Class View

Classdesc

A View can be used to embed additional web content into a Window. It is like a child window, except it is positioned relative to its owning window. It has the ability to listen for View-specific events.

By default, a View will try to share the same renderer process as other Views owned by its parent Application. To change that behavior, see the processAffinity View~options view option.

A View's lifecycle is tied to its owning window and can be re-attached to a different window at any point during its lifecycle.

Alias

View

Hideconstructor

Hierarchy

WebContents<ViewEvent>
- View

Constructors

constructor

new View(wire: Transport<EntityType>, identity: Identity): OpenFin.View
Parameters
- wire: Transport<EntityType>
- identity: Identity
Returns OpenFin.View

Overrides WebContents<ViewEvent>.constructor

Properties

addListener

addListener: (<EventType>(eventType: EventType, listener: EventHandler<OpenFin.ViewEvents.ViewEvent, EventType>, options?: SubscriptionOptions) => Promise<OpenFin.View>) = ...

Type declaration

- <EventType>(eventType: EventType, listener: EventHandler<OpenFin.ViewEvents.ViewEvent, EventType>, options?: SubscriptionOptions): Promise<OpenFin.View>
- Type Parameters
  - EventType extends "blurred" | "certificate-selection-shown" | "crashed" | "did-change-theme-color" | "focused" | "navigation-rejected" | "url-changed" | "did-fail-load" | "did-finish-load" | "page-favicon-updated" | "page-title-updated" | "resource-load-failed" | "response-received" | "child-content-blocked" | "child-content-opened-in-browser" | "child-view-created" | "file-download-started" | "file-download-progress" | "file-download-completed" | "attached" | "created" | "destroyed" | "hidden" | "hotkey" | "shown" | "target-changed" | "found-in-page" | "certificate-error"
  Parameters
  - eventType: EventType
  - listener: EventHandler<OpenFin.ViewEvents.ViewEvent, EventType>
  - Optional options: SubscriptionOptions
  Returns Promise<OpenFin.View>

entityType

entityType: string

identity

identity: Identity

wire

wire: Transport<EntityType>

Accessors

me

get me(): Identity
Returns Identity

Inherited from WebContents.me

Methods

attach

attach(target: Identity): Promise<void>
Experimental
Attaches the current view to a the given window identity. Identity must be the identity of a window in the same application. This detaches the view from its current window, and sets the view to be destroyed when its new window closes.

Returns

Tutorial
View.attach
Parameters
- target: Identity
  
  {Identity}
Returns Promise<void>

capturePage

capturePage(options?: CapturePageOptions): Promise<string>
Parameters
- Optional options: CapturePageOptions
Returns Promise<string>

Inherited from WebContents.capturePage

destroy

destroy(): Promise<void>
Experimental
Destroys the current view

Returns

Tutorial
View.destroy

Returns Promise<void>

emit

emit<EventType>(eventType: EventType, payload: Extract<EmitterEvent, {
type: EventType;
}>, ...args: any[]): boolean
Type Parameters
- EventType extends string
Parameters
- eventType: EventType
- payload: Extract<EmitterEvent, {
  type: EventType;
  }>
- Rest ...args: any[]
Returns boolean

Inherited from WebContents.emit

eventNames

eventNames(): (string | symbol)[]
Returns (string | symbol)[]

Inherited from WebContents.eventNames

executeJavaScript

executeJavaScript(code: string): Promise<void>
Parameters
- code: string
Returns Promise<void>

Inherited from WebContents.executeJavaScript

findInPage

findInPage(searchTerm: string, options?: FindInPageOptions): Promise<void>
Parameters
- searchTerm: string
- Optional options: FindInPageOptions
Returns Promise<void>

Inherited from WebContents.findInPage

focus

focus(__namedParameters?: {
emitSynthFocused: boolean;
}): Promise<void>
Experimental
Focuses the view

Returns

Function
focus

Memberof
View

Emits
focused

Instance

Tutorial
View.focus
Parameters
- __namedParameters: {
  emitSynthFocused: boolean;
  } = ...
  - emitSynthFocused: boolean
Returns Promise<void>

Overrides WebContents.focus

getBounds

getBounds(): Promise<Bounds>
Experimental
Gets the bounds (top, left, width, height) of the view relative to its window.

Returns

Tutorial
View.getBounds

Returns Promise<Bounds>

getCurrentStack

getCurrentStack(): Promise<TabStack>
Retrieves the current TabStack of the view if it belongs to one.

