Editor Extension SDK Reference

The result of the formula, or an error.

Inherited from

ItemProxy.executeFormula

exists

▸ exists(): boolean

Returns

boolean

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

Inherited from

ItemProxy.exists

getBoundingBox

▸ getBoundingBox(): Box

Returns

The bounding box of this item relative to its containing page. As pages may change size to fit the content on them, note that these coordinates may be negative or very large.

If this is a rotated block, the bounding box returned here is where the block would be if it were unrotated.

Inherited from

ItemProxy.getBoundingBox

getClassName

▸ getClassName(): string

Returns

string

The class name of this block. This name is not necessarily human-readable, and will remain consistent over time, e.g. "ProcessBlock"..

getConnectedLines

▸ getConnectedLines(): LineProxy []

Returns

LineProxy []

An array of lines that have one or both endpoints connected to this block.

getContainers

▸ getContainers(): BlockProxy []

Returns

BlockProxy []

An array of blocks whose bounding boxes contain this item's upper-left corner

Inherited from

ItemProxy.getContainers

getLineWidth

▸ getLineWidth(): number

Returns

number

The line width used by most kinds of blocks to render their outline.

getLocation

▸ getLocation(): Object

Returns

Object

The x/y location of this item

Name	Type
x	number
y	number

Inherited from

ItemProxy.getLocation

getPage

▸ getPage(): PageProxy

Returns

The page containing this item

Inherited from

ItemProxy.getPage

getPageId

▸ getPageId(): string

Returns

string

The ID of the page containing this item

undefined | SimpleStaticDataGraphicSettings

Settings for the simple static data graphic currently set on this block, or undefined if no simple data graphic is currently set. Note that if a data graphic exists that is not an icon, this will return undefined. This function will not consider data graphics set via conditional formatting rules.

linkText

▸ linkText(textAreaKey, referenceKey, field): void

Link a text area to a data field, so that editing the text area will also update the associated data, and vice versa.

To use this, first establish a reference key on this block with setReferenceKey.

Parameters

Name	Type
textAreaKey	string
referenceKey	string \| number
field	string

Returns

void

lockAspectRatio

▸ lockAspectRatio(): void

Lock this block's aspect ratio to its current value. This can be reversed with unlockAspectRatio.

Returns

void

measureText

▸ measureText(name, maxWidth): MeasureTextResult

Measure the amount of space necessary to render the text in the given text area, given a width to measure that text within.

Parameters

Name	Type	Description
name	string	Name of the text area whose content we should measure
maxWidth	number	Width of the area in which to measure this text. The result will usually be no wider than this, but if a single word is long enough to go beyond this maxWidth, the width of that word will be returned.

Returns

ItemProxy.removeReferenceKey

The size of rectangle necessary to render this text area's content.

Inherited from

ItemProxy.measureText

offset

▸ offset(type, offset): void

Offset this item in the given direction by the given amount.

Parameters

Name	Type	Description
type	LinearOffsetType	The type of offset to apply to this item
offset	Point	The amount to offset

Returns

void

Inherited from

ItemProxy.offset

removeReferenceKey

▸ removeReferenceKey(key): void

Remove the specified reference key from this element.

Parameters

Name	Type
key	string \| number

Returns

void

Inherited from

setBoundingBox

▸ setBoundingBox(bb): void

Attempts to move and resize this item to fit into the given bounding box. If this item (or another item it contains) has size or aspect ratio restrictions, it may not be possible to fit the requested location exactly.

This is done by moving this item to the requested location, then attempting to resize it from the bottom-right corner to the requested size.

Parameters

Name	Type	Description
bb	Box	The bounding box to attempt to make this item fill

Returns

void

Inherited from

ItemProxy.setBoundingBox

setDataSyncStateIconPosition

▸ setDataSyncStateIconPosition(position): void

Parameters

Name	Type	Description
position	undefined \| BadgeEnumPosition	The postion where the data sync state icon should be displayed on the block. If this position is set to undefined then the state icon position will fallback to the default position for the block.

Returns

void

setFillStyle

▸ setFillStyle(fillStyle): void

Set the fill style used (by most kinds of blocks) to fill in their main opaque areas. This can be a string color (e.g. '#ff00ff80') or an image fill.

Parameters

Name	Type
fillStyle	SimpleFillStyle

Returns

void

setLineWidth

▸ setLineWidth(width): void

Parameters

Name	Type	Description
width	number	The line width to be used (by most kinds of blocks) to render this block's outline

Returns

void

setLocation

▸ setLocation(location): void

Moves this item so that its upper-left corner is positioned at the given location (prior to any rotation)

Parameters

Name	Type	Description
location	Point	The target location

Returns

void

Inherited from

ItemProxy.setLocation

setReferenceKey

▸ setReferenceKey(key, settings): void

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

Parameters

Name	Type
key	string \| number
settings	ReferenceKeyDefinition

unlockAspectRatio

▸ unlockAspectRatio(): void

Unlock the aspect ratio of this block, allowing it to be stretched vertically or horizontally independently.

Returns

void

CardBlockProxy

document/blockclasses/cardblockproxy.CardBlockProxy

A generic lucid card block. This shape has all of the base functionality as a BlockProxy, as well as additional card specific properties.

Hierarchy

BlockProxy

↳ CardBlockProxy

Constructors

constructor

• new CardBlockProxy(id, client)

Parameters

Name	Type	Description
id	string	ID of this item
client	EditorClient

Inherited from

Properties

allShapeData

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

Inherited from

textAreas

• Readonly textAreas: WriteableMapProxy <string, string, undefined, string>

The plain text in each of the text areas on this item, organized by text area name.

Inherited from

textStyles

• Readonly textStyles: WriteableMapProxy <string, TextStyle , Promise<undefined>, Partial< TextStyle >>

The text style in each of the text areas on this item, organized by text area name.

Inherited from

classNameRegex

▪ Static classNameRegex: RegExp

Methods

applyRule

▸ applyRule(rule): void

Parameters

Name	Type	Description
rule	RuleProxy	Rule to apply to this item

Returns

void

Inherited from

changeZOrder

▸ changeZOrder(operation): void

Parameters

Name	Type	Description
operation	ZOrderOperation	How to adjust the Z order of this item relative to the other items it overlaps on the page

Returns

void

Inherited from

delete

▸ delete(): void

Delete this item from the document

Returns

void

Inherited from

executeFormula

▸ executeFormula(formula): SerializedFieldType | DataError

Execute a formula in the context of this element

Parameters

Name	Type	Description
formula	string	The formula text, e.g. "@a + @b" to add together the shape data values a and b.

Returns

The result of the formula, or an error.

Inherited from

exists

▸ exists(): boolean

Returns

boolean

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

Inherited from

getAssignee

▸ getAssignee(): string

Returns

string

getBoundingBox

▸ getBoundingBox(): Box

Returns

Returns

number

The line width used by most kinds of blocks to render their outline.

Inherited from

BlockProxy.getLineWidth

getLocation

▸ getLocation(): Object

Returns

Object

The x/y location of this item

Name	Type
x	number
y	number

▸ lockAspectRatio(): void

Lock this block's aspect ratio to its current value. This can be reversed with unlockAspectRatio.

Returns

void

Inherited from

measureText

▸ measureText(name, maxWidth): MeasureTextResult

Measure the amount of space necessary to render the text in the given text area, given a width to measure that text within.

Parameters

Name	Type	Description
name	string	Name of the text area whose content we should measure
maxWidth	number	Width of the area in which to measure this text. The result will usually be no wider than this, but if a single word is long enough to go beyond this maxWidth, the width of that word will be returned.

Returns

The size of rectangle necessary to render this text area's content.

Inherited from

offset

▸ offset(type, offset): void

Offset this item in the given direction by the given amount.

Parameters

Name	Type	Description
type	LinearOffsetType	The type of offset to apply to this item
offset	Point	The amount to offset

Returns

void

Inherited from

removeReferenceKey

▸ removeReferenceKey(key): void

Remove the specified reference key from this element.

Parameters

Name	Type
key	string \| number

Returns

void

Inherited from

setAssignee

▸ setAssignee(assignee): void

Parameters

Name	Type	Description
assignee	string	The assignee that you want to set for this card.

Returns

void

setBoundingBox

▸ setBoundingBox(bb): void

This is done by moving this item to the requested location, then attempting to resize it from the bottom-right corner to the requested size.

Parameters

Name	Type	Description
bb	Box	The bounding box to attempt to make this item fill

setFillStyle

▸ setFillStyle(fillStyle): void

Set the fill style used (by most kinds of blocks) to fill in their main opaque areas. This can be a string color (e.g. '#ff00ff80') or an image fill.

Parameters

Name	Type
fillStyle	SimpleFillStyle

Returns

void

Inherited from

setLineWidth

▸ setLineWidth(width): void

Parameters

Name	Type	Description
width	number	The line width to be used (by most kinds of blocks) to render this block's outline

Returns

void

Inherited from

setLocation

▸ setLocation(location): void

Moves this item so that its upper-left corner is positioned at the given location (prior to any rotation)

Parameters

Name	Type	Description
location	Point	The target location

Returns

void

Inherited from

setReferenceKey

▸ setReferenceKey(key, settings): void

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

Parameters

Name	Type
key	string \| number
settings	ReferenceKeyDefinition

unlockAspectRatio

▸ unlockAspectRatio(): void

Unlock the aspect ratio of this block, allowing it to be stretched vertically or horizontally independently.

Returns

void

Inherited from

DocumentElementProxy.constructor

CardConfigProxy

document/documentelement/cardconfigproxy.CardConfigProxy

Base class for anything on a Lucid document that has an ID and properties.

Hierarchy

DocumentElementProxy

↳ CardConfigProxy

Constructors

constructor

• new CardConfigProxy(id, client)

Parameters

Name	Type	Description
id	string	The ID of this card config element
client	EditorClient

Overrides

Properties

client

• Protected Readonly client: EditorClient

Inherited from

DocumentElementProxy.client

id

• Readonly id: string

Inherited from

DocumentElementProxy.id

properties

• Readonly properties: WriteableMapProxy <string, JsonSerializable , void, JsonSerializable >

Inherited from

DocumentElementProxy.properties

CollectionEnumFieldType

core/data/fieldtypedefinition/collectionenumfieldtype.CollectionEnumFieldType

Constructors

constructor

• new CollectionEnumFieldType(collectionId)

Parameters

Name	Type
collectionId	string

Properties

collectionId

• Readonly collectionId: string

PRIMARY_KEY

▪ Static Readonly PRIMARY_KEY: Id = CollectionEnumFieldNames.Id

Specifies which groovy field name is used as the primary key.

This should be kept in sync with GroovyFieldNames in FieldType.scala

Methods

toJSON

▸ toJSON(): SerializedCollectionEnumFieldType

Returns

SerializedCollectionEnumFieldType

CollectionProxy

data/collectionproxy.CollectionProxy

A collection is a set of data items, each with the same set of fields (though some data items may not have all fields defined).

Hierarchy

PropertyStoreProxy

↳ CollectionProxy

Constructors

constructor

• new CollectionProxy(id, client)

Parameters

Name	Type	Description
id	string	ID of this collection on the current document
client	EditorClient

Overrides

PropertyStoreProxy.client

Properties

client

• Protected Readonly client: EditorClient

Inherited from

id

• Readonly id: string

Inherited from

PropertyStoreProxy.id

items

• Readonly items: MapProxy <string, DataItemProxy >

The data items in this collection, organized by their primary key. The primary key is usually calculated from the content of the data item, but may differ from the expected value in some circumstances, e.g. if there are two data items that would have the same primary key.

properties

• Readonly properties: WriteableMapProxy <string, JsonSerializable , void, JsonSerializable >

Inherited from

PropertyStoreProxy.properties

Methods

getBranchedFrom

▸ getBranchedFrom(): undefined | CollectionProxy

constructor

• new ColorLegendEntryProxy(legend, index)

Parameters

Name	Type
legend	LegendBlockProxy
index	number

Overrides

LegendEntryProxy.constructor

Properties

Methods

CustomBlockProxy

document/blockclasses/customblockproxy.CustomBlockProxy

Custom shapes defined in extension packages (or other stencil-providing means like Visio stencil imports) are represented by a CustomBlockProxy.

Hierarchy

BlockProxy

↳ CustomBlockProxy

Constructors

constructor

• new CustomBlockProxy(id, client)

Parameters

Name	Type	Description
id	string	ID of this item
client	EditorClient

Inherited from

Properties

allShapeData

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

Inherited from

textAreas

• Readonly textAreas: WriteableMapProxy <string, string, undefined, string>

The plain text in each of the text areas on this item, organized by text area name.

Inherited from

textStyles

• Readonly textStyles: WriteableMapProxy <string, TextStyle , Promise<undefined>, Partial< TextStyle >>

The text style in each of the text areas on this item, organized by text area name.

Inherited from

classNameRegex

▪ Static classNameRegex: RegExp

Methods

applyRule

▸ applyRule(rule): void

Parameters

Name	Type	Description
rule	RuleProxy	Rule to apply to this item

Returns

void

Inherited from

changeZOrder

▸ changeZOrder(operation): void

Parameters

Name	Type	Description
operation	ZOrderOperation	How to adjust the Z order of this item relative to the other items it overlaps on the page

Returns

void

Inherited from

delete

▸ delete(): void

Delete this item from the document

Returns

void

Inherited from

executeFormula

▸ executeFormula(formula): SerializedFieldType | DataError

Execute a formula in the context of this element

Parameters

Name	Type	Description
formula	string	The formula text, e.g. "@a + @b" to add together the shape data values a and b.

Returns

The result of the formula, or an error.

Inherited from

exists

▸ exists(): boolean

Returns

boolean

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

Inherited from

getBoundingBox

▸ getBoundingBox(): Box

Returns

Returns

Object

The x/y location of this item

Name	Type
x	number
y	number

getStencilTextAreaName

▸ getStencilTextAreaName(stencilTextAreaName): undefined | string

Parameters

Name	Type
stencilTextAreaName	string

Returns

undefined | string

isFromStencil

▸ isFromStencil(library, shape): boolean

Parameters

Name	Type
library	string
shape	string

Returns

boolean

linkText

▸ linkText(textAreaKey, referenceKey, field): void

Link a text area to a data field, so that editing the text area will also update the associated data, and vice versa.

To use this, first establish a reference key on this block with setReferenceKey.

Parameters

Name	Type
textAreaKey	string
referenceKey	string \| number
field	string

Returns

void

Inherited from

lockAspectRatio

▸ lockAspectRatio(): void

Lock this block's aspect ratio to its current value. This can be reversed with unlockAspectRatio.

Returns

void

Inherited from

measureText

▸ measureText(name, maxWidth): MeasureTextResult

Measure the amount of space necessary to render the text in the given text area, given a width to measure that text within.

Parameters

Name	Type	Description
name	string	Name of the text area whose content we should measure
maxWidth	number	Width of the area in which to measure this text. The result will usually be no wider than this, but if a single word is long enough to go beyond this maxWidth, the width of that word will be returned.

Returns

The size of rectangle necessary to render this text area's content.

Inherited from

offset

▸ offset(type, offset): void

Offset this item in the given direction by the given amount.

Parameters

Name	Type	Description
type	LinearOffsetType	The type of offset to apply to this item
offset	Point	The amount to offset

Returns

void

Inherited from

removeReferenceKey

▸ removeReferenceKey(key): void

Remove the specified reference key from this element.

Parameters

Name	Type
key	string \| number

Returns

void

Inherited from

setBoundingBox

▸ setBoundingBox(bb): void

This is done by moving this item to the requested location, then attempting to resize it from the bottom-right corner to the requested size.

Parameters

Name	Type	Description
bb	Box	The bounding box to attempt to make this item fill

Returns

void

Inherited from

setDataSyncStateIconPosition

▸ setDataSyncStateIconPosition(position): void

Parameters

Name	Type	Description
position	undefined \| BadgeEnumPosition	The postion where the data sync state icon should be displayed on the block. If this position is set to undefined then the state icon position will fallback to the default position for the block.

Returns

void

Inherited from

setFillStyle

▸ setFillStyle(fillStyle): void

Set the fill style used (by most kinds of blocks) to fill in their main opaque areas. This can be a string color (e.g. '#ff00ff80') or an image fill.

Parameters

Name	Type
fillStyle	SimpleFillStyle

Returns

void

Inherited from

setLineWidth

▸ setLineWidth(width): void

Parameters

Name	Type	Description
width	number	The line width to be used (by most kinds of blocks) to render this block's outline

Returns

void

Inherited from

setLocation

▸ setLocation(location): void

Moves this item so that its upper-left corner is positioned at the given location (prior to any rotation)

Parameters

Name	Type	Description
location	Point	The target location

Returns

void

Inherited from

setReferenceKey

▸ setReferenceKey(key, settings): void

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

Parameters

Name	Type
key	string \| number
settings	ReferenceKeyDefinition

unlockAspectRatio

▸ unlockAspectRatio(): void

Unlock the aspect ratio of this block, allowing it to be stretched vertically or horizontally independently.

Returns

void

Inherited from

registerCustomBlockClass

▸ Static registerCustomBlockClass(klass): void

Parameters

Name	Type
klass	CustomBlockProxyConstructor

Returns

void

DataConnector

dataconnector/dataconnector.DataConnector

Factory class to define a bunch of action handlers.

Constructors

constructor

• new DataConnector(client)

Parameters

Name	Type
client	DataConnectorClient

Properties

actions

• actions: Record<string, { actionResponder: ActionRequest< DataConnectorAsynchronousAction , unknown> ; asynchronous: true } | { actionResponder: ActionRequest< DataConnectorAction , unknown> ; asynchronous: false }> = {}

routes

• routes: Record<string, DataConnectorRoute > = {}

Methods

defineAction

▸ defineAction<T>(name, request, asynchronous?): DataConnector

Factory to define an action request handler

Type parameters

Name	Type
T	extends string

Parameters

Name	Type	Default value
name	T	undefined
request	ActionTypeForName<T, boolean>	undefined
asynchronous	boolean	false

Returns

DataConnector

defineAsynchronousAction

▸ defineAsynchronousAction<T>(name, request): DataConnector

Factory to define an asynchronous action request handler

Type parameters

Name	Type
T	extends string

Parameters

Name	Type
name	T
request	ActionTypeForName<T, true>

Returns

DataConnector

defineRoute

▸ defineRoute(name, request): DataConnector

Factory to define a route handler

Parameters

Name	Type
name	string
request	DataConnectorRoute

Returns

DataConnector

routeDebugServer

▸ routeDebugServer(options): ExpressAppLike

Add a route to the given express app (or generate a new app) to serve this data connector

Parameters

Name	Type
options	RunDebugServerOptions

Returns

ExpressAppLike

runAction

▸ runAction(url, headers, body): Promise<{ body: unknown ; status: number }>

Call a defined action handler and gather its serialized response

Parameters

Name	Type
url	string
headers	Record<string, undefined \| string \| string[]>
body	unknown

Returns

Promise<{ body: unknown ; status: number }>

runDebugServer

▸ runDebugServer(options): void

Serve this data connector as a simple express app for debugging purposes

Parameters

Name	Type
options	RunDebugServerOptions

Returns

void

DataConnectorAction

dataconnector/actions/action.DataConnectorAction

Base class for actions to be performed by data connectors

Hierarchy

DataConnectorAction

↳ DataConnectorAsynchronousAction

↳ DataConnectorSynchronousAction

↳ DataConnectorPatchAction

↳ DataConnectorManageWebhookAction

Constructors

constructor

• new DataConnectorAction(name, context)

Parameters

Name	Type
name	string
context	DataConnectorActionContext

Properties

context

• context: DataConnectorActionContext

name

• name: string

DataConnectorActionContext

dataconnector/actions/action.DataConnectorActionContext

This holds all the contextual information about a give data action.

Constructors

constructor

• new DataConnectorActionContext(packageId, packageVersion, userCredential, dataConnectorName, installationId, documentCollections, updateFilterType)

Parameters

Name	Type	Description
packageId	string	The package ID of the extension that triggered this action
packageVersion	string	The version of the extension that triggered this action
userCredential	string	The authorized OAuth2 credential that Lucid has for the 3rd party this extension works with
dataConnectorName	string	The data connector name from manifest.json that triggered this action
installationId	undefined \| string	The installation id of the extension/user that triggered this action
documentCollections	Object	Set of items this document is tracking as a Record<CollectionId, ItemPrimaryKey[]>
updateFilterType	DataUpdateFilterType	Update filter type for this document

Properties

dataConnectorName

• dataConnectorName: string

The data connector name from manifest.json that triggered this action

documentCollections

• documentCollections: Object

Set of items this document is tracking as a Record<CollectionId, ItemPrimaryKey[]>

Index signature

▪ [collectionId: CollectionId ]: ItemPrimaryKey []

installationId

• installationId: undefined | string

The installation id of the extension/user that triggered this action

packageId

• Readonly packageId: string

The package ID of the extension that triggered this action

packageVersion

• packageVersion: string

The version of the extension that triggered this action

updateFilterType

• updateFilterType: DataUpdateFilterType

Update filter type for this document

userCredential

• userCredential: string

The authorized OAuth2 credential that Lucid has for the 3rd party this extension works with

DataConnectorAsynchronousAction

dataconnector/actions/action.DataConnectorAsynchronousAction

