API Reference

FEnum

Access these values through univerAPI.Enum, for example univerAPI.Enum.WrapStrategy.WRAP. Feature-specific values become available after their plugins and Facade entries are loaded. Use named values in application code; the tables below show their published types.

TypeScript
const sheet = univerAPI.getActiveWorkbook()?.getActiveSheet()if (!sheet) throw new Error('No active worksheet')sheet.getRange('A1').setWrapStrategy(univerAPI.Enum.WrapStrategy.WRAP)

@univerjs-pro/bases

Enum.BaseConditionalColorOperator

Comparison operators supported by Base conditional coloring.

Text-like fields support equality, containment, and empty checks. Numeric fields support equality, GREATER_THAN, LESS_THAN, and empty checks. Date-like fields support equality, BEFORE, AFTER, and empty checks, optionally with BaseConditionalDateMode. Checkbox fields support equality and inequality.

Available values

TypeScript
type EnumValues = {  IS: 'is'  IS_NOT: 'isNot'  CONTAINS: 'contains'  NOT_CONTAINS: 'notContains'  IS_EMPTY: 'isEmpty'  IS_NOT_EMPTY: 'isNotEmpty'  GREATER_THAN: 'greaterThan'  LESS_THAN: 'lessThan'  BEFORE: 'before'  AFTER: 'after'}

Example

Add a text containment rule

TypeScript
const base = univerAPI.getActiveBase()if (!base) throw new Error('Open a Base before running this example.')const table = base.insertTable(`Conditional operator ${Date.now()}`, {  primaryFieldName: 'Risk item',})const title = table.getPrimaryField()const view = table.getViewByName('Grid')if (!view) throw new Error('The default Grid view was not created.')view.addConditionalColorRule({  id: 'delay-risk',  color: '#fff7df',  target: univerAPI.Enum.BaseConditionalColorTarget.CELL,  fieldId: title.getId(),  operator: univerAPI.Enum.BaseConditionalColorOperator.CONTAINS,  operand: 'delay',})

Package: @univerjs-pro/bases · Type definitions

Enum.BaseConditionalColorTarget

Paint targets supported by Base conditional coloring.

CELL colors only the evaluated field cell, ROW colors the complete matching record row, and COLUMN colors the selected field column unconditionally (its operator, operand, and date mode are ignored).

Available values

TypeScript
type EnumValues = {  /** Paint only the cell in the rule's field. */  CELL: 'cell'  /** Paint the complete record row. */  ROW: 'row'  /** Paint the rule's field column unconditionally; operator, operand, and date mode are ignored. */  COLUMN: 'column'}

Example

Color an entire row when a Number field is greater than 80

TypeScript
const base = univerAPI.getActiveBase()if (!base) throw new Error('Open a Base before running this example.')const table = base.insertTable(`Conditional target ${Date.now()}`, {  primaryFieldName: 'Risk item',})const level = table.addField('Risk level', univerAPI.Enum.BaseFieldType.Number)const view = table.getViewByName('Grid')if (!view) throw new Error('The default Grid view was not created.')view.addConditionalColorRule({  id: 'high-risk',  color: '#fde9e9',  target: univerAPI.Enum.BaseConditionalColorTarget.ROW,  fieldId: level.getId(),  operator: univerAPI.Enum.BaseConditionalColorOperator.GREATER_THAN,  operand: 80,})

Package: @univerjs-pro/bases · Type definitions

Enum.BaseConditionalDateMode

Exact and relative windows supported by Date-like conditional color rules.

Relative modes such as TODAY, THIS_WEEK, and PAST_7_DAYS do not require an operand. Use EXACT with an explicit date operand. IS matches dates inside the window, IS_NOT outside it, BEFORE before its start, and AFTER after its end.

Available values

TypeScript
type EnumValues = {  EXACT: 'exact'  TODAY: 'today'  TOMORROW: 'tomorrow'  YESTERDAY: 'yesterday'  THIS_WEEK: 'thisWeek'  LAST_WEEK: 'lastWeek'  THIS_MONTH: 'thisMonth'  LAST_MONTH: 'lastMonth'  PAST_7_DAYS: 'past7'  NEXT_7_DAYS: 'next7'  PAST_30_DAYS: 'past30'  NEXT_30_DAYS: 'next30'}

Example

Highlight records due in the next seven days

TypeScript
const base = univerAPI.getActiveBase()if (!base) throw new Error('Open a Base before running this example.')const table = base.insertTable(`Conditional date ${Date.now()}`, {  primaryFieldName: 'Risk item',})const dueDate = table.addField('Due date', univerAPI.Enum.BaseFieldType.Date)const view = table.getViewByName('Grid')if (!view) throw new Error('The default Grid view was not created.')view.addConditionalColorRule({  id: 'due-soon',  color: '#eef3ff',  target: univerAPI.Enum.BaseConditionalColorTarget.ROW,  fieldId: dueDate.getId(),  operator: univerAPI.Enum.BaseConditionalColorOperator.IS,  dateMode: univerAPI.Enum.BaseConditionalDateMode.NEXT_7_DAYS,})

Package: @univerjs-pro/bases · Type definitions

Enum.BaseEventSource

Sources reported by BaseHierarchyChanged and BeforeBaseHierarchyChange.

Use this enum instead of comparing source strings. Facade identifies a write initiated through the Facade API; Remote identifies a collaboration mutation; Undo and Redo identify history replay; and Import is reserved for import pipelines that attach hierarchy metadata to their mutation.

Available values

TypeScript
type EnumValues = {  /** A built-in Base UI interaction initiated the command. */  UI: BaseEventSource.UI  /** A Facade API method initiated the command. */  Facade: BaseEventSource.Facade  /** The mutation arrived through collaboration. */  Remote: BaseEventSource.Remote  /** The local Undo stack replayed the inverse mutation. */  Undo: BaseEventSource.Undo  /** The local Redo stack replayed the mutation. */  Redo: BaseEventSource.Redo  /** An import pipeline applied a mutation carrying hierarchy metadata. */  Import: BaseEventSource.Import}

Example

Ignore collaboration echoes while reacting to local SDK writes

TypeScript
const disposable = univerAPI.addEvent(  univerAPI.Event.BaseHierarchyChanged,  ({ changes, source }) => {    if (source === univerAPI.Enum.BaseEventSource.Remote) return    for (const change of changes) {      console.log(change.recordId, change.parentRecordId, source)    }  },)// Call disposable.dispose() when the integration is torn down.

Package: @univerjs-pro/bases · Type definitions

Enum.BaseFieldKeyEnum

Base field key enumeration.

Available values

TypeScript
type EnumValues = {  Id: BaseFieldKeyEnum.Id  Name: BaseFieldKeyEnum.Name  Auto: BaseFieldKeyEnum.Auto}

Example

TypeScript
const fBase = univerAPI.getActiveBase()const fBaseTable = fBase.getTableById('table-1')const record = fBaseTable.addRecord(  {    Title: 'Ship beta',    Status: 'todo',  },  univerAPI.Enum.BaseFieldKeyEnum.Name,)console.log(record)

Package: @univerjs-pro/bases · Type definitions

Enum.BaseFieldType

Base field types. The Base plugin currently exposes the 21 field types demonstrated below. Other enum members are reserved for field plugins that are not enabled by default.

Available values

TypeScript
type EnumValues = {  Text: BaseFieldType.Text  SingleSelect: BaseFieldType.SingleSelect  MultiSelect: BaseFieldType.MultiSelect  Person: BaseFieldType.Person  Group: BaseFieldType.Group  Date: BaseFieldType.Date  Attachment: BaseFieldType.Attachment  Number: BaseFieldType.Number  Checkbox: BaseFieldType.Checkbox  Link: BaseFieldType.Link  Formula: BaseFieldType.Formula  Numbering: BaseFieldType.Numbering  Phone: BaseFieldType.Phone  Email: BaseFieldType.Email  Progress: BaseFieldType.Progress  Currency: BaseFieldType.Currency  Rating: BaseFieldType.Rating  RecordLink: BaseFieldType.RecordLink  RecordId: BaseFieldType.RecordId  CreatedBy: BaseFieldType.CreatedBy  UpdatedBy: BaseFieldType.UpdatedBy  CreatedAt: BaseFieldType.CreatedAt  UpdatedAt: BaseFieldType.UpdatedAt}

Example

Create and populate every field type exposed by the Base UI

TypeScript
const fBase = univerAPI.getActiveBase()if (!fBase) throw new Error('No active Base.')const table = fBase.insertTable(`Field examples ${Date.now()}`, { primaryFieldName: 'Title' })const title = table.getPrimaryField() // Primary fields are Text fields.if (title.getType() !== univerAPI.Enum.BaseFieldType.Text)  throw new Error('Expected a Text primary field.')table.addField('Status', univerAPI.Enum.BaseFieldType.SingleSelect, {  field: {    config: {      options: [        { id: 'todo', name: 'Todo', color: 'blue' },        { id: 'done', name: 'Done', color: 'green' },      ],    },  },})table.addField('Tags', univerAPI.Enum.BaseFieldType.MultiSelect, {  field: {    config: {      options: [        { id: 'api', name: 'API', color: 'purple' },        { id: 'docs', name: 'Docs', color: 'orange' },      ],    },  },})table.addField('Owner', univerAPI.Enum.BaseFieldType.Person, {  field: { config: { allowMultiple: false, provider: 'person' } },})table.addField('Teams', univerAPI.Enum.BaseFieldType.Group, {  field: { config: { allowMultiple: true, provider: 'group' } },})table.addField('Due Date', univerAPI.Enum.BaseFieldType.Date, {  field: { config: { pattern: 'yyyy/mm/dd', includeTime: true, hourCycle: 'h24' } },})const attachments = table.addField('Attachments', univerAPI.Enum.BaseFieldType.Attachment)table.addField('Amount', univerAPI.Enum.BaseFieldType.Number, {  field: { config: { pattern: '#,##0.00', decimalPlaces: 2 } },})table.addField('Approved', univerAPI.Enum.BaseFieldType.Checkbox)table.addField('Website', univerAPI.Enum.BaseFieldType.Link)table.addField('Phone', univerAPI.Enum.BaseFieldType.Phone)table.addField('Email', univerAPI.Enum.BaseFieldType.Email)table.addField('Progress', univerAPI.Enum.BaseFieldType.Progress, {  field: { config: { start: 0, end: 100 } },})table.addField('Budget', univerAPI.Enum.BaseFieldType.Currency, {  field: { config: { currencySymbol: '$', decimalPlaces: 2 } },})table.addField('Rating', univerAPI.Enum.BaseFieldType.Rating, {  field: { config: { min: 1, max: 5 } },})const formulaTableName = table.getFormulaName()const formula = table.addField('Total', univerAPI.Enum.BaseFieldType.Formula, {  field: {    config: {      formula: `=SUM(${formulaTableName}[[#This Row],[Amount]],${formulaTableName}[[#This Row],[Budget]])`,    },  },  externalReferences: [], // Required; this formula only uses fields in the Host Base.})const numbering = table.addField('Sequence', univerAPI.Enum.BaseFieldType.Numbering)const createdBy = table.addField('Created By', univerAPI.Enum.BaseFieldType.CreatedBy)const updatedBy = table.addField('Updated By', univerAPI.Enum.BaseFieldType.UpdatedBy)const createdAt = table.addField('Created At', univerAPI.Enum.BaseFieldType.CreatedAt)const updatedAt = table.addField('Updated At', univerAPI.Enum.BaseFieldType.UpdatedAt)const record = table.addRecord(  {    Title: 'Document every field type',    Status: 'todo',    Tags: ['api', 'docs'],    Owner: 'user-1',    Teams: ['group-1'],    'Due Date': 45839, // Excel serial for 2025-07-01.    Attachments: [], // Populate with record.setAttachments(...) after creating the record.    Amount: 1250.5,    Approved: true,    Website: { text: 'Univer', url: 'https://univer.ai' },    Phone: '+1 555 0100',    Email: 'agent@example.com',    Progress: 75,    Budget: 5000,    Rating: 4,  },  univerAPI.Enum.BaseFieldKeyEnum.Name,  { createdBy: 'user-1', updatedBy: 'user-1' },)const previewDataUrl = 'data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///ywAAAAAAQABAAACAUwAOw=='record.setAttachments(attachments.getId(), [  {    id: 'local-preview',    name: 'preview.gif',    mimeType: 'image/gif',    sourceType: univerAPI.Enum.ImageSourceType.BASE64,    source: previewDataUrl,  },])// Formula, numbering, and audit fields are generated and cannot be written directly.console.log({  formula: record.getValue(formula.getId()),  numbering: record.getValue(numbering.getId()),  createdBy: record.getValue(createdBy.getId()),  updatedBy: record.getValue(updatedBy.getId()),  createdAt: record.getValue(createdAt.getId()),  updatedAt: record.getValue(updatedAt.getId()),})

Package: @univerjs-pro/bases · Type definitions

Enum.BaseFilterConjunction

Base filter conjunctions.

Available values

TypeScript
type EnumValues = {  AND: BaseFilterConjunction.AND  OR: BaseFilterConjunction.OR}

Example

TypeScript
const fBase = univerAPI.getActiveBase()const fBaseTable = fBase.getTableById('table-1')const view = fBaseTable.getViewByName('Grid')view.setFilter({  conjunction: univerAPI.Enum.BaseFilterConjunction.AND,  filters: [    {      fieldId: 'fld-1',      operator: univerAPI.Enum.BaseFilterOperator.Equals,      value: 'John Doe',    },  ],})

Package: @univerjs-pro/bases · Type definitions

Enum.BaseFilterOperator

Base filter operators.

Available values

TypeScript
type EnumValues = {  IS: BaseFilterOperator.IS  IS_NOT: BaseFilterOperator.IS_NOT  CONTAINS: BaseFilterOperator.CONTAINS  NOT_CONTAINS: BaseFilterOperator.NOT_CONTAINS  IS_EMPTY: BaseFilterOperator.IS_EMPTY  IS_NOT_EMPTY: BaseFilterOperator.IS_NOT_EMPTY  GREATER_THAN: BaseFilterOperator.GREATER_THAN  GREATER_THAN_OR_EQUAL: BaseFilterOperator.GREATER_THAN_OR_EQUAL  LESS_THAN: BaseFilterOperator.LESS_THAN  LESS_THAN_OR_EQUAL: BaseFilterOperator.LESS_THAN_OR_EQUAL  BEFORE: BaseFilterOperator.BEFORE  AFTER: BaseFilterOperator.AFTER}

Example

TypeScript
const fBase = univerAPI.getActiveBase()const fBaseTable = fBase.getTableById('table-1')const view = fBaseTable.getViewByName('Grid')view.setFilter({  conjunction: univerAPI.Enum.BaseFilterConjunction.AND,  filters: [    {      fieldId: 'fld-1',      operator: univerAPI.Enum.BaseFilterOperator.Equals,      value: 'John Doe',    },  ],})

Package: @univerjs-pro/bases · Type definitions

Enum.BaseHierarchyErrorCode

Stable error codes thrown by hierarchy commands.

SDK integrations should branch on BaseHierarchyError.code, not on a localized UI notification or the human-readable error message. The current codes cover an ineligible Parent field, a missing record, self-parent, cycle, five-level depth overflow, and manual drag while the view is sorted.

Available values

TypeScript
type EnumValues = {  /** The Parent field is absent, targets another table, or allows multiple records. */  InvalidField: BaseHierarchyErrorCode.InvalidField  /** The record being changed or its requested parent does not exist. */  MissingRecord: BaseHierarchyErrorCode.MissingRecord  /** A record was assigned as its own parent. */  SelfParent: BaseHierarchyErrorCode.SelfParent  /** The requested Parent edge would create a cycle. */  Cycle: BaseHierarchyErrorCode.Cycle  /** Moving the record's subtree would exceed {@link BASE_HIERARCHY_MAX_LEVELS}. */  MaxDepth: BaseHierarchyErrorCode.MaxDepth  /** Manual record reordering was requested while the active view has Sort rules. */  SortedView: BaseHierarchyErrorCode.SortedView}

Example

Handle a hierarchy error without hard-coded strings

TypeScript
import { BaseHierarchyError } from '@univerjs-pro/bases'try {  record.setParent(table.getHierarchyFieldId(), targetRecordId)} catch (error) {  if (!(error instanceof BaseHierarchyError)) throw error  switch (error.code) {    case univerAPI.Enum.BaseHierarchyErrorCode.Cycle:      console.error('The move would create a cycle.')      break    case univerAPI.Enum.BaseHierarchyErrorCode.MaxDepth:      console.error('The hierarchy supports at most five levels.')      break    default:      console.error('The hierarchy change was rejected.', error.code)  }}

Package: @univerjs-pro/bases · Type definitions

Enum.BaseHierarchyInvalidReason

Reasons why a stored Parent edge is excluded from the effective tree.

Collaboration data is not repaired by an extra client mutation. Instead, every client deterministically cuts an invalid edge and renders that record as a root. Model projections expose this enum so renderers and diagnostics can describe the same decision without hard-coded values.

Available values

TypeScript
type EnumValues = {  MissingParent: BaseHierarchyInvalidReason.MissingParent  SelfParent: BaseHierarchyInvalidReason.SelfParent  Cycle: BaseHierarchyInvalidReason.Cycle  MaxDepth: BaseHierarchyInvalidReason.MaxDepth}

Example

Inspect projection diagnostics

TypeScript
const projection = table.getViewByName('Grid')?.getProjection()if (projection?.type === univerAPI.Enum.BaseViewType.Grid && projection.hierarchy) {  for (const node of Object.values(projection.hierarchy.nodes)) {    if (node.invalidReason === univerAPI.Enum.BaseHierarchyInvalidReason.Cycle) {      console.warn(`Record ${node.recordId} has a cyclic Parent edge.`)    }  }}

Package: @univerjs-pro/bases · Type definitions

Enum.BaseRecordLinkRole

Semantic roles supported by Base RecordLink fields.

Parent marks the table's canonical same-table, single-value RecordLink. Prefer table.getHierarchyFieldId() and table.setHierarchyField() over editing field.config.relationRole directly, because the Facade write runs through the validated, undoable command path.

Available values

TypeScript
type EnumValues = {  Parent: BaseRecordLinkRole.Parent}

Example

Verify that the first child materialized the Parent field

TypeScript
const fieldId = table.getHierarchyFieldId()const field = table.getFieldById(fieldId)const config = field?.getField().configif (config?.relationRole === univerAPI.Enum.BaseRecordLinkRole.Parent) {  console.log('Hierarchy field is materialized.')}

Package: @univerjs-pro/bases · Type definitions

Enum.BaseSortDirection

Base sort directions.

Available values

TypeScript
type EnumValues = {  ASC: BaseSortDirection.ASC  DESC: BaseSortDirection.DESC}

Example

TypeScript
const fBase = univerAPI.getActiveBase()const fBaseTable = fBase.getTableById('table-1')const view = fBaseTable.getViewByName('Grid')const success = view.setSort([  {    fieldId: 'priority',    direction: univerAPI.Enum.BaseSortDirection.ASC,  },])console.log(success ? 'Sort set' : 'Set sort failed')

Package: @univerjs-pro/bases · Type definitions

Enum.BaseViewType

Base view types.

Available values

TypeScript
type EnumValues = {  Grid: BaseViewType.Grid  Kanban: BaseViewType.Kanban  Calendar: BaseViewType.Calendar  Gantt: BaseViewType.Gantt  Gallery: BaseViewType.Gallery  Pivot: BaseViewType.Pivot}

Example

TypeScript
const fBase = univerAPI.getActiveBase()const fBaseTable = fBase.getTableById('table-1')const view = fBaseTable.createView('API Grid', univerAPI.Enum.BaseViewType.Grid, {  view: {    id: 'grid-api',    config: {      frozenFieldCount: 1,    },  },})console.log(view)

Package: @univerjs-pro/bases · Type definitions

@univerjs-pro/boards

Enum.BoardBackgroundType

Board page background types accepted by Board background APIs.

Available values

TypeScript
type EnumValues = {  None: BoardBackgroundType.None  Solid: BoardBackgroundType.Solid  Gradient: BoardBackgroundType.Gradient  Image: BoardBackgroundType.Image  Pattern: BoardBackgroundType.Pattern}

Package: @univerjs-pro/boards · Type definitions

Enum.BoardConnectorLabelAnchor

Path-relative anchors accepted by connector label placement.

Available values

TypeScript
type EnumValues = {  Start: 'start'  Center: 'center'  End: 'end'  Path: 'path'  /** Prefer the longest orthogonal segment; use the arc-length midpoint on other paths. */  Auto: 'auto'}

Package: @univerjs-pro/boards · Type definitions

Enum.BoardConnectorLabelOffsetSpace

Available values

TypeScript
type EnumValues = {  Path: 'path'  Canvas: 'canvas'}

Package: @univerjs-pro/boards · Type definitions

Enum.BoardConnectorLabelOrientation

Text orientations accepted by connector label placement.

Available values

TypeScript
type EnumValues = {  /** Keep text horizontal regardless of the connector direction. */  Horizontal: 'horizontal'  /** Follow the directed tangent exactly; reversed routes can produce upside-down text. */  FollowPath: 'followPath'  /** Follow the tangent, flipping text by 180 degrees when needed to keep it upright. */  Auto: 'auto'}

Package: @univerjs-pro/boards · Type definitions

Enum.BoardConnectorLabelSide

Lateral sides accepted by connector label placement.

Available values

TypeScript
type EnumValues = {  Left: 'left'  OnPath: 'onPath'  Right: 'right'}

Package: @univerjs-pro/boards · Type definitions

Enum.BoardConnectorLabelSizing

Available values

TypeScript
type EnumValues = {  AutoSize: 'autoSize'  FixedWidth: 'fixedWidth'  FixedSize: 'fixedSize'}

Package: @univerjs-pro/boards · Type definitions

Enum.BoardConnectorRouting

Connector routing styles accepted by board connector facade APIs.

Available values

TypeScript
type EnumValues = {  /** Draws a direct line between endpoints. Use only for short connections with clear space; it does not perform general obstacle avoidance. */  Straight: 'straight'  /** Draws an orthogonal elbow connector. Combine with automatic routing for normal process and dependency diagrams that need obstacle routing. */  Orthogonal: 'orthogonal'  /** Draws a curved connector. Prefer it for feedback, return, and self-loop relationships with clear arc space. */  Curve: 'curve'  /** Draws a manually controlled polyline connector. Use it only when the caller supplies the intended path. */  FreePolyline: 'freePolyline'}

Example

TypeScript
console.log(univerAPI.Enum.BoardConnectorRouting.Orthogonal)

Package: @univerjs-pro/boards · Type definitions

Enum.BoardConnectorRoutingMode

Connector routing modes accepted by board connector facade APIs.

Available values

TypeScript
type EnumValues = {  /** Lets the board choose and refresh the route automatically. */  Auto: 'auto'  /** Keeps the caller-provided route. */  Manual: 'manual'  /** Uses a route with both automatic and manually controlled parts. */  Mixed: 'mixed'}

Example

TypeScript
console.log(univerAPI.Enum.BoardConnectorRoutingMode.Auto)

Package: @univerjs-pro/boards · Type definitions

Enum.BoardConnectorSite

Semantic shape-site ids for connector endpoints.

Available values

TypeScript
type EnumValues = {  Top: 0  Right: 1  Bottom: 2  Left: 3}

Example

TypeScript
console.log(univerAPI.Enum.BoardConnectorSite.Bottom)

Package: @univerjs-pro/boards · Type definitions

Enum.BoardContainerKind

Container kinds stored in Board snapshots. Use createSwimlane() for the swimlane kind.

Available values

TypeScript
type EnumValues = {  Generic: 'generic'  Swimlane: 'swimlane'  UMLPackage: 'uml-package'  SystemBoundary: 'system-boundary'}

Package: @univerjs-pro/boards · Type definitions

Enum.BoardCustomShapeType

Native UML, component, storage, actor, and state shapes.

Available values

TypeScript
type EnumValues = {  Actor: 'actor'  Boundary: 'boundary'  Control: 'control'  Entity: 'entity'  Collection: 'collection'  DataStorage1: 'data_storage_1'  DataStorage2: 'data_storage_2'  DataStorage3: 'data_storage_3'  Component: 'component'  ComponentBox: 'component_box'  ProvidedInterface: 'provided_interface'  AssemblyConnector: 'assembly_connector'  RequiredInterface: 'required_interface'  InitialState: 'initial_state'  FinalState: 'final_state'  StateBar: 'state_bar'}

Package: @univerjs-pro/boards · Type definitions

Enum.BoardElementOrderPlacement

Z-order placements accepted by board reorder APIs.

Available values

TypeScript
type EnumValues = {  /** Move elements to the top of the z-order. */  Front: 'front'  /** Move elements one step forward in the z-order. */  Forward: 'forward'  /** Move elements one step backward in the z-order. */  Backward: 'backward'  /** Move elements to the bottom of the z-order. */  Back: 'back'}

Example

TypeScript
console.log(univerAPI.Enum.BoardElementOrderPlacement.Front)

Package: @univerjs-pro/boards · Type definitions

Enum.BoardElementType

Board element model types used by query and preflight APIs.

Available values

TypeScript
type EnumValues = {  /** Template-owned placeholder resolved during import or layout application. */  Placeholder: 'placeholder'  /** Standalone editable rich-text element. */  Text: 'text'  /** Basic or custom vector shape, including persistent Ink paths. */  Shape: 'shape'  /** Raster or externally sourced image element. */  Image: 'image'  /** Data chart element handled by a registered chart adapter. */  Chart: 'chart'  /** Editable Board table backed by a table resource. */  Table: 'table'  /** Imported or adapter-owned compound diagram element. */  Diagram: 'diagram'  /** Audio or video media element. */  Media: 'media'  /** Legacy physical group element retained for snapshot compatibility. */  Group: 'group'  /** Routed line that may attach to Board elements. */  Connector: 'connector'  /** Generic, swimlane, or structured semantic container. */  Container: 'container'}

Example

TypeScript
const board = univerAPI.getActiveBoard()if (!board) throw new Error('No active board')const shapeDescriptors = board.describeElements({  elementType: univerAPI.Enum.BoardElementType.Shape,})console.log(shapeDescriptors.length)

Package: @univerjs-pro/boards · Type definitions

Enum.BoardERDCardinality

Crow-foot cardinalities used by insertEntityRelation(s).

Available values

TypeScript
type EnumValues = {  One: 'one'  ZeroOrOne: 'zeroOrOne'  OneOrMany: 'oneOrMany'  ZeroOrMany: 'zeroOrMany'}

Package: @univerjs-pro/boards · Type definitions

Enum.BoardERDRelationType

ERD relationship line styles used by insertEntityRelation(s).

Available values

TypeScript
type EnumValues = {  Identifying: 'identifying'  NonIdentifying: 'nonIdentifying'}

Package: @univerjs-pro/boards · Type definitions

Enum.BoardFacadeElementAlignment

Element alignment modes accepted by board alignment helpers.

Available values

TypeScript
type EnumValues = {  /** Align left edges. */  Left: 'left'  /** Align horizontal centers. */  Center: 'center'  /** Align right edges. */  Right: 'right'  /** Align top edges. */  Top: 'top'  /** Align vertical middles. */  Middle: 'middle'  /** Align bottom edges. */  Bottom: 'bottom'}

Example

TypeScript
console.log(univerAPI.Enum.BoardFacadeElementAlignment.Left)

Package: @univerjs-pro/boards · Type definitions

Enum.BoardFacadeElementDistribution

Distribution axes accepted by board distribution helpers.

Available values

TypeScript
type EnumValues = {  /** Distribute elements along the x-axis. */  Horizontal: 'horizontal'  /** Distribute elements along the y-axis. */  Vertical: 'vertical'}

Example

TypeScript
console.log(univerAPI.Enum.BoardFacadeElementDistribution.Horizontal)

Package: @univerjs-pro/boards · Type definitions

Enum.BoardFacadeLayeredConnectionMode

Connection modes accepted by layered connector helpers.

Available values

TypeScript
type EnumValues = {  /** Connect each source layer item to every target layer item. */  Complete: 'complete'  /** Connect items by matching index. */  Pairwise: 'pairwise'  /** Connect each source item to a fan of target items. */  Fan: 'fan'}

Example

TypeScript
console.log(univerAPI.Enum.BoardFacadeLayeredConnectionMode.Pairwise)

Package: @univerjs-pro/boards · Type definitions

Enum.BoardFacadeLayeredLayoutAlignment

Cross-axis alignment modes accepted by layered layout helpers.

Available values

TypeScript
type EnumValues = {  /** Align layer items to the start of the cross-axis. */  Start: 'start'  /** Center layer items on the cross-axis. */  Center: 'center'  /** Align layer items to the end of the cross-axis. */  End: 'end'}

Example

TypeScript
console.log(univerAPI.Enum.BoardFacadeLayeredLayoutAlignment.Center)

Package: @univerjs-pro/boards · Type definitions

Enum.BoardFacadeLayeredLayoutDirection

Layered layout directions accepted by diagram layout helpers.

Available values

TypeScript
type EnumValues = {  /** Layout layers from top to bottom. */  Vertical: 'vertical'  /** Layout layers from left to right. */  Horizontal: 'horizontal'}

Example

TypeScript
console.log(univerAPI.Enum.BoardFacadeLayeredLayoutDirection.Horizontal)

Package: @univerjs-pro/boards · Type definitions

