Interface IAnchored

IAnchored objects are anchored to one or more ranges.

interface IAnchored {
    isIAnchored: true;
    addListeners(
        listeners: IAnchored.IListeners,
        options?: IListener.Options,
    ): Remove;
    close(): void;
    delete(): void;
    getAnchorType?(): IAnchored.Type;
    getName?(): string | null;
    getRanges(options?: ICellRange.GetRangeOptions): ICellRanges;
    isClosed(): boolean;
    isDeleted(): boolean;
    isProtected(): boolean;
}

Hierarchy (View Summary)

IAnchored

Index

Properties

Methods

addListeners close delete getAnchorType? getName? getRanges isClosed isDeleted isProtected

Properties

`Readonly`isIAnchored

isIAnchored: true

For runtime type checking.

Methods

addListeners

addListeners(
listeners: IAnchored.IListeners,
options?: IListener.Options,
): Remove
Add Listeners.
Parameters
- listeners: IAnchored.IListeners
- Optionaloptions: IListener.Options
Returns Remove

See
IListener.ISource.addListeners

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

`Optional`getAnchorType

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

Returns IAnchored.Type
Default Value
```
IAnchored.Type.TwoCell
```

`Optional`getName

getName?(): string | null

The name of the anchor or null if it has none.

Returns string | null

getRanges

getRanges(options?: ICellRange.GetRangeOptions): ICellRanges
Returns the ranges this object is anchored to, in authored order.
Parameters
- Optionaloptions: ICellRange.GetRangeOptions
Returns ICellRanges
Remarks
- Never null. An item whose last range was removed by a row/column delete returns an invalid ranges — ask ICellRanges.isInvalid, the same contract as ITable.getDataRange.
- This is the general accessor. Most anchored types hold exactly one range and declare their own getRange() for it, but data validations, conditional formats and protected ranges are authored as several, and any single range can become several when a delete splits it.

isClosed

isClosed(): boolean

Returns if the model has been closed

Returns boolean

isDeleted

isDeleted(): boolean

Returns if the model has been deleted

Returns boolean

isProtected

isProtected(): boolean

If the anchor is unable to be modified.

Returns boolean