Interface IAnchoredItem

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

interface IAnchoredItem {
    isAnchoredItem: true;
    addListener(listener): RemoveListener;
    close(): void;
    copyTo?(sheet, destination, options?): void;
    delete(): void;
    getAnchor(): CellRangeCoords;
    getAnchorType?(): AnchorType;
    isClosed(): boolean;
    isProtected(): boolean;
    setAnchorType?(anchorType): void;
}

Hierarchy (view full)

IAnchoredItem
- IDrawingModel

Index

Properties

Methods

addListener close copyTo? delete getAnchor getAnchorType? isClosed isProtected setAnchorType?

Properties

`Readonly` isAnchoredItem

isAnchoredItem: true

For runtime type checking

Methods

addListener

addListener(listener): RemoveListener
Adds a listener for the anchor item
Parameters
- listener: IAnchoredItemListener
Returns RemoveListener

close

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

Returns void

`Optional` copyTo

copyTo(sheet, destination, options?): void
Copies the anchor to the given sheet and coords.
Parameters
- sheet: ISheetModel
- destination: CellRangeCoords
- Optional options: CopyCellsOptions
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
```

isClosed

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

Returns boolean

isProtected

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

Returns boolean

`Optional` setAnchorType

setAnchorType(anchorType): void
Ses the anchorBounds.
Parameters
- anchorType: AnchorType
Returns void
Default Value
```
AnchorType.TwoCell
```