DefinedName
DefinedName object. Instances of this are stored in Workbook._globals and
WorkSheet._locallyScopedNames.
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new DefinedName(
orgCell,name?,container?):DefinedName
Construct a DefinedName instance.
Parameters
Section titled “Parameters”orgCell
Section titled “orgCell”object to copy attributes from (all optional, this may be empty)
DefinedName | { f?: string; }
the name of the defined name
null | string
container?
Section titled “container?”CellContainer
Returns
Section titled “Returns”DefinedName
Properties
Section titled “Properties”_ast:
ASTRootNode
Cached abstract syntax tree, if this.f has been parsed.
Implementation of
Section titled “Implementation of”_container
Section titled “_container”_container:
null|CellContainer=null
Implementation of
Section titled “Implementation of”_spill
Section titled “_spill”_spill:
null=null
Explicitly null-typed in defined names, which are never part of a spill.
Implementation of
Section titled “Implementation of”f:
null|string
formula, if any
Implementation of
Section titled “Implementation of”ft:
"a"='a'
Formula type is always ‘a’ for defined names.
Implementation of
Section titled “Implementation of”id:
string
this defined name’s name
Implementation of
Section titled “Implementation of”neutralizedFormula
Section titled “neutralizedFormula”neutralizedFormula:
null|string=null
Formula which was neutralized by a write to/overlapping this cell
Implementation of
Section titled “Implementation of”CellInterface.neutralizedFormula
state:
number
State for recalcWithMarkAndEvalQueue
Implementation of
Section titled “Implementation of”vertexId
Section titled “vertexId”vertexId:
NameVertexId
Cached vertex ID for this defined name. Storing this avoids repeatedly constructing NameVertexId instances in hot paths.
Implementation of
Section titled “Implementation of”Accessors
Section titled “Accessors”formulaZ
Section titled “formulaZ”Get Signature
Section titled “Get Signature”get formulaZ():
null|string
The defined name’s formula-assigned number format, if present.
Returns
Section titled “Returns”null | string
Implementation of
Section titled “Implementation of”isInternal
Section titled “isInternal”Get Signature
Section titled “Get Signature”get isInternal():
boolean
Whether this defined name is an internal implementation detail (cached formula cell or extracted subexpression) that should not be serialized or exposed to users.
Returns
Section titled “Returns”boolean
sheetIndex
Section titled “sheetIndex”Get Signature
Section titled “Get Signature”get sheetIndex():
null|number
Returns
Section titled “Returns”null | number
Implementation of
Section titled “Implementation of”Get Signature
Section titled “Get Signature”get v():
FormulaValue
Returns
Section titled “Returns”Set Signature
Section titled “Set Signature”set v(
value):void
Set the value of the defined name. If the value is a boxed value, the number format will become the defined name’s formula-assigned number format.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”valueBoxed
Section titled “valueBoxed”Get Signature
Section titled “Get Signature”get valueBoxed():
MaybeBoxedFormulaValue
The value of the defined name. If the value has a formula-assigned number format, the value will be a boxed value containing that number format.
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”workbookKey
Section titled “workbookKey”Get Signature
Section titled “Get Signature”get workbookKey():
number
Returns
Section titled “Returns”number
Implementation of
Section titled “Implementation of”Get Signature
Section titled “Get Signature”get z():
null|string
The effective number format of the defined name. Null unless propagated from number formats of referenced cells.
Returns
Section titled “Returns”null | string
Implementation of
Section titled “Implementation of”Methods
Section titled “Methods”clear()
Section titled “clear()”clear():
void
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”edit()
Section titled “edit()”edit(
cellData):void
Parameters
Section titled “Parameters”cellData
Section titled “cellData”JSFCellExpanded
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”hasValue()
Section titled “hasValue()”hasValue():
boolean
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”hasValueOrFormula()
Section titled “hasValueOrFormula()”hasValueOrFormula():
boolean
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”CellInterface.hasValueOrFormula
isBlank()
Section titled “isBlank()”isBlank():
boolean
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”isSpillAnchor()
Section titled “isSpillAnchor()”isSpillAnchor():
boolean
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”isSpilled()
Section titled “isSpilled()”isSpilled():
this is Cell & { _spill: { valid: true }; F: string; sheetIndex: number }
Returns
Section titled “Returns”this is Cell & { _spill: { valid: true }; F: string; sheetIndex: number }
Implementation of
Section titled “Implementation of”spillHeight()
Section titled “spillHeight()”spillHeight():
number
Returns
Section titled “Returns”number
Implementation of
Section titled “Implementation of”spillWidth()
Section titled “spillWidth()”spillWidth():
number
Returns
Section titled “Returns”number
Implementation of
Section titled “Implementation of”toString()
Section titled “toString()”toString():
string
Returns
Section titled “Returns”string