Interface AnchoredDrawingOptions<J>

Options for adding a drawing object to a drawing container.

interface AnchoredDrawingOptions<J> {
    defaultLockAspectRatio?: boolean;
    fromResourceId?: ((resourceId) => ISharedResource);
    getMaxBounds?: (() => Bounds);
    getZIndex?: (() => number);
    initialAnchor: CellRangeCoords;
    isProtected: (() => boolean);
    jsonAnchor?: DrawingAnchorJSON<J>;
    moveBackwardOnContainer?: (() => void);
    moveForwardOnContainer?: (() => void);
    moveToBackOnContainer?: (() => void);
    moveToFrontOnContainer?: (() => void);
    resource?: ISharedResource;
    transactionStore?: TransactionStore;
    type: string;
    deleteFromContainer(): void;
    getRangeBounds(cellRangeCoords): Bounds;
    getRangeCoords(bounds): CellRangeCoords;
    setAnchorOnContainer(anchor): void;
    setContainerAnchorDeleteCallback?(callback): void;
    setContainerAnchorResizeCallback?(callback): void;
    setContainerAnchorShiftCallback(callback): void;
    setContainerProtectionCallback(callback): void;
    setContainerZIndexCallback(callback): void;
}

Type Parameters

Hierarchy

  • AnchoredItemOptions
    • AnchoredDrawingOptions

Properties

defaultLockAspectRatio? fromResourceId? getMaxBounds? getZIndex? initialAnchor isProtected jsonAnchor? moveBackwardOnContainer? moveForwardOnContainer? moveToBackOnContainer? moveToFrontOnContainer? resource? transactionStore? type

Methods

deleteFromContainer getRangeBounds getRangeCoords setAnchorOnContainer setContainerAnchorDeleteCallback? setContainerAnchorResizeCallback? setContainerAnchorShiftCallback setContainerProtectionCallback setContainerZIndexCallback

Properties

Optional defaultLockAspectRatio

defaultLockAspectRatio?: boolean

Allow for the default lock aspect ratio to be overwritten.

Optional fromResourceId

fromResourceId?: ((resourceId) => ISharedResource)

from resourceId

Type declaration

Optional getMaxBounds

getMaxBounds?: (() => Bounds)

Return the maximum bounds of the container. If not defined the container will be unbounded.

Type declaration

Returns

Optional getZIndex

getZIndex?: (() => number)

Return the z-index for the current Drawing.

Type declaration

    • (): number

    • Returns number

initialAnchor

initialAnchor: CellRangeCoords

The anchor used when the item is first created.

isProtected

isProtected: (() => boolean)

If protected the container can protected the item.

Type declaration

    • (): boolean

    • Returns boolean

Optional jsonAnchor

jsonAnchor?: DrawingAnchorJSON<J>

The initial JSON to load the drawing from.

Optional moveBackwardOnContainer

moveBackwardOnContainer?: (() => void)

Move drawing backward one layer in the zIndex.

Type declaration

    • (): void

    • Returns void

Optional moveForwardOnContainer

moveForwardOnContainer?: (() => void)

Move drawing forward one layer in the zIndex.

Type declaration

    • (): void

    • Returns void

Optional moveToBackOnContainer

moveToBackOnContainer?: (() => void)

Move drawing to the back in the zIndex.

Type declaration

    • (): void

    • Returns void

Optional moveToFrontOnContainer

moveToFrontOnContainer?: (() => void)

Move drawing to the font in the zIndex.

Type declaration

    • (): void

    • Returns void

Optional resource

resource?: ISharedResource

If provided the drawing will be added to the resource manager.

Optional transactionStore

transactionStore?: TransactionStore

A transaction store that can be used to undo/redo changes to the table.

type

type: string

The type of the drawing

Methods

deleteFromContainer

  • deleteFromContainer(): void

  • Delete from the container

    Returns void

getRangeBounds

  • getRangeBounds(cellRangeCoords): Bounds

  • Returns the bounds of a range of cells.

    Parameters

    Returns Bounds

getRangeCoords

setAnchorOnContainer

  • setAnchorOnContainer(anchor): void

  • Parameters

    Returns void

Optional setContainerAnchorDeleteCallback

  • setContainerAnchorDeleteCallback(callback): void

  • Notify anchored item that the record has been deleted from the container.

    Parameters

    • callback: AnchoredItemDeleteCallback

    Returns void

Optional setContainerAnchorResizeCallback

  • setContainerAnchorResizeCallback(callback): void

  • Notify anchored item that the pixel bounds have changed due to a resize.

    Parameters

    • callback: AnchoredItemResizeCallback

    Returns void

setContainerAnchorShiftCallback

  • setContainerAnchorShiftCallback(callback): void

  • Notify anchored item that the anchor bounds have changed due to an insert/remove.

    Parameters

    • callback: AnchoredItemShiftCallback

    Returns void

setContainerProtectionCallback

  • setContainerProtectionCallback(callback): void

  • Notify drawing it's protection has been updated from the container.

    Parameters

    • callback: (() => void)
        • (): void

        • Returns void

    Returns void

setContainerZIndexCallback

  • setContainerZIndexCallback(callback): void

  • Notify drawing it's zIndex has been updated from the container.

    Parameters

    • callback: (() => void)
        • (): void

        • Returns void

    Returns void

Settings

Member Visibility

Theme

On This Page

defaultLockAspectRatiofromResourceIdgetMaxBoundsgetZIndexinitialAnchorisProtectedjsonAnchormoveBackwardOnContainermoveForwardOnContainermoveToBackOnContainermoveToFrontOnContainerresourcetransactionStoretypedeleteFromContainergetRangeBoundsgetRangeCoordssetAnchorOnContainersetContainerAnchorDeleteCallbacksetContainerAnchorResizeCallbacksetContainerAnchorShiftCallbacksetContainerProtectionCallbacksetContainerZIndexCallback