AboutSupportDeveloper GuideVersion 41.133.100.79

Interface UpdatableViewOptions

View options that can be updated after creation.

interface UpdatableViewOptions {
    api?: ApiSettings;
    autoResize?: AutoResizeOptions;
    backgroundColor?: string;
    chromiumPolicies?: ChromiumPolicies;
    contentNavigation?: NavigationRules;
    contentRedirect?: NavigationRules;
    contextMenu?: boolean;
    contextMenuOptions?: ContextMenuOptions;
    contextMenuSettings?: ContextMenuSettings;
    customContext?: any;
    customData?: any;
    detachOnClose?: boolean;
    interop?: InteropConfig;
    isClosable?: boolean;
    preventDragOut?: boolean;
    throttling?: ViewThrottling;
}

Properties

api? autoResize? backgroundColor? chromiumPolicies? contentNavigation? contentRedirect? contextMenu? contextMenuOptions? contextMenuSettings? customContext? customData? detachOnClose? interop? isClosable? preventDragOut? throttling?

Properties

Optionalapi

api?: ApiSettings

Configurations for API injection.

OptionalautoResize

autoResize?: AutoResizeOptions

OptionalbackgroundColor

backgroundColor?: string

The view’s backfill color as a hexadecimal value. Not to be confused with the content background color (document.body.style.backgroundColor), this color briefly fills a view’s (a) content area before its content is loaded as well as (b) newly exposed areas when growing a view. Setting this value to the anticipated content background color can help improve user experience. Default is white.

OptionalchromiumPolicies

chromiumPolicies?: ChromiumPolicies

Control behavior for Chromium policies

OptionalcontentNavigation

contentNavigation?: NavigationRules

Restrict navigation to URLs that match an allowed pattern. In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited. See here for more details.

OptionalcontentRedirect

contentRedirect?: NavigationRules

OptionalcontextMenu

contextMenu?: boolean

Deprecated

Superseded by contextMenuOptions, which offers a larger feature-set and cleaner syntax.

Default Value

true

Show the context menu when right-clicking on the view.
Gives access to the devtools for the view.

OptionalcontextMenuOptions

contextMenuOptions?: ContextMenuOptions

Configure the context menu when right-clicking on a window.

OptionalcontextMenuSettings

contextMenuSettings?: ContextMenuSettings

Deprecated

Superseded by contextMenuOptions, which offers a larger feature-set and cleaner syntax.

Configure the context menu when right-clicking on a window.

OptionalcustomContext

customContext?: any

A field that the user can use to attach serializable data that will be saved when Platform.getSnapshot is called. If a window in a Platform is trying to update or retrieve its own context, it can use the Platform.setWindowContext and Platform.getWindowContext calls. When omitted, inherits from the parent application. As opposed to customData, this is meant for frequent updates and sharing with other contexts. For usage example, see customContext Example.

OptionalcustomData

customData?: any

A field that the user can attach serializable data to be ferried around with the window options. When omitted, inherits from the parent application.

OptionaldetachOnClose

detachOnClose?: boolean

Default Value

false

Deprecated

Platforms Only. If true, will hide and detach the View from the window for later use instead of closing, allowing the state of the View to be saved and the View to be immediately shown in a new Layout.

Optionalinterop

interop?: InteropConfig

OptionalisClosable

isClosable?: boolean

Default Value

true

Platforms Only. If false, the view will be persistent and can't be closed through either UI or Platform.closeView. Note that the view will still be closed if the host window is closed or if the view isn't part of the new layout when running Layout.replace.

OptionalpreventDragOut

preventDragOut?: boolean

Default Value

false

**Platforms Only.** If true, the tab of the view can't be dragged out of its host window.

Optionalthrottling

throttling?: ViewThrottling

View throttling state.

  • enabled: Both background throttling and scheduler throttling are true. It's fully throttled.
  • scheduler-disabled: background throttling is true, but scheduler throttling is disabled.

Default Value

'enabled'

Settings

On This Page

Properties