Returns
The TabStack this view belongs to.

Throws
if this view does not belong to a TabStack or if the window has been destroyed.

Returns Promise<TabStack>

getCurrentWindow

getCurrentWindow(): Promise<Window>
Experimental
Retrieves the window the view is currently attached to.

Returns

Returns Promise<Window>

getInfo

getInfo(): Promise<ViewInfo>
Experimental
Gets the View's info.

Returns

Tutorial
View.getInfo

Returns Promise<ViewInfo>

getOptions

getOptions(): Promise<ViewOptions>
Experimental
Gets the View's options.

Returns

Tutorial
View.getOptions

Returns Promise<ViewOptions>

getParentLayout

getParentLayout(): Promise<OpenFin.Layout>
Experimental
Retrieves the layout for the window the view is attached to.

Returns

Tutorial
View.getParentLayout

Returns Promise<OpenFin.Layout>

getPrinters

getPrinters(): Promise<PrinterInfo>
Returns Promise<PrinterInfo>

Inherited from WebContents.getPrinters

getProcessInfo

getProcessInfo(): Promise<EntityProcessDetails>
Returns Promise<EntityProcessDetails>

Inherited from WebContents.getProcessInfo

getSharedWorkers

getSharedWorkers(): Promise<SharedWorkerInfo[]>
Returns Promise<SharedWorkerInfo[]>

Inherited from WebContents.getSharedWorkers

getZoomLevel

getZoomLevel(): Promise<number>
Returns Promise<number>

Inherited from WebContents.getZoomLevel

hide

hide(): Promise<void>
Experimental
Hides the current view if it is currently visible.

Returns

Tutorial
View.hide

Returns Promise<void>

inspectServiceWorker

inspectServiceWorker(): Promise<void>
Returns Promise<void>

Inherited from WebContents.inspectServiceWorker

inspectSharedWorker

inspectSharedWorker(): Promise<void>
Returns Promise<void>

Inherited from WebContents.inspectSharedWorker

inspectSharedWorkerById

inspectSharedWorkerById(workerId: string): Promise<void>
Parameters
- workerId: string
Returns Promise<void>

Inherited from WebContents.inspectSharedWorkerById

listenerCount

listenerCount(type: string | symbol): number
Parameters
- type: string | symbol
Returns number

Inherited from WebContents.listenerCount

listeners

listeners(type: string | symbol): Function[]
Parameters
- type: string | symbol
Returns Function[]

Inherited from WebContents.listeners

navigate

navigate(url: string): Promise<void>
Parameters
- url: string
Returns Promise<void>

Inherited from WebContents.navigate

navigateBack

navigateBack(): Promise<void>
Returns Promise<void>

Inherited from WebContents.navigateBack

navigateForward

navigateForward(): Promise<void>
Returns Promise<void>

Inherited from WebContents.navigateForward

on

on<EventType>(eventType: EventType, listener: EventHandler<OpenFin.ViewEvents.ViewEvent, EventType>, options?: SubscriptionOptions): Promise<OpenFin.View>
Type Parameters
- EventType extends "blurred" | "certificate-selection-shown" | "crashed" | "did-change-theme-color" | "focused" | "navigation-rejected" | "url-changed" | "did-fail-load" | "did-finish-load" | "page-favicon-updated" | "page-title-updated" | "resource-load-failed" | "response-received" | "child-content-blocked" | "child-content-opened-in-browser" | "child-view-created" | "file-download-started" | "file-download-progress" | "file-download-completed" | "attached" | "created" | "destroyed" | "hidden" | "hotkey" | "shown" | "target-changed" | "found-in-page" | "certificate-error"
Parameters
- eventType: EventType
- listener: EventHandler<OpenFin.ViewEvents.ViewEvent, EventType>
- Optional options: SubscriptionOptions
Returns Promise<OpenFin.View>

Inherited from WebContents.on

once

once<EventType>(eventType: EventType, listener: EventHandler<OpenFin.ViewEvents.ViewEvent, EventType>, options?: SubscriptionOptions): Promise<OpenFin.View>
Type Parameters
- EventType extends "blurred" | "certificate-selection-shown" | "crashed" | "did-change-theme-color" | "focused" | "navigation-rejected" | "url-changed" | "did-fail-load" | "did-finish-load" | "page-favicon-updated" | "page-title-updated" | "resource-load-failed" | "response-received" | "child-content-blocked" | "child-content-opened-in-browser" | "child-view-created" | "file-download-started" | "file-download-progress" | "file-download-completed" | "attached" | "created" | "destroyed" | "hidden" | "hotkey" | "shown" | "target-changed" | "found-in-page" | "certificate-error"
Parameters
- eventType: EventType
- listener: EventHandler<OpenFin.ViewEvents.ViewEvent, EventType>
- Optional options: SubscriptionOptions
Returns Promise<OpenFin.View>

