For AI agents: the complete documentation index is available at /next/llms.txt, the full documentation bundle is available at /next/llms-full.txt, and this page is available as Markdown at /next/api/genui/openui/data-tools/interfaces/QueryDataTools.md.
Lynx
  • English
  • Interface: QueryDataTools

    Renderer tools and lifecycle controls for host-backed local Query data.

    Properties

    tools

    tools: Record<typeof OPENUI_DATA_TOOL_NAMES[number], (args: Record<string, unknown>) => Promise<unknown>>

    Registered local tools; spread into the renderer's toolProvider.

    Methods

    dispose()

    dispose(): void

    Reset the scope and reject pending calls; setScope can start another lifecycle. Already dispatched host work is not aborted.

    Returns

    void


    publishDefaults()

    publishDefaults(scope: string, defaults: InitialQueryResults): void

    Merge completed defaults for the current scope and initialize the host; other scopes and unchanged maps are ignored.

    Parameters

    ParameterType
    scopestring
    defaultsInitialQueryResults

    Returns

    void


    setScope()

    setScope(scope: string): void

    Select a data scope, resetting defaults and rejecting pending calls when the scope changes.

    Parameters

    ParameterType
    scopestring

    Returns

    void

    Except as otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License, and code samples are licensed under the Apache License 2.0.