Univer Facade API

https://reference.univer.ai/en-US/
Admin
Univer Facade API is a simplified and easier-to-use interface for Univer that provides instance...
Tokens:315,048
Snippets:2,279
Trust Score:7.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### Facade API Installation using Presets

Source: https://reference.univer.ai/en-US

Instructions on how to install the Facade API using npm, pnpm, yarn, or bun, along with an example of creating a Univer instance and accessing the Facade API.

```APIDOC
## Installation using `Presets`

Developers can install using `Presets` or manually combine installations.

### Install using `Presets`

If you use Presets, it will automatically introduce the Facade API of the included functions and return a corresponding Facade API instance univerAPI when you create a Univer instance, which can be used directly.

```bash
npm install @univerjs/presets
```

```bash
pnpm add @univerjs/presets
```

```bash
yarn add @univerjs/presets
```

```bash
bun add @univerjs/presets
```

Here is an example of how to get the `Facade API` instance:

```typescript
// main.ts
import { createUniver, defaultTheme, LocaleType, merge } from '@univerjs/presets'
import { UniverSheetsCorePreset } from '@univerjs/presets/preset-sheets-core'
import UniverPresetSheetsCoreZhCN from '@univerjs/presets/preset-sheets-core/locales/en-US'

import '@univerjs/presets/lib/styles/preset-sheets-core.css'

const { univer, univerAPI } = createUniver({
  locale: LocaleType.ZH_CN,
  locales: {
    [LocaleType.ZH_CN]: merge(
      {},
      UniverPresetSheetsCoreZhCN,
    ),
  },
  theme: defaultTheme,
  presets: [
    UniverSheetsCorePreset({
      container: 'app',
    }),
  ],
})

univerAPI.createWorkbook({ name: 'Test Sheet' })
```
```

--------------------------------

### Install Facade API via Presets

Source: https://reference.univer.ai/en-US

Commands to install the @univerjs/presets package using various package managers.

```bash
npm install @univerjs/presets
```

```bash
pnpm add @univerjs/presets
```

```bash
yarn add @univerjs/presets
```

```bash
bun add @univerjs/presets
```

--------------------------------

### Facade API Piecemeal Installation

Source: https://reference.univer.ai/en-US

Instructions for piecemeal installation of the Facade API by importing individual plugin facade implementations.

```APIDOC
## Piecemeal Installation

The implementation of the Facade API has been distributed to various plugins and mounted on the global Facade API root object. This means that for plugins that provide a Facade API, you need to introduce their corresponding Facade API implementation.

We will introduce whether each feature provides a Facade API implementation on its page. You need to introduce their corresponding Facade API according to the features you actually use:

### Import

```typescript
// main.ts
import '@univerjs/sheets/facade'
import '@univerjs/ui/facade'
import '@univerjs/docs-ui/facade'
import '@univerjs/sheets-ui/facade'

import '@univerjs/sheets-data-validation/facade'
import '@univerjs/engine-formula/facade'
import '@univerjs/sheets-filter/facade'
import '@univerjs/sheets-formula/facade'
import '@univerjs/sheets-numfmt/facade'
import '@univerjs/sheets-hyper-link-ui/facade'
```

The way to introduce Facade APIs with advanced features is now the same as the way to introduce open-source features, for example:

```typescript
import '@univerjs-pro/sheets-pivot/facade'
import '@univerjs-pro/exchange-client/facade'
```
```

--------------------------------

### Start Presenting

Source: https://reference.univer.ai/en-US/classes/FUniver

Initiates the presentation mode.

```typescript
startPresenting(): void
```

--------------------------------

### Migration Example: FPermission to New API

Source: https://reference.univer.ai/en-US/classes/FPermission

This example demonstrates how to migrate from the old FPermission API to the new permission API for protecting ranges.

```APIDOC
### Migration Examples:

```javascript
// Old API
const permission = workbook.getPermission();
await permission.addRangeBaseProtection(unitId, subUnitId, ranges);
 
// New API
const worksheet = workbook.getSheetBySheetId(subUnitId);
const permission = worksheet.getWorksheetPermission();
await permission.protectRanges([{ ranges, options: { name: 'Protected', allowEdit: false } }]);
```
```

--------------------------------

### Example: Set Document Selection

Source: https://reference.univer.ai/en-US/classes/FDocument

An example demonstrating how to set the selection in a document to span from character offset 10 to 20.

```javascript
document.setSelection(10, 20);
```

--------------------------------

### Start Following

Source: https://reference.univer.ai/en-US/classes/FUniver

Connects to the server to begin following operations.

```typescript
startFollowing(): void
```

--------------------------------

### Example Formula Expression Tree Output

Source: https://reference.univer.ai/en-US/classes/FFormula

Simplified example output of a formula expression tree, illustrating the hierarchical structure of parsed formulas.

```json
{
  "value": "let(x,sum(A1,B1,A1:B10),y,offset(A1:B10,0,1),sum(x,y)+x)+1",
  "children": [
    {
      "value": "let(x,sum(A1,B1,A1:B10),y,offset(A1:B10,0,1),sum(x,y)+x)",
      "children": [
        {
          "value": "sum(A1,B1,A1:B10)",
          "children": [
            {
              "value": "A1:B10",
              "children": []
            }
          ]
        },
        {
          "value": "offset(A1:B10,0,1)",
          "children": [
            {
              "value": "A1:B10",
              "children": []
            }
          ]
        }
      ]
    }
  ]
}
```

