RangeVertexId
Extends
Section titled “Extends”VertexId
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new RangeVertexId(
workbookKey,sheetIndex,top,left,bottom,right):RangeVertexId
Parameters
Section titled “Parameters”workbookKey
Section titled “workbookKey”number
The dependency graph key of the workbook
sheetIndex
Section titled “sheetIndex”number
Zero-based sheet index
number
Zero-based row index
number
Zero-based column index
bottom
Section titled “bottom”number
Zero-based row index
number
Zero-based column index
Returns
Section titled “Returns”RangeVertexId
Overrides
Section titled “Overrides”VertexId.constructor
Properties
Section titled “Properties”bottom
Section titled “bottom”bottom:
number
key:
string
Inherited from
Section titled “Inherited from”VertexId.key
left:
number
right:
number
sheetIndex
Section titled “sheetIndex”sheetIndex:
number
top:
number
workbookKey
Section titled “workbookKey”workbookKey:
number
Inherited from
Section titled “Inherited from”VertexId.workbookKey
Methods
Section titled “Methods”bottomRight()
Section titled “bottomRight()”bottomRight():
CellVertexId
Returns
Section titled “Returns”contains()
Section titled “contains()”contains(
other):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”Returns
Section titled “Returns”boolean
Overrides
Section titled “Overrides”VertexId.contains
is1x1()
Section titled “is1x1()”is1x1():
boolean
Returns
Section titled “Returns”boolean
offset()
Section titled “offset()”offset(
rows,cols):RangeVertexId
Parameters
Section titled “Parameters”number
number
Returns
Section titled “Returns”RangeVertexId
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
Overrides
Section titled “Overrides”VertexId.overlaps
topLeft()
Section titled “topLeft()”topLeft():
CellVertexId
Returns
Section titled “Returns”toRange()
Section titled “toRange()”toRange():
Range
Returns
Section titled “Returns”Overrides
Section titled “Overrides”VertexId.toRange
toString()
Section titled “toString()”toString():
string
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”VertexId.toString
visitCells()
Section titled “visitCells()”visitCells(
callback,bounds?):void
Parameters
Section titled “Parameters”callback
Section titled “callback”CallbackWithStop<CellVertexId>
function to call with each cell vertex ID
bounds?
Section titled “bounds?”the maximum 0-based x and y coordinates to visit. If not specified, then all coordinates of this range vertex ID are visited.
bottom
Section titled “bottom”number
number
Returns
Section titled “Returns”void
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