Univer

https://docs.univer.ai/
Admin
Univer is a full-stack, isomorphic office suite with high extensibility and performance, designed to...
Tokens:1,867,574
Snippets:15,845
Trust Score:7.7
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Run an example with pnpm commands

Source: https://docs.univer.ai/ai/examples

Use this sequence inside any example directory to install dependencies, build, link the CLI, and start the server. After the server starts, run univer-example-cli from another terminal.

```bash
pnpm install
pnpm build
pnpm link-cli
pnpm start-server
```

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

### Run the official quick-start example

Source: https://docs.univer.ai/server/collaboration/quick-start

Clone the official collaboration examples repository, install dependencies with the lockfile, and run the quick-start example. Requires Node.js 24+ and pnpm 10.32.1; run from the repository root. The command builds the browser and server, type-checks the example, and starts it; it is not a hot-reload development server.

```bash
git clone https://github.com/dream-num/univer-collaboration-examples.git
cd univer-collaboration-examples
pnpm install --frozen-lockfile
pnpm example:quick-start
```

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

### Get paragraph start index example

Source: https://docs.univer.ai/reference/facade/document-list-item

Example of getting the paragraph start index of a list item.

```javascript
const fDocument = univerAPI.getActiveDocument()const item = fDocument.findListItemByText('Ship API')console.log(item?.getParagraphStartIndex())
```

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

### FRange.getRow: Get starting row index

Source: https://docs.univer.ai/reference/facade/range

Gets the starting row index of the range; index starts at 0. The example logs 0 for range A1:B2.

```typescript
getRow(): number
```

```typescript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')const fRange = fWorksheet.getRange('A1:B2')console.log(fRange.getRow()) // 0
```

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

### Run Quick Start example

Source: https://docs.univer.ai/server/collaboration/examples

Runs the Quick Start example, which composes Collaboration Client, Transport, Endpoint, Service, and Memory Adapter. Use two browsers to verify HTTP loading, WebSocket Sessions, Room, ACK, and broadcast for the same Sheet. After running, open http://127.0.0.1:3010/?unit=quick-start-sheet&type=2.

```bash
pnpm example:quick-start
```

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

### FRange.getColumn - Get starting column index

Source: https://docs.univer.ai/reference/facade/range

Method signature for FRange.getColumn. Returns the starting column index of the range, with indexing starting at 0. Example logs 0 for range A1:B2.

```typescript
getColumn(): number
```

```typescript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')const fRange = fWorksheet.getRange('A1:B2')console.log(fRange.getColumn()) // 0
```

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

### Install and initialize Univer Web SDK with preset plugins

Source: https://docs.univer.ai/

Install the core Web SDK packages via npm, then initialize the Univer instance with English locale resources, register all required plugins (render, formula, UI, docs, sheets, formula UI, numfmt), create a spreadsheet unit, and obtain the FUniver facade API. This is the preset mode quick integration path.