--------------------------------

### GET /

Source: https://reference.univer.ai/en-US/classes/FNetwork

Sends a GET request to the specified URL.

```APIDOC
## GET /

### Description
Send a GET request to the server.

### Method
GET

### Parameters
#### Path Parameters
- **url** (string) - Required - The requested URL

#### Query Parameters
- **params** (IRequestParams) - Optional - Query parameters

### Response
- **Promise<HTTPResponse<...>>** - Network response
```

--------------------------------

### Chart Configuration Enums and Examples

Source: https://reference.univer.ai/en-US/classes/FEnum

Enumerations and code examples for configuring chart properties such as radar shape and legend selection mode.

```APIDOC
## Chart Configuration Enums and Examples

### RadarShape
Represents the shape of the radar chart.

**Example**
```javascript
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();

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

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

**Example**
```javascript
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();

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

--------------------------------

### FEnum get() Method

Source: https://reference.univer.ai/en-US/classes/FEnum

Retrieves the FEnum instance.

```APIDOC
## Methods
### get()

#### Description
Retrieves the FEnum instance.

#### Method
GET

#### Endpoint
`/api/fenum/get`

#### Parameters
#### Query Parameters
- **None**

#### Request Example
```json
{
  "example": "const fEnum = univerAPI.FEnum.get();"
}
```

#### Response
#### Success Response (200)
- **fEnum** (FEnum) - The FEnum instance.

#### Response Example
```json
{
  "example": "// FEnum instance details..."
}
```
```

--------------------------------

### getRow()

Source: https://reference.univer.ai/en-US/classes/FRange

Gets the starting row index of the range.

```APIDOC
## getRow()

### Description
Gets the starting row index of the range. Index starts at 0.

### Returns
- **number** - The starting row index of the range.
```

--------------------------------

### getColumn()

Source: https://reference.univer.ai/en-US/classes/FRange

Gets the starting column index of the range.

```APIDOC
## getColumn()

### Description
Gets the starting column index of the range. Index starts at 0.

### Response
- **number** - The starting column index of the range.

### Request Example
```javascript
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1:B2');
console.log(fRange.getColumn()); // 0
```
```

--------------------------------

### Get Starting Row Index with getRow

Source: https://reference.univer.ai/en-US/classes/FRange

Determine the starting row index of a specified range. The index is zero-based, meaning the first row is 0.

```typescript
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1:B2');
console.log(fRange.getRow()); // 0
```

--------------------------------

### startFollowing

Source: https://reference.univer.ai/en-US/classes/FUniver

Connects to the server and initiates the following state.

```APIDOC
## POST /api/startFollowing

### Description
Connects to the server and starts following.

### Method
POST

### Endpoint
/api/startFollowing

### Parameters
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **void** - This method does not return any value.
```

--------------------------------

### Get Column Index

Source: https://reference.univer.ai/en-US/classes/FRange

Retrieves the starting column index (0-based) of a given range.

```typescript
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1:B2');
console.log(fRange.getColumn()); // 0
```

--------------------------------

### Get Range by Row and Column Indices

Source: https://reference.univer.ai/en-US/classes/FWorksheet

Use this method to get a range object by specifying the starting row and column, along with the number of rows and columns. Ensure indices are zero-based.

```javascript
const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
// Get range for cells A1:C3
const range = fWorksheet.getRange(0, 0, 3, 3);
console.log(range);
```

--------------------------------

### Get User Manager

Source: https://reference.univer.ai/en-US/classes/FUniver

Retrieves the user manager instance.

```APIDOC
## getUserManager()

### Description
Retrieves the user manager instance.

### Method
GET

### Endpoint
N/A (Method call)

### Returns
- **FUserManager** - The user manager object.
```

--------------------------------

### getColumnWidth(columnPosition)

Source: https://reference.univer.ai/en-US/classes/FWorksheet

Gets the width in pixels of a specified column. The column index starts at 0.

```APIDOC
## getColumnWidth(columnPosition)

### Description
Gets the width in pixels of the given column.

### Method
GET

### Endpoint
`/api/worksheet/columns/{columnPosition}/width`

### Parameters
#### Path Parameters
- **columnPosition** (number) - Required - The position of the column to examine. Index starts at 0.

#### Returns
`number` - The width of the column in pixels.

### Request Example
```javascript
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
fWorksheet.getRange('A1').setValue('Whenever it is a damp, drizzly November in my soul...');
fWorksheet.autoResizeColumn(0);
console.log(fWorksheet.getColumnWidth(0));
```
```

--------------------------------

### startPresenting

Source: https://reference.univer.ai/en-US/classes/FUniver

Initiates the presenting state.

```APIDOC
## POST /api/startPresenting

### Description
Starts presenting.

### Method
POST

### Endpoint
/api/startPresenting

### Parameters
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **void** - This method does not return any value.
```

--------------------------------

### Get last row index

Source: https://reference.univer.ai/en-US/classes/FRange

Returns the ending row index of the range, starting from 0.

```typescript
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1:B2');
console.log(fRange.getLastRow()); // 1
```

--------------------------------

### Initialize Univer with Presets

Source: https://reference.univer.ai/en-US

Example of creating a Univer instance and retrieving the univerAPI instance using Presets.

```typescript
import { createUniver, defaultTheme, LocaleType, merge } from '@univerjs/presets'
import { UniverSheetsCorePreset } from '@univerjs/presets/preset-sheets-core'
import UniverPresetSheetsCoreZhCN from '@univerjs/presets/preset-sheets-core/locales/en-US'
 
