Vertex Viewer SDK
    Preparing search index...

    Interface VertexSceneTree

    interface VertexSceneTree {
        config?: string | Config;
        configEnv?: Environment;
        controller?: SceneTreeController;
        metadataKeys?: string[];
        metadataSearchExactMatch?: boolean;
        metadataSearchKeys?: string[];
        onConnectionError?: (
            event: VertexSceneTreeCustomEvent<SceneTreeErrorDetails>,
        ) => void;
        onFirstRowRendered?: (event: VertexSceneTreeCustomEvent<void>) => void;
        operationAnimationDuration?: number;
        overScanCount?: number;
        rowData?: RowDataProvider;
        searchOptions?: FilterOptions;
        viewer?: HTMLVertexViewerElement | null;
        viewerSelector?: string;
    }
    Index
    config? configEnv? controller? metadataKeys? metadataSearchExactMatch? metadataSearchKeys? onConnectionError? onFirstRowRendered? operationAnimationDuration? overScanCount? rowData? searchOptions? viewer? viewerSelector?
    config?: string | Config

    An object to configure the scene tree.

    configEnv?: Environment

    Sets the default environment for the viewer. This setting is used for auto-configuring network hosts.

    Use the config property for manually setting hosts.

    'platprod'
    controller?: SceneTreeController
    metadataKeys?: string[]

    A list of part metadata keys that will be made available to each row. This metadata can be used for data binding inside the scene tree's template.

    Note: for the values of these metadata keys to be evaluated for search, they must be provided to the metadataSearchKeys specified in the searchOptions. Otherwise, the search will only be performed against the item name.

    []
    metadataSearchExactMatch?: boolean

    Use searchOptions Indicates whether the metadata search should use an exact match.

    false
    metadataSearchKeys?: string[]

    Use searchOptions A list of the metadata keys that a scene tree search should be performed on.

    []
    onConnectionError?: (
        event: VertexSceneTreeCustomEvent<SceneTreeErrorDetails>,
    ) => void

    An event that is emitted when this encounters a connection error.

    onFirstRowRendered?: (event: VertexSceneTreeCustomEvent<void>) => void

    An event that is emitted when the first row of this has been rendered.

    operationAnimationDuration?: number

    The duration of operations with animations, in milliseconds, when a user performs an action that results in an animation such as isolate. Defaults to 500ms.

    500
    overScanCount?: number

    The number of offscreen rows above and below the viewport to render. Having a higher number reduces the chance of the browser not displaying a row while scrolling.

    25
    rowData?: RowDataProvider

    A callback that is invoked immediately before a row is about to be rendered. This callback can return additional data that can be bound to in a template.

    <script>
      const table = document.querySelector('vertex-scene-tree-table');
      table.rowData = (row) => {
        return { func: () => console.log('row', row.node.name) };
      };
    </script>
    <vertex-scene-tree>
      <vertex-scene-tree-table>
        <vertex-scene-tree-table-column>
          <template> <button event:click="{{row.data.func}}">Hi</button> </template>
        </vertex-scene-tree-table-column>
      </vertex-scene-tree-table>
    </vertex-scene-tree>
    searchOptions?: FilterOptions

    A set of options to configure scene tree searching behavior.

    {}
    viewer?: HTMLVertexViewerElement | null

    An instance of a <vertex-viewer> element. Either this property or viewerSelector must be set.

    viewerSelector?: string

    A CSS selector that points to a <vertex-viewer> element. Either this property or viewer must be set.

    Settings
    Member Visibility

    On This Page
    Properties