```javascript
# npm install @univerjs/core @univerjs/design @univerjs/docs @univerjs/docs-ui @univerjs/engine-formula @univerjs/engine-render @univerjs/sheets @univerjs/sheets-formula @univerjs/sheets-formula-ui @univerjs/sheets-numfmt @univerjs/sheets-numfmt-ui @univerjs/sheets-ui @univerjs/ui react react-dom rxjs

import { LocaleType, mergeLocales, Univer, UniverInstanceType } from '@univerjs/core'
import { FUniver } from '@univerjs/core/facade'
import DesignEnUSfrom '@univerjs/design/locale/en-US'
import { UniverDocsPlugin } from '@univerjs/docs'
import { UniverDocsUIPlugin } from '@univerjs/docs-ui'
import DocsUIEnUSfrom '@univerjs/docs-ui/locale/en-US'
import { UniverFormulaEnginePlugin } from '@univerjs/engine-formula'
import { UniverRenderEnginePlugin } from '@univerjs/engine-render'
import { UniverSheetsPlugin } from '@univerjs/sheets'
import { UniverSheetsFormulaPlugin } from '@univerjs/sheets-formula'
import { UniverSheetsFormulaUIPlugin } from '@univerjs/sheets-formula-ui'
import SheetsFormulaUIEnUSfrom '@univerjs/sheets-formula-ui/locale/en-US'
import { UniverSheetsNumfmtPlugin } from '@univerjs/sheets-numfmt'
import { UniverSheetsNumfmtUIPlugin } from '@univerjs/sheets-numfmt-ui'
import SheetsNumfmtUIEnUSfrom '@univerjs/sheets-numfmt-ui/locale/en-US'
import { UniverSheetsUIPlugin } from '@univerjs/sheets-ui'
import SheetsUIEnUSfrom '@univerjs/sheets-ui/locale/en-US'
import SheetsEnUSfrom '@univerjs/sheets/locale/en-US'
import { UniverUIPlugin } from '@univerjs/ui'
import UIEnUSfrom '@univerjs/ui/locale/en-US'

import '@univerjs/engine-formula/facade'
import '@univerjs/ui/facade'
import '@univerjs/docs-ui/facade'
import '@univerjs/sheets/facade'
import '@univerjs/sheets-ui/facade'
import '@univerjs/sheets-formula/facade'
import '@univerjs/sheets-numfmt/facade'

import '@univerjs/design/lib/index.css'
import '@univerjs/ui/lib/index.css'
import '@univerjs/docs-ui/lib/index.css'
import '@univerjs/sheets-ui/lib/index.css'
import '@univerjs/sheets-formula-ui/lib/index.css'
import '@univerjs/sheets-numfmt-ui/lib/index.css'

const univer = new Univer({
  locale: LocaleType.EN_US,
  locales: {
    [LocaleType.EN_US]:mergeLocales([
      DesignEnUS,
      UIEnUS,
      DocsUIEnUS,
      SheetsEnUS,
      SheetsUIEnUS,
      SheetsFormulaUIEnUS,
      SheetsNumfmtUIEnUS,
    ]),
  },
})

univer.registerPlugin(UniverRenderEnginePlugin)
univer.registerPlugin(UniverFormulaEnginePlugin)
univer.registerPlugin(UniverUIPlugin,{ container: 'app' })
univer.registerPlugin(UniverDocsPlugin)
univer.registerPlugin(UniverDocsUIPlugin)
univer.registerPlugin(UniverSheetsPlugin)
univer.registerPlugin(UniverSheetsUIPlugin)
univer.registerPlugin(UniverSheetsFormulaPlugin)
univer.registerPlugin(UniverSheetsFormulaUIPlugin)
univer.registerPlugin(UniverSheetsNumfmtPlugin)
univer.registerPlugin(UniverSheetsNumfmtUIPlugin)

univer.createUnit(UniverInstanceType.UNIVER_SHEET,{})

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

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

### Create and run a Univer starter project

Source: https://docs.univer.ai/tools/initialization-generator

Commands to scaffold a new Univer project, install dependencies, and start the development server. Run from the directory containing create-univer-project.mjs.

```bash
node create-univer-project.mjs
cd univer-starter
npm install
npm run dev
```

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

### Get row outlines example

Source: https://docs.univer.ai/reference/facade/worksheet

Example usage of getDimensionOutlines with the ROW axis filter, iterating over the returned outlines and logging id, start, end, and collapsed properties.

```javascript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')const rowOutlines = fWorksheet.getDimensionOutlines(univerAPI.Enum.DimensionOutlineAxis.ROW)rowOutlines.forEach((outline) => {  console.log(outline.id, outline.start, outline.end, outline.collapsed)})
```

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

### Install @univerjs/preset-docs-drawing and @univerjs/preset-docs-advanced

Source: https://docs.univer.ai/guides/docs/features/print

Install the required presets for preset mode. The @univerjs/preset-docs-advanced preset depends on @univerjs/preset-docs-drawing at runtime, so install both.

```bash
pnpm add @univerjs/preset-docs-drawing @univerjs/preset-docs-advanced
```

```bash
npm install @univerjs/preset-docs-drawing @univerjs/preset-docs-advanced
```

```bash
yarn add @univerjs/preset-docs-drawing @univerjs/preset-docs-advanced
```

```bash
bun add @univerjs/preset-docs-drawing @univerjs/preset-docs-advanced
```

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

### FRange.getLastRow - Get ending row index

Source: https://docs.univer.ai/reference/facade/range

Gets the ending row index of the range, starting at 0. The example logs the last row index for range A1:B2, which is 1.

```typescript
getLastRow(): number
```

```javascript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')const fRange = fWorksheet.getRange('A1:B2')console.log(fRange.getLastRow()) // 1
```

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

### FRange.getLastColumn - Get ending column index

Source: https://docs.univer.ai/reference/facade/range

Gets the ending column index of the range, starting at 0. The example logs the last column index for range A1:B2, which is 1.

```typescript
getLastColumn(): number
```

```javascript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')const fRange = fWorksheet.getRange('A1:B2')console.log(fRange.getLastColumn()) // 1
```

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

### Create Univer app with npm starter kit

Source: https://docs.univer.ai/guides/docs/getting-started/quickstart

Creates a new Univer app using the starter kit with npm. Requires nodejs >= 18, npm >= 8, and git installed.

```bash
npx degit dream-num/univer-doc-start-kit univer-doc-start-kit
cd univer-doc-start-kit
npm install
npm run dev

```

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

### Create board example

Source: https://docs.univer.ai/reference/facade/univer

Example of creating a board with a name and logging its id.

```javascript
const board = univerAPI.createBoard({ name: 'Planning Board' })console.log(board.getId())
```

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

### getSectionAt: Get section containing a data-stream offset

Source: https://docs.univer.ai/reference/facade/document

Returns the traditional section containing the given offset, or null if none exists or the document is not Traditional. The example finds a paragraph by text, gets its start offset, and retrieves the section at that offset.

```typescript
const fDocument = univerAPI.getActiveDocument()const paragraph = fDocument?.findParagraphByText('Launch')const offset = paragraph?.getInfo().startOffsetconst section = offset == null ? null : fDocument?.getSectionAt(offset)console.log(section?.getId())
```

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

### Run Database Adapter example

Source: https://docs.univer.ai/server/collaboration/examples

Runs the Database Adapter example, which demonstrates how to use the built-in SQLite Adapter and implement a custom Database Adapter. After running, open http://127.0.0.1:3010/?unit=persistent-sheet&type=2.

```bash
pnpm example:database-adapter
```

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

### Install @univerjs-pro/embed and @univerjs-pro/embed-ui with bun

Source: https://docs.univer.ai/guides/bases/features/embed

Install the embed packages using bun. Requires an existing Univer setup.

```bash
bun add @univerjs-pro/embed @univerjs-pro/embed-ui
```

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

### Get text example

Source: https://docs.univer.ai/reference/facade/document-list-item

Example of getting the text of a list item.

```javascript
const fDocument = univerAPI.getActiveDocument()const item = fDocument.findListItemByText('Ship API')console.log(item?.getText())
```

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

### Create Univer app with pnpm starter kit

Source: https://docs.univer.ai/guides/docs/getting-started/quickstart

Creates a new Univer app using the starter kit with pnpm. Requires nodejs >= 18, pnpm >= 7, and git installed.

```bash
pnpm dlx degit dream-num/univer-doc-start-kit univer-doc-start-kit
cd univer-doc-start-kit
pnpm install
pnpm dev

