Skip to Content
ClassesFEnum

类: FEnum

继承

  • IFSheetsEnum.IFSheetsFormulaEnum.IFSheetsFilterEnumMixin.IFSheetsConditionalFormattingEnum.IPivotEnumMixin.IFSparklineEnumMixin.IFUIEnumMixin.IFDrawingEnumMixin.FWatermarkEnum.ISheetPrintEnum.IChartEnumMixin

属性

属性类型描述

AxisAlignEnum

any

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

示例

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
 
// Create a line chart with data source A1:D6.
// The starting position is upper-left corner of cell B2.
// The x-axis title is set to 'X Axis Title' with red font color and aligned to the end of the axis.
const chartInfo = fWorksheet.newChart()
  .asLineChart()
  .addRange('A1:D6')
  .setPosition(1, 1, 0, 0)
  .setOptions('', {
    xAxisTitle: {
      content: 'X Axis Title',
      fontColor: '#ff0000',
      axisAlignment: univerAPI.Enum.AxisAlignEnum.End,
    }
  })
  .build();
await fWorksheet.insertChart(chartInfo);

CalculationMode

any

Define the calculation mode during initialization

ChartBorderDashType

any

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

示例

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
 
// Create a line chart with data source A1:D6.
// The starting position is upper-left corner of cell B2.
// The axis pointer style is set.
const chartInfo = fWorksheet.newChart()
  .asLineChart()
  .addRange('A1:D6')
  .setPosition(1, 1, 0, 0)
  .setAxisPointerStyle({
    indicatorLabelColor: '#ff0000',
    indicatorLineType: univerAPI.Enum.ChartBorderDashType.Solid,
    indicatorLineColor: '#00ff00',
    indicatorLabelTextColor: '#0000ff',
  })
  .build();
await fWorksheet.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.

示例

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
 
// Create a column chart with data source A1:D6.
// The starting position is upper-left corner of cell B2.
const chartInfo = fWorksheet.newChart()
  .setChartType(univerAPI.Enum.ChartType.Column)
  .addRange('A1:D6')
  .setPosition(1, 1, 0, 0)
  .build();
await fWorksheet.insertChart(chartInfo);

ConditionFormatNumberOperatorEnum

any

Conditional formatting number operator

ConditionFormatTimePeriodOperatorEnum

any

Conditional formatting time period operator

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.

示例

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
 
// Create a line chart with data source A1:D6.
// The starting position is upper-left corner of cell B2.
// The legend is positioned at the top of the chart.
const chartInfo = fWorksheet.newChart()
  .asLineChart()
  .addRange('A1:D6')
  .setPosition(1, 1, 0, 0)
  .setOptions('legend.position', univerAPI.Enum.LegendPositionEnum.Top)
  .build();
await fWorksheet.insertChart(chartInfo);

LinePointShape

any

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

示例

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
 
// Create a line chart with data source A1:D6.
// The starting position is upper-left corner of cell B2.
// The data point shape is set to circle, color is red, and size is 10.
const chartInfo = fWorksheet.newChart()
  .asLineChart()
  .addRange('A1:D6')
  .setPosition(1, 1, 0, 0)
  .setDataPointShape(univerAPI.Enum.LinePointShape.CIRCLE)
  .setDataPointColor('#ff0000')
  .setDataPointSize(10)
  .build();
await fWorksheet.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

PivotDateGroupFieldDateTypeEnum

any

Represents the date type of the pivot date group field. PivotDateGroupFieldDateTypeEnum

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

RadarShape

any

Represents the shape of the radar chart. RadarShape

示例

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
 
// Create a radar chart with data source A1:D6.
// The starting position is upper-left corner of cell B2.
// The shape of the radar chart is set to polygon and filled with red color.
const chartInfo = fWorksheet.newChart()
  .asRadarChart()
  .addRange('A1:D6')
  .setPosition(1, 1, 0, 0)
  .setShape(univerAPI.Enum.RadarShape.Polygon)
  .setFill(true)
  .build();
await fWorksheet.insertChart(chartInfo);

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.

