Interface IAnchored

IAnchored objects are anchored to a range.

interface IAnchored {
    isIAnchored: true;
    addListeners(listeners: IListeners, options?: IListener.Options): Remove;
    close(): void;
    delete(): void;
    getAnchorCoords(): IRange.Coords;
    getAnchorType(): IAnchored.Type;
    isClosed(): boolean;
    isProtected(): boolean;
}

Hierarchy (View Summary)

IAnchored
- IMovable
- ITable

Index

Properties

Methods

addListeners close delete getAnchorCoords getAnchorType? isClosed isProtected

Properties

`Readonly`isIAnchored

isIAnchored: true

For runtime type checking.

Methods

addListeners

addListeners(listeners: IListeners, options?: IListener.Options): Remove
Add Listeners.
Parameters
- listeners: 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

getAnchorCoords

getAnchorCoords(): IRange.Coords
Returns the anchor.

Returns IRange.Coords

`Optional`getAnchorType

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

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

isClosed

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

Returns boolean

isProtected

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

Returns boolean