eidos

Declare eidos/schema, eidos/table or eidos/config. Lite supports all three; Serve supports table. Table operations target the bound table and use field IDs. Configuration writes require write access and expectedVersion; stale versions must be reconciled. watch sends invalidation hints, without an initial value; reread after notifications. setViewConfig replaces configuration rather than merging it.

Usage guide: tables. API index.

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

EidosTable

Source

EidosTable.tableId

Supported hosts: Lite Serve Mobile

readonly tableId: string;

EidosTable.viewId

Supported hosts: Lite Serve Mobile

readonly viewId: string;

EidosTable.readContext

Supported hosts: Lite Serve Mobile

Read fields and saved-view information for the bound table.

readContext(): Promise<EidosTableSnapshot>;

Returns: Promise<EidosTableSnapshot>.

EidosTable.readRows

Supported hosts: Lite Serve Mobile

Read a page of records from the bound table.

readRows(options: {
    offset: number;
    limit: number;
}): Promise<EidosFileRowPage>;

Parameter	Type	Required
options	{ offset: number; limit: number; }	Yes

Returns: Promise<EidosFileRowPage>.

EidosTable.aggregate

Supported hosts: Lite Serve Mobile

Aggregate records using field IDs and the selected metric.

aggregate(options: TableAggregateOptions): Promise<TableAggregateResult>;

Parameter	Type	Required
options	TableAggregateOptions	Yes

Returns: Promise<TableAggregateResult>.

EidosTable.setViewConfig

Supported hosts: Lite Serve Mobile

Replace the saved view’s plugin configuration. Merge retained keys before calling.

setViewConfig(config: Record<string, unknown>): Promise<void>;

Parameter	Type	Required
config	Record<string, unknown>	Yes

Returns: Promise<void>.

EidosTable.openRecord

Supported hosts: Lite Serve Mobile

Open a record in the host.

openRecord(rowId: string): Promise<void>;

Parameter	Type	Required
rowId	string	Yes

Returns: Promise<void>.

EidosTable.watch

Supported hosts: Lite Serve Mobile

Receive invalidation hints; reread current data after a notification.

watch(listener: () => void): Disposable;

Parameter	Type	Required
listener	() => void	Yes

Returns: Disposable.

Related types: EidosTableSnapshot, TableAggregateOptions, TableAggregateResult, Disposable.

EidosCapabilities

Source

EidosCapabilities.schema

Supported hosts: Lite Mobile

readonly schema?: EidosSchema;

EidosCapabilities.table

Supported hosts: Lite Serve Mobile

readonly table?: EidosTable;

EidosCapabilities.config

Supported hosts: Lite Mobile

readonly config?: EidosConfig;

Related types: EidosSchema, EidosTable, EidosConfig.

EidosSchema

Source

EidosSchema.listTables

Supported hosts: Lite Mobile

List tables in the current Eidos file.

listTables(): Promise<Array<{
    id: string;
    name: string;
}>>;

Returns: Promise<Array<{ id: string; name: string; }>>.

EidosSchema.readTable

Supported hosts: Lite Mobile

Read the selected table’s fields within the current file.

readTable(tableId: string): Promise<{
    fields: EidosFileFieldInfo[];
}>;

Parameter	Type	Required
tableId	string	Yes

Returns: Promise<{ fields: EidosFileFieldInfo[]; }>.

EidosConfig

Source

EidosConfig.read

Supported hosts: Lite Mobile

Read this plugin’s configuration and version for a table.

read(tableId: string): Promise<EidosConfigSnapshot>;

Parameter	Type	Required
tableId	string	Yes

Returns: Promise<EidosConfigSnapshot>.

EidosConfig.write

Supported hosts: Lite Mobile

Replace configuration if expectedVersion matches; a stale version fails with STALE_REVISION.

write(tableId: string, input: {
    value: JsonObject | null;
    expectedVersion: string;
}): Promise<EidosConfigSnapshot>;

Parameter	Type	Required
tableId	string	Yes
input	{ value: JsonObject | null; expectedVersion: string; }	Yes

Returns: Promise<EidosConfigSnapshot>.

EidosConfig.watch

Supported hosts: Lite Mobile

Subscribe to invalidation hints without an initial value. Notifications may include unrelated changes.

watch(tableId: string, listener: () => void): Disposable;

Parameter	Type	Required
tableId	string	Yes
listener	() => void	Yes

Returns: Disposable.

Related types: EidosConfigSnapshot, Disposable.