示例

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
 
// Create a line chart with data source A1:D6.
// The starting position is upper-left corner of cell B2.
// The legend is in single selection mode.
const chartInfo = fWorksheet.newChart()
  .asLineChart()
  .addRange('A1:D6')
  .setPosition(1, 1, 0, 0)
  .setOptions('legend.selectMode', univerAPI.Enum.SelectModeEnum.Single)
  .build();
await fWorksheet.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

‐

SplitDelimiterType

any

Split delimiter types.

TitlePositionEnum

any

Represents the position of the title in the chart. TitlePositionEnum

示例

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
 
// Create a line chart with data source A1:D6.
// The starting position is upper-left corner of cell B2.
// The title is positioned at the top of the chart.
const chartInfo = fWorksheet.newChart()
  .asLineChart()
  .addRange('A1:D6')
  .setPosition(1, 1, 0, 0)
  .setOptions('', {
    title: {
      content: 'Chart Title',
      position: univerAPI.Enum.TitlePositionEnum.TOP,
    },
  })
  .build();
await fWorksheet.insertChart(chartInfo);

访问器

AbsoluteRefType

Getter 签名

get AbsoluteRefType(): typeof AbsoluteRefType;

Defines different types of absolute references

示例
console.log(univerAPI.Enum.AbsoluteRefType);
返回

typeof AbsoluteRefType

AutoFillSeries

Getter 签名

get AutoFillSeries(): any;

Auto fill series types

示例
console.log(univerAPI.Enum.AutoFillSeries.ALTERNATE_SERIES);
返回

any

BaselineOffset

Getter 签名

get BaselineOffset(): typeof BaselineOffset;

Different baseline offsets for text baseline positioning

示例
console.log(univerAPI.Enum.BaselineOffset.SUPERSCRIPT);
返回

typeof BaselineOffset

BooleanNumber

Getter 签名

get BooleanNumber(): typeof BooleanNumber;

Boolean number representations

示例
console.log(univerAPI.Enum.BooleanNumber.TRUE);
返回

typeof BooleanNumber

BorderStyleTypes

Getter 签名

get BorderStyleTypes(): typeof BorderStyleTypes;

Different border style types

示例
console.log(univerAPI.Enum.BorderStyleTypes.NONE);
返回

typeof BorderStyleTypes

BorderType

Getter 签名

get BorderType(): any;

Different border types

示例
console.log(univerAPI.Enum.BorderType.OUTSIDE);
返回

any

BuiltInUIPart

Getter 签名

get BuiltInUIPart(): any;

Built-in UI parts.

返回

any

ColorType

Getter 签名

get ColorType(): any;

Color types

示例
console.log(univerAPI.Enum.ColorType.RGB);
返回

any

CommandType

Getter 签名

get CommandType(): any;

Different types of commands

示例
console.log(univerAPI.Enum.CommandType.COMMAND);
返回

any

CommonHideTypes

Getter 签名

get CommonHideTypes(): any;

Common hide types

示例
console.log(univerAPI.Enum.CommonHideTypes.ON);
返回

any

CopyPasteType

Getter 签名

get CopyPasteType(): any;

Copy paste types

示例
console.log(univerAPI.Enum.CopyPasteType.PASTE_VALUES);
返回

any

DataValidationErrorStyle

Getter 签名

get DataValidationErrorStyle(): any;

Different error display styles

示例
console.log(univerAPI.Enum.DataValidationErrorStyle.WARNING);
返回

any

DataValidationOperator

Getter 签名

get DataValidationOperator(): any;

Different validation operators

示例
console.log(univerAPI.Enum.DataValidationOperator.BETWEEN);
返回

any

DataValidationRenderMode

Getter 签名

get DataValidationRenderMode(): any;

Different validation rendering modes

示例
console.log(univerAPI.Enum.DataValidationRenderMode.TEXT);
返回

any

DataValidationStatus

Getter 签名

get DataValidationStatus(): any;

Different validation states

示例
console.log(univerAPI.Enum.DataValidationStatus.VALID);
返回

any

DataValidationType

