Class PanelAPI

A base class for anything requiring access to the InstanceApi and instance of Vue app controlled by it.

Export

Hierarchy

APIScope
- PanelAPI

Index

Constructors

constructor

new PanelAPI(iApi): PanelAPI
Creates an instance of APIScope.
Parameters
- iApi: InstanceAPI
Returns PanelAPI

Memberof
APIScope
Inherited from APIScope.constructor
- Defined in src/api/common.ts:41

Properties

`Readonly` $iApi

$iApi: InstanceAPI

The instance of RampMap API scoped to a single Vue R4MP application.

Memberof

APIScope

panelStore

Accessors

$element

get $element(): App<Element>
Returns App<Element>
Inherited from APIScope.$element
- Defined in src/api/common.ts:31

$vApp

get $vApp(): ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>
The instance of Vue R4MP application controlled by this InstanceAPI. This is just a shorthand for this.$iApi.$vApp.

Returns ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>

Memberof
APIScope
Inherited from APIScope.$vApp
- Defined in src/api/common.ts:27

opened

get opened(): PanelInstance[]
Returns an array of open PanelInstance objects.

Returns PanelInstance[]

Memberof
PanelAPI
- Defined in src/api/panel.ts:214

pinned

get pinned(): undefined | PanelInstance
Returns the currently pinned panel instance, if exists.

Returns undefined | PanelInstance

Memberof
PanelAPI
- Defined in src/api/panel.ts:434

visible

get visible(): PanelInstance[]
Returns an array of visible PanelInstance object. This is not every open panel, only the ones currently visible to the user.

Returns PanelInstance[]

Memberof
PanelAPI
- Defined in src/api/panel.ts:227

Methods

close

close(value): undefined | PanelInstance
Closes the panel specified.
Parameters
- value: string | PanelInstance
Returns undefined | PanelInstance
the panel instance if the panel is currently registered, undefined otherwise.

Memberof
PanelAPI
- Defined in src/api/panel.ts:239

expand

expand(value, expand?): undefined | PanelInstance
Expands/collapses the expand state of the panel. Toggles whether the panel expands if no expand value is given.
Parameters
- value: string | PanelInstance
- Optional expand: boolean
  
  Optional. Whether the panel should expand, toggles the value if not set
Returns undefined | PanelInstance
the panel instance if the panel is currently registered, undefined otherwise.

Memberof
PanelAPI
- Defined in src/api/panel.ts:537

get

get(value): PanelInstance
Finds and returns a panel with the id specified.
Parameters
- value: string | PanelInstance
Returns PanelInstance

Memberof
PanelAPI
- Defined in src/api/panel.ts:135

isRegistered

isRegistered(panelId): Promise<any>
Provides a promise that resolves when the panel(s) have finished registration.
Parameters
- panelId: string | string[]
  
  the panel ID(s) for which the promise is requested
Returns Promise<any>

Memberof
PanelAPI
- Defined in src/api/panel.ts:91

minimize

minimize(value): undefined | PanelInstance
Minimizes the panel specified, mechanically the same as closing however it does not emit the close event so that temporary appbar buttons stay.
Parameters
- value: string | PanelInstance
Returns undefined | PanelInstance
the panel instance if the panel is currently registered, undefined otherwise.

Memberof
PanelAPI
- Defined in src/api/panel.ts:272

move

move(value, direction): undefined | PanelInstance
Moves the specifed visible panel to the left or right.
Parameters
- value: string | PanelInstance
- direction: PanelDirection
  
  the direction of movement, either "left" or "right".
Returns undefined | PanelInstance
the panel instance if the panel is currently registered, undefined otherwise.

Memberof
PanelAPI
- Defined in src/api/panel.ts:306

open

open(value): undefined | PanelInstance
Opens a registered panel in the panel stack.
- rInstance.panel.open('panel-id') -- opens the 'panel-id' panel on the first screen in the set
- rInstance.panel.open(<PanelInstance>) -- opens the provided PanelInstance object on the first screen in the set
- rInstance.panel.open({ id: 'panel-id', screen: 'screen-id' }) -- opens the 'panel-id' panel on the 'screen-id' screen
- rInstance.panel.open({ id: 'panel-id', screen: 'screen-id', props: {... } }) -- opens the 'panel-id' panel on the 'screen-id' screen passing supplied props to it
Parameters
- value: string | PanelInstance | PanelInstancePath
  
  a panel id, a PanelInstance object or an object of the form { id: <panel-id>, screen: <id>, props: <object> }.
Returns undefined | PanelInstance
the panel instance if the panel is currently registered, undefined otherwise.

Memberof
PanelAPI
- Defined in src/api/panel.ts:152