import '@univerjs/presets/lib/styles/preset-sheets-core.css'
 
const { univer, univerAPI } = createUniver({
  locale: LocaleType.ZH_CN,
  locales: {
    [LocaleType.ZH_CN]: merge(
      {},
      UniverPresetSheetsCoreZhCN,
    ),
  },
  theme: defaultTheme,
  presets: [
    UniverSheetsCorePreset({
      container: 'app',
    }),
  ],
})
 
univerAPI.createWorkbook({ name: 'Test Sheet' })
```

--------------------------------

### Get last column index

Source: https://reference.univer.ai/en-US/classes/FRange

Returns the ending column index of the range, starting from 0.

```typescript
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1:B2');
console.log(fRange.getLastColumn()); // 1
```

--------------------------------

### GET /sse

Source: https://reference.univer.ai/en-US/classes/FNetwork

Requests a stream of server-sent events.

```APIDOC
## GET /sse

### Description
Request for a stream of server-sent events. Univer wraps the stream in an Observable.

### Method
GET

### Parameters
#### Path Parameters
- **method** (HTTPRequestMethod) - Required - HTTP request method
- **url** (string) - Required - The requested URL

#### Query Parameters
- **params** (IPostRequestParams) - Optional - Query parameters

### Response
- **Observable<HTTPEvent<...>>** - An observable that emits the network response
```

--------------------------------

### Create and Configure a Filter

Source: https://reference.univer.ai/en-US/classes/FFilter

Demonstrates creating a filter on a range and applying specific column criteria. The example includes logic to handle existing filters by removing them before creating a new one.

```javascript
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
 
// Set some values of the range C1:F10
const fRange = fWorksheet.getRange('C1:F10');
fRange.setValues([
  [1, 2, 3, 4],
  [2, 3, 4, 5],
  [3, 4, 5, 6],
  [4, 5, 6, 7],
  [5, 6, 7, 8],
  [6, 7, 8, 9],
  [7, 8, 9, 10],
  [8, 9, 10, 11],
  [9, 10, 11, 12],
  [10, 11, 12, 13],
]);
 
// Create a filter on the range C1:F10
let fFilter = fRange.createFilter();
 
// If the filter already exists, remove it and create a new one
if (!fFilter) {
  fRange.getFilter().remove();
  fFilter = fRange.createFilter();
}
 
// Set the filter criteria of the column C, filter out the rows that are not 1, 5, 9
const column = fWorksheet.getRange('C:C').getColumn();
fFilter.setColumnFilterCriteria(column, {
  colId: 0,
  filters: {
    filters: ['1', '5', '9'],
  },
});
 
// Clear the filter criteria of all columns after 3 seconds
setTimeout(() => {
  fFilter.removeFilterCriteria();
}, 3000);
```

```javascript
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
 
// Set some values of the range C1:F10
const fRange = fWorksheet.getRange('C1:F10');
fRange.setValues([
  [1, 2, 3, 4],
  [2, 3, 4, 5],
  [3, 4, 5, 6],
  [4, 5, 6, 7],
  [5, 6, 7, 8],
  [6, 7, 8, 9],
  [7, 8, 9, 10],
  [8, 9, 10, 11],
  [9, 10, 11, 12],
  [10, 11, 12, 13],
]);
 
// Create a filter on the range C1:F10
let fFilter = fRange.createFilter();
 
// If the filter already exists, remove it and create a new one
if (!fFilter) {
  fRange.getFilter().remove();
  fFilter = fRange.createFilter();
}
 
// Set the filter criteria of the column C, filter out the rows that are not 1, 5, 9
const column = fWorksheet.getRange('C:C').getColumn();
fFilter.setColumnFilterCriteria(column, {
  colId: 0,
  filters: {
    filters: ['1', '5', '9'],
  },
});
```

--------------------------------

### Get Custom Meta Data

Source: https://reference.univer.ai/en-US/classes/FRange

Retrieves the custom meta data associated with the starting cell of the range.

```typescript
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1:B2');
console.log(fRange.getCustomMetaData());
```

--------------------------------

### Image Builder Initialization and Basic Usage

Source: https://reference.univer.ai/en-US/classes/FOverGridImageBuilder

Demonstrates how to initialize a new image builder, set its source, position, and then build and insert the image into a sheet.

```APIDOC
## Image Builder Initialization and Basic Usage

### Description
Creates a new image builder, sets the image source from a URL, defines its position using column and row, and then builds and inserts the image into the active worksheet.

### Method
`newOverGridImage()` followed by chaining builder methods.

### Endpoint
N/A (Client-side API)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```javascript
// create a new image builder and set image source.
// then build `ISheetImage` and insert it into the sheet, position is start from F6 cell and horizontal offset is 10px.
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const image = await fWorksheet.newOverGridImage()
  .setSource('https://avatars.githubusercontent.com/u/61444807?s=48&v=4', univerAPI.Enum.ImageSourceType.URL)
  .setColumn(5)
  .setRow(5)
  .setColumnOffset(10)
  .buildAsync();
fWorksheet.insertImages([image]);
```

