Interface IDrawingContainer<T>

Implemented by ISheetModel

interface IDrawingContainer<T> {
    addDrawing(options?): IDrawingModel<DrawingJSON>;
    addEventListener(type, listener, options?): RemoveListener;
    getDrawingsCount(): number;
    searchDrawings(options?): IDrawingModel<DrawingJSON>[];
}

Type Parameters

T = any

Hierarchy (view full)

IListenerSource<DrawingContainerEvent<T>>
- IDrawingContainer
  - ISheetModel

Implemented by

SheetModel

Index

Methods

addDrawing addEventListener getDrawingsCount searchDrawings

Methods

addDrawing

addDrawing(options?): IDrawingModel<DrawingJSON>
Add a drawing to the container
Parameters
- Optional options: TypedAddDrawingOptions<DrawingJSON>
Returns IDrawingModel<DrawingJSON>

addEventListener

addEventListener(type, listener, options?): RemoveListener
Add a listener. This is very similar to default javascript listeners except the offer a few additional options and there is no remove listener.

These add listeners return a function that can be called to remove the listener. Additionally they honor transactional boundaries.

Listeners are fired in the order that they are added.
Parameters
- type: string
- listener: Listener<DrawingContainerEvent<T>>
- Optional options: ListenerOptions
Returns RemoveListener
Inherited from IListenerSource.addEventListener

getDrawingsCount

getDrawingsCount(): number
Return the total drawings available. This is useful for quick escape of searching drawings.

Returns number

searchDrawings

searchDrawings(options?): IDrawingModel<DrawingJSON>[]
Return drawings that match the search criteria. If no search criteria is provided, all drawings will be returned.
Parameters
- Optional options: DrawingSearchOptions
  DrawingSearchOptions
Returns IDrawingModel<DrawingJSON>[]