```

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

### Install @univerjs/preset-docs-thread-comment

Source: https://docs.univer.ai/guides/docs/features/comments

Install the preset package using your preferred package manager. Choose one of these commands.

```bash
pnpm add @univerjs/preset-docs-thread-comment
```

```bash
npm install @univerjs/preset-docs-thread-comment
```

```bash
yarn add @univerjs/preset-docs-thread-comment
```

```bash
bun add @univerjs/preset-docs-thread-comment
```

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

### FRange.getCustomMetaData - Get custom metadata for first cell

Source: https://docs.univer.ai/reference/facade/range

Method signature for FRange.getCustomMetaData. Returns the custom metadata for the cell at the start of the range. Example retrieves metadata for A1:B2.

```typescript
getCustomMetaData(): CustomData | null
```

```typescript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')const fRange = fWorksheet.getRange('A1:B2')console.log(fRange.getCustomMetaData())
```

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

### Install @univerjs/presets and @univerjs/preset-docs-core

Source: https://docs.univer.ai/guides/docs/features/core

Install the Univer presets and the docs core preset using your preferred package manager. Choose the command that matches your environment.

```bash
pnpm add @univerjs/presets @univerjs/preset-docs-core
```

```bash
npm install @univerjs/presets @univerjs/preset-docs-core
```

```bash
yarn add @univerjs/presets @univerjs/preset-docs-core
```

```bash
bun add @univerjs/presets @univerjs/preset-docs-core
```

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

### Get segment id example

Source: https://docs.univer.ai/reference/facade/document-list-item

Example of getting the segment id of a list item.

```javascript
const fDocument = univerAPI.getActiveDocument()const item = fDocument.findListItemByText('Ship API')console.log(item?.getSegmentId())
```

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

### Install preset-sheets-node-core with bun

Source: https://docs.univer.ai/guides/sheets/getting-started/node

Install the headless preset package using bun.

```bash
bun add @univerjs/preset-sheets-node-core
```

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

### Get board by id example

Source: https://docs.univer.ai/reference/facade/univer

Example of getting the active board and then retrieving it by id using getBoard.

```javascript
const activeBoard = univerAPI.getActiveBoard()if (!activeBoard) throw new Error('No active board')console.log(univerAPI.getBoard(activeBoard.getId()))
```

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

### Get note example

Source: https://docs.univer.ai/reference/facade/range

Example usage of getNote. Gets the note from range A1:D10 and logs it.

```typescript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')const fRange = fWorksheet.getRange('A1:D10')const note = fRange.getNote()console.log(note)
```

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

### Install preset-docs-node-core with bun

Source: https://docs.univer.ai/guides/docs/getting-started/node

Install the preset package for headless Univer in Node.js using bun.

```bash
bun add @univerjs/preset-docs-node-core
```

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

### Install @univerjs-pro/embed and @univerjs-pro/embed-ui with npm

Source: https://docs.univer.ai/guides/bases/features/embed

Install the embed packages using npm. Requires an existing Univer setup.

```bash
npm install @univerjs-pro/embed @univerjs-pro/embed-ui
```

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

### FWorksheet.getRowDefaultStyle example

Source: https://docs.univer.ai/reference/facade/worksheet

Example of using FWorksheet.getRowDefaultStyle to get the default style for row 0, and with keepRaw=true to get raw style data.

```typescript
const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')// Get default style for row 0 (1)const rowStyle = fWorksheet.getRowDefaultStyle(0)console.log(rowStyle)// Get raw style data for row 0const rawRowStyle = fWorksheet.getRowDefaultStyle(0, true)console.log(rawRowStyle)
```

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

### Install Boards packages with pnpm, npm, yarn, or bun

Source: https://docs.univer.ai/guides/boards/features/core

Install the two Boards product packages for the Univer runtime. Choose the command matching your package manager.

```bash
pnpm add @univerjs-pro/boards @univerjs-pro/boards-ui
```

```bash
npm install @univerjs-pro/boards @univerjs-pro/boards-ui
```

```bash
yarn add @univerjs-pro/boards @univerjs-pro/boards-ui
```

```bash
bun add @univerjs-pro/boards @univerjs-pro/boards-ui
```

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

### Run Multi-node example

Source: https://docs.univer.ai/server/collaboration/examples

Runs the Multi-node example, which distributes collaboration workloads for different documents across multiple server nodes to reduce the load on each node and increase overall concurrency. After running, open http://127.0.0.1:3010/ and select New Sheet to create a file. Copy the full URL to another tab to verify collaborative editing of the same document. Then create a few more files to observe how they are distributed across nodes.

```bash
pnpm example:multi-node
```

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

### Get chart by ID example

Source: https://docs.univer.ai/reference/facade/worksheet

Example usage of getChart. It retrieves the first chart from the worksheet and then gets that chart by its ID, logging its info.

```typescript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')const firstChart = fWorksheet.getCharts()[0]const fChart = firstChart ? fWorksheet.getChart(firstChart.getId()) : nullconsole.log(fChart?.getInfo())
```

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

### Install with bun

Source: https://docs.univer.ai/guides/docs/features/list

Install the enhanced list packages using bun.

```bash
bun add @univerjs-pro/docs-list @univerjs-pro/docs-list-ui
```

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

### Get active board example

Source: https://docs.univer.ai/reference/facade/univer

Example of getting the active board, throwing an error if none exists, and logging the number of element descriptors.

```javascript
const board = univerAPI.getActiveBoard()if (!board) throw new Error('No active board')const descriptors = board.describeElements()console.log(descriptors.length)
```

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

### FBaseTableRecord.getId example

Source: https://docs.univer.ai/reference/facade/base-table-record

Example usage of getId. Gets the active base, retrieves a table by id, gets its records, and logs the id of the first record.

```typescript
const fBase = univerAPI.getActiveBase()const fBaseTable = fBase.getTableById('table-1')const records = fBaseTable.getRecords()console.log(records[0]?.getId())
```

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

### Initialize Univer and register Bases plugins

Source: https://docs.univer.ai/guides/bases/getting-started/installation

Create a Univer instance, register plugins, and create a Base unit. The license is read from the CLIENT_LICENSE_TEXT environment variable. The container 'app' must exist before this code runs.

```javascript
const univer = new Univer({  locale: LocaleType.EN_US,  locales: {    [LocaleType.EN_US]: mergeLocales(      DesignEnUS,      UIEnUS,      BasesEnUS,      BasesUIEnUS,    ),  },})univer.registerPlugin(UniverRenderEnginePlugin)univer.registerPlugin(UniverUIPlugin, { container: 'app' })univer.registerPlugin(UniverProFormulaEnginePlugin)univer.registerPlugin(UniverLicensePlugin, {  license: process.env.CLIENT_LICENSE_TEXT,})univer.registerPlugin(UniverBasesPlugin)univer.registerPlugin(UniverBasesUIPlugin)univer.createUnit(UniverInstanceType.UNIVER_BASE, {})const univerAPI = FUniver.newAPI(univer)
```

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

### FDocument.getCallouts example

Source: https://docs.univer.ai/reference/facade/document

Example usage of FDocument.getCallouts to get all callouts in the document.

```javascript
const fDocument = univerAPI.getActiveDocument()const callouts = fDocument.getCallouts()console.log(callouts)
```

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

### Install preset-docs-node-core with npm

Source: https://docs.univer.ai/guides/docs/getting-started/node

Install the preset package for headless Univer in Node.js using npm.

```bash
npm install @univerjs/preset-docs-node-core
```

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

### Set up Univer instance with plugins

Source: https://docs.univer.ai/guides/sheets/features/core

Imports all required modules and CSS, creates a Univer instance with English locale, and registers all plugins including render, formula, UI, docs, sheets, and numfmt plugins. The UI plugin is configured with a container element with id 'app'.

```typescript
import { LocaleType, mergeLocales, Univer } from '@univerjs/core'
import DesignEnUS from '@univerjs/design/locale/en-US'
import { UniverDocsPlugin } from '@univerjs/docs'
import { UniverDocsUIPlugin } from '@univerjs/docs-ui'
import DocsUIEnUS from '@univerjs/docs-ui/locale/en-US'
import { UniverFormulaEnginePlugin } from '@univerjs/engine-formula'
import { UniverRenderEnginePlugin } from '@univerjs/engine-render'
import { UniverSheetsPlugin } from '@univerjs/sheets'
import { UniverSheetsFormulaPlugin } from '@univerjs/sheets-formula'
import { UniverSheetsFormulaUIPlugin } from '@univerjs/sheets-formula-ui'
import SheetsFormulaUIEnUS from '@univerjs/sheets-formula-ui/locale/en-US'
import { UniverSheetsNumfmtPlugin } from '@univerjs/sheets-numfmt'
import { UniverSheetsNumfmtUIPlugin } from '@univerjs/sheets-numfmt-ui'
import SheetsNumfmtUIEnUS from '@univerjs/sheets-numfmt-ui/locale/en-US'
import { UniverSheetsUIPlugin } from '@univerjs/sheets-ui'
import SheetsUIEnUS from '@univerjs/sheets-ui/locale/en-US'
import SheetsEnUS from '@univerjs/sheets/locale/en-US'
import { UniverUIPlugin } from '@univerjs/ui'
import UIEnUS from '@univerjs/ui/locale/en-US'
import '@univerjs/design/lib/index.css'
import '@univerjs/ui/lib/index.css'
import '@univerjs/docs-ui/lib/index.css'
import '@univerjs/sheets-ui/lib/index.css'
import '@univerjs/sheets-formula-ui/lib/index.css'
import '@univerjs/sheets-numfmt-ui/lib/index.css'
import '@univerjs/engine-formula/facade'
import '@univerjs/ui/facade'
import '@univerjs/docs-ui/facade'
import '@univerjs/sheets/facade'
import '@univerjs/sheets-ui/facade'
import '@univerjs/sheets-formula/facade'
import '@univerjs/sheets-numfmt/facade'
const univer = new Univer({
  locale: LocaleType.EN_US,
  locales: {
    [LocaleType.EN_US]: mergeLocales(
      DesignEnUS,
      UIEnUS,
      DocsUIEnUS,
      SheetsEnUS,
      SheetsUIEnUS,
      SheetsFormulaUIEnUS,
      SheetsNumfmtUIEnUS,
    ),
  },
})
univer.registerPlugin(UniverRenderEnginePlugin)
univer.registerPlugin(UniverFormulaEnginePlugin)
univer.registerPlugin(UniverUIPlugin, {
  container: 'app',
})
univer.registerPlugin(UniverDocsPlugin)
univer.registerPlugin(UniverDocsUIPlugin)
univer.registerPlugin(UniverSheetsPlugin)
univer.registerPlugin(UniverSheetsUIPlugin)
univer.registerPlugin(UniverSheetsFormulaPlugin)
univer.registerPlugin(UniverSheetsFormulaUIPlugin)
univer.registerPlugin(UniverSheetsNumfmtPlugin)
univer.registerPlugin(UniverSheetsNumfmtUIPlugin)
```

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

### FBaseTableRange.getValue example

Source: https://docs.univer.ai/reference/facade/base-table-range

Example of getting the first value in the data range.

```javascript
const fBase = univerAPI.getActiveBase()
const fBaseTable = fBase.getTableById('table-1')
const range = fBaseTable.getDataRange()
console.log(range.getValue())
```

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

### FBaseTableRange.getTableId example

Source: https://docs.univer.ai/reference/facade/base-table-range

Example of getting the table id from the data range.

```javascript
const fBase = univerAPI.getActiveBase()
const fBaseTable = fBase.getTableById('table-1')
const range = fBaseTable.getDataRange()
console.log(range.getTableId())
```

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

### Initialize Univer Slides with plugins and create presentation

Source: https://docs.univer.ai/guides/slides/features/core

Sets up a Univer instance with the Pro Slides plugins, including locale merging, license registration, and a new presentation named 'Quarterly review'. Requires the CLIENT_LICENSE_TEXT environment variable for the license plugin.

```javascript
import { UniverLicensePlugin } from '@univerjs-pro/license'import { UniverSlidesPlugin } from '@univerjs-pro/slides'import { UniverSlidesUIPlugin } from '@univerjs-pro/slides-ui'import SlidesUIEnUS from '@univerjs-pro/slides-ui/locale/en-US'import SlidesEnUS from '@univerjs-pro/slides/locale/en-US'import { LocaleType, mergeLocales, Univer } from '@univerjs/core'import { FUniver } from '@univerjs/core/facade'import DesignEnUS from '@univerjs/design/locale/en-US'import { UniverDocsPlugin } from '@univerjs/docs'import { UniverDocsUIPlugin } from '@univerjs/docs-ui'import DocsUIEnUS from '@univerjs/docs-ui/locale/en-US'import { UniverDrawingPlugin } from '@univerjs/drawing'import { UniverRenderEnginePlugin } from '@univerjs/engine-render'import { UniverUIPlugin } from '@univerjs/ui'import UIEnUS from '@univerjs/ui/locale/en-US'import '@univerjs-pro/slides/facade'import '@univerjs/design/lib/index.css'import '@univerjs/ui/lib/index.css'import '@univerjs/docs-ui/lib/index.css'import '@univerjs-pro/slides-ui/lib/index.css'const univer = new Univer({  locale: LocaleType.EN_US,  locales: {    [LocaleType.EN_US]: mergeLocales(DesignEnUS, UIEnUS, DocsUIEnUS, SlidesEnUS, SlidesUIEnUS),  },})univer.registerPlugin(UniverRenderEnginePlugin)univer.registerPlugin(UniverUIPlugin, { container: 'app' })univer.registerPlugin(UniverDocsPlugin)univer.registerPlugin(UniverDocsUIPlugin)univer.registerPlugin(UniverDrawingPlugin)univer.registerPlugin(UniverLicensePlugin, {  license: process.env.CLIENT_LICENSE_TEXT,})univer.registerPlugin(UniverSlidesPlugin)univer.registerPlugin(UniverSlidesUIPlugin)const univerAPI = FUniver.newAPI(univer)const presentation = univerAPI.createPresentation({ name: 'Quarterly review' })
```

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

### Create workbook example

Source: https://docs.univer.ai/reference/facade/univer

Creates a workbook with the given id and name, then logs the returned FWorkbook instance.

```javascript
const fWorkbook = univerAPI.createWorkbook({ id: 'workbook-01', name: 'Workbook1' })console.log(fWorkbook)
```

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

### FBaseTableRange.getNumRows example

Source: https://docs.univer.ai/reference/facade/base-table-range

Example of getting the number of rows in the data range.

```javascript
const fBase = univerAPI.getActiveBase()
const fBaseTable = fBase.getTableById('table-1')
const range = fBaseTable.getDataRange()
console.log(range.getNumRows())
```

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

### FBaseTableRange.getNumColumns example

Source: https://docs.univer.ai/reference/facade/base-table-range

Example of getting the number of columns in the data range.

```javascript
const fBase = univerAPI.getActiveBase()
const fBaseTable = fBase.getTableById('table-1')
const range = fBaseTable.getDataRange()
console.log(range.getNumColumns())
```

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

### Install Bases packages with pnpm, npm, yarn, or bun

Source: https://docs.univer.ai/guides/bases/features/core

Install the two Bases product packages for the Univer runtime. Choose the command matching your package manager (pnpm, npm, yarn, or bun).

```bash
pnpm add @univerjs-pro/bases @univerjs-pro/bases-ui
```

```bash
npm install @univerjs-pro/bases @univerjs-pro/bases-ui
```

```bash
yarn add @univerjs-pro/bases @univerjs-pro/bases-ui
```

```bash
bun add @univerjs-pro/bases @univerjs-pro/bases-ui
```

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

### Install @univerjs-pro/docs-reference and @univerjs-pro/docs-reference-ui

Source: https://docs.univer.ai/guides/docs/features/footnotes

Install the required plugins for footnotes and endnotes. Choose one package manager; all install the same two packages.

```bash
pnpm add @univerjs-pro/docs-reference @univerjs-pro/docs-reference-ui
```

```bash
npm install @univerjs-pro/docs-reference @univerjs-pro/docs-reference-ui
```

```bash
yarn add @univerjs-pro/docs-reference @univerjs-pro/docs-reference-ui
```

```bash
bun add @univerjs-pro/docs-reference @univerjs-pro/docs-reference-ui
```

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

### Get workbook by id example

Source: https://docs.univer.ai/reference/facade/univer

Gets the workbook with id 'workbook-01' and logs it.

```javascript
const fWorkbook = univerAPI.getWorkbook('workbook-01')console.log(fWorkbook)
```

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

### Run Worktree example

Source: https://docs.univer.ai/server/collaboration/examples

Runs the Worktree example, which demonstrates the complete isolated draft, Ready, Reopen, and per-Unit Merge lifecycle. Switch between trunk and draft to see how Agent changes remain isolated before merge. After running, open http://127.0.0.1:3010/?unit=worktree-sheet&type=2&worktree=demo-worktree.

```bash
pnpm example:worktree
```

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

### Get column count

Source: https://docs.univer.ai/reference/facade/document-column-group

Example of getting the column count of the first group.

```javascript
const fDocument = univerAPI.getActiveDocument()const groups = fDocument.getColumnGroups()if (groups.length > 0) {  const group = groups[0]  console.log(group.getColumnCount())}
```

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

### Get a column by index or id

Source: https://docs.univer.ai/reference/facade/document-column-group

Example of getting a column by index and by id.

```javascript
const fDocument = univerAPI.getActiveDocument()const groups = fDocument.getColumnGroups()if (groups.length > 0) {  const group = groups[0]  const columnWithIndex = group.getColumn(0)  console.log(columnWithIndex?.getText())  const columnWithId = group.getColumn('right-column')  console.log(columnWithId?.getText())}
```

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

### Set up Univer PDFs plugin and create a PDF

Source: https://docs.univer.ai/guides/pdfs/features/core

Imports required modules, registers the UI, license, PDFs, and PDFs UI plugins, and creates a new PDF via the Facade API. Requires a license string in the CLIENT_LICENSE_TEXT environment variable.

```typescript
import { UniverLicensePlugin } from '@univerjs-pro/license'
import { UniverPdfsPlugin } from '@univerjs-pro/pdfs'
import { UniverPdfsUIPlugin } from '@univerjs-pro/pdfs-ui'
import PdfsUIEnUS from '@univerjs-pro/pdfs-ui/locale/en-US'
import { LocaleType, mergeLocales, Univer } from '@univerjs/core'
import { FUniver } from '@univerjs/core/facade'
import DesignEnUS from '@univerjs/design/locale/en-US'
import { UniverUIPlugin } from '@univerjs/ui'
import UIEnUS from '@univerjs/ui/locale/en-US'
import '@univerjs-pro/pdfs/facade'
import '@univerjs/design/lib/index.css'
import '@univerjs/ui/lib/index.css'
import '@univerjs-pro/pdfs-ui/lib/index.css'