Enum.BoardFacadeNextAvailableBoundsPlacement

Placement directions accepted by getNextAvailableBounds().

Available values

TypeScript
type EnumValues = {  /** Place the new bounds to the right of existing content. */  Right: 'right'  /** Place the new bounds below existing content. */  Below: 'below'}

Example

TypeScript
const board = univerAPI.getActiveBoard()if (!board) throw new Error('No active board')const bounds = board.getNextAvailableBounds({  width: 180,  height: 100,  placement: univerAPI.Enum.BoardFacadeNextAvailableBoundsPlacement.Right,})console.log(bounds)

Package: @univerjs-pro/boards · Type definitions

Enum.BoardSequenceMessageType

UML sequence message types used by insertSequenceMessages().

Available values

TypeScript
type EnumValues = {  Synchronous: 'synchronous'  Asynchronous: 'asynchronous'  Reply: 'reply'  Create: 'create'  Destroy: 'destroy'  Self: 'self'}

Package: @univerjs-pro/boards · Type definitions

Enum.BoardSequenceShapeType

Native UML sequence participant and activation shapes.

Use these shapes with lifeline connector endpoints. Do not simulate a lifeline with a dashed free connector.

Available values

TypeScript
type EnumValues = {  ActorLifeline: 'sequence_actor_lifeline'  BoundaryLifeline: 'sequence_boundary_lifeline'  ControlLifeline: 'sequence_control_lifeline'  EntityLifeline: 'sequence_entity_lifeline'  CollectionLifeline: 'sequence_collection_lifeline'  ObjectLifeline: 'sequence_object_lifeline'  MagneticDiskLifeline: 'sequence_magnetic_disk_lifeline'  DirectAccessStorageLifeline: 'sequence_direct_access_storage_lifeline'  ActivationBar: 'sequence_activation_bar'}

Example

TypeScript
console.log(univerAPI.Enum.BoardSequenceShapeType.ObjectLifeline)

Package: @univerjs-pro/boards · Type definitions

Enum.BoardSwimlaneOrientation

Swimlane orientations accepted by board swimlane facade APIs.

Available values

TypeScript
type EnumValues = {  /** Lanes are stacked from top to bottom. */  Horizontal: 'horizontal'  /** Lanes are arranged from left to right. */  Vertical: 'vertical'}

Example

TypeScript
console.log(univerAPI.Enum.BoardSwimlaneOrientation.Horizontal)

Package: @univerjs-pro/boards · Type definitions

Enum.BoardToolType

Board toolbar tool types used by UI integrations.

This enum is not used by FBoard mutation APIs. Agent scripts that create board content should call id-first facade methods such as insertShape() or insertConnector() instead of switching tools.

Available values

TypeScript
type EnumValues = {  /** Select, move, resize, and edit existing elements. */  Select: BoardToolType.Select  /** Pan the Board viewport without changing content. */  Drag: BoardToolType.Drag  /** Insert a basic or custom vector shape. */  Shape: BoardToolType.Shape  /** Insert standalone editable text. */  Text: BoardToolType.Text  /** Insert a sticky-note shape. */  Sticky: BoardToolType.Sticky  /** Draw or connect line elements. */  Line: BoardToolType.Line  /** Insert a generic semantic container. */  Container: BoardToolType.Container  /** Insert a lane-based workflow container. */  Swimlane: BoardToolType.Swimlane  /** Insert an editable Board table. */  Table: BoardToolType.Table  /** Insert a chart through the registered Board chart adapter. */  Chart: BoardToolType.Chart  /** Draw a persistent Ink path. */  Pen: BoardToolType.Pen  /** Insert a structured mind map. */  MindMap: BoardToolType.MindMap  /** Open the shape and diagram resource library. */  Resources: BoardToolType.Resources  /** Insert an image resource. */  Image: BoardToolType.Image  /** Open the external content import flow. */  Import: BoardToolType.Import}

Example

TypeScript
console.log(univerAPI.Enum.BoardToolType.Shape)

Package: @univerjs-pro/boards · Type definitions

Enum.BoardUMLClassRelationType

UML class relationship presets used by insertClassRelation(s).

Available values

TypeScript
type EnumValues = {  Association: 'association'  DirectedAssociation: 'directedAssociation'  Aggregation: 'aggregation'  Composition: 'composition'  Generalization: 'generalization'  Realization: 'realization'  Dependency: 'dependency'}

Package: @univerjs-pro/boards · Type definitions

@univerjs-pro/boards-mind

Enum.BoardMindMapBranchLineType

Branch routing styles accepted by insertMindMap().

Available values

TypeScript
type EnumValues = {  /** Rounded elbow branches. */  RoundedOrthogonal: 'rounded-orthogonal'  /** Curved branches. */  Curve: 'curve'  /** Sharp elbow branches. */  Orthogonal: 'orthogonal'}

Example

TypeScript
console.log(univerAPI.Enum.BoardMindMapBranchLineType.Curve)

Package: @univerjs-pro/boards-mind · Type definitions

Enum.BoardMindMapNodeSide

Requested child node sides accepted by mind map creation and node insertion APIs.

Available values

TypeScript
type EnumValues = {  /** Left side of the parent. */  Left: 'left'  /** Right side of the parent. */  Right: 'right'  /** Top side of the parent. */  Top: 'top'  /** Bottom side of the parent. */  Bottom: 'bottom'}

Example

TypeScript
const side = univerAPI.Enum.BoardMindMapNodeSide.Rightconsole.log(side)

Package: @univerjs-pro/boards-mind · Type definitions

Enum.BoardMindMapStructureKind

Structured mind map layouts accepted by insertMindMap().

Available values

TypeScript
type EnumValues = {  /** Horizontal two-sided mind map. */  MindMapHorizontal: 'mindmap-horizontal'  /** Vertical mind map. */  MindMapVertical: 'mindmap-vertical'  /** Right-growing tree. */  TreeRight: 'tree-right'  /** Left-growing tree. */  TreeLeft: 'tree-left'  /** Alternating-side tree. */  TreeAlternate: 'tree-alternate'  /** Horizontal timeline. */  TimelineHorizontal: 'timeline-horizontal'  /** Vertical timeline. */  TimelineVertical: 'timeline-vertical'}

Example

TypeScript
console.log(univerAPI.Enum.BoardMindMapStructureKind.TreeRight)

Package: @univerjs-pro/boards-mind · Type definitions

@univerjs-pro/boards-table

Enum.BoardTableBorderDashEnum

Border dash styles used by Board table border definitions.

Available values

TypeScript
type EnumValues = {  /** Continuous border line. */  Solid: SlideTableBorderDashEnum.Solid  /** Dashed border line. */  Dash: SlideTableBorderDashEnum.Dash  /** Dotted border line. */  Dot: SlideTableBorderDashEnum.Dot  /** Alternating dash and dot border line. */  DashDot: SlideTableBorderDashEnum.DashDot  /** Remove the selected border. */  None: SlideTableBorderDashEnum.None}

Example

TypeScript
const dash = univerAPI.Enum.BoardTableBorderDashEnum.Dashconsole.log(dash)

Package: @univerjs-pro/boards-table · Type definitions

Enum.BoardTableBorderPresetEnum

Border presets accepted by FBoardTable.setBorderPreset().

Available values

TypeScript
type EnumValues = {  /** Apply borders to every outer and inner edge. */  All: SlideTableBorderPresetEnum.All  /** Apply only inner horizontal and vertical borders. */  Inner: SlideTableBorderPresetEnum.Inner  /** Apply only the outside rectangle. */  Outer: SlideTableBorderPresetEnum.Outer  /** Apply only the top edge. */  Top: SlideTableBorderPresetEnum.Top  /** Apply only the bottom edge. */  Bottom: SlideTableBorderPresetEnum.Bottom  /** Apply only the left edge. */  Left: SlideTableBorderPresetEnum.Left  /** Apply only the right edge. */  Right: SlideTableBorderPresetEnum.Right  /** Remove all borders in the target range. */  None: SlideTableBorderPresetEnum.None  /** Apply only borders between rows. */  InnerHorizontal: SlideTableBorderPresetEnum.InnerHorizontal  /** Apply only borders between columns. */  InnerVertical: SlideTableBorderPresetEnum.InnerVertical}

Example

TypeScript
const preset = univerAPI.Enum.BoardTableBorderPresetEnum.Allconsole.log(preset)

Package: @univerjs-pro/boards-table · Type definitions

Enum.BoardTableDiagramPreset

UML and ER diagram-table structures accepted by insertTable() and insertTable().

A preset supplies the initial table geometry and semantic styling. Set cell values after insertion to describe the specific entity, class, fields, or relationship.

Available values

TypeScript
type EnumValues = {  /** UML class box with name, attributes, and operations sections. */  UMLClass: BoardDiagramTablePreset.UMLClass  /** UML interface box with stereotype, name, and operations sections. */  UMLInterface: BoardDiagramTablePreset.UMLInterface  /** UML sequence-diagram frame with one labeled content region. */  UMLSequenceFragment: BoardDiagramTablePreset.UMLSequenceFragment  /** UML sequence-diagram alternative frame with multiple guarded regions. */  UMLSequenceAlternativeFragment: BoardDiagramTablePreset.UMLSequenceAlternativeFragment  /** Compact ER entity box containing an entity name. */  ERDEntity: BoardDiagramTablePreset.ERDEntity  /** ER field row with a dedicated primary/foreign key column. */  ERDKeyField: BoardDiagramTablePreset.ERDKeyField  /** ER field row with separate field-name and data-type columns. */  ERDFieldType: BoardDiagramTablePreset.ERDFieldType  /** Full ER entity table with name, key, field, and data-type columns. */  ERDFull: BoardDiagramTablePreset.ERDFull}

Example

TypeScript
console.log(univerAPI.Enum.BoardTableDiagramPreset.UMLClass)

Package: @univerjs-pro/boards-table · Type definitions

Enum.BoardTableFillTypeEnum

Fill styles accepted by FBoardTable.setCellStyle().

Available values

TypeScript
type EnumValues = {  /** Do not paint a cell fill. */  None: SlideTableFillTypeEnum.None  /** Paint one solid color. */  Solid: SlideTableFillTypeEnum.Solid  /** Paint a gradient defined by type, angle, and color stops. */  Gradient: SlideTableFillTypeEnum.Gradient  /** Paint an image using stretch or tile placement. */  Picture: SlideTableFillTypeEnum.Picture}

Example

TypeScript
const fill = univerAPI.Enum.BoardTableFillTypeEnum.Solidconsole.log(fill)

Package: @univerjs-pro/boards-table · Type definitions

Enum.BoardTableGradientFillTypeEnum

Gradient geometries accepted by Board table gradient fills.

Available values

TypeScript
type EnumValues = {  /** Linear gradient along an angle. */  Linear: SlideTableGradientFillTypeEnum.Linear  /** Radial gradient expanding from a center point. */  Radial: SlideTableGradientFillTypeEnum.Radial  /** Angular gradient rotating around a center point. */  Angular: SlideTableGradientFillTypeEnum.Angular  /** Diamond-shaped gradient expanding toward the corners. */  Diamond: SlideTableGradientFillTypeEnum.Diamond}

Example

TypeScript
const gradientType = univerAPI.Enum.BoardTableGradientFillTypeEnum.Linearconsole.log(gradientType)

Package: @univerjs-pro/boards-table · Type definitions

Enum.BoardTablePictureFillModeEnum

Image placement modes accepted by Board table picture fills.

Available values

TypeScript
type EnumValues = {  /** Scale one image to cover the cell fill area. */  Stretch: SlideTablePictureFillModeEnum.Stretch  /** Repeat the image as tiles inside the cell fill area. */  Tile: SlideTablePictureFillModeEnum.Tile}

Example

TypeScript
const pictureMode = univerAPI.Enum.BoardTablePictureFillModeEnum.Stretchconsole.log(pictureMode)

Package: @univerjs-pro/boards-table · Type definitions

Enum.BoardTableTextDirectionEnum

Text direction values accepted by Board table cell styles.

Available values

TypeScript
type EnumValues = {  /** Render text from left to right using normal horizontal lines. */  Horizontal: SlideTableTextDirectionEnum.Horizontal  /** Stack or rotate text vertically from top to bottom. */  Vertical: SlideTableTextDirectionEnum.Vertical  /** Render vertical text in the opposite 270-degree direction. */  Vertical270: SlideTableTextDirectionEnum.Vertical270  WordArtVertical: SlideTableTextDirectionEnum.WordArtVertical}

Example

TypeScript
const direction = univerAPI.Enum.BoardTableTextDirectionEnum.Verticalconsole.log(direction)

Package: @univerjs-pro/boards-table · Type definitions

Enum.BoardTableVerticalAlignEnum

Vertical alignment values accepted by Board table cell styles.

Available values

TypeScript
type EnumValues = {  /** Align cell content to the top edge. */  Top: SlideTableVerticalAlignEnum.Top  /** Center cell content vertically. */  Middle: SlideTableVerticalAlignEnum.Middle  /** Align cell content to the bottom edge. */  Bottom: SlideTableVerticalAlignEnum.Bottom}

Example

TypeScript
const alignment = univerAPI.Enum.BoardTableVerticalAlignEnum.Middleconsole.log(alignment)

Package: @univerjs-pro/boards-table · Type definitions

@univerjs-pro/boards-ui

Enum.BoardInteractionMode

Available values

TypeScript
type EnumValues = {  Editing: BoardInteractionMode.Editing  Viewing: BoardInteractionMode.Viewing}

Package: @univerjs-pro/boards-ui · Type definitions

@univerjs-pro/collaboration-client

Enum.CollaborationStatus

Get CollaborationStatus enum. CollaborationStatus

Available values

TypeScript
type EnumValues = {  NOT_COLLAB: CollaborationStatus.NOT_COLLAB  SYNCED: CollaborationStatus.SYNCED  PENDING: CollaborationStatus.PENDING  AWAITING: CollaborationStatus.AWAITING  AWAITING_WITH_PENDING: CollaborationStatus.AWAITING_WITH_PENDING  FETCH_MISS: CollaborationStatus.FETCH_MISS  CONFLICT: CollaborationStatus.CONFLICT  OFFLINE: CollaborationStatus.OFFLINE}

Package: @univerjs-pro/collaboration-client · Type definitions

@univerjs-pro/docs-chart

Enum.DocsChartInsertAnchorKind

Document insertion anchors accepted by a Document Chart builder's setPosition() method.

Use Selection for the active text selection or an explicit body offset for deterministic insertion.

Available values

TypeScript
type EnumValues = {  Selection: DocChartInsertAnchorKind.Selection  BodyOffset: DocChartInsertAnchorKind.BodyOffset  Paragraph: DocChartInsertAnchorKind.Paragraph  TextRange: DocChartInsertAnchorKind.TextRange}

Example

TypeScript
const fDocument = univerAPI.getActiveDocument()const chartInfo = fDocument  .newChart(univerAPI.Enum.ChartTypeString.Column)  .setSource([    ['Quarter', 'Sales'],    ['Q1', 120],    ['Q2', 180],  ])  .setPosition({    kind: univerAPI.Enum.DocsChartInsertAnchorKind.BodyOffset,    offset: 0,  })  .setInline()  .setSize(640, 360)  .build()await fDocument.insertChart(chartInfo)

Package: @univerjs-pro/docs-chart · Type definitions

Enum.DocsChartLayoutType

Document text-layout modes accepted by Chart layout APIs.

Prefer INLINE, WRAP_SQUARE, or WRAP_TOP_AND_BOTTOM. WRAP_NONE is a foreground overlay that can cover text. Contour wrapping modes require metadata that the document Chart Facade does not provide.

Available values

TypeScript
type EnumValues = {  /** Places the object in the text flow like a character and lets it affect the containing line's metrics. */  INLINE: PositionedObjectLayoutType.INLINE  /** Floats the object without reflowing text. The object and text can overlap. */  WRAP_NONE: PositionedObjectLayoutType.WRAP_NONE  /** Floats the object and wraps text around the custom polygon defined by its wrap path. */  WRAP_POLYGON: PositionedObjectLayoutType.WRAP_POLYGON  /** Floats the object and wraps text around its rectangular bounds. */  WRAP_SQUARE: PositionedObjectLayoutType.WRAP_SQUARE  /** Floats the object and allows text to flow through eligible open regions in its wrap contour. */  WRAP_THROUGH: PositionedObjectLayoutType.WRAP_THROUGH  /** Floats the object and wraps text closely around its contour instead of its rectangular bounds. */  WRAP_TIGHT: PositionedObjectLayoutType.WRAP_TIGHT  /** Floats the object in a horizontal band, leaving text only above and below it. */  WRAP_TOP_AND_BOTTOM: PositionedObjectLayoutType.WRAP_TOP_AND_BOTTOM}

Example

TypeScript
const fDocument = univerAPI.getActiveDocument()const chartInfo = fDocument  .newChart(univerAPI.Enum.ChartTypeString.Line)  .setSource([    ['Month', 'Sales'],    ['Jan', 120],    ['Feb', 180],  ])  .setLayout({    layoutType: univerAPI.Enum.DocsChartLayoutType.WRAP_SQUARE,    position: { x: 120, y: 80 },    width: 640,    height: 360,  })  .build()await fDocument.insertChart(chartInfo)

Package: @univerjs-pro/docs-chart · Type definitions

@univerjs-pro/docs-column

Enum.DocsColumnPositionEnum

Docs column position enum.

Available values

TypeScript
type EnumValues = {  LEFT: ColumnPosition.LEFT  RIGHT: ColumnPosition.RIGHT}

Example

TypeScript
const fDocument = univerAPI.getActiveDocument()const group = fDocument.findColumnGroupByText('Launch')const columns = group.getColumns()if (columns.length > 0) {  const rightColumn = group.getColumn(columns.length - 1)  const inserted = group.addColumn(    rightColumn.getId(),    univerAPI.Enum.DocsColumnPositionEnum.LEFT,    'new-column',  )  console.log(inserted?.getInsertOffset())}

Package: @univerjs-pro/docs-column · Type definitions

@univerjs-pro/docs-list

Enum.DocsListSelectionMode

Represents the selection scopes used by docs list operations.

Available values

TypeScript
type EnumValues = {  Item: DocsListSelectionMode.Item  Level: DocsListSelectionMode.Level  List: DocsListSelectionMode.List}

Example

TypeScript
const fDocument = univerAPI.getActiveDocument()const item = fDocument?.findListItemByText('Todo')item?.select(univerAPI.Enum.DocsListSelectionMode.Level)

Package: @univerjs-pro/docs-list · Type definitions

Enum.ListGlyphType

Represents the glyph types used by ordered and unordered docs lists.

Available values

TypeScript
type EnumValues = {  BULLET: ListGlyphType.BULLET  NONE: ListGlyphType.NONE  DECIMAL: ListGlyphType.DECIMAL  DECIMAL_ZERO: ListGlyphType.DECIMAL_ZERO  UPPER_LETTER: ListGlyphType.UPPER_LETTER  LOWER_LETTER: ListGlyphType.LOWER_LETTER  UPPER_ROMAN: ListGlyphType.UPPER_ROMAN  LOWER_ROMAN: ListGlyphType.LOWER_ROMAN  /** Not yet achieved, aligned with Excel's standards. 17.18.59 ST_NumberFormat (Numbering Format) */  ORDINAL: ListGlyphType.ORDINAL  CARDINAL_TEXT: ListGlyphType.CARDINAL_TEXT  ORDINAL_TEXT: ListGlyphType.ORDINAL_TEXT  HEX: ListGlyphType.HEX  CHICAGO: ListGlyphType.CHICAGO  IDEOGRAPH_DIGITAL: ListGlyphType.IDEOGRAPH_DIGITAL  JAPANESE_COUNTING: ListGlyphType.JAPANESE_COUNTING  AIUEO: ListGlyphType.AIUEO  IROHA: ListGlyphType.IROHA  DECIMAL_FULL_WIDTH: ListGlyphType.DECIMAL_FULL_WIDTH  DECIMAL_HALF_WIDTH: ListGlyphType.DECIMAL_HALF_WIDTH  JAPANESE_LEGAL: ListGlyphType.JAPANESE_LEGAL  JAPANESE_DIGITAL_TEN_THOUSAND: ListGlyphType.JAPANESE_DIGITAL_TEN_THOUSAND  DECIMAL_ENCLOSED_CIRCLE: ListGlyphType.DECIMAL_ENCLOSED_CIRCLE  DECIMAL_FULL_WIDTH2: ListGlyphType.DECIMAL_FULL_WIDTH2  AIUEO_FULL_WIDTH: ListGlyphType.AIUEO_FULL_WIDTH  IROHA_FULL_WIDTH: ListGlyphType.IROHA_FULL_WIDTH  GANADA: ListGlyphType.GANADA  CHOSUNG: ListGlyphType.CHOSUNG  DECIMAL_ENCLOSED_FULLSTOP: ListGlyphType.DECIMAL_ENCLOSED_FULLSTOP  DECIMAL_ENCLOSED_PAREN: ListGlyphType.DECIMAL_ENCLOSED_PAREN  DECIMAL_ENCLOSED_CIRCLE_CHINESE: ListGlyphType.DECIMAL_ENCLOSED_CIRCLE_CHINESE  IDEOGRAPH_ENCLOSED_CIRCLE: ListGlyphType.IDEOGRAPH_ENCLOSED_CIRCLE  IDEOGRAPH_TRADITIONAL: ListGlyphType.IDEOGRAPH_TRADITIONAL  IDEOGRAPH_ZODIAC: ListGlyphType.IDEOGRAPH_ZODIAC  IDEOGRAPH_ZODIAC_TRADITIONAL: ListGlyphType.IDEOGRAPH_ZODIAC_TRADITIONAL  TAIWANESE_COUNTING: ListGlyphType.TAIWANESE_COUNTING  IDEOGRAPH_LEGAL_TRADITIONAL: ListGlyphType.IDEOGRAPH_LEGAL_TRADITIONAL  TAIWANESE_COUNTING_THOUSAND: ListGlyphType.TAIWANESE_COUNTING_THOUSAND  TAIWANESE_DIGITAL: ListGlyphType.TAIWANESE_DIGITAL  CHINESE_COUNTING: ListGlyphType.CHINESE_COUNTING  CHINESE_LEGAL_SIMPLIFIED: ListGlyphType.CHINESE_LEGAL_SIMPLIFIED  CHINESE_COUNTING_THOUSAND: ListGlyphType.CHINESE_COUNTING_THOUSAND  KOREAN_DIGITAL: ListGlyphType.KOREAN_DIGITAL  KOREAN_COUNTING: ListGlyphType.KOREAN_COUNTING  KOREAN_LEGAL: ListGlyphType.KOREAN_LEGAL  KOREAN_DIGITAL2: ListGlyphType.KOREAN_DIGITAL2  VIETNAMESE_COUNTING: ListGlyphType.VIETNAMESE_COUNTING  RUSSIAN_LOWER: ListGlyphType.RUSSIAN_LOWER  RUSSIAN_UPPER: ListGlyphType.RUSSIAN_UPPER  NUMBER_IN_DASH: ListGlyphType.NUMBER_IN_DASH  HEBREW1: ListGlyphType.HEBREW1  HEBREW2: ListGlyphType.HEBREW2  ARABIC_ALPHA: ListGlyphType.ARABIC_ALPHA  ARABIC_ABJAD: ListGlyphType.ARABIC_ABJAD  HINDI_VOWELS: ListGlyphType.HINDI_VOWELS  HINDI_CONSONANTS: ListGlyphType.HINDI_CONSONANTS  HINDI_NUMBERS: ListGlyphType.HINDI_NUMBERS  HINDI_COUNTING: ListGlyphType.HINDI_COUNTING  THAI_LETTERS: ListGlyphType.THAI_LETTERS  THAI_NUMBERS: ListGlyphType.THAI_NUMBERS  THAI_COUNTING: ListGlyphType.THAI_COUNTING  CUSTOM: ListGlyphType.CUSTOM}

Example

TypeScript
const fDocument = univerAPI.getActiveDocument()const item = fDocument?.findListItemByText('Todo')item?.setGlyphType(univerAPI.Enum.ListGlyphType.UPPER_LETTER)

Package: @univerjs-pro/docs-list · Type definitions

@univerjs-pro/docs-shape

Enum.DocShapeAnchorPosition

Paragraph-relative insertion positions accepted by FDocument.insertShape().

Available values

TypeScript
type EnumValues = {  /** Insert before the first character in the paragraph. */  PARAGRAPH_START: DocShapeAnchorPosition.PARAGRAPH_START  /** Insert after the last character and before the paragraph terminator. */  PARAGRAPH_END: DocShapeAnchorPosition.PARAGRAPH_END  /** Insert at a character offset relative to the start of the paragraph. */  OFFSET: DocShapeAnchorPosition.OFFSET}

Example

TypeScript
const document = univerAPI.getActiveDocument()const paragraph = document?.getParagraphs()[0]if (!document || !paragraph) throw new Error('Document paragraph not found.')document.insertShape({  shapeType: univerAPI.Enum.ShapeTypeEnum.Rect,  placement: {    wrappingStyle: univerAPI.Enum.TextWrappingStyle.INLINE,    anchor: {      paragraphId: paragraph.getId(),      segmentId: paragraph.getSegmentId(),      position: univerAPI.Enum.DocShapeAnchorPosition.OFFSET,      offset: 0,    },  },})

Package: @univerjs-pro/docs-shape · Type definitions

@univerjs-pro/docs-table

Enum.DashStyleType

Represents dash styles used by table borders.

Available values

TypeScript
type EnumValues = {  DASH_STYLE_UNSPECIFIED: DashStyleType.DASH_STYLE_UNSPECIFIED  SOLID: DashStyleType.SOLID  DOT: DashStyleType.DOT  DASH: DashStyleType.DASH}

Example

TypeScript
const table = univerAPI.getActiveDocument()?.getTable('table-1')table?.setTableBorder({  preset: univerAPI.Enum.DocsTableBorderPreset.All,  border: { dashStyle: univerAPI.Enum.DashStyleType.DASH },})

Package: @univerjs-pro/docs-table · Type definitions

Enum.DocsTableBorderPreset

Represents border presets used by docs table border operations.

Available values

TypeScript
type EnumValues = {  All: DocsTableBorderPreset.All  Inner: DocsTableBorderPreset.Inner  Outer: DocsTableBorderPreset.Outer  Top: DocsTableBorderPreset.Top  Bottom: DocsTableBorderPreset.Bottom  Left: DocsTableBorderPreset.Left  Right: DocsTableBorderPreset.Right  None: DocsTableBorderPreset.None  InnerHorizontal: DocsTableBorderPreset.InnerHorizontal  InnerVertical: DocsTableBorderPreset.InnerVertical}

Example

TypeScript
const table = univerAPI.getActiveDocument()?.getTable('table-1')table?.setTableBorder({  preset: univerAPI.Enum.DocsTableBorderPreset.Outer,})

Package: @univerjs-pro/docs-table · Type definitions

Enum.DocsTableColumnInsertPosition

Represents column insertion positions used by docs table column operations.

Available values

TypeScript
type EnumValues = {  Left: DocsTableInsertPosition.Left  Right: DocsTableInsertPosition.Right}

Example

TypeScript
univerAPI.Enum.DocsTableColumnInsertPosition.Right

Package: @univerjs-pro/docs-table · Type definitions

Enum.DocsTableColumnType

Represents the logical column types used by docs table metadata.

Available values

TypeScript
type EnumValues = {  Text: DocsTableColumnType.Text  Number: DocsTableColumnType.Number  Date: DocsTableColumnType.Date  Checkbox: DocsTableColumnType.Checkbox  Dropdown: DocsTableColumnType.Dropdown}

Example

TypeScript
const fDocument = univerAPI.getActiveDocument()const table = fDocument.getTable('table-1')table?.setColumnType(1, {  type: univerAPI.Enum.DocsTableColumnType.Number,})

Package: @univerjs-pro/docs-table · Type definitions

Enum.DocsTableInsertTablePosition

Represents the insertion positions used by docs table creation.

Available values

TypeScript
type EnumValues = {  Selection: DocsTableInsertTablePosition.Selection  DocumentEnd: DocsTableInsertTablePosition.DocumentEnd  Offset: DocsTableInsertTablePosition.Offset}

Example

TypeScript
const fDocument = univerAPI.getActiveDocument()const table = fDocument.insertTable(3, 4, {  position: univerAPI.Enum.DocsTableInsertTablePosition.Selection,})

Package: @univerjs-pro/docs-table · Type definitions

Enum.DocsTableRowInsertPosition

Represents row insertion positions used by docs table row operations.

Available values

TypeScript
type EnumValues = {  Above: DocsTableInsertPosition.Above  Below: DocsTableInsertPosition.Below}

Example

TypeScript
univerAPI.Enum.DocsTableRowInsertPosition.Above

Package: @univerjs-pro/docs-table · Type definitions

Enum.DocsTableSelectionKind

Represents docs table selection scopes and modes.

Available values

TypeScript
type EnumValues = {  None: DocsTableSelectionKind.None  Text: DocsTableSelectionKind.Text  Cell: DocsTableSelectionKind.Cell  Range: DocsTableSelectionKind.Range  Row: DocsTableSelectionKind.Row  Column: DocsTableSelectionKind.Column  Table: DocsTableSelectionKind.Table}

Example