Getter 签名

get DataValidationType(): any;

Different types of data validation

示例
console.log(univerAPI.Enum.DataValidationType.LIST);
返回

any

DeleteDirection

Getter 签名

get DeleteDirection(): any;

Delete direction types

示例
console.log(univerAPI.Enum.DeleteDirection.LEFT);
返回

any

DeveloperMetadataVisibility

Getter 签名

get DeveloperMetadataVisibility(): any;

Developer metadata visibility types

示例
console.log(univerAPI.Enum.DeveloperMetadataVisibility.DOCUMENT);
返回

any

Dimension

Getter 签名

get Dimension(): any;

Dimension types

示例
console.log(univerAPI.Enum.Dimension.ROWS);
返回

any

Direction

Getter 签名

get Direction(): any;

Direction types

示例
console.log(univerAPI.Enum.Direction.UP);
返回

any

HorizontalAlign

Getter 签名

get HorizontalAlign(): typeof HorizontalAlign;

Different horizontal text alignment options

示例
console.log(univerAPI.Enum.HorizontalAlign.CENTER);
返回

typeof HorizontalAlign

InterpolationPointType

Getter 签名

get InterpolationPointType(): any;

Interpolation point types

示例
console.log(univerAPI.Enum.InterpolationPointType.NUMBER);
返回

any

IWatermarkTypeEnum

Getter 签名

get IWatermarkTypeEnum(): any;
返回

any

继承自

FWatermarkEnum.IWatermarkTypeEnum

KeyCode

Getter 签名

get KeyCode(): any;

Key codes.

返回

any

LifecycleStages

Getter 签名

get LifecycleStages(): any;

Represents different stages in the lifecycle

示例
console.log(univerAPI.Enum.LifecycleStages.Rendered);
返回

any

LocaleType

Getter 签名

get LocaleType(): typeof LocaleType;

Locale types

示例
console.log(univerAPI.Enum.LocaleType.EN_US);
返回

typeof LocaleType

MentionType

Getter 签名

get MentionType(): any;

Mention types

示例
console.log(univerAPI.Enum.MentionType.PERSON);
返回

any

ProtectionType

Getter 签名

get ProtectionType(): any;

Protection types

示例
console.log(univerAPI.Enum.ProtectionType.RANGE);
返回

any

RelativeDate

Getter 签名

get RelativeDate(): any;

Relative date types

示例
console.log(univerAPI.Enum.RelativeDate.TODAY);
返回

any

SheetTypes

Getter 签名

get SheetTypes(): any;

Sheet types

示例
console.log(univerAPI.Enum.SheetTypes.GRID);
返回

any

TextDecoration

Getter 签名

get TextDecoration(): typeof TextDecoration;

Different text decoration styles

示例
console.log(univerAPI.Enum.TextDecoration.DOUBLE);
返回

typeof TextDecoration

TextDirection

Getter 签名

get TextDirection(): typeof TextDirection;

Different text direction options

示例
console.log(univerAPI.Enum.TextDirection.LEFT_TO_RIGHT);
返回

typeof TextDirection

ThemeColorType

Getter 签名

get ThemeColorType(): typeof ThemeColorType;

Theme color types

示例
console.log(univerAPI.Enum.ThemeColorType.ACCENT1);
返回

typeof ThemeColorType

UniverInstanceType

Getter 签名

get UniverInstanceType(): any;

Defines different types of Univer instances

示例
console.log(univerAPI.Enum.UniverInstanceType.UNIVER_SHEET);
返回

any

VerticalAlign

Getter 签名

get VerticalAlign(): typeof VerticalAlign;

Different vertical text alignment options

示例
console.log(univerAPI.Enum.VerticalAlign.MIDDLE);
返回

typeof VerticalAlign

WrapStrategy

Getter 签名

get WrapStrategy(): typeof WrapStrategy;

Different wrap strategy options

示例
console.log(univerAPI.Enum.WrapStrategy.WRAP);
返回

typeof WrapStrategy

方法

get()

static get(): FEnum;

返回

FEnum

FDocumentFEventName