Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents window creation parameters.

All parameters are optional and have default settings.

Hierarchy

  • WindowParams

Index

Properties

animations

animations: WMAnimations

Window animation preferences.

Optional body

body: string

Window body text

Optional bodyClass

bodyClass: string

The css class to apply to the window body container.

center

center: boolean

Whether to center the window on creation.

controlBoxStyle

controlBoxStyle: "WS_CBX_MINMAXCLOSE" | "WS_CBX_CLOSE" | "WS_CBX_MINCLOSE" | "WS_CBX_NONE"

The control box style to use.

disableCommentsBtn

disableCommentsBtn: boolean

[internal] For developers only.

draggable

draggable: boolean

Whether the window is draggable.

Optional icon

icon: string

The window icon to use.

iframeFix

iframeFix: boolean

Whether to apply the iframe fix.

This fix makes the window clickable when its inactive. Otherwise, an iframe captures your pointer events.

The side effect is that this fix blocks iframe pointer events until the window is active again.

ignoreFocus

ignoreFocus: boolean

Whether to ignore focus events.

initialHeight

initialHeight: number

Initial height

initialWidth

initialWidth: number

Initial width.

initialX

initialX: number

Initial X position

initialY

initialY: number

Initial Y position.

minHeight

minHeight: number

Minimum height

minWidth

minWidth: number

Minimum width

mobResize

mobResize: boolean

Whether to allow mobile mode to resize this window and make it fullscreen.

noCompose

noCompose: boolean

Whether to disable the window compositor for the specified window.

resizable

resizable: boolean

Whether the window can be resized.

taskbar

taskbar: boolean

Whether the window should be registered in the taskbar.

title

title: string

Window title.

Optional windowClass

windowClass: string

The css class to apply to the window.

Optional wndContainer

wndContainer: HTMLElement

The window container to use.

zLayer

zLayer: "NORMAL" | "LOW" | "HIGH"

The ZLayer to use.

Generated using TypeDoc