A generic "asynchronous" action to be performed by the data connector. This is an action that reports back to Lucid by calling back in the DataSourceClient rather than returning a meaningful value.

Hierarchy

DataConnectorAction

↳ DataConnectorAsynchronousAction

Constructors

constructor

• new DataConnectorAsynchronousAction(name, context, client, data)

Parameters

Name	Type
name	string
context	DataConnectorActionContext
client	DataSourceClient
data	unknown

Overrides

Properties

client

• client: DataSourceClient

context

• context: DataConnectorActionContext

Inherited from

data

• data: unknown

name

• name: string

Inherited from

DataConnectorClient

dataconnector/dataconnectorclient.DataConnectorClient

Client for requests to and from Lucid

Hierarchy

DataConnectorClient

↳ MockDataConnectorClient

Constructors

constructor

• new DataConnectorClient(cryptoDependencies, urls?, fetchMethod?)

Parameters

Name	Type	Default value
cryptoDependencies	CryptoDependencies	undefined
urls	Object	LUCID_URLS
urls.api	string	undefined
urls.main	string	undefined
fetchMethod	GlobalFetchType	globalFetch

Properties

urls

• urls: Object = LUCID_URLS

Type declaration

Name	Type
api	string
main	string

Methods

getDataSourceClient

▸ getDataSourceClient(updateToken): DataSourceClient

Get a client for DataSource related requests to Lucid

Parameters

Name	Type
updateToken	string

Parameters

Name	Type
url	string
headers	Record<string, unknown>
actions	unknown

Returns

Promise<undefined | DataConnectorAction []>

DataConnectorManageWebhookAction

dataconnector/actions/action.DataConnectorManageWebhookAction

A "synchronous" style action indicating that Lucid would like to setup a webhook in the third party.

Hierarchy

DataConnectorAction

↳ DataConnectorManageWebhookAction

Constructors

constructor

• new DataConnectorManageWebhookAction(context, webhookToken, webhooks)

Parameters

Name	Type	Description
context	DataConnectorActionContext	-
webhookToken	string	Token to be added to the newly created webhook so that when it fires it will have permissions to make changes to Lucid documents.
webhooks	Webhook []	A list of existing webhooks so you can be more granular about what you track. You may also find it useful to delete some of the existing webhooks. The response back to Lucid should include all existing webhooks (newly created or any of these that were not deleted).

Overrides

Properties

context

• context: DataConnectorActionContext

Inherited from

name

• name: string

Inherited from

webhookToken

• webhookToken: string

Token to be added to the newly created webhook so that when it fires it will have permissions to make changes to Lucid documents.

webhooks

• webhooks: Webhook []

A list of existing webhooks so you can be more granular about what you track. You may also find it useful to delete some of the existing webhooks. The response back to Lucid should include all existing webhooks (newly created or any of these that were not deleted).

DataConnectorPatchAction

dataconnector/actions/action.DataConnectorPatchAction

A patch action is a kind of synchronous style action. It occurs when data is changed in the Lucid editor. All the changes are collected in the patches field.

Hierarchy

DataConnectorAction

↳ DataConnectorPatchAction

Constructors

constructor

• new DataConnectorPatchAction(context, patches, client, name?)

Parameters

Name	Type	Default value	Description
context	DataConnectorActionContext	undefined	-
patches	Patch []	undefined	changes applied by Lucid
client	DataSourceClient	undefined	-
name	string	DataConnectorActionKeys.Patch	-

Overrides

Properties

client

• client: DataSourceClient

context

• context: DataConnectorActionContext

Inherited from

name

• name: string

Inherited from

patches

• patches: Patch []

changes applied by Lucid

DataConnectorRequestError

dataconnector/dataconnector.DataConnectorRequestError

Thrown by any failable http APIs

Hierarchy

Error

↳ DataConnectorRequestError

Constructors

constructor

• new DataConnectorRequestError(status, message, response, statusText?)

Parameters

Name	Type
status	number
message	string
response	string
statusText?	string

Overrides

Error.constructor

• Optional statusText: string

Methods

toString

▸ toString(): string

Returns

string

DataConnectorRequestState

dataconnector/dataconnector.DataConnectorRequestState

Constructors

constructor

• new DataConnectorRequestState(itemRekeyer)

Parameters

Name	Type
itemRekeyer	ItemRekeyer

Properties

itemRekeyer

• itemRekeyer: ItemRekeyer

DataConnectorResponseError

dataconnector/dataconnector.DataConnectorResponseError

Thrown by any APIs the client didn't recognize when parsing

Hierarchy

Error

↳ DataConnectorResponseError

Constructors

constructor

• new DataConnectorResponseError(message, response)

Parameters

Name	Type
message	string
response	string

Overrides

Error.constructor

Properties

message

• message: string

Inherited from

Error.message

name

• name: string

Inherited from

Error.name

response

• response: string

stack

• Optional stack: string

Inherited from

Error.stack

DataConnectorRunError

dataconnector/dataconnector.DataConnectorRunError

Throw this from an action request handler to produce a non-200 response code and not have to return the expected result type

Hierarchy

Error

↳ DataConnectorRunError

Constructors

constructor

• new DataConnectorRunError(status, body, message?)

Parameters

Name	Type
status	number
body	unknown
message?	string

Overrides

Error.constructor

withMessage

▸ Static withMessage(status, message): DataConnectorRunError

Parameters

Name	Type
status	number
message	string

Returns

DataConnectorRunError

DataConnectorSynchronousAction

dataconnector/actions/action.DataConnectorSynchronousAction

A generic "synchronous" action to be performed by the data connector.

Hierarchy

DataConnectorAction

↳ DataConnectorSynchronousAction

Constructors

constructor

• new DataConnectorSynchronousAction(name, context, data)

Parameters

Name	Type
name	string
context	DataConnectorActionContext
data	unknown

Overrides

Properties

context

• context: DataConnectorActionContext

Inherited from

data

• data: unknown

name

• name: string

Inherited from

DataError

data/dataerror.DataError

The requested data or formula result couldn't be calculated.

Constructors

constructor

• new DataError(error, type)

Parameters

Name	Type	Description
error	string	A human-readable description of the reason why the error occurred
type	DataErrorType	The kind of error that occurred

Properties

error

• Readonly error: string

type

• Readonly type: DataErrorType

DataItemProxy

data/dataitemproxy.DataItemProxy

One data item in a collection, consisting of key-value pairs

Hierarchy

DataItemProxy

↳ PatchedDataItemProxy

Constructors

constructor

• new DataItemProxy(primaryKey, collection, client)

Parameters

Name	Type	Description
primaryKey	string	The current primary key of the data item. This may change if the fields on the data item change, rendering this proxy inoperable.
collection	CollectionProxy	The collection that contains this data item.
client	EditorClient

Properties

collection

• Readonly collection: CollectionProxy

fields

• Readonly fields: MapProxy <string, SerializedFieldType >

The fields on this data item, organized by their name.

primaryKey

• Readonly primaryKey: string

Methods

exists

▸ exists(): boolean

Returns

boolean

True if a data item exists in this collection at this primary key

DataProxy

data/dataproxy.DataProxy

The DataProxy class gives access to the tabular and graph data on the current Lucid document.

Data collections are organized into data sources. One data sources is typically produced for each data import, and may contain multiple collections.

Constructors

constructor

• new DataProxy(client)

Parameters

Name	Type
client	EditorClient

Properties

dataSources

• Readonly dataSources: MapProxy <string, DataSourceProxy >

Data sources on the current document, organized by their ID on this document. The ID will remain stable for as long as the data source exists on this document, but will vary from the data source ID on other documents if the same data is imported there.

Methods

addDataSource

▸ addDataSource(name, sourceConfig): DataSourceProxy

Creates a new empty data source, which you can then add collections of data to.

Parameters

Name	Type	Description
name	string	Human-readable name of the new data source
sourceConfig	Object	Any configuration values that might be useful to reference later, such as the upstream origin of this data source

Returns

DataSourceProxy

the newly created data source

DataSourceClient

dataconnector/datasourceclient.DataSourceClient

Authenticated client for DataSource related requests to Lucid.

Hierarchy

DataSourceClient

↳ MockDataSourceClient

Constructors

constructor

• new DataSourceClient(urls, updateToken, fetchMethod?)

Parameters

Name	Type	Default value
urls	Object	undefined
urls.api	string	undefined
urls.main	string	undefined
updateToken	string	undefined
fetchMethod	GlobalFetchType	globalFetch

Methods

update

▸ update(request): Promise<void>

Create or update a datasource. If you create a new collection it must be fully specified in terms of schema and and items. If it's just an update then the schema can be omitted (if unchanged) and items that already exist can be partial.

Parameters

Name	Type
request	DataSourceRequest

Returns

Promise<void>

DataSourceProxy

data/datasourceproxy.DataSourceProxy

A data source represents a set of related data collections on a document. Typically one data source is produced for each data import.

Hierarchy

PropertyStoreProxy

↳ DataSourceProxy

Constructors

constructor

• new DataSourceProxy(id, client)

Parameters

Name	Type	Description
id	string	ID of the dataSource on the current document
client	EditorClient

Overrides

PropertyStoreProxy.client

Properties

client

• Protected Readonly client: EditorClient

Inherited from

collections

• Readonly collections: MapProxy <string, CollectionProxy >

The set of data collections in this data source, organized by ID on this document. The IDs will remain stable for as long as the collection exists on this document, but will vary from the collection ID on other documents if the same data is imported there.

id

• Readonly id: string

Inherited from

PropertyStoreProxy.id

properties

• Readonly properties: WriteableMapProxy <string, JsonSerializable , void, JsonSerializable >

Inherited from

PropertyStoreProxy.properties

Methods

addCollection

▸ addCollection(name, schema): CollectionProxy

Create a new collection as part of this data source.

Parameters

Name	Type
name	string
schema	SchemaDefinition

Returns

CollectionProxy

The newly created collection

getName

▸ getName(): string

Returns

string

A human-readable name for this data source

getSourceConfig

▸ getSourceConfig(): Object

Returns

Object

The source configuration values set when this data source was created

DocumentElementProxy

document/documentelement/documentelementproxy.DocumentElementProxy

Base class for anything on a Lucid document that has an ID and properties.

Hierarchy

PropertyStoreProxy

↳ DocumentElementProxy

↳↳ CardConfigProxy

↳↳ RuleProxy

Constructors

constructor

• new DocumentElementProxy(id, client)

Parameters

Name	Type	Description
id	string	The ID of this document element
client	EditorClient

Overrides

ElementProxy.allShapeData

Properties

DocumentProxy

document/documentproxy.DocumentProxy

The currently-open Lucid document

Hierarchy

ElementProxy

↳ DocumentProxy

Constructors

constructor

• new DocumentProxy(client)

Parameters

Name	Type
client	EditorClient

Overrides

ElementProxy.constructor

Properties

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

cardIntegrationConfigs

• Readonly cardIntegrationConfigs: MapProxy <string, CardConfigProxy >

client

• Protected Readonly client: EditorClient

Inherited from

ElementProxy.client

id

• Readonly id: string

Inherited from

ElementProxy.id

pages

• Readonly pages: MapProxy <string, PageProxy >

The set of pages on this document, organized by ID

properties

• Readonly properties: WriteableMapProxy <string, JsonSerializable , void, JsonSerializable >

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

rules

• Readonly rules: MapProxy <string, RuleProxy >

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

addPage

▸ addPage(def): PageProxy

Add a new page to the current document

Parameters

Name	Type	Description
def	PageDefinition	Definition of the page to add

Returns

ElementProxy.removeReferenceKey

The created page

addRule

▸ addRule(definition): undefined | RuleProxy

Parameters

Name	Type
definition	RuleDefinition

Name	Type
ids	string[]

boolean

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

Inherited from

ElementProxy.exists

getTitle

▸ getTitle(): string

Returns

string

The title of this document

hookAllChanges

▸ hookAllChanges(callback): string

Infrequently, you may need to watch for any changes to the document. These changes may be the local user adding content, or a data integration sending updated records to a data collection, or a remote user hitting undo, or any user entering or exiting an intra-document mutex.

Because these changes may happen rapidly, the callback you provide here will only be called on a heavily-debounced schedule. The callback will happen between 1-10 seconds after changes are made to the document, depending on the frequency with which changes are happening.

Parameters

Name	Type
callback	() => void

Returns

string

A handle that can be passed into unhookAllChanges

hookCreateItems

▸ hookCreateItems(callback): string

Watch for new blocks, lines, or groups added to this document. The callback will be called with new items created by the current user, but will not be called with items created

As part of a generated diagram, e.g. org chart
By another user on the same document

Parameters

Name	Type
callback	(items: ItemProxy []) => void

Returns

string

A handle that can be passed to unhookCreateItems

hookDeleteItems

▸ hookDeleteItems(callback): string

Watch for new blocks, lines, or groups deleted from this document. The callback will be called with items deleted by the current user, but will not be called with items deleted

As part of a generated diagram, e.g. org chart
By another user on the same document

Parameters

Name	Type
callback	(itemIds: string[]) => void

Returns

string

A handle that can be passed to unhookDeleteItems

removeReferenceKey

▸ removeReferenceKey(key): void

Remove the specified reference key from this element.

Parameters

Name	Type
key	string \| number

Returns

void

Inherited from

setReferenceKey

▸ setReferenceKey(key, settings): void

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

Parameters

Name	Type
key	string \| number
settings	ReferenceKeyDefinition

Returns

void

Inherited from

ElementProxy.setReferenceKey

setTitle

▸ setTitle(title): void

Updates the title of this document

Parameters

Name	Type	Description
title	string	The new title for this document

Returns

void

unhookAllChanges

▸ unhookAllChanges(handle): void

Parameters

Name	Type	Description
handle	string	Return value from hookAllChanges

Returns

void

unhookCreateItems

▸ unhookCreateItems(handle): void

Parameters

Name	Type	Description
handle	string	Return value from hookCreateItems

Returns

void

unhookDeleteItems

▸ unhookDeleteItems(handle): void

Parameters

Name	Type	Description
handle	string	Return value from hookDeleteItems

Returns

void

EditorClient

editorclient.EditorClient

Constructors

constructor

• new EditorClient()

Methods

actionExists

▸ actionExists(name): boolean

Parameters

Name	Type	Description
name	string	name of the action to check

Returns

boolean

true if a callback has been registered for this action; false otherwise

alert

▸ alert(text, title?, buttonText?): AlertResult

Display an alert modal to the user

Parameters

Name	Type	Description
text	string	Body text to display in the alert modal
title?	string	Title of the alert modal; defaults to the extension title specified in manifest.json
buttonText?	string	Text for the OK button; defaults to "OK" (or a translation)

Returns

AlertResult

a Promise that resolves true if the user clicks OK, false if they otherwise dismiss the modal

asyncOAuthXhr

▸ asyncOAuthXhr(providerName, request): Promise< TextXHRResponse >

Make an asyncronous OAuth network request. The request is enqueued to eventually execute. The request may be attempted multiple times with an overall timeout of 120 seconds.

Parameters

Name	Type	Description
providerName	string	Name of the OAuth provider
request	OAuthXHRRequest & { responseFormat: "utf8" }	Settings for the request

Returns

Promise< TextXHRResponse >

A promise that will either resolve or reject with an XHRResponse. If the HTTP status code is not 2xx, the promise will reject.

▸ asyncOAuthXhr(providerName, request): Promise< BinaryXHRResponse >

Parameters

Name	Type
providerName	string
request	OAuthXHRRequest & { responseFormat: "binary" }

Returns

Promise< BinaryXHRResponse >

▸ asyncOAuthXhr(providerName, request): Promise< XHRResponse >

Parameters

Name	Type
providerName	string
request	OAuthXHRRequest

True if the current user is allowed to edit package settings on this installation of this extension (if any settings exist), or false otherwise.

confirm

▸ confirm(text, title?, okText?, cancelText?): ConfirmResult

Display a confirm modal to the user

Parameters

Name	Type	Description
text	string	Body text to display in the alert modal
title?	string	Title of the alert modal; defaults to the extension title specified in manifest.json
okText?	string	Text for the OK button; defaults to "OK" (or a translation)
cancelText?	string	Text for the Cancel button; defaults to "Cancel" (or a translation)

Returns

ConfirmResult

a Promise that resolves true if the user clicks OK, false if they click Cancel or otherwise dismiss the modal

createUserImage

▸ createUserImage(mediaType, data): Promise<string>

Upload an image and return a URL that can be used for displaying that image on the canvas. Note: the URL is public - anyone with the URL can access the image.

Parameters

Name	Type	Description
mediaType	string	The media type, e.g. 'image/png'
data	string \| Uint8Array	The binary image contents, or a base64-encoded string

Returns

Promise<string>

A promise that resolves with the URL of the created image.

deleteAction

▸ deleteAction(name): void

Remove the callback for a given action. If the action is later invoked, nothing will happen.

Parameters

Name	Type	Description
name	string	name of the action to unregister

Returns

void

download

▸ download(filename, data, mime, base64): void

Initiate a browser file download of custom content

Parameters

Name	Type	Description
filename	string	Filename of the downloaded file
data	string	The content to put into the file, either in plain text or as base64-encoded binary data
mime	string	The MIME type to tell the browser it is downloading
base64	boolean	If true, base64 decode the data before downloading it

Returns

void

duplicatePages

▸ duplicatePages(pageNums): Promise<void>

Duplicates one or more pages of the current document as new pages.

Parameters

Name	Type	Description
pageNums	number[]	An array of zero-indexed page indices to duplicate from the current document

Returns

Promise<void>

a promise that resolves to void when the pages have been duplicated or the the duplication failed

getBlockProxy

▸ getBlockProxy(id): BlockProxy

Create and return a proxy for accessing a block with the given ID. If the block is of a type that has a specific proxy implementation (e.g. an ERD block) then a specialized subclass of BlockProxy may be returned.

Parameters

Name	Type	Description
id	string	ID of the block to create a proxy for

Returns

BlockProxy

the given block

getCustomShapeDefinition

▸ getCustomShapeDefinition(library, shape): Promise<undefined | BlockDefinition >

Load the requested shape library's content, and if it was found, return a block definition ready to be created.

Example usage:

const client = new EditorClient(); const viewport = new Viewport(client); const page = viewport.getCurrentPage(); if (page) { const def = await page.getCustomShapeDefinition('libraryName', 'shapeName'); if (def) { //Customize the shape about to be created def.boundingBox.x = 500; def.boundingBox.y = 500; //Create the shape itself const block = page.addBlock(def); //Set any data fields on the shape as needed block.shapeData.set('Value', 50); } }

Parameters

Name	Type	Description
library	string	Name of the shape library in this extension to search for
shape	string	Name of the shape within that library to search for

Returns

Promise<undefined | BlockDefinition >

getElementProxy

▸ getElementProxy(id): ElementProxy

Parameters

Name	Type	Description
id	string	ID of the element to create a proxy for

Returns

ElementProxy

the given element

getItemProxy

▸ getItemProxy(id): BlockProxy | LineProxy | GroupProxy

Parameters

Name	Type	Description
id	string	ID of the item to create a proxy for

Returns

BlockProxy | LineProxy | GroupProxy

the given item

getLineProxy

▸ getLineProxy(id): LineProxy

Parameters

Name	Type	Description
id	string	ID of the line to create a proxy for

Returns

LineProxy

the given line

getOAuthClientId

▸ getOAuthClientId(providerName): Promise<undefined | string>

Fetch the OAuth Client Id if there is one

Parameters

Name	Type	Description
providerName	string	Name of the OAuth provider

Returns

Promise<undefined | string>

A oauth client id or undefined if it doesn't exist

getOAuthToken

▸ getOAuthToken(providerName): Promise<undefined | string>

Returns an OAuth token for the given provider, prompting the user to grant access if necessary

Parameters

Name	Type	Description
providerName	string	Name of the OAuth provider

Returns

Promise<undefined | string>

An oauth token, or undefined if a valid token cannot be obtained

getPackageSettings

▸ getPackageSettings(): Promise<Map<string, JsonSerializable >>

If the extension package containing this editor extension has configurable settings, fetch the current values of those settings for this installation of this extension.

Only settings that have been set by the installing user will have a value in the map, other settings will be missing.

Returns

Promise<Map<string, JsonSerializable >>

A promise that resolves to a map of setting names to current setting values

getPageProxy

▸ getPageProxy(id): PageProxy

Parameters

Name	Type	Description
id	string	ID of the page to create a proxy for

Returns

the given page

getProduct

▸ getProduct(): LucidProduct

Get which Lucid product this editor extension has been loaded in.

Returns

LucidProduct

importPage

▸ importPage(documentId, pageNums): Promise<void>

Import one or pages of the specified document or template into the current document as new pages. NOTE: The indices of the pages to import will change if the pages are rearranged on the source document or template.

Parameters

Name	Type	Description
documentId	string	The ID of the document or template to import
pageNums	number[]	An array of zero-indexed page indices to import from the document or template

Returns

Promise<void>

a promise that resolves to void when the pages have been imported or the the import failed

killExtension

▸ killExtension(): void

Unload this extension immediately, removing any custom menu items etc., until the user refreshes the browser tab.

Returns

void

loadBlockClasses

▸ loadBlockClasses(classNames): Promise<undefined>

Because code for block classes are loaded incrementally, you MUST call 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

Name	Type	Description
classNames	string[]	the block classes to load

Returns

Promise<undefined>

a promise that resolves when the block classes can be used to create new blocks on the document

oauthXhr

▸ oauthXhr(providerName, request): Promise< TextXHRResponse >

Make an OAuth network request. Make the request immediately and only once with a 10 second timeout.

Parameters

Name	Type	Description
providerName	string	Name of the OAuth provider
request	OAuthXHRRequest & { responseFormat: "utf8" }	Settings for the request

Returns

Promise< TextXHRResponse >

A promise that will either resolve or reject with an XHRResponse. If the HTTP status code is not 2xx, the promise will reject.

▸ oauthXhr(providerName, request): Promise< BinaryXHRResponse >

Parameters

Name	Type
providerName	string
request	OAuthXHRRequest & { responseFormat: "binary" }

Returns

Promise< BinaryXHRResponse >

▸ oauthXhr(providerName, request): Promise< XHRResponse >

Parameters

Name	Type
providerName	string
request	OAuthXHRRequest

Returns

Promise< XHRResponse >

performDataAction

▸ performDataAction(options): Promise< DataActionResponse >

Parameters

Name	Type
options	DataActionOptions

Returns

Promise< DataActionResponse >

permanentTokenXhr

▸ permanentTokenXhr(providerName, request): Promise< BinaryXHRResponse >

Parameters

Name	Type
providerName	string
request	XHRRequest & { responseFormat: "binary" }

Returns

Promise< BinaryXHRResponse >

▸ permanentTokenXhr(providerName, request): Promise< XHRResponse >

Parameters

Name	Type
providerName	string
request	XHRRequest

Returns

Promise< XHRResponse >

processAndClearBootstrapData

▸ processAndClearBootstrapData(callback, markExtensionAsRequired?): Promise<void>

Parameters

Name	Type	Description
callback	(data: JsonSerializable ) => void \| Promise<void>	A callback that processes the bootstrap data, if any, stored on the document and associated with this editor extension. If this callback is async (returns a promise), then the bootstrap data is not cleared off of the document until that promise resolves.
markExtensionAsRequired?	boolean	If bootstrap data is available for this editor extension, this will mark the document as requiring the extension. Once marked, if the extension is not installed the user will be notified about the extension being required on document load. The minimum extension version required by the document is the version provided in the request body when creating the document.

Returns

Promise<void>

a promise that resolves immediately if there is no available bootstrap data, or else after the callback successfully completes. This promise will reject/throw if the callback throws or returns a promise that rejects, or if there is another editor session processing the same bootstrap data at the same time.

prompt

▸ prompt(text, title?): PromptResult

Display a prompt modal to the user

Parameters

Name	Type	Description
text	string	Body text to display in the alert modal
title?	string	Title of the alert modal; defaults to the extension title specified in manifest.json

Returns

PromptResult

a Promise that resolves to a string if a user enters one, or undefined if they cancel

registerAction

▸ registerAction(name, callback): void

Some actions may return a value that is used by the core application, e.g. a visibleAction for a menu item. However, if you return a Promise from your callback, that value will be discarded and your action will return undefined instead. The ability to provide a callback that returns a Promise is only a convenience so that you can register actions with async callbacks for easy async/await.

Throws an error if the same action name is registered multiple times.

Parameters

Name	Type	Description
name	string	name of the action
callback	(value: any) => void \| JsonSerializable \| Promise<any>	function to execute when this action is invoked

Returns

void

registerFileUploadAction

▸ registerFileUploadAction(name, callback): void

Register a named action that receives file upload data. These callbacks can be used in Menu.addMenuItem as the file action.

Parameters

Name	Type	Description
name	string	The name of the action
callback	(files: FileUploadData []) => void	Function to execute when this action is invoked

Returns

void

registerUnfurlHandler

▸ registerUnfurlHandler(domain, callbacks): void

Registers a handler for link unfurling.

Parameters

Name	Type	Description
domain	string	The domain
callbacks	UnfurlCallbacks	The callbacks to call when a link matching the domain is pasted.

Returns

void

reloadExtension

▸ reloadExtension(): void

Unload this extension, and then re-execute it.

Returns

void

sendCommand

▸ sendCommand<C>(name, params): CommandArgs [C]["result"]

Execute an API command. This is the low-level API that most of this SDK wraps. It is not expected that you should ever need to use this directly.

Type parameters

Name	Type
C	extends CommandName

Parameters

Name	Type	Description
name	C	name of the API command to execute
params	UnionToIntersection< CommandArgs [C]["query"]>	data to pass to the API command

Returns

CommandArgs [C]["result"]

the output of the given API command

setPackageSettings

▸ setPackageSettings(settings): Promise<undefined>

If the extension package containing this editor extension has configurable settings, set the value of those settings for this installation of this extension. A subset of setting values can be provided to update those values while leaving others unchanged.

If the user does not have permission to change settings on this installation of this extension, or if no settings exist, an error is thrown.

Parameters

Name	Type
settings	Record<string, string> \| Map<string, string>

Returns

Promise<undefined>

showPackageSettingsModal

▸ showPackageSettingsModal(): Promise<void>

If the extension package containing this editor extension has configurable settings, show a standard modal allowing the user to view or change those settings.

If the user does not have permission to change settings on this installation of this extension, or if no settings exist, an error is thrown.

Returns

Promise<void>

A promise that resolves when the user closes the settings modal.

triggerAuthFlow

▸ triggerAuthFlow(providerName): TriggerAuthFlowResult

Parameters

Name	Type
providerName	string

Returns

TriggerAuthFlowResult

tryGetItemProxy

▸ tryGetItemProxy(id): undefined | BlockProxy | LineProxy | GroupProxy

Parameters

Name	Type	Description
id	string	ID of the item to create a proxy for

Returns

undefined | BlockProxy | LineProxy | GroupProxy

the given item, or undefined if the item does not exist or an error occurs

withIntraDocumentMutex

▸ withIntraDocumentMutex(name, callback): Promise<boolean>

Executes the given callback within a mutex scoped to the current document, extension, and the given name. If another editor session currently has the given mutex name locked within the same extension package ID on this same document, this function's returned promise will resolve to false. Otherwise, the mutex will be locked for the duration of the callback and the returned promise will resolve to true.

Parameters

Name	Type	Description
name	string	Name of the intra-document mutex to attempt to lock
callback	() => void \| Promise<void>	Code to execute while the mutex is locked, if it is successfully locked

Returns

Promise<boolean>

A promise resolving to a boolean indicating whether the mutex was successfully locked

withSilentActions

▸ withSilentActions(callback): void

Parameters

Name	Type	Description
callback	() => void	Callback that will be executed with the user's local undo/redo history suppressed. This is useful when you want to make changes to a document that will not be erased if the user uses undo or redo, for example adding shape data onto shapes as a result of a background process that collects data from a remote API.

Returns

void

xhr

▸ xhr(request): Promise< TextXHRResponse >

Make a network request

Parameters

Name	Type	Description
request	XHRRequest & { responseFormat: "utf8" }	Settings for the network request

Returns

Promise< TextXHRResponse >

A promise that will either resolve or reject with an XHRResponse. If the HTTP status code is not 2xx, the promise will reject.

▸ xhr(request): Promise< BinaryXHRResponse >

Parameters

Name	Type
request	XHRRequest & { responseFormat: "binary" }

Returns

Promise< BinaryXHRResponse >

▸ xhr(request): Promise< XHRResponse >

Parameters

Name	Type
request	XHRRequest

Returns

Promise< XHRResponse >

ElementProxy

document/elementproxy.ElementProxy

An element is anything on a Lucid document that can have properties and shape data:

The document itself
Pages
Blocks
Lines
Groups

Hierarchy

PropertyStoreProxy

↳ ElementProxy

↳↳ DocumentProxy

↳↳ ItemProxy

↳↳ PageProxy

Constructors

constructor

• new ElementProxy(id, client)

Parameters

Name	Type	Description
id	string	ID of this element
client	EditorClient

Overrides

Properties

allShapeData

• Readonly allShapeData: MapProxy <string, SerializedFieldType | DataError >

• Readonly shapeData: ShapeDataProxy

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

Methods

executeFormula

▸ executeFormula(formula): SerializedFieldType | DataError

Execute a formula in the context of this element

Parameters

Name	Type	Description
formula	string	The formula text, e.g. "@a + @b" to add together the shape data values a and b.

Returns

The result of the formula, or an error.

exists

▸ exists(): boolean

Returns

boolean

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

removeReferenceKey

▸ removeReferenceKey(key): void

Remove the specified reference key from this element.

Parameters

Name	Type
key	string \| number

Returns

void

setReferenceKey

▸ setReferenceKey(key, settings): void

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

Parameters

Name	Type
key	string \| number
settings	ReferenceKeyDefinition

Returns

void

ERDBlockProxy

document/blockclasses/erdblockproxy.ERDBlockProxy

Hierarchy

BlockProxy

↳ ERDBlockProxy

Constructors

constructor

• new ERDBlockProxy(id, client)

Parameters

Name	Type	Description
id	string	ID of this item
client	EditorClient

Inherited from

Properties

allShapeData

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

Inherited from

textAreas

• Readonly textAreas: WriteableMapProxy <string, string, undefined, string>

The plain text in each of the text areas on this item, organized by text area name.

Inherited from

textStyles

• Readonly textStyles: WriteableMapProxy <string, TextStyle , Promise<undefined>, Partial< TextStyle >>

The text style in each of the text areas on this item, organized by text area name.

Inherited from

classNameRegex

▪ Static classNameRegex: RegExp

Methods

applyRule

▸ applyRule(rule): void

Parameters

Name	Type	Description
rule	RuleProxy	Rule to apply to this item

Returns

void

Inherited from

changeZOrder

▸ changeZOrder(operation): void

Parameters

Name	Type	Description
operation	ZOrderOperation	How to adjust the Z order of this item relative to the other items it overlaps on the page

Returns

void

Inherited from

delete

▸ delete(): void

Delete this item from the document

Returns

void

Inherited from

executeFormula

▸ executeFormula(formula): SerializedFieldType | DataError

Execute a formula in the context of this element

Parameters

Name	Type	Description
formula	string	The formula text, e.g. "@a + @b" to add together the shape data values a and b.

Returns

The result of the formula, or an error.

Inherited from

exists

▸ exists(): boolean

Returns

boolean

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

Inherited from

getBoundingBox

▸ getBoundingBox(): Box

Returns

Returns

number

getFields

▸ getFields(): ERDFieldProxy []

Returns

ERDFieldProxy []

getLineWidth

▸ getLineWidth(): number

Returns

number

The line width used by most kinds of blocks to render their outline.

Inherited from

BlockProxy.getLineWidth

getLocation

▸ getLocation(): Object

Returns

Object

The x/y location of this item

Name	Type
x	number
y	number

Inherited from

BlockProxy.getLocation

undefined | SimpleStaticDataGraphicSettings

Inherited from

linkText

▸ linkText(textAreaKey, referenceKey, field): void

Link a text area to a data field, so that editing the text area will also update the associated data, and vice versa.

To use this, first establish a reference key on this block with setReferenceKey.

Parameters

Name	Type
textAreaKey	string
referenceKey	string \| number
field	string

Returns

void

Inherited from

lockAspectRatio

▸ lockAspectRatio(): void

Lock this block's aspect ratio to its current value. This can be reversed with unlockAspectRatio.

Returns

void

Inherited from

measureText

▸ measureText(name, maxWidth): MeasureTextResult

Measure the amount of space necessary to render the text in the given text area, given a width to measure that text within.

Parameters

Name	Type	Description
name	string	Name of the text area whose content we should measure
maxWidth	number	Width of the area in which to measure this text. The result will usually be no wider than this, but if a single word is long enough to go beyond this maxWidth, the width of that word will be returned.

Returns

The size of rectangle necessary to render this text area's content.

Inherited from

offset

▸ offset(type, offset): void

Offset this item in the given direction by the given amount.

Parameters

Name	Type	Description
type	LinearOffsetType	The type of offset to apply to this item
offset	Point	The amount to offset

Returns

void

Inherited from

removeReferenceKey

▸ removeReferenceKey(key): void

Remove the specified reference key from this element.

Parameters

Name	Type
key	string \| number

Returns

void

Inherited from

setBoundingBox

▸ setBoundingBox(bb): void

This is done by moving this item to the requested location, then attempting to resize it from the bottom-right corner to the requested size.

Parameters

Name	Type	Description
bb	Box	The bounding box to attempt to make this item fill

Returns

void

Inherited from

setDataSyncStateIconPosition

▸ setDataSyncStateIconPosition(position): void

Parameters

Name	Type	Description
position	undefined \| BadgeEnumPosition	The postion where the data sync state icon should be displayed on the block. If this position is set to undefined then the state icon position will fallback to the default position for the block.

Returns

void

Inherited from

setFillStyle

▸ setFillStyle(fillStyle): void

Set the fill style used (by most kinds of blocks) to fill in their main opaque areas. This can be a string color (e.g. '#ff00ff80') or an image fill.

Parameters

Name	Type
fillStyle	SimpleFillStyle

Returns

void

Inherited from

setLineWidth

▸ setLineWidth(width): void

Parameters

Name	Type	Description
width	number	The line width to be used (by most kinds of blocks) to render this block's outline

Returns

void

Inherited from

setLocation

▸ setLocation(location): void

Moves this item so that its upper-left corner is positioned at the given location (prior to any rotation)

Parameters

Name	Type	Description
location	Point	The target location

Returns

void

Inherited from

setReferenceKey

▸ setReferenceKey(key, settings): void

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

Parameters

Name	Type
key	string \| number
settings	ReferenceKeyDefinition

unlockAspectRatio

▸ unlockAspectRatio(): void

Unlock the aspect ratio of this block, allowing it to be stretched vertically or horizontally independently.

Returns

void

Inherited from

BaseFieldTypeArray.constructor

ERDFieldProxy

document/blockclasses/erdblockproxy.ERDFieldProxy

Constructors

constructor

• new ERDFieldProxy(block, index)

Parameters

Name	Type
block	ERDBlockProxy
index	number

Methods

getKey

▸ getKey(): string | number | boolean | JsonArray | JsonObject

Returns

string | number | boolean | JsonArray | JsonObject

getName

▸ getName(): string

Returns

string

getType

▸ getType(): string | number | boolean | JsonArray | JsonObject

Returns

string | number | boolean | JsonArray | JsonObject

FieldTypeArray<SubTypes>

core/data/fieldtypedefinition/fieldtypearray.FieldTypeArray

Type parameters

Name	Type
SubTypes	extends FieldTypeArraySubTypes = FieldTypeArraySubTypes

Hierarchy

BaseFieldTypeArray <SubTypes>

↳ FieldTypeArray

Constructors

constructor

• new FieldTypeArray<SubTypes>(validTypesArray)

Type parameters

Name	Type
SubTypes	extends FieldTypeArraySubTypes = FieldTypeArraySubTypes

Parameters

Name	Type
validTypesArray	SubTypes[]

Inherited from

Properties

validTypesArray

• Readonly validTypesArray: SubTypes[]

Inherited from

BaseFieldTypeArray.validTypesArray

Methods

Inherited from

BaseFieldTypeArray.toJSON

FormattedPrimaryKey<Fields, PrimaryKey>

core/data/fieldspecification.FormattedPrimaryKey

Generates a mapper that, given a primary key definition is able to produce the primary key for that item.

Type parameters

Name	Type
Fields	extends FieldsStructure
PrimaryKey	extends keyof Fields

Constructors

constructor

• new FormattedPrimaryKey<Fields, PrimaryKey>(...elements)

Type parameters

Name	Type
Fields	extends FieldsStructure
PrimaryKey	extends string \| number \| symbol

Parameters

Name	Type
...elements	PrimaryKey[]

Properties

elements

• Readonly elements: PrimaryKey[]

Methods

forItem

▸ forItem(item): string

Generate the serialized form of the item's primary key.

For single value primary keys, the encoded values are just the json representation of the primary key. For example, if the primary key is ['id'] the following table shows encodings:

type	value	encoded
number	15	new Map([["15", ...], ...])
boolean	false	new Map([["false", ...], ...])
string	"hello"	new Map([['"hello"', ...], ...])

Take note of the extra quotes in the string case.

For primary keys with multiple values, first sort the array of primary keys then join the json encoded values from of the keys with commas. For example:

undefined

                     primary key = ["lastName", "firstName"]
sorted key = ["firstName", "lastName"]
row = {"lastName": "Smith", "firstName": "John", "age": 42}
row key = '"John","Smith"'
items = new Map([['"John","Smith"', {"lastName": "Smith", "firstName": "John", "age": 42}]])
                  

Parameters

Name	Type
item	PartialItemType <Fields, PrimaryKey>

Returns

string

serializeList

▸ Static serializeList(items): string

Parameters

Name	Type
items	unknown[]

Returns

string

GroupProxy

document/groupproxy.GroupProxy

A group of items on a page.

Hierarchy

ItemProxy

↳ GroupProxy

Constructors

constructor

• new GroupProxy(id, client)

Parameters

Name	Type	Description
id	string	ID of this item
client	EditorClient

Inherited from

ItemProxy.constructor

Properties

allBlocks

• Readonly allBlocks: MapProxy <string, BlockProxy >

The blocks that are contained in this group, including those nested in deeper groups, organized by ID.

allGroups

• Readonly allGroups: MapProxy <string, GroupProxy >

The groups that are contained in this group, including those nested in deeper groups, organized by ID.

allLines

• Readonly allLines: MapProxy <string, LineProxy >

The lines that are contained in this group, including those nested in deeper groups, organized by ID.

allShapeData

applyRule

▸ applyRule(rule): void

Parameters

Name	Type	Description
rule	RuleProxy	Rule to apply to this item

Returns

void

Inherited from

ItemProxy.applyRule

changeZOrder

▸ changeZOrder(operation): void

Parameters

Name	Type	Description
operation	ZOrderOperation	How to adjust the Z order of this item relative to the other items it overlaps on the page

Returns

void

Inherited from

ItemProxy.changeZOrder

delete

▸ delete(): void

Delete this item from the document

Returns

void

Inherited from

ItemProxy.delete

executeFormula

▸ executeFormula(formula): SerializedFieldType | DataError

Execute a formula in the context of this element

Parameters

Name	Type	Description
formula	string	The formula text, e.g. "@a + @b" to add together the shape data values a and b.

Returns

The result of the formula, or an error.

Inherited from

ItemProxy.executeFormula

exists

▸ exists(): boolean

Returns

boolean

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

Inherited from

ItemProxy.exists

getBoundingBox

▸ getBoundingBox(): Box

Returns

The bounding box of this item relative to its containing page. As pages may change size to fit the content on them, note that these coordinates may be negative or very large.

If this is a rotated block, the bounding box returned here is where the block would be if it were unrotated.

Inherited from

ItemProxy.getBoundingBox

getContainers

▸ getContainers(): BlockProxy []

Returns

BlockProxy []

An array of blocks whose bounding boxes contain this item's upper-left corner

Inherited from

ItemProxy.getContainers

getLocation

▸ getLocation(): Object

Returns

Object

The x/y location of this item

Name	Type
x	number
y	number

Inherited from

ItemProxy.getLocation

getPage

▸ getPage(): PageProxy

Returns

The page containing this item

Inherited from

ItemProxy.getPage

getPageId

▸ getPageId(): string

Returns

string

The ID of the page containing this item

Inherited from

ItemProxy.getPageId

measureText

▸ measureText(name, maxWidth): MeasureTextResult

Measure the amount of space necessary to render the text in the given text area, given a width to measure that text within.

Parameters

Name	Type	Description
name	string	Name of the text area whose content we should measure
maxWidth	number	Width of the area in which to measure this text. The result will usually be no wider than this, but if a single word is long enough to go beyond this maxWidth, the width of that word will be returned.

Returns

ItemProxy.removeReferenceKey

The size of rectangle necessary to render this text area's content.

Inherited from

ItemProxy.measureText

offset

▸ offset(type, offset): void

Offset this item in the given direction by the given amount.

Parameters

Name	Type	Description
type	LinearOffsetType	The type of offset to apply to this item
offset	Point	The amount to offset

Returns

void

Inherited from

ItemProxy.offset

removeReferenceKey

▸ removeReferenceKey(key): void

Remove the specified reference key from this element.

Parameters

Name	Type
key	string \| number

Returns

void

Inherited from

setBoundingBox

▸ setBoundingBox(bb): void

This is done by moving this item to the requested location, then attempting to resize it from the bottom-right corner to the requested size.

Parameters

Name	Type	Description
bb	Box	The bounding box to attempt to make this item fill

Returns

void

Inherited from

ItemProxy.setBoundingBox

setLocation

▸ setLocation(location): void

Moves this item so that its upper-left corner is positioned at the given location (prior to any rotation)

Parameters

Name	Type	Description
location	Point	The target location

Returns

void

Inherited from

ItemProxy.setLocation

setReferenceKey

▸ setReferenceKey(key, settings): void

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

Parameters

Name	Type
key	string \| number
settings	ReferenceKeyDefinition

Returns

void

Inherited from

ItemProxy.setReferenceKey

unapplyRule

▸ unapplyRule(rule): void

Parameters

Name	Type	Description
rule	RuleProxy	Rule to remove from this item

Returns

void

Inherited from

ItemProxy.unapplyRule

HumanReadableError

core/humanreadableerror.HumanReadableError

An error carrying a message that is good to be shown directly in the UI. These can be thrown from extensions and caught in core code.

Hierarchy

Error

↳ HumanReadableError

Constructors

constructor

• new HumanReadableError(message?)

Parameters

Name	Type
message?	string

Inherited from

Error.constructor

Properties

message

• message: string

Inherited from

Error.message

name

• name: string = 'HumanReadableError'

Overrides

Error.name

stack

• Optional stack: string

Inherited from

Error.stack

I18nFormattedList

interop.I18nFormattedList

Constructors

constructor

• new I18nFormattedList()

I18nFormattedNumber

interop.I18nFormattedNumber

Constructors

constructor

• new I18nFormattedNumber()

I18nSafeString

interop.I18nSafeString

Constructors

constructor

• new I18nSafeString(str)

Parameters

Name	Type
str	string

Properties

value

• value: string

IframeUI

ui/iframeui.IframeUI

Base class for defining and interacting with custom UI elements whose contents are displayed in an iframe.

Hierarchy

IframeUI

↳ Modal

↳ Panel

Constructors

constructor

• new IframeUI(client)

Parameters

Name	Type
client	EditorClient

Properties

client

• Protected Readonly client: EditorClient

framePosition

• Protected framePosition: Object

The location of this frame within the top-level browser window. This is always updated immediately before messageFromFrame is called.

Type declaration

Name	Type
h	number
w	number
x	number
y	number

loaded

• Protected loaded: boolean = false

True after the iframe has fired an onload event (not all scripts are necessarily finished executing)

messageActionName

• Protected messageActionName: string

Methods

frameClosed

▸ Protected frameClosed(): void

sendMessage

▸ sendMessage(data): Promise<void>

Send a message to this UI component's iframe via window.postMessage.

Parameters

Name	Type	Description
data	JsonSerializable	Data to send to the iframe

Returns

Promise<void>

unhookMessages

▸ Protected unhookMessages(): void

Subclasses must call unhookMessages to allow them to be garbage collected.

Returns

void

ItemProxy

document/itemproxy.ItemProxy

A block, line, or group on a page of the current document.

Hierarchy

ElementProxy

↳ ItemProxy

↳↳ BlockProxy

↳↳ GroupProxy

↳↳ LineProxy

Constructors

constructor

• new ItemProxy(id, client)

Parameters

Name	Type	Description
id	string	ID of this item
client	EditorClient

Overrides

ElementProxy.constructor

Properties

allShapeData

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

textAreas

• Readonly textAreas: WriteableMapProxy <string, string, undefined, string>

The plain text in each of the text areas on this item, organized by text area name.

textStyles

• Readonly textStyles: WriteableMapProxy <string, TextStyle , Promise<undefined>, Partial< TextStyle >>

The text style in each of the text areas on this item, organized by text area name.

Methods

applyRule

▸ applyRule(rule): void

Parameters

Name	Type	Description
rule	RuleProxy	Rule to apply to this item

Returns

void

changeZOrder

▸ changeZOrder(operation): void

Parameters

Name	Type	Description
operation	ZOrderOperation	How to adjust the Z order of this item relative to the other items it overlaps on the page

boolean

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

Inherited from

ElementProxy.exists

getBoundingBox

▸ getBoundingBox(): Box

Returns

ElementProxy.setReferenceKey

The bounding box of this item relative to its containing page. As pages may change size to fit the content on them, note that these coordinates may be negative or very large.

If this is a rotated block, the bounding box returned here is where the block would be if it were unrotated.

getContainers

▸ getContainers(): BlockProxy []

Returns

BlockProxy []

An array of blocks whose bounding boxes contain this item's upper-left corner

getLocation

▸ getLocation(): Object

Returns

Object

The x/y location of this item

Name	Type
x	number
y	number

getPage

removeReferenceKey

▸ removeReferenceKey(key): void

Remove the specified reference key from this element.

Parameters

Name	Type
key	string \| number

Parameters

Name	Type
key	string \| number
settings	ReferenceKeyDefinition

Returns

void

Inherited from

unapplyRule

▸ unapplyRule(rule): void

Parameters

Name	Type	Description
rule	RuleProxy	Rule to remove from this item

Returns

void

ItemRekeyer

dataconnector/itemrekeyer.ItemRekeyer

Constructors

constructor

• new ItemRekeyer()

Methods

addRekeyingsFor

▸ addRekeyingsFor(collectionId, itemsPatch, primaryKey?): void

Parameters

Name	Type
collectionId	string
itemsPatch	ItemsPatch
primaryKey?	FormattedPrimaryKey <any, string>

Returns

void

getRekeyingMap

▸ getRekeyingMap(patch): undefined | RekeyingMap

Parameters

Name	Type
patch	Patch

Returns

undefined | RekeyingMap

ItemsPatchExhaustive

dataconnector/datasourceupdatetypes.ItemsPatchExhaustive

Constructors

constructor

• new ItemsPatchExhaustive(items, rekeyingMap?, errors?)

Parameters

Name	Type
items	Map<string, SerializedFields >
rekeyingMap?	Map<string, null \| string>
errors?	Map<string, SerializedLucidDictionary >

Properties

errors

• Optional errors: Map<string, SerializedLucidDictionary >

items

• items: Map<string, SerializedFields >

rekeyingMap

• Optional rekeyingMap: Map<string, null | string>

ItemsPatchInexhaustive

dataconnector/datasourceupdatetypes.ItemsPatchInexhaustive

Constructors

constructor

• new ItemsPatchInexhaustive(items, itemsDeleted?, errors?)

Parameters

Name	Type	Description
items	Map<string, SerializedFields >	Items to be added or changed in the collection. Mapping from item serialized primary key to the sparse patch of the item. See FormattedPrimaryKey.forItem.
itemsDeleted?	string[]	Items to remove from the collection, based on the same primary key algorithm.
errors?	Map<string, SerializedLucidDictionary >	-

Properties

errors

• Optional errors: Map<string, SerializedLucidDictionary >

items

• items: Map<string, SerializedFields >

Items to be added or changed in the collection. Mapping from item serialized primary key to the sparse patch of the item. See FormattedPrimaryKey.forItem.

itemsDeleted

• Optional itemsDeleted: string[]

Items to remove from the collection, based on the same primary key algorithm.

LegendBlockProxy

document/blockclasses/legendblockproxy.LegendBlockProxy

Hierarchy

BlockProxy

↳ LegendBlockProxy

Constructors

constructor

• new LegendBlockProxy(id, client)

Parameters

Name	Type	Description
id	string	ID of this item
client	EditorClient

Inherited from

Properties

allShapeData

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

Inherited from

textAreas

• Readonly textAreas: WriteableMapProxy <string, string, undefined, string>

The plain text in each of the text areas on this item, organized by text area name.

Inherited from

textStyles

• Readonly textStyles: WriteableMapProxy <string, TextStyle , Promise<undefined>, Partial< TextStyle >>

The text style in each of the text areas on this item, organized by text area name.

Inherited from

classNameRegex

▪ Static classNameRegex: RegExp

Methods

applyRule

▸ applyRule(rule): void

Parameters

Name	Type	Description
rule	RuleProxy	Rule to apply to this item

Returns

void

Inherited from

changeZOrder

▸ changeZOrder(operation): void

Parameters

Name	Type	Description
operation	ZOrderOperation	How to adjust the Z order of this item relative to the other items it overlaps on the page

Returns

void

Inherited from

delete

▸ delete(): void

Delete this item from the document

Returns

void

Inherited from

executeFormula

▸ executeFormula(formula): SerializedFieldType | DataError

Execute a formula in the context of this element

Parameters

Name	Type	Description
formula	string	The formula text, e.g. "@a + @b" to add together the shape data values a and b.

Returns

The result of the formula, or an error.

Inherited from

exists

▸ exists(): boolean

Returns

boolean

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

Inherited from

getBoundingBox

▸ getBoundingBox(): Box

Returns

Returns

string

getItems

▸ getItems(): LegendEntryProxy []

Returns

LegendEntryProxy []

getLineWidth

▸ getLineWidth(): number

Returns

number

The line width used by most kinds of blocks to render their outline.

Inherited from

BlockProxy.getLineWidth

getLocation

▸ getLocation(): Object

Returns

Object

The x/y location of this item

Name	Type
x	number
y	number

linkText

▸ linkText(textAreaKey, referenceKey, field): void

Link a text area to a data field, so that editing the text area will also update the associated data, and vice versa.

To use this, first establish a reference key on this block with setReferenceKey.

Parameters

Name	Type
textAreaKey	string
referenceKey	string \| number
field	string

Returns

void

Inherited from

lockAspectRatio

▸ lockAspectRatio(): void

Lock this block's aspect ratio to its current value. This can be reversed with unlockAspectRatio.

Returns

void

Inherited from

measureText

▸ measureText(name, maxWidth): MeasureTextResult

Measure the amount of space necessary to render the text in the given text area, given a width to measure that text within.

Parameters

Name	Type	Description
name	string	Name of the text area whose content we should measure
maxWidth	number	Width of the area in which to measure this text. The result will usually be no wider than this, but if a single word is long enough to go beyond this maxWidth, the width of that word will be returned.

Returns

The size of rectangle necessary to render this text area's content.

Inherited from

offset

▸ offset(type, offset): void

Offset this item in the given direction by the given amount.

Parameters

Name	Type	Description
type	LinearOffsetType	The type of offset to apply to this item
offset	Point	The amount to offset

Returns

void

Inherited from

removeReferenceKey

▸ removeReferenceKey(key): void

Remove the specified reference key from this element.

Parameters

Name	Type
key	string \| number

Returns

void

Inherited from

setBoundingBox

▸ setBoundingBox(bb): void

This is done by moving this item to the requested location, then attempting to resize it from the bottom-right corner to the requested size.

Parameters

Name	Type	Description
bb	Box	The bounding box to attempt to make this item fill

Returns

void

Inherited from

setDataSyncStateIconPosition

▸ setDataSyncStateIconPosition(position): void

Parameters

Name	Type	Description
position	undefined \| BadgeEnumPosition	The postion where the data sync state icon should be displayed on the block. If this position is set to undefined then the state icon position will fallback to the default position for the block.

Returns

void

Inherited from

setFillStyle

▸ setFillStyle(fillStyle): void

Set the fill style used (by most kinds of blocks) to fill in their main opaque areas. This can be a string color (e.g. '#ff00ff80') or an image fill.

Parameters

Name	Type
fillStyle	SimpleFillStyle

Returns

void

Inherited from

setLineWidth

▸ setLineWidth(width): void

Parameters

Name	Type	Description
width	number	The line width to be used (by most kinds of blocks) to render this block's outline

Returns

void

Inherited from

setLocation

▸ setLocation(location): void

Moves this item so that its upper-left corner is positioned at the given location (prior to any rotation)

Parameters

Name	Type	Description
location	Point	The target location

Returns

void

Inherited from

setReferenceKey

▸ setReferenceKey(key, settings): void

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

Parameters

Name	Type
key	string \| number
settings	ReferenceKeyDefinition

unlockAspectRatio

▸ unlockAspectRatio(): void

Unlock the aspect ratio of this block, allowing it to be stretched vertically or horizontally independently.

Returns

void

Inherited from

LegendEntryProxy

document/blockclasses/legendblockproxy.LegendEntryProxy

Hierarchy

LegendEntryProxy

↳ ColorLegendEntryProxy

↳ ShapeLegendEntryProxy

Constructors

constructor

• new LegendEntryProxy(legend, index, type)

Parameters

Name	Type
legend	LegendBlockProxy
index	number
type	LegendItemType

Properties

index

• Readonly index: number

legend

• Protected Readonly legend: LegendBlockProxy

type

• Readonly type: LegendItemType

Methods

getText

▸ getText(): string

Returns

string

setText

▸ setText(text): void

Parameters

Name	Type
text	string

Returns

void

LineProxy

document/lineproxy.LineProxy

A line on the current Lucid document

Hierarchy

ItemProxy

↳ LineProxy

Constructors

constructor

• new LineProxy(id, client)

Parameters

Name	Type	Description
id	string	ID of this item
client	EditorClient

Inherited from

ItemProxy.constructor

Properties

allShapeData

addTextArea

▸ addTextArea(text, position): string

Adds a new text area to this line at the given location with the given initial plain text. The text will be styled with the document theme, if any.

Parameters

Name	Type
text	string
position	LineTextAreaPositioning

Returns

string

The name of the text area added

applyRule

▸ applyRule(rule): void

Parameters

Name	Type	Description
rule	RuleProxy	Rule to apply to this item

Returns

void

Inherited from

ItemProxy.applyRule

changeZOrder

▸ changeZOrder(operation): void

Parameters

Name	Type	Description
operation	ZOrderOperation	How to adjust the Z order of this item relative to the other items it overlaps on the page

boolean

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

Inherited from

ItemProxy.exists

getBoundingBox

▸ getBoundingBox(): Box

Returns

Inherited from

ItemProxy.getLocation

getPage

▸ getPage(): PageProxy

Returns

The page containing this item

Inherited from

ItemProxy.getPage

getPageId

▸ getPageId(): string

Returns

string

The ID of the page containing this item

Inherited from

ItemProxy.getPageId

getRelativePosition

▸ getRelativePosition(relative): Point

Parameters

Name	Type	Description
relative	number	A distance, between 0 and 1, between the first and second endpoint of this line

Returns

Point

The coordinate of that relative position, relative to the containing page

getShape

▸ getShape(): LineShape

Returns

LineShape

getTextAreaPosition

▸ getTextAreaPosition(name): undefined | LineTextAreaPositioning

Parameters

Name	Type
name	string

Returns

undefined | LineTextAreaPositioning

The position of the given text area on this line, if it exists, or undefined if it does not exist.

getUpstreamConnection

▸ getUpstreamConnection(): undefined | void | BlockProxy | LineProxy

Returns

undefined | void | BlockProxy | LineProxy

The block or line connected to the first endpoint of this line, or undefined if none

measureText

▸ measureText(name, maxWidth): MeasureTextResult

Measure the amount of space necessary to render the text in the given text area, given a width to measure that text within.

Parameters

Name	Type	Description
name	string	Name of the text area whose content we should measure
maxWidth	number	Width of the area in which to measure this text. The result will usually be no wider than this, but if a single word is long enough to go beyond this maxWidth, the width of that word will be returned.

Returns

ItemProxy.removeReferenceKey

The size of rectangle necessary to render this text area's content.

Inherited from

ItemProxy.measureText

offset

▸ offset(type, offset): void

Offset this item in the given direction by the given amount.

Parameters

Name	Type	Description
type	LinearOffsetType	The type of offset to apply to this item
offset	Point	The amount to offset

Returns

void

Inherited from

ItemProxy.offset

removeReferenceKey

▸ removeReferenceKey(key): void

Remove the specified reference key from this element.

Parameters

Name	Type
key	string \| number

Returns

void

Inherited from

setBoundingBox

▸ setBoundingBox(bb): void

This is done by moving this item to the requested location, then attempting to resize it from the bottom-right corner to the requested size.

Parameters

Name	Type	Description
bb	Box	The bounding box to attempt to make this item fill

Parameters

Name	Type	Description
location	Point	The target location

Returns

void

Inherited from

ItemProxy.setLocation

setReferenceKey

▸ setReferenceKey(key, settings): void

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

Parameters

Name	Type
key	string \| number
settings	ReferenceKeyDefinition

Returns

void

Inherited from

ItemProxy.setReferenceKey

setShape

▸ setShape(shape): void

Parameters

Name	Type
shape	LineShape

Returns

void

setTextAreaPosition

▸ setTextAreaPosition(name, position): void

Updates the position of the given text area, if it exists. If not, an error is thrown.

Parameters

Name	Type
name	string
position	LineTextAreaPositioning

Returns

void

unapplyRule

▸ unapplyRule(rule): void

Parameters

Name	Type	Description
rule	RuleProxy	Rule to remove from this item

Returns

void

Inherited from

ItemProxy.unapplyRule

LinkUnfurlBlockProxy

document/blockclasses/linkunfurlblockproxy.LinkUnfurlBlockProxy

This is the kind of block that appears when a link is pasted onto the canvas of a Lucid editor.

Hierarchy

BlockProxy

↳ LinkUnfurlBlockProxy

Constructors

constructor

• new LinkUnfurlBlockProxy(id, client)

Parameters

Name	Type	Description
id	string	ID of this item
client	EditorClient

Inherited from

Properties

allShapeData

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

Inherited from

textAreas

• Readonly textAreas: WriteableMapProxy <string, string, undefined, string>

The plain text in each of the text areas on this item, organized by text area name.

Inherited from

textStyles

• Readonly textStyles: WriteableMapProxy <string, TextStyle , Promise<undefined>, Partial< TextStyle >>

The text style in each of the text areas on this item, organized by text area name.

Inherited from

classNameRegex

▪ Static classNameRegex: RegExp

Methods

applyRule

▸ applyRule(rule): void

Parameters

Name	Type	Description
rule	RuleProxy	Rule to apply to this item

Returns

void

Inherited from

changeZOrder

▸ changeZOrder(operation): void

Parameters

Name	Type	Description
operation	ZOrderOperation	How to adjust the Z order of this item relative to the other items it overlaps on the page

Returns

void

Inherited from

delete

▸ delete(): void

Delete this item from the document

Returns

void

Inherited from

executeFormula

▸ executeFormula(formula): SerializedFieldType | DataError

Execute a formula in the context of this element

Parameters

Name	Type	Description
formula	string	The formula text, e.g. "@a + @b" to add together the shape data values a and b.

Returns

The result of the formula, or an error.

Inherited from

exists

▸ exists(): boolean

Returns

boolean

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

Inherited from

getBoundingBox

▸ getBoundingBox(): Box

Returns

Inherited from

BlockProxy.getLocation

getPage

▸ getPage(): PageProxy

Returns

The page containing this item

Inherited from

BlockProxy.getPage

getPageId

▸ getPageId(): string

Returns

string

The ID of the page containing this item

Inherited from

BlockProxy.getPageId

getPreviewThumbnailUrl

Inherited from

BlockProxy.getShadow

getSimpleStaticDataGraphic

▸ getSimpleStaticDataGraphic(): undefined | SimpleStaticDataGraphicSettings

▸ linkText(textAreaKey, referenceKey, field): void

Link a text area to a data field, so that editing the text area will also update the associated data, and vice versa.

To use this, first establish a reference key on this block with setReferenceKey.

Parameters

Name	Type
textAreaKey	string
referenceKey	string \| number
field	string

Returns

void

Inherited from

lockAspectRatio

▸ lockAspectRatio(): void

Lock this block's aspect ratio to its current value. This can be reversed with unlockAspectRatio.

Returns

void

Inherited from

measureText

▸ measureText(name, maxWidth): MeasureTextResult

Measure the amount of space necessary to render the text in the given text area, given a width to measure that text within.

Parameters

Name	Type	Description
name	string	Name of the text area whose content we should measure
maxWidth	number	Width of the area in which to measure this text. The result will usually be no wider than this, but if a single word is long enough to go beyond this maxWidth, the width of that word will be returned.

Returns

The size of rectangle necessary to render this text area's content.

Inherited from

offset

▸ offset(type, offset): void

Offset this item in the given direction by the given amount.

Parameters

Name	Type	Description
type	LinearOffsetType	The type of offset to apply to this item
offset	Point	The amount to offset

Returns

void

Inherited from

removeReferenceKey

▸ removeReferenceKey(key): void

Remove the specified reference key from this element.

Parameters

Name	Type
key	string \| number

Returns

void

Inherited from

setBoundingBox

▸ setBoundingBox(bb): void

This is done by moving this item to the requested location, then attempting to resize it from the bottom-right corner to the requested size.

Parameters

Name	Type	Description
bb	Box	The bounding box to attempt to make this item fill

Returns

void

Inherited from

setDataSyncStateIconPosition

▸ setDataSyncStateIconPosition(position): void

Parameters

Name	Type	Description
position	undefined \| BadgeEnumPosition	The postion where the data sync state icon should be displayed on the block. If this position is set to undefined then the state icon position will fallback to the default position for the block.

Parameters

Name	Type
fillStyle	SimpleFillStyle

Returns

void

Inherited from

setIframe

▸ setIframe(unfurlIframe): void

Sets the URL to be loaded in an iframe when the user clicks the "Expand" action on the block.

Parameters

Name	Type
unfurlIframe	UnfurlIframe

Returns

void

setLineWidth

▸ setLineWidth(width): void

Parameters

Name	Type	Description
width	number	The line width to be used (by most kinds of blocks) to render this block's outline

Returns

void

Inherited from

setLocation

▸ setLocation(location): void

Moves this item so that its upper-left corner is positioned at the given location (prior to any rotation)

Parameters

Name	Type	Description
location	Point	The target location

Returns

void

Inherited from

setPreviewThumbnailUrl

▸ setPreviewThumbnailUrl(thumbnailUrl): void

Sets the main thumbnail on the block

Parameters

Name	Type
thumbnailUrl	string

Returns

void

setReferenceKey

▸ setReferenceKey(key, settings): void

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

Parameters

Name	Type
key	string \| number
settings	ReferenceKeyDefinition

Sets additional thumbnails on the block

Parameters

Name	Type
thumbnails	string[]

Returns

void

setTitle

▸ setTitle(title): void

Sets the title on the block, which is the main text shown on the block.

Parameters

Name	Type
title	string

Returns

void

setUrl

▸ setUrl(url): void

Sets the URL the user will be redirected to when the user clicks the "Pop Out" action on the block.

Parameters

Name	Type
url	string

Returns

void

unapplyRule

▸ unapplyRule(rule): void

Parameters

Name	Type	Description
rule	RuleProxy	Rule to remove from this item

Returns

void

Inherited from

BlockProxy.unapplyRule

unlockAspectRatio

▸ unlockAspectRatio(): void

Unlock the aspect ratio of this block, allowing it to be stretched vertically or horizontally independently.

Returns

void

Inherited from

DataConnectorClient.constructor

LiteralFieldType

core/data/fieldtypedefinition/literalfieldtype.LiteralFieldType

Constructors

constructor

• new LiteralFieldType(literal)

Parameters

Name	Type
literal	string \| number \| boolean

Properties

literalStringPrefix

▪ Static literalStringPrefix: string = '%'

Methods

getLiteral

▸ getLiteral(): string | number | boolean

Returns

string | number | boolean

getScalarFieldType

▸ getScalarFieldType(): ScalarFieldTypeEnum

Returns

ScalarFieldTypeEnum

toJSON

▸ toJSON(): string

Returns

string

LucidCardIntegration

core/cardintegration/lucidcardintegration.LucidCardIntegration

Constructors

constructor

• new LucidCardIntegration(client)

Parameters

Name	Type
client	EditorClient

Properties

addCard

• Optional addCard: Object

If specified, allow the user to create new cards and convert other shapes to cards

Type declaration

Name	Type
createCardData	(input: Map<string, SerializedFieldType >) => Promise<{ collection: CollectionProxy ; primaryKey: string }>
getInputFields	(inputSoFar: Map<string, SerializedFieldType >) => Promise< ExtensionCardFieldDefinition []>

client

• Protected Readonly client: EditorClient

dataConnectorName

• Abstract dataConnectorName: string

The name of the data connector associated with the card integration.

fieldConfiguration

• Abstract fieldConfiguration: Object

Type declaration

Name	Type	Description
fieldValueSearchCallbacks?	Map<string, string>	Specify callbacks for searching for legal values for the given fields. For example, a Task collection may have an Assignee field that references a User collection, but you don't import all the users in the entire source data set. Here, you can provide a way to search for legal values for the Assignee field, similar to the ExtensionCardFieldDefinition.search functionality. Register a search callback using LucidCardIntegrationRegistry.registerFieldSearchCallback, then set the returned string as a value in this Map. The inputSoFar parameter passed to the callback will be all the current field values on the item being edited.
getAllFields	(dataSource: DataSourceProxy ) => Promise<string[]>	Callback to provide a list of all supported field names for the card integration.
onSelectedFieldsChange?	(dataSource: DataSourceProxy , selectedFields: string[]) => Promise<void>	Callback that handled changes in the fields the user wants to be displayed in the card integration. If this callback is not provided then the user will not be shown the modal to configure fields.

getDefaultConfig

• Abstract getDefaultConfig: (dataSource: DataSourceProxy ) => Promise< CardIntegrationConfig >

Type declaration

▸ (dataSource): Promise< CardIntegrationConfig >

Provide the default configuration for a new import

Parameters

Name	Type
dataSource	DataSourceProxy

Returns

Promise< CardIntegrationConfig >

iconUrl

• Abstract iconUrl: string

URL for an icon to display in toolbars, etc. Should be at least 24x24.

importModal

• Optional importModal: LucidCardIntegrationCustomImportModal | LucidCardIntegrationStandardImportModal

This allows the user to import cards by selecting items from within a modal. You can either create a custom import modal or the standard import modal can be used.

itemLabel

• Abstract itemLabel: string

Label used to identify one card worth of data, e.g. "Jira task"

itemsLabel

• Abstract itemsLabel: string

Label used to identify multiple cards worth of data, e.g. "Jira tasks"

label

• Abstract label: string

Label used to identify the integration, e.g. "Jira", which will be used in menu items, etc. Should be unique within any given extension.

showIntro

• Optional showIntro: () => void

Type declaration

▸ (): void

If specified, and the user hasn't yet authorized the data connector for this extension, this should show the user an intro dialog or take some other action.

Returns

void

textStyle

• Optional textStyle: Partial< TextStyle >

The default text style to use on cards created as part of this integration. These can be overridden by values in getDefaultConfig().fieldStyles for individual fields that should have different styles.

Methods

showCardImport

▸ showCardImport(name): ImportCardsResult

Parameters

Name	Type
name	string

Returns

ImportCardsResult

LucidCardIntegrationCustomImportModal

core/cardintegration/lucidcardintegrationcustomimportmodal.LucidCardIntegrationCustomImportModal

Extending this class lets you create a custom import modal for a Lucid card integration.

Hierarchy

Modal

↳ LucidCardIntegrationCustomImportModal

Constructors

constructor

• new LucidCardIntegrationCustomImportModal(client, config, cardIntegrationLabel)

Parameters

Name	Type
client	EditorClient
config	ModalConfig
cardIntegrationLabel	string

Overrides

Modal.constructor

Properties

createCards

▸ Protected createCards(collectionId, primaryKeys): CreateCardsResult

Once the data has been imported, call this function to create Lucid cards on the canvas.

Parameters

Name	Type
collectionId	string
primaryKeys	string[]

Inherited from

Returns

Promise<void>

Inherited from

Modal.show

unhookMessages

▸ Protected unhookMessages(): void

Subclasses must call unhookMessages to allow them to be garbage collected.

Returns

void

Inherited from

Modal.unhookMessages

LucidCardIntegrationRegistry

core/cardintegration/lucidcardintegrationregistry.LucidCardIntegrationRegistry

Constructors

constructor

• new LucidCardIntegrationRegistry()

Methods

addCardIntegration

▸ Static addCardIntegration(client, cardIntegration): void

Parameters

Name	Type
client	EditorClient
cardIntegration	LucidCardIntegration

Returns

void

registerFieldOptionsCallback

▸ Static registerFieldOptionsCallback(client, callback): string

Parameters

Name	Type
client	EditorClient
callback	(inputSoFar: Map<string, SerializedFieldType >) => Promise< ExtensionCardFieldOption []>

Returns

string

registerFieldSearchCallback

▸ Static registerFieldSearchCallback(client, callback): string

Parameters

Name	Type
client	EditorClient
callback	(searchText: string, inputSoFar: Map<string, SerializedFieldType >) => Promise< ExtensionCardFieldOption []>

Returns

string

MapProxy<KEY, VALUE>

document/mapproxy.MapProxy

A data structure similar to a normal Map which accesses its data through API commands to the Lucid app. This structure is iterable with for...of.

Type parameters

Name
KEY
VALUE

Hierarchy

MapProxy

↳ WriteableMapProxy

Constructors

constructor

• new MapProxy<KEY, VALUE>(getKeys, getItem)

Type parameters

Name
KEY
VALUE

Parameters

Name	Type
getKeys	() => KEY[]
getItem	(key: KEY) => VALUE

Accessors

size

• get size(): number

Returns

number

Methods

filter

▸ filter(filter): VALUE[]

Parameters

Name	Type
filter	(item: VALUE, key: KEY) => boolean

Returns

VALUE[]

find

▸ find(filter): undefined | VALUE

Parameters

Name	Type
filter	(item: VALUE, key: KEY) => boolean

Type parameters

Name
T

Parameters

Name	Type
callback	(item: VALUE, key: KEY) => T

Returns

T[]

values

▸ values(): Generator<Object, void, unknown>

Returns

Generator<Object, void, unknown>

ui/menu.Menu

Constructors

constructor

• new Menu(client)

Parameters

Name	Type
client	EditorClient

Methods

addContentDockMenuItem

▸ addContentDockMenuItem(item): void

Create an icon tied to an action (required) that appears in the left toolbar in Lucidspark and Teamspaces (not in Lucidchart).

The action must be registered with EditorClient.registerAction prior to using it in the menu.

Parameters

Name	Type	Description
item	CustomContentDockMenu	The definition of the new menu item

Returns

void

addContextMenuItem

▸ addContextMenuItem(item): void

Create a menu in the right click context menu. Appears in both Lucidspark and Lucidchart.

The action must be registered with EditorClient.registerAction prior to using it in the menu.

Parameters

Name	Type	Description
item	CustomMenuConfig	The definition of the new menu item

Returns

void

addDropdownMenuItem

▸ addDropdownMenuItem(item): void

Create a menu in the basic drop down top menus. In Lucidspark this will just be under the generic menu. In Lucidchart you can configure this to be in any of the other drop down menus.

The action must be registered with EditorClient.registerAction prior to using it in the menu.

Parameters

Name	Type	Description
item	CustomDropdownMenu	The definition of the new menu item

Returns

void

addMenuItem

▸ addMenuItem(item): void

Generic function to create a new menu item to trigger custom code. You can use addDropdownMenuItem, addContextMenuItem, or addContentDockMenuItem for easier to use entrypoints.

The action must be registered with EditorClient.registerAction prior to using it in the menu.

Parameters

Name	Type	Description
item	CustomMenuItem	The definition of the new menu item

Returns

void

MockDataConnectorClient

dataconnector/dataconnectorclient.MockDataConnectorClient

Use this for writing automated tests for your data connector

Hierarchy

DataConnectorClient

↳ MockDataConnectorClient

Constructors

constructor

• new MockDataConnectorClient()

Overrides

Properties

dataSourceClient

• Readonly dataSourceClient: MockDataSourceClient

set properties on this to modify how data source updates are mocked

urls

• urls: Object = LUCID_URLS

Type declaration

Name	Type
api	string
main	string

Inherited from

DataConnectorClient.urls

Methods

Inherited from

DataConnectorClient.parseActions

MockDataSourceClient

dataconnector/datasourceclient.MockDataSourceClient

A version of the DataSourceClient that you can use for any automated tests of your data connector. Modify the gotUpdate field to change the behaviour of the update method.

Hierarchy

DataSourceClient

↳ MockDataSourceClient

Constructors

constructor

• new MockDataSourceClient()

Overrides

DataSourceClient.constructor

Properties

gotMetadata

• gotMetadata: (keys: string[], prefixes: string[]) => MetadataRecord []

Type declaration

▸ (keys, prefixes): MetadataRecord []

Assign this to your mocked update function

Parameters

Name	Type
keys	string[]
prefixes	string[]

Returns

MetadataRecord []

gotUpdate

• gotUpdate: (request: DataSourceRequest ) => void

Type declaration

▸ (request): void

Assign this to your mocked update function

Parameters

Name	Type
request	DataSourceRequest

Returns

void

patchedMetadata

• patchedMetadata: (patches: MetadataPatch []) => MetadataPatchResponse

Type declaration

▸ (patches): MetadataPatchResponse

Assign this to your mocked update function

Parameters

Name	Type
patches	MetadataPatch []

Returns

MetadataPatchResponse

MockSignatureValidator

dataconnector/signaturevalidator.MockSignatureValidator

Mock signature validator, always returns true.

Constructors

constructor

• new MockSignatureValidator()

Methods

validate

▸ validate(): boolean

Returns

boolean

ui/modal.Modal

Extend this class to show a custom modal to the user, whose contents are displayed in a sandboxed iframe controlled by your extension.

To pass a message to a script running in the modal, call sendMessage. The data you pass in will be sent to the iframe with window.postMessage.

To pass messages back from the modal to this class, call parent.postMessage from within the iframe. The data sent will be passed along to the messageFromFrame implementation on your Modal class.

Hierarchy

IframeUI

↳ Modal

↳↳ LucidCardIntegrationCustomImportModal

Constructors

constructor

• new Modal(client, config)

Parameters

Name	Type
client	EditorClient
config	ModalConfig

Overrides

IframeUI.constructor

Properties

Returns

void

Inherited from

IframeUI.hookMessages

messageFromFrame

▸ Protected messageFromFrame(message): void

Receives messages sent from the iframe via parent.postMessage(, '*')

Parameters

Name	Type	Description
message	any	data sent from the iframe

Returns

void

Inherited from

IframeUI.messageFromFrame

sendMessage

▸ sendMessage(data): Promise<void>

Send a message to this UI component's iframe via window.postMessage.

Parameters

Name	Type	Description
data	JsonSerializable	Data to send to the iframe

Returns

Promise<void>

Inherited from

IframeUI.sendMessage

show

▸ show(): Promise<void>

Returns

Promise<void>

unhookMessages

▸ Protected unhookMessages(): void

Subclasses must call unhookMessages to allow them to be garbage collected.

Returns

void

Inherited from

IframeUI.unhookMessages

NDimensionalFieldTypeArray

core/data/fieldtypedefinition/ndimensionalfieldtypearray.NDimensionalFieldTypeArray

Constructors

constructor

• new NDimensionalFieldTypeArray(validTypesArray)

Parameters

Name	Type
validTypesArray	( ScalarFieldTypeEnum \| LiteralFieldType )[]

Properties

validTypesArray

• Readonly validTypesArray: ( ScalarFieldTypeEnum | LiteralFieldType )[]

Methods

PageProxy

document/pageproxy.PageProxy

One page in the current Lucid document

Hierarchy

ElementProxy

↳ PageProxy

Constructors

constructor

• new PageProxy(id, client)

Parameters

Name	Type	Description
id	string	The ID of this page
client	EditorClient

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

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

Name	Type	Description
def	BlockDefinition	The definition of the new block to add

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

Name	Type	Description
diagramType	FLOWCHART	The type of the diagram. Note that this is redundant because the Mermaid markup also contains the diagram type.
mermaid	string	Mermaid markup text describing the diagram to add.
origin?	Point	Where to place the diagram on the page. If absent some free space within or near the current viewport is automatically chosen.
exactPlacement?	boolean	If true and if origin is specified, places the diagram exactly at the specified origin instead of trying to find free space.

Returns

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

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

addImage

▸ addImage(def): Promise< BlockProxy >

Add a new image to this page.

Parameters

Name	Type	Description
def	ImageDefinition	The definition of the new image to add

Returns

Promise< BlockProxy >

The added image

addLine

▸ addLine(def): LineProxy

Add a new line to this page.

Parameters

Name	Type	Description
def	LineDefinition	The definition of the new line to add

Returns

LineProxy

The added line

applyRuleToAllItems

▸ applyRuleToAllItems(rule): void

Parameters

Name	Type	Description
rule	RuleProxy	Rule to apply to all items on this page

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

Name	Type	Description
searchX	number	Place to start the search
searchY	number	Place to start the search
width	number
height	number

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.

Name	Type
page	PageProxy
x	number
y	number

findItems

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

Parameters

Name	Type	Description
boundingBox	Box	An area of this page to search for blocks, lines, and groups
searchType	GetItemsAtSearchType

Returns

( BlockProxy | LineProxy | GroupProxy )[]

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

getLLMContextForItems

▸ getLLMContextForItems(items, contextType?): Object

Parameters

Name	Type	Default value
items	ItemProxy []	undefined
contextType	GetLLMContextType	GetLLMContextType.Relational

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.

Name	Type
idToLucidId	Map<string, string>
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

Name	Type	Default value	Description
items?	ItemProxy []	undefined	If specified, only include these items in the resulting SVG
includeBackground	boolean	false	If true, include the background of the page in the SVG. Otherwise the background is transparent.
viewBox?	Box	undefined	If specified, crop the resulting SVG to the specified bounding box in page coordinates

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

Name	Type	Description
blocks	BlockProxy []	A non-empty array of items to group

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

Name	Type	Description
links	string[]	links to be imported onto the canvas as link unfurl blocks

Returns

Promise<void>

removeReferenceKey

▸ removeReferenceKey(key): void

Remove the specified reference key from this element.

Parameters

Name	Type
key	string \| number

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

Name	Type
key	string \| number
settings	ReferenceKeyDefinition

Returns

void

Inherited from

ElementProxy.setReferenceKey

setTitle

▸ setTitle(title): void

Updates the page of this page

Parameters

Name	Type	Description
title	string	The new title for this page

Returns

void

unapplyRuleToAllItems

▸ unapplyRuleToAllItems(rule): void

Parameters

Name	Type	Description
rule	RuleProxy	Rule to remove from the list applied to all items on this page

Returns

void

Panel

ui/panel.Panel

Extend this class to show a custom panel to the user, whose contents are displayed in a sandboxed iframe controlled by your extension.

To pass a message to a script running in the panel, call sendMessage. The data you pass in will be sent to the iframe with window.postMessage.

To pass messages back from the panel to this class, call parent.postMessage from within the iframe. The data sent will be passed along to the messageFromFrame implementation on your Panel class.

Hierarchy

IframeUI

↳ Panel

Constructors

constructor

• new Panel(client, config)

Parameters

Name	Type
client	EditorClient
config	PanelConfig

Overrides

IframeUI.constructor

Properties

client

IframeUI.unhookMessages

Patch

dataconnector/actions/action.Patch

A patch to be applied against the 3rd party datasource with changes coming from Lucid

Constructors

constructor

• new Patch(id, itemsAdded, itemsChanged, itemsDeleted, itemOrderChanged, syncSourceId, syncCollectionId)

Parameters

Name	Type	Description
id	string	The id of the patch
itemsAdded	PatchItems	Mapping of item primary keys to new items introduced by Lucid
itemsChanged	PatchItems	Mapping of item primary keys to sparse changesets of pre-existing items changed by Lucid
itemsDeleted	string[]	List of item primary keys deleted by Lucid
itemOrderChanged	undefined \| [string, null \| string][]
syncSourceId	string	The syncSourceId of the changed data source
syncCollectionId	string	The syncCollectionId of the changed collection

Properties

id

• id: string

The id of the patch

itemOrderChanged

• itemOrderChanged: undefined | [string, null | string][]

itemsAdded

• itemsAdded: PatchItems

Mapping of item primary keys to new items introduced by Lucid

itemsChanged

• itemsChanged: PatchItems

Mapping of item primary keys to sparse changesets of pre-existing items changed by Lucid

itemsDeleted

• itemsDeleted: string[]

List of item primary keys deleted by Lucid

syncCollectionId

• syncCollectionId: string

The syncCollectionId of the changed collection

syncSourceId

• syncSourceId: string

The syncSourceId of the changed data source

Methods

getChange

▸ getChange(collections?): PatchChange

Parameters

Name	Type	Default value
collections	PatchChangeCollection []	[]

Returns

PatchChange

toJSON

▸ toJSON(): object

Returns

object

PatchChange

dataconnector/actions/patchresponsebody.PatchChange

Reports a completed change back to Lucid

Constructors

constructor

• new PatchChange(patchId, syncId, collections)

Parameters

Name	Type
patchId	string
syncId	string
collections	PatchChangeCollection []

Properties

collections

• collections: PatchChangeCollection []

patchId

• patchId: string

syncId

• syncId: string

Methods

Constructors

constructor

• new PatchCollectionProxy(client, branchedCollection, patchCollection, originalCollection)

Use CollectionProxy.getLocalChanges() to get a PatchCollectionProxy rather than constructing one directly.

Parameters

Name	Type
client	EditorClient
branchedCollection	CollectionProxy
patchCollection	CollectionProxy
originalCollection	CollectionProxy

all data items that were deleted from this collection locally, but that have not yet been deleted in the external data source.

PatchedDataItemProxy

data/patchcollectionproxy.PatchedDataItemProxy

One data item in a collection, consisting of key-value pairs

Hierarchy

DataItemProxy

↳ PatchedDataItemProxy

Constructors

constructor

• new PatchedDataItemProxy(primaryKey, collection, changedFields, original, client)

Parameters

Name	Type	Description
primaryKey	string	-
collection	CollectionProxy	-
changedFields	string[]	The names of all fields that have been changed locally on this data item and not yet synced back to the external data source.
original	DataItemProxy	The original data item, before local changes. You can query the original values for the changedFields from this data item.
client	EditorClient	-

Overrides

DataItemProxy.constructor

Properties

changedFields

• Readonly changedFields: string[]

The names of all fields that have been changed locally on this data item and not yet synced back to the external data source.

DataItemProxy.primaryKey

Methods

exists

▸ exists(): boolean

Returns

boolean

True if a data item exists in this collection at this primary key

Inherited from

DataItemProxy.exists

PropertyStoreProxy

document/propertystoreproxy.PropertyStoreProxy

Base class for anything on a Lucid document that has an ID and properties.

Hierarchy

PropertyStoreProxy

↳ CollectionProxy

↳ DataSourceProxy

↳ DocumentElementProxy

↳ ElementProxy

Constructors

constructor

• new PropertyStoreProxy(id, client)

Parameters

Name	Type	Description
id	string	ID of this element
client	EditorClient

Properties

client

• Protected Readonly client: EditorClient

id

• Readonly id: string

properties

• Readonly properties: WriteableMapProxy <string, JsonSerializable , void, JsonSerializable >

ReferenceKeyProxy

data/referencekeyproxy.ReferenceKeyProxy

Constructors

constructor

• new ReferenceKeyProxy(elementId, key, client, settings)

Parameters

Name	Type
elementId	undefined \| string
key	string \| number
client	EditorClient
settings	SerializedReferenceKeyType

Properties

elementId

• Readonly elementId: undefined | string

key

• Readonly key: string | number

Accessors

Methods

getItem

▸ getItem(): DataItemProxy

Returns

DataItemProxy

RekeyingMap

dataconnector/itemrekeyer.RekeyingMap

Constructors

constructor

• new RekeyingMap(map)

Parameters

Name	Type
map	Map<string, null \| string>

Properties

map

• map: Map<string, null | string>

Methods

getNewKey

▸ getNewKey(key): string

Parameters

Name	Type
key	string

Returns

string

getRecordWithNewKeys

▸ getRecordWithNewKeys(items): PatchItems

Parameters

Name	Type
items	PatchItems

Returns

PatchItems

getRekeyedPatch

▸ getRekeyedPatch(patch): Patch

Parameters

Name	Type
patch	Patch

Returns

Patch

RuleCondition

document/documentelement/ruleproxy.RuleCondition

Constructors

constructor

• new RuleCondition(rule, client, key)

Parameters

Name	Type
rule	RuleProxy
client	EditorClient
key	string

Properties

condition

• Readonly condition: Conditions

If this.type == ConditionType.Text, this is a TextConditions. If this.type == ConditionType.ShapeData, this is a ShapeDataConditions. If this.type == ConditionType.ShapeType, this is a ShapeTypeConditions. If this.type == ConditionType.ConnectedShapes, this is a ConnectedShapesConditions.

field

• Readonly field: undefined | string

For shape data conditions, the name of the shape data field to test

fieldLabel

• Readonly fieldLabel: undefined | string

For shape data conditions, the name to display to the end user to identify the field name

key

• Readonly key: string

rule

• Readonly rule: RuleProxy

type

• Readonly type: ConditionType

What kind of condition is this? e.g. a formula evaluation, checking for non-empty text, etc.

value

• Readonly value: ConditionValueType

For formula conditions, the formula string.

For other conditions,the value against which the condition is tested. For example, a condition with type = ConditionType.ShapeData condition = ShapeDataConditions.GreaterThan field = 'TheField' value = 14

will trigger when the shape data field "TheField" has a value that is greater than 14.

Methods

update

▸ update(definition): void

Update this condition to reflect a new definition

Parameters

Name	Type
definition	ConditionDefinition

Returns

void

RuleEffect

document/documentelement/ruleproxy.RuleEffect

Constructors

constructor

• new RuleEffect(rule, client, key)

Parameters

Name	Type
rule	RuleProxy
client	EditorClient
key	string

Properties

combination

• Readonly combination: ConditionCombination

How multiple conditions are combined (AND vs OR)

conditions

• Readonly conditions: MapProxy <string, RuleCondition >

dataGraphic

• Readonly dataGraphic: undefined | { color: undefined | string ; image: undefined | { h: number ; url: string ; w: number } ; index: number ; position: BadgeEnumPosition ; set: DataGraphicIconSets }

For formatType = RuleFormattingType.DATA_GRAPHICS, a description of which icon appears and where

formatType

• Readonly formatType: RuleFormattingType

What kind of effect is displayed? Formatting vs. icons vs. dynamic stencil, etc.

formatting

• Readonly formatting: SerializedFormatting

For formatType = RuleFormattingType.FORMATTING, what styles are applied to blocks, lines, and pages?

key

• Readonly key: string

rule

• Readonly rule: RuleProxy

Methods

update

▸ update(definition): void

Update this effect to reflect a new definition

Parameters

Name	Type
definition	EffectDefinition

Returns

void

RuleProxy

document/documentelement/ruleproxy.RuleProxy

Base class for anything on a Lucid document that has an ID and properties.

Hierarchy

DocumentElementProxy

↳ RuleProxy

Constructors

constructor

• new RuleProxy(id, client)

Parameters

Name	Type	Description
id	string	The ID of this conditional formatting rule
client	EditorClient

Overrides

DocumentElementProxy.constructor

Properties

client

• Protected Readonly client: EditorClient

Inherited from

DocumentElementProxy.client

effects

• Readonly effects: MapProxy <string, RuleEffect >

id

• Readonly id: string

Inherited from

DocumentElementProxy.id

properties

• Readonly properties: WriteableMapProxy <string, JsonSerializable , void, JsonSerializable >

Inherited from

DocumentElementProxy.properties

Methods

delete

▸ delete(): void

Delete this conditional formatting rule from the document

Returns

void

getName

▸ getName(): string

Returns

string

getOrder

▸ getOrder(): number

Returns

number

setName

▸ setName(name): void

Parameters

Name	Type
name	string

Returns

void

update

▸ update(definition): void

Update this rule to reflect a new definition

Parameters

Name	Type
definition	RuleDefinition

Returns

void

ShapeDataProxy

document/shapedataproxy.ShapeDataProxy

The shape data fields on a single element of the current document

Hierarchy

WriteableMapProxy <string, SerializedFieldType | SerializedDataError , void>

↳ ShapeDataProxy

Constructors

constructor

• new ShapeDataProxy(id, client)

Parameters

Name	Type	Description
id	undefined \| string	The ID of the element, or undefined for the document itself
client	EditorClient

Overrides

WriteableMapProxy.constructor

Properties

client

• Protected Readonly client: EditorClient

id

• Readonly id: undefined | string

Accessors

size

• get size(): number

Returns

number

Inherited from

WriteableMapProxy.size

Methods

addInheritable

▸ addInheritable(name, value): void

Add shape data to this element that is inherited by its descendants.

If you add an inheritable shape data to a page, whose formula is "=@Cost * 4", then each item on that page will have a new shape data entry (in allShapeData) by that name with the value calculated in the context of that individual item.

Inheritable shape data on a page affects all items on the page. Inheritable shape data on a group affects all items inside that group.

Parameters

Name	Type	Description
name	string	Name of the new shape data
value	string	Value (or formula, if starting with "=") of the new shape data

Returns

void

delete

▸ delete(key): void

Delete the specified shape data from this element

Parameters

Name	Type
key	string

Returns

void

filter

▸ filter(filter): ( SerializedFieldType | SerializedDataError )[]

Parameters

Name	Type
filter	(item: SerializedFieldType \| SerializedDataError , key: string) => boolean

Returns

string

document/blockclasses/legendblockproxy.ShapeLegendEntryProxy

Hierarchy

LegendEntryProxy

↳ ShapeLegendEntryProxy

Constructors

constructor

• new ShapeLegendEntryProxy(legend, index)

Parameters

Name	Type
legend	LegendBlockProxy
index	number

Overrides

LegendEntryProxy.constructor

Properties

Methods

getText

▸ getText(): string

Returns

string

Inherited from

LegendEntryProxy.getText

setText

▸ setText(text): void

Parameters

Name	Type
text	string

Returns

void

Inherited from

LegendEntryProxy.setText

SignatureValidator

dataconnector/signaturevalidator.SignatureValidator

Allows validation that requests originated from Lucid. This class can only be instanciated in a NodeJS environment. Technically any environment that provides NodeJS compatible implementations of globalThis.Buffer and globalThis.require('crypto') will work.

Constructors

constructor

• new SignatureValidator(dependencies, publicKey)

Parameters

Name	Type
dependencies	CryptoDependencies
publicKey	string

Methods

validate

▸ validate(body, headers, url): boolean

Validate a given request came from Lucid.

Parameters

Name	Type	Description
body	unknown	The body of the request as a plain JavaScript object. This should be JSON.parse called on exactly the request body that came from Lucid.
headers	Object	The headers that are associated with the request. Only 'x-lucid-rsa-nonce' and 'x-lucid-signature' are required.
headers.x-lucid-rsa-nonce	string	-
headers.x-lucid-signature	string	-
url	string	The url of the current endpoint that is being requested.

Returns

boolean

true if the request is valid

SwimLaneBlockProxy

document/blockclasses/swimlaneblockproxy.SwimLaneBlockProxy

Hierarchy

BlockProxy

↳ SwimLaneBlockProxy

Constructors

constructor

• new SwimLaneBlockProxy(id, client)

Parameters

Name	Type	Description
id	string	ID of this item
client	EditorClient

Inherited from

Properties

allShapeData

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

Inherited from

textAreas

• Readonly textAreas: WriteableMapProxy <string, string, undefined, string>

The plain text in each of the text areas on this item, organized by text area name.

Inherited from

textStyles

• Readonly textStyles: WriteableMapProxy <string, TextStyle , Promise<undefined>, Partial< TextStyle >>

The text style in each of the text areas on this item, organized by text area name.

Inherited from

classNameRegex

▪ Static classNameRegex: RegExp

Methods

applyRule

▸ applyRule(rule): void

Parameters

Name	Type	Description
rule	RuleProxy	Rule to apply to this item

Returns

void

Inherited from

changeZOrder

▸ changeZOrder(operation): void

Parameters

Name	Type	Description
operation	ZOrderOperation	How to adjust the Z order of this item relative to the other items it overlaps on the page

Returns

void

Inherited from

delete

▸ delete(): void

Delete this item from the document

Returns

void

Inherited from

executeFormula

▸ executeFormula(formula): SerializedFieldType | DataError

Execute a formula in the context of this element

Parameters

Name	Type	Description
formula	string	The formula text, e.g. "@a + @b" to add together the shape data values a and b.

Returns

The result of the formula, or an error.

Inherited from

exists

▸ exists(): boolean

Returns

boolean

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

Inherited from

getBoundingBox

▸ getBoundingBox(): Box

Returns

Returns

Object

The x/y location of this item

Name	Type
x	number
y	number

Inherited from

BlockProxy.getLocation

getMagnetized

▸ getMagnetized(): boolean

Returns

boolean

getPage

▸ getPage(): PageProxy

Returns

The page containing this item

Inherited from

BlockProxy.getPage

getPageId

▸ getPageId(): string

Returns

Returns

undefined | SimpleStaticDataGraphicSettings

Inherited from

linkText

▸ linkText(textAreaKey, referenceKey, field): void

Link a text area to a data field, so that editing the text area will also update the associated data, and vice versa.

To use this, first establish a reference key on this block with setReferenceKey.

Parameters

Name	Type
textAreaKey	string
referenceKey	string \| number
field	string

Returns

void

Inherited from

lockAspectRatio

▸ lockAspectRatio(): void

Lock this block's aspect ratio to its current value. This can be reversed with unlockAspectRatio.

Returns

void

Inherited from

measureText

▸ measureText(name, maxWidth): MeasureTextResult

Measure the amount of space necessary to render the text in the given text area, given a width to measure that text within.

Parameters

Name	Type	Description
name	string	Name of the text area whose content we should measure
maxWidth	number	Width of the area in which to measure this text. The result will usually be no wider than this, but if a single word is long enough to go beyond this maxWidth, the width of that word will be returned.

Returns

The size of rectangle necessary to render this text area's content.

Inherited from

offset

▸ offset(type, offset): void

Offset this item in the given direction by the given amount.

Parameters

Name	Type	Description
type	LinearOffsetType	The type of offset to apply to this item
offset	Point	The amount to offset

Returns

void

Inherited from

removeReferenceKey

▸ removeReferenceKey(key): void

Remove the specified reference key from this element.

Parameters

Name	Type
key	string \| number

Returns

void

Inherited from

setBoundingBox

▸ setBoundingBox(bb): void

Swim lanes only use the normal BoundingBox property for location. For size, it uses the PrimaryLane and SecondaryLane properties.

Parameters

Name	Type
bb	Box

Returns

void

Overrides

setDataSyncStateIconPosition

▸ setDataSyncStateIconPosition(position): void

Parameters

Name	Type	Description
position	undefined \| BadgeEnumPosition	The postion where the data sync state icon should be displayed on the block. If this position is set to undefined then the state icon position will fallback to the default position for the block.

Returns

void

Inherited from

setFillStyle

▸ setFillStyle(fillStyle): void

Set the fill style used (by most kinds of blocks) to fill in their main opaque areas. This can be a string color (e.g. '#ff00ff80') or an image fill.

Parameters

Name	Type
fillStyle	SimpleFillStyle

Returns

void

Inherited from

setLineWidth

▸ setLineWidth(width): void

Parameters

Name	Type	Description
width	number	The line width to be used (by most kinds of blocks) to render this block's outline

Returns

void

Inherited from

setLocation

▸ setLocation(location): void

Moves this item so that its upper-left corner is positioned at the given location (prior to any rotation)

Parameters

Name	Type	Description
location	Point	The target location

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

Parameters

Name	Type
key	string \| number
settings	ReferenceKeyDefinition

unlockAspectRatio

▸ unlockAspectRatio(): void

Unlock the aspect ratio of this block, allowing it to be stretched vertically or horizontally independently.

Returns

void

Inherited from

SwimLanePrimaryLaneProxy

document/blockclasses/swimlaneblockproxy.SwimLanePrimaryLaneProxy

Constructors

constructor

• new SwimLanePrimaryLaneProxy(swimlane, index)

Parameters

Name	Type
swimlane	SwimLaneBlockProxy
index	number

Properties

index

• Readonly index: number

swimlane

• Readonly swimlane: SwimLaneBlockProxy

Methods

getBoundingBox

▸ getBoundingBox(): Object

Returns

Object

Name	Type
h	number
w	number
x	number
y	number

getSize

▸ getSize(): number

constructor

• new TableBlockProxy(id, client)

Parameters

Name	Type	Description
id	string	ID of this item
client	EditorClient

Inherited from

Properties

allShapeData

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

Inherited from

textAreas

• Readonly textAreas: WriteableMapProxy <string, string, undefined, string>

The plain text in each of the text areas on this item, organized by text area name.

Inherited from

textStyles

• Readonly textStyles: WriteableMapProxy <string, TextStyle , Promise<undefined>, Partial< TextStyle >>

The text style in each of the text areas on this item, organized by text area name.

Inherited from

classNameRegex

▪ Static classNameRegex: RegExp

Methods

addColumn

▸ addColumn(referenceCell, before?): TableColumnProxy

Parameters

Name	Type	Default value	Description
referenceCell	TableCellProxy	undefined	The cell to add the new column before or after.
before	boolean	false	If true, the new column will be added before the reference cell, otherwise it will be added after.

Returns

TableColumnProxy

The TableColumnProxy for the newly added column.

addRow

▸ addRow(referenceCell, before?): TableRowProxy

Parameters

Name	Type	Default value	Description
referenceCell	TableCellProxy	undefined	The cell to add the new row before or after.
before	boolean	false	If true, the new row will be added before the reference cell, otherwise it will be added after.

Returns

TableRowProxy

The TableRowProxy for the newly added row.

applyRule

▸ applyRule(rule): void

Parameters

Name	Type	Description
rule	RuleProxy	Rule to apply to this item

Returns

void

Inherited from

changeZOrder

▸ changeZOrder(operation): void

Parameters

Name	Type	Description
operation	ZOrderOperation	How to adjust the Z order of this item relative to the other items it overlaps on the page

Returns

void

Inherited from

delete

▸ delete(): void

boolean

undefined | TableCellProxy

The TableCellProxy represented by the text area key, or undefined if the text area key does not exist in the table.

getClassName

▸ getClassName(): string

Returns

string

The class name of this block. This name is not necessarily human-readable, and will remain consistent over time, e.g. "ProcessBlock"..

Inherited from

BlockProxy.getClassName

getColumnCount

▸ getColumnCount(): number

Returns

number

Object

The x/y location of this item

Name	Type
x	number
y	number

lockAspectRatio

▸ lockAspectRatio(): void

Lock this block's aspect ratio to its current value. This can be reversed with unlockAspectRatio.

Returns

void

Inherited from

measureText

▸ measureText(name, maxWidth): MeasureTextResult

Measure the amount of space necessary to render the text in the given text area, given a width to measure that text within.

Parameters

Name	Type	Description
name	string	Name of the text area whose content we should measure
maxWidth	number	Width of the area in which to measure this text. The result will usually be no wider than this, but if a single word is long enough to go beyond this maxWidth, the width of that word will be returned.

Returns

The size of rectangle necessary to render this text area's content.

Inherited from

offset

▸ offset(type, offset): void

Offset this item in the given direction by the given amount.

Parameters

Name	Type	Description
type	LinearOffsetType	The type of offset to apply to this item
offset	Point	The amount to offset

Returns

void

Inherited from

removeReferenceKey

▸ removeReferenceKey(key): void

Remove the specified reference key from this element.

Parameters

Name	Type
key	string \| number

This is done by moving this item to the requested location, then attempting to resize it from the bottom-right corner to the requested size.

Parameters

Name	Type	Description
bb	Box	The bounding box to attempt to make this item fill

setFillStyle

▸ setFillStyle(fillStyle): void

Set the fill style used (by most kinds of blocks) to fill in their main opaque areas. This can be a string color (e.g. '#ff00ff80') or an image fill.

Parameters

Name	Type
fillStyle	SimpleFillStyle

setLocation

▸ setLocation(location): void

Moves this item so that its upper-left corner is positioned at the given location (prior to any rotation)

Parameters

Name	Type	Description
location	Point	The target location

Returns

void

Inherited from

setReferenceKey

▸ setReferenceKey(key, settings): void

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

Parameters

Name	Type
key	string \| number
settings	ReferenceKeyDefinition

unlockAspectRatio

▸ unlockAspectRatio(): void

Unlock the aspect ratio of this block, allowing it to be stretched vertically or horizontally independently.

Returns

void

Inherited from

TableCellProxy

document/blockclasses/tableblockproxy.TableCellProxy

Constructors

constructor

• new TableCellProxy(table, row, column)

Parameters

Name	Type
table	TableBlockProxy
row	number
column	number

Properties

column

• Readonly column: number

row

• Readonly row: number

table

• Readonly table: TableBlockProxy

Methods

getBoundingBox

▸ getBoundingBox(): Box

Returns

getHeight

▸ getHeight(): number

Returns

number

the pixel height of the cell, including any cells it is merged with.

getMergedCellSize

▸ getMergedCellSize(): Object

Cells in a table can be merged together with adjacent cells into one larger cell. In this case, the upper- left cell remains visible but is enlarged to cover additional cells, and the other cells are hidden.

Returns

Object

the size of this cell, in how many cells horizontally and vertically have been merged into it. For most cells, this will be {w:1, h:1}, but if it has been merged with the cell to the right of it, it would be {w:2, h:1}.

Name	Type
h	number
w	number

the pixel width of the cell, including any cells it is merged with.

setFill

▸ setFill(fill): void

Parameters

Name	Type
fill	SimpleFillStyle

Returns

void

setMergedCellSize

▸ setMergedCellSize(size): void

/**

Cells in a table can be merged together with adjacent cells into one larger cell. In this case, the upper-
left cell remains visible but is enlarged to cover additional cells, and the other cells are hidden.

Parameters

Name	Type	Description
size	Object	the desired size of this cell, in how many cells horizontally and vertically are merged into it. * This normally {w:1, h:1} for a normal cell, or {w:2, h:1} to merge a cell with the one to the right of it, etc.
size.h	number	-
size.w	number	-

Returns

void

setText

▸ setText(text): undefined

Parameters

Name	Type
text	string

Returns

undefined

setTextStyle

▸ setTextStyle(style): void

Parameters

Name	Type
style	Partial< TextStyle >

Returns

void

TableColumnProxy

document/blockclasses/tableblockproxy.TableColumnProxy

Constructors

constructor

• new TableColumnProxy(table, col)

Parameters

Name	Type
table	TableBlockProxy
col	number

Properties

col

• Readonly col: number

table

• Readonly table: TableBlockProxy

Methods

getCells

▸ getCells(): TableCellProxy []

Returns

TableCellProxy []

getWidth

▸ getWidth(): number

Returns

number

TableRowProxy

document/blockclasses/tableblockproxy.TableRowProxy

Constructors

constructor

• new TableRowProxy(table, row)

Parameters

Name	Type
table	TableBlockProxy
row	number

Properties

row

• Readonly row: number

table

• Readonly table: TableBlockProxy

Methods

getCells

▸ getCells(): TableCellProxy []

Returns

TableCellProxy []

getHeight

▸ getHeight(): number

Returns

number

UserProxy

user/userproxy.UserProxy

The UserProxy class gives access to the current user on the current Lucid document.

Constructors

constructor

• new UserProxy(client)

Parameters

Name	Type
client	EditorClient

Properties

id

• Readonly id: string

Methods

getAccessPermssionOnDocument

▸ getAccessPermssionOnDocument(): DocumentAccessPermission

Returns

DocumentAccessPermission

the permission the user has on the current document.

Viewport

ui/viewport.Viewport

Constructors

constructor

• new Viewport(client)

Parameters

Name	Type
client	EditorClient

Methods

cancelDraggingNewBlock

▸ cancelDraggingNewBlock(): void

If startDraggingNewBlock has been called, and the drag-new-block interaction is still active, cancel that interaction.

Returns

void

cancelDraggingNewImage

▸ cancelDraggingNewImage(): void

If startDraggingNewImage has been called, and the drag-new-image interaction is still active, cancel that interaction.

Returns

void

dragPointerMove

▸ dragPointerMove(x, y): void

After calling startDraggingNewBlock, call this to simulate the user moving the mouse at the given location within the top-level browser window.

This has no effect if the drag-new-block interaction is not active.

To convert a position in a Panel's iframe to a position in the top-level browser window, add the IframeUI.framePosition.

Parameters

Name	Type
x	number
y	number

Returns

void

dragPointerUp

▸ dragPointerUp(x, y): void

After calling startDraggingNewBlock, call this to simulate the user releasing the mouse button at the given location within the top-level browser window.

This has no effect if the drag-new-block interaction is not active.

To convert a position in a Panel's iframe to a position in the top-level browser window, add the IframeUI.framePosition.

Parameters

Name	Type
x	number
y	number

Returns

void

findAvailableSpace

▸ findAvailableSpace(width, height): Object

Find available space on the current page for adding new content.

Parameters

Name	Type
width	number
height	number

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.

Name	Type
page	PageProxy
x	number
y	number

focusCameraOnItems

▸ focusCameraOnItems(items): void

Switch to the page containing these items, if necessary, and then animate the viewport to zoom in and focus on these items.

Parameters

Name	Type	Description
items	ItemProxy []	The items the camera should zoom to

Returns

void

getCurrentPage

▸ getCurrentPage(): undefined | PageProxy

Returns

undefined | PageProxy

the page currently being viewed

getSelectedItems

▸ getSelectedItems(deep?): ItemProxy []

Parameters

Name	Type	Description
deep?	boolean	If true, and groups are selected, include the contents of those groups in the array

Returns

ItemProxy []

An array of currently-selected items on the currently-visible page

getVisibleRect

▸ getVisibleRect(): Box

Returns

the box for the current viewport location

hookSelection

▸ hookSelection(callback): string

Parameters

Name	Type	Description
callback	(items: ItemProxy []) => void	Called when the user changes their selection of items

Returns

string

A handle representing this hook, which can be passed to unhookSelection to remove this hook.

hookTextEdit

▸ hookTextEdit(callback, eager?): string

If callback returns false, text editing is prevented. If callback returns true, text editing continues as normal.

If callback returns a TextEditCompletionCallback(/extension-sdk/#modules_ui_viewport_texteditcompletioncallback), then text editing is allowed, but that completion callback is called.

when the user finishes editing that text. That completion callback may return true or false to allow or deny the edit, or also may return a replacement string to use instead of the text the user actually typed. If replacement text is provided, it will be styled as close to the original as possible, but styles that apply to only parts of the original text will be discarded.

Parameters

Name	Type	Description
callback	(item: ItemProxy , textAreaKey: string, text?: string) => boolean \| TextEditCompletionCallback \| Promise<boolean \| TextEditCompletionCallback >	Called just before the user starts editing text.
eager?	boolean	Whether to trigger the callback eagerly during text edit

Returns

string

A handle representing this hook, which can be passed to unhookTextEdit to remove this hook.

setCurrentPage

▸ setCurrentPage(page): void

View the given page in the viewport

Parameters

Name	Type	Description
page	PageProxy	The page to view

Returns

void

setSelectedItems

▸ setSelectedItems(items): void

Unselect all currently-selected items, and select the subset of the given items that exist on the currently-visible page.

Parameters

Name	Type
items	ItemProxy []

Returns

void

startDraggingNewBlock

▸ startDraggingNewBlock(definition): Promise<undefined | BlockProxy >

Start an interaction of the current user dragging a new block onto the current page, exactly as if they started dragging that block out of the normal toolbox. At the time this function is called, the user's primary mouse button should be down (e.g. in a mousedown event handler).

Parameters

Name	Type	Description
definition	BlockDefinition	Definition of the block to create if and where the user drops it on-canvas

Returns

Promise<undefined | BlockProxy >

A promise resolving to a reference to the created block, if successfully dropped, or undefined if the user cancels the drag interaction.

startDraggingNewImage

▸ startDraggingNewImage(definition): Promise<undefined | BlockProxy >

Start an interaction of the current user dragging a new image onto the current page, exactly as if they started dragging that image out of the normal toolbox. At the time this function is called, the user's primary mouse button should be down (e.g. in a mousedown event handler).

Parameters

Name	Type	Description
definition	ImageDefinition	Definition of the image to create if and where the user drops it on-canvas

Returns

Promise<undefined | BlockProxy >

A promise resolving to a reference to the created image, if successfully dropped, or undefined if the user cancels the drag interaction.

unhookSelection

▸ unhookSelection(handle): void

Remove a hook set by hookSelection.

Parameters

Name	Type	Description
handle	string	The return value of hookSelection.

Returns

void

unhookTextEdit

▸ unhookTextEdit(handle): void

Remove a hook set by hookTextEdit.

Parameters

Name	Type	Description
handle	string	The return value of hookTextEdit.

Returns

void

Webhook

dataconnector/actions/action.Webhook

A description of an existing webhook that Lucid is keeping track of.

Constructors

constructor

• new Webhook(documentCollections, webhookData)

Parameters

Name	Type	Description
documentCollections	Object	Set of items this webhook is tracking as a Record<CollectionId, ItemPrimaryKey[]>
webhookData	unknown	Arbitrary extra data to allow the data connector to better identitify the webhook.

Properties

documentCollections

• documentCollections: Object

Set of items this webhook is tracking as a Record<CollectionId, ItemPrimaryKey[]>

Index signature

▪ [collectionId: CollectionId ]: ItemPrimaryKey []

webhookData

• webhookData: unknown

Arbitrary extra data to allow the data connector to better identitify the webhook.

WriteableMapProxy<KEY, VALUE, WRITERETURN, WRITEVALUE>

document/mapproxy.WriteableMapProxy

A data structure similar to a normal Map which accesses its data through API commands to the Lucid app. This structure is iterable with for...of.

Type parameters

Name	Type
KEY	KEY
VALUE	VALUE
WRITERETURN	WRITERETURN
WRITEVALUE	VALUE

Hierarchy

MapProxy <KEY, VALUE>

↳ WriteableMapProxy

↳↳ ShapeDataProxy

Constructors

constructor

• new WriteableMapProxy<KEY, VALUE, WRITERETURN, WRITEVALUE>(getKeys, getItem, setter)

Type parameters

Name	Type
KEY	KEY
VALUE	VALUE
WRITERETURN	WRITERETURN
WRITEVALUE	VALUE

Parameters

Name	Type
getKeys	() => KEY[]
getItem	(key: KEY) => VALUE
setter	(key: KEY, val: WRITEVALUE, options?: SetterOptions ) => WRITERETURN

Overrides

MapProxy.constructor

Accessors

size

• get size(): number

Returns

number

Inherited from

MapProxy.size

Methods

filter

▸ filter(filter): VALUE[]

Parameters

Name	Type
filter	(item: VALUE, key: KEY) => boolean

Returns

VALUE[]

Inherited from

MapProxy.filter

find

▸ find(filter): undefined | VALUE

Parameters

Name	Type
filter	(item: VALUE, key: KEY) => boolean

Returns

undefined | VALUE

Inherited from

MapProxy.find

Inherited from

MapProxy.values

Interfaces

Badgeable

core/properties/datagraphic/badgeposition.Badgeable

Properties

position

• position: SerializedBadgeEnumPosition

BadgeEnumPosition

core/properties/datagraphic/badgeposition.BadgeEnumPosition

Properties

horizontalPos

• horizontalPos: HorizontalBadgePos

layer

• layer: BadgeLayerPos

responsive

• responsive: BadgeResponsiveness

verticalPos

• verticalPos: VerticalBadgePos

BaseConditionDefinition

document/ruledefinition.BaseConditionDefinition

Hierarchy

BaseConditionDefinition

↳ FormulaConditionDefinition

↳ ShapeDataConditionDefinition

↳ TextConditionDefinition

↳ ShapeTypeConditionDefinition

Properties

type

• type: ConditionType

What kind of condition is this? e.g. a formula evaluation, checking for non-empty text, etc.

BaseEffectDefinition

document/ruledefinition.BaseEffectDefinition

Hierarchy

BaseEffectDefinition

↳ FormattingEffectDefinition

↳ DataGraphicEffectDefinition

↳ CustomIconEffectDefinition

Properties

combination

• combination: ConditionCombination

How multiple conditions are combined (AND vs OR)

conditions

• conditions: ConditionDefinition []

• Optional tooltip: string

BaseXHRResponse

core/xhr.BaseXHRResponse

Hierarchy

BaseXHRResponse

↳ TextXHRResponse

↳ BinaryXHRResponse

Properties

headers

• headers: Object

Headers sent by the server in the response

Index signature

▪ [key: string]: string

status

• status: number

HTTP status, e.g. 200 or 404

timeout

• Optional timeout: boolean

True if this request failed due to a timeout

url

• url: string

URL of the final response, after any redirects

BinaryXHRResponse

core/xhr.BinaryXHRResponse

Hierarchy

BaseXHRResponse

↳ BinaryXHRResponse

Properties

headers

• headers: Object

Headers sent by the server in the response

Index signature

▪ [key: string]: string

Inherited from

BaseXHRResponse.headers

responseData

• responseData: Uint8Array

Contents of the response body

responseFormat

• responseFormat: "binary"

status

• status: number

HTTP status, e.g. 200 or 404

Inherited from

BaseXHRResponse.status

timeout

• Optional timeout: boolean

True if this request failed due to a timeout

Inherited from

BaseXHRResponse.timeout

url

• url: string

URL of the final response, after any redirects

Inherited from

BaseXHRResponse.url

BlockDefinition

document/blockdefinition.BlockDefinition

The information required to create a new block on the current document

Properties

boundingBox

• boundingBox: Box

The initial location and size of the block on the page.

className

• className: string

The type of block to create, e.g. "ProcessBlock".

fillStyle

• Optional fillStyle: SimpleFillStyle

If specified, the initial FillColor property for the block

lineWidth

• Optional lineWidth: number

If specified, the initial line width for the block

properties

• Optional properties: JsonObject

Additional properties to set on the block immediately after creation. This is not typically set directly (it's easier and safer to call .properties.set() after block creation) but is set by EditorClient.getCustomShapeDefinition.

stencil

• Optional stencil: JsonSerializable

If specified, the stencil to use for a custom shape. This is not typically set directly; use EditorClient.getCustomShapeDefinition.

BlockEndpointDefinition

document/linedefinition.BlockEndpointDefinition

A line endpoint connected to another block

Hierarchy

EndpointStyle

↳ BlockEndpointDefinition

Properties

autoLink

• Optional autoLink: boolean

If true, this endpoint may move around the target block in order to make the line less complex

connection

• connection: BlockProxy

inside

• Optional inside: boolean

If true, the connection isn't to the edge of the target block, but inside it

linkX

• linkX: number

0 to 1, relative X position in target block's bounding box

linkY

• linkY: number

0 to 1, relative Y position in target block's bounding box

padding

• Optional padding: number

If set, the distance from the connected block this endpoint should be

style

• Optional style: string

Omit to use defaults (theme)

Inherited from

EndpointStyle.style

BufferSingleton

dataconnector/cryptodependencies.BufferSingleton

Methods

from

▸ from(str, encoding?): unknown

Parameters

Name	Type
str	string
encoding?	string

Returns

unknown

CardIntegrationConfig

core/cardintegration/cardintegrationconfig.CardIntegrationConfig

Properties

cardConfig

• cardConfig: Object

Type declaration

Name	Type	Description
fieldDisplaySettings?	Map<string, LucidCardFieldDisplaySettings >	The data fields to be displayed on cards as data graphics
fieldNames	string[]	The data fields to be displayed on cards, as data-linked text fields
fieldStyles?	Map<string, Partial< TextStyle >>	The default text style to set on each of the above fields for new cards. Any style not specified will use a default value, and any field name not present will use all defaults.

cardDetailsPanelConfig

• cardDetailsPanelConfig: Object

Type declaration

Name	Type	Description
fields	{ locked?: boolean ; name: string }[]	The data fields to be displayed in the details panel of a card

CollectionDefinition

data/collectiondefinition.CollectionDefinition

Properties

items

• items: Map<string, SerializedFields >

schema

• schema: SchemaDefinition

CollectionPatch

dataconnector/datasourceupdatetypes.CollectionPatch

A patch to a collection or the definition of a new collection to be added. If adding a new collection, a schema must be provided. If modifying an existing collection, a schema may be omitted.

Properties

name

• Optional name: string

The collection's display name

patch

• patch: ItemsPatch

The patch to apply to the collection

represents

• Optional represents: Items []

What the collection implicitly represents *

schema

• Optional schema: SchemaDefinition

If changing an existing schema only the following changes are allowed:

Adding a nullable field
Promoting a type of a field to a union of types (string -> string | number)
Adding a new variant to a union type (string | number -> string | number | boolean)

Removing a field is not allowed (just add | null and don't provide the field in patches anymore).
Changing a type in a way that any existing legal value is no longer valid for that field is not allowed.

CollectionReferenceKeyDefinition

data/referencekeydefinition.CollectionReferenceKeyDefinition

A reference key that points to a DataItem in a Collection. This is the most common type of reference key to create.

For more information, see the Developer Guide.

Properties

collectionId

• collectionId: string

The ID of the collection referenced

fieldWhitelist

• Optional fieldWhitelist: string[]

If specified, only expose this list of fields through this reference key. This can be used to limit namespace pollution in shape data from lots of unnecessary fields, or just to hide information you'd prefer not to be visible in the UI or through formulas.

primaryKey

• primaryKey: string

The primary key of the data item referenced

readonly

• Optional readonly: boolean

If true, prevent the user from editing the field values of this reference key through the normal UI

Console

interop.Console

Methods

assert

▸ assert(condition?, ...data): void

Parameters

Name	Type
condition?	boolean
...data	any[]

Returns

void

▸ assert(condition?, ...data): void

Parameters

Name	Type
condition?	boolean
...data	any[]

Returns

void

clear

▸ clear(): void

Name	Type
label?	string

Returns

void

countReset

▸ countReset(label?): void

Parameters

Name	Type
label?	string

Returns

void

▸ countReset(label?): void

Parameters

Name	Type
label?	string

Returns

void

debug

▸ debug(...data): void

Parameters

Name	Type
...data	any[]

Returns

void

▸ debug(...data): void

Parameters

Name	Type
...data	any[]

Returns

void

dir

▸ dir(item?, options?): void

Parameters

Name	Type
item?	any
options?	any

Returns

void

▸ dir(item?, options?): void

Parameters

Name	Type
item?	any
options?	any

Returns

void

dirxml

▸ dirxml(...data): void

Parameters

Name	Type
...data	any[]

Returns

void

▸ dirxml(...data): void

Parameters

Name	Type
...data	any[]

Returns

void

error

▸ error(...data): void

Parameters

Name	Type
...data	any[]

Returns

void

▸ error(...data): void

Parameters

Name	Type
...data	any[]

Returns

void

group

▸ group(...data): void

Parameters

Name	Type
...data	any[]

Returns

void

▸ group(...data): void

Parameters

Name	Type
...data	any[]

Returns

void

groupCollapsed

▸ groupCollapsed(...data): void

Parameters

Name	Type
...data	any[]

Returns

void

▸ groupCollapsed(...data): void

Parameters

Name	Type
...data	any[]

Returns

void

groupEnd

▸ groupEnd(): void

Name	Type
...data	any[]

Returns

void

log

▸ log(...data): void

Parameters

Name	Type
...data	any[]

Returns

void

▸ log(...data): void

Parameters

Name	Type
...data	any[]

Returns

void

table

▸ table(tabularData?, properties?): void

Parameters

Name	Type
tabularData?	any
properties?	string[]

Returns

void

▸ table(tabularData?, properties?): void

Parameters

Name	Type
tabularData?	any
properties?	string[]

Returns

void

time

▸ time(label?): void

Parameters

Name	Type
label?	string

Returns

void

▸ time(label?): void

Parameters

Name	Type
label?	string

Returns

void

timeEnd

▸ timeEnd(label?): void

Parameters

Name	Type
label?	string

Returns

void

▸ timeEnd(label?): void

Parameters

Name	Type
label?	string

Returns

void

timeLog

▸ timeLog(label?, ...data): void

Parameters

Name	Type
label?	string
...data	any[]

Returns

void

▸ timeLog(label?, ...data): void

Parameters

Name	Type
label?	string
...data	any[]

Returns

void

timeStamp

▸ timeStamp(label?): void

Parameters

Name	Type
label?	string

Returns

void

▸ timeStamp(label?): void

Parameters

Name	Type
label?	string

Returns

void

trace

▸ trace(...data): void

Parameters

Name	Type
...data	any[]

Returns

void

▸ trace(...data): void

Parameters

Name	Type
...data	any[]

Returns

void

warn

▸ warn(...data): void

CustomMenuConfig.disabledAction

Parameters

Name	Type
...data	any[]

Returns

void

▸ warn(...data): void

Parameters

Name	Type
...data	any[]

Returns

void

CryptoModule

dataconnector/cryptodependencies.CryptoModule

Methods

createPublicKey

▸ createPublicKey(key): unknown

Parameters

Name	Type
key	string

Returns

unknown

verify

▸ verify(algorithm, data, publicKey, signature): boolean

Parameters

Name	Type
algorithm	string
data	unknown
publicKey	unknown
signature	unknown

Returns

boolean

CustomContentDockMenu

ui/menu.CustomContentDockMenu

Data to create a content dock icon in Spark + Teamspaces

Hierarchy

CustomMenuConfig

↳ CustomContentDockMenu

Properties

action

• action: string

The registered action to run when the menu item is clicked

Overrides

CustomMenuConfig.action

disabledAction

• Optional disabledAction: string

If specified, what action's return value should determine if this menu item is disabled?

Inherited from

file

• Optional file: Object

If specified, this menu item should launch a file picker

Type declaration

Name	Type	Description
accept	string	An accept string as specified for HTML file inputs
action	string	An action registered with EditorClient.registerFileUploadAction
binary?	boolean	If true, send the file contents to the callback action as a Uint8Array as well as a plain text string
singleFileOnly?	boolean	If true, only allow a single file to be selected for upload

Inherited from

CustomMenuConfig.file

iconUrl

• iconUrl: string

The icon to display on the menu item. A URL (a data URI is fine) pointing to an icon representing the integration. This will be displayed at up to 32x32 CSS pixels in size.

label

• label: string

The text to display on the menu item

Inherited from

CustomMenuConfig.label

visibleAction

• Optional visibleAction: string

If specified, what action's return value should determine if this menu item is visible?

Inherited from

CustomMenuConfig.visibleAction

CustomDropdownMenu

ui/menu.CustomDropdownMenu

Data to create a dropdown menu in the main top menus.

Hierarchy

CustomMenuConfig

↳ CustomDropdownMenu

Properties

action

• Optional action: string

The registered action to run when the menu item is clicked.

Inherited from

CustomMenuConfig.action

disabledAction

• Optional disabledAction: string

If specified, what action's return value should determine if this menu item is disabled?

Inherited from

CustomMenuConfig.disabledAction

file

• Optional file: Object

If specified, this menu item should launch a file picker

Type declaration

Name	Type	Description
accept	string	An accept string as specified for HTML file inputs
action	string	An action registered with EditorClient.registerFileUploadAction
binary?	boolean	If true, send the file contents to the callback action as a Uint8Array as well as a plain text string
singleFileOnly?	boolean	If true, only allow a single file to be selected for upload

Inherited from

CustomMenuConfig.file

label

• label: string

The text to display on the menu item

Inherited from

CustomMenuConfig.label

location

• Optional location: MenuLocation

Where in that menu to display this item in Lucidchart. Defaults to the extension menu. In Lucidspark the only valid menu is Extension, it will not appear otherwise.

visibleAction

• Optional visibleAction: string

If specified, what action's return value should determine if this menu item is visible?

Inherited from

CustomMenuConfig.visibleAction

CustomIconEffectDefinition

document/ruledefinition.CustomIconEffectDefinition

Hierarchy

BaseEffectDefinition

↳ CustomIconEffectDefinition

Properties

combination

• combination: ConditionCombination

How multiple conditions are combined (AND vs OR)

Inherited from

BaseEffectDefinition.combination

conditions

• conditions: ConditionDefinition []

Inherited from

BaseEffectDefinition.conditions

dataGraphic

• dataGraphic: Object

Type declaration

Name	Type
image	{ height: number ; url: string ; width: number }
image.height	number
image.url	string
image.width	number
position	BadgeEnumPosition
set	CUSTOM_ICONS

formatType

• formatType: DATA_GRAPHICS

• Optional tooltip: string

Inherited from

BaseEffectDefinition.tooltip

CustomMenuConfig

ui/menu.CustomMenuConfig

Data to create a menu

Hierarchy

CustomMenuConfig

↳ CustomDropdownMenu

↳ CustomContentDockMenu

Properties

action

• Optional action: string

The registered action to run when the menu item is clicked.

disabledAction

• Optional disabledAction: string

If specified, what action's return value should determine if this menu item is disabled?

file

• Optional file: Object

If specified, this menu item should launch a file picker

Type declaration

Name	Type	Description
accept	string	An accept string as specified for HTML file inputs
action	string	An action registered with EditorClient.registerFileUploadAction
binary?	boolean	If true, send the file contents to the callback action as a Uint8Array as well as a plain text string
singleFileOnly?	boolean	If true, only allow a single file to be selected for upload

label

• label: string

The text to display on the menu item

visibleAction

• Optional visibleAction: string

If specified, what action's return value should determine if this menu item is visible?

CustomMenuItem

ui/menu.CustomMenuItem

A generic object to contain any information creating a menu might need. It is a little easier to use CustomMenuConfig, CustomDropdownMenu, or CustomContentDockMenu.

Properties

action

• Optional action: string

The registered action to run when the menu item is clicked

disabledAction

• Optional disabledAction: string

If specified, what action's return value should determine if this menu item is disabled?

file

• Optional file: Object

If specified, this menu item should launch a file picker

Type declaration

Name	Type	Description
accept	string	An accept string as specified for HTML file inputs
action	string	An action registered with EditorClient.registerFileUploadAction
binary?	boolean	If true, send the file contents to the callback action as a Uint8Array as well as a plain text string
singleFileOnly?	boolean	If true, only allow a single file to be selected for upload

iconUrl

• Optional iconUrl: string

The icon to display on the menu item. A URL (a data URI is fine) pointing to an icon representing the integration. This will be displayed at up to 32x32 CSS pixels in size.

NOTE: Not all menuTypes support displaying an icon

label

• label: string

The text to display on the menu item

location

• Optional location: MenuLocation

Where in that menu to display this item

menuType

• menuType: MenuType

Which menu to display this item in

visibleAction

• Optional visibleAction: string

If specified, what action's return value should determine if this menu item is visible?

DataGraphicEffectDefinition

document/ruledefinition.DataGraphicEffectDefinition

Hierarchy

BaseEffectDefinition

↳ DataGraphicEffectDefinition

Properties

combination

• combination: ConditionCombination

How multiple conditions are combined (AND vs OR)

Inherited from

BaseEffectDefinition.combination

conditions

• conditions: ConditionDefinition []

Inherited from

BaseEffectDefinition.conditions

dataGraphic

• dataGraphic: Object

Type declaration

Name	Type
color?	string
index	number
position	BadgeEnumPosition
set	STATUS_ICONS \| STATUS_CIRCLES \| STOPLIGHTS \| TOGGLES \| COMPLETION_PIES \| TRENDING_ARROWS \| STATUS_CHECK_BOXES \| TRENDING_ARROWS_FLIPPED

formatType

• formatType: DATA_GRAPHICS

• Optional tooltip: string

Inherited from

BaseEffectDefinition.tooltip

DeferredPromise<T>

core/defer.DeferredPromise

Type parameters

Name
T

Hierarchy

Promise<T>

↳ DeferredPromise

Properties

[interfaces_core_defer-DeferredPromise_-tostringtag-]

• Readonly [toStringTag]: string

Inherited from

Promise.__@toStringTag@218

promise

• promise: Promise<T>

reject

• reject: (p1?: any) => any

Type declaration

▸ (p1?): any

Parameters

Name	Type
p1?	any

Returns

any

resolve

• resolve: (p1: T) => any

Type declaration

▸ (p1): any

Parameters

Name	Type
p1	T

Returns

any

Methods

catch

▸ catch<TResult>(onrejected?): Promise<T | TResult>

Attaches a callback for only the rejection of the Promise.

Type parameters

Name	Type
TResult	never

Parameters

Name	Type	Description
onrejected?	null \| (reason: any) => TResult \| PromiseLike<TResult>	The callback to execute when the Promise is rejected.

Returns

Promise<T | TResult>

A Promise for the completion of the callback.

Inherited from

Promise.catch

finally

▸ finally(onfinally?): Promise<T>

Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.

Parameters

Name	Type	Description
onfinally?	null \| () => void	The callback to execute when the Promise is settled (fulfilled or rejected).

Returns

Promise<T>

A Promise for the completion of the callback.

Inherited from

Promise.finally

then

▸ then<TResult1, TResult2>(onfulfilled?, onrejected?): Promise<TResult1 | TResult2>

Attaches callbacks for the resolution and/or rejection of the Promise.

Type parameters

Name	Type
TResult1	T
TResult2	never

Parameters

Name	Type	Description
onfulfilled?	null \| (value: T) => TResult1 \| PromiseLike<TResult1>	The callback to execute when the Promise is resolved.
onrejected?	null \| (reason: any) => TResult2 \| PromiseLike<TResult2>	The callback to execute when the Promise is rejected.

Returns

Promise<TResult1 | TResult2>

A Promise for the completion of which ever callback is executed.

Inherited from

Promise.then

EndpointStyle

document/linedefinition.EndpointStyle

Hierarchy

EndpointStyle

↳ BlockEndpointDefinition

↳ LineEndpointDefinition

↳ PositionEndpointDefinition

Properties

style

• Optional style: string

Omit to use defaults (theme)

ExtensionCardFieldDefinition

core/cardintegration/cardintegrationdefinitions.ExtensionCardFieldDefinition

The definition for a field to be included in a SchemaDefinition

Hierarchy

FieldDefinition

↳ ExtensionCardFieldDefinition

Properties

constraints

• Optional constraints: FieldConstraintDefinition []

Inherited from

FieldDefinition.constraints

default

• Optional default: SerializedFieldType

If defined, the default value for this field

description

• Optional description: string

Additional information we can provide to users, e.g. as a hover tooltip

label

• label: string

The label to display in the UI

mapping

• Optional mapping: readonly SemanticFields [] | readonly SemanticKind []

Inherited from

FieldDefinition.mapping

name

• name: string

Inherited from

FieldDefinition.name

options

• Optional options: string | ExtensionCardFieldOption []

If specified, the list of options available to choose from, or the name of a registered action that returns the list of options (either directly or as a Promise).

search

• Optional search: string

If specified, an action that takes the search text and input so far, and returns the list of options that should be displayed. This is useful when there are too many possible options to reasonably use the "options" option for options.

type

• type: FieldTypeDefinition

Inherited from

FieldDefinition.type

ExtensionCardFieldOption

core/cardintegration/cardintegrationdefinitions.ExtensionCardFieldOption

For fields with Option or ApiOption type, the label and value for each available option

Properties

iconUrl

• Optional iconUrl: string

label

• label: string

value

• value: SerializedFieldType

Failure<T>

core/result.Failure

Type parameters

Name
T

Properties

error

• error: T

FieldDefinition

data/schemadefinition.FieldDefinition

The definition for a field to be included in a SchemaDefinition

Hierarchy

FieldDefinition

↳ ExtensionCardFieldDefinition

Properties

constraints

• Optional constraints: FieldConstraintDefinition []

mapping

• Optional mapping: readonly SemanticFields [] | readonly SemanticKind []

name

• name: string

type

• type: FieldTypeDefinition

FileUploadData

ui/menu.FileUploadData

Properties

binary

• Optional binary: Uint8Array

fileName

• fileName: string

text

• text: string

FlattenedReferenceDefinition

data/referencekeydefinition.FlattenedReferenceDefinition

A reference key that has the field values embedded directly in the reference definition. This can be useful in cases when you want to have a standard schema of data associated with an element but do not for whatever reason want to construct an actual Collection to house that data.

Properties

data

• data: Record<string, SerializedFieldType >

Field values available at this reference key

name

• Optional name: string

Name to display to the user for the reference key (what would normally be the collection name)

schema

• schema: SchemaDefinition

Schema of the data stored at this key

FormattingEffectDefinition

document/ruledefinition.FormattingEffectDefinition

Hierarchy

BaseEffectDefinition

↳ FormattingEffectDefinition

Properties

combination

• combination: ConditionCombination

How multiple conditions are combined (AND vs OR)

Inherited from

BaseEffectDefinition.combination

conditions

• conditions: ConditionDefinition []

Inherited from

BaseEffectDefinition.conditions

formatType

• formatType: FORMATTING

formatting

• formatting: Object

Type declaration

Name	Type	Description
borderColor?	string	If specified, the color to use for affected block borders
borderStyle?	StrokeStyle	If specified, the style to use for affected block borders
borderWidth?	number	If specified, the width to use for affected block borders
fillColor?	string	If specified, the color to use for affected block fills
lineColor?	string	If specified, the color to use for affected lines
lineStyle?	StrokeStyle	If specified, the style to use for affected lines
lineWidth?	number	If specified, the width to use for affected lines

• Optional tooltip: string

Inherited from

BaseEffectDefinition.tooltip

FormulaConditionDefinition

document/ruledefinition.FormulaConditionDefinition

Hierarchy

BaseConditionDefinition

↳ FormulaConditionDefinition

Properties

formula

• formula: string

The formula string

type

• type: Formula

What kind of condition is this? e.g. a formula evaluation, checking for non-empty text, etc.

Overrides

XHRRequest.responseFormat

I18nFormattedNumberParams

interop.I18nFormattedNumberParams

Properties

maximumFractionDigits

• Optional maximumFractionDigits: number

minimumFractionDigits

• Optional minimumFractionDigits: number

minimumIntegerDigits

• Optional minimumIntegerDigits: number

useGrouping

• Optional useGrouping: boolean

I18nReplacement

interop.I18nReplacement

Indexable

ImageDefinition

document/imagedefinition.ImageDefinition

The information required to create a new image block on the current document

Properties

boundingBox

• boundingBox: Box

The initial location and size of the block on the page.

fillStyle

• fillStyle: SimpleImageFill

Settings for using an image as the fill style of a block.

lineColor

• Optional lineColor: string

the border color for this image (default is black, #000000).

lineWidth

• Optional lineWidth: number

The border width in pixels for this image (default is 1).

opacity

• Optional opacity: number

The opacity (0 - 1) for this image (default is 1).

rotation

• Optional rotation: number

The rotation for this image (deafult is 0).

rounding

• Optional rounding: number

The rounding for this image (default is 0).

strokeStyle

• Optional strokeStyle: StrokeStyle

The stroke style for the border of this image (default is Solid).

ImportResult

core/cardintegration/lucidcardintegrationstandardimportmodal.ImportResult

Result of importing data from the import modal

Properties

collection

• collection: CollectionProxy

primaryKeys

• primaryKeys: string[]

JsonObject

core/jsonserializable.JsonObject

Indexable

▪ [key: string]: JsonSerializable

LineDefinition

document/linedefinition.LineDefinition

The information required in order to create a new line

Properties

endpoint1

• endpoint1: EndpointDefinition

endpoint2

• endpoint2: EndpointDefinition

LineEndpointDefinition

document/linedefinition.LineEndpointDefinition

A line endpoint that is connected to another line at some distance along that other line, where 0 is at that line's endpoint1, and 1 is at that line's endpoint2.

Hierarchy

EndpointStyle

↳ LineEndpointDefinition

Properties

connection

• connection: LineProxy

position

• position: number

0 to 1, distance along the target line

style

• Optional style: string

Omit to use defaults (theme)

Inherited from

EndpointStyle.style

LineTextAreaPositioning

document/linetextareapositioning.LineTextAreaPositioning

Properties

allowOverBlock

• Optional allowOverBlock: boolean

Normally text on a line is not allowed to overlap a block that is connected to either end of the line. If allowOverBlock is true, then the text is allowed to overlap an attached block.

location

• location: number

A number between 0 and 1 representing how far this text lies along the line, where 0 puts the text at the same location as the first endpoint, and 1 puts the text at the same location as the second endpoint.

side

• side: 0 | 1 | -1

Which side of the line the text is displayed on. If zero, the text is on top of the line. If -1, the text is to the left of the line as you travel from the first to second endpoints. If 1, the text is to the right of the line as you travel from the first to second endpoints.

LockedFieldConstraintDefinition

data/schemadefinition.LockedFieldConstraintDefinition

Properties

type

• type: LOCKED

value

• Optional value: undefined

LucidCardFieldDisplaySettings

core/cardintegration/cardfielddisplaysettings.LucidCardFieldDisplaySettings

Configuration settings for how to display a particular field on the card itself. Currently only used for adding custom data graphics with stencils.

Properties

stencilConfig

• Optional stencilConfig: StencilConfig

LucidCardIntegrationStandardImportModal

core/cardintegration/lucidcardintegrationstandardimportmodal.LucidCardIntegrationStandardImportModal

You can use the standard import modal can be used by providing the following data:

getSearchFields: Given the values entered by the user so far into search fields, return the list of all search fields to display in the search form.

search: Given values entered by the user into the search fields so far, return a collection of data to display in the results table. If partialImportMetadata is also returned, it will be used to create the tasks cards before the import is completed—which allows users to interact with the cards while the data is fetched asynchronously. The collectionId needs to match the id that will be returned from the completed import. The syncDataSourceId needs to match the syncDataSourceId that is passed into performDataAction. The last requirement for the partial import to work is that the primary keys in the data also returned in this search need to match the primary keys that will be returned on import.

import: The user checked the boxes beside the given list of items in the collection returned from search(). Import them, and return the collection and primary keys in that final collection that were imported.

onSetup: If specified, it's going to be called everytime the modal is setting up, right after the modal is displayed and before the initial form fields are shown to the user.

The config provided here is only used on the first import from a given source; on subsequent imports, the existing config will remain unchanged to preserve any customizations by the user.

Properties

getSearchFields

• getSearchFields: (searchSoFar: Map<string, SerializedFieldType >) => Promise< ExtensionCardFieldDefinition []>

Type declaration

▸ (searchSoFar): Promise< ExtensionCardFieldDefinition []>

Parameters

Name	Type
searchSoFar	Map<string, SerializedFieldType >

value

• Optional value: undefined

OAuthXHRRequest

core/xhr.OAuthXHRRequest

Hierarchy

XHRRequest

↳ OAuthXHRRequest

Properties

data

• Optional data: string

The data to send as the body of the request

Inherited from

XHRRequest.data

headers

• Optional headers: Object

Headers to send with the request. If specifying an array, multiple headers with the same name will be sent

Index signature

▪ [key: string]: string | string[]

Inherited from

XHRRequest.headers

method

• Optional method: string

HTTP method, e.g. "POST". If omitted, GET is used

Inherited from

XHRRequest.method

postResultTo

• Optional postResultTo: string

When present, forwards the result of this request to the specified destination. Instead, this request returns whether the request will be made and forwarded, and not the actual request.

Note: There is an allow list which limits where the result can be posted. It is currently only to the result of LinkUnfurlBlockProxy#experimentalStartPDFUpload

responseFormat

• Optional responseFormat: SendXHRResponseFormat

The desired format for the returned response body. Defaults to 'utf8'.

If 'utf8', the response body will be returned as a string.
If 'binary', the response body will be returned as a Uint8Array.

Inherited from

streamCallback

• Optional streamCallback: (chunk: string) => void

Type declaration

▸ (chunk): void

For utf8 responses, you can have the result streamed to you for endpoints that support it.

Parameters

Name	Type
chunk	string

document/pagedefinition.PageDefinition

The information required to create a new page on the current document

Properties

title

• title: string

PositionEndpointDefinition

document/linedefinition.PositionEndpointDefinition

A line endpoint that is free-floating at the given x/y location on the page

Hierarchy

EndpointStyle

↳ PositionEndpointDefinition

Properties

connection

• Optional connection: void

style

• Optional style: string

Omit to use defaults (theme)

Inherited from

EndpointStyle.style

x

• x: number

y

• y: number

RequiredFieldConstraintDefinition

data/schemadefinition.RequiredFieldConstraintDefinition

Properties

type

• type: REQUIRED

value

• Optional value: undefined

RuleDefinition

document/ruledefinition.RuleDefinition

Properties

effects

• effects: EffectDefinition []

The possible visual effects of this conditional formatting rule, in priority order. The first effect whose conditions are met is used.

name

• name: string

User-readable name of this conditional formatting rule

SchemaDefinition

data/schemadefinition.SchemaDefinition

Definition of a schema for creating a Collection

Properties

fieldLabels

• Optional fieldLabels: Record<string, string>

Maps field names to labels to display in the UI when necessary. If any field name is not present as a key in this label map, the field name itself will be the label.

fields

• fields: FieldDefinition []

primaryKey

• primaryKey: string[]

Field names that are used to construct primary keys for new data items. Typically this contains only one field name, and that field is usually unique.

SearchResult

core/cardintegration/lucidcardintegrationstandardimportmodal.SearchResult

Result of searching for data in the import modal

Properties

data

• data: CollectionDefinition

fields

• fields: ExtensionCardFieldDefinition []

partialImportMetadata

• Optional partialImportMetadata: Object

Type declaration

Name	Type
collectionId	string
syncDataSourceId?	string

SerializedCollectionPatch

dataconnector/datasourceupdatetypes.SerializedCollectionPatch

Properties

itemsPatch

• itemsPatch: SerializedItemsPatch

properties

• Optional properties: serializedPropertiesForApi

schema

• Optional schema: SerializedSchemaForApi

SerializedDataItems

core/data/serializedfield/serializeddataitems.SerializedDataItems

Indexable

▪ [primaryKey: string]: SerializedFields

SerializedReferenceKey

core/data/referencekeys/serializedreferencekey.SerializedReferenceKey

Properties

cid

• cid: string

f

• Optional f: Object

Type declaration

Name	Type
e?	string
md?	SerializedFields
pd	TypedSerializedFlattenedReference
ts	number

pk

• pk: string

ro

• Optional ro: boolean

wl

• Optional wl: string[]

SerializedSourceConfig

core/data/datasource/upstreamconfig.SerializedSourceConfig

Indexable

▪ [primaryKey: string]: JsonObject

SetterOptions

document/mapproxy.SetterOptions

Properties

force

• Optional force: boolean

Shadow

core/properties/shadow.Shadow

Properties

angle

• angle: number

blur

• blur: number

color

• color: string

distance

• distance: number

ShapeDataConditionDefinition

document/ruledefinition.ShapeDataConditionDefinition

Hierarchy

BaseConditionDefinition

↳ ShapeDataConditionDefinition

Properties

condition

• condition: ShapeDataConditions

field

• field: undefined | string

The name of the shape data field to test

fieldLabel

• Optional fieldLabel: string

The name to display to the end user to identify the field name

type

• type: ShapeData

What kind of condition is this? e.g. a formula evaluation, checking for non-empty text, etc.

Overrides

value

• Optional value: ConditionValueType

The value against which the condition is tested. For example, a condition with type = ConditionType.ShapeData condition = ShapeDataConditions.GreaterThan field = 'TheField' value = 14

will trigger when the shape data field "TheField" has a value that is greater than 14.

ShapeTypeConditionDefinition

document/ruledefinition.ShapeTypeConditionDefinition

Hierarchy

BaseConditionDefinition

↳ ShapeTypeConditionDefinition

Properties

classNames

• classNames: string[]

condition

• condition: ShapeTypeConditions

type

• type: ShapeType

What kind of condition is this? e.g. a formula evaluation, checking for non-empty text, etc.

Overrides

SingleLineFieldConstraintDefinition

data/schemadefinition.SingleLineFieldConstraintDefinition

Properties

type

• type: SINGLE_LINE_ONLY

value

• Optional value: undefined

StencilConfig

core/cardintegration/cardfielddisplaysettings.StencilConfig

Properties

backgroundColor

• Optional backgroundColor: string

For displayType values that support it, you may provide an override for the background color for this data. If this is not provided, the background color will default to the background color of the card itself, darkened 5%.

This may be provided as a literal color hex, e.g. "#00ff00ff" or as a formula by starting the string with "=", e.g. "=darken("#ffffff", 0.5)"

displayType

• displayType: FieldDisplayType

How should we generate the stencil/data graphic from the specified field value? These are registered in LucidCardsLibrary.registerStencilDisplayTypes.

foregroundColor

• Optional foregroundColor: string

For displayType values that support it, you may provide an override for the foreground color for this data. If this is not provided, the foreground color will default to grey.

This may be provided as a literal color hex, e.g. "#00ff00ff" or as a formula by starting the string with "=", e.g. "=darken("#ffffff", 0.5)"

horizontalPosition

• Optional horizontalPosition: HorizontalBadgePos

Each display type has its default location on the card. You can override those default locations by setting these values.

imageBadgeSettings

• Optional imageBadgeSettings: ImageBadgeSettings

For displayType values that support it, you may provide a height and a width for the image size. Images are 24px by 24px by default.

linkFormula

• Optional linkFormula: string

If onClickHandlerKey is OpenBrowserWindow, this formula calculates the URL to open.

onClickHandlerKey

• Optional onClickHandlerKey: OnClickHandlerKeys

If specified, what behavior should happen when the user clicks on the data graphic generated via the above displayType?

textBadgeSettings

• Optional textBadgeSettings: TextBadgeSettings

Allows the same card to have multiple textbadges but have different properties. You can change bold, italic, underline, rounding, minwidth, minheight, maxtextwidth, maxfontsize

tooltipFormula

• Optional tooltipFormula: string

If specified, the result of this formula (executed in the context of the data item associated with this card) will be used as a tooltip when the user hovers the cursor over this data graphic.

valueFormula

• Optional valueFormula: string

If specified, the result of this formula (executed in the context of the data item associated with this card) will be used instead of the raw field value when creating the data graphic. This can be useful if, for example, you want to convert an ID into a URL.

verticalPosition

• Optional verticalPosition: VerticalBadgePos

Each display type has its default location on the card. You can override those default locations by setting these values.

Success<T>

core/result.Success

Type parameters

Name
T

Properties

value

• value: T

TextConditionDefinition

document/ruledefinition.TextConditionDefinition

Hierarchy

BaseConditionDefinition

↳ TextConditionDefinition

Properties

condition

• condition: TextConditions

type

• type: Text

What kind of condition is this? e.g. a formula evaluation, checking for non-empty text, etc.

Overrides