Class: FEnum
Extends
IFSheetsEnum
.IFSheetsFormulaEnum
.IFSheetsFilterEnumMixin
.IFSheetsConditionalFormattingEnum
.IPivotEnumMixin
.IFSparklineEnumMixin
.IFUIEnumMixin
.IFDrawingEnumMixin
.FWatermarkEnum
.ISheetPrintEnum
.IChartEnumMixin
Properties
Property | Type | Description |
---|---|---|
|
Represents the alignment of the axis. AxisAlignEnum The possible values are: START, CENTER, END. Example
| |
|
Define the calculation mode during initialization | |
|
Represents the type of the border dash. ChartBorderDashType The possible values are: SOLID, DOTTED, DASHED. Example
| |
|
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
| |
|
Conditional formatting number operator | |
|
Conditional formatting time period operator | |
|
Please refer to CustomFilterOperator. | |
typeof |
Please refer to DrawingTypeEnum. | |
|
Please refer to ImageSourceType. | |
|
Represents the position of the legend in the chart. LegendPositionEnum The possible values are: BOTTOM, TOP, LEFT, RIGHT, HIDE. Example
| |
|
Represents the shape of the data point in the line chart. LinePointShape Example
| |
|
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. | |
|
Represents the sort operator of the pivot data field. PivotDataFieldSortOperatorEnum | |
|
Represents the sort type of the pivot data field. PivotDataFieldSortTypeEnum | |
|
Represents the date type of the pivot date group field. PivotDateGroupFieldDateTypeEnum | |
|
Represents the filter operator of the pivot filter. ST_PivotFilterOperatorEnum | |
|
Represents the filter type of the pivot table. PivotFilterTypeEnum | |
|
Represents the subtotal type of the pivot table. PivotSubtotalTypeEnum | |
|
Represents the change type of the pivot table. PivotTableChangeTypeEnum | |
|
Represents the field area of the pivot table. PivotTableFiledAreaEnum | |
|
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. | |
|
Represents the position type of the pivot table. PositionType | |
|
Print alignment settings for content positioning | |
|
Print area setting that determines which part of the spreadsheet to print | |
|
Page orientation setting (Portrait/Landscape) | |
|
Freeze pane settings for printing | |
|
Header and footer content options | |
|
Special symbols/placeholders available for headers and footers | |
|
Margin presets for the printed page | |
|
Paper size options for printing (e.g., A4, Letter) | |
|
Print scaling options to fit content to page | |
|
Represents the shape of the radar chart. RadarShape Example
| |
|
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
| |
|
Please refer to SheetDrawingAnchorType. | |
|
Sheet skeleton change command types. These commands affect the structure of the worksheet. Includes operations like changing row/column dimensions, visibility, and grid properties. | |
|
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. | |
|
‐ | |
|
Split delimiter types. | |
|
Represents the position of the title in the chart. TitlePositionEnum Example
|
Accessors
AbsoluteRefType
Get Signature
get AbsoluteRefType(): typeof AbsoluteRefType;
Defines different types of absolute references
Example
console.log(univerAPI.Enum.AbsoluteRefType);
Returns
typeof AbsoluteRefType
AutoFillSeries
Get Signature
get AutoFillSeries(): any;
Auto fill series types
Example
console.log(univerAPI.Enum.AutoFillSeries.ALTERNATE_SERIES);
Returns
any
BaselineOffset
Get Signature
get BaselineOffset(): typeof BaselineOffset;
Different baseline offsets for text baseline positioning
Example
console.log(univerAPI.Enum.BaselineOffset.SUPERSCRIPT);
Returns
typeof BaselineOffset
BooleanNumber
Get Signature
get BooleanNumber(): typeof BooleanNumber;
Boolean number representations
Example
console.log(univerAPI.Enum.BooleanNumber.TRUE);
Returns
typeof BooleanNumber
BorderStyleTypes
Get Signature
get BorderStyleTypes(): typeof BorderStyleTypes;
Different border style types
Example
console.log(univerAPI.Enum.BorderStyleTypes.NONE);
Returns
typeof BorderStyleTypes
BorderType
Get Signature
get BorderType(): any;
Different border types
Example
console.log(univerAPI.Enum.BorderType.OUTSIDE);
Returns
any
BuiltInUIPart
Get Signature
get BuiltInUIPart(): any;
Built-in UI parts.
Returns
any
ColorType
Get Signature
get ColorType(): any;
Color types
Example
console.log(univerAPI.Enum.ColorType.RGB);
Returns
any
CommandType
Get Signature
get CommandType(): any;
Different types of commands
Example
console.log(univerAPI.Enum.CommandType.COMMAND);
Returns
any
CommonHideTypes
Get Signature
get CommonHideTypes(): any;
Common hide types
Example
console.log(univerAPI.Enum.CommonHideTypes.ON);
Returns
any
CopyPasteType
Get Signature
get CopyPasteType(): any;
Copy paste types
Example
console.log(univerAPI.Enum.CopyPasteType.PASTE_VALUES);
Returns
any
DataValidationErrorStyle
Get Signature
get DataValidationErrorStyle(): any;
Different error display styles
Example
console.log(univerAPI.Enum.DataValidationErrorStyle.WARNING);
Returns
any
DataValidationOperator
Get Signature
get DataValidationOperator(): any;
Different validation operators
Example
console.log(univerAPI.Enum.DataValidationOperator.BETWEEN);
Returns
any
DataValidationRenderMode
Get Signature
get DataValidationRenderMode(): any;
Different validation rendering modes
Example
console.log(univerAPI.Enum.DataValidationRenderMode.TEXT);
Returns
any
DataValidationStatus
Get Signature
get DataValidationStatus(): any;
Different validation states
Example
console.log(univerAPI.Enum.DataValidationStatus.VALID);
Returns
any
DataValidationType
Get Signature
get DataValidationType(): any;
Different types of data validation
Example
console.log(univerAPI.Enum.DataValidationType.LIST);
Returns
any
DeleteDirection
Get Signature
get DeleteDirection(): any;
Delete direction types
Example
console.log(univerAPI.Enum.DeleteDirection.LEFT);
Returns
any
DeveloperMetadataVisibility
Get Signature
get DeveloperMetadataVisibility(): any;
Developer metadata visibility types
Example
console.log(univerAPI.Enum.DeveloperMetadataVisibility.DOCUMENT);
Returns
any
Dimension
Get Signature
get Dimension(): any;
Dimension types
Example
console.log(univerAPI.Enum.Dimension.ROWS);
Returns
any
Direction
Get Signature
get Direction(): any;
Direction types
Example
console.log(univerAPI.Enum.Direction.UP);
Returns
any
HorizontalAlign
Get Signature
get HorizontalAlign(): typeof HorizontalAlign;
Different horizontal text alignment options
Example
console.log(univerAPI.Enum.HorizontalAlign.CENTER);
Returns
typeof HorizontalAlign
InterpolationPointType
Get Signature
get InterpolationPointType(): any;
Interpolation point types
Example
console.log(univerAPI.Enum.InterpolationPointType.NUMBER);
Returns
any
IWatermarkTypeEnum
Get Signature
get IWatermarkTypeEnum(): any;
Returns
any
Inherited from
FWatermarkEnum
.IWatermarkTypeEnum
KeyCode
Get Signature
get KeyCode(): any;
Key codes.
Returns
any
LifecycleStages
Get Signature
get LifecycleStages(): any;
Represents different stages in the lifecycle
Example
console.log(univerAPI.Enum.LifecycleStages.Rendered);
Returns
any
LocaleType
Get Signature
get LocaleType(): typeof LocaleType;
Locale types
Example
console.log(univerAPI.Enum.LocaleType.EN_US);
Returns
typeof LocaleType
MentionType
Get Signature
get MentionType(): any;
Mention types
Example
console.log(univerAPI.Enum.MentionType.PERSON);
Returns
any
ProtectionType
Get Signature
get ProtectionType(): any;
Protection types
Example
console.log(univerAPI.Enum.ProtectionType.RANGE);
Returns
any
RelativeDate
Get Signature
get RelativeDate(): any;
Relative date types
Example
console.log(univerAPI.Enum.RelativeDate.TODAY);
Returns
any
SheetTypes
Get Signature
get SheetTypes(): any;
Sheet types
Example
console.log(univerAPI.Enum.SheetTypes.GRID);
Returns
any
TextDecoration
Get Signature
get TextDecoration(): typeof TextDecoration;
Different text decoration styles
Example
console.log(univerAPI.Enum.TextDecoration.DOUBLE);
Returns
typeof TextDecoration
TextDirection
Get Signature
get TextDirection(): typeof TextDirection;
Different text direction options
Example
console.log(univerAPI.Enum.TextDirection.LEFT_TO_RIGHT);
Returns
typeof TextDirection
ThemeColorType
Get Signature
get ThemeColorType(): typeof ThemeColorType;
Theme color types
Example
console.log(univerAPI.Enum.ThemeColorType.ACCENT1);
Returns
typeof ThemeColorType
UniverInstanceType
Get Signature
get UniverInstanceType(): any;
Defines different types of Univer instances
Example
console.log(univerAPI.Enum.UniverInstanceType.UNIVER_SHEET);
Returns
any
VerticalAlign
Get Signature
get VerticalAlign(): typeof VerticalAlign;
Different vertical text alignment options
Example
console.log(univerAPI.Enum.VerticalAlign.MIDDLE);
Returns
typeof VerticalAlign
WrapStrategy
Get Signature
get WrapStrategy(): typeof WrapStrategy;
Different wrap strategy options
Example
console.log(univerAPI.Enum.WrapStrategy.WRAP);
Returns
typeof WrapStrategy
Methods
get()
static get(): FEnum;
Returns
FEnum