Viewer
    Preparing search index...

    Interface ISelectionParameterProps

    Properties of a selection parameter.

    interface ISelectionParameterProps {
        activeMode?: "default" | "activeOnStart";
        availableColor?: InteractionEffect;
        deselectOnEmpty?: boolean;
        hover?: boolean;
        hoverColor?: InteractionEffect;
        maximumSelection?: number;
        minimumSelection?: number;
        nameFilter?: string[];
        occludeBySceneGeometry?: boolean;
        prompt?: {
            activeText?: string;
            activeTitle?: string;
            inactiveTitle?: string;
        };
        selectionColor?: InteractionEffect;
    }

    Hierarchy (View Summary)

    Index

    Properties

    activeMode? availableColor? deselectOnEmpty? hover? hoverColor? maximumSelection? minimumSelection? nameFilter? occludeBySceneGeometry? prompt? selectionColor?

    Properties

    activeMode?: "default" | "activeOnStart"

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

    availableColor?: InteractionEffect

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

    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)

    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