### Response
#### Success Response (200)
N/A (Client-side API, returns built image object)

#### Response Example
N/A
```

--------------------------------

### Get Cell Comment

Source: https://reference.univer.ai/en-US/classes/FRange

Retrieves the thread comment associated with the starting cell of the range. Returns null if no comment exists.

```typescript
const range = univerAPI.getActiveWorkbook()
 .getActiveSheet()
 .getActiveRange();
const comment = range.getComment();
```

--------------------------------

### Get Scroll State

Source: https://reference.univer.ai/en-US/classes/FWorksheet

Retrieves the current scroll state of the active sheet, including scroll offsets and view start positions.

```APIDOC
## GET /api/worksheet/scroll-state

### Description
Get scroll state of the current sheet.

### Method
GET

### Endpoint
/api/worksheet/scroll-state

### Response
#### Success Response (200)
- **IScrollState** (object) - The current scroll state of the sheet, including `offsetX`, `offsetY`, `sheetViewStartColumn`, and `sheetViewStartRow`.

#### Response Example
```json
{
  "sheetViewStartRow": 9,
  "sheetViewStartColumn": 3,
  "offsetX": 0,
  "offsetY": 0
}
```
```

--------------------------------

### Example Usage for xAxisTitle

Source: https://reference.univer.ai/en-US/interfaces/IChartBuildOptions

Demonstrates how to set options for the xAxisTitle using the chart builder.

```APIDOC
### Example

```javascript
chartBuilder.setOptions('xAxisTitle.content', 'xAxis Title text')
.setOptions('xAxisTitle.font', 1)
.setOptions('xAxisTitle.fontSize', 12)
.setOptions('xAxisTitle.fontColor', '#ff0000')
.build();
```
```

--------------------------------

### Facade API Usage

Source: https://reference.univer.ai/en-US

How to wrap a Univer instance with FUniver to get the Facade API instance.

```APIDOC
## Usage

The Facade API is a wrapper for the Univer instance, so you need to wrap this instance with FUniver after creating the Univer instance:

```typescript
import { FUniver } from '@univerjs/core/facade'

const univerAPI = FUniver.newAPI(univer)
```
```

--------------------------------

### Get Range by Coordinates

Source: https://reference.univer.ai/en-US/classes/FWorksheet

Retrieves a range object from the worksheet using starting row and column indices, along with the number of rows and columns.

```APIDOC
## GET /api/worksheet/range

### Description
Retrieves a range object from the worksheet using starting row and column indices, along with the number of rows and columns.

### Method
GET

### Endpoint
/api/worksheet/range

### Parameters
#### Query Parameters
- **row** (number) - Required - The starting row index of the range.
- **column** (number) - Required - The starting column index of the range.
- **numRows** (number) - Required - The number of rows in the range.
- **numColumns** (number) - Required - The number of columns in the range.

### Response
#### Success Response (200)
- **FRange** (object) - A Range object representing the specified range.

#### Response Example
```json
{
  "example": "FRange object"
}
```
```

--------------------------------

### Get Scroll State

Source: https://reference.univer.ai/en-US/classes/FWorksheet

Retrieves the current scroll state of the active worksheet, including offset and starting view positions for rows and columns.

```javascript
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();

// Scroll to cell D10
const fRange = fWorksheet.getRange('D10');
const row = fRange.getRow();
const column = fRange.getColumn();
fWorksheet.scrollToCell(row, column);

// Get scroll state
const scrollState = fWorksheet.getScrollState();
const { offsetX, offsetY, sheetViewStartColumn, sheetViewStartRow } = scrollState;
console.log(scrollState); // sheetViewStartRow: 9, sheetViewStartColumn: 3, offsetX: 0, offsetY: 0
```

--------------------------------

### whenTextStartsWith()

Source: https://reference.univer.ai/en-US/classes/ConditionalFormatHighlightRuleBuilder

Sets the conditional format rule to trigger when the input starts with the specified text.

```APIDOC
## whenTextStartsWith(text)

### Description
Sets the conditional format rule to trigger when the input starts with the given value.

### Parameters
#### Parameters
- **text** (string) - Required - Text to compare against the beginning of the string.

### Returns
- **ConditionalFormatHighlightRuleBuilder** - This builder for chaining.
```

--------------------------------

### Get Sheet Index

Source: https://reference.univer.ai/en-US/classes/FWorksheet

Returns the position of the active sheet within its parent spreadsheet, starting from 0. Useful for determining sheet order.

```javascript
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorkSheet = fWorkbook.getActiveSheet();
// get the position of the active sheet
const position = fWorkSheet.getIndex();
console.log(position);
```

--------------------------------

### whenTextStartsWith()

Source: https://reference.univer.ai/en-US/classes/FConditionalFormattingBuilder

Sets the conditional format rule to trigger when the input starts with the given value.

```APIDOC
## whenTextStartsWith(text)

### Description
Sets the conditional format rule to trigger when the input starts with the given value.

### Parameters
- **text** (string) - Required - Text to compare against the beginning of the string.

### Returns
- **ConditionalFormatHighlightRuleBuilder** - The conditional format highlight rule builder.
```

--------------------------------

### Get Column Width

Source: https://reference.univer.ai/en-US/classes/FWorksheet

Determines the width in pixels of a specified column. This example also demonstrates setting a value and auto-resizing the column first.

```javascript
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();

