Interface IMovableCollection

Holds a collection of IMovables.

interface IMovableCollection {
    add(options?: IMovableCollection.AddOptions): Promise<IMovable>;
    addImage(
        image: string | IResource | IResourceCollection.AddOptions,
        options?: IMovableCollection.AddOptions,
    ): Promise<IMovable>;
    addListeners(listeners: IListeners, options?: IListener.Options): Remove;
    getCount(): number;
    search(options?: IMovableCollection.SearchOptions): IMovable[];
    updateSelected(update: (movable: IMovable) => void, action?: string): void;
}

Hierarchy (View Summary)

ICollection
- IMovableCollection

Index

Methods

add addImage addListeners getCount search updateSelected

Methods

add

add(options?: IMovableCollection.AddOptions): Promise<IMovable>
Add a resource to the movable collection.
Parameters
- Optionaloptions: IMovableCollection.AddOptions
  IMovableCollection.AddOptions
Returns Promise<IMovable>
A new IMovable.

addImage

addImage(
image: string | IResource | IResourceCollection.AddOptions,
options?: IMovableCollection.AddOptions,
): Promise<IMovable>
Add an image to the current sheet. Returns an IMovableImage that can be used to manipulate the image or remove it.
Parameters
- image: string | IResource | IResourceCollection.AddOptions
  This can be either string to a url, a Resource or an IResource.AddOptions
- Optionaloptions: IMovableCollection.AddOptions
  IMovableCollection.AddOptions
Returns Promise<IMovable>
A Promise that will resolve to the new Movable.

addListeners

addListeners(listeners: IListeners, options?: IListener.Options): Remove
Add Listeners.
Parameters
- listeners: IListeners
- Optionaloptions: IListener.Options
Returns Remove
See
IListener.ISource.addListeners

Overrides IListener.ISource.addListeners

getCount

getCount(): number
Returns the total items available.

Returns number
Remarks
Useful as a quick escape for search.

Inherited from ICollection.getCount

search

search(options?: IMovableCollection.SearchOptions): IMovable[]
Returns movables that match the search criteria.
Parameters
- Optionaloptions: IMovableCollection.SearchOptions
  IMovableCollection.SearchOptions
Returns IMovable[]
An Array of IMovable.

Remarks
If no search criteria is provided, all items will be returned.

updateSelected

updateSelected(update: (movable: IMovable) => void, action?: string): void
Update all of the selected movable in a single transaction
Parameters
- update: (movable: IMovable) => void
- Optionalaction: string
Returns void