pin(value, pin?): undefined | PanelInstance
Pin/unpin/toggle (if no value provided) pin status of the provided panel. When pinning, automatically unpins any previous pinned panel if exists.
Parameters
- value: string | PanelInstance
- Optional pin: boolean
Returns undefined | PanelInstance
the panel instance if the panel is currently registered, undefined otherwise.

Memberof
PanelAPI
- Defined in src/api/panel.ts:399

register

register(value, options?): PanelInstance
Registers a provided panel object and returns the resulting PanelInstance objects. When the panel is registered, all its screens are added to the Vue as components right away.
Parameters
- value: PanelConfigPair
  
  a PanelConfig/id pair in the form of { id: string, config: PanelConfig }
- Optional options: PanelRegistrationOptions
Returns PanelInstance

Memberof
PanelAPI
- Defined in src/api/panel.ts:20
register(value, options?): PanelInstanceSet
Registers a set of provided panel objects and returns the resulting PanelInstance object set. When the panel is registered, all its screens are added to the Vue as components right away.
Parameters
- value: PanelConfigSet
  
  a set of PanelConfig objects in the form of { [name: string]: PanelConfig } where keys assumed to be ids
- Optional options: PanelRegistrationOptions
  
  a set of options that will apply to all the panel in the set
Returns PanelInstanceSet

Memberof
PanelAPI
- Defined in src/api/panel.ts:33

remove

remove(value): void
Removes a panel instance
Parameters
- value: string | PanelInstance
Returns void

Memberof
PanelAPI
- Defined in src/api/panel.ts:111

setStyle

setStyle(value, style, replace?): undefined | PanelInstance
Sets the styles of the specified panel by using a provided CSS styles object.
Parameters
- value: string | PanelInstance
- style: object
- Optional replace: boolean = false
  
  merge with existing styles if false; replace if true
Returns undefined | PanelInstance
the panel instance if the panel is currently registered, undefined otherwise.

Memberof
PanelAPI
- Defined in src/api/panel.ts:510

show

show(value, route): undefined | PanelInstance
Sets route to the specified screen id and pass props to the panel screen components.
Parameters
- value: string | PanelInstance
- route: PanelConfigRoute
Returns undefined | PanelInstance
the panel instance if the panel is currently registered and the specified screen exists, undefined otherwise.

Memberof
PanelAPI
- Defined in src/api/panel.ts:448

toggle

toggle(value?, toggle?): undefined | PanelInstance
Toggle panel.
Parameters
- Optional value: string | PanelInstance | PanelInstancePath
- Optional toggle: boolean
  
  Optional param. True forces a panel open, false forces the panel to close.
Returns undefined | PanelInstance
the panel instance if the panel is currently registered, undefined otherwise.

Memberof
PanelAPI
- Defined in src/api/panel.ts:329

toggleMinimize

toggleMinimize(value?, toggle?): undefined | PanelInstance
Toggle panel's minimized state
Parameters
- Optional value: string | PanelInstance | PanelInstancePath
- Optional toggle: boolean
  
  Optional param. True forces a panel open, false forces the panel to minimize.
Returns undefined | PanelInstance
the panel instance if the panel is currently registered, undefined otherwise.

Memberof
PanelAPI
- Defined in src/api/panel.ts:364

Class PanelAPI

Export

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

iApi: InstanceAPI

Returns PanelAPI

Memberof

Properties

Readonly $iApi

Memberof

panelStore

Accessors

$element

Returns App<Element>

$vApp

Returns ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>

Memberof

opened

Returns PanelInstance[]

Memberof

pinned

Returns undefined | PanelInstance

Memberof

visible

Returns PanelInstance[]

Memberof

Methods

close

Parameters

value: string | PanelInstance

Returns undefined | PanelInstance

Memberof

expand

Parameters

value: string | PanelInstance

Optional expand: boolean

Returns undefined | PanelInstance

Memberof

get

Parameters

value: string | PanelInstance

Returns PanelInstance

Memberof

isRegistered

Parameters

panelId: string | string[]

Returns Promise<any>

Memberof

minimize

Parameters

value: string | PanelInstance

Returns undefined | PanelInstance

Memberof

move

Parameters

value: string | PanelInstance

direction: PanelDirection

Returns undefined | PanelInstance

Memberof

open

Parameters

value: string | PanelInstance | PanelInstancePath

Returns undefined | PanelInstance

Memberof

pin

Parameters

value: string | PanelInstance

Optional pin: boolean

Returns undefined | PanelInstance

Memberof

register

Parameters

value: PanelConfigPair

`Readonly` $iApi

`Optional` expand: boolean

`Optional` pin: boolean

`Optional` options: PanelRegistrationOptions

`Optional` options: PanelRegistrationOptions

`Optional` replace: boolean = false

`Optional` value: string | PanelInstance | PanelInstancePath

`Optional` toggle: boolean

`Optional` value: string | PanelInstance | PanelInstancePath

`Optional` toggle: boolean