VertexId
Base class for vertex identifiers, which unambiguously identify the vertices for cells, ranges and defined names in a model’s dependency graph.
Extended by
Section titled “Extended by”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new VertexId(workbookKey, key): VertexId;Parameters
Section titled “Parameters”workbookKey
Section titled “workbookKey”number
The dependency graph key of the workbook
string
The key of this vertex ID (which includes the workbook key)
Returns
Section titled “Returns”VertexId
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.
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.
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
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
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
toString()
Section titled “toString()”toString(): string;Returns
Section titled “Returns”string
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