Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FolderApi

Hierarchy

  • RackLikeApi<FolderController>

Implements

  • BladeRackApi

Index

Accessors

Methods

Accessors

children

  • get children(): BladeApi<BladeController<View>>[]

  • Returns BladeApi<BladeController<View>>[]

disabled

  • get disabled(): boolean
  • set disabled(disabled: boolean): any

  • Returns boolean

  • Parameters

    • disabled: boolean

    Returns any

expanded

  • get expanded(): boolean
  • set expanded(expanded: boolean): any

  • Returns boolean

  • Parameters

    • expanded: boolean

    Returns any

hidden

  • get hidden(): boolean
  • set hidden(hidden: boolean): any

  • Returns boolean

  • Parameters

    • hidden: boolean

    Returns any

title

  • get title(): undefined | string
  • set title(title: undefined | string): any

  • Returns undefined | string

  • Parameters

    • title: undefined | string

    Returns any

Methods

add

  • add<A>(api: A, opt_index?: number): A

  • Type parameters

    Parameters

    • api: A
    • Optional opt_index: number

    Returns A

addBlade

  • Parameters

    Returns BladeApi<BladeController<View>>

addButton

  • Parameters

    Returns ButtonApi

addFolder

  • Parameters

    Returns FolderApi

addInput

  • Type parameters

    • O: Record<string, any>

    • Key: string

    Parameters

    Returns InputBindingApi<unknown, O[Key]>

addMonitor

  • Type parameters

    • O: Record<string, any>

    • Key: string

    Parameters

    Returns MonitorBindingApi<O[Key]>

addSeparator

  • Parameters

    Returns SeparatorApi

addTab

  • Parameters

    Returns TabApi

dispose

  • dispose(): void

  • Returns void

on

  • on<EventName>(eventName: EventName, handler: (ev: FolderApiEvents[EventName]["event"]) => void): FolderApi

  • Adds a global event listener. It handles all events of child inputs/monitors.

    Type parameters

    • EventName: keyof FolderApiEvents

    Parameters

    • eventName: EventName

      The event name to listen.

    • handler: (ev: FolderApiEvents[EventName]["event"]) => void
        • (ev: FolderApiEvents[EventName]["event"]): void

        • Parameters

          • ev: FolderApiEvents[EventName]["event"]

          Returns void

    Returns FolderApi

    The API object itself.

remove

  • remove(api: BladeApi<BladeController<View>>): void

  • Parameters

    Returns void

Generated using TypeDoc