TypeScript
const fDocument = univerAPI.getActiveDocument()const table = fDocument.getTable('table-1')const tableRange = table?.getTableRange()if (tableRange) {  table.selectRange(tableRange, univerAPI.Enum.DocsTableSelectionKind.Table)}

Package: @univerjs-pro/docs-table · Type definitions

Enum.DocsTableSortDirection

Represents sort directions used by docs table sort operations.

Available values

TypeScript
type EnumValues = {  Asc: DocsTableSortDirection.Asc  Desc: DocsTableSortDirection.Desc}

Example

TypeScript
const table = univerAPI.getActiveDocument()?.getTable('table-1')table?.sortByColumn(1, univerAPI.Enum.DocsTableSortDirection.Asc)

Package: @univerjs-pro/docs-table · Type definitions

@univerjs-pro/embed

Enum.FEmbedHostSurface

Available values

TypeScript
type EnumValues = {  DocBlock: 'docs-custom-block'  SheetTab: 'sheets-sheet-tab'  SheetFloating: 'sheets-floating-object'  BaseTable: 'bases-table-list-block'  SlidePage: 'slides-page-list-block'  SlideFloating: 'slides-floating-object'  BoardFloating: 'boards-floating-object'}

Package: @univerjs-pro/embed · Type definitions

@univerjs-pro/engine-chart

Enum.ChartAggregationTarget

Targets used when clearing selected Chart aggregation settings.

Available values

TypeScript
type EnumValues = {  Aggregate: ChartAggregationTarget.Aggregate  TopN: ChartAggregationTarget.TopN}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Column)  .setSource('A1:D8')  .setAggregation({ topN: { count: 5 } })  .clearAggregation(univerAPI.Enum.ChartAggregationTarget.TopN)  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartAllSeriesStyleTarget

Targets used when clearing selected all-series style settings.

Available values

TypeScript
type EnumValues = {  Border: ChartAllSeriesStyleTarget.Border  Color: ChartAllSeriesStyleTarget.Color  FillOpacity: ChartAllSeriesStyleTarget.FillOpacity  Label: ChartAllSeriesStyleTarget.Label  Point: ChartAllSeriesStyleTarget.Point  RightAxis: ChartAllSeriesStyleTarget.RightAxis}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Line)  .setSource('A1:D8')  .setAllSeriesStyle({ color: '#2563eb' })  .clearAllSeriesStyle(univerAPI.Enum.ChartAllSeriesStyleTarget.Color)  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartAppearanceTarget

Targets used when clearing selected Chart appearance settings.

Available values

TypeScript
type EnumValues = {  Background: ChartAppearanceTarget.Background  Border: ChartAppearanceTarget.Border  Font: ChartAppearanceTarget.Font}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Column)  .setSource('A1:D8')  .setAppearance({ background: { color: '#ffffff' } })  .clearAppearance(univerAPI.Enum.ChartAppearanceTarget.Background)  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartAreaLineStyle

Straight and smooth line styles for Area Charts.

Available values

TypeScript
type EnumValues = {  Line: AreaLineStyle.Line  Smooth: AreaLineStyle.Smooth  Step: AreaLineStyle.Step}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Area)  .setSource('A1:D8')  .setAreaLineStyle(univerAPI.Enum.ChartAreaLineStyle.Smooth)  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartAxisName

Semantic names for the category, primary value, and secondary value axes.

Available values

TypeScript
type EnumValues = {  X: ChartAxisName.X  Y: ChartAxisName.Y  RightY: ChartAxisName.RightY}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Line)  .setSource('A1:D8')  .build()const fChart = await fWorksheet.insertChart(chartInfo)const updatedInfo = fChart.toBuilder().build()await fChart.update({  ...updatedInfo,  config: {    ...updatedInfo.config,    axes: {      ...updatedInfo.config.axes,      [univerAPI.Enum.ChartAxisName.Y]: {        title: 'Revenue',      },    },  },})

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartAxisPointerTarget

Targets used when clearing selected axis-pointer settings.

Available values

TypeScript
type EnumValues = {  IndicatorLabelColor: ChartAxisPointerTarget.IndicatorLabelColor  IndicatorLabelTextColor: ChartAxisPointerTarget.IndicatorLabelTextColor  IndicatorLineColor: ChartAxisPointerTarget.IndicatorLineColor  IndicatorLineType: ChartAxisPointerTarget.IndicatorLineType}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Line)  .setSource('A1:D8')  .setAxisPointer({ indicatorLineColor: '#2563eb' })  .clearAxisPointer(univerAPI.Enum.ChartAxisPointerTarget.IndicatorLineColor)  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartAxisTarget

Targets used when clearing selected axis settings.

Available values

TypeScript
type EnumValues = {  Min: ChartAxisTarget.Min  Max: ChartAxisTarget.Max  Reverse: ChartAxisTarget.Reverse  Line: ChartAxisTarget.Line  Tick: ChartAxisTarget.Tick  Format: ChartAxisTarget.Format  Label: ChartAxisTarget.Label  GridLine: ChartAxisTarget.GridLine}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Line)  .setSource('A1:D8')  .setYAxis({ gridLine: { visible: true } })  .clearYAxis(univerAPI.Enum.ChartAxisTarget.GridLine)  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartAxisTickPosition

Positions for rendering axis ticks inside or outside the axis.

Available values

TypeScript
type EnumValues = {  Inside: ChartAxisTickPosition.Inside  Outside: ChartAxisTickPosition.Outside}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Line)  .setSource('A1:D8')  .setXAxis({ tick: { position: univerAPI.Enum.ChartAxisTickPosition.Outside } })  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartChordFocusMode

Focus behavior used when emphasizing a Chord node or ribbon.

Available values

TypeScript
type EnumValues = {  Adjacency: 'adjacency'  Self: 'self'  None: 'none'}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Chord)  .setSource('A1:C8')  .setChordMapping({ sourceIndex: 0, targetIndex: 1, valueIndex: 2 })  .setChordEmphasis({ focus: univerAPI.Enum.ChartChordFocusMode.Adjacency })  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartChordLabelPosition

Positions supported by Chord node labels.

Available values

TypeScript
type EnumValues = {  Inside: 'inside'  Outside: 'outside'}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Chord)  .setSource('A1:C8')  .setChordMapping({ sourceIndex: 0, targetIndex: 1, valueIndex: 2 })  .setChordLabel({ position: univerAPI.Enum.ChartChordLabelPosition.Outside })  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartChordRibbonColorMode

Color sources supported by Chord ribbons.

Available values

TypeScript
type EnumValues = {  Source: 'source'  Target: 'target'  Gradient: 'gradient'}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Chord)  .setSource('A1:C8')  .setChordMapping({ sourceIndex: 0, targetIndex: 1, valueIndex: 2 })  .setChordRibbon({ color: univerAPI.Enum.ChartChordRibbonColorMode.Gradient })  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartGaugeMode

Visual-language presets supported by Gauge Charts.

Available values

TypeScript
type EnumValues = {  Modern: 'modern'  Classic: 'classic'}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Gauge)  .setSource('A1:B8')  .setCategoryField(0)  .setGaugeValueField(1)  .setGaugeMode(univerAPI.Enum.ChartGaugeMode.Modern)  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartGaugePointerShape

Pointer shapes supported by Gauge Charts.

Available values

TypeScript
type EnumValues = {  Needle: 'needle'  Slim: 'slim'  Arrow: 'arrow'}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Gauge)  .setSource('A1:B8')  .setCategoryField(0)  .setGaugeValueField(1)  .setGaugePointer({ shape: univerAPI.Enum.ChartGaugePointerShape.Needle })  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartInvalidValueType

Strategies for handling invalid or missing Chart values.

Available values

TypeScript
type EnumValues = {  Zero: InvalidValueType.Zero  Break: InvalidValueType.Break  Link: InvalidValueType.Link}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Line)  .setSource('A1:D8')  .setInvalidValueStrategy(univerAPI.Enum.ChartInvalidValueType.Zero)  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartLabelAlignEnum

Horizontal label-alignment values used by Chart label specifications.

Available values

TypeScript
type EnumValues = {  Left: LabelAlignEnum.Left  Right: LabelAlignEnum.Right  Center: LabelAlignEnum.Center}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Column)  .setSource('A1:D8')  .setTitle({ text: 'Sales', alignment: univerAPI.Enum.ChartLabelAlignEnum.Center })  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartLegendPositionEnum

Placement values for Chart legends.

Available values

TypeScript
type EnumValues = {  /** The legend is displayed at the top of the chart. */  Top: LegendPositionEnum.Top  /** The legend is displayed at the left of the chart. */  Left: LegendPositionEnum.Left  /** The legend is displayed at the right of the chart. */  Right: LegendPositionEnum.Right  /** The legend is displayed at the bottom of the chart. */  Bottom: LegendPositionEnum.Bottom  /** The legend is hidden. */  Hide: LegendPositionEnum.Hide}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Column)  .setSource('A1:D8')  .setLegend({ position: univerAPI.Enum.ChartLegendPositionEnum.Bottom })  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartLinePointShape

Point-symbol shapes used by Line and Relation Charts.

Available values

TypeScript
type EnumValues = {  /** Excel short horizontal marker. */  Dot: LinePointShape.Dot  /** Excel long horizontal marker. */  Dash: LinePointShape.Dash  /** The circle shape. */  Circle: LinePointShape.Circle  /** The square shape. */  Square: LinePointShape.Square  /** The triangle shape. */  Triangle: LinePointShape.Triangle  /** The diamond shape. */  Diamond: LinePointShape.Diamond  /** The rectangle shape. */  Rect: LinePointShape.Rect  /** The rounded rectangle shape. */  RoundRect: LinePointShape.RoundRect  /** The pin shape. */  Pin: LinePointShape.Pin  /** The arrow shape. */  Arrow: LinePointShape.Arrow  /** No shape. */  None: LinePointShape.None  /** The empty circle shape. */  EmptyCircle: LinePointShape.EmptyCircle  /** The empty square shape. */  EmptySquare: LinePointShape.EmptySquare  /** The empty triangle shape. */  EmptyTriangle: LinePointShape.EmptyTriangle  /** The empty diamond shape. */  EmptyDiamond: LinePointShape.EmptyDiamond  /** The empty rectangle shape. */  EmptyRect: LinePointShape.EmptyRect  /** The empty rounded rectangle shape. */  EmptyRoundRect: LinePointShape.EmptyRoundRect  /** The empty pin shape. */  EmptyPin: LinePointShape.EmptyPin  /** The empty arrow shape. */  EmptyArrow: LinePointShape.EmptyArrow}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Relation)  .setSource('A1:C8')  .setNodeShape(univerAPI.Enum.ChartLinePointShape.Circle)  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartMarkLineLabelPosition

Label positions supported by semantic Chart mark lines.

Available values

TypeScript
type EnumValues = {  Start: ChartMarkLineLabelPosition.Start  Middle: ChartMarkLineLabelPosition.Middle  End: ChartMarkLineLabelPosition.End}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Line)  .setSource('A1:D8')  .setMarkLines([    {      axis: univerAPI.Enum.ChartSemanticAxis.PrimaryValue,      value: 80,      label: { position: univerAPI.Enum.ChartMarkLineLabelPosition.End },    },  ])  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartPieLabelPosition

Label positions supported by Pie and Donut Charts.

Available values

TypeScript
type EnumValues = {  Auto: PieLabelPosition.Auto  Inside: PieLabelPosition.Inside  Outside: PieLabelPosition.Outside}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Pie)  .setSource('A1:B8')  .setPieLabel({ position: univerAPI.Enum.ChartPieLabelPosition.Outside })  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartPieSecondaryPlotType

Secondary plot types supported by composite Pie Charts.

Available values

TypeScript
type EnumValues = {  Pie: 'pie'  Bar: 'bar'}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Pie)  .setSource('A1:B8')  .setPieComposite({    enabled: true,    secondaryPlot: { type: univerAPI.Enum.ChartPieSecondaryPlotType.Pie },  })  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartRadarShape

Polygon and circle layouts for Radar Charts.

Available values

TypeScript
type EnumValues = {  Polygon: RadarShape.Polygon  Circle: RadarShape.Circle}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Radar)  .setSource('A1:D8')  .setShape(univerAPI.Enum.ChartRadarShape.Circle)  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartRelationChartLayoutEnum

Force, circular, and other layouts supported by Relation Charts.

Available values

TypeScript
type EnumValues = {  None: RelationChartLayoutEnum.None  Circular: RelationChartLayoutEnum.Circular  Force: RelationChartLayoutEnum.Force}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Relation)  .setSource('A1:C8')  .setLayout(univerAPI.Enum.ChartRelationChartLayoutEnum.Force)  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartSelectModeEnum

Legend selection behaviors.

Available values

TypeScript
type EnumValues = {  /** The single selection mode. */  Single: SelectModeEnum.Single  /** The multiple selection */  Multiple: SelectModeEnum.Multiple  /** The close selection mode.It means the legend can not be selected. */  Close: SelectModeEnum.Close}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Column)  .setSource('A1:D8')  .setLegend({ selectMode: univerAPI.Enum.ChartSelectModeEnum.Multiple })  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartSemanticAxis

Semantic axes referenced by mark lines and other cross-axis settings.

Available values

TypeScript
type EnumValues = {  Category: ChartSemanticAxis.Category  SecondaryCategory: ChartSemanticAxis.SecondaryCategory  PrimaryValue: ChartSemanticAxis.PrimaryValue  SecondaryValue: ChartSemanticAxis.SecondaryValue}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Line)  .setSource('A1:D8')  .setMarkLines([    {      axis: univerAPI.Enum.ChartSemanticAxis.PrimaryValue,      value: 80,    },  ])  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartSeriesAxis

Primary and secondary value-axis assignments for combination series.

Available values

TypeScript
type EnumValues = {  Left: ChartSeriesAxis.Left  Right: ChartSeriesAxis.Right}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Combination)  .setSource('A1:D8')  .setSeriesAxis(0, univerAPI.Enum.ChartSeriesAxis.Right)  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartSeriesClearTarget

Targets used when clearing selected per-series style settings.

Available values

TypeScript
type EnumValues = {  Border: ChartSeriesClearTarget.Border  Color: ChartSeriesClearTarget.Color  DataPoints: ChartSeriesClearTarget.DataPoints  FillOpacity: ChartSeriesClearTarget.FillOpacity  Label: ChartSeriesClearTarget.Label  Point: ChartSeriesClearTarget.Point  RightAxis: ChartSeriesClearTarget.RightAxis}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Line)  .setSource('A1:D8')  .setSeries(0, { color: '#2563eb' })  .clearSeries(0, univerAPI.Enum.ChartSeriesClearTarget.Color)  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartSeriesLabelPosition

Label positions shared by supported Chart series.

Available values

TypeScript
type EnumValues = {  Auto: SeriesLabelPosition.Auto  Top: SeriesLabelPosition.Top  Bottom: SeriesLabelPosition.Bottom  Left: SeriesLabelPosition.Left  Right: SeriesLabelPosition.Right  Inside: SeriesLabelPosition.Inside  InsideBase: SeriesLabelPosition.InsideBase  InsideEnd: SeriesLabelPosition.InsideEnd  Outside: SeriesLabelPosition.Outside}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Line)  .setSource('A1:D8')  .setSeries(0, { label: { position: univerAPI.Enum.ChartSeriesLabelPosition.Inside } })  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartSeriesTypeString

Series types available inside a Combination Chart.

Available values

TypeScript
type EnumValues = {  Column: ChartSeriesTypeString.Column  ColumnStacked: ChartSeriesTypeString.ColumnStacked  Line: ChartSeriesTypeString.Line  Area: ChartSeriesTypeString.Area  AreaStacked: ChartSeriesTypeString.AreaStacked}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Combination)  .setSource('A1:D8')  .setSeriesType(0, univerAPI.Enum.ChartSeriesTypeString.ColumnStacked)  .setSeriesType(1, univerAPI.Enum.ChartSeriesTypeString.AreaStacked)  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartSunburstLabelPosition

Label positions supported by Sunburst Charts.

Available values

TypeScript
type EnumValues = {  Inside: 'inside'  Outside: 'outside'}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Sunburst)  .setSource('A1:D8')  .setHierarchyFields([0, 1, 2])  .setValueField(3)  .setSunburstLabel({ position: univerAPI.Enum.ChartSunburstLabelPosition.Outside })  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartThemeName

Stable names of the built-in Chart themes.

Custom themes registered through univerAPI.registerTheme() continue to use their registered string names directly.

Available values

TypeScript
type EnumValues = {  /** Balanced Univer palette with blue, cyan, pink, orange, purple, and light blue. */  Default: ChartThemeName.Default  /** Bright blue-and-cyan palette accented with coral and yellow. */  Univer1: ChartThemeName.Univer1  /** High-contrast palette combining blue, coral, cyan, yellow, green, and orange. */  Univer2: ChartThemeName.Univer2  /** Softer pastel palette led by light blue and cyan with warm coral and orange accents. */  Univer3: ChartThemeName.Univer3  /** Blue-and-coral palette softened with lavender, pink, light blue, and peach. */  Univer4: ChartThemeName.Univer4  /** Light, low-saturation pastel palette with blue, cyan, lavender, pink, and peach. */  Univer5: ChartThemeName.Univer5  /** Vivid mixed palette with strong blue, coral, yellow, cyan, and orange contrast. */  Univer6: ChartThemeName.Univer6  /** Monochromatic blue palette progressing from deep navy blue to pale periwinkle. */  UniverGradient1: ChartThemeName.UniverGradient1  /** Monochromatic purple palette progressing from deep violet to pale lavender. */  UniverGradient2: ChartThemeName.UniverGradient2  /** Monochromatic red palette progressing from dark crimson to soft coral pink. */  UniverGradient3: ChartThemeName.UniverGradient3  /** Monochromatic azure palette progressing from deep blue to pale sky blue. */  UniverGradient4: ChartThemeName.UniverGradient4  /** Monochromatic magenta palette progressing from deep berry to pale pink. */  UniverGradient5: ChartThemeName.UniverGradient5  /** Monochromatic teal palette progressing from deep teal to pale cyan. */  UniverGradient6: ChartThemeName.UniverGradient6}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Column)  .setSource('A1:B8')  .setTheme(univerAPI.Enum.ChartThemeName.UniverGradient1)  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartTitlePositionEnum

Placement values for Chart titles.

Available values

TypeScript
type EnumValues = {  /** The chart title is displayed at the top of the chart. */  Top: TitlePositionEnum.Top  /** The chart title is displayed at the left of the chart */  Left: TitlePositionEnum.Left  /** The chart title is displayed at the right of the */  Right: TitlePositionEnum.Right  /** The chart title is displayed at the bottom of the */  Bottom: TitlePositionEnum.Bottom  /** The chart title is hidden. */  Hide: TitlePositionEnum.Hide}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Column)  .setSource('A1:D8')  .setTitle({ text: 'Sales', position: univerAPI.Enum.ChartTitlePositionEnum.Top })  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartTreemapParentLabelLayout

Layout modes supported by Treemap parent labels.

Available values

TypeScript
type EnumValues = {  Banner: 'banner'  Overlapping: 'overlapping'  None: 'none'}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Treemap)  .setSource('A1:D8')  .setHierarchyFields([0, 1, 2])  .setValueField(3)  .setParentLabelLayout(univerAPI.Enum.ChartTreemapParentLabelLayout.Banner)  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartTrendlineType

Trendline algorithms accepted by Cartesian series builders.

Available values

TypeScript
type EnumValues = {  /** Specifies the trendline shall be an exponential curve in the form y = ab^x */  exp: ChartTrendlineType.exp  /** Specifies the trendline shall be a linear curve in the form y = mx + b */  linear: ChartTrendlineType.linear  /** Specifies the trendline shall be a logarithmic curve in the form y = a log x + b, where log is the natural logarithm. */  log: ChartTrendlineType.log  /** Specifies the trendline shall be a moving average of period Period. */  movingAvg: ChartTrendlineType.movingAvg  /** Specifies the trendline shall be a polynomial curve of order Order in the form y = ax^6 + bx^5+cx^4 + dx^3 + ex^2 + fx + g */  poly: ChartTrendlineType.poly  /** Specifies the trendline shall be a power curve in the form y = ax^b */  pow: ChartTrendlineType.pow}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Line)  .setSource('A1:D8')  .setTrendline(0, { type: univerAPI.Enum.ChartTrendlineType.linear })  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartTypeString

Canonical Chart types accepted by newChart() and toBuilder(type).

Available values

TypeScript
type EnumValues = {  Line: ChartTypeString.Line  Column: ChartTypeString.Column  ColumnStacked: ChartTypeString.ColumnStacked  ColumnPercentStacked: ChartTypeString.ColumnPercentStacked  Bar: ChartTypeString.Bar  BarStacked: ChartTypeString.BarStacked  BarPercentStacked: ChartTypeString.BarPercentStacked  Pie: ChartTypeString.Pie  Donut: ChartTypeString.Donut  Area: ChartTypeString.Area  AreaStacked: ChartTypeString.AreaStacked  AreaPercentStacked: ChartTypeString.AreaPercentStacked  Radar: ChartTypeString.Radar  Scatter: ChartTypeString.Scatter  Combination: ChartTypeString.Combination  WordCloud: ChartTypeString.WordCloud  Funnel: ChartTypeString.Funnel  Bubble: ChartTypeString.Bubble  Relation: ChartTypeString.Relation  Waterfall: ChartTypeString.Waterfall  Pareto: ChartTypeString.Pareto  Sankey: ChartTypeString.Sankey  Heatmap: ChartTypeString.Heatmap  Boxplot: ChartTypeString.Boxplot  Candlestick: ChartTypeString.Candlestick  Histogram: ChartTypeString.Histogram  Treemap: ChartTypeString.Treemap  Sunburst: ChartTypeString.Sunburst  Gauge: ChartTypeString.Gauge  Chord: ChartTypeString.Chord}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Gauge)  .setSource('A1:B8')  .setCategoryField(0)  .setGaugeValueField(1)  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartVisualMapType

Continuous and piecewise visual-map modes for Heatmap Charts.

Available values

TypeScript
type EnumValues = {  Continuous: ChartVisualMapType.Continuous  Piecewise: ChartVisualMapType.Piecewise}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Heatmap)  .setSource('A1:D8')  .setVisualMapType(univerAPI.Enum.ChartVisualMapType.Continuous)  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartWaterfallPointRole

Semantic point roles used to mark Waterfall totals and subtotals.

Available values

TypeScript
type EnumValues = {  Change: ChartWaterfallPointRole.Change  Total: ChartWaterfallPointRole.Total}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Waterfall)  .setSource('A1:B8')  .setPointRoles([    {      series: 0,      dataPointIndex: 3,      role: univerAPI.Enum.ChartWaterfallPointRole.Total,    },  ])  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartWaterfallStackTypeEnum

Stacking modes supported by Waterfall Charts.

Available values

TypeScript
type EnumValues = {  /** The difference series will one by one put on the top of the previous series. */  Arrangement: WaterfallStackTypeEnum.Arrangement  /** The difference series show in same position, and the value will be stacked. */  Stacked: WaterfallStackTypeEnum.Stacked}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Waterfall)  .setSource('A1:B8')  .setStackType(univerAPI.Enum.ChartWaterfallStackTypeEnum.Arrangement)  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartWaterfallStyleTarget

Targets used when clearing selected Waterfall point styles.

Available values

TypeScript
type EnumValues = {  Positive: ChartWaterfallStyleTarget.Positive  Negative: ChartWaterfallStyleTarget.Negative  Subtotal: ChartWaterfallStyleTarget.Subtotal}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Waterfall)  .setSource('A1:B8')  .build()const fChart = await fWorksheet.insertChart(chartInfo)const updatedInfo = fChart.toBuilder().build()await fChart.update({  ...updatedInfo,  config: {    ...updatedInfo.config,    series: [      {        selector: { index: 0 },        waterfallStyles: {          [univerAPI.Enum.ChartWaterfallStyleTarget.Positive]: {            color: '#16a34a',          },        },      },    ],  },})

Package: @univerjs-pro/engine-chart · Type definitions

Enum.ChartWordCloudShapeEnum

Built-in outline shapes for Word Cloud Charts.

Available values

TypeScript
type EnumValues = {  Cloud: WordCloudShapeEnum.Cloud  Rect: WordCloudShapeEnum.Rect  Circle: WordCloudShapeEnum.Circle  Cardioid: WordCloudShapeEnum.Cardioid  Heart: WordCloudShapeEnum.Heart  Diamond: WordCloudShapeEnum.Diamond  TriangleForward: WordCloudShapeEnum.TriangleForward  Triangle: WordCloudShapeEnum.Triangle  Pentagon: WordCloudShapeEnum.Pentagon  Star: WordCloudShapeEnum.Star}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.WordCloud)  .setSource('A1:B8')  .setShape(univerAPI.Enum.ChartWordCloudShapeEnum.Cloud)  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/engine-chart · Type definitions

@univerjs-pro/engine-formula

Enum.FormulaReferenceType

Reference target kinds accepted by formula.buildReference().

Available values

TypeScript
type EnumValues = {  /** A worksheet A1 range such as `Sheet1!A1:B10` or `'[Sales]Data'!A1:B10`. */  SHEET_RANGE: FormulaReferenceType.SHEET_RANGE  /** A Base structured reference such as `Orders[Amount]` or `[Sales]!Orders[Amount]`. */  TABLE_COLUMN: FormulaReferenceType.TABLE_COLUMN}

Example

Select a Sheet range target

