Class: BaseReferenceObject

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:44

Extends

ObjectClassType

Extended by

RangeReferenceObject

Constructors

new BaseReferenceObject()

new BaseReferenceObject(_token): BaseReferenceObject

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:78

Parameters

Parameter	Type
`_token`	`string`

Returns

BaseReferenceObject

Overrides

ObjectClassType.constructor

Properties

Property	Type	Default value	Inherited from	Defined in
`pattern`	`string`	`''`	`ObjectClassType.pattern`	submodules/univer/packages/engine-formula/src/basics/object-class-type.ts:18

Methods

dispose()

dispose(): void

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:82

Returns

void

Overrides

ObjectClassType.dispose

getActiveSheetColumnCount()

getActiveSheetColumnCount(): number

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:342

Returns

number

getActiveSheetRowCount()

getActiveSheetRowCount(): number

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:338

Returns

number

getArrayFormulaCellData()

getArrayFormulaCellData(): IRuntimeUnitDataType

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:314

Returns

IRuntimeUnitDataType

getCellByColumn()

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

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:431

Parameters

Parameter	Type
`column`	`number`

Returns

getCellByPosition()

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

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:477

Parameters

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

Returns

getCellByRow()

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

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:427

Parameters

Parameter	Type
`row`	`number`

Returns

getCellData()

getCellData(row, column): Nullable<ICellData>

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:455

Parameters

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

Returns

Nullable<ICellData>

getCellPattern()

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

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:505

Get the pattern of the cell

Parameters

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

Returns

string

getCellValueObject()

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

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:397

Parameters

Parameter	Type
`cell`	`ICellData`

Returns

getColumnCount()

getColumnCount(): number

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:350

Returns

number

getColumnData()

getColumnData(): IObjectArrayPrimitiveType<Partial<IColumnData>>

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:358

Returns

IObjectArrayPrimitiveType<Partial<IColumnData>>

getCurrentActiveArrayFormulaCellData()

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

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:447

Returns

| undefined | ObjectMatrix<Nullable<ICellData>>

getCurrentActiveSheetData()

getCurrentActiveSheetData(): ISheetItem

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:435

Returns

ISheetItem

getCurrentRuntimeActiveArrayFormulaCellData()

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

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:451

Returns

| undefined | ObjectMatrix<Nullable<ICellData>>

getCurrentRuntimeSheetData()

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

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:443

Returns

| undefined | ObjectMatrix<Nullable<ICellData>>

getCurrentStylesData()

getCurrentStylesData(): Styles

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:439

Returns

Styles

getDefaultSheetId()

getDefaultSheetId(): string

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:278

Returns

string

getDefaultUnitId()

getDefaultUnitId(): string

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:286

Returns

string

getFirstCell()

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

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:197

Returns

getForcedSheetId()

getForcedSheetId(): Nullable<string>

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:260

Returns

Nullable<string>

getForcedSheetName()

getForcedSheetName(): string

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:270

Returns

string

getForcedUnitId()

getForcedUnitId(): string

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:248

Returns

string

getPattern()

getPattern(): string

Defined in: submodules/univer/packages/engine-formula/src/basics/object-class-type.ts:24

Returns

string

Inherited from

ObjectClassType.getPattern

getRangeData()

getRangeData(): IRange

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:220

Returns

IRange

