Skip to content

ui & resources

Check optional UI methods before calling. exportFile accepts a leaf filename and at most 16 MiB; Lite shows a save dialog, Serve starts a download, and actions/mobile do not expose it. It needs no filesystem write permission. Lite resources require workspace file read access, resolve paths from the bound file, and render up to 12 read-only panels within the Space; nested dashboards are unsupported. Dispose mounts with the View.

Usage guide: resources. API index.

Signatures, parameters and return types are generated from the SDK. Optional members are not available in every host and context.

Source

interface ResourceMount extends Disposable { /* members below */ }

Supported hosts: Lite

Reload the referenced resource.

refresh(): Promise<void>;

Returns: Promise<void>.

Related types: Disposable.

Source

Supported hosts: Lite

List available file previews or saved Eidos views for a relative path.

listViews(path: string): Promise<ResourceViewInfo[]>;
Parameter Type Required
path string Yes

Returns: Promise<ResourceViewInfo[]>.

Supported hosts: Lite

Mount a host-rendered read-only resource in a rectangular element.

mount(element: HTMLElement, source: ResourceSource): Promise<ResourceMount>;
Parameter Type Required
element HTMLElement Yes
source ResourceSource Yes

Returns: Promise<ResourceMount>.

Related types: ResourceViewInfo, ResourceSource, ResourceMount.

Source

Supported hosts: Lite

resources?: HostResources;

Supported hosts: Lite Serve Mobile

Show a host notification.

notify(message: string): Promise<void>;
Parameter Type Required
message string Yes

Returns: Promise<void>.

Supported hosts: Lite Serve

Ask the host to export generated bytes; cancellation is a result, not a failure.

exportFile?(request: FileExportRequest): Promise<FileExportResult>;
Parameter Type Required
request FileExportRequest Yes

Returns: Promise<FileExportResult>.

Supported hosts: Lite Mobile

Open an existing Space-relative file in the host.

openFile?(relativePath: string): Promise<void>;
Parameter Type Required
relativePath string Yes

Returns: Promise<void>.

Supported hosts: Lite Mobile

Navigate to this plugin’s declared page View. In Lite, omitting route reuses the same contribution’s already open main page without disposing its iframe or changing its binding. Supplying any explicit route, including an empty string, creates a new binding and remounts. A different page contribution mounts normally. Stateful pages can update through existing subscriptions.

navigate?(viewId: string, route?: string): Promise<void>;
Parameter Type Required
viewId string Yes
route string No

Returns: Promise<void>.

Related types: HostResources, FileExportRequest, FileExportResult.