Interface IDrawingModel<J>

AnchoredItem belong to a sheet and is anchored to a range of cells.

interface IDrawingModel<J> {
    addListener: ((listener) => RemoveListener);
    isAnchoredItem: true;
    isDrawing: true;
    moveBackward: (() => void);
    moveForward: (() => void);
    moveToBack: (() => void);
    moveToFront: (() => void);
    type: string;
    uuid: string;
    zIndex: number;
    close(): void;
    copyTo?(sheet, destination, options?): void;
    delete(): void;
    getAnchor(): CellRangeCoords;
    getAnchorType?(): AnchorType;
    getBounds(): Bounds;
    getDescription(): string;
    getName(): string;
    getRotation(): number;
    isClosed(): boolean;
    isHidden(): boolean;
    isLockAspectRatio(): boolean;
    isProtected(): boolean;
    setAnchorType?(anchorType): void;
    setBounds(bounds, options?): void;
    setDescription(description): void;
    setHidden(hidden): void;
    setLockAspectRatio(locked): void;
    setName(name): void;
    setRotation(rotation): void;
    toJSON?(toResourceId?): DrawingAnchorJSON<J>;
}

Type Parameters

Hierarchy (view full)

Implemented by

Properties

addListener isAnchoredItem isDrawing moveBackward moveForward moveToBack moveToFront type uuid zIndex

Methods

close copyTo? delete getAnchor getAnchorType? getBounds getDescription getName getRotation isClosed isHidden isLockAspectRatio isProtected setAnchorType? setBounds setDescription setHidden setLockAspectRatio setName setRotation toJSON?

Properties

addListener

addListener: ((listener) => RemoveListener)

All for listen to changes to the sheet. To remove listener call the returned function.

Type declaration

Returns

An unsubscribe function

Readonly isAnchoredItem

isAnchoredItem: true

For runtime type checking

Readonly isDrawing

isDrawing: true

For runtime inspection.

moveBackward

moveBackward: (() => void)

Move drawing backward one layer in the zIndex.

Type declaration

    • (): void

    • Returns void

moveForward

moveForward: (() => void)

Move drawing forward one layer in the zIndex.

Type declaration

    • (): void

    • Returns void

moveToBack

moveToBack: (() => void)

Move drawing to the back in the zIndex.

Type declaration

    • (): void

    • Returns void

moveToFront

moveToFront: (() => void)

Move drawing to the font in the zIndex.

Type declaration

    • (): void

    • Returns void

Readonly type

type: string

Unique type for the drawing object.

Readonly uuid

uuid: string

A specific uuid for use in memory.

Remarks

Useful for caches and react keys. This is not persisted.

Readonly zIndex

zIndex: number

The order in the z plane. To adjust this use the move methods.

Methods

close

  • close(): void

  • Similar to delete but cleans resources and can't be undone..

    Returns void

Optional copyTo

delete

getAnchor

Optional getAnchorType

getBounds

  • getBounds(): Bounds

  • Return the absolute bounds of the drawing object in pixels.

    Returns Bounds

getDescription

  • getDescription(): string

  • Returns string

    See

    #setDescription

getName

  • getName(): string

  • Returns string

    See

    #setName

getRotation

  • getRotation(): number

  • Returns number

    See

    #setHidden

isClosed

  • isClosed(): boolean

  • Returns if the model has been closed

    Returns boolean

isHidden

  • isHidden(): boolean

  • Returns boolean

    See

    #setHidden

isLockAspectRatio

  • isLockAspectRatio(): boolean

  • Returns boolean

    See

    #setLockAspectRatio

isProtected

Optional setAnchorType

setBounds

  • setBounds(bounds, options?): void

  • Set the absolution position of a drawing in pixels. If only some of the points are provided then only those will be moved.

    Parameters

    Returns void

setDescription

  • setDescription(description): void

  • This is the alternative text use for assistive technologies.

    Parameters

    • description: string

    Returns void

    Default Value

    null

setHidden

  • setHidden(hidden): void

  • If true then the drawing object is hidden.

    Parameters

    • hidden: boolean

    Returns void

    Default Value

    false

setLockAspectRatio

  • setLockAspectRatio(locked): void

  • If true then the aspect should be maintained during resize if using the corners or if the api only specifies one dimension.

    Parameters

    • locked: boolean

    Returns void

    Default Value

    depends on the drawing type.

setName

  • setName(name): void

  • Set the name for a drawing object.

    Parameters

    • name: string

    Returns void

setRotation

  • setRotation(rotation): void

  • Set the rotation in degrees.

    Parameters

    • rotation: number

    Returns void

    Default Value

    0

Optional toJSON

  • toJSON(toResourceId?): DrawingAnchorJSON<J>

  • If defined this will be called when the containing sheet is being serialized.

    Parameters

    • Optional toResourceId: ((resource) => number)

    Returns DrawingAnchorJSON<J>

Settings

Member Visibility

Theme

On This Page

addListenerisAnchoredItemisDrawingmoveBackwardmoveForwardmoveToBackmoveToFronttypeuuidzIndexclosecopyTodeletegetAnchorgetAnchorTypegetBoundsgetDescriptiongetNamegetRotationisClosedisHiddenisLockAspectRatioisProtectedsetAnchorTypesetBoundssetDescriptionsetHiddensetLockAspectRatiosetNamesetRotationtoJSON