Class DataTablePrefRef

Wrapper around a data table created from a gadget preference value.

Automatically configures filter and sort settings from the preference, and provides a getFilteredRows() convenience method that applies them.

const cfg = client.createDataTableFromPref(prefs.getString('rdDataTable'));

// Fetch rows with auto-wired filter + sort from the preference
const result = await cfg.getFilteredRows();

// Access the underlying DataTableRef for schema, events, etc.
cfg.dataTable.on('rowUpdated', (change) => console.log(change));

// Cleanup
cfg.dispose();

Constructors

constructor

Properties

dataTable pref

Methods

dispose getFilteredRows

Constructors

constructor

  • new DataTablePrefRef(prefValue, options?): DataTablePrefRef

  • Creates a new DataTablePrefRef from a gadget preference JSON string.

    Parameters

    • prefValue: string

      The raw gadget preference string (JSON)

    • Optionaloptions: IDataTableOptions

      Optional configuration overrides

    Returns DataTablePrefRef

    Throws

    Error if the global datatable library is not loaded

Properties

ReadonlydataTable

dataTable: DataTableRef

The underlying DataTableRef with full access to schema, events, polling, etc.

Readonlypref

pref: IDataTablePref

The parsed preference object.

Methods

dispose

  • dispose(): void

  • Releases all resources held by the underlying DataTableRef.

    Returns void

getFilteredRows

  • getFilteredRows(params?): Promise<IDataTableResult>

  • Fetches rows with the filter and sort settings from the preference automatically applied. Additional query parameters can override or supplement the preference settings.

    Parameters

    Returns Promise<IDataTableResult>

    Promise resolving to the result set

    // Use preference defaults
    const result = await cfg.getFilteredRows();

    // Override page size
    const page = await cfg.getFilteredRows({ pageSize: 10 });

Settings

Member Visibility

On This Page

Constructors
Properties
Methods