ViewObject | Documentation

Class representing the ViewObject

Hierarchy

ViewObject

Properties

Private io

io: Io

viewId

viewId: string

displayName

displayName: string

Private window

window: DisplayWindow

windowName

windowName: string

Private displayContextName

displayContextName: string

Constructors

constructor

new ViewObject(io: Io, window: DisplayWindow, options: { viewId: string; displayName: string; displayContextName: string; windowName: string }): ViewObject

- Defined in packages/io-display/src/view-object.ts:85
Parameters
- io: Io
- window: DisplayWindow
- options: { viewId: string; displayName: string; displayContextName: string; windowName: string }
  - viewId: string
  - displayName: string
  - displayContextName: string
  - windowName: string
Returns ViewObject

Methods

Private _postRequest

_postRequest<T>(data: { command: string; options: { viewId: string } }): Promise<T>

- Defined in packages/io-display/src/view-object.ts:106
Type Parameters
- T = any
Parameters
- data: { command: string; options: { viewId: string } }
  - command: string
  - options: { viewId: string }
    - [key: string]: unknown
    - viewId: string
Returns Promise<T>

setUrl

setUrl(url: string): Promise<object>

- Defined in packages/io-display/src/view-object.ts:125
Sets the url of the view object

Parameters
- url: string
Returns Promise<object>

getUrl

getUrl(): Promise<object>

- Defined in packages/io-display/src/view-object.ts:140
gets the current url of the view object

Returns Promise<object>

setCSSStyle

setCSSStyle(cssText: string): Promise<object>

- Defined in packages/io-display/src/view-object.ts:154
sets the css style string

Parameters
- cssText: string
Returns Promise<object>

enableDeviceEmulation

enableDeviceEmulation(options: DeviceEmulationOptions): Promise<object>

- Defined in packages/io-display/src/view-object.ts:170
enables device emulation

Parameters
- options: DeviceEmulationOptions
  
  http://electron.atom.io/docs/api/web-contents/#contentsenabledeviceemulationparameters
Returns Promise<object>

disableDeviceEmulation

disableDeviceEmulation(): Promise<object>

- Defined in packages/io-display/src/view-object.ts:185
disables device emulation

Returns Promise<object>

reload

reload(): Promise<ViewObjectRequestResponse>

- Defined in packages/io-display/src/view-object.ts:199
reloads the view object

Returns Promise<ViewObjectRequestResponse>

hide

hide(): Promise<object>

- Defined in packages/io-display/src/view-object.ts:213
hides the view object

Returns Promise<object>

show

show(): Promise<object>

- Defined in packages/io-display/src/view-object.ts:227
shows the view object

Returns Promise<object>

close

close(): Promise<object>

- Defined in packages/io-display/src/view-object.ts:241
closes the view object

Returns Promise<object>

setBounds

setBounds(options: { gridLeft?: number; gridTop?: number; left?: number; top?: number; widthFactor?: number; width?: number; heightFactor?: number; height?: number }): Promise<object>

- Defined in packages/io-display/src/view-object.ts:256
setBounds the view object

Parameters
- options: { gridLeft?: number; gridTop?: number; left?: number; top?: number; widthFactor?: number; width?: number; heightFactor?: number; height?: number }
  - Optional gridLeft?: number
  - Optional gridTop?: number
  - Optional left?: number
  - Optional top?: number
  - Optional widthFactor?: number
  - Optional width?: number
  - Optional heightFactor?: number
  - Optional height?: number
Returns Promise<object>

getBounds

getBounds(): Promise<object>

- Defined in packages/io-display/src/view-object.ts:308
gets the bounds of the view object

Returns Promise<object>

goBack

goBack(): Promise<object>

- Defined in packages/io-display/src/view-object.ts:322
navigates back if available

Returns Promise<object>

goForward

goForward(): Promise<object>

- Defined in packages/io-display/src/view-object.ts:336
navigates forward if available

Returns Promise<object>

openDevTools

openDevTools(): Promise<object>

- Defined in packages/io-display/src/view-object.ts:350
opens debug console

Returns Promise<object>

closeDevTools

closeDevTools(): Promise<object>

- Defined in packages/io-display/src/view-object.ts:365
closes debug console

Returns Promise<object>