// Set the long text value in cell A1
const fRange = fWorksheet.getRange('A1');
fRange.setValue('Whenever it is a damp, drizzly November in my soul...');

// Set the column A to a width which fits the text
fWorksheet.autoResizeColumn(0);

// Get the width of the column A
console.log(fWorksheet.getColumnWidth(0));
```

--------------------------------

### getHelpText()

Source: https://reference.univer.ai/en-US/classes/FDataValidation

Gets the help text information, which is used to provide users with guidance and support.

```APIDOC
## getHelpText()

### Description
Gets the help text information, which is used to provide users with guidance and support.

### Returns
- **string** - Returns the help text information. If there is no error message, it returns an undefined value.
```

--------------------------------

### Get Lexer Tree Builder

Source: https://reference.univer.ai/en-US/classes/FFormula

Retrieves the tree builder used for formula strings. No setup is required beyond having an instance of the formula engine.

```typescript
get lexerTreeBuilder(): LexerTreeBuilder
```

--------------------------------

### Configure Data Bar Rule

Source: https://reference.univer.ai/en-US/classes/ConditionalFormatDataBarRuleBuilder

Shows how to initialize a data bar rule using the setDataBar() method with specific min, max, and color configurations.

```javascript
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
 
// Create a conditional formatting rule that adds a data bar to cells with values between -100 and 100 in the range A1:D10.
// positive values are green and negative values are red.
const fRange = fWorksheet.getRange('A1:D10');
const rule = fWorksheet.newConditionalFormattingRule()
  .setDataBar({
    min: { type: 'num', value: -100 },
    max: { type: 'num', value: 100 },
    positiveColor: '#00FF00',
    nativeColor: '#FF0000',
    isShowValue: true
  })
 .setRanges([fRange.getRange()])
.build();
fWorksheet.addConditionalFormattingRule(rule);
```

--------------------------------

### Get Row Custom Metadata

Source: https://reference.univer.ai/en-US/classes/FWorksheet

Fetches custom metadata associated with a specific row. The index parameter specifies the row number, starting from 0.

```javascript
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorkSheet = fWorkbook.getActiveSheet();
const custom = fWorkSheet.getRowCustomMetadata(0);
console.log(custom);
```

--------------------------------

### Create a New Rich Text Instance

Source: https://reference.univer.ai/en-US/classes/FUniver

Initializes a new rich text builder with optional body data. This is the starting point for creating rich text content.

```javascript
const richText = univerAPI.newRichText({ body: { dataStream: 'Hello World\r\n' } });
const range = univerAPI.getActiveWorkbook().getActiveSheet().getRange('A1');
range.setRichTextValueForCell(richText);
```

--------------------------------

### Get Comment by ID

Source: https://reference.univer.ai/en-US/classes/FWorksheet

Retrieves a specific comment from the sheet using its unique ID. This example includes creating a comment first to ensure it exists.

```javascript
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
// Create a new comment
const richText = univerAPI.newRichText().insertText('hello univer');
const commentBuilder = univerAPI.newTheadComment()
  .setContent(richText)
  .setId('mock-comment-id');
const cell = fWorksheet.getRange('A1');
await cell.addCommentAsync(commentBuilder);
const comment = fWorksheet.getCommentById('mock-comment-id');
console.log(comment, comment?.getCommentData());
```

--------------------------------

### Get Conditional Formatting Rules

Source: https://reference.univer.ai/en-US/classes/FRange

Retrieves all conditional formatting rules applied to the specified range. This example also demonstrates how to create and add a new rule.

```typescript
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();

// Create a conditional formatting rule that sets the cell format to italic, red background, and green font color when the cell is not empty.
const fRange = fWorksheet.getRange('A1:T100');
const rule = fWorksheet.newConditionalFormattingRule()
  .whenCellNotEmpty()
  .setRanges([fRange.getRange()])
  .setItalic(true)
  .setBackground('red')
  .setFontColor('green')
  .build();
fWorksheet.addConditionalFormattingRule(rule);

// Get all the conditional formatting rules for the range F6:H8.
const targetRange = fWorksheet.getRange('F6:H8');
const rules = targetRange.getConditionalFormattingRules();
console.log(rules);
```

--------------------------------

### Insert Image with Dimensions

Source: https://reference.univer.ai/en-US/classes/FOverGridImageBuilder

Demonstrates creating an image builder, setting a URL source, defining grid position, and specifying pixel dimensions.

```javascript
// create a new image builder and set image source.
// then build `ISheetImage` and insert it into the sheet, position is start from F6 cell, width is 120px and height is 50px.
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const image = await fWorksheet.newOverGridImage()
  .setSource('https://avatars.githubusercontent.com/u/61444807?s=48&v=4', univerAPI.Enum.ImageSourceType.URL)
  .setColumn(5)
  .setRow(5)
  .setWidth(120)
  .setHeight(50)
  .buildAsync();
fWorksheet.insertImages([image]);
```

--------------------------------

### Create a new builder instance

Source: https://reference.univer.ai/en-US/classes/FTheadCommentBuilder

Initializes a new FTheadCommentBuilder instance.

```javascript
const commentBuilder = univerAPI.newTheadComment();
console.log(commentBuilder);
```

--------------------------------

### Get Scroll State by Sheet ID

Source: https://reference.univer.ai/en-US/classes/FWorkbook

Retrieves the scroll state for a specified sheet, identified by its ID. This includes scroll offsets and the starting row/column of the visible view.

```javascript
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();

