Viewer
    Preparing search index...

    Interface ISelectionParameterProps

    Properties of a selection parameter.

    interface ISelectionParameterProps {
        activeMode?: "default" | "activeOnStart" | "alwaysActive";
        automaticSceneUpdate?: boolean;
        automaticSceneUpdateTimeout?: number;
        availableColor?: InteractionEffect;
        buttons?: { clear?: boolean };
        deselectOnEmpty?: boolean;
        hover?: boolean;
        hoverColor?: InteractionEffect;
        maximumSelection?: number;
        minimumSelection?: number;
        nameFilter?: string[];
        occludeBySceneGeometry?: boolean;
        presentation?: "widget" | "toolbar";
        prompt?: {
            activeText?: string;
            activeTitle?: string;
            inactiveTitle?: string;
        };
        selectionColor?: InteractionEffect;
    }

    Hierarchy (View Summary)

    Index

    Properties

    activeMode? automaticSceneUpdate? automaticSceneUpdateTimeout? availableColor? buttons? deselectOnEmpty? hover? hoverColor? maximumSelection? minimumSelection? nameFilter? occludeBySceneGeometry? presentation? prompt? selectionColor?

    Properties

    activeMode?: "default" | "activeOnStart" | "alwaysActive"

    The mode to determine when the parameter is active. (default: 'default')

    automaticSceneUpdate?: boolean

    If true, a customization is requested after handles stop changing. Waits automaticSceneUpdateTimeout after the last committed change.

    This is not session-level ISessionApi.automaticSceneUpdate, which controls whether the session scene tree node is replaced after customize.

    Used by gumball and rectangle transform (the drawing parameter has the same setting in its behavior settings). Selection and dragging ignore it. App Builder applies it only for always active tools (activeMode: "alwaysActive").

    false
    automaticSceneUpdateTimeout?: number

    Idle timeout in milliseconds before automaticSceneUpdate requests a customization. Reset on each committed handle move.

    500
    availableColor?: InteractionEffect

    The interaction effect on objects when available. (default: '#ffffff')

    buttons?: { clear?: boolean }

    Which buttons are available for the interaction parameter.

    Type Declaration

    • Optionalclear?: boolean

      When true, the clear button is available to reset the parameter. (default: true)

    deselectOnEmpty?: boolean

    If true, the selection will be cleared when clicking on an empty space. (default: false)

    hover?: boolean

    If the objects are hoverable. (default: true)

    hoverColor?: InteractionEffect

    The interaction effect on objects when hovered. (default: '#00ff78')

    maximumSelection?: number

    The maximum number of objects that can be selected. (default: 1)

    minimumSelection?: number

    The minimum number of objects that can be selected. (default: 1)

    nameFilter?: string[]

    The names of the objects that can be interacted with. (see Jira document and discussion result)

    occludeBySceneGeometry?: boolean

    When true, interactions are blocked by non-interactive solid geometry in front of the target. (default: false)

    presentation?: "widget" | "toolbar"

    The presentation of the interaction parameter. (default: 'toolbar')

    prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }

    A prompt that can be defined which is displayed instead of the default prompt.

    Type Declaration

    • OptionalactiveText?: string

      The text when the parameter is inactive.

    • OptionalactiveTitle?: string

      The title when the parameter is active.

    • OptionalinactiveTitle?: string

      The title when the parameter is inactive.

    selectionColor?: InteractionEffect

    The interaction effect on objects when selected. (default: '#0d44f0')

    Settings

    Member Visibility

    On This Page

    Properties