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”| DefinedName
| {
f?: string;
}
object to copy attributes from (all optional, this may be empty)
string | null
the name of the defined name
container?
Section titled “container?”CellContainer
Returns
Section titled “Returns”DefinedName
Properties
Section titled “Properties”f: string | null;formula, if any
Implementation of
Section titled “Implementation of”ft: "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”Accessors
Section titled “Accessors”formulaZ
Section titled “formulaZ”Get Signature
Section titled “Get Signature”get formulaZ(): string | null;The defined name’s formula-assigned number format, if present.
Returns
Section titled “Returns”string | null
Implementation of
Section titled “Implementation of”isExtractedSubexpression
Section titled “isExtractedSubexpression”Get Signature
Section titled “Get Signature”get isExtractedSubexpression(): boolean;Whether this defined name contains a subexpression the optimizer hoisted out of the formulas
that repeat it, as opposed to the other internal kind, a cached formula. Extraction affects
only how those formulas evaluate; their f text is unchanged. See
Docs.InternalDefinedNames.
Returns
Section titled “Returns”boolean
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. See Docs.InternalDefinedNames.
Both kinds are found by hashing their formula, so neither is ever rewritten in place.
Returns
Section titled “Returns”boolean
sheetIndex
Section titled “sheetIndex”Get Signature
Section titled “Get Signature”get sheetIndex(): number | null;Returns
Section titled “Returns”number | null
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(): string | null;The effective number format of the defined name. Null unless propagated from number formats of referenced cells.
Returns
Section titled “Returns”string | null
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”hasValueOrFormula()
Section titled “hasValueOrFormula()”hasValueOrFormula(): boolean;Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”CellInterface.hasValueOrFormula
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