NameVertexId
Extends
Section titled “Extends”VertexId
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”Zero-based sheet index (if name is sheet-scoped, else null)
null | number
string
The defined name
Returns
Section titled “Returns”NameVertexId
Overrides
Section titled “Overrides”VertexId.constructor
Properties
Section titled “Properties”key:
string
Inherited from
Section titled “Inherited from”VertexId.key
name:
string
sheetIndex
Section titled “sheetIndex”sheetIndex:
null|number
workbookKey
Section titled “workbookKey”workbookKey:
number
Inherited from
Section titled “Inherited from”VertexId.workbookKey
Methods
Section titled “Methods”contains()
Section titled “contains()”contains(
otherId):boolean
Check if this vertex ID fully contains another (i.e., all cells of the other vertex ID are within this one). The base implementation only matches exact key equality; RangeVertexId overrides this for geometric containment.
Parameters
Section titled “Parameters”otherId
Section titled “otherId”Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”VertexId.contains
overlaps()
Section titled “overlaps()”overlaps(
otherId):boolean
Check if this vertex ID overlaps with another. Used for determining if a dynamic dependency edge applies to a given cell/range change. The base implementation only matches exact key equality; subclasses like RangeVertexId override this to perform geometric intersection.
Parameters
Section titled “Parameters”otherId
Section titled “otherId”Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”VertexId.overlaps
toRange()
Section titled “toRange()”toRange():
null|Range
Returns
Section titled “Returns”null | Range
Inherited from
Section titled “Inherited from”VertexId.toRange
toString()
Section titled “toString()”toString():
string
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”VertexId.toString
withSheetIndex()
Section titled “withSheetIndex()”withSheetIndex(
newSheetIndex):KnownVertexId
Parameters
Section titled “Parameters”newSheetIndex
Section titled “newSheetIndex”number
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”VertexId.withSheetIndex
fromKey()
Section titled “fromKey()”
staticfromKey(key):KnownVertexId
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”VertexId.fromKey