getRangePosition()

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

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:119

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`	-	submodules/univer/packages/core/src/sheets/typedef.ts:473
`endColumn`	`number`	-	submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:143
`endRow`	`number`	-	submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:141
`rangeType`?	`RANGE_TYPE`	-	submodules/univer/packages/core/src/sheets/typedef.ts:469
`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.	submodules/univer/packages/core/src/sheets/typedef.ts:422
`startAbsoluteRefType`?	`AbsoluteRefType`	-	submodules/univer/packages/core/src/sheets/typedef.ts:471
`startColumn`	`number`	-	submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:142
`startRow`	`number`	-	submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:140
`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.	submodules/univer/packages/core/src/sheets/typedef.ts:416

getRefOffset()

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

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:112

Returns

{
  x: number;
  y: number;
}

Name	Type	Defined in
`x`	`number`	submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:114
`y`	`number`	submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:115

getRowCount()

getRowCount(): number

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:346

Returns

number

getRowData()

getRowData(): IObjectArrayPrimitiveType<Partial<IRowData>>

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:354

Returns

IObjectArrayPrimitiveType<Partial<IRowData>>

getRuntimeArrayFormulaCellData()

getRuntimeArrayFormulaCellData(): IRuntimeUnitDataType

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:322

Returns

IRuntimeUnitDataType

getRuntimeData()

getRuntimeData(): IRuntimeUnitDataType

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:306

Returns

IRuntimeUnitDataType

getRuntimeFeatureCellData()

getRuntimeFeatureCellData(): {}

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:330

Returns

{}

getRuntimeFeatureCellValue()

getRuntimeFeatureCellValue(row, column): undefined | ICellData

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:473

Parameters

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

Returns

undefined | ICellData

getSheetId()

getSheetId(): string

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:235

Returns

string

getToken()

getToken(): string

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:90

Returns

string

getUnitData()

getUnitData(): IUnitData

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:290

Returns

IUnitData

getUnitId()

getUnitId(): string

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:228

Returns

string

getUnitStylesData()

getUnitStylesData(): IUnitStylesData

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:298

Returns

IUnitStylesData

isArray()

isArray(): boolean

Defined in: submodules/univer/packages/engine-formula/src/basics/object-class-type.ts:52

Returns

boolean

Inherited from

ObjectClassType.isArray

isAsyncArrayObject()

isAsyncArrayObject(): boolean

Defined in: submodules/univer/packages/engine-formula/src/basics/object-class-type.ts:44

Returns

boolean

Inherited from

ObjectClassType.isAsyncArrayObject

isAsyncObject()

isAsyncObject(): boolean

Defined in: submodules/univer/packages/engine-formula/src/basics/object-class-type.ts:40

Returns

boolean

Inherited from

ObjectClassType.isAsyncObject

isCell()

isCell(): boolean

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:362

Returns

boolean

isColumn()

isColumn(): boolean

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:366

Returns

boolean

isEqualType()

isEqualType(object): boolean

Defined in: submodules/univer/packages/engine-formula/src/basics/object-class-type.ts:60

Parameters

Parameter	Type
`object`	`ObjectClassType`

Returns

boolean

Inherited from

ObjectClassType.isEqualType

isError()

isError(): boolean

Defined in: submodules/univer/packages/engine-formula/src/basics/object-class-type.ts:36

Returns

boolean

Inherited from

ObjectClassType.isError

isExceedRange()

isExceedRange(): boolean

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:98

Returns

boolean

isRange()

isRange(): boolean

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:374

Returns

boolean

isReferenceObject()

isReferenceObject(): boolean

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:147

Returns

boolean

Overrides

ObjectClassType.isReferenceObject

isRow()

isRow(): boolean

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:370

Returns

boolean

isTable()

isTable(): boolean

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:378

Returns

boolean

isValueObject()

isValueObject(): boolean

Defined in: submodules/univer/packages/engine-formula/src/basics/object-class-type.ts:56

Returns

boolean

Inherited from

ObjectClassType.isValueObject

iterator()

iterator(callback): Nullable<boolean>

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:151

Parameters

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

Returns

Nullable<boolean>

setArrayFormulaCellData()

setArrayFormulaCellData(unitData): void

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:318

Parameters

Parameter	Type
`unitData`	`IRuntimeUnitDataType`

Returns

void

setDefaultSheetId()

setDefaultSheetId(sheetId): void

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:274

Parameters

Parameter	Type
`sheetId`	`string`

Returns

void

setDefaultUnitId()

setDefaultUnitId(unitId): void

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:282

Parameters

Parameter	Type
`unitId`	`string`

Returns

void

setForcedSheetId()

setForcedSheetId(sheetNameMap): void

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:252

Parameters

Parameter	Type
`sheetNameMap`	`IUnitSheetNameMap`

Returns

void

setForcedSheetIdDirect()

setForcedSheetIdDirect(sheetId): void

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:256

Parameters

Parameter	Type
`sheetId`	`string`

Returns

void

setForcedSheetName()

setForcedSheetName(sheetName): void

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:264

Parameters

Parameter	Type
`sheetName`	`string`

Returns

void

setForcedUnitIdDirect()

setForcedUnitIdDirect(unitId): void

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:242

Parameters

Parameter	Type
`unitId`	`string`

Returns

void

setPattern()

setPattern(pattern): void

Defined in: submodules/univer/packages/engine-formula/src/basics/object-class-type.ts:32

Only used in NumberValueObject

Parameters

Parameter	Type
`pattern`	`string`

Returns

void

Inherited from

ObjectClassType.setPattern

setRangeData()

setRangeData(range): void

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:224

Parameters

Parameter	Type
`range`	`IRange`

Returns

void

setRefOffset()

setRefOffset(x, y): void

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:107

Parameters

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

Returns

void

setRuntimeArrayFormulaCellData()

setRuntimeArrayFormulaCellData(unitData): void

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:326

Parameters

Parameter	Type
`unitData`	`IRuntimeUnitDataType`

Returns

void

setRuntimeData()

setRuntimeData(runtimeData): void

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:310

Parameters

Parameter	Type
`runtimeData`	`IRuntimeUnitDataType`

Returns

void

setRuntimeFeatureCellData()

setRuntimeFeatureCellData(unitData): void

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:334

Parameters

Parameter	Type
`unitData`	{}

Returns

void

setToken()

setToken(token): void

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:94

Parameters

Parameter	Type
`token`	`string`

Returns

void

setUnitData()

setUnitData(unitData): void

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:294

Parameters

Parameter	Type
`unitData`	`IUnitData`

Returns

void

setUnitStylesData()

setUnitStylesData(unitStylesData): void

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:302

Parameters

Parameter	Type
`unitStylesData`	`IUnitStylesData`

Returns

void

toArrayValueObject()

toArrayValueObject(useCache): ArrayValueObject

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:523

Parameters

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

Returns

ArrayValueObject

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;
}

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:573

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`; }	-	submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:575
`range.endAbsoluteRefType`?	`AbsoluteRefType`	-	submodules/univer/packages/core/src/sheets/typedef.ts:473
`range.endColumn`	`number`	-	submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:143
`range.endRow`	`number`	-	submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:141
`range.rangeType`?	`RANGE_TYPE`	-	submodules/univer/packages/core/src/sheets/typedef.ts:469
`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.	submodules/univer/packages/core/src/sheets/typedef.ts:422
`range.startAbsoluteRefType`?	`AbsoluteRefType`	-	submodules/univer/packages/core/src/sheets/typedef.ts:471
`range.startColumn`	`number`	-	submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:142
`range.startRow`	`number`	-	submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:140
`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.	submodules/univer/packages/core/src/sheets/typedef.ts:416
`sheetId`	`string`	-	submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:576
`unitId`	`string`	-	submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:577

unionBy()

unionBy(referenceObject): NodeValueType

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:382

Parameters

Parameter	Type
`referenceObject`	`BaseReferenceObject`

Returns

NodeValueType

unionRange()

unionRange(rangeData1, rangeData2): IRange

Defined in: submodules/univer/packages/engine-formula/src/engine/reference-object/base-reference-object.ts:387

Parameters

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

Returns

IRange

Basefunction Basevalueobject