// scroll to cell D10
fWorksheet.scrollToCell(9, 3);

// get scroll state
const scrollState = fWorkbook.getScrollStateBySheetId(fWorksheet.getSheetId());
const { offsetX, offsetY, sheetViewStartRow, sheetViewStartColumn } = scrollState;
console.log(scrollState); // sheetViewStartRow: 9, sheetViewStartColumn: 3, offsetX: 0, offsetY: 0
```

--------------------------------

### Import Piecemeal Facade APIs

Source: https://reference.univer.ai/en-US

Manual import of specific plugin facade implementations for piecemeal installations.

```typescript
import '@univerjs/sheets/facade'
import '@univerjs/ui/facade'
import '@univerjs/docs-ui/facade'
import '@univerjs/sheets-ui/facade'
 
import '@univerjs/sheets-data-validation/facade'
import '@univerjs/engine-formula/facade'
import '@univerjs/sheets-filter/facade'
import '@univerjs/sheets-formula/facade'
import '@univerjs/sheets-numfmt/facade'
import '@univerjs/sheets-hyper-link-ui/facade'
```

```typescript
import '@univerjs-pro/sheets-pivot/facade'
import '@univerjs-pro/exchange-client/facade'
```

--------------------------------

### Get Range by Row, Column, and Number of Rows - getRange(row, column, numRows)

Source: https://reference.univer.ai/en-US/classes/FWorksheet

Returns a `FRange` object for a block of cells starting at the specified row and column, spanning a given number of rows. Useful for selecting vertical ranges.

```typescript
const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
// Example usage (assuming you want a range of 5 rows starting from A1):
const range = fWorksheet.getRange(0, 0, 5);
console.log(range);
```

--------------------------------

### Wrap Univer Instance with FUniver

Source: https://reference.univer.ai/en-US

Manual initialization of the Facade API by wrapping an existing Univer instance.

```typescript
import { FUniver } from '@univerjs/core/facade'
 
const univerAPI = FUniver.newAPI(univer)
```

--------------------------------

### Get Range by Row, Column, Number of Rows, and Number of Columns - getRange(row, column, numRows, numColumns)

Source: https://reference.univer.ai/en-US/classes/FWorksheet

Returns a `FRange` object for a rectangular block of cells defined by a starting row and column, and the total number of rows and columns. This is the most comprehensive way to define a range.

```typescript
const fWorksheet = univerAPI.getActiveWorkbook().getActiveSheet();
// Example usage (assuming you want a 5x10 range starting from A1):
const range = fWorksheet.getRange(0, 0, 5, 10);
console.log(range);
```

--------------------------------

### Import DOCX to Snapshot (Async)

Source: https://reference.univer.ai/en-US/classes/FUniver

Imports a DOCX file and converts it into a snapshot of document data asynchronously.

```APIDOC
## importDOCXToSnapshotAsync(file)

### Description
Imports a DOCX file and converts it into a snapshot of document data asynchronously.

### Method
POST

### Endpoint
N/A (Method call)

### Parameters
#### Path Parameters
- **file** (string | File) - Required - The DOCX file to import. Can be a file path or a File object.

### Returns
- **Promise<IDocumentData>** - A promise that resolves to the document data snapshot.

### Request Example
```javascript
// Accepts a File object
const snapshot = await univerAPI.importDOCXToSnapshotAsync(file);
// Or accepts a URL to a remote file
// const snapshot = await univerAPI.importDOCXToSnapshotAsync('https://example.com/filename.docx');
console.log('Snapshot created:', snapshot);
```
```

--------------------------------

### Get Row Height

Source: https://reference.univer.ai/en-US/classes/FWorksheet

Gets the height in pixels of a specified row.

```APIDOC
## GET /api/worksheet/row/height

### Description
Gets the height in pixels of the given row.

### Method
GET

### Endpoint
/api/worksheet/row/height

### Parameters
#### Query Parameters
- **rowPosition** (number) - Required - The position of the row to examine. Index starts at 0.

### Response
#### Success Response (200)
- **number** - The height in pixels of the given row.

#### Response Example
```json
{
  "example": 30
}
```
```

--------------------------------

### Create a new workbook

Source: https://reference.univer.ai/en-US/classes/FUniver

Initializes a new spreadsheet instance. Use the optional configuration to control whether the new workbook becomes the active one.

```typescript
const fWorkbook = univerAPI.createWorkbook({ id: 'Sheet1', name: 'Sheet1' });
console.log(fWorkbook);
```

```typescript
const fWorkbook = univerAPI.createWorkbook({ id: 'Sheet1', name: 'Sheet1' }, { makeCurrent: false });
console.log(fWorkbook);
```

--------------------------------

### Get FEnum Method

Source: https://reference.univer.ai/en-US/classes/FEnum

Static method to get an FEnum instance.

```typescript
static get(): FEnum
```

--------------------------------

### Start Zen Editing Async

Source: https://reference.univer.ai/en-US/classes/FWorkbook

Enters zen editing mode for the active cell, returning a promise.

```javascript
const fWorkbook = univerAPI.getActiveWorkbook();
const success = await fWorkbook.startZenEditingAsync();
console.log(success);
```

--------------------------------

### Get HTTP Request

Source: https://reference.univer.ai/en-US/classes/FNetwork

Sends a GET request to the specified URL.

```typescript
get<T>(url, params?): Promise<HTTPResponse<...>>
```

--------------------------------

### GET /sheet/index

Source: https://reference.univer.ai/en-US/classes/FWorksheet

Gets the position (index) of the sheet within its parent spreadsheet.

```APIDOC
## GET /sheet/index

