Class DisplayContext

Class representing the DisplayContext object.

Hierarchy

DisplayContext

Properties

Private io

io: Io

name

name: string

Private displayWindows

displayWindows: Map<string, DisplayWindow>

Private displayNames

displayNames: Set<string>

Private viewObjects

viewObjects: Map<string, ViewObject>

Private settings

settings: DisplayContextSettings

Private Optional displayWorkerQuitHandler

displayWorkerQuitHandler?: ((obj: QuitHandlerObj) => void)

Type declaration

- (obj: QuitHandlerObj): void
- Parameters
  - obj: QuitHandlerObj
  Returns void

Constructors

constructor

new DisplayContext(io: Io, name: string, settings: DisplayOptions): DisplayContext

- Defined in packages/io-display/src/display-context.ts:123
Creates an instance of DisplayContext.

Parameters
- io: Io
  
  CELIO object instance
- name: string
  
  Display context name
- settings: DisplayOptions
Returns DisplayContext

Methods

displayUrl

displayUrl(windowName: string, url: string, options: DisplayUrlOptions): Promise<ViewObject>

- Defined in packages/io-display/src/display-context.ts:165
Parameters
- windowName: string
- url: string
- options: DisplayUrlOptions
Returns Promise<ViewObject>

Private validQueue

validQueue(queueName: string): boolean

- Defined in packages/io-display/src/display-context.ts:220
Parameters
- queueName: string
Returns boolean

Private _clean

_clean(closedDisplay: string): void

- Defined in packages/io-display/src/display-context.ts:227
Parameters
- closedDisplay: string
Returns void

Private _postRequest

_postRequest<T>(displayName: string, data: any): Promise<T>

- Defined in packages/io-display/src/display-context.ts:253
Type Parameters
- T = any
Parameters
- displayName: string
- data: any
Returns Promise<T>

restoreFromDisplayWorkerStates

restoreFromDisplayWorkerStates(reset?: boolean): Promise<any>

- Defined in packages/io-display/src/display-context.ts:267
Parameters
- reset: boolean = false
Returns Promise<any>

Private _executeInAvailableDisplays

_executeInAvailableDisplays<T>(cmd: { command: string; options: { context: string } }): Promise<T[]>

- Defined in packages/io-display/src/display-context.ts:337
Type Parameters
- T = any
Parameters
- cmd: { command: string; options: { context: string } }
  - command: string
  - options: { context: string }
    - context: string
Returns Promise<T[]>

getWindowBounds

getWindowBounds(): Promise<DisplayContextSettings>

- Defined in packages/io-display/src/display-context.ts:375
gets a map of windowName with bounds

Returns Promise<DisplayContextSettings>
A map of windowNames with bounds

getDisplayWindow

getDisplayWindow(windowName: string): DisplayWindow

- Defined in packages/io-display/src/display-context.ts:404
gets a window object by window name

Parameters
- windowName: string
Returns DisplayWindow

getDisplayWindowNames

getDisplayWindowNames(): <internal>.IterableIterator<string>

- Defined in packages/io-display/src/display-context.ts:416
gets all window names

Returns <internal>.IterableIterator<string>
An array of window names

show

show(): Promise<DisplayResponse[]>

- Defined in packages/io-display/src/display-context.ts:424
Shows all windows of a display context

Returns Promise<DisplayResponse[]>
returns a status object

hide

hide(): Promise<any[]>

- Defined in packages/io-display/src/display-context.ts:447
hides all windows of a display context

Returns Promise<any[]>
returns a status object

close

close(): Promise<{ status: string; command: string; displayName: string }[]>

- Defined in packages/io-display/src/display-context.ts:461
closes all windows of a display context

Returns Promise<{ status: string; command: string; displayName: string }[]>
returns a status object

reloadAll

reloadAll(): Promise<ViewObjectRequestResponse[]>

- Defined in packages/io-display/src/display-context.ts:520
reloads all viewObjects of a display context

Returns Promise<ViewObjectRequestResponse[]>
returns a status object

initialize

initialize(options: DisplayContextSettings): Promise<<internal>.Record<string, InitializeReturn>>

- Defined in packages/io-display/src/display-context.ts:529
Parameters
- options: DisplayContextSettings
Returns Promise<<internal>.Record<string, InitializeReturn>>

getViewObject

getViewObject(id: string): ViewObject

- Defined in packages/io-display/src/display-context.ts:576
gets a viewObject

Parameters
- id: string
  
  an uuid of the viewobject
Returns ViewObject
returns the ViewObject instance

getViewObjects

getViewObjects(): Map<string, ViewObject>

- Defined in packages/io-display/src/display-context.ts:588
gets all viewObjects

Returns Map<string, ViewObject>
returns the collection of ViewObject instances

captureDisplayWindows

captureDisplayWindows(): Promise<any>

- Defined in packages/io-display/src/display-context.ts:596
Captures screenshot of display windows

Returns Promise<any>
returns a map of screenshot image buffer with windowNames as key and image Buffer as value

createViewObject

createViewObject(options: ViewObjectOptions, windowName?: string): Promise<ViewObject>

- Defined in packages/io-display/src/display-context.ts:618
Creates a view object

Parameters
- options: ViewObjectOptions
  
  view object options
- windowName: string = 'main'
Returns Promise<ViewObject>
returns the ViewObject instance

onClosed

onClosed(handler: ((content: ResponseContent, response: <internal>.RabbitMessage<unknown>) => void)): void

- Defined in packages/io-display/src/display-context.ts:689
DisplayContext closed event

Parameters
- handler: ((content: ResponseContent, response: <internal>.RabbitMessage<unknown>) => void)
  
  event handler
  - - (content: ResponseContent, response: <internal>.RabbitMessage<unknown>): void
    - Parameters
      - content: ResponseContent
      - response: <internal>.RabbitMessage<unknown>
      Returns void
Returns void

onActivated

onActivated(handler: ((content: ResponseContent, response: <internal>.RabbitMessage<unknown>) => void)): void

- Defined in packages/io-display/src/display-context.ts:710
DisplayContext changed event

Parameters
- handler: ((content: ResponseContent, response: <internal>.RabbitMessage<unknown>) => void)
  
  event handler
  - - (content: ResponseContent, response: <internal>.RabbitMessage<unknown>): void
    - Parameters
      - content: ResponseContent
      - response: <internal>.RabbitMessage<unknown>
      Returns void
Returns void

onDeactivated

onDeactivated(handler: ((content: ResponseContent, response: <internal>.RabbitMessage<unknown>) => void)): void

- Defined in packages/io-display/src/display-context.ts:731
DisplayContext changed event

Parameters
- handler: ((content: ResponseContent, response: <internal>.RabbitMessage<unknown>) => void)
  
  event handler
  - - (content: ResponseContent, response: <internal>.RabbitMessage<unknown>): void
    - Parameters
      - content: ResponseContent
      - response: <internal>.RabbitMessage<unknown>
      Returns void
Returns void

onDisplayWorkerQuit

onDisplayWorkerQuit(handler: ((obj: QuitHandlerObj) => void)): void

- Defined in packages/io-display/src/display-context.ts:752
DisplayWorkerQuit Event

Parameters
- handler: ((obj: QuitHandlerObj) => void)
  - - (obj: QuitHandlerObj): void
    - Parameters
      - obj: QuitHandlerObj
      Returns void
Returns void

Generated using TypeDoc