@univerjs-pro/engine-pivot v0.5.4


Class: PageViewItem

Defined in: layout/pivot-view.ts:220

Extends

Constructors

new PageViewItem()

new PageViewItem(): PageViewItem

Returns

PageViewItem

Inherited from

PivotViewItem.constructor

Properties

PropertyTypeDefault valueDescriptionOverridesInherited fromDefined in
colCountnumber0- how many cols in the view-PivotViewItem.colCountlayout/pivot-view.ts:100
dataIPivotViewItemData{}the data of the view, the key is the row index, the value is the column data-PivotViewItem.datalayout/pivot-view.ts:104
infoIPivotViewInfo[][]the info of the view, the index is the index of the view item, the value is the info of the view item-PivotViewItem.infolayout/pivot-view.ts:108
lastColnumber-1the last col index of the page viewPivotViewItem.lastCol-layout/pivot-view.ts:229
lastRownumber-1the last row index of the page viewPivotViewItem.lastRow-layout/pivot-view.ts:233
rangesIPageViewItemRange[][]the range group of the page view, all range is base on the left top of the page view--layout/pivot-view.ts:224
rowCountnumber0- how many rows in the view-PivotViewItem.rowCountlayout/pivot-view.ts:96

Methods

addRange()

addRange(range): void

Defined in: layout/pivot-view.ts:240

Parameters

ParameterType
rangeIPageViewItemRange

Returns

void


buildPathMap()

buildPathMap(considerValue): Record<string, number>

Defined in: layout/pivot-view.ts:152

Parameters

ParameterType
considerValueboolean

Returns

Record<string, number>

Inherited from

PivotViewItem.buildPathMap


fromJSON()

fromJSON(json): void

Defined in: layout/pivot-view.ts:278

Parameters

ParameterType
jsonIPageViewItemJSON

Returns

void

Overrides

PivotViewItem.fromJSON


getCell()

protected getCell(row, col): IPivotViewCellData

Defined in: layout/pivot-view.ts:138

Parameters

ParameterType
rownumber
colnumber

Returns

IPivotViewCellData

Inherited from

PivotViewItem.getCell


getColCount()

getColCount(): number

Defined in: layout/pivot-view.ts:175

Returns

number

Inherited from

PivotViewItem.getColCount


getLastCol()

getLastCol(): number

Defined in: layout/pivot-view.ts:256

Returns

number

Overrides

PivotViewItem.getLastCol


getLastRow()

getLastRow(): number

Defined in: layout/pivot-view.ts:260

Returns

number

Overrides

PivotViewItem.getLastRow


getRanges()

getRanges(): IPageViewItemRange[]

Defined in: layout/pivot-view.ts:244

Returns

IPageViewItemRange[]


getRowCount()

getRowCount(): number

Defined in: layout/pivot-view.ts:171

Returns

number

Inherited from

PivotViewItem.getRowCount


getStyle()

getStyle(row, col): 
  | undefined
  | PivotCellStyleTypeEnum

Defined in: layout/pivot-view.ts:183

Parameters

ParameterType
rownumber
colnumber

Returns

| undefined | PivotCellStyleTypeEnum

Inherited from

PivotViewItem.getStyle


getValue()

getValue(row, col): IPivotViewValueType

Defined in: layout/pivot-view.ts:179

Parameters

ParameterType
rownumber
colnumber

Returns

IPivotViewValueType

Inherited from

PivotViewItem.getValue


setBlank()

setBlank(row, col): void

Defined in: layout/pivot-view.ts:133

Parameters

ParameterType
rownumber
colnumber

Returns

void

Inherited from

PivotViewItem.setBlank


setColCount()

setColCount(colCount): void

Defined in: layout/pivot-view.ts:167

Parameters

ParameterType
colCountnumber

Returns

void

Inherited from

PivotViewItem.setColCount


setInfo()

setInfo(index, info): void

Defined in: layout/pivot-view.ts:148

Parameters

ParameterType
indexnumber
infoIPivotViewInfo

Returns

void

Inherited from

PivotViewItem.setInfo


setLastCol()

setLastCol(col): void

Defined in: layout/pivot-view.ts:248

Parameters

ParameterType
colnumber

Returns

void


setLastRow()

setLastRow(row): void

Defined in: layout/pivot-view.ts:252

Parameters

ParameterType
rownumber

Returns

void


setPageIndex()

setPageIndex(
   row, 
   col, 
   index): void

Defined in: layout/pivot-view.ts:235

Parameters

ParameterType
rownumber
colnumber
indexnumber

Returns

void


setRowCount()

setRowCount(rowCount): void

Defined in: layout/pivot-view.ts:163

Parameters

ParameterType
rowCountnumber

Returns

void

Inherited from

PivotViewItem.setRowCount


setStyle()

setStyle(
   row, 
   col, 
   styleType): void

Defined in: layout/pivot-view.ts:128

Parameters

ParameterType
rownumber
colnumber
styleTypePivotCellStyleTypeEnum

Returns

void

Inherited from

PivotViewItem.setStyle


setValue()

setValue(
   row, 
   col, 
   value): void

Defined in: layout/pivot-view.ts:121

Parameters

ParameterType
rownumber
colnumber
valueIPivotViewValueType

Returns

void

Inherited from

PivotViewItem.setValue


toJSON()

toJSON(): IPageViewItemJSON

Defined in: layout/pivot-view.ts:264

Returns

IPageViewItemJSON

Overrides

PivotViewItem.toJSON