Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SliderGroup

Class used to create a SliderGroup which contains groups of slider buttons

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Creates a new SelectorGroup

    Parameters

    • name: string

      of group, used as a group heading

    Returns SliderGroup

Properties

nameSearch playground for name

name: string

name of SelectorGroup

Accessors

groupPanel

header

  • get header(): string
  • set header(label: string): any
  • Gets and sets the group header

    Returns string

  • Gets and sets the group header

    Parameters

    • label: string

    Returns any

selectors

Methods

addSliderSearch playground for addSlider

  • addSlider(label: string, func?: (v: number) => void, unit?: string, min?: number, max?: number, value?: number, onValueChange?: (v: number) => number): void
  • Adds a slider to the SelectorGroup

    Parameters

    • label: string

      is the label for the SliderBar

    • Optional func: (v: number) => void

      is the function called when the Slider moves

        • (v: number): void
        • Parameters

          • v: number

          Returns void

    • Optional unit: string

      is a string describing the units used, eg degrees or metres

    • Optional min: number

      is the minimum value for the Slider

    • Optional max: number

      is the maximum value for the Slider

    • Optional value: number

      is the start value for the Slider between min and max

    • Optional onValueChange: (v: number) => number

      is the function used to format the value displayed, eg radians to degrees

        • (v: number): number
        • Parameters

          • v: number

          Returns number

    Returns void

removeSelectorSearch playground for removeSelector

  • removeSelector(selectorNb: number): void
  • Removes the selector at the given position

    Parameters

    • selectorNb: number

      the position of the selector within the group

    Returns void

Legend

  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Static property
  • Static method