Inherited from WebContents.once

prependListener

prependListener<EventType>(eventType: EventType, listener: EventHandler<OpenFin.ViewEvents.ViewEvent, EventType>, options?: SubscriptionOptions): Promise<OpenFin.View>
Type Parameters
- EventType extends "blurred" | "certificate-selection-shown" | "crashed" | "did-change-theme-color" | "focused" | "navigation-rejected" | "url-changed" | "did-fail-load" | "did-finish-load" | "page-favicon-updated" | "page-title-updated" | "resource-load-failed" | "response-received" | "child-content-blocked" | "child-content-opened-in-browser" | "child-view-created" | "file-download-started" | "file-download-progress" | "file-download-completed" | "attached" | "created" | "destroyed" | "hidden" | "hotkey" | "shown" | "target-changed" | "found-in-page" | "certificate-error"
Parameters
- eventType: EventType
- listener: EventHandler<OpenFin.ViewEvents.ViewEvent, EventType>
- Optional options: SubscriptionOptions
Returns Promise<OpenFin.View>

Inherited from WebContents.prependListener

prependOnceListener

prependOnceListener<EventType>(eventType: EventType, listener: EventHandler<OpenFin.ViewEvents.ViewEvent, EventType>, options?: SubscriptionOptions): Promise<OpenFin.View>
Type Parameters
- EventType extends "blurred" | "certificate-selection-shown" | "crashed" | "did-change-theme-color" | "focused" | "navigation-rejected" | "url-changed" | "did-fail-load" | "did-finish-load" | "page-favicon-updated" | "page-title-updated" | "resource-load-failed" | "response-received" | "child-content-blocked" | "child-content-opened-in-browser" | "child-view-created" | "file-download-started" | "file-download-progress" | "file-download-completed" | "attached" | "created" | "destroyed" | "hidden" | "hotkey" | "shown" | "target-changed" | "found-in-page" | "certificate-error"
Parameters
- eventType: EventType
- listener: EventHandler<OpenFin.ViewEvents.ViewEvent, EventType>
- Optional options: SubscriptionOptions
Returns Promise<OpenFin.View>

Inherited from WebContents.prependOnceListener

print

print(options?: PrintOptions): Promise<void>
Parameters
- options: PrintOptions = {}
Returns Promise<void>

Inherited from WebContents.print

reload

reload(ignoreCache?: boolean): Promise<void>
Parameters
- ignoreCache: boolean = false
Returns Promise<void>

Inherited from WebContents.reload

removeAllListeners

removeAllListeners(eventType?: "blurred" | "certificate-selection-shown" | "crashed" | "did-change-theme-color" | "focused" | "navigation-rejected" | "url-changed" | "did-fail-load" | "did-finish-load" | "page-favicon-updated" | "page-title-updated" | "resource-load-failed" | "response-received" | "child-content-blocked" | "child-content-opened-in-browser" | "child-view-created" | "file-download-started" | "file-download-progress" | "file-download-completed" | "attached" | "created" | "destroyed" | "hidden" | "hotkey" | "shown" | "target-changed" | "found-in-page" | "certificate-error"): Promise<OpenFin.View>
Parameters
- Optional eventType: "blurred" | "certificate-selection-shown" | "crashed" | "did-change-theme-color" | "focused" | "navigation-rejected" | "url-changed" | "did-fail-load" | "did-finish-load" | "page-favicon-updated" | "page-title-updated" | "resource-load-failed" | "response-received" | "child-content-blocked" | "child-content-opened-in-browser" | "child-view-created" | "file-download-started" | "file-download-progress" | "file-download-completed" | "attached" | "created" | "destroyed" | "hidden" | "hotkey" | "shown" | "target-changed" | "found-in-page" | "certificate-error"
Returns Promise<OpenFin.View>

Inherited from WebContents.removeAllListeners

removeListener

