OpenChartAutomationOptions

Integration guide · Reference index

Public contract reference. This declaration describes types and callback shapes; availability is constrained by the linked integration guide and the runtime capability. Legacy product-specific fields are not a promise of implementation.

Options for IChartWidgetApi.openAutomation(). SDK types come from the @lumencharts/chart-automation/sdk and @lumencharts/chart-automation/contracts.

commandsCopy Anchor Link

commands?: readonly ChartAutomationFamily[];

Native families to install. Defaults to every chart-level family; host-disabled families stay unsupported. A family listed in owners must also be listed here when this is given, or opening rejects with invalid_input.

ownersCopy Anchor Link

owners?: ChartAutomationOwners;

Adopt existing owners instead of building new ones, so SDK changes share their leases, Undo and persistence. Keep one mutating owner per chart per family: a second session on the same chart should pass the same owners.

policyCopy Anchor Link

policy?: AutomationPolicy;

Use the type signature above and the integration guide for the owning capability.

chartIdCopy Anchor Link

chartId?: string;

Stable ID used as the request target. Defaults to the runtime's chart ID.

bindingCopy Anchor Link

binding?: ChartBinding;

Persistence identity for native document owners. Defaults to a session-local identity.

capturePngCopy Anchor Link

capturePng?: (() => Promise<string | Blob>) | null;

Replaces the built-in exact-chart capture; null turns capture off.

requestHistoryCopy Anchor Link

requestHistory?: NativeChartAutomationOptions['requestHistory'];

Use the type signature above and the integration guide for the owning capability.

additionalDataCopy Anchor Link

additionalData?: NativeChartAutomationOptions['additionalData'];

Use the type signature above and the integration guide for the owning capability.

subscribeAdditionalDataCopy Anchor Link

subscribeAdditionalData?: NativeChartAutomationOptions['subscribeAdditionalData'];

Use the type signature above and the integration guide for the owning capability.

workspaceCopy Anchor Link

workspace?: ChartWorkspaceApi;

A widget-level workspace owner (widget.createWorkspaceCommands); the caller keeps ownership.

persistCopy Anchor Link

persist?: NativeCommandOwners['persist'];

Durable save between native preparation and commit for drawing and study changes.

Related typesCopy Anchor Link

• ChartAutomationFamily
• ChartAutomationOwners