Class: FEnum

AxisAlignEnum

any

Represents the alignment of the axis. AxisAlignEnum The possible values are: START, CENTER, END.

Example

const fWorkbook = univerAPI.getActiveWorkbook();
const fSheet = fWorkbook.getActiveSheet();
const chartBuilder = fSheet.newChart().asLineChart();
const chartInfo = chartBuilder.addRange('A1:B8')
.setChartType(univerAPI.Enum.ChartType.Line)
.setAxisAlign(univerAPI.Enum.AxisAlignEnum.START)
.build();
fSheet.insertChart(chartInfo);

ChartBorderDashType

any

Represents the type of the border dash. ChartBorderDashType The possible values are: SOLID, DOTTED, DASHED.

Example

const fWorkbook = univerAPI.getActiveWorkbook();
const fSheet = fWorkbook.getActiveSheet();
const chartBuilder = fSheet.newChart().asLineChart();
const chartInfo = chartBuilder.addRange('A1:B8')
.setChartType(univerAPI.Enum.ChartType.Line)
.setAxisPointerStyle({
     indicatorLabelColor: '#ff0000',
     indicatorLineType: univerAPI.Enum.ChartBorderDashType.Solid,
     indicatorLineColor: '#00ff00',
     indicatorLabelTextColor: '#0000ff',
 })
.build();
fSheet.insertChart(chartInfo);

ChartType

any

Represents the type of the chart. ChartTypeBits

Description

This enum is used to specify the type of the chart. Which is binary-like value, each bit represents a type of the chart.

Example

const fWorkbook = univerAPI.getActiveWorkbook();
const fSheet = fWorkbook.getActiveSheet();
const chartBuilder = fSheet.newChart().asRadarChart();
const chartInfo = chartBuilder.addRange('A1:B8')
.setChartType(univerAPI.Enum.ChartType.Radar)
.setShape(univerAPI.Enum.RadarShape.Polygon)
.setFill(true)
.build();
fSheet.insertChart(chartInfo);

CustomFilterOperator

any

Please refer to CustomFilterOperator.

DrawingType

typeof DrawingTypeEnum

Please refer to DrawingTypeEnum.

ImageSourceType

Omit<any, "UUID">

Please refer to ImageSourceType.

LegendPositionEnum

any

Represents the position of the legend in the chart. LegendPositionEnum The possible values are: BOTTOM, TOP, LEFT, RIGHT, HIDE.

Example

const fWorkbook = univerAPI.getActiveWorkbook();
const fSheet = fWorkbook.getActiveSheet();
const chartBuilder = fSheet.newChart();
const chartInfo = chartBuilder.addRange('A1:B8')
.setChartType(univerAPI.Enum.ChartType.Line)
.setOptions('legend.position', univerAPI.Enum.LegendPositionEnum.TOP)
.build();
fSheet.insertChart(chartInfo);

LinePointShape

any

Represents the shape of the data point in the line chart. LinePointShape

Example

const fWorkbook = univerAPI.getActiveWorkbook();
const fSheet = fWorkbook.getActiveSheet();
const chartBuilder = fSheet.newChart().asLineChart();
const chartInfo = chartBuilder.addRange('A1:B8')
.setChartType(univerAPI.Enum.ChartType.Line)
.setDataPointShape(univerAPI.Enum.LinePointShape.CIRCLE)
.build();
fSheet.insertChart(chartInfo);

PivotDataFieldDataTypeEnum

any

Represents the data type of the pivot data field. PivotDataFieldDataTypeEnum

Description

This is enum is used to specify the data type of the pivot source field.

PivotDataFieldSortOperatorEnum

any

Represents the sort operator of the pivot data field. PivotDataFieldSortOperatorEnum

PivotDataFieldSortTypeEnum

any

Represents the sort type of the pivot data field. PivotDataFieldSortTypeEnum

PivotFilterOperatorEnum

any

Represents the filter operator of the pivot filter. ST_PivotFilterOperatorEnum

PivotFilterTypeEnum

any

Represents the filter type of the pivot table. PivotFilterTypeEnum

PivotSubtotalTypeEnum

any

Represents the subtotal type of the pivot table. PivotSubtotalTypeEnum

PivotTableChangeTypeEnum

any

Represents the change type of the pivot table. PivotTableChangeTypeEnum

PivotTableFiledAreaEnum

any

Represents the field area of the pivot table. PivotTableFiledAreaEnum

PivotTableValuePositionEnum

any

Represents the value position of the pivot table. PivotTableValuePositionEnum

Description

In excel pivot table, the value position can be placed in the row, column area, but only there are more than one value field it will be placed.

PositionTypeEnum

any

Represents the position type of the pivot table. PositionType

PrintAlign

any

Print alignment settings for content positioning

PrintArea

any

Print area setting that determines which part of the spreadsheet to print

PrintDirection

any

Page orientation setting (Portrait/Landscape)

PrintFreeze

any

Freeze pane settings for printing

PrintHeaderFooter

any

Header and footer content options

PrintHeaderFooterSymbol

any

Special symbols/placeholders available for headers and footers

PrintPaperMargin

any

Margin presets for the printed page

PrintPaperSize

any

Paper size options for printing (e.g., A4, Letter)

PrintScale

any

Print scaling options to fit content to page

SelectModeEnum

any

Represents the selection mode of the chart. SelectModeEnum The possible values are: SINGLE, MULTIPLE, Close. It used to specify the selection mode of the chart legend.

Example

const fWorkbook = univerAPI.getActiveWorkbook();
const fSheet = fWorkbook.getActiveSheet();
const chartBuilder = fSheet.newChart().asLineChart();
const chartInfo = chartBuilder.addRange('A1:B8')
.setChartType(univerAPI.Enum.ChartType.Line)
.setOptions('legend.selectMode', univerAPI.Enum.SelectModeEnum.SINGLE)
.build();
fSheet.insertChart(chartInfo);

SheetDrawingAnchorType

any

Please refer to SheetDrawingAnchorType.

SheetSkeletonChangeType

any

Sheet skeleton change command types. These commands affect the structure of the worksheet. Includes operations like changing row/column dimensions, visibility, and grid properties.

SheetValueChangeType

any

Sheet value change command types. These commands affect the content or style of cells. Includes operations like setting cell values, moving ranges, merging cells, and applying styles.

SparklineTypeEnum

any

‐

TitlePositionEnum

any

Represents the position of the title in the chart. TitlePositionEnum

Example

const fWorkbook = univerAPI.getActiveWorkbook();
const fSheet = fWorkbook.getActiveSheet();
const chartBuilder = fSheet.newChart().asLineChart();
const chartInfo = chartBuilder.addRange('A1:B8')
.setOptions('title.position',univerAPI.Enum.TitlePositionEnum.TOP)
.build();
fSheet.insertChart(chartInfo);