@univerjs-pro/engine-pivot v0.5.4
@univerjs-pro/engine-pivot
Enumerations
| Enumeration | Description |
|---|---|
| PivotCellStyleTypeEnum | Represents the pivot cell style type enum |
| PivotDataFieldDataTypeEnum | Enum for pivot table data field types. |
| PivotDataFieldSortOperatorEnum | Enum for pivot table data field sort types. |
| PivotDataFieldSortTypeEnum | Represents the sort types for pivot data fields. |
| PivotErrorTypeEnum | Enum for pivot table error types. |
| PivotFilterTypeEnum | Enum for pivot table data field types. |
| PivotLayoutTypeEnum | Enum for pivot table layout types. |
| PivotShowAsTypeEnum | Enum for pivot table show as types. |
| PivotSubtotalTypeEnum | Enum for pivot table subtotal types. |
| PivotTableChangeTypeEnum | Represents the change type of the pivot table. |
| PivotTableFiledAreaEnum | Enum for pivot table field types. |
| PivotTableValuePositionEnum | Enum for pivot table value field position types. in the pivot table, the value field can be placed in the column or row field. |
| PivotViewCellValueTypeEnum | - |
| ST_PivotFilterOperatorEnum | Enum for IST_PivotFilter Operator |
Classes
| Class | Description |
|---|---|
| DataField | Represents a data field in a pivot table , it match the excel pivot cache field data structure. |
| DataFieldManager | - |
| FieldsCollection | Represents the collection of fields in the pivot table. which one to one with a pivot table. |
| LabelViewItem | - |
| PageViewItem | - |
| PivotModel | PivotModel represents a config model for a pivot table. |
| PivotTable | PivotTable - represents the wrapper class pivot table. |
| PivotTableFieldBase | Represents a base class for the field in a pivot table. |
| PivotTableLabelField | Represents a label field in a pivot table. |
| PivotTableValueField | Represents a base class for the field in a pivot table. |
| PivotTuple | PivotTuple |
| PivotView | PivotView |
| PivotViewItem | - |
| SummaryManager | - |
Interfaces
| Interface | Description |
|---|---|
| IColumnNodeSizeInfo | - |
| IDataFieldInfo | - |
| IDataFieldJSON | Represents the data field serialized to JSON data structure. |
| IDataFieldManagerBaseJSON | - |
| IDateValue | - |
| IDimensionMapItem | - |
| IFieldsCollectionJSON | - |
| ILabelViewHeaderMapItem | - |
| ILabelViewItemJSON | - |
| IMeasuresMapItem | - |
| IMeasureTupleItem | - |
| INodeSizeInfo | - |
| IPageViewItemJSON | - |
| IPageViewItemRange | - |
| IPivotField | - |
| IPivotLayoutCtx | - |
| IPivotSummaryLevelPool | - |
| IPivotSummaryLevelPoolItem | - |
| IPivotTableAddFieldChange | The change of adding field to the pivot table. |
| IPivotTableCustomFilter | - |
| IPivotTableLabelFieldJSON | - |
| IPivotTableLabelFieldQueryData | Represents the query data for a label field in a pivot table. |
| IPivotTableLabelSortInfo | - |
| IPivotTableManualFilter | Represents the Pivot Table Manual Filter info |
| IPivotTableMeasureData | Represents the query data for a measure field in a pivot table. |
| IPivotTableOptions | Represents the data structure for a pivot table config, which is match CT_pivotTableDefinition |
| IPivotTableQueryData | Represents the data structure for a pivot table query. |
| IPivotTableRemoveFieldChange | The change of removing field from the pivot table. |
| IPivotTableRenameFieldChange | The change of renaming the field in the pivot table. |
| IPivotTableSetCollapseChange | The change of setting collapse to the field in the pivot table. |
| IPivotTableSetFilterInfoChange | The change of setting filter information to the field in the pivot table. |
| IPivotTableSetFormatChange | The change of setting format to the field in the pivot table. |
| IPivotTableSetOptionsChange | The change of setting options to the pivot table. |
| IPivotTableSetSortInfoChange | The change of setting sort information to the field in the pivot table. |
| IPivotTableSetSubtotalTypeChange | The change of setting subtotal type to the field in the pivot table. |
| IPivotTableShowDataAsInfo | - |
| IPivotTableSnapshot | Represents a snapshot of a pivot table. |
| IPivotTableUpdatePositionChange | The change of updating field position in the pivot table. |
| IPivotTableUpdateValuePositionChange | The change of updating value position in the pivot table. |
| IPivotTableValueFieldJSON | - |
| IPivotTableValueFieldQueryData | Represents the query data for a value field in a pivot table. |
| IPivotTableValueFilter | - |
| IPivotTableValueSortInfo | - |
| IPivotTuple | - |
| IPivotUpdateSourceChange | The change of updating source of the field in the pivot table. |
| IPivotViewCellData | - |
| IPivotViewErrorValue | - |
| IPivotViewInfo | Represents the pivot view info data structure, which is used to store row /col path and value index |
| IPivotViewItemData | - |
| IPivotViewItemJSON | - |
| IPivotViewJSON | - |
| IPivotViewPrefixValue | - |
| IRowNodeSizeInfo | - |
| ITPivotTupleInfo | - |
| ITupleItem | - |
Type Aliases
| Type alias | Description |
|---|---|
| IDataFieldValue | Represents the value of a data field in a pivot table data field |
| IPivotTableChangeSet | - |
| IPivotTableFilterInfo | - |
| IPivotTableSortInfo | - |
| IPivotViewValueType | - |
| ITupleItemSummary | - |
Functions
| Function | Description |
|---|---|
| cloneLabelFieldToValueField | Clone the label field to a value field. |
| cloneValueFieldToLabelField | Clone the value field to a label field. |
| createLabelField | - Create a label field from the JSON data. |
| createValueField | - Create a value field from the JSON data. |
| generateHexNumber | - Generate a random hex number text with specified length |
| getAutoDisplayName | - Get the auto display name of the value field. |
| isCustomFilter | -judge the filter info is customFilter filter |
| isDateValue | - judge the value is date like type |
| isErrorValue | judge the value is the error value, it will be a error value when the show data as or the product bigger than the max value of number in javascript |
| isManualFilter | -judge the filter info is manual filter |
| isPrefixValue | judge the value is the prefix value, once when the value is a subtotal and there are multiple value field, the value will be the prefix value |
| isValueFilter | -judge the filter info is customFilter filter |