### Description
Gets the position of the sheet in its parent spreadsheet. Starts at 0.

### Method
GET

### Endpoint
`/sheet/index`

### Returns
#### Success Response (200)
- **index** (number) - The position of the sheet in its parent spreadsheet.

### Request Example
```javascript
const position = fWorkSheet.getIndex();
console.log(position);
```
```

--------------------------------

### startZenEditingAsync()

Source: https://reference.univer.ai/en-US/classes/FWorkbook

Enters an advanced 'zen' editing mode for the active cell, potentially offering a more focused or immersive editing experience.

```APIDOC
## startZenEditingAsync()

### Description
Enter the zen editing process on the active cell.

### Method
POST

### Endpoint
/workbook/startZenEditingAsync

### Response
#### Success Response (200)
- **Promise<boolean>** - A promise that resolves to a boolean indicating whether the zen editing process was started successfully.

#### Response Example
```json
true
```
```

--------------------------------

### FEventRegistry Constructor

Source: https://reference.univer.ai/en-US/classes/FEventRegistry

Initializes a new instance of the FEventRegistry class.

```APIDOC
## FEventRegistry Constructor

### Description
Initializes a new instance of the FEventRegistry class.

### Method
new

### Endpoint
N/A

### Returns
`FEventRegistry` - An instance of the FEventRegistry class.

### Request Example
```javascript
const eventRegistry = new FEventRegistry();
```

### Response Example
```json
{
  "instance": "FEventRegistry"
}
```
```

--------------------------------

### Get Active Univer Sheet (Deprecated)

Source: https://reference.univer.ai/en-US/classes/FUniver

Deprecated method to get the active workbook.

```typescript
getActiveUniverSheet(): FWorkbook
```

--------------------------------

### Get LifecycleStages Enum

Source: https://reference.univer.ai/en-US/classes/FEnum

Accesses the LifecycleStages enumeration to get different stages in the lifecycle.

```typescript
get LifecycleStages(): any
```

```javascript
console.log(univerAPI.Enum.LifecycleStages.Rendered);
```

--------------------------------

### Create Custom Menu with Image Icon

Source: https://reference.univer.ai/en-US/classes/FUniver

Shows how to create a custom menu with an image as its icon, registering the image component and appending the menu to the ribbon.

```javascript
// Or
// Create a custom menu with an image icon
univerAPI.registerComponent('custom-menu-icon', () => {
  return <img src="https://avatars.githubusercontent.com/u/61444807?s=48&v=4" alt="" style={{ width: '16px', height: '16px' }} />;
});
univerAPI.createMenu({
  id: 'custom-menu',
  icon: 'custom-menu-icon',
  title: 'Custom Menu',
  tooltip: 'Custom Menu Tooltip',
  action: () => {
    console.log('Custom Menu Clicked');
  },
}).appendTo('ribbon.start.others');
```

--------------------------------

### Set Defined Name Reference (Range)

Source: https://reference.univer.ai/en-US/classes/FDefinedNameBuilder

Sets the cell or range reference for the defined name by specifying the start row, start column, number of rows, and number of columns. Indices start at 0.

```typescript
const fWorkbook = univerAPI.getActiveWorkbook();
const definedNameBuilder = univerAPI.newDefinedName()
  .setName('MyDefinedName')
  .setRefByRange(
     0, 
     0, 
     1, 
     1
  )
  .build();
fWorkbook.insertDefinedNameBuilder(definedNameBuilder);
```

--------------------------------

### Constructor: new FWatermarkEnum()

Source: https://reference.univer.ai/en-US/classes/FWatermarkEnum

Initializes a new instance of the FWatermarkEnum class.

```APIDOC
## Constructor: new FWatermarkEnum()

### Description
Creates a new instance of the FWatermarkEnum class.

### Returns
- **FWatermarkEnum** - A new instance of the class.
```

--------------------------------

### Manage Table Filters

Source: https://reference.univer.ai/en-US/classes/FWorksheet

Demonstrates adding a table, applying a numeric filter to a column, and resetting the filter after a delay.

```javascript
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
 
// Insert a table in the range B2:F11
const fRange = fWorksheet.getRange('B2:F11');
const success = await fWorksheet.addTable(
  'name-1',
  fRange.getRange(),
  'id-1',
  {
    tableStyleId: 'table-default-4',
  }
);
 
if (success) {
  // Set the filter for the second column
  await fWorksheet.setTableFilter('id-1', 1, {
    filterType: univerAPI.Enum.TableColumnFilterTypeEnum.condition,
    filterInfo: {
      conditionType: univerAPI.Enum.TableConditionTypeEnum.Number,
      compareType: univerAPI.Enum.TableNumberCompareTypeEnum.GreaterThan,
      expectedValue: 10,
    },
  });
 
  // Reset the filter for the second column after 3 seconds
  setTimeout(async () => {
    await fWorksheet.resetFilter('id-1', 1);
  }, 3000);
 
  const tableInfo = fWorkbook.getTableInfo('id-1');
  console.log('debugger tableInfo', tableInfo);
}
```

--------------------------------

### Chart Title Position Enum and Example

Source: https://reference.univer.ai/en-US/classes/FEnum

Enumeration for chart title positions with a code example demonstrating its usage.

```APIDOC
## Chart Title Position Enum and Example

