Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ISelectionParameterProps

Properties of a selection parameter.

Hierarchy

Index

Properties

Properties

Optional hover

hover?: boolean

If the objects are hoverable. (default: true)

Optional hoverColor

hoverColor?: string

The color of the objects when hovered. (default: '#00ff78')

Optional maximumSelection

maximumSelection?: number

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

Optional minimumSelection

minimumSelection?: number

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

Optional nameFilter

nameFilter?: string[]

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

Optional prompt

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

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

Type declaration

  • Optional activeText?: string

    The text when the parameter is inactive.

  • Optional activeTitle?: string

    The title when the parameter is active.

  • Optional inactiveTitle?: string

    The title when the parameter is inactive.

Optional selectionColor

selectionColor?: string

The color of the objects when selected. (default: '#0d44f0')