Class AbstractDrawing<J, STATE>`Abstract`

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

Type Parameters

J = DrawingJSON
STATE extends DrawingTransactionState = DrawingTransactionState

Hierarchy (view full)

AbstractAnchoredItem<STATE>
- AbstractDrawing

Implements

IDrawingModel

Constructors

constructor

new AbstractDrawing<J, STATE>(options): AbstractDrawing<J, STATE>
Type Parameters
- J = DrawingJSON
- STATE extends DrawingTransactionState = DrawingTransactionState
Parameters
- options: AnchoredDrawingOptions<J>
Returns AbstractDrawing<J, STATE>
Overrides AbstractAnchoredItem<STATE>.constructor

Properties

`Static` instanceCounter

instanceCounter: number = 0

Accessors

isAnchoredItem

get isAnchoredItem(): true
For runtime type checking

Returns true
Implementation of IDrawingModel.isAnchoredItem
Inherited from AbstractAnchoredItem.isAnchoredItem

isDrawing

get isDrawing(): true
For runtime inspection.

Returns true
Implementation of IDrawingModel.isDrawing

type

get type(): string
Unique type for the drawing object.

Returns string
Implementation of IDrawingModel.type

uuid

get uuid(): string
A specific uuid for use in memory.

Returns string
Remarks
Useful for caches and react keys. This is not persisted.

Implementation of IDrawingModel.uuid

zIndex

get zIndex(): number
The order in the z plane. To adjust this use the move methods.

Returns number
Implementation of IDrawingModel.zIndex

Methods

addListener

addListener(listener): RemoveListener
Parameters
- listener: IAnchoredItemListener
Returns RemoveListener
Implementation of IDrawingModel.addListener
Inherited from AbstractAnchoredItem.addListener

close

close(): void
Similar to delete but cleans resources and can't be undone..

Returns void
Implementation of IDrawingModel.close
Inherited from AbstractAnchoredItem.close

delete

delete(): void
Deletes the anchored item.

Returns void
Implementation of IDrawingModel.delete
Inherited from AbstractAnchoredItem.delete

getAnchor

getAnchor(): CellRangeCoords
Returns the anchor

Returns CellRangeCoords
Implementation of IDrawingModel.getAnchor
Inherited from AbstractAnchoredItem.getAnchor

`Optional` getAnchorType

getAnchorType(): AnchorType
Returns how the anchorBounds adjust when inserting/removing rows/columns.

Returns AnchorType
Default Value
```
AnchorType.TwoCell
```
Implementation of IDrawingModel.getAnchorType
Inherited from AbstractAnchoredItem.getAnchorType

getBounds

getBounds(): Bounds
Return the absolute bounds of the drawing object in pixels.

Returns Bounds
Implementation of IDrawingModel.getBounds

getDescription

getDescription(): string
Returns string
See
#setDescription

Implementation of IDrawingModel.getDescription

getName

getName(): string
Returns string
See
#setName

Implementation of IDrawingModel.getName

getRotation

getRotation(): number
Returns number
See
#setHidden

Implementation of IDrawingModel.getRotation

isClosed

isClosed(): boolean
Returns if the model has been closed

Returns boolean
Implementation of IDrawingModel.isClosed
Inherited from AbstractAnchoredItem.isClosed

isHidden

isHidden(): boolean
Returns boolean
See
#setHidden

Implementation of IDrawingModel.isHidden

isLockAspectRatio

isLockAspectRatio(): boolean
Returns boolean
See
#setLockAspectRatio

Implementation of IDrawingModel.isLockAspectRatio

isProtected

isProtected(): boolean
If the drawing is unable to be modified.

Returns boolean
Implementation of IDrawingModel.isProtected
Inherited from AbstractAnchoredItem.isProtected

moveBackward

moveBackward(): void
Returns void
Implementation of IDrawingModel.moveBackward

moveForward

moveForward(): void
Returns void
Implementation of IDrawingModel.moveForward

moveToBack

moveToBack(): void
Returns void
Implementation of IDrawingModel.moveToBack

moveToFront

moveToFront(): void
Returns void
Implementation of IDrawingModel.moveToFront

notifyAnchorUpdate

notifyAnchorUpdate(anchor?): void
Parameters
- Optional anchor: CellRangeCoords
Returns void
Overrides AbstractAnchoredItem.notifyAnchorUpdate

notifyAnyChanges

notifyAnyChanges(): void
Returns void

notifyBoundsChange

notifyBoundsChange(): void
Returns void

notifyOnClose

notifyOnClose(): void
Returns void
Inherited from AbstractAnchoredItem.notifyOnClose

notifyOnDelete

notifyOnDelete(): void
Returns void
Inherited from AbstractAnchoredItem.notifyOnDelete

notifyProtectedChange

notifyProtectedChange(): void
Returns void
Inherited from AbstractAnchoredItem.notifyProtectedChange

pushTransaction

pushTransaction(description?): ITransaction
Parameters
- Optional description: string
Returns ITransaction
Inherited from AbstractAnchoredItem.pushTransaction

`Optional` setAnchorType

setAnchorType(anchorType): void
Ses the anchorBounds.
Parameters
- anchorType: AnchorType
Returns void
Default Value
```
AnchorType.TwoCell
```
Implementation of IDrawingModel.setAnchorType
Overrides AbstractAnchoredItem.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
- bounds: Partial<Bounds>
  T
- Optional options: SetOptions
Returns void
Implementation of IDrawingModel.setBounds

setDescription

setDescription(description): void
This is the alternative text use for assistive technologies.
Parameters
- description: string
Returns void
Default Value
```
null
```
Implementation of IDrawingModel.setDescription

setHidden

setHidden(hidden): void
If true then the drawing object is hidden.
Parameters
- hidden: boolean
Returns void
Default Value
```
false
```
Implementation of IDrawingModel.setHidden

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.
```
Implementation of IDrawingModel.setLockAspectRatio

setName

setName(name): void
Set the name for a drawing object.
Parameters
- name: string
Returns void
Implementation of IDrawingModel.setName

setRotation

setRotation(rotation): void
Set the rotation in degrees.
Parameters
- rotation: number
Returns void
Default Value
```
0
```
Implementation of IDrawingModel.setRotation

toJSON

toJSON(toResourceId?): DrawingAnchorJSON<J>
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<J>
Implementation of IDrawingModel.toJSON