### TitlePositionEnum
Represents the position of the title in the chart.

**Example**
```javascript
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();

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

--------------------------------

### Create Custom Menu with Univer Icon

Source: https://reference.univer.ai/en-US/classes/FUniver

Demonstrates how to create a custom menu item with a Univer icon, registering the icon component and appending the menu to the ribbon.

```javascript
// Univer Icon can be viewed at https://docs.univer.ai/icons
import { SmileIcon } from '@univerjs/icons'
 
// Create a custom menu with an univer icon
univerAPI.registerComponent('custom-menu-icon', SmileIcon);
univerAPI.createMenu({
  id: 'custom-menu',
  icon: 'custom-menu-icon',
  title: 'Custom Menu',
  tooltip: 'Custom Menu Tooltip',
  action: () => {
    console.log('Custom Menu Clicked');
  },
}).appendTo('ribbon.start.others');
```

--------------------------------

### IIndentStart Interface Definition

Source: https://reference.univer.ai/en-US/interfaces/IIndentStart

This snippet details the properties of the IIndentStart interface.

```APIDOC
## Interface: IIndentStart

### Description
Defines properties related to text indentation.

### Extended by
  * `IParagraphProperties`

### Properties

| Property           | Type          |
|--------------------|---------------|
| `hanging?`         | `INumberUnit` |
| `indentEnd?`       | `INumberUnit` |
| `indentFirstLine?` | `INumberUnit` |
| `indentStart?`     | `INumberUnit` |
| `tabStops?`        | `ITabStop`[]  |
```

--------------------------------

### Get Row Default Style

Source: https://reference.univer.ai/en-US/classes/FWorksheet

Retrieves the default style of a worksheet row, with an option to get raw style data.

```APIDOC
## GET /api/worksheet/row/default-style

### Description
Get the default style of the worksheet row.

### Method
GET

### Endpoint
/api/worksheet/row/default-style

### Parameters
#### Query Parameters
- **index** (number) - Required - The index of the row.
- **keepRaw** (boolean) - Optional - If true, return the raw style data; otherwise, return data from the row manager.

### Response
#### Success Response (200)
- **string | Nullable<…>** - The default style of the worksheet row name or style data.

#### Response Example
```json
{
  "example": "string | Nullable<style_data>"
}
```
```

--------------------------------

### FShortcut API - enableShortcut

Source: https://reference.univer.ai/en-US/classes/FShortcut

Enables keyboard shortcuts for the Univer application. Returns the current instance for chaining.

```APIDOC
## POST /api/shortcuts/enable

### Description
Enable shortcuts of Univer.

### Method
POST

### Endpoint
/api/shortcuts/enable

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "fShortcut.enableShortcut(); // Use the FShortcut instance used by disableShortcut before, do not create a new instance"
}
```

### Response
#### Success Response (200)
- **this** (object) - The Facade API instance itself for chaining.

#### Response Example
```json
{
  "example": "// Returns the FShortcut instance"
}
```
```

--------------------------------

### Interact with Univer Shortcuts

Source: https://reference.univer.ai/en-US/classes/FUniver

Obtains the FShortcut handler to manage Univer's shortcut functionalities. Allows enabling, disabling, and triggering shortcuts programmatically. Includes an example of triggering a 'bold' shortcut.

```javascript
const fShortcut = univerAPI.getShortcut();

// Disable shortcuts of Univer
fShortcut.disableShortcut();

// Enable shortcuts of Univer
fShortcut.enableShortcut();

// Trigger a shortcut
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1');
fRange.activate();
fRange.setValue('Hello Univer');
console.log(fRange.getCellStyle().bold); // false
const pseudoEvent = new KeyboardEvent('keydown', {
  key: 'b',
  ctrlKey: true,
  keyCode: univerAPI.Enum.KeyCode.B
});
const ifShortcutItem = fShortcut.triggerShortcut(pseudoEvent);
if (ifShortcutItem) {
  const commandId = ifShortcutItem.id;
  console.log(fRange.getCellStyle().bold); // true
}
```

--------------------------------

### Highlight Range with Default and Custom Styles

Source: https://reference.univer.ai/en-US/classes/FRange

Demonstrates how to highlight a range with default styles and then with custom styles including a primary cell. It also shows how to remove the highlight after a delay.

```javascript
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();

// Highlight the range C3:E5 with default style
const fRange = fWorksheet.getRange('C3:E5');
fRange.highlight();

// Highlight the range C7:E9 with custom style and primary cell D8
const fRange2 = fWorksheet.getRange('C7:E9');
const primaryCell = fWorksheet.getRange('D8').getRange();
const disposable = fRange2.highlight(
  {
    stroke: 'red',
    fill: 'yellow'
  },
  {
    ...primaryCell,
    actualRow: primaryCell.startRow,
    actualColumn: primaryCell.startColumn
  }
);

// Remove the range C7:E9 highlight after 5 seconds
setTimeout(() => {
  disposable.dispose();
}, 5000);
```
Tokens:
Raw