Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ColourModule

Hierarchy

Indexable

[K: string]: any

Index

Constructors

constructor

Properties

methods

methods: IMethodTree

Protected output

output: Output

Accessors

Static id

id:

Methods

HEXtoRGBComponents

  • HEXtoRGBComponents(hex: string): object
  • Parameters

    • hex: string

    Returns object

HSVtoRGB

  • HSVtoRGB(h: number, s: number, v: number): object
  • Parameters

    • h: number
    • s: number
    • v: number

    Returns object

RGBtoHEX

  • RGBtoHEX(r: number, g: number, b: number): string
  • Parameters

    • r: number
    • g: number
    • b: number

    Returns string

_create

  • _create(type: "rgb" | "hsv", one: number, two: number, three: number): undefined | string
  • Parameters

    • type: "rgb" | "hsv"
    • one: number
    • two: number
    • three: number

    Returns undefined | string

_lerp

  • _lerp(from: string, to: string, percentage: number): string
  • Parameters

    • from: string
    • to: string
    • percentage: number

    Returns string

_luminance

  • _luminance(hex: string, lum?: number): string
  • Parameters

    • hex: string
    • Default value lum: number = 0

    Returns string

_random

  • _random(): string
  • Returns string

addLifecycleStep

  • addLifecycleStep(name: string, cbName: string): void
  • Parameters

    • name: string
    • cbName: string

    Returns void

addMethod

  • addMethod(name: string, cbName: Function | string): void
  • Parameters

    • name: string
    • cbName: Function | string

    Returns void

addModule

  • addModule(name: string): SubModule
  • Parameters

    • name: string

    Returns SubModule

executeLifecycleStep

  • executeLifecycleStep(name: string): void

getSymbols

  • getSymbols(): string[]
  • Returns string[]

instrumentize

  • instrumentize(fullPath: string, method: string): Instrument

Static transformLegacy

  • transformLegacy(app: any): void
  • Parameters

    • app: any

    Returns void

Generated using TypeDoc