FDocumentCode
Facade object for a single docs code block.
Access
Access through:
FDocument.getCodes()FDocument.getCode()FDocument.getCodeAt()FDocument.findCodeByText()FDocument.findCodes()FDocument.insertCode()
Example
const fDocument = univerAPI.getActiveDocument()const codes = fDocument.getCodes()console.log(codes)const code = fDocument.findCodeByText('function')console.log(code?.getText())console.log(code?.getConfig())code?.updateConfig({ language: 'javascript', lineNumbers: true })console.log(code?.describe())code?.unwrap()code?.remove()Setup
Register @univerjs-pro/docs-code or a preset that includes it. In plugin mode, import @univerjs-pro/docs-code/facade. Additional methods below require their listed plugin packages. See Facade setup.
@univerjs-pro/docs-code
FDocumentCode.describe
Returns an agent-friendly description of the code.
describe(): IDocsCodeInfo | nullReturns
The code id, range, and text, or null if it no longer exists.
Examples
const fDocument = univerAPI.getActiveDocument()const code = fDocument.findCodeByText('function')if (code) { console.log(code.describe())}Types: IDocsCodeInfo
Package: @univerjs-pro/docs-code · Type definitions
FDocumentCode.getConfig
Returns the code block configuration.
getConfig(): IDocsCodeConfigReturns
Language, wrapping, line number, and tab-size settings.
Examples
const fDocument = univerAPI.getActiveDocument()const code = fDocument.findCodeByText('function')if (code) { console.log(code.getConfig())}Types: IDocsCodeConfig
Package: @univerjs-pro/docs-code · Type definitions
FDocumentCode.getId
Returns the code block id.
getId(): stringReturns
The code block range id.
Examples
const fDocument = univerAPI.getActiveDocument(); const codes = fDocument.getCodes();
// Get the id of the first code block. if (codes.length > 0) { const code = codes[0]; console.log(code.getId()); }
**Package:** [`@univerjs-pro/docs-code`](/reference/packages/plugins/univerjs-pro/docs-code) · [Type definitions](https://unpkg.com/@univerjs-pro/docs-code@1.0.0-rc.0/lib/types/facade/f-document-code.d.ts)### `FDocumentCode.getRange` [#getrange]Returns the code block range in the document data stream.```typescriptgetRange(): IDocsCodeRange | nullReturns
The code range, or null if it no longer exists.
Examples
const fDocument = univerAPI.getActiveDocument(); const codes = fDocument.getCodes();
// Get the range of the first code block. if (codes.length > 0) { const code = codes[0]; console.log(code.getRange()); }
**Types:** [`IDocsCodeRange`](https://unpkg.com/@univerjs-pro/docs-code@1.0.0-rc.0/lib/types/facade/types.d.ts)**Package:** [`@univerjs-pro/docs-code`](/reference/packages/plugins/univerjs-pro/docs-code) · [Type definitions](https://unpkg.com/@univerjs-pro/docs-code@1.0.0-rc.0/lib/types/facade/f-document-code.d.ts)### `FDocumentCode.getText` [#gettext]Returns plain text inside the code.```typescriptgetText(): stringReturns
The code text with block tokens removed.
Examples
const fDocument = univerAPI.getActiveDocument(); const code = fDocument.findCodeByText('function');
if (code) { console.log(code.getText()); }
**Package:** [`@univerjs-pro/docs-code`](/reference/packages/plugins/univerjs-pro/docs-code) · [Type definitions](https://unpkg.com/@univerjs-pro/docs-code@1.0.0-rc.0/lib/types/facade/f-document-code.d.ts)### `FDocumentCode.remove` [#remove]Removes this code block and its content.```typescriptremove(): booleanReturns
Whether the code block was removed.
Examples
const fDocument = univerAPI.getActiveDocument()const code = fDocument.findCodeByText('function')if (code) { const success = code.remove() console.log(success)}Package: @univerjs-pro/docs-code · Type definitions
FDocumentCode.unwrap
Unwraps this code block by removing only the code block formatting.
unwrap(): booleanReturns
Whether the code block formatting was removed.
Examples
const fDocument = univerAPI.getActiveDocument()const code = fDocument.findCodeByText('function')if (code) { // Remove code block formatting from this block. const success = code.unwrap() console.log(success)}Package: @univerjs-pro/docs-code · Type definitions
FDocumentCode.updateConfig
Updates the code block configuration.
updateConfig(options: IDocsCodeUpdateFacadeOptions): booleanParameters
options— Required. Code block configuration patch.
Returns
Whether the update command succeeded.
Examples
const fDocument = univerAPI.getActiveDocument()const code = fDocument.findCodeByText('function')if (code) { code.updateConfig({ config: { language: 'typescript' } })}**Types:** [`IDocsCodeUpdateFacadeOptions`](https://unpkg.com/@univerjs-pro/docs-code@1.0.0-rc.0/lib/types/facade/types.d.ts)**Package:** [`@univerjs-pro/docs-code`](/reference/packages/plugins/univerjs-pro/docs-code) · [Type definitions](https://unpkg.com/@univerjs-pro/docs-code@1.0.0-rc.0/lib/types/facade/f-document-code.d.ts)How is this guide?