removeListener<EventType>(eventType: EventType, listener: EventHandler<OpenFin.ViewEvents.ViewEvent, EventType>, options?: SubscriptionOptions): Promise<OpenFin.View>
Type Parameters
- EventType extends "blurred" | "certificate-selection-shown" | "crashed" | "did-change-theme-color" | "focused" | "navigation-rejected" | "url-changed" | "did-fail-load" | "did-finish-load" | "page-favicon-updated" | "page-title-updated" | "resource-load-failed" | "response-received" | "child-content-blocked" | "child-content-opened-in-browser" | "child-view-created" | "file-download-started" | "file-download-progress" | "file-download-completed" | "attached" | "created" | "destroyed" | "hidden" | "hotkey" | "shown" | "target-changed" | "found-in-page" | "certificate-error"
Parameters
- eventType: EventType
- listener: EventHandler<OpenFin.ViewEvents.ViewEvent, EventType>
- Optional options: SubscriptionOptions
Returns Promise<OpenFin.View>

Inherited from WebContents.removeListener

setBounds

setBounds(bounds: Bounds): Promise<void>
Experimental
Sets the bounds (top, left, width, height) of the view relative to its window.

Returns

Tutorial
View.setBounds
Parameters
- bounds: Bounds
  
  {ViewBounds}
Returns Promise<void>

setZoomLevel

setZoomLevel(level: number): Promise<void>
Parameters
- level: number
Returns Promise<void>

Inherited from WebContents.setZoomLevel

show

show(): Promise<void>
Experimental
Shows the current view if it is currently hidden.

Returns

Tutorial
View.show

Returns Promise<void>

showDeveloperTools

showDeveloperTools(): Promise<void>
Returns Promise<void>

Inherited from WebContents.showDeveloperTools

showPopupWindow

showPopupWindow(options: PopupOptions): Promise<PopupResult<any>>
Parameters
- options: PopupOptions
Returns Promise<PopupResult<any>>

Inherited from WebContents.showPopupWindow

stopFindInPage

stopFindInPage(action: string): Promise<void>
Parameters
- action: string
Returns Promise<void>

Inherited from WebContents.stopFindInPage

stopNavigation

stopNavigation(): Promise<void>
Returns Promise<void>

Inherited from WebContents.stopNavigation

triggerBeforeUnload

triggerBeforeUnload(): Promise<boolean>
Experimental
Triggers the before-unload handler for the View, if one is set. Returns true if the handler is trying to prevent the View from unloading, and false if it isn't. Only enabled when setting enableBeforeUnload: true in your View options. If this option is not enabled it will always return false.

Returns

Tutorial
View.triggerBeforeUnload

Returns Promise<boolean>

updateOptions

updateOptions(options: Partial<MutableViewOptions>): Promise<void>
Experimental
Updates the view's options.

Returns

Tutorial
View.updateOptions
Parameters
- options: Partial<MutableViewOptions>
Returns Promise<void>

Class View

Classdesc

Alias

Hideconstructor

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

wire: Transport<EntityType>

identity: Identity

Returns OpenFin.View

Properties

addListener

Type declaration

Type Parameters

Parameters

eventType: EventType

listener: EventHandler<OpenFin.ViewEvents.ViewEvent, EventType>

Optional options: SubscriptionOptions

Returns Promise<OpenFin.View>

entityType

identity

wire

Accessors

me

Returns Identity

Methods

attach

Returns

Tutorial

Parameters

target: Identity

Returns Promise<void>

capturePage

Parameters

Optional options: CapturePageOptions

Returns Promise<string>

destroy

Returns

Tutorial

Returns Promise<void>

emit

Type Parameters

EventType extends string

Parameters

eventType: EventType

payload: Extract<EmitterEvent, { type: EventType; }>

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

executeJavaScript

Parameters

code: string

Returns Promise<void>

findInPage

Parameters

searchTerm: string

Optional options: FindInPageOptions

Returns Promise<void>

focus

Returns

Function

Memberof

Emits

Instance

Tutorial

Parameters

__namedParameters: { emitSynthFocused: boolean; } = ...

emitSynthFocused: boolean

Returns Promise<void>

getBounds

Returns

Tutorial

Returns Promise<Bounds>

`Optional` options: SubscriptionOptions

`Optional` options: CapturePageOptions

payload: Extract<EmitterEvent, {
type: EventType;
}>

`Rest` ...args: any[]

`Optional` options: FindInPageOptions

__namedParameters: {
emitSynthFocused: boolean;
} = ...

`Optional` options: SubscriptionOptions