Class ColorSelectorAbstract

ColorSelectors choose and return colors from some set list or criteria.

Hierarchy (view full)

Constructors

constructor

Accessors

colorNames name type COLOR_NAMES

Methods

getBackgroundColor getColor selectColorFromChoices addColorChoice

Constructors

Protectedconstructor

  • new ColorSelector(name, randomOrder?): ColorSelector

  • Parameters

    • name: string

      The name of the color selector.

    • OptionalrandomOrder: boolean

      A flag that determines the color selection order of selectColorFromChoices.

    Returns ColorSelector

    See

    _RANDOM_ORDER

Accessors

colorNames

  • get colorNames(): string[]

  • Returns string[]

    The names of the colors that can be or have been chosen by the color selector.

name

  • get name(): string

  • Returns string

    The name of the selector (e.g. 'blue rgb color selector').

Abstracttype

ProtectedCOLOR_NAMES

  • get COLOR_NAMES(): Set<string>

  • Returns Set<string>

    The _COLOR_NAMES set.

Methods

getBackgroundColor

  • getBackgroundColor(chanceOfBlack, chanceOfWhite, chanceOfColor): Color

  • Select and return a Color object to be used as a background. The color will either be black (#000000), white (#FFFFFF), or a color from the selector, chosen by the getColor method.
    IMPORTANT: The sum of chanceOfBlack, chanceOfWhite, and chanceOfColor should be equal to 1.0.

    Parameters

    • chanceOfBlack: number

      The percent (0-1) chance that the chosen color will be black (#000000). The sum of all percentages should be equal to 1.0.

    • chanceOfWhite: number

      The percent (0-1) chance that the chosen color will be white (#FFFFFF). The sum of all percentages should be equal to 1.0.

    • chanceOfColor: number

      The percent (0-1) chance that the chosen color will be a color from the selector (getColor). The sum of all percentages should be equal to 1.0.

    Returns Color

AbstractgetColor

  • getColor(): Color

  • Select and return a Color object.

    Returns Color

selectColorFromChoices

  • selectColorFromChoices(): Color

  • Returns Color

    The selected Color from the _COLOR_CHOICES list.
    If _COLOR_CHOICES is empty, a default Color object (black) will be returned.

ProtectedaddColorChoice

  • addColorChoice(color): void

  • Add a Color to the _COLOR_CHOICES list.

    Parameters

    Returns void

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods