@univerjs-pro/sheets-pivot v0.5.1 • Docs

Class: FWorkbookSheetsPivotMixin

FBase is a base class for all facade classes. It provides a way to extend classes with static and instance methods. The _initialize as a special method that will be called after the constructor. You should never call it directly.

Extends

• FWorkbook

Implements

• IFWorkbookSheetsPivotMixin

Constructors

new FWorkbookSheetsPivotMixin()

new FWorkbookSheetsPivotMixin(
   _workbook, 
   _injector, 
   _resourceLoaderService, 
   _selectionManagerService, 
   _univerInstanceService, 
   _commandService, 
   _permissionService, 
   _logService): FWorkbookSheetsPivotMixin

Parameters

Returns

FWorkbookSheetsPivotMixin

Inherited from

FWorkbook.constructor

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:27

Properties

Methods

_initialize()

_initialize(): void

Returns

void

Inherited from

FWorkbook._initialize

Defined in

submodules/univer/packages/core/src/facade/f-base.ts:33

addPivotTable()

addPivotTable(
   sourceInfo, 
   positionType, 
anchorCellInfo): Promise<undefined | FPivotTable>

Parameters

Returns

Promise<undefined | FPivotTable>

The added pivot table id.

Description

Add a pivot table to the Workbook.

Example

// should ensure the sheet range {0,0,8,6} is not empty
const fWorkbook = univerAPI.getActiveWorkbook()
const unitId = fWorkbook.getId()
const fSheet = fWorkbook.getActiveSheet();
const subUnitId = fSheet.getSheetId()
const sheetName = fSheet.getSheetName();
const sourceInfo = {
    unitId,
    subUnitId,
    sheetName,
    range: {
        startRow: 0,
        endRow: 8,
        startColumn: 0,
        endColumn: 6
    }
}
const anchorCellInfo = {
    unitId,
    subUnitId,
    row: 0,
    col: 8
}
const fp = await fWorkbook.addPivotTable(sourceInfo, 'exiting', anchorCellInfo)
// the addPivotTable is async, you can add pivot fields after the pivot table is added
// in the future, we will support pivot table added event, you can add pivot fields in the event handler
setTimeout(function() {
    fp.addField(1, 2)
    fp.addField(1, 3)
}, 1000)

Implementation of

IFWorkbookSheetsPivotMixin.addPivotTable

Overrides

FWorkbook.addPivotTable

Defined in

packages/sheets-pivot/src/facade/f-workbook.ts:73

create()

create(
   name, 
   rows, 
   column): FWorksheet

Create a new worksheet and returns a handle to it.

Parameters

Returns

FWorksheet

The new created sheet

Inherited from

FWorkbook.create

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:94

deleteSheet()

deleteSheet(sheet): void

Deletes the specified worksheet.

Parameters

Returns

void

Inherited from

FWorkbook.deleteSheet

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:189

getActiveRange()

getActiveRange(): null | FRange

Returns the selected range in the active sheet, or null if there is no active range.

Returns

null | FRange

the active range

Inherited from

FWorkbook.getActiveRange

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:303

getActiveSheet()

getActiveSheet(): FWorksheet

Get the active sheet of the workbook.

Returns

FWorksheet

The active sheet of the workbook

Inherited from

FWorkbook.getActiveSheet

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:72

getId()

getId(): string

Returns

string

Inherited from

FWorkbook.getId

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:42

getName()

getName(): string

Returns

string

Inherited from

FWorkbook.getName

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:46

getPivotTableByCell()

getPivotTableByCell(
   unitId, 
   subUnitId, 
   row, 
   col): undefined | FPivotTable

Parameters

Returns

undefined | FPivotTable

The pivot table id or undefined.

Description

Get the pivot table id by the cell.

Implementation of

IFWorkbookSheetsPivotMixin.getPivotTableByCell

Overrides

FWorkbook.getPivotTableByCell

Defined in

packages/sheets-pivot/src/facade/f-workbook.ts:93

getSheetByName()

getSheetByName(name): null | FWorksheet

Get a worksheet by sheet name.

Parameters

Returns

null | FWorksheet

The worksheet with given sheet name

Inherited from

FWorkbook.getSheetByName

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:139

getSheetBySheetId()

getSheetBySheetId(sheetId): null | FWorksheet

Get a worksheet by sheet id.

Parameters

Returns

null | FWorksheet

The worksheet with given sheet id

Inherited from

FWorkbook.getSheetBySheetId

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:125

getSheets()

getSheets(): FWorksheet[]

Gets all the worksheets in this workbook

Returns

FWorksheet[]

An array of all the worksheets in the workbook

Inherited from

FWorkbook.getSheets

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:81

getSnapshot()

getSnapshot(): IWorkbookData

Returns

IWorkbookData

{IWorkbookData}

Deprecated

use ‘save’ instead.

Memberof

FWorkbook

Inherited from

FWorkbook.getSnapshot

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:63

insertSheet()

insertSheet(): FWorksheet

Inserts a new worksheet into the workbook. Using a default sheet name. The new sheet becomes the active sheet

Returns

FWorksheet

The new sheet

Inherited from

FWorkbook.insertSheet

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:167

onBeforeCommandExecute()

onBeforeCommandExecute(callback): IDisposable

Register a callback that will be triggered before invoking a command targeting the Univer sheet.

Parameters

Returns

IDisposable

A function to dispose the listening.

Inherited from

FWorkbook.onBeforeCommandExecute

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:215

onCommandExecuted()

onCommandExecuted(callback): IDisposable

Register a callback that will be triggered when a command is invoked targeting the Univer sheet.

Parameters

Returns

IDisposable

A function to dispose the listening.

Inherited from

FWorkbook.onCommandExecuted

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:230

onSelectionChange()

onSelectionChange(callback): IDisposable

Parameters

Returns

IDisposable

Inherited from

FWorkbook.onSelectionChange

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:240

redo()

redo(): Promise<boolean>

Returns

Promise<boolean>

Inherited from

FWorkbook.redo

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:205

save()

save(): IWorkbookData

save workbook snapshot data, including conditional formatting, data validation, and other plugin data.

Returns

IWorkbookData

Inherited from

FWorkbook.save

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:53

setActiveRange()

setActiveRange(range): void

Sets the active selection region for this sheet.

Parameters

Returns

void

Inherited from

FWorkbook.setActiveRange

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:274

setActiveSheet()

setActiveSheet(sheet): FWorksheet

Sets the given worksheet to be the active worksheet in the workbook.

Parameters

Returns

FWorksheet

The active worksheet

Inherited from

FWorkbook.setActiveSheet

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:153

setEditable()

setEditable(value): void

Used to modify the editing permissions of the workbook. When the value is false, editing is not allowed.

Parameters

Returns

void

Inherited from

FWorkbook.setEditable

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:261

undo()

undo(): Promise<boolean>

Returns

Promise<boolean>

Inherited from

FWorkbook.undo

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:200

extend()

static extend(source): void

Parameters

Returns

void

Inherited from

FWorkbook.extend

Defined in

submodules/univer/packages/core/src/facade/f-base.ts:35