Vertex Viewer SDK
    Preparing search index...

    Interface VertexSceneTreeSearch

    interface VertexSceneTreeSearch {
        controller?: SceneTreeController;
        debounce?: number;
        disabled?: boolean;
        onSearch?: (event: VertexSceneTreeSearchCustomEvent<string>) => void;
        onSearchCompleted?: (
            event: VertexSceneTreeSearchCustomEvent<string>,
        ) => void;
        placeholder?: string;
        value?: string;
    }
    Index
    controller? debounce? disabled? onSearch? onSearchCompleted? placeholder? value?
    controller?: SceneTreeController

    The scene tree controller

    debounce?: number

    Specifies the delay, in milliseconds, to emit search events after user input.

    If this value is specified, searches will automatically occur after a keystroke has occurred and the debounce threshold has elapsed.

    Defaults to undefined, and searches only occur on an Enter press or a blur event.

    disabled?: boolean

    If true, disables user interaction of the component.

    false
    onSearch?: (event: VertexSceneTreeSearchCustomEvent<string>) => void

    An event that is emitted when a user has changed or cleared the search term. The event may be delayed according to the current debounce value.

    onSearchCompleted?: (event: VertexSceneTreeSearchCustomEvent<string>) => void

    An event that is emitted when a search has completed.

    placeholder?: string

    Placeholder text if value is empty.

    undefined
    value?: string

    The current text value of the component. Value is updated on user interaction.

    ''

    Settings
    Member Visibility

    On This Page
    Properties