@univerjs/engine-formula v0.4.2 • Docs

Class: BaseReferenceObject

Extends

ObjectClassType

Extended by

RangeReferenceObject

Constructors

new BaseReferenceObject()

new BaseReferenceObject(_token): BaseReferenceObject

Parameters

Parameter	Type
`_token`	`string`

Returns

BaseReferenceObject

Overrides

ObjectClassType.constructor

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:77 (opens in a new tab)

Properties

Property	Type	Default value	Inherited from	Defined in
`pattern`	`string`	`''`	`ObjectClassType.pattern`	packages/engine-formula/src/basics/object-class-type.ts:18 (opens in a new tab)

Methods

dispose()

dispose(): void

Returns

void

Overrides

ObjectClassType.dispose

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:81 (opens in a new tab)

getActiveSheetColumnCount()

getActiveSheetColumnCount(): number

Returns

number

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:341 (opens in a new tab)

getActiveSheetRowCount()

getActiveSheetRowCount(): number

Returns

number

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:337 (opens in a new tab)

getArrayFormulaCellData()

getArrayFormulaCellData(): IRuntimeUnitDataType

Returns

IRuntimeUnitDataType

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:313 (opens in a new tab)

getCellByColumn()

getCellByColumn(column): 
  | ErrorValueObject
  | NullValueObject
  | NumberValueObject
  | BooleanValueObject
  | StringValueObject
  | ArrayValueObject

Parameters

Parameter	Type
`column`	`number`

Returns

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:430 (opens in a new tab)

getCellByPosition()

getCellByPosition(rowRaw?, columnRaw?): 
  | ErrorValueObject
  | NullValueObject
  | NumberValueObject
  | BooleanValueObject
  | StringValueObject
  | ArrayValueObject

Parameters

Parameter	Type
`rowRaw`?	`number`
`columnRaw`?	`number`

Returns

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:476 (opens in a new tab)

getCellByRow()

getCellByRow(row): 
  | ErrorValueObject
  | NullValueObject
  | NumberValueObject
  | BooleanValueObject
  | StringValueObject
  | ArrayValueObject

Parameters

Parameter	Type
`row`	`number`

Returns

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:426 (opens in a new tab)

getCellData()

getCellData(row, column): Nullable<ICellData>

Parameters

Parameter	Type
`row`	`number`
`column`	`number`

Returns

Nullable<ICellData>

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:454 (opens in a new tab)

getCellPattern()

getCellPattern(
   unitId, 
   sheetId, 
   row, 
   column): string

Get the pattern of the cell

Parameters

Parameter	Type
`unitId`	`string`
`sheetId`	`string`
`row`	`number`
`column`	`number`

Returns

string

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:504 (opens in a new tab)

getCellValueObject()

getCellValueObject(cell): 
  | ErrorValueObject
  | NullValueObject
  | NumberValueObject
  | BooleanValueObject
  | StringValueObject
  | ArrayValueObject

Parameters

Parameter	Type
`cell`	`ICellData`

Returns

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:396 (opens in a new tab)

getColumnCount()

getColumnCount(): number

Returns

number

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:349 (opens in a new tab)

getColumnData()

getColumnData(): IObjectArrayPrimitiveType<Partial<IColumnData>>

Returns

IObjectArrayPrimitiveType<Partial<IColumnData>>

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:357 (opens in a new tab)

getCurrentActiveArrayFormulaCellData()

getCurrentActiveArrayFormulaCellData(): undefined | ObjectMatrix<Nullable<ICellData>>

Returns

undefined | ObjectMatrix<Nullable<ICellData>>

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:446 (opens in a new tab)

getCurrentActiveSheetData()

getCurrentActiveSheetData(): ISheetItem

Returns

ISheetItem

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:434 (opens in a new tab)

getCurrentRuntimeActiveArrayFormulaCellData()

getCurrentRuntimeActiveArrayFormulaCellData(): undefined | ObjectMatrix<Nullable<ICellData>>

Returns

undefined | ObjectMatrix<Nullable<ICellData>>

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:450 (opens in a new tab)

getCurrentRuntimeSheetData()

getCurrentRuntimeSheetData(): undefined | ObjectMatrix<Nullable<ICellData>>

Returns

undefined | ObjectMatrix<Nullable<ICellData>>

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:442 (opens in a new tab)

getCurrentStylesData()

getCurrentStylesData(): Styles

Returns

Styles

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:438 (opens in a new tab)

getDefaultSheetId()

getDefaultSheetId(): string

Returns

string

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:277 (opens in a new tab)

getDefaultUnitId()

getDefaultUnitId(): string

Returns

string

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:285 (opens in a new tab)

getFirstCell()

