@univerjs-pro/engine-pivot v0.5.0-beta.1 • Docs


Class: PageViewItem

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

Parameters

ParameterType
rangeIPageViewItemRange

Returns

void

Defined in

layout/pivot-view.ts:240


buildPathMap()

buildPathMap(considerValue): Record<string, number>

Parameters

ParameterType
considerValueboolean

Returns

Record<string, number>

Inherited from

PivotViewItem.buildPathMap

Defined in

layout/pivot-view.ts:152


fromJSON()

fromJSON(json): void

Parameters

ParameterType
jsonIPageViewItemJSON

Returns

void

Overrides

PivotViewItem.fromJSON

Defined in

layout/pivot-view.ts:278


getCell()

protected getCell(row, col): IPivotViewCellData

Parameters

ParameterType
rownumber
colnumber

Returns

IPivotViewCellData

Inherited from

PivotViewItem.getCell

Defined in

layout/pivot-view.ts:138


getColCount()

getColCount(): number

Returns

number

Inherited from

PivotViewItem.getColCount

Defined in

layout/pivot-view.ts:175


getLastCol()

getLastCol(): number

Returns

number

Overrides

PivotViewItem.getLastCol

Defined in

layout/pivot-view.ts:256


getLastRow()

getLastRow(): number

Returns

number

Overrides

PivotViewItem.getLastRow

Defined in

layout/pivot-view.ts:260


getRanges()

getRanges(): IPageViewItemRange[]

Returns

IPageViewItemRange[]

Defined in

layout/pivot-view.ts:244


getRowCount()

getRowCount(): number

Returns

number

Inherited from

PivotViewItem.getRowCount

Defined in

layout/pivot-view.ts:171


getStyle()

getStyle(row, col): undefined | PivotCellStyleTypeEnum

Parameters

ParameterType
rownumber
colnumber

Returns

undefined | PivotCellStyleTypeEnum

Inherited from

PivotViewItem.getStyle

Defined in

layout/pivot-view.ts:183


getValue()

getValue(row, col): IPivotViewValueType

Parameters

ParameterType
rownumber
colnumber

Returns

IPivotViewValueType

Inherited from

PivotViewItem.getValue

Defined in

layout/pivot-view.ts:179


setBlank()

setBlank(row, col): void

Parameters

ParameterType
rownumber
colnumber

Returns

void

Inherited from

PivotViewItem.setBlank

Defined in

layout/pivot-view.ts:133


setColCount()

setColCount(colCount): void

Parameters

ParameterType
colCountnumber

Returns

void

Inherited from

PivotViewItem.setColCount

Defined in

layout/pivot-view.ts:167


setInfo()

setInfo(index, info): void

Parameters

ParameterType
indexnumber
infoIPivotViewInfo

Returns

void

Inherited from

PivotViewItem.setInfo

Defined in

layout/pivot-view.ts:148


setLastCol()

setLastCol(col): void

Parameters

ParameterType
colnumber

Returns

void

Defined in

layout/pivot-view.ts:248


setLastRow()

setLastRow(row): void

Parameters

ParameterType
rownumber

Returns

void

Defined in

layout/pivot-view.ts:252


setPageIndex()

setPageIndex(
   row, 
   col, 
   index): void

Parameters

ParameterType
rownumber
colnumber
indexnumber

Returns

void

Defined in

layout/pivot-view.ts:235


setRowCount()

setRowCount(rowCount): void

Parameters

ParameterType
rowCountnumber

Returns

void

Inherited from

PivotViewItem.setRowCount

Defined in

layout/pivot-view.ts:163


setStyle()

setStyle(
   row, 
   col, 
   styleType): void

Parameters

ParameterType
rownumber
colnumber
styleTypePivotCellStyleTypeEnum

Returns

void

Inherited from

PivotViewItem.setStyle

Defined in

layout/pivot-view.ts:128


setValue()

setValue(
   row, 
   col, 
   value): void

Parameters

ParameterType
rownumber
colnumber
valueIPivotViewValueType

Returns

void

Inherited from

PivotViewItem.setValue

Defined in

layout/pivot-view.ts:121


toJSON()

toJSON(): IPageViewItemJSON

Returns

IPageViewItemJSON

Overrides

PivotViewItem.toJSON

Defined in

layout/pivot-view.ts:264