NameVertexId
Vertex ID representing a defined name.
Workbook-scoped if sheetIndex is null, else scoped to the given cell.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new NameVertexId( workbookKey, sheetIndex, name): NameVertexId;Parameters
Section titled “Parameters”workbookKey
Section titled “workbookKey”number
The dependency graph key of the workbook
sheetIndex
Section titled “sheetIndex”number | null
Zero-based sheet index (if name is sheet-scoped, else null)
string
The defined name
Returns
Section titled “Returns”NameVertexId
Overrides
Section titled “Overrides”Properties
Section titled “Properties”key: string;Underlying string encoding of the identifier. Guaranteed to be identical for two vertex ID instances that identify the same thing within a model, and to be distinct for instances that don’t.
Inherited from
Section titled “Inherited from”name: string;Name, as specified when this vertex ID was constructed. Note that vertex IDs with different casing of the name are equivalent.
sheetIndex
Section titled “sheetIndex”sheetIndex: number | null;Zero-based index of sheet, if this represents a sheet-scoped defined name
workbookKey
Section titled “workbookKey”workbookKey: number;Key identifying a workbook in this model. Although it is numeric, the number does not necessarily indicate its ordering in the model.
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”contains()
Section titled “contains()”contains(otherId): boolean;Check whether this vertex ID fully contains another (meaning all of the other vertex ID is within this one)
Parameters
Section titled “Parameters”otherId
Section titled “otherId”Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”overlaps()
Section titled “overlaps()”overlaps(otherId): boolean;Check whether this vertex ID overlaps another.
Parameters
Section titled “Parameters”otherId
Section titled “otherId”Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”toRange()
Section titled “toRange()”toRange(): Range | null;Derive a bare Range for the cell or range represented by this vertex ID, without workbook or sheet attachment. For a vertex ID that does not represent a cell or range, this is null.
Returns
Section titled “Returns”Range | null
Inherited from
Section titled “Inherited from”toString()
Section titled “toString()”toString(): string;Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”fromKey()
Section titled “fromKey()”static fromKey(key): KnownVertexId;Make a VertexId instance for the given key. Two calls with the same key will return distinct but equivalent instances.
Parameters
Section titled “Parameters”string