Options
All
  • Public
  • Public/Protected
  • All
Menu

A slider with a label on each side.

Settings

  • @member labelStart Text at the beginning of the slider.
  • @member labelEnd Text at the end of the slider.

Controls

  • @member sliderValue The slider's position.

Hierarchy

Implements

Index

Constructors

constructor

  • Parameters

    • Optional name: string

      The displayed name of this module.

    • Optional playerRole: PlayerRoleFlag

      Indicates which user is able to see this module.

    Returns Slider1DModel

Properties

Readonly id

id: string

Unique Id of this module.

labelEnd

labelEnd: string = ''

Text at the end of the slider.

labelStart

labelStart: string = ''

Text at the beginning of the slider.

name

name: string

The displayed name of also meant for displaying.

playerRole

playerRole: PlayerRoleFlag

Indicates which user is able to see this module.

sliderValue

sliderValue: AggregatorValue<number> = ...

The slider's position

Readonly type

Indicates which type of module this is.

Accessors

aggregatorValues

  • Returns undefined | AggregatorValue<number>[]

Methods

init

  • Forces inherited child classes to identify themself with the type of modul they are.

    Returns ModuleEnum

    The module enum that belongs to this type of module.

setLabelEnd

  • Builder function to set the text at the end of this slider.

    Parameters

    • labelEnd: string

      The new text at the end of this slider.

    Returns Slider1DModel

    A copy of the object with updated settings.

setLabelStart

  • Builder function to set the text at the beginning of this slider.

    Parameters

    • labelStart: string

      The new text at the beginning of this slider.

    Returns Slider1DModel

    A copy of the object with updated settings.

setSliderValue

  • Builder function to set the initial position or value of the slider.

    Parameters

    • sliderValue: number

      The initial position or value of the slider.

    Returns Slider1DModel

    A copy of the object with updated settings.

updateModule

  • Updates a module with new settings.

    Parameters

    • newModule: ModuleModel

      A module that holds the new settings.

    Returns void

updateMyself

Generated using TypeDoc