const univer = new Univer({
  locale: LocaleType.EN_US,
  locales: {
    [LocaleType.EN_US]: mergeLocales(DesignEnUS, UIEnUS, PdfsUIEnUS),
  },
})

univer.registerPlugin(UniverUIPlugin, { container: 'app' })
univer.registerPlugin(UniverLicensePlugin, {
  license: process.env.CLIENT_LICENSE_TEXT,
})
univer.registerPlugin(UniverPdfsPlugin)
univer.registerPlugin(UniverPdfsUIPlugin)

const univerAPI = FUniver.newAPI(univer)
const pdf = univerAPI.createPdf({ name: 'Untitled PDF' })
```

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

### FUniver.getPdfTableThemePresets usage example

Source: https://docs.univer.ai/reference/facade/univer

Example of getting the PDF table-theme presets and logging them.

```typescript
const presets = univerAPI.getPdfTableThemePresets()console.log(presets)
```

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

### Create Univer instance and register plugins

Source: https://docs.univer.ai/guides/boards/getting-started/installation

Create a Univer instance, register plugins, and create a Board unit. Register UniverLicensePlugin before registering Board plugins.

```javascript
const univer = new Univer({  locale: LocaleType.EN_US,  locales: {    [LocaleType.EN_US]: mergeLocales(      DesignEnUS,      UIEnUS,      DocsUIEnUS,      DrawingUIEnUS,      InkUIEnUS,      BoardsUIEnUS,    ),  },})univer.registerPlugin(UniverRenderEnginePlugin)univer.registerPlugin(UniverUIPlugin, { container: 'app' })univer.registerPlugin(UniverDocsPlugin)univer.registerPlugin(UniverDocsUIPlugin)univer.registerPlugin(UniverDrawingPlugin)univer.registerPlugin(UniverDrawingUIPlugin)univer.registerPlugin(UniverInkUIPlugin)univer.registerPlugin(UniverLicensePlugin, {  license: process.env.CLIENT_LICENSE_TEXT,})univer.registerPlugin(UniverBoardsPlugin)univer.registerPlugin(UniverBoardsUIPlugin)univer.createUnit(UniverInstanceType.UNIVER_BOARD, {})const univerAPI = FUniver.newAPI(univer)
```

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

### Run Exchange example

Source: https://docs.univer.ai/server/collaboration/examples

Runs the Exchange example, which composes @univerjs-pro/exchange-node with Collaboration Service for server-side Sheet import and export, task polling, snapshot import, and confirmed-revision export. After running, open http://127.0.0.1:3010/?unit=exchange-sheet&type=2. Import through File → Open (File) and export through File → Save As.

```bash
pnpm example:exchange
```

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

### FDocument.getCalloutAt example

Source: https://docs.univer.ai/reference/facade/document

Example usage of FDocument.getCalloutAt to get the callout at offset 150.

```javascript
const fDocument = univerAPI.getActiveDocument()const callout = fDocument.getCalloutAt(150)console.log(callout)
```

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

### FDocument.getCallout example

Source: https://docs.univer.ai/reference/facade/document

Example usage of FDocument.getCallout to get a callout by its block id.

```javascript
const fDocument = univerAPI.getActiveDocument()const callout = fDocument.getCallout('block-id-123')console.log(callout)
```

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

### describe() example

Source: https://docs.univer.ai/reference/facade/document-text-range

Returns a serializable summary of the text range, suitable for agent/tool responses. The example retrieves the range for the paragraph containing 'Launch' and logs the description.

```javascript
const fDocument = univerAPI.getActiveDocument()
const range = fDocument?.findParagraphByText('Launch')?.getTextRange()
console.log(range?.describe())
```

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

### Describe list item example

Source: https://docs.univer.ai/reference/facade/document-list-item

Example of getting a description of a list item.

```javascript
const fDocument = univerAPI.getActiveDocument()const item = fDocument.findListItemByText('Ship API')console.log(item?.describe())
```

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

### Install @univerjs/action-recorder with bun

Source: https://docs.univer.ai/blog/action-recorder

Install the action-recorder package using bun. Use the package manager that matches your project.

```bash
bun add @univerjs/action-recorder
```

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

### Install preset-docs-drawing package

Source: https://docs.univer.ai/guides/docs/features/images

Install the preset-docs-drawing package for preset mode using your preferred package manager.

```bash
pnpm add @univerjs/preset-docs-drawing
```

```bash
npm install @univerjs/preset-docs-drawing
```

```bash
yarn add @univerjs/preset-docs-drawing
```

```bash
bun add @univerjs/preset-docs-drawing
```

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

### FBaseTableRange.getRow example

Source: https://docs.univer.ai/reference/facade/base-table-range

Example of getting the first row index of the data range.

```javascript
const fBase = univerAPI.getActiveBase()
const fBaseTable = fBase.getTableById('table-1')
const range = fBaseTable.getDataRange()
console.log(range.getRow())
```

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

### FBaseTableRange.getRange example

Source: https://docs.univer.ai/reference/facade/base-table-range

Example of getting the raw range position of the data range.

```javascript
const fBase = univerAPI.getActiveBase()
const fBaseTable = fBase.getTableById('table-1')
const range = fBaseTable.getDataRange()
console.log(range.getRange())
```

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

### Install preset-docs-node-core with pnpm

Source: https://docs.univer.ai/guides/docs/getting-started/node

Install the preset package for headless Univer in Node.js using pnpm.

```bash
pnpm add @univerjs/preset-docs-node-core
```

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

### setPageSetup example

Source: https://docs.univer.ai/reference/facade/document-section

Updates the page setup of the second section in a traditional document. Requires a traditional document and an existing section; throws if the section is missing or the update fails.

```TypeScript
const document = univerAPI.getActiveDocument()
if (!document?.isTraditional()) {
  throw new Error('A Traditional document is required')
}
const section = document.getSection(1)
if (!section) {
  throw new Error('The second section does not exist')
}
const updated = section.setPageSetup({
  pageSize: { width: 816, height: 1056 },
  marginTop: 96,
  marginBottom: 96,
  marginLeft: 96,
  marginRight: 96,
})
if (!updated) {
  throw new Error('Failed to update section page setup')
}
console.log(section.getEffectivePageSetup())
```

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

### FBaseTableRange.getColumn example

Source: https://docs.univer.ai/reference/facade/base-table-range

Example of getting the first column index of the data range.

```javascript
const fBase = univerAPI.getActiveBase()
const fBaseTable = fBase.getTableById('table-1')
const range = fBaseTable.getDataRange()
console.log(range.getColumn())
```

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

### Install @univerjs/ui-adapter-web-component

Source: https://docs.univer.ai/guides/docs/ui/components

Install the Univer Web Component adapter package using your preferred package manager. Choose the command that matches your environment.

```bash
pnpm add @univerjs/ui-adapter-web-component
```

```bash
npm install @univerjs/ui-adapter-web-component
```

```bash
yarn add @univerjs/ui-adapter-web-component
```

```bash
bun add @univerjs/ui-adapter-web-component
```

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

### FConnectorShape.setStartPoint signature and example

Source: https://docs.univer.ai/reference/facade/connector-shape

Method signature for setting a free start point, which removes any existing start binding while preserving the end binding, followed by an example in document coordinates.

```typescript
setStartPoint(point: IShapePoint): this
```

```typescript
fConnectorShape.setStartPoint({ x: 80, y: 120 })
```

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

### Install @univerjs/ui-adapter-web-component with bun

Source: https://docs.univer.ai/guides/sheets/ui/components

Install the Univer Web Component adapter package using bun.

```bash
bun add @univerjs/ui-adapter-web-component
```

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

### FBaseTableView.setGroup example

Source: https://docs.univer.ai/reference/facade/base-table-view

Example usage of setGroup to set group rules on a view. The example retrieves the active base, gets a table by ID, gets a view by name, and sets a group rule with a field ID and sort direction. Logs success or failure.

```typescript
const fBase = univerAPI.getActiveBase()const fBaseTable = fBase.getTableById('table-1')const view = fBaseTable.getViewByName('Grid')const success = view.setGroup([  {    fieldId: 'status',    direction: univerAPI.Enum.BaseSortDirection.ASC,  },])console.log(success ? 'Group set' : 'Set group failed')
```

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

### Install @univerjs/ui-adapter-web-component with npm

Source: https://docs.univer.ai/guides/sheets/ui/components

Install the Univer Web Component adapter package using npm.

```bash
npm install @univerjs/ui-adapter-web-component
```

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

### FUniver.getPdf usage example

Source: https://docs.univer.ai/reference/facade/univer

Example of getting a PDF unit by ID and logging its pages.

```typescript
const pdf = univerAPI.getPdf('pdf-unit-id')console.log(pdf?.getPages())
```

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

### Install @univerjs-pro/pdfs-print with bun

Source: https://docs.univer.ai/guides/pdfs/features/print

Install the print plugin using bun.

```bash
bun add @univerjs-pro/pdfs-print
```

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

### FWorkbook.getUrl example

Source: https://docs.univer.ai/reference/facade/workbook

Example usage of FWorkbook.getUrl. Gets the active workbook and logs its URL.

```javascript
// The code below gets the URL of the workbookconst fWorkbook = univerAPI.getActiveWorkbook()const url = fWorkbook.getUrl()console.log(url)
```

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

### FWorkbook.getSheets example

Source: https://docs.univer.ai/reference/facade/workbook

Example usage of FWorkbook.getSheets. Gets the active workbook and logs all worksheets.

```javascript
// The code below gets all the worksheets in the workbookconst fWorkbook = univerAPI.getActiveWorkbook()const sheets = fWorkbook.getSheets()console.log(sheets)
```

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

### Install @univerjs/icons with bun

Source: https://docs.univer.ai/guides/icons/react

Install the icon package using bun.

```bash
bun add @univerjs/icons
```

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

### Install @univerjs/preset-docs-hyper-link

Source: https://docs.univer.ai/guides/docs/features/hyper-link

Install the hyperlink preset for Univer docs in preset mode using your preferred package manager.

```bash
pnpm add @univerjs/preset-docs-hyper-link
```

```bash
npm install @univerjs/preset-docs-hyper-link
```

```bash
yarn add @univerjs/preset-docs-hyper-link
```

```bash
bun add @univerjs/preset-docs-hyper-link
```

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

### FWorkbook.getName example

Source: https://docs.univer.ai/reference/facade/workbook

Example usage of FWorkbook.getName. Gets the active workbook and logs its name.

```javascript
// The code below gets the name of the workbookconst fWorkbook = univerAPI.getActiveWorkbook()const name = fWorkbook.getName()console.log(name)
```

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

### Install with npm

Source: https://docs.univer.ai/guides/docs/features/list

Install the enhanced list packages using npm.

```bash
npm install @univerjs-pro/docs-list @univerjs-pro/docs-list-ui
```

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

### FSlide.getName example

Source: https://docs.univer.ai/reference/facade/slide

Gets the slide name. The example logs the name of the first slide.

```typescript
const fPresentation = univerAPI.getActivePresentation()const fSlide = fPresentation.getSlideByIndex(0)console.log(fSlide.getName())
```

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

### Install @univerjs/ui-adapter-vue3 with bun

Source: https://docs.univer.ai/guides/slides/ui/components

Installs the Vue 3 adapter plugin using bun.

```bash
bun add @univerjs/ui-adapter-vue3
```

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

### Get view filter example

Source: https://docs.univer.ai/reference/facade/base-table-view

Example that retrieves the filter of a Grid view and logs it.

```typescript
const fBase = univerAPI.getActiveBase()const fBaseTable = fBase.getTableById('table-1')const view = fBaseTable.getViewByName('Grid')console.log(view.getFilter())
```

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

### FBaseTableRange.getBaseId example

Source: https://docs.univer.ai/reference/facade/base-table-range

Example of getting the Base id from the data range of a Base table.

```javascript
const fBase = univerAPI.getActiveBase()
const fBaseTable = fBase.getTableById('table-1')
const range = fBaseTable.getDataRange()
console.log(range.getBaseId())
```

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

### Load server unit example

Source: https://docs.univer.ai/reference/facade/univer

Example of loading a server unit and logging the unit model and its snapshot.

```typescript
const unitModel = await univerAPI.loadServerUnit(  'unitId',  univerAPI.Enum.UniverInstanceType.UNIVER_SHEET,)console.log(unitModel, unitModel?.getSnapshot())
```

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

### Install @univerjs-pro/docs-sdt packages with bun

Source: https://docs.univer.ai/guides/docs/features/content-controls

Install the Docs SDT and SDT UI packages using bun. Required before creating a document with content controls.

```bash
bun add @univerjs-pro/docs-sdt @univerjs-pro/docs-sdt-ui
```

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

### Get start arrowhead

Source: https://docs.univer.ai/reference/facade/connector-shape

Logs the configured start arrowhead, or null when none is configured.

```typescript
console.log(fConnectorShape.getStartArrow())
```

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

### describe() Example

Source: https://docs.univer.ai/reference/facade/document-callout

Returns an agent-friendly description of the callout, including id, range, text, config, and compact style, or null if it no longer exists.

```javascript
const fDocument = univerAPI.getActiveDocument()const callout = fDocument.findCalloutByText('Important')if (callout) {  console.log(callout.describe())}
```

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

### Get conditional formatting rules example

Source: https://docs.univer.ai/reference/facade/worksheet

Example of retrieving and logging all conditional formatting rules.

```typescript
const fWorkbook = univerAPI.getActiveWorkbook()const fWorksheet = fWorkbook.getSheetByName('Sheet1')if (!fWorksheet) throw new Error('fWorksheet is not available')const rules = fWorksheet.getConditionalFormattingRules()console.log(rules)
```

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

### Install @univerjs/ui-adapter-web-component with pnpm

Source: https://docs.univer.ai/guides/sheets/ui/components

Install the Univer Web Component adapter package using pnpm.

```bash
pnpm add @univerjs/ui-adapter-web-component
```

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

### FUniver.disposeUnit example

Source: https://docs.univer.ai/reference/facade/univer

Example of disposing the active workbook by getting its unit ID and calling disposeUnit.

```typescript
const fWorkbook = univerAPI.getActiveWorkbook()const unitId = fWorkbook?.getId()if (unitId) {  univerAPI.disposeUnit(unitId)}
```
Tokens:
Raw