setAudioMuted

setAudioMuted(mute: boolean): Promise<object>

- Defined in packages/io-display/src/view-object.ts:381
sets audio muted

Parameters
- mute: boolean
Returns Promise<object>

isAudioMuted

isAudioMuted(): Promise<object>

- Defined in packages/io-display/src/view-object.ts:396
gets if audio muted

Returns Promise<object>

Private _on

_on(topic: string, handler: ((response: <internal>.RabbitMessage<unknown>) => void)): void

- Defined in packages/io-display/src/view-object.ts:406
Parameters
- topic: string
- handler: ((response: <internal>.RabbitMessage<unknown>) => void)
  - - (response: <internal>.RabbitMessage<unknown>): void
    - Parameters
      - response: <internal>.RabbitMessage<unknown>
      Returns void
Returns void

onHidden

onHidden(handler: ((response: <internal>.RabbitMessage<unknown>) => void)): void

- Defined in packages/io-display/src/view-object.ts:431
viewObject hidden event

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

onShown

onShown(handler: ((response: <internal>.RabbitMessage<unknown>) => void)): void

- Defined in packages/io-display/src/view-object.ts:442
viewObject became visible event

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

onClosed

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

- Defined in packages/io-display/src/view-object.ts:453
viewObject closed event

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

onBoundsChanged

onBoundsChanged(handler: ((response: <internal>.RabbitMessage<unknown>) => void)): void

- Defined in packages/io-display/src/view-object.ts:464
viewObject bounds changed event

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

onUrlChanged

onUrlChanged(handler: ((response: <internal>.RabbitMessage<unknown>) => void)): void

- Defined in packages/io-display/src/view-object.ts:475
viewObject URL changed event

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

onUrlReloaded

onUrlReloaded(handler: ((response: <internal>.RabbitMessage<unknown>) => void)): void

- Defined in packages/io-display/src/view-object.ts:486
viewObject URL reloaded event

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

onCrashed

onCrashed(handler: ((response: <internal>.RabbitMessage<unknown>) => void)): void

- Defined in packages/io-display/src/view-object.ts:497
viewObject crashed event

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

onGPUCrashed

onGPUCrashed(handler: ((response: <internal>.RabbitMessage<unknown>) => void)): void

- Defined in packages/io-display/src/view-object.ts:508
viewObject GPU crashed event

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

onPluginCrashed

onPluginCrashed(handler: ((response: <internal>.RabbitMessage<unknown>) => void)): void

- Defined in packages/io-display/src/view-object.ts:519
viewObject plugin crashed event

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

Hierarchy

Index

Properties

Constructors

Methods

Properties

Private io

viewId

displayName

Private window

windowName

Private displayContextName

Constructors

constructor

Parameters

io: Io

window: DisplayWindow

options: { viewId: string; displayName: string; displayContextName: string; windowName: string }

viewId: string

displayName: string

displayContextName: string

windowName: string

Returns ViewObject

Methods

Private _postRequest

Type Parameters

T = any

Parameters

data: { command: string; options: { viewId: string } }

command: string

options: { viewId: string }

[key: string]: unknown

viewId: string

Returns Promise<T>

setUrl

Parameters

url: string

Returns Promise<object>

getUrl

Returns Promise<object>

setCSSStyle

Parameters

cssText: string

Returns Promise<object>

enableDeviceEmulation

Parameters

options: DeviceEmulationOptions

Returns Promise<object>

disableDeviceEmulation

Returns Promise<object>

reload

Returns Promise<ViewObjectRequestResponse>

hide

Returns Promise<object>

show

Returns Promise<object>

close

Returns Promise<object>

setBounds

Parameters

options: { gridLeft?: number; gridTop?: number; left?: number; top?: number; widthFactor?: number; width?: number; heightFactor?: number; height?: number }

Optional gridLeft?: number

Optional gridTop?: number

Optional left?: number

Optional top?: number

Optional widthFactor?: number

Optional width?: number

Optional heightFactor?: number

Optional height?: number

Returns Promise<object>

getBounds

Returns Promise<object>

goBack

Returns Promise<object>

goForward

Returns Promise<object>

openDevTools

Returns Promise<object>

closeDevTools

Returns Promise<object>