PageProxy

One page in the current Lucid document

Extends

• ElementProxy

Constructors

new PageProxy()

new PageProxy(id, client): PageProxy

Parameters

Returns

PageProxy

Overrides

ElementProxy.constructor

Properties

allBlocks

readonly allBlocks: MapProxy<string, BlockProxy>;

The blocks contained on this page, including ones inside groups

allGroups

readonly allGroups: MapProxy<string, GroupProxy>;

The groups contained on this page, including ones inside groups

allItems

readonly allItems: MapProxy<string, BlockProxy | LineProxy | GroupProxy>;

All blocks, lines, and groups on the page, including ones inside groups

allLines

readonly allLines: MapProxy<string, LineProxy>;

The lines contained on this page, including ones inside groups

allShapeData

readonly allShapeData: MapProxy<string, SerializedFieldType | DataError>;

All shape data accessible on this element, including shape data inherited from the page or a containing group.
This collection is read-only.

Inherited from

ElementProxy.allShapeData

blocks

readonly blocks: MapProxy<string, BlockProxy>;

The blocks contained directly on this page, not including ones inside groups

client

protected readonly client: EditorClient;

Inherited from

ElementProxy.client

groups

readonly groups: MapProxy<string, GroupProxy>;

The groups contained directly on this page, not including ones inside groups

id

readonly id: string;

The ID of this page

Inherited from

ElementProxy.id

lines

readonly lines: MapProxy<string, LineProxy>;

The lines contained directly on this page, not including ones inside groups

properties

readonly properties: WriteableMapProxy<string, UnsafeJsonSerializableOrUndefined, void, UnsafeJsonSerializableOrUndefined>;

All properties available on this element, organized by name.
Not all properties are writeable (e.g. "ClassName" on a block).
To move or resize elements, use setLocation() or setBoundingBox() or offset() instead.

For text area properties, properties.get('Text') returns plain text. To get or set
rich text with inline formatting (bold, italic, links, line spacing), use the Rich:
prefix: properties.get('Rich:Text') returns {t: string, m: Array} with text and
markup, and properties.set('Rich:Text', {t: 'hello', m: [{s: 0, e: 5, n: 'b', v: true}]})
sets bold text. This works with any text area name (e.g. 'Rich:Title',
'Rich:Cell_0,1').

Inherited from

ElementProxy.properties

referenceKeys

readonly referenceKeys: MapProxy<string | number, ReferenceKeyProxy>;

The set of reference keys, organized by their ID, which can be either a string or number.

For more information, see the Developer Guide.

Inherited from

ElementProxy.referenceKeys

shapeData

readonly shapeData: ShapeDataProxy;

The shape data set directly on this element (not including any shape data inherited from the page or a containing group).

Inherited from

ElementProxy.shapeData

Methods

addBlock()

addBlock(def): BlockProxy

Add a new block to this page.

IMPORTANT: Because code for block classes are loaded incrementally, you MUST call
EditorClient.loadBlockClasses with the given block class name (and wait for it to
resolve) before attempting to create a block. If you don't, an error will be thrown.

Parameters

Returns

BlockProxy

The added block

addDiagramFromMermaid()

addDiagramFromMermaid(
   diagramType, 
   mermaid, 
   origin?, 
exactPlacement?): Promise<(BlockProxy | LineProxy | GroupProxy)[]>

Add a diagram described by Mermaid markup to this page.

See https://mermaid.js.org/intro/syntax-reference.html for information on Mermaid markup syntax.

Parameters

Returns

Promise<(BlockProxy | LineProxy | GroupProxy)[]>

An array of the proxies for all the objects in the added diagram.

addGraph()

Experimental

addGraph(graphDefinition): Promise<BlockProxy>

Add a new graph to this page.

This method uses the CreateGraph command which provides enhanced graph creation
capabilities with data collection integration. For custom graph implementations,
you may also send a postMessage to the parent window for custom handling.

Parameters

Returns

Promise<BlockProxy>

A promise that resolves to the added graph block

addImage()

addImage(def): Promise<BlockProxy>

Add a new image to this page.

Parameters

Returns

Promise<BlockProxy>

The added image

addLine()

addLine(def): LineProxy

Add a new line to this page.

Parameters

Returns

LineProxy

The added line

applyRuleToAllItems()

applyRuleToAllItems(rule): void

Parameters

Returns

void

delete()

delete(): void

Delete this page from the document if possible

Returns

void

duplicate()

duplicate(): Promise<void>

Duplicates the page represented by the page proxy

Returns

Promise<void>

executeFormula()

executeFormula(formula): SerializedFieldType | DataError

Execute a formula in the context of this element

Parameters

Returns

SerializedFieldType | DataError

The result of the formula, or an error.

Inherited from

ElementProxy.executeFormula

exists()

exists(): boolean

Returns

boolean

true if this element still exists on the document, or false otherwise

Inherited from

ElementProxy.exists

findAvailableSpace()

findAvailableSpace(
   searchX, 
   searchY, 
   width, 
   height): object

Find available space on this page for adding new content.

Parameters

Returns

object

a reference to the page and origin (upper-left point) of the space you can add new
content of the given size to.

page

page: PageProxy;

x

x: number;

y

y: number;

findItems()

findItems(boundingBox, searchType): (BlockProxy | LineProxy | GroupProxy)[]

Parameters

Returns

(BlockProxy | LineProxy | GroupProxy)[]

Items in the given bounding box, based on the search type

getLLMContextForItems()

getLLMContextForItems(items, contextType): object

Parameters

Returns

object

A string representing the content of the items provided, including immediate surrounding context if
necessary, in a format that is easily understandable by LLMs like ChatGPT. Also a map of IDs, from the shortened
IDs provided for the items in the context to the actual Lucid item IDs.

idToLucidId

idToLucidId: Map<string, string>;

prompt

prompt: string;

getPageNumber()

getPageNumber(): number

Returns

number

the page number of this page

getRulesAppliedToAllItems()

getRulesAppliedToAllItems(): RuleProxy[]

Returns

RuleProxy[]

All conditional formatting rules that are applied to every item on this page

getSvg()

getSvg(
   items?, 
   includeBackground?, 
   viewBox?): GetSvgResult

Parameters

Returns

GetSvgResult

A promise resolving to an SVG string

getTitle()

getTitle(): string

Returns

string

the title of this page

groupBlocks()

groupBlocks(blocks): GroupProxy

Creates a new group from a list of items.

Parameters

Returns

GroupProxy

The added group

importLinks()

importLinks(links): Promise<void>

Import links onto this page as link unfurl blocks

NOTE: links will be unfurled by Lucid based on extensions installed by user

Parameters

Returns

Promise<void>

removeReferenceKey()

removeReferenceKey(key): void

Remove the specified reference key from this element.

Parameters

Returns

void

Inherited from

ElementProxy.removeReferenceKey

setReferenceKey()

setReferenceKey(key, settings): void

Set a reference key on this element, replacing any existing reference at the specified key.

Parameters

Returns

void

Inherited from

ElementProxy.setReferenceKey

setTitle()

setTitle(title): void

Updates the page of this page

Parameters

Returns

void

unapplyRuleToAllItems()

unapplyRuleToAllItems(rule): void

Parameters

Returns

void