Web Viewer - v0.41.0
    Preparing search index...

    Interface DatasetSchemaOptions

    Which dataset WebViewer.get_dataset_schema and WebViewer.get_dataset_assets_schema describe.

    interface DatasetSchemaOptions {
        dataset_url?: string;
        entity_path?: string;
        max_entities?: number;
        paths_only?: boolean;
    }

    Hierarchy (View Summary)

    Index
    dataset_url? entity_path? max_entities? paths_only?
    dataset_url?: string

    A dataset url from the servers of WebViewer.get_state. If omitted, the dataset on screen.

    entity_path?: string

    Only describe this entity and the entities below it, e.g. /world/robot.

    max_entities?: number

    How many entities to describe at most. Defaults to 100, or to 10000 with paths_only.

    paths_only?: boolean

    Name the entities without describing what is logged on them.

    Settings
    Member Visibility

    On This Page
    Properties