getFirstCell(): 
  | ErrorValueObject
  | NullValueObject
  | NumberValueObject
  | BooleanValueObject
  | StringValueObject
  | ArrayValueObject

Returns

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:196 (opens in a new tab)

getForcedSheetId()

getForcedSheetId(): Nullable<string>

Returns

Nullable<string>

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:259 (opens in a new tab)

getForcedSheetName()

getForcedSheetName(): string

Returns

string

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:269 (opens in a new tab)

getForcedUnitId()

getForcedUnitId(): string

Returns

string

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:247 (opens in a new tab)

getPattern()

getPattern(): string

Returns

string

Inherited from

ObjectClassType.getPattern

Defined in

packages/engine-formula/src/basics/object-class-type.ts:24 (opens in a new tab)

getRangeData()

getRangeData(): IRange

Returns

IRange

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:219 (opens in a new tab)

getRangePosition()

getRangePosition(): {
  endAbsoluteRefType: AbsoluteRefType;
  endColumn: number;
  endRow: number;
  rangeType: RANGE_TYPE;
  sheetId: string;
  startAbsoluteRefType: AbsoluteRefType;
  startColumn: number;
  startRow: number;
  unitId: string;
}

Returns

{
  endAbsoluteRefType: AbsoluteRefType;
  endColumn: number;
  endRow: number;
  rangeType: RANGE_TYPE;
  sheetId: string;
  startAbsoluteRefType: AbsoluteRefType;
  startColumn: number;
  startRow: number;
  unitId: string;
}

Name	Type	Description	Defined in
`endAbsoluteRefType`	`AbsoluteRefType`	-	packages/core/src/sheets/typedef.ts:442 (opens in a new tab)
`endColumn`	`number`	-	packages/engine-formula/src/engine/reference-object/base-reference-object.ts:142 (opens in a new tab)
`endRow`	`number`	-	packages/engine-formula/src/engine/reference-object/base-reference-object.ts:140 (opens in a new tab)
`rangeType`	`RANGE_TYPE`	-	packages/core/src/sheets/typedef.ts:438 (opens in a new tab)
`sheetId`	`string`	Id of the Worksheet the range belongs to. When this field is not defined, it should be considered as the range in the currently activated worksheet.	packages/core/src/sheets/typedef.ts:391 (opens in a new tab)
`startAbsoluteRefType`	`AbsoluteRefType`	-	packages/core/src/sheets/typedef.ts:440 (opens in a new tab)
`startColumn`	`number`	-	packages/engine-formula/src/engine/reference-object/base-reference-object.ts:141 (opens in a new tab)
`startRow`	`number`	-	packages/engine-formula/src/engine/reference-object/base-reference-object.ts:139 (opens in a new tab)
`unitId`	`string`	Id of the Workbook the range belongs to. When this field is not defined, it should be considered as the range in the currently activated worksheet.	packages/core/src/sheets/typedef.ts:385 (opens in a new tab)

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:118 (opens in a new tab)

getRefOffset()

getRefOffset(): {
  x: number;
  y: number;
}

Returns

{
  x: number;
  y: number;
}

Name	Type	Defined in
`x`	`number`	packages/engine-formula/src/engine/reference-object/base-reference-object.ts:113 (opens in a new tab)
`y`	`number`	packages/engine-formula/src/engine/reference-object/base-reference-object.ts:114 (opens in a new tab)

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:111 (opens in a new tab)

getRowCount()

getRowCount(): number

Returns

number

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:345 (opens in a new tab)

getRowData()

getRowData(): IObjectArrayPrimitiveType<Partial<IRowData>>

Returns

IObjectArrayPrimitiveType<Partial<IRowData>>

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:353 (opens in a new tab)

getRuntimeArrayFormulaCellData()

getRuntimeArrayFormulaCellData(): IRuntimeUnitDataType

Returns

IRuntimeUnitDataType

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:321 (opens in a new tab)

getRuntimeData()

getRuntimeData(): IRuntimeUnitDataType

Returns

IRuntimeUnitDataType

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:305 (opens in a new tab)

getRuntimeFeatureCellData()

getRuntimeFeatureCellData(): {}

Returns

{}

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:329 (opens in a new tab)

getRuntimeFeatureCellValue()

getRuntimeFeatureCellValue(row, column): undefined | ICellData

Parameters

Parameter	Type
`row`	`number`
`column`	`number`

Returns

undefined | ICellData

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:472 (opens in a new tab)

getSheetId()

getSheetId(): string

Returns

string

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:234 (opens in a new tab)

getToken()

getToken(): string

Returns

string

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:89 (opens in a new tab)

getUnitData()

getUnitData(): IUnitData

Returns

IUnitData

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:289 (opens in a new tab)

getUnitId()

getUnitId(): string

Returns

