Class PanelInstance

constructor

• new PanelInstance(iApi, id, config): PanelInstance

• Creates an instance of PanelInstance.

  Parameters

  • iApi: InstanceAPI
  • id: string
  • config: PanelConfig

  Returns PanelInstance

  Memberof

  PanelInstance

ReadonlyalertName

button

controls

expanded

Readonlyid

route

Readonlyscreens

style

Optionalteleport

isLeftMostPanel

• get isLeftMostPanel(): boolean

• Checks if this panel is the leftmost visible and not-teleported panel.

  Returns boolean

  Memberof

  PanelInstance

isOpen

• get isOpen(): boolean

• Checks if the panel is open or not.

  Returns boolean

  Memberof

  PanelInstance

isPinned

• get isPinned(): boolean

• Checks if this panel is pinned or not.

  Returns boolean

  Memberof

  PanelInstance

isRightMostPanel

• get isRightMostPanel(): boolean

• Checks if this panel is the rightmost visible and non-teleported panel. Note that a traditional for each loop is used due to reverse traversal of the array.

  Returns boolean

  Memberof

  PanelInstance

isVisible

• get isVisible(): boolean

• true if the panel is currently visible

  Returns boolean

  Memberof

  PanelInstance

width

• get width(): undefined | number

• Returns the width of the panel in pixels or undefined if not set.

  Returns undefined | number

  Memberof

  PanelInstance

close

• close(): this

• Close this panel. This is a proxy to InstanceAPI.panel.close(...).

  Returns this

  Memberof

  PanelInstance

expand

• expand(expand?): this

• Expands/collapses/toggles the expand state of the panel. Panels set to expand fill empty space. This is a proxy to InstanceAPI.panel.expand(...).

  Parameters

  • Optionalexpand: boolean

    Optional. Whether the panel should expand. Toggles if no value is given.

  Returns this

  Memberof

  PanelInstance

isScreenLoaded

• isScreenLoaded(id): boolean

• Checks if a given screen component id is already loaded and ready to render.

  Parameters

  • id: string

  Returns boolean

  Memberof

  PanelInstance

minimize

• minimize(): this

• Minimize this panel. This is a proxy to InstanceAPI.panel.minimize(...).

  Returns this

  Memberof

  PanelInstance

move

• move(direction): this

• Move this panel left or right in the stack. This is a proxy to InstanceAPI.panel.move(...).

  Parameters

  • direction: PanelDirection

    the direction of movement, either "left" or "right".

  Returns this

  Memberof

  PanelInstance

open

• open(value?): this

• Opens a registered panel in the panel stack. This is a proxy to InstanceAPI.panel.open(...).

  • somePanel.open() -- opens the panel on the first screen in the set
  • somePanel.open('screen-id') -- opens the panel on the 'screen-id' screen
  • somePanel.open({ screen: 'screen-id', props: {... } }) -- opens the panel on the 'screen-id' screen passing supplied props to it

  Parameters

  • Optionalvalue: string | {
        props?: object;
        screen: string;
    }

    a screen id, or an object of the form { screen: <id>, props: <object> }.

  Returns this

  Memberof

  PanelInstance

pin

• pin(value?): this

• Pin/unpin/toggle (if no value provided) pin status of this panel. When pinning, automatically unpins any previous pinned panel if exists. This is a proxy to InstanceAPI.panel.pin(...).

  Parameters

  • Optionalvalue: boolean

  Returns this

  Memberof

  PanelInstance

registerScreen

• registerScreen(id): void

• Loads and register panel screen components. This function should be called just before the screen is to be shown; this will avoid needlessly loading components upfront (sometimes certain screens might not get used at all).

  Parameters

  • id: string

  Returns void

  Memberof

  PanelInstance

remove

• remove(): this

• Remove this panel. This is a proxy to InstanceAPI.panel.remove(...).

  Returns this

  Memberof

  PanelInstance

setStyles

• setStyles(style, replace?): this

• Sets the styles of the specified panel by using a provided CSS styles object. This is a proxy to InstanceAPI.panel.setStyles(...).

  Parameters

  • style: object
  • Optionalreplace: boolean = false

  Returns this

  Memberof

  PanelInstance

show

• show(value): this

• Sets route to the specified screen id and pass props to the panel screen components. This is a proxy to InstanceAPI.panel.route(...).

  Parameters

  • value: string | PanelConfigRoute

  Returns this

  Memberof

  PanelInstance

toggle

• toggle(value?): this

• Toggle panel. This is a proxy to InstanceAPI.panel.toggle(...).

  Parameters

  • Optionalvalue: boolean | {
        props?: object;
        screen: string;
        toggle?: boolean;
    }

  Returns this

  Memberof

  PanelInstance

toggleMinimize

• toggleMinimize(value?): this

• Toggle panel's minimize state. This is a proxy to InstanceAPI.panel.toggleMinimize(...).

  Parameters

  • Optionalvalue: boolean | {
        props?: object;
        screen: string;
        toggle?: boolean;
    }

  Returns this

  Memberof

  PanelInstance