Class DrawingGraphicFrameModel

Static instanceCounter

isAnchoredItem

• get isAnchoredItem(): true

• For runtime type checking

  Returns true

isDrawing

• get isDrawing(): true

• For runtime inspection.

  Returns true

type

• get type(): string

• Unique type for the drawing object.

  Returns string

uuid

• get uuid(): string

• A specific uuid for use in memory.

  Returns string

  Remarks

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

zIndex

• get zIndex(): number

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

  Returns number

addListener

• addListener(listener): RemoveListener

• Parameters

  • listener: IAnchoredItemListener

  Returns RemoveListener

close

• close(): void

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

  Returns void

delete

• delete(): void

• Deletes the anchored item.

  Returns void

getAnchor

• getAnchor(): CellRangeCoords

• Returns the anchor

  Returns CellRangeCoords

Optional getAnchorType

• getAnchorType(): AnchorType

• Returns how the anchorBounds adjust when inserting/removing rows/columns.

  Returns AnchorType

  Default Value

  AnchorType.TwoCell
  Copy

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

• isProtected(): boolean

• If the drawing is unable to be modified.

  Returns boolean

moveBackward

• moveBackward(): void

• Returns void

moveForward

• moveForward(): void

• Returns void

moveToBack

• moveToBack(): void

• Returns void

moveToFront

• moveToFront(): void

• Returns void

notifyAnchorUpdate

• notifyAnchorUpdate(anchor?): void

• Parameters

  • Optional anchor: CellRangeCoords

  Returns void

notifyAnyChanges

• notifyAnyChanges(): void

• Returns void

notifyBoundsChange

• notifyBoundsChange(): void

• Returns void

notifyOnClose

• notifyOnClose(): void

• Returns void

notifyOnDelete

• notifyOnDelete(): void

• Returns void

notifyProtectedChange

• notifyProtectedChange(): void

• Returns void

pushTransaction

• pushTransaction(description?): ITransaction

• Parameters

  • Optional description: string

  Returns ITransaction

Optional setAnchorType

• setAnchorType(anchorType): void

• Ses the anchorBounds.

  Parameters

  • anchorType: AnchorType

  Returns void

  Default Value

  AnchorType.TwoCell
  Copy

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

  • bounds: Partial<Bounds>

    T
  • Optional options: SetOptions

  Returns void

setDescription

• setDescription(description): void

• This is the alternative text use for assistive technologies.

  Parameters

  • description: string

  Returns void

  Default Value

  null
  Copy

setHidden

• setHidden(hidden): void

• If true then the drawing object is hidden.

  Parameters

  • hidden: boolean

  Returns void

  Default Value

  false
  Copy

setLockAspectRatio

• setLockAspectRatio(lockAspectRatio): void

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

  Parameters

  • lockAspectRatio: boolean

  Returns void

  Default Value

  depends on the drawing type.
  Copy

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
  Copy

toJSON

• toJSON(toResourceId?): DrawingAnchorJSON<DrawingGraphicFrameJSON>

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

  Parameters

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

      • Parameters

        • resource: ISharedResource

        Returns number

  Returns DrawingAnchorJSON<DrawingGraphicFrameJSON>