string

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:227 (opens in a new tab)

getUnitStylesData()

getUnitStylesData(): IUnitStylesData

Returns

IUnitStylesData

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:297 (opens in a new tab)

isArray()

isArray(): boolean

Returns

boolean

Inherited from

ObjectClassType.isArray

Defined in

packages/engine-formula/src/basics/object-class-type.ts:52 (opens in a new tab)

isAsyncArrayObject()

isAsyncArrayObject(): boolean

Returns

boolean

Inherited from

ObjectClassType.isAsyncArrayObject

Defined in

packages/engine-formula/src/basics/object-class-type.ts:44 (opens in a new tab)

isAsyncObject()

isAsyncObject(): boolean

Returns

boolean

Inherited from

ObjectClassType.isAsyncObject

Defined in

packages/engine-formula/src/basics/object-class-type.ts:40 (opens in a new tab)

isCell()

isCell(): boolean

Returns

boolean

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:361 (opens in a new tab)

isColumn()

isColumn(): boolean

Returns

boolean

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:365 (opens in a new tab)

isEqualType()

isEqualType(object): boolean

Parameters

Parameter	Type
`object`	`ObjectClassType`

Returns

boolean

Inherited from

ObjectClassType.isEqualType

Defined in

packages/engine-formula/src/basics/object-class-type.ts:60 (opens in a new tab)

isError()

isError(): boolean

Returns

boolean

Inherited from

ObjectClassType.isError

Defined in

packages/engine-formula/src/basics/object-class-type.ts:36 (opens in a new tab)

isExceedRange()

isExceedRange(): boolean

Returns

boolean

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:97 (opens in a new tab)

isRange()

isRange(): boolean

Returns

boolean

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:373 (opens in a new tab)

isReferenceObject()

isReferenceObject(): boolean

Returns

boolean

Overrides

ObjectClassType.isReferenceObject

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:146 (opens in a new tab)

isRow()

isRow(): boolean

Returns

boolean

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:369 (opens in a new tab)

isTable()

isTable(): boolean

Returns

boolean

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:377 (opens in a new tab)

isValueObject()

isValueObject(): boolean

Returns

boolean

Inherited from

ObjectClassType.isValueObject

Defined in

packages/engine-formula/src/basics/object-class-type.ts:56 (opens in a new tab)

iterator()

iterator(callback): Nullable<boolean>

Parameters

Parameter	Type
`callback`	(`valueObject`, `rowIndex`, `columnIndex`) => `Nullable`<`boolean`>

Returns

Nullable<boolean>

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:150 (opens in a new tab)

setArrayFormulaCellData()

setArrayFormulaCellData(unitData): void

Parameters

Parameter	Type
`unitData`	`IRuntimeUnitDataType`

Returns

void

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:317 (opens in a new tab)

setDefaultSheetId()

setDefaultSheetId(sheetId): void

Parameters

Parameter	Type
`sheetId`	`string`

Returns

void

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:273 (opens in a new tab)

setDefaultUnitId()

setDefaultUnitId(unitId): void

Parameters

Parameter	Type
`unitId`	`string`

Returns

void

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:281 (opens in a new tab)

setForcedSheetId()

setForcedSheetId(sheetNameMap): void

Parameters

Parameter	Type
`sheetNameMap`	`IUnitSheetNameMap`

Returns

void

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:251 (opens in a new tab)

setForcedSheetIdDirect()

setForcedSheetIdDirect(sheetId): void

Parameters

Parameter	Type
`sheetId`	`string`

Returns

void

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:255 (opens in a new tab)

setForcedSheetName()

setForcedSheetName(sheetName): void

Parameters

Parameter	Type
`sheetName`	`string`

Returns

void

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:263 (opens in a new tab)

setForcedUnitIdDirect()

setForcedUnitIdDirect(unitId): void

Parameters

Parameter	Type
`unitId`	`string`

Returns

void

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:241 (opens in a new tab)

setPattern()

setPattern(pattern): void

Only used in NumberValueObject

Parameters

Parameter	Type
`pattern`	`string`

Returns

void

Inherited from

ObjectClassType.setPattern

Defined in

packages/engine-formula/src/basics/object-class-type.ts:32 (opens in a new tab)

setRangeData()

setRangeData(range): void

Parameters

Parameter	Type
`range`	`IRange`

Returns

void

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:223 (opens in a new tab)

setRefOffset()

setRefOffset(x, y): void

Parameters

Parameter	Type	Default value
`x`	`number`	`0`
`y`	`number`	`0`

Returns

void

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:106 (opens in a new tab)

setRuntimeArrayFormulaCellData()

setRuntimeArrayFormulaCellData(unitData): void

Parameters

Parameter	Type
`unitData`	`IRuntimeUnitDataType`

