Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Group

Hierarchy

Index

Constructors

Methods

  • open(): void
  • Open the group

    Returns void

  • close(): void
  • Close the group

    Returns void

  • get(name: string): Child
  • Get a group or a controller by his name

    const controller1 = group.add('someProperty', someTarget)
    const controller2 = group.get('someProperty')
    controller1 === controller2 // true

    Parameters

    • name: string

    Returns Child

  • add<Base>(property: string, target?: Object, params?: any): Base
  • Add a new controller, see documentation of each controller for more information

    const target = { property: 1 }
    group.add('property', target)

    Type parameters

    Parameters

    • property: string
    • target: Object = ...
    • params: any = {}

    Returns Base

  • color(property: string, target?: Object, parameters?: Object): ColorController
  • Delete a child controller

    const controller = group.add('someValue', target)
    group.delete(controller) // delete by
    group.delete('someValue') // or

    Parameters

    Returns void

Properties

name: string

Display name of the group

target: Object = {}

The default target object of the group (used when target parameter is not defined in group.add method)

Accessors

  • get opened(): boolean
  • set opened(value: boolean): void
  • Returns boolean

  • Parameters

    • value: boolean

    Returns void

Generated using TypeDoc