TypeScript
const workbook = univerAPI.getActiveWorkbook()if (!workbook) throw new Error('No active workbook.')const shape = workbook.getActiveSheet().getShape('formula-shape-1')if (!shape?.isFormulaShape()) throw new Error('Formula Shape not found.')const formula = univerAPI.getFormula()const reference = formula.buildReference({  hostUnitId: workbook.getId(),  unit: {    unitId: workbook.getId(),    formulaQualifier: 'Current Workbook',  },  target: {    kind: univerAPI.Enum.FormulaReferenceType.SHEET_RANGE,    sheetName: 'Sheet1',    range: { startRow: 0, endRow: 9, startColumn: 0, endColumn: 1 },  },})shape.setFormula({  formula: `=SUM(${reference})`,  externalReferences: [], // Required; empty only because Source and Host are the same Unit.})

Select a Base table-column target

TypeScript
import type { IFormulaReferenceUnit } from '@univerjs-pro/engine-formula'function setSalesBaseFormula(baseUnit: IFormulaReferenceUnit) {  const board = univerAPI.getActiveBoard()  if (!board) throw new Error('No active board.')  const shape = board.getShape('formula-shape-1')  if (!shape?.isFormulaShape()) throw new Error('Formula Shape not found.')  const reference = univerAPI.getFormula().buildReference({    hostUnitId: board.getId(),    unit: baseUnit,    target: {      kind: univerAPI.Enum.FormulaReferenceType.TABLE_COLUMN,      tableName: 'SalesTable',      columnName: 'Amount',    },  })  shape.setFormula({    formula: `=SUM(${reference})`,    externalReferences: [      {        qualifier: baseUnit.formulaQualifier,        sourceUnitId: baseUnit.unitId,        sourceUnitType: univerAPI.Enum.UniverInstanceType.UNIVER_BASE,      },    ],  })}setSalesBaseFormula({  unitId: 'sales-base',  formulaQualifier: 'Sales Base',})

Package: @univerjs-pro/engine-formula · Type definitions

@univerjs-pro/engine-shape

Enum.ShapeArrowSizeEnum

Connector arrowhead sizes.

Available values

TypeScript
type EnumValues = {  Small: ShapeArrowSizeEnum.Small  Medium: ShapeArrowSizeEnum.Medium  Large: ShapeArrowSizeEnum.Large}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const fConnectorShape = fWorksheet.insertShape({  shapeType: univerAPI.Enum.ShapeTypeEnum.StraightConnector1,})fConnectorShape.setEndArrow(  univerAPI.Enum.ShapeArrowTypeEnum.Arrow,  univerAPI.Enum.ShapeArrowSizeEnum.Large,)

Package: @univerjs-pro/engine-shape · Type definitions

Enum.ShapeArrowTypeEnum

Connector arrowhead types.

Available values

TypeScript
type EnumValues = {  None: ShapeArrowTypeEnum.None  Arrow: ShapeArrowTypeEnum.Arrow  OpenArrow: ShapeArrowTypeEnum.OpenArrow  DiamondArrow: ShapeArrowTypeEnum.DiamondArrow  StealthArrow: ShapeArrowTypeEnum.StealthArrow  OvalArrow: ShapeArrowTypeEnum.OvalArrow}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const fConnectorShape = fWorksheet.insertShape({  shapeType: univerAPI.Enum.ShapeTypeEnum.StraightConnector1,})fConnectorShape.setEndArrow(univerAPI.Enum.ShapeArrowTypeEnum.Arrow)

Package: @univerjs-pro/engine-shape · Type definitions

Enum.ShapeFillEnum

Shape fill types such as no fill, solid, gradient, and picture.

Available values

TypeScript
type EnumValues = {  NoFill: ShapeFillEnum.NoFill  SolidFill: ShapeFillEnum.SolidFill  GradientFill: ShapeFillEnum.GradientFill  PatternFill: ShapeFillEnum.PatternFill  PictureFill: ShapeFillEnum.PictureFill}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const fShape = fWorksheet.insertShape({  shapeType: univerAPI.Enum.ShapeTypeEnum.Rect,  shapeData: {    fill: {      fillType: univerAPI.Enum.ShapeFillEnum.SolidFill,      color: '#2563eb',    },  },})

Package: @univerjs-pro/engine-shape · Type definitions

Enum.ShapeGradientTypeEnum

Gradient geometries accepted by Shape fill APIs.

Available values

TypeScript
type EnumValues = {  Linear: ShapeGradientTypeEnum.Linear  Radial: ShapeGradientTypeEnum.Radial  Angular: ShapeGradientTypeEnum.Angular  Diamond: ShapeGradientTypeEnum.Diamond}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const fShape = fWorksheet.insertShape({  shapeType: univerAPI.Enum.ShapeTypeEnum.Rect,})fShape.setGradientFill(univerAPI.Enum.ShapeGradientTypeEnum.Linear, [  { position: 0, color: '#2563eb' },  { position: 1, color: '#a855f7' },])

Package: @univerjs-pro/engine-shape · Type definitions

Enum.ShapeImageFillModeEnum

Image fill layout modes for stretching or tiling an image inside a Shape.

Available values

TypeScript
type EnumValues = {  Stretch: ImageFillModeEnum.Stretch  /** Tile: The image is repeated (tiled) to fill the shape's area. */  Tile: ImageFillModeEnum.Tile}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const fShape = fWorksheet.insertShape({ shapeType: univerAPI.Enum.ShapeTypeEnum.Rect })fShape.setImageFill(  'https://github.com/dream-num.png',  univerAPI.Enum.ShapeImageSourceTypeEnum.URL,  {    imageFillMode: univerAPI.Enum.ShapeImageFillModeEnum.Stretch,  },)

Package: @univerjs-pro/engine-shape · Type definitions

Enum.ShapeImageSourceTypeEnum

Image source types accepted by Shape image fill APIs.

Available values

TypeScript
type EnumValues = {  /** The image source is a URL, for example: https://avatars.githubusercontent.com/u/61444807?s=48&v=4 */  URL: ImageSourceType.URL  /** The image source is a UUID, this ID is generated by the Univer image hosting service. For specific generation rules, please refer to the Univer image hosting service API documentation. */  UUID: ImageSourceType.UUID  /** The image source is BASE64, for example: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAALCAYAAAB7ZJ... */  BASE64: ImageSourceType.BASE64}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const fShape = fWorksheet.insertShape({  shapeType: univerAPI.Enum.ShapeTypeEnum.Rect,})fShape.setImageFill('https://github.com/dream-num.png', univerAPI.Enum.ShapeImageSourceTypeEnum.URL)

Package: @univerjs-pro/engine-shape · Type definitions

Enum.ShapeLineCapEnum

Line cap styles accepted by Shape stroke APIs.

Available values

TypeScript
type EnumValues = {  Flat: ShapeLineCapEnum.Flat  Round: ShapeLineCapEnum.Round  Square: ShapeLineCapEnum.Square}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const fShape = fWorksheet.insertShape({  shapeType: univerAPI.Enum.ShapeTypeEnum.Rect,})fShape.setStrokeLineCapType(univerAPI.Enum.ShapeLineCapEnum.Round)

Package: @univerjs-pro/engine-shape · Type definitions

Enum.ShapeLineDashEnum

Dash patterns accepted by Shape stroke APIs.

Available values

TypeScript
type EnumValues = {  Solid: ShapeLineDashEnum.Solid  RoundDot: ShapeLineDashEnum.RoundDot  SquareDot: ShapeLineDashEnum.SquareDot  Dash: ShapeLineDashEnum.Dash  DashDot: ShapeLineDashEnum.DashDot  LongDash: ShapeLineDashEnum.LongDash  LongDashDot: ShapeLineDashEnum.LongDashDot  LongDashDotDot: ShapeLineDashEnum.LongDashDotDot  SystemDash: ShapeLineDashEnum.SystemDash  SystemDashDot: ShapeLineDashEnum.SystemDashDot  SystemDashDotDot: ShapeLineDashEnum.SystemDashDotDot}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const fShape = fWorksheet.insertShape({  shapeType: univerAPI.Enum.ShapeTypeEnum.Rect,})fShape.setStrokeLineDashType(univerAPI.Enum.ShapeLineDashEnum.DashDot)

Package: @univerjs-pro/engine-shape · Type definitions

Enum.ShapeLineJoinEnum

Line join styles accepted by Shape stroke APIs.

Available values

TypeScript
type EnumValues = {  Miter: ShapeLineJoinEnum.Miter  Round: ShapeLineJoinEnum.Round  Bevel: ShapeLineJoinEnum.Bevel}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const fShape = fWorksheet.insertShape({  shapeType: univerAPI.Enum.ShapeTypeEnum.Rect,})fShape.setStrokeLineJoinType(univerAPI.Enum.ShapeLineJoinEnum.Bevel)

Package: @univerjs-pro/engine-shape · Type definitions

Enum.ShapeLineTypeEnum

Shape stroke fill types such as no line, solid line, and gradient line.

Available values

TypeScript
type EnumValues = {  NoLine: ShapeLineTypeEnum.NoLine  SolidLine: ShapeLineTypeEnum.SolidLine  GradientLine: ShapeLineTypeEnum.GradientLine}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const fShape = fWorksheet.insertShape({  shapeType: univerAPI.Enum.ShapeTypeEnum.Rect,})fShape.setStrokeLineType(univerAPI.Enum.ShapeLineTypeEnum.SolidLine)

Package: @univerjs-pro/engine-shape · Type definitions

Enum.ShapeOperatorEnum

Formula operators used by custom Shape geometry guides.

Available values

TypeScript
type EnumValues = {  Val: ShapeOperatorEnum.Val  Pin: ShapeOperatorEnum.Pin  AddSub: ShapeOperatorEnum.AddSub  MulDiv: ShapeOperatorEnum.MulDiv  AddDiv: ShapeOperatorEnum.AddDiv  Abs: ShapeOperatorEnum.Abs  Max: ShapeOperatorEnum.Max  Min: ShapeOperatorEnum.Min  IfElse: ShapeOperatorEnum.IfElse  Sin: ShapeOperatorEnum.Sin  Cos: ShapeOperatorEnum.Cos  Tan: ShapeOperatorEnum.Tan  Atan2: ShapeOperatorEnum.Atan2  Mod: ShapeOperatorEnum.Mod  Sqrt: ShapeOperatorEnum.Sqrt  Cat2: ShapeOperatorEnum.Cat2  Sat2: ShapeOperatorEnum.Sat2}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const fShape = fWorksheet.insertShape({  shapeType: univerAPI.Enum.ShapeTypeEnum.Rect,})fShape.setCustomGeometry({  adjustValues: {    inset: [univerAPI.Enum.ShapeOperatorEnum.Val, 12000],  },  pathLst: [    {      dataArray: [        { command: 'M', points: ['inset', 'inset'] },        { command: 'L', points: ['r', 'inset'] },        { command: 'L', points: ['r', 'b'] },        { command: 'L', points: ['inset', 'b'] },        { command: 'z', points: [] },      ],    },  ],})

Package: @univerjs-pro/engine-shape · Type definitions

Enum.ShapeTextAutoFitType

Automatic fitting strategies for Shape text.

Available values

TypeScript
type EnumValues = {  /** Do not automatically adjust overflowing text. */  NoAutoFit: ShapeTextAutoFitType.NoAutoFit  /** Shrink text when it overflows the shape. */  NormAutoFit: ShapeTextAutoFitType.NormAutoFit  /** Resize the shape to fit the text. */  SpAutoFit: ShapeTextAutoFitType.SpAutoFit}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const fShape = fWorksheet.insertShape({  shapeType: univerAPI.Enum.ShapeTypeEnum.Rect,})fShape.getText().setText('Quarterly review')fShape.getText().setTextBoxOptions({  autoFitType: univerAPI.Enum.ShapeTextAutoFitType.NormAutoFit,})

Package: @univerjs-pro/engine-shape · Type definitions

Enum.ShapeTextDirection

Writing directions for Shape text.

Available values

TypeScript
type EnumValues = {  /** Horizontal text. */  Horz: ShapeTextDirection.Horz  /** Vertical text. */  Vert: ShapeTextDirection.Vert  /** Vertical text rotated 270 degrees from the horizontal baseline. */  Vert270: ShapeTextDirection.Vert270  /** Vertical WordArt text. */  WordArtVert: ShapeTextDirection.WordArtVert  /** East Asian vertical text. */  EaVert: ShapeTextDirection.EaVert  /** Mongolian vertical text. */  MongolianVert: ShapeTextDirection.MongolianVert  /** Right-to-left vertical WordArt text. */  WordArtVertRtl: ShapeTextDirection.WordArtVertRtl}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const fShape = fWorksheet.insertShape({  shapeType: univerAPI.Enum.ShapeTypeEnum.Rect,})fShape.getText().setText('Vertical text')fShape.getText().setTextBoxOptions({  textDirection: univerAPI.Enum.ShapeTextDirection.Vert,})

Package: @univerjs-pro/engine-shape · Type definitions

Enum.ShapeTextWrapType

Wrapping modes for Shape text.

Available values

TypeScript
type EnumValues = {  /** Do not wrap text inside the shape text box. */  None: ShapeTextWrapType.None  /** Wrap text inside the shape text box. */  Square: ShapeTextWrapType.Square}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const fShape = fWorksheet.insertShape({  shapeType: univerAPI.Enum.ShapeTypeEnum.Rect,})fShape.getText().setText('Wrapped Shape text')fShape.getText().setTextBoxOptions({  textWrap: univerAPI.Enum.ShapeTextWrapType.Square,})

Package: @univerjs-pro/engine-shape · Type definitions

Enum.ShapeTypeEnum

Built-in Shape and Connector preset types.

Available values

TypeScript
type EnumValues = {  /** No rendered geometry; reserve this value for an explicitly empty shape. */  None: ShapeTypeEnum.None  /** SmartArt composite host. Its editable presentation shapes remain nested in `shapeData.smartArt`. */  SmartArt: ShapeTypeEnum.SmartArt  /** Rectangle for generic process steps, cards, and diagram nodes. */  Rect: ShapeTypeEnum.Rect  /** Rounded rectangle for friendly process steps, states, and cards. */  RoundRect: ShapeTypeEnum.RoundRect  /** Ellipse for events, states, and circular diagram nodes. */  Ellipse: ShapeTypeEnum.Ellipse  /** Diamond for decisions, conditions, and branching points. */  Diamond: ShapeTypeEnum.Diamond  /** Upward-pointing triangle. */  Triangle: ShapeTypeEnum.Triangle  /** Right triangle with one vertical and one horizontal edge. */  RightTriangle: ShapeTypeEnum.RightTriangle  /** Parallelogram commonly used for input and output steps. */  Parallelogram: ShapeTypeEnum.Parallelogram  /** Symmetric trapezoid. */  Trapezoid: ShapeTypeEnum.Trapezoid  /** Adjustable hexagon commonly used for preparation steps. */  Hexagon: ShapeTypeEnum.Hexagon  /** Eight-sided polygon commonly used for stop or warning nodes. */  Octagon: ShapeTypeEnum.Octagon  /** Plus-sign shape. */  Plus: ShapeTypeEnum.Plus  /** 5-point star shape. */  Star5: ShapeTypeEnum.Star5  /** 6-point star shape. */  Star6: ShapeTypeEnum.Star6  /** 7-point star shape. */  Star7: ShapeTypeEnum.Star7  /** 8-point star shape. */  Star8: ShapeTypeEnum.Star8  /** 10-point star shape. */  Star10: ShapeTypeEnum.Star10  /** 12-point star shape. */  Star12: ShapeTypeEnum.Star12  /** 16-point star shape. */  Star16: ShapeTypeEnum.Star16  /** 24-point star shape. */  Star24: ShapeTypeEnum.Star24  /** 32-point star shape. */  Star32: ShapeTypeEnum.Star32  /** Round 1 rect shape. */  Round1Rect: ShapeTypeEnum.Round1Rect  /** Round 2 same rect shape. */  Round2SameRect: ShapeTypeEnum.Round2SameRect  /** Round 2 diag rect shape. */  Round2DiagRect: ShapeTypeEnum.Round2DiagRect  /** Snip 1 rect shape. */  Snip1Rect: ShapeTypeEnum.Snip1Rect  /** Snip round rect shape. */  SnipRoundRect: ShapeTypeEnum.SnipRoundRect  /** Snip 2 same rect shape. */  Snip2SameRect: ShapeTypeEnum.Snip2SameRect  /** Snip 2 diag rect shape. */  Snip2DiagRect: ShapeTypeEnum.Snip2DiagRect  /** Plaque shape. */  Plaque: ShapeTypeEnum.Plaque  /** Rectangular frame with an open center. */  Frame: ShapeTypeEnum.Frame  /** Two-sided partial frame. */  HalfFrame: ShapeTypeEnum.HalfFrame  /** Right-angle corner shape. */  Corner: ShapeTypeEnum.Corner  /** Diag stripe shape. */  DiagStripe: ShapeTypeEnum.DiagStripe  /** Circular segment bounded by a chord. */  Chord: ShapeTypeEnum.Chord  /** Open circular arc. */  Arc: ShapeTypeEnum.Arc  /** Left circular arrow shape for directional diagrams. */  LeftCircularArrow: ShapeTypeEnum.LeftCircularArrow  /** Left right circular arrow shape for directional diagrams. */  LeftRightCircularArrow: ShapeTypeEnum.LeftRightCircularArrow  /** Swoosh arrow shape for directional diagrams. */  SwooshArrow: ShapeTypeEnum.SwooshArrow  /** Left right ribbon shape. */  LeftRightRibbon: ShapeTypeEnum.LeftRightRibbon  /** Seven-sided polygon. */  Heptagon: ShapeTypeEnum.Heptagon  /** Home-plate pentagon for directional process nodes. */  HomePlate: ShapeTypeEnum.HomePlate  /** Right arrow shape for directional diagrams. */  RightArrow: ShapeTypeEnum.RightArrow  /** Left arrow shape for directional diagrams. */  LeftArrow: ShapeTypeEnum.LeftArrow  /** Up arrow shape for directional diagrams. */  UpArrow: ShapeTypeEnum.UpArrow  /** Down arrow shape for directional diagrams. */  DownArrow: ShapeTypeEnum.DownArrow  /** Left right arrow shape for directional diagrams. */  LeftRightArrow: ShapeTypeEnum.LeftRightArrow  /** Up down arrow shape for directional diagrams. */  UpDownArrow: ShapeTypeEnum.UpDownArrow  /** Quad arrow shape for directional diagrams. */  QuadArrow: ShapeTypeEnum.QuadArrow  /** Left right up arrow shape for directional diagrams. */  LeftRightUpArrow: ShapeTypeEnum.LeftRightUpArrow  /** Bent arrow shape for directional diagrams. */  BentArrow: ShapeTypeEnum.BentArrow  /** Uturn arrow shape for directional diagrams. */  UturnArrow: ShapeTypeEnum.UturnArrow  /** Left up arrow shape for directional diagrams. */  LeftUpArrow: ShapeTypeEnum.LeftUpArrow  /** Bent up arrow shape for directional diagrams. */  BentUpArrow: ShapeTypeEnum.BentUpArrow  /** Curved right arrow shape for directional diagrams. */  CurvedRightArrow: ShapeTypeEnum.CurvedRightArrow  /** Curved left arrow shape for directional diagrams. */  CurvedLeftArrow: ShapeTypeEnum.CurvedLeftArrow  /** Curved up arrow shape for directional diagrams. */  CurvedUpArrow: ShapeTypeEnum.CurvedUpArrow  /** Curved down arrow shape for directional diagrams. */  CurvedDownArrow: ShapeTypeEnum.CurvedDownArrow  /** Striped right arrow shape for directional diagrams. */  StripedRightArrow: ShapeTypeEnum.StripedRightArrow  /** Notched right arrow shape for directional diagrams. */  NotchedRightArrow: ShapeTypeEnum.NotchedRightArrow  /** Five-sided polygon or home-style process node. */  Pentagon: ShapeTypeEnum.Pentagon  /** Chevron for sequences, progress, and directional stages. */  Chevron: ShapeTypeEnum.Chevron  /** Right arrow callout shape for directional diagrams. */  RightArrowCallout: ShapeTypeEnum.RightArrowCallout  /** Down arrow callout shape for directional diagrams. */  DownArrowCallout: ShapeTypeEnum.DownArrowCallout  /** Left arrow callout shape for directional diagrams. */  LeftArrowCallout: ShapeTypeEnum.LeftArrowCallout  /** Up arrow callout shape for directional diagrams. */  UpArrowCallout: ShapeTypeEnum.UpArrowCallout  /** Left right arrow callout shape for directional diagrams. */  LeftRightArrowCallout: ShapeTypeEnum.LeftRightArrowCallout  /** Quad arrow callout shape for directional diagrams. */  QuadArrowCallout: ShapeTypeEnum.QuadArrowCallout  /** Circular arrow for cycles and repeated processes. */  CircularArrow: ShapeTypeEnum.CircularArrow  /** Equation symbol for plus. */  MathPlus: ShapeTypeEnum.MathPlus  /** Equation symbol for minus. */  MathMinus: ShapeTypeEnum.MathMinus  /** Equation symbol for multiply. */  MathMultiply: ShapeTypeEnum.MathMultiply  /** Equation symbol for divide. */  MathDivide: ShapeTypeEnum.MathDivide  /** Equation symbol for equal. */  MathEqual: ShapeTypeEnum.MathEqual  /** Equation symbol for not equal. */  MathNotEqual: ShapeTypeEnum.MathNotEqual  /** Flowchart process symbol for a standard operation. */  FlowchartProcess: ShapeTypeEnum.FlowchartProcess  /** Flowchart alternate-process symbol. */  FlowchartAlternateProcess: ShapeTypeEnum.FlowchartAlternateProcess  /** Flowchart decision symbol for branching conditions. */  FlowchartDecision: ShapeTypeEnum.FlowchartDecision  /** Flowchart input/output symbol for data entering or leaving a process. */  FlowChartInputOutput: ShapeTypeEnum.FlowChartInputOutput  /** Flowchart predefined-process symbol for a named subprocess. */  FlowchartPredefinedProcess: ShapeTypeEnum.FlowchartPredefinedProcess  /** Flowchart internal-storage symbol. */  FlowchartInternalStorage: ShapeTypeEnum.FlowchartInternalStorage  /** Flowchart document symbol for one document artifact. */  FlowchartDocument: ShapeTypeEnum.FlowchartDocument  /** Flowchart multiple-documents symbol. */  FlowchartMultiDocument: ShapeTypeEnum.FlowchartMultiDocument  /** Flowchart terminator symbol for a start or end state. */  FlowchartTerminator: ShapeTypeEnum.FlowchartTerminator  /** Flowchart preparation symbol for initialization or setup. */  FlowchartPreparation: ShapeTypeEnum.FlowchartPreparation  /** Flowchart manual-input symbol. */  FlowchartManualInput: ShapeTypeEnum.FlowchartManualInput  /** Flowchart manual-operation symbol. */  FlowchartManualOperation: ShapeTypeEnum.FlowchartManualOperation  /** Flowchart on-page connector symbol. */  FlowchartConnector: ShapeTypeEnum.FlowchartConnector  /** Flowchart off-page connector symbol. */  FlowchartOffPageConnector: ShapeTypeEnum.FlowchartOffPageConnector  /** Flowchart punched-card data symbol. */  FlowchartPunchedCard: ShapeTypeEnum.FlowchartPunchedCard  /** Flowchart punched-tape data symbol. */  FlowchartPunchedTape: ShapeTypeEnum.FlowchartPunchedTape  /** Flowchart summing-junction symbol. */  FlowchartSummingJunction: ShapeTypeEnum.FlowchartSummingJunction  /** Flowchart logical OR junction symbol. */  FlowchartOr: ShapeTypeEnum.FlowchartOr  /** Flowchart collate symbol. */  FlowchartCollate: ShapeTypeEnum.FlowchartCollate  /** Flowchart sort symbol. */  FlowchartSort: ShapeTypeEnum.FlowchartSort  /** Flowchart extract symbol. */  FlowchartExtract: ShapeTypeEnum.FlowchartExtract  /** Flowchart merge symbol. */  FlowchartMerge: ShapeTypeEnum.FlowchartMerge  /** Flowchart online-storage symbol. */  FlowchartOnlineStorage: ShapeTypeEnum.FlowchartOnlineStorage  /** Flowchart delay or wait symbol. */  FlowchartDelay: ShapeTypeEnum.FlowchartDelay  /** Flowchart sequential-access magnetic-tape storage symbol. */  FlowchartMagneticTape: ShapeTypeEnum.FlowchartMagneticTape  /** Flowchart magnetic-disk storage symbol. */  FlowchartMagneticDisk: ShapeTypeEnum.FlowchartMagneticDisk  /** Flowchart direct-access magnetic-drum storage symbol. */  FlowchartMagneticDrum: ShapeTypeEnum.FlowchartMagneticDrum  /** Flowchart display or screen output symbol. */  FlowchartDisplay: ShapeTypeEnum.FlowchartDisplay  /** Wedge rect callout shape for annotated content. */  WedgeRectCallout: ShapeTypeEnum.WedgeRectCallout  /** Wedge round rect callout shape for annotated content. */  WedgeRoundRectCallout: ShapeTypeEnum.WedgeRoundRectCallout  /** Wedge ellipse callout shape for annotated content. */  WedgeEllipseCallout: ShapeTypeEnum.WedgeEllipseCallout  /** Cloud callout shape for annotated content. */  CloudCallout: ShapeTypeEnum.CloudCallout  /** Border callout 1 shape for annotated content. */  BorderCallout1: ShapeTypeEnum.BorderCallout1  /** Border callout 2 shape for annotated content. */  BorderCallout2: ShapeTypeEnum.BorderCallout2  /** Border callout 3 shape for annotated content. */  BorderCallout3: ShapeTypeEnum.BorderCallout3  /** Accent callout 1 shape for annotated content. */  AccentCallout1: ShapeTypeEnum.AccentCallout1  /** Accent callout 2 shape for annotated content. */  AccentCallout2: ShapeTypeEnum.AccentCallout2  /** Accent callout 3 shape for annotated content. */  AccentCallout3: ShapeTypeEnum.AccentCallout3  /** Callout 1 shape for annotated content. */  Callout1: ShapeTypeEnum.Callout1  /** Callout 2 shape for annotated content. */  Callout2: ShapeTypeEnum.Callout2  /** Callout 3 shape for annotated content. */  Callout3: ShapeTypeEnum.Callout3  /** Accent border callout 1 shape for annotated content. */  AccentBorderCallout1: ShapeTypeEnum.AccentBorderCallout1  /** Accent border callout 2 shape for annotated content. */  AccentBorderCallout2: ShapeTypeEnum.AccentBorderCallout2  /** Accent border callout 3 shape for annotated content. */  AccentBorderCallout3: ShapeTypeEnum.AccentBorderCallout3  /** Ribbon shape. */  Ribbon: ShapeTypeEnum.Ribbon  /** Ribbon 2 shape. */  Ribbon2: ShapeTypeEnum.Ribbon2  /** Ellipse ribbon shape. */  EllipseRibbon: ShapeTypeEnum.EllipseRibbon  /** Ellipse ribbon 2 shape. */  EllipseRibbon2: ShapeTypeEnum.EllipseRibbon2  /** Vertical scroll shape. */  VerticalScroll: ShapeTypeEnum.VerticalScroll  /** Horizontal scroll shape. */  HorizontalScroll: ShapeTypeEnum.HorizontalScroll  /** Wave shape. */  Wave: ShapeTypeEnum.Wave  /** Double wave shape. */  DoubleWave: ShapeTypeEnum.DoubleWave  /** Cube shape. */  Cube: ShapeTypeEnum.Cube  /** Can shape. */  Can: ShapeTypeEnum.Can  /** Lightning bolt shape. */  LightningBolt: ShapeTypeEnum.LightningBolt  /** Heart shape. */  Heart: ShapeTypeEnum.Heart  /** Sun shape. */  Sun: ShapeTypeEnum.Sun  /** Moon shape. */  Moon: ShapeTypeEnum.Moon  /** Smiley face shape. */  SmileyFace: ShapeTypeEnum.SmileyFace  /** Irregular seal 1 shape. */  IrregularSeal1: ShapeTypeEnum.IrregularSeal1  /** Irregular seal 2 shape. */  IrregularSeal2: ShapeTypeEnum.IrregularSeal2  /** Folded corner shape. */  FoldedCorner: ShapeTypeEnum.FoldedCorner  /** Bevel shape. */  Bevel: ShapeTypeEnum.Bevel  /** Donut shape. */  Donut: ShapeTypeEnum.Donut  /** No smoking shape. */  NoSmoking: ShapeTypeEnum.NoSmoking  /** Block arc shape. */  BlockArc: ShapeTypeEnum.BlockArc  /** Teardrop shape. */  Teardrop: ShapeTypeEnum.Teardrop  /** Pie wedge shape. */  PieWedge: ShapeTypeEnum.PieWedge  /** Pie shape. */  Pie: ShapeTypeEnum.Pie  /** Funnel shape. */  Funnel: ShapeTypeEnum.Funnel  /** Gear 6 shape. */  Gear6: ShapeTypeEnum.Gear6  /** Gear 9 shape. */  Gear9: ShapeTypeEnum.Gear9  /** Decagon shape. */  Decagon: ShapeTypeEnum.Decagon  /** Dodecagon shape. */  Dodecagon: ShapeTypeEnum.Dodecagon  /** Corner tabs shape. */  CornerTabs: ShapeTypeEnum.CornerTabs  /** Left brace shape. */  LeftBrace: ShapeTypeEnum.LeftBrace  /** Right brace shape. */  RightBrace: ShapeTypeEnum.RightBrace  /** Left bracket shape. */  LeftBracket: ShapeTypeEnum.LeftBracket  /** Right bracket shape. */  RightBracket: ShapeTypeEnum.RightBracket  /** Action button for back previous. */  ActionButtonBackPrevious: ShapeTypeEnum.ActionButtonBackPrevious  /** Action button for forward next. */  ActionButtonForwardNext: ShapeTypeEnum.ActionButtonForwardNext  /** Action button for beginning. */  ActionButtonBeginning: ShapeTypeEnum.ActionButtonBeginning  /** Action button for end. */  ActionButtonEnd: ShapeTypeEnum.ActionButtonEnd  /** Action button for home. */  ActionButtonHome: ShapeTypeEnum.ActionButtonHome  /** Action button for information. */  ActionButtonInformation: ShapeTypeEnum.ActionButtonInformation  /** Action button for return. */  ActionButtonReturn: ShapeTypeEnum.ActionButtonReturn  /** Action button for movie. */  ActionButtonMovie: ShapeTypeEnum.ActionButtonMovie  /** Action button for document. */  ActionButtonDocument: ShapeTypeEnum.ActionButtonDocument  /** Action button for sound. */  ActionButtonSound: ShapeTypeEnum.ActionButtonSound  /** Action button for help. */  ActionButtonHelp: ShapeTypeEnum.ActionButtonHelp  /** Action button for blank. */  ActionButtonBlank: ShapeTypeEnum.ActionButtonBlank  /** Brace pair shape. */  BracePair: ShapeTypeEnum.BracePair  /** Bracket pair shape. */  BracketPair: ShapeTypeEnum.BracketPair  /** Chart plus shape. */  ChartPlus: ShapeTypeEnum.ChartPlus  /** Chart star shape. */  ChartStar: ShapeTypeEnum.ChartStar  /** Chart x shape. */  ChartX: ShapeTypeEnum.ChartX  /** Cloud shape. */  Cloud: ShapeTypeEnum.Cloud  /** Flowchart offline-storage symbol. */  FlowChartOfflineStorage: ShapeTypeEnum.FlowChartOfflineStorage  /** Line inv shape. */  LineInv: ShapeTypeEnum.LineInv  /** Non isosceles trapezoid shape. */  NonIsoscelesTrapezoid: ShapeTypeEnum.NonIsoscelesTrapezoid  /** Plaque tabs shape. */  PlaqueTabs: ShapeTypeEnum.PlaqueTabs  /** Square tabs shape. */  SquareTabs: ShapeTypeEnum.SquareTabs  /** 4-point star shape. */  Star4: ShapeTypeEnum.Star4  /** Up down arrow callout shape for directional diagrams. */  UpDownArrowCallout: ShapeTypeEnum.UpDownArrowCallout  /** Simple line shape. */  Line: ShapeTypeEnum.Line  /** Straight connector shape with one segment. */  StraightConnector1: ShapeTypeEnum.StraightConnector1  /** Orthogonal connector shape with two segments. */  BentConnector2: ShapeTypeEnum.BentConnector2  /** Orthogonal connector shape with three segments. */  BentConnector3: ShapeTypeEnum.BentConnector3  /** Orthogonal connector shape with four segments. */  BentConnector4: ShapeTypeEnum.BentConnector4  /** Orthogonal connector shape with five segments. */  BentConnector5: ShapeTypeEnum.BentConnector5  /** Curved connector shape with two control sections. */  CurvedConnector2: ShapeTypeEnum.CurvedConnector2  /** Curved connector shape with three control sections. */  CurvedConnector3: ShapeTypeEnum.CurvedConnector3  /** Curved connector shape with four control sections. */  CurvedConnector4: ShapeTypeEnum.CurvedConnector4  /** Curved connector shape with five control sections. */  CurvedConnector5: ShapeTypeEnum.CurvedConnector5}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const fShape = fWorksheet.insertShape({  shapeType: univerAPI.Enum.ShapeTypeEnum.RoundRect,  transform: { left: 80, top: 80, width: 200, height: 120 },})

Package: @univerjs-pro/engine-shape · Type definitions

@univerjs-pro/ink

Enum.BoardInkHandleKind

Pen anchor and handle targets accepted by moveInkAnchorPoint().

Available values

TypeScript
type EnumValues = {  /** Move the anchor itself and translate both handles with it. */  Anchor: 'anchor'  /** Move the incoming Bezier handle. */  In: 'in'  /** Move the outgoing Bezier handle. */  Out: 'out'}

Example

TypeScript
console.log(univerAPI.Enum.BoardInkHandleKind.Anchor)

Package: @univerjs-pro/ink · Type definitions

Enum.BoardInkPointType

Pen anchor behaviors accepted by setInkAnchorPointType() and pen source models.

Available values

TypeScript
type EnumValues = {  /** Corner anchor with independently controlled incoming and outgoing segments. */  Corner: 'corner'  /** Smooth anchor that keeps both handles collinear while preserving their lengths. */  Smooth: 'smooth'  /** Symmetric anchor that keeps both handles collinear and equally long. */  Symmetric: 'symmetric'  /** Free anchor whose handles can be moved independently. */  Free: 'free'}

Example

TypeScript
console.log(univerAPI.Enum.BoardInkPointType.Corner)

Package: @univerjs-pro/ink · Type definitions

Enum.BoardInkTool

Persistent ink tools accepted by insertInk().

Eraser is intentionally absent because it is an interaction mode rather than a stored ink element.

Available values

TypeScript
type EnumValues = {  /** Editable Bezier pen path. */  Pen: 'pen'  /** Freehand brush stroke. */  Brush: 'brush'  /** Translucent highlighter stroke. */  Highlighter: 'highlighter'}

Example

TypeScript
console.log(univerAPI.Enum.BoardInkTool.Brush)

Package: @univerjs-pro/ink · Type definitions

@univerjs-pro/pdfs

Enum.PdfAnnotationType

Supported PDF annotation subtypes.

Available values

TypeScript
type EnumValues = {  TEXT: PdfAnnotationType.TEXT  POPUP: PdfAnnotationType.POPUP  LINK: PdfAnnotationType.LINK  FREE_TEXT: PdfAnnotationType.FREE_TEXT  LINE: PdfAnnotationType.LINE  SQUARE: PdfAnnotationType.SQUARE  CIRCLE: PdfAnnotationType.CIRCLE  POLYGON: PdfAnnotationType.POLYGON  POLYLINE: PdfAnnotationType.POLYLINE  HIGHLIGHT: PdfAnnotationType.HIGHLIGHT  UNDERLINE: PdfAnnotationType.UNDERLINE  STRIKEOUT: PdfAnnotationType.STRIKEOUT  SQUIGGLY: PdfAnnotationType.SQUIGGLY  STAMP: PdfAnnotationType.STAMP  INK: PdfAnnotationType.INK  FILE_ATTACHMENT: PdfAnnotationType.FILE_ATTACHMENT  WIDGET: PdfAnnotationType.WIDGET}

Example

TypeScript
const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const annotation = page.insertAnnotation({  annotationType: univerAPI.Enum.PdfAnnotationType.HIGHLIGHT,  left: 36,  top: 72,  width: 180,  height: 18,})

Package: @univerjs-pro/pdfs · Type definitions

Enum.PdfListKind

Semantic ordered and unordered PDF list kinds.

Available values

TypeScript
type EnumValues = {  /** A list whose label is a glyph such as a disc, circle, or square. */  UNORDERED: PdfListKind.UNORDERED  /** A list whose label is derived from a deterministic ordinal. */  ORDERED: PdfListKind.ORDERED}

Example

TypeScript
const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const list = page.insertList({  text: 'First item',  kind: univerAPI.Enum.PdfListKind.UNORDERED,  preset: univerAPI.Enum.PdfListPresetId.UNORDERED_DISC,})list  .insertItem(1, { text: '第二项' })  .insertItem(2, { text: '子项', level: 1 })  .insertItem(3, { text: '第四项' })

Package: @univerjs-pro/pdfs · Type definitions

Enum.PdfListPresetId

Built-in PDF list marker presets.

Available values

TypeScript
type EnumValues = {  UNORDERED_DISC: PdfListPresetId.UNORDERED_DISC  UNORDERED_CIRCLE: PdfListPresetId.UNORDERED_CIRCLE  UNORDERED_SQUARE: PdfListPresetId.UNORDERED_SQUARE  UNORDERED_DIAMOND: PdfListPresetId.UNORDERED_DIAMOND  UNORDERED_CHECK: PdfListPresetId.UNORDERED_CHECK  UNORDERED_ARROW: PdfListPresetId.UNORDERED_ARROW  ORDERED_DECIMAL_DOT: PdfListPresetId.ORDERED_DECIMAL_DOT  ORDERED_DECIMAL_PAREN: PdfListPresetId.ORDERED_DECIMAL_PAREN  ORDERED_MULTILEVEL: PdfListPresetId.ORDERED_MULTILEVEL  ORDERED_ALPHA: PdfListPresetId.ORDERED_ALPHA  ORDERED_NUMBER_ALPHA: PdfListPresetId.ORDERED_NUMBER_ALPHA  ORDERED_DECIMAL_ZERO: PdfListPresetId.ORDERED_DECIMAL_ZERO}

Example

TypeScript
const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const list = page.insertList({  text: 'First item',  kind: univerAPI.Enum.PdfListKind.UNORDERED,  preset: univerAPI.Enum.PdfListPresetId.UNORDERED_DISC,})list  .insertItem(1, { text: '第二项' })  .insertItem(2, { text: '子项', level: 1 })  .insertItem(3, { text: '第四项' })

Package: @univerjs-pro/pdfs · Type definitions

Enum.PdfTableCellVerticalAlign

Vertical alignment values for PDF table cells.

Available values

TypeScript
type EnumValues = {  TOP: PdfTableCellVerticalAlign.TOP  MIDDLE: PdfTableCellVerticalAlign.MIDDLE  BOTTOM: PdfTableCellVerticalAlign.BOTTOM}

Example

TypeScript
const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const table = page.getTables()[0]const cell = table?.getCell(0, 0)if (cell) {  cell.setStyle({    fill: { color: '#eef3ff' },    fontColor: '#dc2626',    horizontalAlignment: univerAPI.Enum.HorizontalAlign.CENTER,    verticalAlign: univerAPI.Enum.PdfTableCellVerticalAlign.MIDDLE,  })}

Package: @univerjs-pro/pdfs · Type definitions

Enum.PdfTextAnchor

Vertical anchors for editable PDF text boxes.

Available values

TypeScript
type EnumValues = {  START: PdfTextAnchor.START  MIDDLE: PdfTextAnchor.MIDDLE  END: PdfTextAnchor.END}

Example

TypeScript
const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const textBox = page.getTextBoxes()[0]if (textBox) {  textBox.setTextAnchor(univerAPI.Enum.PdfTextAnchor.MIDDLE)}

Package: @univerjs-pro/pdfs · Type definitions

@univerjs-pro/shape-editor

Enum.FormulaShapeResultStatus

Calculation states returned by shape.getFormulaResult().

Available values

TypeScript
type EnumValues = {  EMPTY: FormulaShapeResultStatus.EMPTY  PENDING: FormulaShapeResultStatus.PENDING  SUCCESS: FormulaShapeResultStatus.SUCCESS  ERROR: FormulaShapeResultStatus.ERROR}

Example

Check for a successful result in the active worksheet

TypeScript
const workbook = univerAPI.getActiveWorkbook()if (!workbook) throw new Error('No active workbook.')const shape = workbook.getActiveSheet().getShape('formula-shape-1')const result = shape?.getFormulaResult()if (result?.status === univerAPI.Enum.FormulaShapeResultStatus.SUCCESS) {  console.log(result.displayText)}

Check for a formula error in the active Board

TypeScript
const board = univerAPI.getActiveBoard()if (!board) throw new Error('No active board.')const result = board.getShape('formula-shape-1')?.getFormulaResult()if (result?.status === univerAPI.Enum.FormulaShapeResultStatus.ERROR) {  console.error(result.value)}

Package: @univerjs-pro/shape-editor · Type definitions

@univerjs-pro/sheets-chart

Enum.ChartSourceOrientation

Controls how a Sheet range is interpreted as Chart series.

  • Auto lets Sheet Chart infer the orientation from the selected range.
  • Row, Rows, and RowsAsSeries are equivalent: each row is treated as a series.
  • Column, Columns, and ColumnsAsSeries are equivalent: each column is treated as a series.

Pass a value through orientation when calling a Sheet Chart builder's setSource() method or a live Sheet Chart's setDataSource() method.

Available values

TypeScript
type EnumValues = {  Auto: ChartSourceOrientation.Auto  Row: ChartSourceOrientation.Row  Column: ChartSourceOrientation.Column  Rows: ChartSourceOrientation.Rows  Columns: ChartSourceOrientation.Columns  RowsAsSeries: ChartSourceOrientation.RowsAsSeries  ColumnsAsSeries: ChartSourceOrientation.ColumnsAsSeries}

Example

TypeScript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const chartInfo = fWorksheet  .newChart(univerAPI.Enum.ChartTypeString.Column)  .setSource({    range: 'A1:D8',    orientation: univerAPI.Enum.ChartSourceOrientation.Columns,  })  .build()await fWorksheet.insertChart(chartInfo)

Package: @univerjs-pro/sheets-chart · Type definitions

@univerjs-pro/sheets-outline

Enum.DimensionOutlineAxis

Row or column axis for dimension outline facade APIs.

Available values

TypeScript
type EnumValues = {  ROW: DimensionOutlineAxis.ROW  COLUMN: DimensionOutlineAxis.COLUMN}

Package: @univerjs-pro/sheets-outline · Type definitions

Enum.DimensionOutlineErrorReason

Error reason values emitted by dimension outline commands.

Available values

TypeScript
type EnumValues = {  INVALID_RANGE: DimensionOutlineErrorReason.INVALID_RANGE  OUT_OF_BOUNDS: DimensionOutlineErrorReason.OUT_OF_BOUNDS  CROSSING: DimensionOutlineErrorReason.CROSSING  MAX_DEPTH: DimensionOutlineErrorReason.MAX_DEPTH  MOVE_SPLITS_OUTLINE: DimensionOutlineErrorReason.MOVE_SPLITS_OUTLINE  CLEAR_RANGE_NOT_CONTAIN_OUTLINE: DimensionOutlineErrorReason.CLEAR_RANGE_NOT_CONTAIN_OUTLINE  UNKNOWN: DimensionOutlineErrorReason.UNKNOWN}

Package: @univerjs-pro/sheets-outline · Type definitions

@univerjs-pro/sheets-pivot

Enum.PivotCallbackEnum

Represents the callback execution timing of the pivot engine. PivotCallbackEnum

Available values

TypeScript
type EnumValues = {  /** The pivot engine starts calculating */  onQueryStart: PivotCallbackEnum.onQueryStart  /** The pivot engine completes the calculation */  onQueryEnd: PivotCallbackEnum.onQueryEnd}

Package: @univerjs-pro/sheets-pivot · Type definitions

Enum.PivotCellStyleTypeEnum

Represents the pivot cell style type generated by the pivot view. PivotCellStyleTypeEnum

Available values

TypeScript
type EnumValues = {  /** the pivot table page filter selected all */  FilterAll: PivotCellStyleTypeEnum.FilterAll  /** the pivot table page filter selected partial */  FilterPartial: PivotCellStyleTypeEnum.FilterPartial  /** the pivot table page filter selected one */  FilterSingle: PivotCellStyleTypeEnum.FilterSingle  /** the pivot table area cell is blank */  BlankValue: PivotCellStyleTypeEnum.BlankValue  /** the pivot table dimension cell has filter but not sort */  FilteredSortNone: PivotCellStyleTypeEnum.FilteredSortNone  /** the pivot table dimension cell has filter and sort asc */  FilteredSortAsc: PivotCellStyleTypeEnum.FilteredSortAsc  /** the pivot table dimension cell has filter and sort desc */  FilteredSortDesc: PivotCellStyleTypeEnum.FilteredSortDesc  /** the pivot table dimension cell has no filter and sort */  FilterNoneSortNone: PivotCellStyleTypeEnum.FilterNoneSortNone  /** the pivot table dimension cell has no filter and sort asc */  FilterNoneSortAsc: PivotCellStyleTypeEnum.FilterNoneSortAsc  /** the pivot table dimension cell has no filter and sort desc */  FilterNoneSortDesc: PivotCellStyleTypeEnum.FilterNoneSortDesc  /** the branch node of tree can be collapse */  Collapse: PivotCellStyleTypeEnum.Collapse  /** the branch node of tree can be expand */  Expand: PivotCellStyleTypeEnum.Expand  /** the subtotal cell, the real value should be `${value} Total` or `${value} 汇总` */  Subtotal: PivotCellStyleTypeEnum.Subtotal  /** the grand total cell, the value template should be `GrandTotal` or `总计` */  GrandTotal: PivotCellStyleTypeEnum.GrandTotal  /** the grandtotal has more than oen value, the real value should be `Total ${value}` or `总计 ${value}` */  MultipleGrandTotal: PivotCellStyleTypeEnum.MultipleGrandTotal}

Package: @univerjs-pro/sheets-pivot · Type definitions

Enum.PivotDataFieldDataTypeEnum

Represents the data type of the pivot data field. PivotDataFieldDataTypeEnum

Available values

TypeScript
type EnumValues = {  /** the string data type */  text: PivotDataFieldDataTypeEnum.text  /** the number data type */  number: PivotDataFieldDataTypeEnum.number  /** the boolean data type */  boolean: PivotDataFieldDataTypeEnum.boolean  /** the date data type */  date: PivotDataFieldDataTypeEnum.date  /** the blank data type */  blank: PivotDataFieldDataTypeEnum.blank  /** the other data type */  other: PivotDataFieldDataTypeEnum.other}

Package: @univerjs-pro/sheets-pivot · Type definitions

Enum.PivotDataFieldSortOperatorEnum

Represents the sort operator of the pivot data field. PivotDataFieldSortOperatorEnum

Available values

TypeScript
type EnumValues = {  /** - the ascending sort */  ascending: PivotDataFieldSortOperatorEnum.ascending  /** - the descending sort */  descending: PivotDataFieldSortOperatorEnum.descending  /** - the custom sort */  custom: PivotDataFieldSortOperatorEnum.custom}

Package: @univerjs-pro/sheets-pivot · Type definitions

Enum.PivotDataFieldSortTypeEnum

Represents the sort type of the pivot data field. PivotDataFieldSortTypeEnum

Available values

TypeScript
type EnumValues = {  /** Sorts by the value of the data field. */  value: PivotDataFieldSortTypeEnum.value  /** Sorts by the field name of the data field. */  field: PivotDataFieldSortTypeEnum.field}

Package: @univerjs-pro/sheets-pivot · Type definitions

Enum.PivotDataFieldTypeEnum

Represents the source field type, including normal and group fields. PivotDataFieldTypeEnum

Available values

TypeScript
type EnumValues = {  /** - the default data field */  defaultNormalField: PivotDataFieldTypeEnum.defaultNormalField  /** - the number group type */  numberGroupField: PivotDataFieldTypeEnum.numberGroupField  /** - the date group type */  dateGroupField: PivotDataFieldTypeEnum.dateGroupField  /** - the text group type */  textGroupField: PivotDataFieldTypeEnum.textGroupField  /** - the custom group type, if this grouping is used, the user needs to register the relevant records generation function */  customGroupField: PivotDataFieldTypeEnum.customGroupField}

Package: @univerjs-pro/sheets-pivot · Type definitions

Enum.PivotDateGroupFieldDateSystemEnum

Represents the date system used by pivot date group fields. PivotDateGroupFieldDateSystemEnum

Available values

TypeScript
type EnumValues = {  Date1900: PivotDateGroupFieldDateSystemEnum.Date1900  Date1904: PivotDateGroupFieldDateSystemEnum.Date1904}

Package: @univerjs-pro/sheets-pivot · Type definitions

Enum.PivotDateGroupFieldDateTypeEnum

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

Available values

TypeScript
type EnumValues = {  /** The minute date type. Represents data grouped by minute. */  Minute: PivotDateGroupFieldDateTypeEnum.Minute  /** The hour date type. Represents data grouped by hour. */  Hour: PivotDateGroupFieldDateTypeEnum.Hour  /** The hour-minute date type. Represents data grouped by both hour and minute. */  HourMinute: PivotDateGroupFieldDateTypeEnum.HourMinute  /** The date type. Represents data grouped by specific dates. */  Date: PivotDateGroupFieldDateTypeEnum.Date  /** The month date type. Represents data grouped by month. */  Month: PivotDateGroupFieldDateTypeEnum.Month  /** The month-date type. Represents data grouped by both month and specific dates. */  MonthDate: PivotDateGroupFieldDateTypeEnum.MonthDate  /** The quarter date type. Represents data grouped by quarters (e.g., Q1, Q2). */  Quarter: PivotDateGroupFieldDateTypeEnum.Quarter  /** The year date type. Represents data grouped by year. */  Year: PivotDateGroupFieldDateTypeEnum.Year  /** The year-month date type. Represents data grouped by both year and month. */  YearMonth: PivotDateGroupFieldDateTypeEnum.YearMonth  /** The year-quarter date type. Represents data grouped by both year and quarter. */  YearQuarter: PivotDateGroupFieldDateTypeEnum.YearQuarter  /** The year-month-date type. Represents data grouped by year, month, and specific dates. */  YearMonthDate: PivotDateGroupFieldDateTypeEnum.YearMonthDate}

Package: @univerjs-pro/sheets-pivot · Type definitions

Enum.PivotFilterOperatorEnum

Represents the filter operator of the pivot filter. ST_PivotFilterOperatorEnum

Available values

TypeScript
type EnumValues = {  /** Filter by caption that begins with a specific value */  captionBeginsWith: ST_PivotFilterOperatorEnum.captionBeginsWith  /** Filter by caption that is between two values */  captionBetween: ST_PivotFilterOperatorEnum.captionBetween  /** Filter by caption that contains a specific value */  captionContains: ST_PivotFilterOperatorEnum.captionContains  /** Filter by caption that ends with a specific value */  captionEndsWith: ST_PivotFilterOperatorEnum.captionEndsWith  /** Filter by caption that is equal to a specific value */  captionEqual: ST_PivotFilterOperatorEnum.captionEqual  /** Filter by caption that is greater than a specific value */  captionGreaterThan: ST_PivotFilterOperatorEnum.captionGreaterThan  /** Filter by caption that is greater than or equal to a specific value */  captionGreaterThanOrEqual: ST_PivotFilterOperatorEnum.captionGreaterThanOrEqual  /** Filter by caption that is less than a specific value */  captionLessThan: ST_PivotFilterOperatorEnum.captionLessThan  /** Filter by caption that is less than or equal to a specific value */  captionLessThanOrEqual: ST_PivotFilterOperatorEnum.captionLessThanOrEqual  /** Filter by caption that does not begin with a specific value */  captionNotBeginsWith: ST_PivotFilterOperatorEnum.captionNotBeginsWith  /** Filter by caption that is not between two values */  captionNotBetween: ST_PivotFilterOperatorEnum.captionNotBetween  /** Filter by caption that does not contain a specific value */  captionNotContains: ST_PivotFilterOperatorEnum.captionNotContains  /** Filter by caption that does not end with a specific value */  captionNotEndsWith: ST_PivotFilterOperatorEnum.captionNotEndsWith  /** Filter by caption that is not equal to a specific value */  captionNotEqual: ST_PivotFilterOperatorEnum.captionNotEqual  /** Filter by count */  count: ST_PivotFilterOperatorEnum.count  /** Filter by date that is between two values */  dateBetween: ST_PivotFilterOperatorEnum.dateBetween  /** Filter by date that is equal to a specific value */  dateEqual: ST_PivotFilterOperatorEnum.dateEqual  /** Filter by date that is newer than a specific value */  dateNewerThan: ST_PivotFilterOperatorEnum.dateNewerThan  /** Filter by date that is newer than or equal to a specific value */  dateNewerThanOrEqual: ST_PivotFilterOperatorEnum.dateNewerThanOrEqual  /** Filter by date that is not between two values */  dateNotBetween: ST_PivotFilterOperatorEnum.dateNotBetween  /** Filter by date that is not equal to a specific value */  dateNotEqual: ST_PivotFilterOperatorEnum.dateNotEqual  /** Filter by date that is older than a specific value */  dateOlderThan: ST_PivotFilterOperatorEnum.dateOlderThan  /** Filter by date that is older than or equal to a specific value */  dateOlderThanOrEqual: ST_PivotFilterOperatorEnum.dateOlderThanOrEqual  /** Filter by last month */  lastMonth: ST_PivotFilterOperatorEnum.lastMonth  /** Filter by last quarter */  lastQuarter: ST_PivotFilterOperatorEnum.lastQuarter  /** Filter by last week */  lastWeek: ST_PivotFilterOperatorEnum.lastWeek  /** Filter by last year */  lastYear: ST_PivotFilterOperatorEnum.lastYear  /** Filter by dates in January */  M1: ST_PivotFilterOperatorEnum.M1  /** Filter by dates in October */  M10: ST_PivotFilterOperatorEnum.M10  /** Filter by dates in November */  M11: ST_PivotFilterOperatorEnum.M11  /** Filter by dates in December */  M12: ST_PivotFilterOperatorEnum.M12  /** Filter by dates in February */  M2: ST_PivotFilterOperatorEnum.M2  /** Filter by dates in March */  M3: ST_PivotFilterOperatorEnum.M3  /** Filter by dates in April */  M4: ST_PivotFilterOperatorEnum.M4  /** Filter by dates in May */  M5: ST_PivotFilterOperatorEnum.M5  /** Filter by dates in June */  M6: ST_PivotFilterOperatorEnum.M6  /** Filter by dates in July */  M7: ST_PivotFilterOperatorEnum.M7  /** Filter by dates in August */  M8: ST_PivotFilterOperatorEnum.M8  /** Filter by dates in September */  M9: ST_PivotFilterOperatorEnum.M9  /** Filter by next month */  nextMonth: ST_PivotFilterOperatorEnum.nextMonth  /** Filter by next quarter */  nextQuarter: ST_PivotFilterOperatorEnum.nextQuarter  /** Filter by next week */  nextWeek: ST_PivotFilterOperatorEnum.nextWeek  /** Filter by next year */  nextYear: ST_PivotFilterOperatorEnum.nextYear  /** Filter by percent */  percent: ST_PivotFilterOperatorEnum.percent  /** Filter by first quarter */  Q1: ST_PivotFilterOperatorEnum.Q1  /** Filter by second quarter */  Q2: ST_PivotFilterOperatorEnum.Q2  /** Filter by third quarter */  Q3: ST_PivotFilterOperatorEnum.Q3  /** Filter by fourth quarter */  Q4: ST_PivotFilterOperatorEnum.Q4  /** Filter by sum */  sum: ST_PivotFilterOperatorEnum.sum  /** Filter by this month */  thisMonth: ST_PivotFilterOperatorEnum.thisMonth  /** Filter by this quarter */  thisQuarter: ST_PivotFilterOperatorEnum.thisQuarter  /** Filter by this week */  thisWeek: ST_PivotFilterOperatorEnum.thisWeek  /** Filter by this year */  thisYear: ST_PivotFilterOperatorEnum.thisYear  /** Filter by today */  today: ST_PivotFilterOperatorEnum.today  /** Filter by tomorrow */  tomorrow: ST_PivotFilterOperatorEnum.tomorrow  /** Filter by unknown */  unknown: ST_PivotFilterOperatorEnum.unknown  /** Filter by value that is between two values */  valueBetween: ST_PivotFilterOperatorEnum.valueBetween  /** Filter by value that is equal to a specific value */  valueEqual: ST_PivotFilterOperatorEnum.valueEqual  /** Filter by value that is greater than a specific value */  valueGreaterThan: ST_PivotFilterOperatorEnum.valueGreaterThan  /** Filter by value that is greater than or equal to a specific value */  valueGreaterThanOrEqual: ST_PivotFilterOperatorEnum.valueGreaterThanOrEqual  /** Filter by value that is less than a specific value */  valueLessThan: ST_PivotFilterOperatorEnum.valueLessThan  /** Filter by value that is less than or equal to a specific value */  valueLessThanOrEqual: ST_PivotFilterOperatorEnum.valueLessThanOrEqual  /** Filter by value that is not between two values */  valueNotBetween: ST_PivotFilterOperatorEnum.valueNotBetween  /** Filter by value that is not equal to a specific value */  valueNotEqual: ST_PivotFilterOperatorEnum.valueNotEqual  /** Filter by year-to-date */  yearToDate: ST_PivotFilterOperatorEnum.yearToDate  /** Filter by yesterday */  yesterday: ST_PivotFilterOperatorEnum.yesterday}

Package: @univerjs-pro/sheets-pivot · Type definitions

Enum.PivotFilterTypeEnum

Represents the filter type of the pivot table. PivotFilterTypeEnum

Available values

TypeScript
type EnumValues = {  /** the label filter */  CustomFilter: PivotFilterTypeEnum.CustomFilter  /** - the value filter */  ValueFilter: PivotFilterTypeEnum.ValueFilter  /** - the manual filter */  ManualFilter: PivotFilterTypeEnum.ManualFilter}

Package: @univerjs-pro/sheets-pivot · Type definitions

Enum.PivotLayoutTypeEnum

Represents the layout type of a pivot table. PivotLayoutTypeEnum

Available values

TypeScript
type EnumValues = {  compact: PivotLayoutTypeEnum.compact  outline: PivotLayoutTypeEnum.outline  tabular: PivotLayoutTypeEnum.tabular}

Package: @univerjs-pro/sheets-pivot · Type definitions

Enum.PivotShowAsBaseItemTypeEnum

Represents how the base item is selected for a Show Values As calculation. PivotShowAsBaseItemTypeEnum

Available values

TypeScript
type EnumValues = {  item: PivotShowAsBaseItemTypeEnum.item  previous: PivotShowAsBaseItemTypeEnum.previous  next: PivotShowAsBaseItemTypeEnum.next}

Package: @univerjs-pro/sheets-pivot · Type definitions

Enum.PivotShowAsTypeEnum

Represents the show-as calculation type of a pivot value field. PivotShowAsTypeEnum

Available values

TypeScript
type EnumValues = {  /** - the normal value */  normal: PivotShowAsTypeEnum.normal  /** - the value as a percentage of the column total */  percentOfColumnTotal: PivotShowAsTypeEnum.percentOfColumnTotal  /** - the value as a percentage of the row total */  percentOfRowTotal: PivotShowAsTypeEnum.percentOfRowTotal  /** - the value as a percentage of the grand total */  percentOfGrandTotal: PivotShowAsTypeEnum.percentOfGrandTotal  /** - the value as a percentage of the parent column total */  percentOfParentColumnTotal: PivotShowAsTypeEnum.percentOfParentColumnTotal  /** - the value as a percentage of the parent row total */  percentOfParentRowTotal: PivotShowAsTypeEnum.percentOfParentRowTotal  /** - the value as a percentage of the parent grand total */  percentOfParentGrandTotal: PivotShowAsTypeEnum.percentOfParentGrandTotal  /** - the index of the value */  index: PivotShowAsTypeEnum.index  /** - the difference from the value */  differenceFrom: PivotShowAsTypeEnum.differenceFrom  /** - the percentage difference from the value */  percentDifferenceFrom: PivotShowAsTypeEnum.percentDifferenceFrom  /** - the running total of the value */  runningTotal: PivotShowAsTypeEnum.runningTotal  /** - the percentage running total of the value */  percentRunningTotal: PivotShowAsTypeEnum.percentRunningTotal  /** - the percentage of the value */  percentOf: PivotShowAsTypeEnum.percentOf  /** - the percentage of the parent value */  percentOfParent: PivotShowAsTypeEnum.percentOfParent  /** - the rank of the value from smallest to largest */  rankAscending: PivotShowAsTypeEnum.rankAscending  /** - the rank of the value from largest to smallest */  rankDescending: PivotShowAsTypeEnum.rankDescending}

Package: @univerjs-pro/sheets-pivot · Type definitions

Enum.PivotSubtotalPositionEnum

Represents where row subtotals are displayed in outline layout. PivotSubtotalPositionEnum

Available values

TypeScript
type EnumValues = {  top: PivotSubtotalPositionEnum.top  bottom: PivotSubtotalPositionEnum.bottom}

Package: @univerjs-pro/sheets-pivot · Type definitions

Enum.PivotSubtotalTypeEnum

Represents the subtotal type of the pivot table. PivotSubtotalTypeEnum

Available values

TypeScript
type EnumValues = {  /** - the average of the values */  average: PivotSubtotalTypeEnum.average  /** - the count of the values */  count: PivotSubtotalTypeEnum.count  /** - the count of the numbers in the values */  countNums: PivotSubtotalTypeEnum.countNums  /** - the maximum value in the values */  max: PivotSubtotalTypeEnum.max  /** - the minimum value in the values */  min: PivotSubtotalTypeEnum.min  /** - the product of the values */  product: PivotSubtotalTypeEnum.product  /** - the standard deviation of the values */  stdDev: PivotSubtotalTypeEnum.stdDev  /** - the population standard deviation of the values */  stdDevp: PivotSubtotalTypeEnum.stdDevp  /** - the sum of the values */  sum: PivotSubtotalTypeEnum.sum  /** - the variance of the values */  var: PivotSubtotalTypeEnum.var  /** - the population variance of the values */  varp: PivotSubtotalTypeEnum.varp}

Package: @univerjs-pro/sheets-pivot · Type definitions

Enum.PivotTableChangeTypeEnum

Represents the change type of the pivot table. PivotTableChangeTypeEnum

Available values

TypeScript
type EnumValues = {  /** Add field to the pivot table. */  AddField: PivotTableChangeTypeEnum.AddField  /** Set subtotal to the field in the pivot table. */  SetSubtotalType: PivotTableChangeTypeEnum.SetSubtotalType  /** Remove field from the pivot table. */  RemoveField: PivotTableChangeTypeEnum.RemoveField  /** Rename the field in the pivot table. */  RenameField: PivotTableChangeTypeEnum.RenameField  /** Set filter information to the field in the pivot table. */  SetFilterInfo: PivotTableChangeTypeEnum.SetFilterInfo  /** Set sort information to the field in the pivot table. */  SetSortInfo: PivotTableChangeTypeEnum.SetSortInfo  /** Update field position in the pivot table. */  UpdateFieldPosition: PivotTableChangeTypeEnum.UpdateFieldPosition  /** Set options to the pivot table. */  UpdateValuePosition: PivotTableChangeTypeEnum.UpdateValuePosition  /** Set options to the pivot table. */  SetOptions: PivotTableChangeTypeEnum.SetOptions  /** Set format to the field in the pivot table. */  SetFieldFormat: PivotTableChangeTypeEnum.SetFieldFormat  /** Set collapse to the field in the pivot table. */  SetCollapse: PivotTableChangeTypeEnum.SetCollapse  /** Update source of the field in the pivot table. */  UpdateSource: PivotTableChangeTypeEnum.UpdateSource  /** Set value filter to the field in the pivot table. */  SetValueFilter: PivotTableChangeTypeEnum.SetValueFilter  /** Set report layout of the pivot table. */  SetLayout: PivotTableChangeTypeEnum.SetLayout  /** Set Show Values As information for a value field. */  SetShowDataAs: PivotTableChangeTypeEnum.SetShowDataAs}

Package: @univerjs-pro/sheets-pivot · Type definitions

Enum.PivotTableFiledAreaEnum

Represents the field area of the pivot table. PivotTableFiledAreaEnum

Available values

TypeScript
type EnumValues = {  /** Column - the column field */  Column: PivotTableFiledAreaEnum.Column  /** Row - the row field */  Row: PivotTableFiledAreaEnum.Row  /** Value - the value field */  Value: PivotTableFiledAreaEnum.Value  /** Filter - the filter field */  Filter: PivotTableFiledAreaEnum.Filter  /** Hidden - the hidden field, it is not shown in the pivot table, but when a slice is created, it will be relation to the slice. */  Hidden: PivotTableFiledAreaEnum.Hidden}

Package: @univerjs-pro/sheets-pivot · Type definitions

Enum.PivotTableValuePositionEnum

Represents the value position of the pivot table. PivotTableValuePositionEnum

Available values

TypeScript
type EnumValues = {  /** - the value field not exist in the column or row field */  None: PivotTableValuePositionEnum.None  /** - the value field position in the column field */  Column: PivotTableValuePositionEnum.Column  /** - the value field position in the row field */  Row: PivotTableValuePositionEnum.Row}

Package: @univerjs-pro/sheets-pivot · Type definitions

Enum.PivotViewCellValueTypeEnum

Represents the pivot view cell value type generated by the pivot view. PivotViewCellValueTypeEnum

Available values

TypeScript
type EnumValues = {  blank: PivotViewCellValueTypeEnum.blank  date: PivotViewCellValueTypeEnum.date  other: PivotViewCellValueTypeEnum.other}

Package: @univerjs-pro/sheets-pivot · Type definitions

Enum.PositionTypeEnum

Represents the position type of the pivot table. PositionType

Available values

TypeScript
type EnumValues = {  Existing: PositionType.Existing  New: PositionType.New}

Package: @univerjs-pro/sheets-pivot · Type definitions

@univerjs-pro/sheets-pivot-chart

Enum.PivotChartSourceKind

Identifies whether a PivotChart owns a range report or references a PivotTable report.

Available values

TypeScript
type EnumValues = {  Range: PivotChartSourceKind.Range  PivotTable: PivotChartSourceKind.PivotTable}

Package: @univerjs-pro/sheets-pivot-chart · Type definitions

@univerjs-pro/sheets-print

Enum.PrintAlign

Print alignment settings for content positioning

Available values

TypeScript
type EnumValues = {  Start: PrintAlign.Start  End: PrintAlign.End  Middle: PrintAlign.Middle}

Package: @univerjs-pro/sheets-print · Type definitions

Enum.PrintArea

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

Available values

TypeScript
type EnumValues = {  /** Print only the current active sheet */  CurrentSheet: PrintArea.CurrentSheet  /** Print the entire workbook */  workbook: PrintArea.workbook  /** Print only the current selected range */  CurrentSelection: PrintArea.CurrentSelection  /** Print all selected ranges across sheets */  AllSelection: PrintArea.AllSelection}

Package: @univerjs-pro/sheets-print · Type definitions

Enum.PrintDirection

Page orientation setting (Portrait/Landscape)

Available values

TypeScript
type EnumValues = {  Portrait: PrintDirection.Portrait  Landscape: PrintDirection.Landscape}

Package: @univerjs-pro/sheets-print · Type definitions

Enum.PrintFreeze

Freeze pane settings for printing

Available values

TypeScript
type EnumValues = {  /** Keep row headers frozen when printing */  Row: PrintFreeze.Row  /** Keep column headers frozen when printing */  Column: PrintFreeze.Column}

Package: @univerjs-pro/sheets-print · Type definitions

Enum.PrintHeaderFooter

Header and footer content options

Available values

TypeScript
type EnumValues = {  /** Insert current page size information */  PageSize: PrintHeaderFooter.PageSize  /** Insert workbook name */  WorkbookTitle: PrintHeaderFooter.WorkbookTitle  /** Insert worksheet name */  WorksheetTitle: PrintHeaderFooter.WorksheetTitle  /** Insert current date */  Date: PrintHeaderFooter.Date  /** Insert current time */  Time: PrintHeaderFooter.Time}

Package: @univerjs-pro/sheets-print · Type definitions

Enum.PrintHeaderFooterSymbol

Special symbols/placeholders available for headers and footers

Available values

TypeScript
type EnumValues = {  WorkbookTitle: PrintHeaderFooterSymbol.WorkbookTitle  WorksheetTitle: PrintHeaderFooterSymbol.WorksheetTitle  DateA: PrintHeaderFooterSymbol.DateA  DateB: PrintHeaderFooterSymbol.DateB  DateC: PrintHeaderFooterSymbol.DateC  DateD: PrintHeaderFooterSymbol.DateD  DateE: PrintHeaderFooterSymbol.DateE  TimeA: PrintHeaderFooterSymbol.TimeA  TimeB: PrintHeaderFooterSymbol.TimeB  TimeC: PrintHeaderFooterSymbol.TimeC  TimeD: PrintHeaderFooterSymbol.TimeD  Page: PrintHeaderFooterSymbol.Page  SheetPage: PrintHeaderFooterSymbol.SheetPage  PageTotal: PrintHeaderFooterSymbol.PageTotal  SheetPageTotal: PrintHeaderFooterSymbol.SheetPageTotal}

Package: @univerjs-pro/sheets-print · Type definitions

Enum.PrintPaperMargin

Margin presets for the printed page

Available values

TypeScript
type EnumValues = {  Normal: PrintPaperMargin.Normal  Narrow: PrintPaperMargin.Narrow  Wide: PrintPaperMargin.Wide  None: PrintPaperMargin.None  Custom: PrintPaperMargin.Custom}

Package: @univerjs-pro/sheets-print · Type definitions

Enum.PrintPaperSize

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

Available values

TypeScript
type EnumValues = {  Letter: PaperType.Letter  Tabloid: PaperType.Tabloid  Legal: PaperType.Legal  Statement: PaperType.Statement  Executive: PaperType.Executive  Folio: PaperType.Folio  A3: PaperType.A3  A4: PaperType.A4  A5: PaperType.A5  B4: PaperType.B4  B5: PaperType.B5}

Package: @univerjs-pro/sheets-print · Type definitions

Enum.PrintScale

Print scaling options to fit content to page

Available values

TypeScript
type EnumValues = {  Origin: PrintScale.Origin  FitWidth: PrintScale.FitWidth  FitHeight: PrintScale.FitHeight  FitPage: PrintScale.FitPage  Custom: PrintScale.Custom}

Package: @univerjs-pro/sheets-print · Type definitions

@univerjs-pro/sheets-sparkline

Enum.SparklineTypeEnum

Available values

TypeScript
type EnumValues = {  /** Line Sparkline */  LINE_CHART: SparklineTypeEnum.LINE_CHART  /** Bar Sparkline */  BAR_CHART: SparklineTypeEnum.BAR_CHART  /** Profit and Loss Sparkline */  PROFIT_AND_LOSS_CHART: SparklineTypeEnum.PROFIT_AND_LOSS_CHART  /** Pie Sparkline */  PIE_CHART: SparklineTypeEnum.PIE_CHART}

Package: @univerjs-pro/sheets-sparkline · Type definitions

@univerjs-pro/slides

Enum.SlideBackgroundTypeEnum

Slide background type enum.

Available values

TypeScript
type EnumValues = {  /** The slide background is transparent or omitted. */  None: SlideBackgroundTypeEnum.None  /** The slide background is a solid color. */  Solid: SlideBackgroundTypeEnum.Solid  /** The slide background is a gradient color. */  Gradient: SlideBackgroundTypeEnum.Gradient  /** The slide background is a picture. */  Image: SlideBackgroundTypeEnum.Image  /** The slide background is a pattern fill. */  Pattern: SlideBackgroundTypeEnum.Pattern}

Example

TypeScript
const fPresentation = univerAPI.getActivePresentation()const fSlide = fPresentation.getSlideById('slide-1')// Set a solid background color on this slide.fSlide.setBackground({  type: univerAPI.Enum.SlideBackgroundTypeEnum.Solid,  color: '#4f90ff',})// Set a gradient background on this slide.fSlide.setBackground({  type: univerAPI.Enum.SlideBackgroundTypeEnum.Gradient,  angle: 45,  stops: [    {      color: '#4f90ff',      position: 0,    },    {      color: '#ffffff',      position: 1,    },  ],})// Set an image background on this slide.fSlide.setBackground({  type: univerAPI.Enum.SlideBackgroundTypeEnum.Image,  source: 'https://example.com/image.png',  imageSourceType: univerAPI.Enum.ImageSourceType.URL,  fit: univerAPI.Enum.SlidePresentationBackgroundGraphicFitEnum.Cover,})// Set a pattern background on this slide.fSlide.setBackground({  type: univerAPI.Enum.SlideBackgroundTypeEnum.Pattern,  pattern: 'diagonal',  foregroundColor: '#4f90ff',  backgroundColor: '#ffffff',})

Package: @univerjs-pro/slides · Type definitions

Enum.SlidePageElementTypeEnum

Slide page element model enum used by slide snapshot elements.

Available values

TypeScript
type EnumValues = {  /** The page element is a placeholder. */  Placeholder: PageElementTypeEnum.Placeholder  /** The page element is an independent text box. */  Text: PageElementTypeEnum.Text  /** The page element is a shape. */  Shape: PageElementTypeEnum.Shape  /** The page element is an image. */  Image: PageElementTypeEnum.Image  /** The page element is a chart. */  Chart: PageElementTypeEnum.Chart  /** The page element is a table. */  Table: PageElementTypeEnum.Table  /** The page element is a diagram. */  Diagram: PageElementTypeEnum.Diagram  /** The page element is a media. */  Media: PageElementTypeEnum.Media  /** Grouped shape, which is a collection of shapes that are grouped together. It can be treated as a single shape for formatting and manipulation purposes. */  Group: PageElementTypeEnum.Group  /** Connector line (straight, bent, or curved) that can attach to connection sites on shapes. */  Connector: PageElementTypeEnum.Connector}

Example

TypeScript
const elementType = univerAPI.Enum.SlidePageElementTypeEnum.Shape

Package: @univerjs-pro/slides · Type definitions

Enum.SlidePageSizePresetEnum

Slide page size preset enum.

Available values

TypeScript
type EnumValues = {  Standard4By3: SlidePageSizePresetEnum.Standard4By3  WideScreen16By9: SlidePageSizePresetEnum.WideScreen16By9  WideScreen16By10: SlidePageSizePresetEnum.WideScreen16By10  Custom: SlidePageSizePresetEnum.Custom}

Example

TypeScript
const fPresentation = univerAPI.getActivePresentation()fPresentation.setPageSize({  width: 1024,  height: 768,  preset: univerAPI.Enum.SlidePageSizePresetEnum.WideScreen16By10,})

Package: @univerjs-pro/slides · Type definitions

Enum.SlidePageTypeEnum

Slide page model enum used by slide snapshots and Facade page APIs.

Available values

TypeScript
type EnumValues = {  Slide: PageTypeEnum.Slide  Master: PageTypeEnum.Master  Layout: PageTypeEnum.Layout  HandoutMaster: PageTypeEnum.HandoutMaster  NotesMaster: PageTypeEnum.NotesMaster}

Example

TypeScript
const pageType = univerAPI.Enum.SlidePageTypeEnum.Slide

Package: @univerjs-pro/slides · Type definitions

Enum.SlidePlaceholderTypeEnum

Slide placeholder type enum.

Available values

TypeScript
type EnumValues = {  /** Slide title placeholder. This is the default placeholder type for a slide. It is used to hold the title of the slide. */  Title: PlaceholderTypeEnum.Title  /** Slide centered title placeholder. */  CenterTitle: PlaceholderTypeEnum.CenterTitle  /** Slide subtitle placeholder. This is used to hold the subtitle of the slide. */  Subtitle: PlaceholderTypeEnum.Subtitle  /** Slide body placeholder. This is used to hold the main content of the slide, such as text, images, charts, tables, etc. */  Body: PlaceholderTypeEnum.Body  /** Generic text placeholder. */  Text: PlaceholderTypeEnum.Text  /** Slide object placeholder. This is used to hold any content type, such as text, images, charts, tables, etc. */  Object: PlaceholderTypeEnum.Object  /** Slide picture placeholder. This is used to hold a picture on the slide. */  Picture: PlaceholderTypeEnum.Picture  /** Slide chart placeholder. This is used to hold a chart on the slide. */  Chart: PlaceholderTypeEnum.Chart  /** Slide table placeholder. This is used to hold a table on the slide. */  Table: PlaceholderTypeEnum.Table  /** Slide diagram placeholder. This is used to hold a diagram on the slide. */  Diagram: PlaceholderTypeEnum.Diagram  /** Slide media placeholder. This is used to hold a multimedia on the slide. */  Media: PlaceholderTypeEnum.Media  /** Slide slide number placeholder. This is used to hold the number of the slide. */  SlideNumber: PlaceholderTypeEnum.SlideNumber  /** Slide date and time placeholder. This is used to hold the date and time on the slide. */  Date: PlaceholderTypeEnum.Date  /** Slide footer placeholder. This is used to hold the footer text on the slide. */  Footer: PlaceholderTypeEnum.Footer  /** Slide header placeholder. This is used to hold the header text on the slide. */  Header: PlaceholderTypeEnum.Header}

Example

TypeScript
const fPresentation = univerAPI.getActivePresentation()const fSlide = fPresentation.getSlideById('slide-1')const tableInfo = fSlide  .newTable()  .setRows(3)  .setColumns(4)  .setPlaceholder({    id: 'body-1',    type: univerAPI.Enum.SlidePlaceholderTypeEnum.Table,  })  .build()fSlide.insertTable(tableInfo)

Package: @univerjs-pro/slides · Type definitions

Enum.SlidePresentationBackgroundGraphicFitEnum

Slide presentation background graphic fit enum.

Available values

TypeScript
type EnumValues = {  Cover: SlidePresentationBackgroundGraphicFitEnum.Cover  Contain: SlidePresentationBackgroundGraphicFitEnum.Contain  Stretch: SlidePresentationBackgroundGraphicFitEnum.Stretch  Repeat: SlidePresentationBackgroundGraphicFitEnum.Repeat}

Example

TypeScript
const fPresentation = univerAPI.getActivePresentation()fPresentation.setPresentationBackgroundGraphics([  {    source: 'image-source-id',    imageSourceType: univerAPI.Enum.ImageSourceType.UUID,    fit: univerAPI.Enum.SlidePresentationBackgroundGraphicFitEnum.Cover,  },])

Package: @univerjs-pro/slides · Type definitions

Enum.SlidePresentationBackgroundGraphicsTargetEnum

Slide presentation background graphics target enum.

Available values

TypeScript
type EnumValues = {  AllMasters: SlidePresentationBackgroundGraphicsTargetEnum.AllMasters  ActiveMaster: SlidePresentationBackgroundGraphicsTargetEnum.ActiveMaster}

Example

TypeScript
const fPresentation = univerAPI.getActivePresentation()fPresentation.setPresentationBackgroundGraphics(  [    {      source: 'image-source-id',      imageSourceType: univerAPI.Enum.ImageSourceType.UUID,      fit: univerAPI.Enum.SlidePresentationBackgroundGraphicFitEnum.Cover,    },  ],  {    target: univerAPI.Enum.SlidePresentationBackgroundGraphicsTargetEnum.ActiveMaster,  },)

Package: @univerjs-pro/slides · Type definitions

Enum.SlideTransitionDirectionEnum

Slide transition direction enum. Used by Push, Wipe, Cover, Uncover, Reveal, and Split.

Available values

TypeScript
type EnumValues = {  Left: SlideTransitionDirectionEnum.Left  Right: SlideTransitionDirectionEnum.Right  Up: SlideTransitionDirectionEnum.Up  Down: SlideTransitionDirectionEnum.Down}

Example

TypeScript
const fPresentation = univerAPI.getActivePresentation()fPresentation.applyTransitionToAll({  type: univerAPI.Enum.SlideTransitionTypeEnum.Push,  duration: 1000,  direction: univerAPI.Enum.SlideTransitionDirectionEnum.Right,})

Package: @univerjs-pro/slides · Type definitions

Enum.SlideTransitionSpeedEnum

Slide transition speed enum. Preserved for PowerPoint compatibility; playback timing uses duration.

Available values

TypeScript
type EnumValues = {  /** Compatibility metadata. Current playback timing uses `duration`. */  Slow: SlideTransitionSpeedEnum.Slow  /** Compatibility metadata. Current playback timing uses `duration`. */  Medium: SlideTransitionSpeedEnum.Medium  /** Compatibility metadata. Current playback timing uses `duration`. */  Fast: SlideTransitionSpeedEnum.Fast}

Package: @univerjs-pro/slides · Type definitions

Enum.SlideTransitionTypeEnum

Slide transition type enum. Direction is only preserved for directional transition types.

Available values

TypeScript
type EnumValues = {  /** No transition effect. */  None: SlideTransitionTypeEnum.None  /** Cross-fade between the previous slide and the destination slide. */  Fade: SlideTransitionTypeEnum.Fade  /** The destination slide moves in from the configured direction and pushes the previous slide out. */  Push: SlideTransitionTypeEnum.Push  /** The destination slide is revealed by clipping in from the configured direction while the previous slide stays in place. */  Wipe: SlideTransitionTypeEnum.Wipe  /** Instant switch with no animation. */  Cut: SlideTransitionTypeEnum.Cut  /** The destination slide moves in from the configured direction and covers the previous slide. */  Cover: SlideTransitionTypeEnum.Cover  /** The previous slide moves out toward the configured direction and uncovers the destination slide. */  Uncover: SlideTransitionTypeEnum.Uncover  /** The previous slide is clipped away toward the configured direction to reveal the destination slide. */  Reveal: SlideTransitionTypeEnum.Reveal  /** The destination slide opens from the center split. Left and Right use a vertical split; Up and Down use a horizontal split. */  Split: SlideTransitionTypeEnum.Split  /** The destination slide scales and fades in while the previous slide scales and fades out. */  Zoom: SlideTransitionTypeEnum.Zoom}

Example

TypeScript
const fPresentation = univerAPI.getActivePresentation()fPresentation.applyTransitionToAll({  type: univerAPI.Enum.SlideTransitionTypeEnum.Push,  duration: 1000,  direction: univerAPI.Enum.SlideTransitionDirectionEnum.Right,})

Package: @univerjs-pro/slides · Type definitions

@univerjs-pro/slides-table

Enum.SlideTableBorderDashEnum

Slide table border dash enum.

Available values

TypeScript
type EnumValues = {  /** Continuous border line. */  Solid: SlideTableBorderDashEnum.Solid  /** Dashed border line. */  Dash: SlideTableBorderDashEnum.Dash  /** Dotted border line. */  Dot: SlideTableBorderDashEnum.Dot  /** Alternating dash and dot border line. */  DashDot: SlideTableBorderDashEnum.DashDot  /** Remove the selected border. */  None: SlideTableBorderDashEnum.None}

Example

TypeScript
const fPresentation = univerAPI.getActivePresentation()const fSlide = fPresentation.getSlideById('slide-1')const table = fSlide.getTableById('status-table')table.setCellStyle(table.getTableRange(), {  borders: {    left: {      color: '#111827',      width: 1,      dash: univerAPI.Enum.SlideTableBorderDashEnum.Dash,    },  },})

Package: @univerjs-pro/slides-table · Type definitions

Enum.SlideTableBorderPresetEnum

Slide table border preset enum.

Available values

TypeScript
type EnumValues = {  /** Apply borders to every outer and inner edge. */  All: SlideTableBorderPresetEnum.All  /** Apply only inner horizontal and vertical borders. */  Inner: SlideTableBorderPresetEnum.Inner  /** Apply only the outside rectangle. */  Outer: SlideTableBorderPresetEnum.Outer  /** Apply only the top edge. */  Top: SlideTableBorderPresetEnum.Top  /** Apply only the bottom edge. */  Bottom: SlideTableBorderPresetEnum.Bottom  /** Apply only the left edge. */  Left: SlideTableBorderPresetEnum.Left  /** Apply only the right edge. */  Right: SlideTableBorderPresetEnum.Right  /** Remove all borders in the target range. */  None: SlideTableBorderPresetEnum.None  /** Apply only borders between rows. */  InnerHorizontal: SlideTableBorderPresetEnum.InnerHorizontal  /** Apply only borders between columns. */  InnerVertical: SlideTableBorderPresetEnum.InnerVertical}

Example

TypeScript
const fPresentation = univerAPI.getActivePresentation()const fSlide = fPresentation.getSlideByIndex(0)const table = fSlide.getTableById('status-table')table.setBorder(  table.getTableRange(),  {    color: '#111827',    width: 1,    dash: univerAPI.Enum.SlideTableBorderDashEnum.Dash,  },  univerAPI.Enum.SlideTableBorderPresetEnum.Outer,)

Package: @univerjs-pro/slides-table · Type definitions

Enum.SlideTableFillTypeEnum

Slide table fill type enum.

Available values

TypeScript
type EnumValues = {  /** Do not paint a cell fill. */  None: SlideTableFillTypeEnum.None  /** Paint one solid color. */  Solid: SlideTableFillTypeEnum.Solid  /** Paint a gradient defined by type, angle, and color stops. */  Gradient: SlideTableFillTypeEnum.Gradient  /** Paint an image using stretch or tile placement. */  Picture: SlideTableFillTypeEnum.Picture}

Example

TypeScript
const fPresentation = univerAPI.getActivePresentation()const fSlide = fPresentation.getSlideById('slide-1')const table = fSlide.getTableById('status-table')table.setCellStyle(table.getTableRange(), {  fill: {    type: univerAPI.Enum.SlideTableFillTypeEnum.Solid,    color: '#E8F1FF',    alpha: 1,  },})

Package: @univerjs-pro/slides-table · Type definitions

Enum.SlideTableGradientFillTypeEnum

Slide table gradient fill type enum.

Available values

TypeScript
type EnumValues = {  /** Linear gradient along an angle. */  Linear: SlideTableGradientFillTypeEnum.Linear  /** Radial gradient expanding from a center point. */  Radial: SlideTableGradientFillTypeEnum.Radial  /** Angular gradient rotating around a center point. */  Angular: SlideTableGradientFillTypeEnum.Angular  /** Diamond-shaped gradient expanding toward the corners. */  Diamond: SlideTableGradientFillTypeEnum.Diamond}

Example

TypeScript
const fPresentation = univerAPI.getActivePresentation()const fSlide = fPresentation.getSlideById('slide-1')const table = fSlide.getTableById('status-table')table.setCellStyle(table.getTableRange(), {  fill: {    type: univerAPI.Enum.SlideTableFillTypeEnum.Gradient,    gradient: {      type: univerAPI.Enum.SlideTableGradientFillTypeEnum.Linear,      angle: 90,      stops: [        { color: '#E8F1FF', offset: 0, opacity: 1 },        { color: '#FFFFFF', offset: 1, opacity: 1 },      ],    },  },})

Package: @univerjs-pro/slides-table · Type definitions

Enum.SlideTablePictureFillModeEnum

Slide table picture fill mode enum.

Available values

TypeScript
type EnumValues = {  /** Scale one image to cover the cell fill area. */  Stretch: SlideTablePictureFillModeEnum.Stretch  /** Repeat the image as tiles inside the cell fill area. */  Tile: SlideTablePictureFillModeEnum.Tile}

Example

TypeScript
const fPresentation = univerAPI.getActivePresentation()const fSlide = fPresentation.getSlideById('slide-1')const table = fSlide.getTableById('status-table')table.setCellStyle(table.getTableRange(), {  fill: {    type: univerAPI.Enum.SlideTableFillTypeEnum.Picture,    picture: {      source: 'https://example.com/image.png',      mode: univerAPI.Enum.SlideTablePictureFillModeEnum.Tile,    },  },})

Package: @univerjs-pro/slides-table · Type definitions

Enum.SlideTableTextDirectionEnum

Slide table text direction enum.

Available values

TypeScript
type EnumValues = {  /** Render text from left to right using normal horizontal lines. */  Horizontal: SlideTableTextDirectionEnum.Horizontal  /** Stack or rotate text vertically from top to bottom. */  Vertical: SlideTableTextDirectionEnum.Vertical  /** Render vertical text in the opposite 270-degree direction. */  Vertical270: SlideTableTextDirectionEnum.Vertical270  WordArtVertical: SlideTableTextDirectionEnum.WordArtVertical}

Example

TypeScript
const fPresentation = univerAPI.getActivePresentation()const fSlide = fPresentation.getSlideById('slide-1')const table = fSlide.getTableById('status-table')table.setCellStyle(table.getTableRange(), {  textDirection: univerAPI.Enum.SlideTableTextDirectionEnum.Vertical,})

Package: @univerjs-pro/slides-table · Type definitions

Enum.SlideTableVerticalAlignEnum

Chart type enum.

Available values

TypeScript
type EnumValues = {  /** Align cell content to the top edge. */  Top: SlideTableVerticalAlignEnum.Top  /** Center cell content vertically. */  Middle: SlideTableVerticalAlignEnum.Middle  /** Align cell content to the bottom edge. */  Bottom: SlideTableVerticalAlignEnum.Bottom}

Example

TypeScript
const fPresentation = univerAPI.getActivePresentation()const fSlide = fPresentation.getSlideById('slide-1')const table = fSlide.getTableById('status-table')table.setCellStyle(table.getTableRange(), {  verticalAlign: univerAPI.Enum.SlideTableVerticalAlignEnum.Middle,})

Package: @univerjs-pro/slides-table · Type definitions

@univerjs/core

Enum.AbsoluteRefType

Defines different types of absolute references

Available values

TypeScript
type EnumValues = {  NONE: AbsoluteRefType.NONE  ROW: AbsoluteRefType.ROW  COLUMN: AbsoluteRefType.COLUMN  ALL: AbsoluteRefType.ALL}

Example

TypeScript
console.log(univerAPI.Enum.AbsoluteRefType)

Package: @univerjs/core · Type definitions

Enum.AutoFillSeries

Auto fill series types

Available values

TypeScript
type EnumValues = {  /** Default. Auto-filling with this setting results in the empty cells in the expanded range being filled with increments of the existing values. */  DEFAULT_SERIES: AutoFillSeries.DEFAULT_SERIES  /** Auto-filling with this setting results in the empty cells in the expanded range being filled with copies of the existing values. */  ALTERNATE_SERIES: AutoFillSeries.ALTERNATE_SERIES}

Example

TypeScript
console.log(univerAPI.Enum.AutoFillSeries.ALTERNATE_SERIES)

Package: @univerjs/core · Type definitions

Enum.BaselineOffset

Different baseline offsets for text baseline positioning

Available values

TypeScript
type EnumValues = {  NORMAL: BaselineOffset.NORMAL  SUBSCRIPT: BaselineOffset.SUBSCRIPT  SUPERSCRIPT: BaselineOffset.SUPERSCRIPT}

Example

TypeScript
console.log(univerAPI.Enum.BaselineOffset.SUPERSCRIPT)

Package: @univerjs/core · Type definitions

Enum.BooleanNumber

Boolean number representations

Available values

TypeScript
type EnumValues = {  FALSE: BooleanNumber.FALSE  TRUE: BooleanNumber.TRUE}

Example

TypeScript
console.log(univerAPI.Enum.BooleanNumber.TRUE)

Package: @univerjs/core · Type definitions

Enum.BorderStyleTypes

Different border style types

Available values

TypeScript
type EnumValues = {  NONE: BorderStyleTypes.NONE  THIN: BorderStyleTypes.THIN  HAIR: BorderStyleTypes.HAIR  DOTTED: BorderStyleTypes.DOTTED  DASHED: BorderStyleTypes.DASHED  DASH_DOT: BorderStyleTypes.DASH_DOT  DASH_DOT_DOT: BorderStyleTypes.DASH_DOT_DOT  DOUBLE: BorderStyleTypes.DOUBLE  MEDIUM: BorderStyleTypes.MEDIUM  MEDIUM_DASHED: BorderStyleTypes.MEDIUM_DASHED  MEDIUM_DASH_DOT: BorderStyleTypes.MEDIUM_DASH_DOT  MEDIUM_DASH_DOT_DOT: BorderStyleTypes.MEDIUM_DASH_DOT_DOT  SLANT_DASH_DOT: BorderStyleTypes.SLANT_DASH_DOT  THICK: BorderStyleTypes.THICK}

Example

TypeScript
console.log(univerAPI.Enum.BorderStyleTypes.NONE)

Package: @univerjs/core · Type definitions

Enum.BorderType

Different border types

Available values

TypeScript
type EnumValues = {  TOP: BorderType.TOP  BOTTOM: BorderType.BOTTOM  LEFT: BorderType.LEFT  RIGHT: BorderType.RIGHT  NONE: BorderType.NONE  ALL: BorderType.ALL  OUTSIDE: BorderType.OUTSIDE  INSIDE: BorderType.INSIDE  HORIZONTAL: BorderType.HORIZONTAL  VERTICAL: BorderType.VERTICAL  TLBR: BorderType.TLBR  TLBC_TLMR: BorderType.TLBC_TLMR  TLBR_TLBC_TLMR: BorderType.TLBR_TLBC_TLMR  BLTR: BorderType.BLTR  MLTR_BCTR: BorderType.MLTR_BCTR}

Example

TypeScript
console.log(univerAPI.Enum.BorderType.OUTSIDE)

Package: @univerjs/core · Type definitions

Enum.ColorType

Color types

Available values

TypeScript
type EnumValues = {  UNSUPPORTED: ColorType.UNSUPPORTED  RGB: ColorType.RGB  HEX: ColorType.HEX  THEME: ColorType.THEME}

Example

TypeScript
console.log(univerAPI.Enum.ColorType.RGB)

Package: @univerjs/core · Type definitions

Enum.CommandType

Different types of commands

Available values

TypeScript
type EnumValues = {  /** Responsible for creating, orchestrating, and executing MUTATION or OPERATION according to specific business logic. For example, a delete row COMMAND will generate a delete row MUTATION, an insert row MUTATION for undo, and a set cell content MUTATION. */  COMMAND: CommandType.COMMAND  /** OPERATION is the change made to data that is not saved to snapshot, without conflict resolution, such as modifying scroll position, modifying sidebar state, etc. */  OPERATION: CommandType.OPERATION  /** MUTATION is the change made to the data saved to snapshot, such as inserting rows and columns, modifying cell content, modifying filter ranges, etc. If you want to add collaborative editing capabilities to Univer, it is the smallest unit of conflict resolution. */  MUTATION: CommandType.MUTATION}

Example

TypeScript
console.log(univerAPI.Enum.CommandType.COMMAND)

Package: @univerjs/core · Type definitions

Enum.CommonHideTypes

Common hide types

Available values

TypeScript
type EnumValues = {  ON: CommonHideTypes.ON  OFF: CommonHideTypes.OFF}

Example

TypeScript
console.log(univerAPI.Enum.CommonHideTypes.ON)

Package: @univerjs/core · Type definitions

Enum.CopyPasteType

Copy paste types

Available values

TypeScript
type EnumValues = {  PASTE_NORMAL: CopyPasteType.PASTE_NORMAL  PASTE_NO_BORDERS: CopyPasteType.PASTE_NO_BORDERS  PASTE_FORMAT: CopyPasteType.PASTE_FORMAT  PASTE_FORMULA: CopyPasteType.PASTE_FORMULA  PASTE_DATA_VALIDATION: CopyPasteType.PASTE_DATA_VALIDATION  PASTE_VALUES: CopyPasteType.PASTE_VALUES  PASTE_CONDITIONAL_FORMATTING: CopyPasteType.PASTE_CONDITIONAL_FORMATTING  PASTE_COLUMN_WIDTHS: CopyPasteType.PASTE_COLUMN_WIDTHS}

Example

TypeScript
console.log(univerAPI.Enum.CopyPasteType.PASTE_VALUES)

Package: @univerjs/core · Type definitions

Enum.DataValidationErrorStyle

Different error display styles

Available values

TypeScript
type EnumValues = {  INFO: DataValidationErrorStyle.INFO  STOP: DataValidationErrorStyle.STOP  WARNING: DataValidationErrorStyle.WARNING}

Example

TypeScript
console.log(univerAPI.Enum.DataValidationErrorStyle.WARNING)

Package: @univerjs/core · Type definitions

Enum.DataValidationOperator

Different validation operators

Available values

TypeScript
type EnumValues = {  BETWEEN: DataValidationOperator.BETWEEN  EQUAL: DataValidationOperator.EQUAL  GREATER_THAN: DataValidationOperator.GREATER_THAN  GREATER_THAN_OR_EQUAL: DataValidationOperator.GREATER_THAN_OR_EQUAL  LESS_THAN: DataValidationOperator.LESS_THAN  LESS_THAN_OR_EQUAL: DataValidationOperator.LESS_THAN_OR_EQUAL  NOT_BETWEEN: DataValidationOperator.NOT_BETWEEN  NOT_EQUAL: DataValidationOperator.NOT_EQUAL}

Example

TypeScript
console.log(univerAPI.Enum.DataValidationOperator.BETWEEN)

Package: @univerjs/core · Type definitions

Enum.DataValidationRenderMode

Different validation rendering modes

Available values

TypeScript
type EnumValues = {  TEXT: DataValidationRenderMode.TEXT  ARROW: DataValidationRenderMode.ARROW  CUSTOM: DataValidationRenderMode.CUSTOM}

Example

TypeScript
console.log(univerAPI.Enum.DataValidationRenderMode.TEXT)

Package: @univerjs/core · Type definitions

Enum.DataValidationStatus

Different validation states

Available values

TypeScript
type EnumValues = {  VALID: DataValidationStatus.VALID  INVALID: DataValidationStatus.INVALID  VALIDATING: DataValidationStatus.VALIDATING}

Example

TypeScript
console.log(univerAPI.Enum.DataValidationStatus.VALID)

Package: @univerjs/core · Type definitions

Enum.DataValidationType

Different types of data validation

Available values

TypeScript
type EnumValues = {  /** custom formula */  CUSTOM: DataValidationType.CUSTOM  LIST: DataValidationType.LIST  LIST_MULTIPLE: DataValidationType.LIST_MULTIPLE  NONE: DataValidationType.NONE  TEXT_LENGTH: DataValidationType.TEXT_LENGTH  DATE: DataValidationType.DATE  TIME: DataValidationType.TIME  /** integer number */  WHOLE: DataValidationType.WHOLE  /** decimal number */  DECIMAL: DataValidationType.DECIMAL  CHECKBOX: DataValidationType.CHECKBOX  ANY: DataValidationType.ANY}

Example

TypeScript
console.log(univerAPI.Enum.DataValidationType.LIST)

Package: @univerjs/core · Type definitions

Enum.DeleteDirection

Delete direction types

Available values

TypeScript
type EnumValues = {  LEFT: DeleteDirection.LEFT  RIGHT: DeleteDirection.RIGHT}

Example

TypeScript
console.log(univerAPI.Enum.DeleteDirection.LEFT)

Package: @univerjs/core · Type definitions

Enum.DeveloperMetadataVisibility

Developer metadata visibility types

Available values

TypeScript
type EnumValues = {  DOCUMENT: DeveloperMetadataVisibility.DOCUMENT  PROJECT: DeveloperMetadataVisibility.PROJECT}

Example

TypeScript
console.log(univerAPI.Enum.DeveloperMetadataVisibility.DOCUMENT)

Package: @univerjs/core · Type definitions

Enum.Dimension

Dimension types

Available values

TypeScript
type EnumValues = {  /** The column (vertical) dimension. move left or right */  COLUMNS: Dimension.COLUMNS  /** The row (horizontal) dimension. move up or down */  ROWS: Dimension.ROWS}

Example

TypeScript
console.log(univerAPI.Enum.Dimension.ROWS)

Package: @univerjs/core · Type definitions

Enum.Direction

Direction types

Available values

TypeScript
type EnumValues = {  UP: Direction.UP  RIGHT: Direction.RIGHT  DOWN: Direction.DOWN  LEFT: Direction.LEFT}

Example

TypeScript
console.log(univerAPI.Enum.Direction.UP)

Package: @univerjs/core · Type definitions

Enum.FormulaType

SpreadsheetML formula types.

Available values

TypeScript
type EnumValues = {  NORMAL: FormulaType.NORMAL  SHARED: FormulaType.SHARED  ARRAY: FormulaType.ARRAY  /** What-if analysis data table, not a structured table. */  DATA_TABLE: FormulaType.DATA_TABLE}

Package: @univerjs/core · Type definitions

Enum.HorizontalAlign

Different horizontal text alignment options

Available values

TypeScript
type EnumValues = {  UNSPECIFIED: HorizontalAlign.UNSPECIFIED  LEFT: HorizontalAlign.LEFT  CENTER: HorizontalAlign.CENTER  RIGHT: HorizontalAlign.RIGHT  JUSTIFIED: HorizontalAlign.JUSTIFIED  BOTH: HorizontalAlign.BOTH  DISTRIBUTED: HorizontalAlign.DISTRIBUTED}

Example

TypeScript
console.log(univerAPI.Enum.HorizontalAlign.CENTER)

Package: @univerjs/core · Type definitions

Enum.ImageSourceType

Image source types

Available values

TypeScript
type EnumValues = {  /** The image source is a URL, for example: https://avatars.githubusercontent.com/u/61444807?s=48&v=4 */  URL: ImageSourceType.URL  /** The image source is a UUID, this ID is generated by the Univer image hosting service. For specific generation rules, please refer to the Univer image hosting service API documentation. */  UUID: ImageSourceType.UUID  /** The image source is BASE64, for example: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAALCAYAAAB7ZJ... */  BASE64: ImageSourceType.BASE64}

Example

TypeScript
console.log(univerAPI.Enum.ImageSourceType.URL)

Package: @univerjs/core · Type definitions

Enum.InterpolationPointType

Interpolation point types

Available values

TypeScript
type EnumValues = {  INTERPOLATION_POINT_TYPE_UNSPECIFIED: InterpolationPointType.INTERPOLATION_POINT_TYPE_UNSPECIFIED  MIN: InterpolationPointType.MIN  MAX: InterpolationPointType.MAX  NUMBER: InterpolationPointType.NUMBER  PERCENT: InterpolationPointType.PERCENT  PERCENTILE: InterpolationPointType.PERCENTILE}

Example

TypeScript
console.log(univerAPI.Enum.InterpolationPointType.NUMBER)

Package: @univerjs/core · Type definitions

Enum.LifecycleStages

Represents different stages in the lifecycle

Available values

TypeScript
type EnumValues = {  /** Register plugins to Univer. */  Starting: LifecycleStages.Starting  /** Univer business instances (UniverDoc / UniverSheet / UniverSlide) are created and services or controllers provided by plugins get initialized. The application is ready to do the first-time rendering. */  Ready: LifecycleStages.Ready  /** First-time rendering is completed. */  Rendered: LifecycleStages.Rendered  /** All lazy tasks are completed. The application is fully ready to provide features to users. */  Steady: LifecycleStages.Steady}

Example

TypeScript
console.log(univerAPI.Enum.LifecycleStages.Rendered)

Package: @univerjs/core · Type definitions

Enum.LocaleType

Locale types

Available values

TypeScript
type EnumValues = {  EN_US: LocaleType.EN_US  FR_FR: LocaleType.FR_FR  ZH_CN: LocaleType.ZH_CN  RU_RU: LocaleType.RU_RU  ZH_TW: LocaleType.ZH_TW  ZH_HK: LocaleType.ZH_HK  VI_VN: LocaleType.VI_VN  FA_IR: LocaleType.FA_IR  JA_JP: LocaleType.JA_JP  KO_KR: LocaleType.KO_KR  ES_ES: LocaleType.ES_ES  CA_ES: LocaleType.CA_ES  SK_SK: LocaleType.SK_SK  PT_BR: LocaleType.PT_BR  DE_DE: LocaleType.DE_DE  IT_IT: LocaleType.IT_IT  ID_ID: LocaleType.ID_ID  PL_PL: LocaleType.PL_PL  AR_SA: LocaleType.AR_SA}

Example

TypeScript
console.log(univerAPI.Enum.LocaleType.EN_US)

Package: @univerjs/core · Type definitions

Enum.MentionType

Mention types

Available values

TypeScript
type EnumValues = {  PERSON: MentionType.PERSON  FILE: MentionType.FILE  DATE: MentionType.DATE  LOCATION: MentionType.LOCATION  EVENT: MentionType.EVENT}

Example

TypeScript
console.log(univerAPI.Enum.MentionType.PERSON)

Package: @univerjs/core · Type definitions

Enum.NamedStyleType

Named paragraph style types

Available values

TypeScript
type EnumValues = {  NAMED_STYLE_TYPE_UNSPECIFIED: NamedStyleType.NAMED_STYLE_TYPE_UNSPECIFIED  NORMAL_TEXT: NamedStyleType.NORMAL_TEXT  TITLE: NamedStyleType.TITLE  SUBTITLE: NamedStyleType.SUBTITLE  HEADING_1: NamedStyleType.HEADING_1  HEADING_2: NamedStyleType.HEADING_2  HEADING_3: NamedStyleType.HEADING_3  HEADING_4: NamedStyleType.HEADING_4  HEADING_5: NamedStyleType.HEADING_5}

Example

TypeScript
console.log(univerAPI.Enum.NamedStyleType.HEADING_1)

Package: @univerjs/core · Type definitions

Enum.NumberUnitType

Units accepted by document lengths such as paragraph indentation and spacing

Agent-facing rich-text helpers accept plain numbers as document points, so this enum is only needed when an explicit alternative unit is required.

Available values

TypeScript
type EnumValues = {  POINT: NumberUnitType.POINT  LINE: NumberUnitType.LINE  CHARACTER: NumberUnitType.CHARACTER  PIXEL: NumberUnitType.PIXEL  PERCENT: NumberUnitType.PERCENT}

Example

TypeScript
console.log(univerAPI.Enum.NumberUnitType.POINT)

Package: @univerjs/core · Type definitions

Enum.PresetListType

Preset ordered, unordered, and checklist styles used by rich-text list items

Available values

TypeScript
type EnumValues = {  /** Standard filled-circle bullet list. */  BULLET_LIST: PresetListType.BULLET_LIST  /** Decorative diamond and arrow bullet list. */  BULLET_LIST_1: PresetListType.BULLET_LIST_1  /** Checkmark-led bullet list for completed-item style content. */  BULLET_LIST_2: PresetListType.BULLET_LIST_2  /** Square and diamond bullet list. */  BULLET_LIST_3: PresetListType.BULLET_LIST_3  /** Star-like decorative bullet list. */  BULLET_LIST_4: PresetListType.BULLET_LIST_4  /** Arrow-led bullet list. */  BULLET_LIST_5: PresetListType.BULLET_LIST_5  /** Hierarchical ordered list using `1`, `a`, and `i` markers. */  ORDER_LIST: PresetListType.ORDER_LIST  /** Hierarchical ordered list using `1)`, `a)`, and `i)` markers. */  ORDER_LIST_1: PresetListType.ORDER_LIST_1  /** Outline list using compound markers such as `1.`, `1.1.`, and `1.1.1.`. */  ORDER_LIST_2: PresetListType.ORDER_LIST_2  /** Hierarchical ordered list using `A`, `a`, and `i` markers. */  ORDER_LIST_3: PresetListType.ORDER_LIST_3  /** Hierarchical ordered list using `A`, `1`, and `i` markers. */  ORDER_LIST_4: PresetListType.ORDER_LIST_4  /** Zero-padded ordered list using `01`, `a`, and `i` markers. */  ORDER_LIST_5: PresetListType.ORDER_LIST_5  /** Quick ordered list using closing-parenthesis markers. */  ORDER_LIST_QUICK_2: PresetListType.ORDER_LIST_QUICK_2  /** Quick ordered list using lowercase letter and period markers. */  ORDER_LIST_QUICK_3: PresetListType.ORDER_LIST_QUICK_3  /** Quick ordered list using lowercase Roman numeral markers. */  ORDER_LIST_QUICK_4: PresetListType.ORDER_LIST_QUICK_4  /** Quick ordered list using uppercase letter markers. */  ORDER_LIST_QUICK_5: PresetListType.ORDER_LIST_QUICK_5  /** Quick ordered list using uppercase Roman numeral markers. */  ORDER_LIST_QUICK_6: PresetListType.ORDER_LIST_QUICK_6  /** Unchecked task-list item. */  CHECK_LIST: PresetListType.CHECK_LIST  /** Checked task-list item. */  CHECK_LIST_CHECKED: PresetListType.CHECK_LIST_CHECKED}

Example

TypeScript
console.log(univerAPI.Enum.PresetListType.BULLET_LIST)

Package: @univerjs/core · Type definitions

Enum.ProtectionType

Protection types

Available values

TypeScript
type EnumValues = {  RANGE: ProtectionType.RANGE  SHEET: ProtectionType.SHEET}

Example

TypeScript
console.log(univerAPI.Enum.ProtectionType.RANGE)

Package: @univerjs/core · Type definitions

Enum.RelativeDate

Relative date types

Available values

TypeScript
type EnumValues = {  RELATIVE_DATE_UNSPECIFIED: RelativeDate.RELATIVE_DATE_UNSPECIFIED  PAST_YEAR: RelativeDate.PAST_YEAR  PAST_MONTH: RelativeDate.PAST_MONTH  PAST_WEEK: RelativeDate.PAST_WEEK  YESTERDAY: RelativeDate.YESTERDAY  TODAY: RelativeDate.TODAY  TOMORROW: RelativeDate.TOMORROW}

Example

TypeScript
console.log(univerAPI.Enum.RelativeDate.TODAY)

Package: @univerjs/core · Type definitions

Enum.SheetTypes

Sheet types

Available values

TypeScript
type EnumValues = {  GRID: SheetTypes.GRID  KANBAN: SheetTypes.KANBAN  GANTT: SheetTypes.GANTT}

Example

TypeScript
console.log(univerAPI.Enum.SheetTypes.GRID)

Package: @univerjs/core · Type definitions

Enum.SpacingRule

Paragraph line-height interpretation modes

Available values

TypeScript
type EnumValues = {  /** Specifies that the line spacing of the parent object shall be automatically determined by the size of its contents, with no predetermined minimum or maximum size. */  AUTO: SpacingRule.AUTO  /** Specifies that the height of the line shall be at least the value specified, but might be expanded to fit its content as needed. */  AT_LEAST: SpacingRule.AT_LEAST  /** Specifies that the height of the line shall be exactly the value specified, regardless of the size of the contents of the contents. */  EXACT: SpacingRule.EXACT}

Example

TypeScript
console.log(univerAPI.Enum.SpacingRule.EXACT)

Package: @univerjs/core · Type definitions

Enum.TextDecoration

Different text decoration styles

Available values

TypeScript
type EnumValues = {  DASH: TextDecoration.DASH  DASH_DOT_DOT_HEAVY: TextDecoration.DASH_DOT_DOT_HEAVY  DASH_DOT_HEAVY: TextDecoration.DASH_DOT_HEAVY  DASHED_HEAVY: TextDecoration.DASHED_HEAVY  DASH_LONG: TextDecoration.DASH_LONG  DASH_LONG_HEAVY: TextDecoration.DASH_LONG_HEAVY  DOT_DASH: TextDecoration.DOT_DASH  DOT_DOT_DASH: TextDecoration.DOT_DOT_DASH  DOTTED: TextDecoration.DOTTED  DOTTED_HEAVY: TextDecoration.DOTTED_HEAVY  DOUBLE: TextDecoration.DOUBLE  NONE: TextDecoration.NONE  SINGLE: TextDecoration.SINGLE  THICK: TextDecoration.THICK  WAVE: TextDecoration.WAVE  WAVY_DOUBLE: TextDecoration.WAVY_DOUBLE  WAVY_HEAVY: TextDecoration.WAVY_HEAVY  WORDS: TextDecoration.WORDS  SINGLE_ACCOUNTING: TextDecoration.SINGLE_ACCOUNTING  DOUBLE_ACCOUNTING: TextDecoration.DOUBLE_ACCOUNTING}

Example

TypeScript
console.log(univerAPI.Enum.TextDecoration.DOUBLE)

Package: @univerjs/core · Type definitions

Enum.TextDirection

Different text direction options

Available values

TypeScript
type EnumValues = {  UNSPECIFIED: TextDirection.UNSPECIFIED  LEFT_TO_RIGHT: TextDirection.LEFT_TO_RIGHT  RIGHT_TO_LEFT: TextDirection.RIGHT_TO_LEFT}

Example

TypeScript
console.log(univerAPI.Enum.TextDirection.LEFT_TO_RIGHT)

Package: @univerjs/core · Type definitions

Enum.ThemeColorType

Theme color types

Available values

TypeScript
type EnumValues = {  /** TEXT */  DARK1: ThemeColorType.DARK1  /** BACKGROUND */  LIGHT1: ThemeColorType.LIGHT1  DARK2: ThemeColorType.DARK2  LIGHT2: ThemeColorType.LIGHT2  ACCENT1: ThemeColorType.ACCENT1  ACCENT2: ThemeColorType.ACCENT2  ACCENT3: ThemeColorType.ACCENT3  ACCENT4: ThemeColorType.ACCENT4  ACCENT5: ThemeColorType.ACCENT5  ACCENT6: ThemeColorType.ACCENT6  /** LINK */  HYPERLINK: ThemeColorType.HYPERLINK  FOLLOWED_HYPERLINK: ThemeColorType.FOLLOWED_HYPERLINK}

Example

TypeScript
console.log(univerAPI.Enum.ThemeColorType.ACCENT1)

Package: @univerjs/core · Type definitions

Enum.UniverInstanceType

Defines different types of Univer instances

Available values

TypeScript
type EnumValues = {  UNIVER_UNKNOWN: UniverType.UNIVER_UNKNOWN  UNIVER_DOC: UniverType.UNIVER_DOC  UNIVER_SHEET: UniverType.UNIVER_SHEET  UNIVER_SLIDE: UniverType.UNIVER_SLIDE  UNIVER_PROJECT: UniverType.UNIVER_PROJECT  UNIVER_BASE: UniverType.UNIVER_BASE  UNIVER_BOARD: UniverType.UNIVER_BOARD  UNIVER_PDF: UniverType.UNIVER_PDF  UNRECOGNIZED: UniverType.UNRECOGNIZED}

Example

TypeScript
console.log(univerAPI.Enum.UniverInstanceType.UNIVER_SHEET)

Package: @univerjs/core · Type definitions

Enum.VerticalAlign

Different vertical text alignment options

Available values

TypeScript
type EnumValues = {  UNSPECIFIED: VerticalAlign.UNSPECIFIED  TOP: VerticalAlign.TOP  MIDDLE: VerticalAlign.MIDDLE  BOTTOM: VerticalAlign.BOTTOM}

Example

TypeScript
console.log(univerAPI.Enum.VerticalAlign.MIDDLE)

Package: @univerjs/core · Type definitions

Enum.WorksheetHiddenState

Worksheet hiding states: VISIBLE (0), HIDDEN (1), VERY_HIDDEN (2).

Available values

TypeScript
type EnumValues = {  /** Visible in the sheet bar. Preserves the existing hidden: 0 value. */  VISIBLE: WorksheetHiddenState.VISIBLE  /** Hidden, and listed in the UI's Unhide dialog. Preserves hidden: 1. */  HIDDEN: WorksheetHiddenState.HIDDEN  /** Omitted from Unhide UI; can be revealed through the API. Not an access permission. */  VERY_HIDDEN: WorksheetHiddenState.VERY_HIDDEN}

Package: @univerjs/core · Type definitions

Enum.WrapStrategy

Different wrap strategy options

Available values

TypeScript
type EnumValues = {  UNSPECIFIED: WrapStrategy.UNSPECIFIED  /** Lines that are longer than the cell width will be written in the next cell over, so long as that cell is empty. If the next cell over is non-empty, this behaves the same as CLIP . The text will never wrap to the next line unless the user manually inserts a new line. Example: | First sentence. | | Manual newline that is very long. <- Text continues into next cell | Next newline. | */  OVERFLOW: WrapStrategy.OVERFLOW  /** Lines that are longer than the cell width will be clipped. The text will never wrap to the next line unless the user manually inserts a new line. Example: | First sentence. | | Manual newline t| <- Text is clipped | Next newline. | */  CLIP: WrapStrategy.CLIP  /** Words that are longer than a line are wrapped at the character level rather than clipped. Example: | Cell has a | | loooooooooo| <- Word is broken. | ong word. | */  WRAP: WrapStrategy.WRAP}

Example

TypeScript
console.log(univerAPI.Enum.WrapStrategy.WRAP)

Package: @univerjs/core · Type definitions

@univerjs/docs

Enum.ColumnSeparatorType

Section column separator types.

Available values

TypeScript
type EnumValues = {  COLUMN_SEPARATOR_STYLE_UNSPECIFIED: ColumnSeparatorType.COLUMN_SEPARATOR_STYLE_UNSPECIFIED  NONE: ColumnSeparatorType.NONE  BETWEEN_EACH_COLUMN: ColumnSeparatorType.BETWEEN_EACH_COLUMN}

Package: @univerjs/docs · Type definitions

Enum.DocumentFlavor

Document layout flavors.

Available values

TypeScript
type EnumValues = {  UNSPECIFIED: DocumentFlavor.UNSPECIFIED  TRADITIONAL: DocumentFlavor.TRADITIONAL  MODERN: DocumentFlavor.MODERN  /** DrawingML text semantics for host-prepared shape and slide text models. */  DRAWINGML: DocumentFlavor.DRAWINGML}

Package: @univerjs/docs · Type definitions

Enum.SectionType

OOXML-compatible section start types.

Available values

TypeScript
type EnumValues = {  SECTION_TYPE_UNSPECIFIED: SectionType.SECTION_TYPE_UNSPECIFIED  CONTINUOUS: SectionType.CONTINUOUS  NEXT_COLUMN: SectionType.NEXT_COLUMN  NEXT_PAGE: SectionType.NEXT_PAGE  EVEN_PAGE: SectionType.EVEN_PAGE  ODD_PAGE: SectionType.ODD_PAGE}

Package: @univerjs/docs · Type definitions

@univerjs/docs-drawing

Enum.DocsImageRelativeFromH

Represents the horizontal position types used by docs image operations.

Available values

TypeScript
type EnumValues = {  PAGE: ObjectRelativeFromH.PAGE  COLUMN: ObjectRelativeFromH.COLUMN  CHARACTER: ObjectRelativeFromH.CHARACTER  MARGIN: ObjectRelativeFromH.MARGIN  INSIDE_MARGIN: ObjectRelativeFromH.INSIDE_MARGIN  OUTSIDE_MARGIN: ObjectRelativeFromH.OUTSIDE_MARGIN  LEFT_MARGIN: ObjectRelativeFromH.LEFT_MARGIN  RIGHT_MARGIN: ObjectRelativeFromH.RIGHT_MARGIN}

Example

TypeScript
const fDocument = univerAPI.getActiveDocument()const image = fDocument.getImages()[0]if (image) {  const success = image.setPositionH({    relativeFrom: univerAPI.Enum.DocsImageRelativeFromH.MARGIN,    posOffset: 100,  })  console.log(success)}

Package: @univerjs/docs-drawing · Type definitions

Enum.DocsImageRelativeFromV

Represents the vertical position types used by docs image operations.

Available values

TypeScript
type EnumValues = {  PAGE: ObjectRelativeFromV.PAGE  PARAGRAPH: ObjectRelativeFromV.PARAGRAPH  LINE: ObjectRelativeFromV.LINE  MARGIN: ObjectRelativeFromV.MARGIN  TOP_MARGIN: ObjectRelativeFromV.TOP_MARGIN  BOTTOM_MARGIN: ObjectRelativeFromV.BOTTOM_MARGIN  INSIDE_MARGIN: ObjectRelativeFromV.INSIDE_MARGIN  OUTSIDE_MARGIN: ObjectRelativeFromV.OUTSIDE_MARGIN}

Example

TypeScript
const fDocument = univerAPI.getActiveDocument()const image = fDocument.getImages()[0]if (image) {  const success = image.setPositionV({    relativeFrom: univerAPI.Enum.DocsImageRelativeFromV.MARGIN,    posOffset: 100,  })  console.log(success)}

Package: @univerjs/docs-drawing · Type definitions

Enum.TextWrappingStyle

Represents the text wrapping styles used by document drawings, including images and Shapes.

Prefer INLINE, WRAP_SQUARE, or WRAP_TOP_AND_BOTTOM for ordinary document content. BEHIND_TEXT and IN_FRONT_OF_TEXT are overlay styles that do not cause text to reflow. Use this property whenever a Facade signature references TextWrappingStyle.

Available values

TypeScript
type EnumValues = {  /** Places the drawing in the text flow like a character. The drawing occupies layout space and does not overlap surrounding text. Its position is determined by its document range, so floating position settings have no visible effect. */  INLINE: TextWrappingStyle.INLINE  /** Floats the drawing behind document text without causing the text to reflow. Use this style for backgrounds or watermarks. Text can overlap the drawing, so ensure that it remains readable. */  BEHIND_TEXT: TextWrappingStyle.BEHIND_TEXT  /** Floats the drawing in front of document text without causing the text to reflow. The drawing can cover overlapping text. Use this style only when an overlay is intentional. */  IN_FRONT_OF_TEXT: TextWrappingStyle.IN_FRONT_OF_TEXT  /** Floats the drawing and wraps text around its rectangular bounds. Use this style for images that should appear beside body text, such as portraits or illustrations. */  WRAP_SQUARE: TextWrappingStyle.WRAP_SQUARE  /** Floats the drawing in a horizontal band, with text only above and below it. Use this style for wide figures or standalone illustrations that should not have text beside them. */  WRAP_TOP_AND_BOTTOM: TextWrappingStyle.WRAP_TOP_AND_BOTTOM}

Example

TypeScript
const fDocument = univerAPI.getActiveDocument()const image = await fDocument.insertImage({  source: 'https://avatars.githubusercontent.com/u/61444807?s=48&v=4',  imageSourceType: univerAPI.Enum.ImageSourceType.URL,  width: 320,  // Float the image and wrap body text around its rectangular bounds.  wrappingStyle: univerAPI.Enum.TextWrappingStyle.WRAP_SQUARE,  textRange: {    startOffset: 30,  },})console.log(image)

Package: @univerjs/docs-drawing · Type definitions

@univerjs/sheets

Enum.RangePermissionPoint

Range permission points.

Available values

TypeScript
type EnumValues = {  /** Edit permission */  Edit: RangePermissionPoint.Edit  /** View permission */  View: RangePermissionPoint.View  ManageCollaborator: RangePermissionPoint.ManageCollaborator  Delete: RangePermissionPoint.Delete}

Package: @univerjs/sheets · Type definitions

Enum.SheetSkeletonChangeType

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

Available values

TypeScript
type EnumValues = {  SET_WORKSHEET_ROW_HEIGHT: SheetSkeletonChangeType.SET_WORKSHEET_ROW_HEIGHT  SET_WORKSHEET_ROW_IS_AUTO_HEIGHT: SheetSkeletonChangeType.SET_WORKSHEET_ROW_IS_AUTO_HEIGHT  SET_WORKSHEET_ROW_AUTO_HEIGHT: SheetSkeletonChangeType.SET_WORKSHEET_ROW_AUTO_HEIGHT  SET_WORKSHEET_COL_WIDTH: SheetSkeletonChangeType.SET_WORKSHEET_COL_WIDTH  SET_WORKSHEET_ACTIVE: SheetSkeletonChangeType.SET_WORKSHEET_ACTIVE  MOVE_ROWS: SheetSkeletonChangeType.MOVE_ROWS  MOVE_COLUMNS: SheetSkeletonChangeType.MOVE_COLUMNS  SET_COL_HIDDEN: SheetSkeletonChangeType.SET_COL_HIDDEN  SET_COL_VISIBLE: SheetSkeletonChangeType.SET_COL_VISIBLE  SET_ROW_HIDDEN: SheetSkeletonChangeType.SET_ROW_HIDDEN  SET_ROW_VISIBLE: SheetSkeletonChangeType.SET_ROW_VISIBLE  INSERT_COL: SheetSkeletonChangeType.INSERT_COL  INSERT_ROW: SheetSkeletonChangeType.INSERT_ROW  REMOVE_COL: SheetSkeletonChangeType.REMOVE_COL  REMOVE_ROW: SheetSkeletonChangeType.REMOVE_ROW  TOGGLE_GRIDLINES: SheetSkeletonChangeType.TOGGLE_GRIDLINES  SET_GRIDLINES_COLOR: SheetSkeletonChangeType.SET_GRIDLINES_COLOR}

Package: @univerjs/sheets · Type definitions

Enum.SheetValueChangeType

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.

Available values

TypeScript
type EnumValues = {  SET_RANGE_VALUES: SheetValueChangeType.SET_RANGE_VALUES  MOVE_RANGE: SheetValueChangeType.MOVE_RANGE  REMOVE_WORKSHEET_MERGE: SheetValueChangeType.REMOVE_WORKSHEET_MERGE  ADD_WORKSHEET_MERGE: SheetValueChangeType.ADD_WORKSHEET_MERGE  REORDER_RANGE: SheetValueChangeType.REORDER_RANGE  SET_WORKSHEET_DEFAULT_STYLE: SheetValueChangeType.SET_WORKSHEET_DEFAULT_STYLE  SET_ROW_DATA: SheetValueChangeType.SET_ROW_DATA  SET_COL_DATA: SheetValueChangeType.SET_COL_DATA  SET_WORKSHEET_RANGE_THEME_STYLE: SheetValueChangeType.SET_WORKSHEET_RANGE_THEME_STYLE  DELETE_WORKSHEET_RANGE_THEME_STYLE: SheetValueChangeType.DELETE_WORKSHEET_RANGE_THEME_STYLE}

Package: @univerjs/sheets · Type definitions

Enum.SplitDelimiterType

Split delimiter types.

Available values

TypeScript
type EnumValues = {  /** The tab character */  Tab: SplitDelimiterEnum.Tab  /** The comma character */  Comma: SplitDelimiterEnum.Comma  /** The semicolon character */  Semicolon: SplitDelimiterEnum.Semicolon  /** The space character */  Space: SplitDelimiterEnum.Space  /** The custom delimiter */  Custom: SplitDelimiterEnum.Custom}

Package: @univerjs/sheets · Type definitions

Enum.UnitRole

Unit roles.

Available values

TypeScript
type EnumValues = {  Reader: UnitRole.Reader  Editor: UnitRole.Editor  Owner: UnitRole.Owner}

Package: @univerjs/sheets · Type definitions

Enum.WorkbookPermissionPoint

Workbook permission points.

Available values

TypeScript
type EnumValues = {  /** Edit permission */  Edit: WorkbookPermissionPoint.Edit  /** View permission */  View: WorkbookPermissionPoint.View  /** Print permission */  Print: WorkbookPermissionPoint.Print  /** Export permission */  Export: WorkbookPermissionPoint.Export  /** Share permission */  Share: WorkbookPermissionPoint.Share  /** Copy content permission */  CopyContent: WorkbookPermissionPoint.CopyContent  /** Duplicate file permission */  DuplicateFile: WorkbookPermissionPoint.DuplicateFile  /** Comment permission */  Comment: WorkbookPermissionPoint.Comment  /** Manage collaborators permission */  ManageCollaborator: WorkbookPermissionPoint.ManageCollaborator  /** Create sheet permission */  CreateSheet: WorkbookPermissionPoint.CreateSheet  /** Delete sheet permission */  DeleteSheet: WorkbookPermissionPoint.DeleteSheet  /** Rename sheet permission */  RenameSheet: WorkbookPermissionPoint.RenameSheet  /** Move sheet permission */  MoveSheet: WorkbookPermissionPoint.MoveSheet  /** Hide sheet permission */  HideSheet: WorkbookPermissionPoint.HideSheet  /** View history permission */  ViewHistory: WorkbookPermissionPoint.ViewHistory  /** Recover history permission */  RecoverHistory: WorkbookPermissionPoint.RecoverHistory  /** Create protection permission */  CreateProtection: WorkbookPermissionPoint.CreateProtection  /** Insert row permission */  InsertRow: WorkbookPermissionPoint.InsertRow  /** Insert column permission */  InsertColumn: WorkbookPermissionPoint.InsertColumn  /** Delete row permission */  DeleteRow: WorkbookPermissionPoint.DeleteRow  /** Delete column permission */  DeleteColumn: WorkbookPermissionPoint.DeleteColumn  /** Copy sheet permission */  CopySheet: WorkbookPermissionPoint.CopySheet}

Package: @univerjs/sheets · Type definitions

Enum.WorksheetPermissionPoint

Worksheet permission points.

Available values

TypeScript
type EnumValues = {  /** Edit permission */  Edit: WorksheetPermissionPoint.Edit  /** View permission */  View: WorksheetPermissionPoint.View  /** Copy permission */  Copy: WorksheetPermissionPoint.Copy  /** Set cell value permission */  SetCellValue: WorksheetPermissionPoint.SetCellValue  /** Set cell style permission */  SetCellStyle: WorksheetPermissionPoint.SetCellStyle  /** Set row style permission */  SetRowStyle: WorksheetPermissionPoint.SetRowStyle  /** Set column style permission */  SetColumnStyle: WorksheetPermissionPoint.SetColumnStyle  /** Insert row permission */  InsertRow: WorksheetPermissionPoint.InsertRow  /** Insert column permission */  InsertColumn: WorksheetPermissionPoint.InsertColumn  /** Delete row permission */  DeleteRow: WorksheetPermissionPoint.DeleteRow  /** Delete column permission */  DeleteColumn: WorksheetPermissionPoint.DeleteColumn  /** Sort permission */  Sort: WorksheetPermissionPoint.Sort  /** Filter permission */  Filter: WorksheetPermissionPoint.Filter  /** Pivot table permission */  PivotTable: WorksheetPermissionPoint.PivotTable  /** Insert hyperlink permission */  InsertHyperlink: WorksheetPermissionPoint.InsertHyperlink  /** Edit extra object permission */  EditExtraObject: WorksheetPermissionPoint.EditExtraObject  /** Manage collaborators permission */  ManageCollaborator: WorksheetPermissionPoint.ManageCollaborator  /** Delete protection permission */  DeleteProtection: WorksheetPermissionPoint.DeleteProtection  /** Select protected cells permission */  SelectProtectedCells: WorksheetPermissionPoint.SelectProtectedCells  /** Select unprotected cells permission */  SelectUnProtectedCells: WorksheetPermissionPoint.SelectUnProtectedCells}

Package: @univerjs/sheets · Type definitions

@univerjs/sheets-conditional-formatting

Enum.ConditionFormatIconSetTypeEnum

Conditional formatting icon set type

Available values

TypeScript
type EnumValues = {  threeArrows: IIconSetType.threeArrows  threeArrowsGray: IIconSetType.threeArrowsGray  fourArrows: IIconSetType.fourArrows  fourArrowsGray: IIconSetType.fourArrowsGray  fiveArrows: IIconSetType.fiveArrows  fiveArrowsGray: IIconSetType.fiveArrowsGray  threeTriangles: IIconSetType.threeTriangles  threeTrafficLights1: IIconSetType.threeTrafficLights1  threeSigns: IIconSetType.threeSigns  threeTrafficLights2: IIconSetType.threeTrafficLights2  fourRedToBlack: IIconSetType.fourRedToBlack  fourTrafficLights: IIconSetType.fourTrafficLights  threeSymbols: IIconSetType.threeSymbols  threeSymbols2: IIconSetType.threeSymbols2  threeFlags: IIconSetType.threeFlags  fourRating: IIconSetType.fourRating  fiveRating: IIconSetType.fiveRating  fiveQuarters: IIconSetType.fiveQuarters  fiveFelling: IIconSetType.fiveFelling  fiveBoxes: IIconSetType.fiveBoxes  threeStars: IIconSetType.threeStars  empty: IIconSetType.empty}

Package: @univerjs/sheets-conditional-formatting · Type definitions

Enum.ConditionFormatNumberOperatorEnum

Conditional formatting number operator

Available values

TypeScript
type EnumValues = {  greaterThan: CFNumberOperator.greaterThan  greaterThanOrEqual: CFNumberOperator.greaterThanOrEqual  lessThan: CFNumberOperator.lessThan  lessThanOrEqual: CFNumberOperator.lessThanOrEqual  notBetween: CFNumberOperator.notBetween  between: CFNumberOperator.between  equal: CFNumberOperator.equal  notEqual: CFNumberOperator.notEqual}

Package: @univerjs/sheets-conditional-formatting · Type definitions

Enum.ConditionFormatTimePeriodOperatorEnum

Conditional formatting time period operator

Available values

TypeScript
type EnumValues = {  today: CFTimePeriodOperator.today  yesterday: CFTimePeriodOperator.yesterday  tomorrow: CFTimePeriodOperator.tomorrow  last7Days: CFTimePeriodOperator.last7Days  thisMonth: CFTimePeriodOperator.thisMonth  lastMonth: CFTimePeriodOperator.lastMonth  nextMonth: CFTimePeriodOperator.nextMonth  thisWeek: CFTimePeriodOperator.thisWeek  lastWeek: CFTimePeriodOperator.lastWeek  nextWeek: CFTimePeriodOperator.nextWeek}

Package: @univerjs/sheets-conditional-formatting · Type definitions

Enum.ConditionFormatValueTypeEnum

Conditional formatting value type

Available values

TypeScript
type EnumValues = {  num: CFValueType.num  min: CFValueType.min  max: CFValueType.max  percent: CFValueType.percent  percentile: CFValueType.percentile  formula: CFValueType.formula}

Package: @univerjs/sheets-conditional-formatting · Type definitions

@univerjs/sheets-drawing

Enum.DrawingType

Please refer to DrawingTypeEnum.

Available values

TypeScript
type EnumValues = {  /** Unrecognized drawing type, requires user to determine */  UNRECOGNIZED: DrawingTypeEnum.UNRECOGNIZED  /** Image */  DRAWING_IMAGE: DrawingTypeEnum.DRAWING_IMAGE  /** Shape, similar to shapes in Office, including circles, rectangles, lines, etc. */  DRAWING_SHAPE: DrawingTypeEnum.DRAWING_SHAPE  /** Chart */  DRAWING_CHART: DrawingTypeEnum.DRAWING_CHART  /** Table */  DRAWING_TABLE: DrawingTypeEnum.DRAWING_TABLE  /** SmartArt, similar to SmartArt in Office */  DRAWING_SMART_ART: DrawingTypeEnum.DRAWING_SMART_ART  /** Video */  DRAWING_VIDEO: DrawingTypeEnum.DRAWING_VIDEO  /** Drawing group */  DRAWING_GROUP: DrawingTypeEnum.DRAWING_GROUP  /** Univer object, allows inserting images, tables, documents, slides as floating objects into the document */  DRAWING_UNIT: DrawingTypeEnum.DRAWING_UNIT  /** Dom element, allows inserting HTML elements as floating objects into the document */  DRAWING_DOM: DrawingTypeEnum.DRAWING_DOM  /** Block element, allows host products to place embeddable unit-backed blocks as drawing objects. */  DRAWING_BLOCK: DrawingTypeEnum.DRAWING_BLOCK  /** Spreadsheet Slicer control. */  DRAWING_SLICER: DrawingTypeEnum.DRAWING_SLICER  /** Spreadsheet Timeline control. */  DRAWING_TIMELINE: DrawingTypeEnum.DRAWING_TIMELINE}

Package: @univerjs/sheets-drawing · Type definitions

Enum.SheetDrawingAnchorType

Please refer to SheetDrawingAnchorType.

Available values

TypeScript
type EnumValues = {  /** Only the position of the drawing follows the cell changes. When rows or columns are inserted or deleted, the position of the drawing changes, but the size remains the same. */  Position: SheetDrawingAnchorType.Position  /** The size and position of the drawing follow the cell changes. When rows or columns are inserted or deleted, the size and position of the drawing change accordingly. */  Both: SheetDrawingAnchorType.Both  /** The size and position of the drawing do not follow the cell changes. When rows or columns are inserted or deleted, the position and size of the drawing remain unchanged. */  None: SheetDrawingAnchorType.None}

Package: @univerjs/sheets-drawing · Type definitions

@univerjs/sheets-filter

Enum.CustomFilterOperator

Please refer to CustomFilterOperator.

Available values

TypeScript
type EnumValues = {  /** "EQUAL" operator. */  EQUAL: CustomFilterOperator.EQUAL  /** "GREATER_THAN" operator. */  GREATER_THAN: CustomFilterOperator.GREATER_THAN  /** "GREATER_THAN_OR_EQUAL" operator. */  GREATER_THAN_OR_EQUAL: CustomFilterOperator.GREATER_THAN_OR_EQUAL  /** "LESS_THAN" operator. */  LESS_THAN: CustomFilterOperator.LESS_THAN  /** "LESS_THAN_OR_EQUAL" operator. */  LESS_THAN_OR_EQUAL: CustomFilterOperator.LESS_THAN_OR_EQUAL  /** "NOT_EQUALS" operator. */  NOT_EQUALS: CustomFilterOperator.NOT_EQUALS}

Package: @univerjs/sheets-filter · Type definitions

@univerjs/sheets-formula

Enum.CalculationMode

Define the calculation mode during initialization

Available values

TypeScript
type EnumValues = {  /** Force calculation of all formulas */  FORCED: CalculationMode.FORCED  /** Partial calculation, only cells with formulas but no v values are calculated */  WHEN_EMPTY: CalculationMode.WHEN_EMPTY  /** All formulas are not calculated */  NO_CALCULATION: CalculationMode.NO_CALCULATION}

Package: @univerjs/sheets-formula · Type definitions

@univerjs/sheets-table

Enum.TableColumnFilterTypeEnum

Filter kinds available for table columns.

Available values

TypeScript
type EnumValues = {  manual: TableColumnFilterTypeEnum.manual  condition: TableColumnFilterTypeEnum.condition  color: TableColumnFilterTypeEnum.color  record: TableColumnFilterTypeEnum.record}

Package: @univerjs/sheets-table · Type definitions

Enum.TableConditionTypeEnum

Value types used by table condition filters.

Available values

TypeScript
type EnumValues = {  Date: TableConditionTypeEnum.Date  Number: TableConditionTypeEnum.Number  String: TableConditionTypeEnum.String  Logic: TableConditionTypeEnum.Logic}

Package: @univerjs/sheets-table · Type definitions

Enum.TableDateCompareTypeEnum

Comparison operators for date table filters.

Available values

TypeScript
type EnumValues = {  Equal: TableDateCompareTypeEnum.Equal  NotEqual: TableDateCompareTypeEnum.NotEqual  After: TableDateCompareTypeEnum.After  AfterOrEqual: TableDateCompareTypeEnum.AfterOrEqual  Before: TableDateCompareTypeEnum.Before  BeforeOrEqual: TableDateCompareTypeEnum.BeforeOrEqual  Between: TableDateCompareTypeEnum.Between  NotBetween: TableDateCompareTypeEnum.NotBetween  Today: TableDateCompareTypeEnum.Today  Yesterday: TableDateCompareTypeEnum.Yesterday  Tomorrow: TableDateCompareTypeEnum.Tomorrow  ThisWeek: TableDateCompareTypeEnum.ThisWeek  LastWeek: TableDateCompareTypeEnum.LastWeek  NextWeek: TableDateCompareTypeEnum.NextWeek  ThisMonth: TableDateCompareTypeEnum.ThisMonth  LastMonth: TableDateCompareTypeEnum.LastMonth  NextMonth: TableDateCompareTypeEnum.NextMonth  ThisQuarter: TableDateCompareTypeEnum.ThisQuarter  LastQuarter: TableDateCompareTypeEnum.LastQuarter  NextQuarter: TableDateCompareTypeEnum.NextQuarter  ThisYear: TableDateCompareTypeEnum.ThisYear  LastYear: TableDateCompareTypeEnum.LastYear  NextYear: TableDateCompareTypeEnum.NextYear  YearToDate: TableDateCompareTypeEnum.YearToDate  Quarter: TableDateCompareTypeEnum.Quarter  Month: TableDateCompareTypeEnum.Month  M1: TableDateCompareTypeEnum.M1  M2: TableDateCompareTypeEnum.M2  M3: TableDateCompareTypeEnum.M3  M4: TableDateCompareTypeEnum.M4  M5: TableDateCompareTypeEnum.M5  M6: TableDateCompareTypeEnum.M6  M7: TableDateCompareTypeEnum.M7  M8: TableDateCompareTypeEnum.M8  M9: TableDateCompareTypeEnum.M9  M10: TableDateCompareTypeEnum.M10  M11: TableDateCompareTypeEnum.M11  M12: TableDateCompareTypeEnum.M12  Q1: TableDateCompareTypeEnum.Q1  Q2: TableDateCompareTypeEnum.Q2  Q3: TableDateCompareTypeEnum.Q3  Q4: TableDateCompareTypeEnum.Q4}

Package: @univerjs/sheets-table · Type definitions

Enum.TableNumberCompareTypeEnum

Comparison operators for numeric table filters.

Available values

TypeScript
type EnumValues = {  Equal: TableNumberCompareTypeEnum.Equal  NotEqual: TableNumberCompareTypeEnum.NotEqual  GreaterThan: TableNumberCompareTypeEnum.GreaterThan  GreaterThanOrEqual: TableNumberCompareTypeEnum.GreaterThanOrEqual  LessThan: TableNumberCompareTypeEnum.LessThan  LessThanOrEqual: TableNumberCompareTypeEnum.LessThanOrEqual  Between: TableNumberCompareTypeEnum.Between  NotBetween: TableNumberCompareTypeEnum.NotBetween  Above: TableNumberCompareTypeEnum.Above  Below: TableNumberCompareTypeEnum.Below  TopN: TableNumberCompareTypeEnum.TopN}

Package: @univerjs/sheets-table · Type definitions

Enum.TableStringCompareTypeEnum

Comparison operators for text table filters.

Available values

TypeScript
type EnumValues = {  Equal: TableStringCompareTypeEnum.Equal  NotEqual: TableStringCompareTypeEnum.NotEqual  Contains: TableStringCompareTypeEnum.Contains  NotContains: TableStringCompareTypeEnum.NotContains  StartsWith: TableStringCompareTypeEnum.StartsWith  EndsWith: TableStringCompareTypeEnum.EndsWith}

Package: @univerjs/sheets-table · Type definitions

@univerjs/sheets-ui

Enum.SHEET_VIEWPORT_KEY

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.

Available values

TypeScript
type EnumValues = {  VIEW_MAIN: SHEET_VIEWPORT_KEY.VIEW_MAIN  VIEW_MAIN_LEFT_TOP: SHEET_VIEWPORT_KEY.VIEW_MAIN_LEFT_TOP  VIEW_MAIN_TOP: SHEET_VIEWPORT_KEY.VIEW_MAIN_TOP  VIEW_MAIN_LEFT: SHEET_VIEWPORT_KEY.VIEW_MAIN_LEFT  VIEW_ROW_TOP: SHEET_VIEWPORT_KEY.VIEW_ROW_TOP  VIEW_ROW_BOTTOM: SHEET_VIEWPORT_KEY.VIEW_ROW_BOTTOM  VIEW_COLUMN_LEFT: SHEET_VIEWPORT_KEY.VIEW_COLUMN_LEFT  VIEW_COLUMN_RIGHT: SHEET_VIEWPORT_KEY.VIEW_COLUMN_RIGHT  VIEW_LEFT_TOP: SHEET_VIEWPORT_KEY.VIEW_LEFT_TOP}

Package: @univerjs/sheets-ui · Type definitions

@univerjs/thread-comment

Enum.ThreadCommentAnchorKind

Stable product anchor kinds used when creating or filtering comments.

Available values

TypeScript
type EnumValues = {  /** A cell comment managed by the Sheets range Facade. */  SHEET_CELL: ThreadCommentAnchorKind.SHEET_CELL  /** A Sheet image, chart, Shape, or other drawing element. */  SHEET_DRAWING: ThreadCommentAnchorKind.SHEET_DRAWING  /** A fixed text range comment managed by the Docs text range Facade. */  DOC_TEXT_RANGE: ThreadCommentAnchorKind.DOC_TEXT_RANGE  /** A Document image, chart, Shape, or other drawing element. */  DOC_DRAWING: ThreadCommentAnchorKind.DOC_DRAWING  /** A Slide page element identified by a stable element ID. */  SLIDE_ELEMENT: ThreadCommentAnchorKind.SLIDE_ELEMENT  /** A free position normalized to the Slide page size. */  SLIDE_POSITION: ThreadCommentAnchorKind.SLIDE_POSITION  /** A Board element identified by a stable element ID. */  BOARD_ELEMENT: ThreadCommentAnchorKind.BOARD_ELEMENT  /** A free position in Board world coordinates. */  BOARD_POSITION: ThreadCommentAnchorKind.BOARD_POSITION  /** A Base record identified by stable table and record IDs. */  BASE_RECORD: ThreadCommentAnchorKind.BASE_RECORD}

Example

TypeScript
const kind = univerAPI.Enum.ThreadCommentAnchorKind.BOARD_ELEMENTconst comments = univerAPI.getComments({ anchorKinds: [kind] })

Package: @univerjs/thread-comment · Type definitions

@univerjs/ui

Enum.BuiltInUIPart

Built-in UI parts.

Available values

TypeScript
type EnumValues = {  GLOBAL: BuiltInUIPart.GLOBAL  HEADER: BuiltInUIPart.HEADER  HEADER_MENU: BuiltInUIPart.HEADER_MENU  CONTENT: BuiltInUIPart.CONTENT  FOOTER: BuiltInUIPart.FOOTER  LEFT_SIDEBAR: BuiltInUIPart.LEFT_SIDEBAR  FLOATING: BuiltInUIPart.FLOATING  UNIT: BuiltInUIPart.UNIT  CUSTOM_HEADER: BuiltInUIPart.CUSTOM_HEADER  CUSTOM_LEFT: BuiltInUIPart.CUSTOM_LEFT  CUSTOM_RIGHT: BuiltInUIPart.CUSTOM_RIGHT  CUSTOM_FOOTER: BuiltInUIPart.CUSTOM_FOOTER  TOOLBAR: BuiltInUIPart.TOOLBAR}

Package: @univerjs/ui · Type definitions

Enum.KeyCode

Key codes.

Available values

TypeScript
type EnumValues = {  UNKNOWN: KeyCode.UNKNOWN  BACKSPACE: KeyCode.BACKSPACE  TAB: KeyCode.TAB  ENTER: KeyCode.ENTER  SHIFT: KeyCode.SHIFT  CTRL: KeyCode.CTRL  ESC: KeyCode.ESC  SPACE: KeyCode.SPACE  END: KeyCode.END  HOME: KeyCode.HOME  ARROW_LEFT: KeyCode.ARROW_LEFT  ARROW_UP: KeyCode.ARROW_UP  ARROW_RIGHT: KeyCode.ARROW_RIGHT  ARROW_DOWN: KeyCode.ARROW_DOWN  INSERT: KeyCode.INSERT  DELETE: KeyCode.DELETE  Digit0: KeyCode.Digit0  Digit1: KeyCode.Digit1  Digit2: KeyCode.Digit2  Digit3: KeyCode.Digit3  Digit4: KeyCode.Digit4  Digit5: KeyCode.Digit5  Digit6: KeyCode.Digit6  Digit7: KeyCode.Digit7  Digit8: KeyCode.Digit8  Digit9: KeyCode.Digit9  A: KeyCode.A  B: KeyCode.B  C: KeyCode.C  D: KeyCode.D  E: KeyCode.E  F: KeyCode.F  G: KeyCode.G  H: KeyCode.H  I: KeyCode.I  J: KeyCode.J  K: KeyCode.K  L: KeyCode.L  M: KeyCode.M  N: KeyCode.N  O: KeyCode.O  P: KeyCode.P  Q: KeyCode.Q  R: KeyCode.R  S: KeyCode.S  T: KeyCode.T  U: KeyCode.U  V: KeyCode.V  W: KeyCode.W  X: KeyCode.X  Y: KeyCode.Y  Z: KeyCode.Z  F1: KeyCode.F1  F2: KeyCode.F2  F3: KeyCode.F3  F4: KeyCode.F4  F5: KeyCode.F5  F6: KeyCode.F6  F7: KeyCode.F7  F8: KeyCode.F8  F9: KeyCode.F9  F10: KeyCode.F10  F11: KeyCode.F11  F12: KeyCode.F12  NUM_LOCK: KeyCode.NUM_LOCK  SCROLL_LOCK: KeyCode.SCROLL_LOCK  EQUAL: KeyCode.EQUAL  COMMA: KeyCode.COMMA  MINUS: KeyCode.MINUS  PERIOD: KeyCode.PERIOD  BACK_SLASH: KeyCode.BACK_SLASH}

Package: @univerjs/ui · Type definitions

@univerjs/watermark

Enum.IWatermarkTypeEnum

Text and image watermark types accepted by addWatermark.

Available values

TypeScript
type EnumValues = {  UserInfo: IWatermarkTypeEnum.UserInfo  Text: IWatermarkTypeEnum.Text  Image: IWatermarkTypeEnum.Image}

Package: @univerjs/watermark · Type definitions

How is this guide?

© 2026 DreamNum Co., Ltd.