Returns

void

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:325 (opens in a new tab)

setRuntimeData()

setRuntimeData(runtimeData): void

Parameters

Parameter	Type
`runtimeData`	`IRuntimeUnitDataType`

Returns

void

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:309 (opens in a new tab)

setRuntimeFeatureCellData()

setRuntimeFeatureCellData(unitData): void

Parameters

Parameter	Type
`unitData`	`object`

Returns

void

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:333 (opens in a new tab)

setToken()

setToken(token): void

Parameters

Parameter	Type
`token`	`string`

Returns

void

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:93 (opens in a new tab)

setUnitData()

setUnitData(unitData): void

Parameters

Parameter	Type
`unitData`	`IUnitData`

Returns

void

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:293 (opens in a new tab)

setUnitStylesData()

setUnitStylesData(unitStylesData): void

Parameters

Parameter	Type
`unitStylesData`	`IUnitStylesData`

Returns

void

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:301 (opens in a new tab)

toArrayValueObject()

toArrayValueObject(useCache): ArrayValueObject

Parameters

Parameter	Type	Default value
`useCache`	`boolean`	`true`

Returns

ArrayValueObject

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:522 (opens in a new tab)

toUnitRange()

toUnitRange(): {
  range: {
     endAbsoluteRefType: AbsoluteRefType;
     endColumn: number;
     endRow: number;
     rangeType: RANGE_TYPE;
     sheetId: string;
     startAbsoluteRefType: AbsoluteRefType;
     startColumn: number;
     startRow: number;
     unitId: string;
    };
  sheetId: string;
  unitId: string;
}

Returns

{
  range: {
     endAbsoluteRefType: AbsoluteRefType;
     endColumn: number;
     endRow: number;
     rangeType: RANGE_TYPE;
     sheetId: string;
     startAbsoluteRefType: AbsoluteRefType;
     startColumn: number;
     startRow: number;
     unitId: string;
    };
  sheetId: string;
  unitId: string;
}

Name	Type	Description	Defined in
`range`	{ `endAbsoluteRefType`: `AbsoluteRefType`; `endColumn`: `number`; `endRow`: `number`; `rangeType`: `RANGE_TYPE`; `sheetId`: `string`; `startAbsoluteRefType`: `AbsoluteRefType`; `startColumn`: `number`; `startRow`: `number`; `unitId`: `string`; }	-	packages/engine-formula/src/engine/reference-object/base-reference-object.ts:574 (opens in a new tab)
`range.endAbsoluteRefType`	`AbsoluteRefType`	-	packages/core/src/sheets/typedef.ts:442 (opens in a new tab)
`range.endColumn`	`number`	-	packages/engine-formula/src/engine/reference-object/base-reference-object.ts:142 (opens in a new tab)
`range.endRow`	`number`	-	packages/engine-formula/src/engine/reference-object/base-reference-object.ts:140 (opens in a new tab)
`range.rangeType`	`RANGE_TYPE`	-	packages/core/src/sheets/typedef.ts:438 (opens in a new tab)
`range.sheetId`	`string`	Id of the Worksheet the range belongs to. When this field is not defined, it should be considered as the range in the currently activated worksheet.	packages/core/src/sheets/typedef.ts:391 (opens in a new tab)
`range.startAbsoluteRefType`	`AbsoluteRefType`	-	packages/core/src/sheets/typedef.ts:440 (opens in a new tab)
`range.startColumn`	`number`	-	packages/engine-formula/src/engine/reference-object/base-reference-object.ts:141 (opens in a new tab)
`range.startRow`	`number`	-	packages/engine-formula/src/engine/reference-object/base-reference-object.ts:139 (opens in a new tab)
`range.unitId`	`string`	Id of the Workbook the range belongs to. When this field is not defined, it should be considered as the range in the currently activated worksheet.	packages/core/src/sheets/typedef.ts:385 (opens in a new tab)
`sheetId`	`string`	-	packages/engine-formula/src/engine/reference-object/base-reference-object.ts:575 (opens in a new tab)
`unitId`	`string`	-	packages/engine-formula/src/engine/reference-object/base-reference-object.ts:576 (opens in a new tab)

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:572 (opens in a new tab)

unionBy()

unionBy(referenceObject): NodeValueType

Parameters

Parameter	Type
`referenceObject`	`BaseReferenceObject`

Returns

NodeValueType

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:381 (opens in a new tab)

unionRange()

unionRange(rangeData1, rangeData2): IRange

Parameters

Parameter	Type
`rangeData1`	`IRange`
`rangeData2`	`IRange`

Returns

IRange

Defined in

packages/engine-formula/src/engine/reference-object/base-reference-object.ts:386 (opens in a new tab)

Basefunction Basevalueobject