@univerjs/engine-formula v0.5.0-beta.1 • Docs
Class: FormulaDependencyTree
A dependency tree, capable of calculating mutual dependencies, is used to determine the order of formula calculations.
Extends
FormulaDependencyTreeCalculator
Constructors
new FormulaDependencyTree()
new FormulaDependencyTree(treeId): FormulaDependencyTreeParameters
| Parameter | Type |
|---|---|
treeId | number |
Returns
Overrides
FormulaDependencyTreeCalculator.constructor
Defined in
submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:316
Properties
| Property | Type | Default value | Inherited from | Defined in |
|---|---|---|---|---|
children | Set<number> | undefined | FormulaDependencyTreeCalculator.children | submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:71 |
column | number | -1 | - | submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:306 |
columnCount | number | Number.NEGATIVE_INFINITY | - | submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:310 |
featureDirtyRanges | IUnitRange[] | [] | - | submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:287 |
featureId | Nullable<string> | undefined | - | submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:286 |
formula | string | '' | - | submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:302 |
formulaId | Nullable<string> | undefined | - | submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:294 |
getDirtyData | GetDirtyDataType | undefined | - | submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:341 |
isCache | boolean | false | - | submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:284 |
isDirty | boolean | false | - | submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:312 |
node | Nullable<AstRootNode> | undefined | - | submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:314 |
parents | Set<number> | undefined | FormulaDependencyTreeCalculator.parents | submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:73 |
rangeList | IUnitRange[] | [] | - | submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:300 |
refOffsetX | number | 0 | - | submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:289 |
refOffsetY | number | 0 | - | submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:290 |
row | number | -1 | - | submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:304 |
rowCount | number | Number.NEGATIVE_INFINITY | - | submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:308 |
subUnitId | string | '' | - | submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:296 |
treeId | number | undefined | FormulaDependencyTreeCalculator.treeId | submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:69 |
type | FormulaDependencyTreeType | FormulaDependencyTreeType.NORMAL_FORMULA | - | submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:292 |
unitId | string | '' | - | submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:298 |
Accessors
isVirtual
Get Signature
get isVirtual(): booleanReturns
boolean
Defined in
submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:321
nodeData
Get Signature
get nodeData(): {
node: Nullable<AstRootNode>;
refOffsetX: 0;
refOffsetY: 0;
}Returns
{
node: Nullable<AstRootNode>;
refOffsetX: 0;
refOffsetY: 0;
}| Name | Type | Default value | Defined in |
|---|---|---|---|
node | Nullable<AstRootNode> | - | submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:327 |
refOffsetX | number | 0 | submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:328 |
refOffsetY | number | 0 | submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:329 |
Defined in
submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:325
Methods
dependencySheetName()
dependencySheetName(dirtyUnitSheetNameMap?): booleanParameters
| Parameter | Type |
|---|---|
dirtyUnitSheetNameMap? | IDirtyUnitSheetNameMap |
Returns
boolean
Defined in
submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:369
dispose()
dispose(): voidReturns
void
Defined in
submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:343
hasChildren()
hasChildren(treeId): booleanParameters
| Parameter | Type |
|---|---|
treeId | number |
Returns
boolean
Inherited from
FormulaDependencyTreeCalculator.hasChildren
Defined in
submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:80
inRangeData()
inRangeData(range): booleanParameters
| Parameter | Type |
|---|---|
range | IRange |
Returns
boolean
Defined in
submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:353
isAdded()
isAdded(): booleanReturns
boolean
Inherited from
FormulaDependencyTreeCalculator.isAdded
Defined in
submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:57
isExcludeRange()
isExcludeRange(unitExcludedCell): booleanParameters
| Parameter | Type |
|---|---|
unitExcludedCell | Nullable<IUnitExcludedCell> |
Returns
boolean
Defined in
submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:392
isSkip()
isSkip(): booleanReturns
boolean
Inherited from
FormulaDependencyTreeCalculator.isSkip
Defined in
submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:65
pushChildren()
pushChildren(tree): voidParameters
| Parameter | Type |
|---|---|
tree | FormulaDependencyTreeCalculator |
Returns
void
Inherited from
FormulaDependencyTreeCalculator.pushChildren
Defined in
submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:75
pushRangeList()
pushRangeList(ranges): voidAdd the range corresponding to the current ast node.
Parameters
| Parameter | Type |
|---|---|
ranges | IUnitRange[] |
Returns
void
Defined in
submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:444
resetState()
resetState(): voidReturns
void
Inherited from
FormulaDependencyTreeCalculator.resetState
Defined in
submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:49
setAdded()
setAdded(): voidReturns
void
Inherited from
FormulaDependencyTreeCalculator.setAdded
Defined in
submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:53
setSkip()
setSkip(): voidReturns
void
Inherited from
FormulaDependencyTreeCalculator.setSkip
Defined in
submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:61
shouldBePushRangeList()
shouldBePushRangeList(): booleanReturns
boolean
Defined in
submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:448
toJson()
toJson(): {
formula: string;
refOffsetX: number;
refOffsetY: number;
}Returns
{
formula: string;
refOffsetX: number;
refOffsetY: number;
}| Name | Type | Defined in |
|---|---|---|
formula | string | submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:335 |
refOffsetX | number | submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:336 |
refOffsetY | number | submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:337 |
Defined in
submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:333
toRTreeItem()
toRTreeItem(): IUnitRange[]Returns
Defined in
submodules/univer/packages/engine-formula/src/engine/dependency/dependency-tree.ts:456