# Window >![](../../public_sys-resources/icon-note.gif) **NOTE:** >The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version. ## Modules to Import ``` import window from '@ohos.window'; ``` ## Required Permissions ohos.permission.SYSTEM\_FLOAT\_WINDOW ## SystemBarProperties Describes the properties of the status bar and navigation bar.

Name	Type	Readable	Writable	Description
statusBarColor	string	Yes	Yes	Color of the status bar. The color is a hexadecimal value, for example, #00FF00 or #FF00FF00.
isStatusBarLightIcon⁷⁺	boolean	Yes	Yes	Whether any icon on the status bar is highlighted.
navigationBarColor	string	Yes	Yes	Color of the navigation bar. The color is a hexadecimal value, for example, #00FF00 or #FF00FF00.
isNavigationBarLightIcon⁷⁺	boolean	Yes	Yes	Whether any icon on the navigation bar is highlighted.

## Rect⁷⁺ Describes a rectangle.

Name	Type	Readable	Writable	Description
left	number	Yes	Yes	Left boundary of the rectangle.
top	number	Yes	Yes	Top boundary of the rectangle.
width	number	Yes	Yes	Width of the rectangle.
height	number	Yes	Yes	Height of the rectangle.

## AvoidArea⁷⁺ Describes the area where the window cannot be displayed.

Name	Type	Readable	Writable	Description
leftRect	Rect	Yes	Yes	Rectangle on the left of the screen.
topRect	Rect	Yes	Yes	Rectangle at the top of the screen.
rightRect	Rect	Yes	Yes	Rectangle on the right of the screen.
bottomRect	Rect	Yes	Yes	Rectangle at the bottom of the screen.

## Size⁷⁺ Describes the window size.

Name	Type	Readable	Writable	Description
width	number	Yes	Yes	Window width.
height	number	Yes	Yes	Window height.

## WindowProperties Describes the window properties.

Name	Type	Readable	Writable	Description
windowRect⁷⁺	Rect	Yes	No	Window size.
type⁷⁺	WindowType	Yes	No	Window type.
brightness	number	Yes	Yes	Screen brightness. The value ranges from 0 to 1. The value 1 indicates the maximum brightness.
isTransparent⁷⁺	boolean	Yes	Yes	Whether the window is transparent. The default value is false.
isFullScreen	boolean	Yes	Yes	Whether the window is displayed in full screen mode. The default value is false.
isKeepScreenOn	boolean	Yes	Yes	Whether the screen is always on. The default value is false.
dimBehindValue⁷⁺	number	Yes	Yes	Dimness of the window that is not on top. The value ranges from 0 to 1. The value 1 indicates the maximum dimness.
isLayoutFullScreen⁷⁺	boolean	Yes	Yes	Whether the window layout is in full-screen mode (whether the window is immersive). The default value is false.
focusable⁷⁺	boolean	Yes	Yes	Whether the window can gain focus. The default value is true.
touchable⁷⁺	boolean	Yes	Yes	Whether the window is touchable. The default value is true.
isPrivacyMode⁷⁺	boolean	Yes	Yes	Whether the window is in privacy mode. The default value is false.
isRoundCorner⁷⁺	boolean	Yes	Yes	Whether the window has rounded corners.

## SplitScreenBoundsInfo⁷⁺ Describes information about the split-screen boundary.

Name	Type	Description
splitMode7+	number	Split-screen mode.
primaryBounds	Rect	Primary window boundary information, which is in the format of a Rect instance.
secondaryBounds	Rect	Secondary window boundary information, which is in the format of a Rect instance.

## window.getTopWindow getTopWindow\(callback: AsyncCallback\): void Obtains a **Window** instance. - Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<Window>	Yes	Callback used to return the current Window object.

- Example ``` window.getTopWindow((err, data) => { if (err) { console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(err)); return; } console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data)); windowClass = data; }); ``` ## window.create⁷⁺ create\(id: string, type: WindowType, callback: AsyncCallback\): void Creates a subwindow. - Parameters

Name	Type	Mandatory	Description
id	string	Yes	Window ID.
type	WindowType	Yes	Window type.
callback	AsyncCallback<Window>	Yes	Callback used to return the current Window object.

- Example ``` window.create("first", 1, (err, data) => { windowClass = data; if (err) { console.error('Failed to create the subWindow. Cause: ' + JSON.stringify(err)); return; } console.info('SubWindow created. Data: ' + JSON.stringify(data)) windowClass.resetSize(500, 1000); windowClass.setOutsideTouchable(true); windowClass.loadContent("pages/index/index", (err, data) => { }); }) ``` ## window.find⁷⁺ find\(id: string, callback: AsyncCallback\): void Finds a subwindow. - Parameters

Name	Type	Mandatory	Description
id	string	Yes	Window ID.
callback	AsyncCallback<Window>	Yes	Callback used to return the current Window object.

- Example ``` window.find("first", (err, data) => { if (err) { console.error('Failed to find the subWindow. Cause: ' + JSON.stringify(err)); return; } console.info('SubWindow found. Data: ' + JSON.stringify(data)) windowClass = data; }) ``` ## window.getAbilityWindowMode⁷⁺ getAbilityWindowMode\(callback: AsyncCallback\): void Obtains the mode of this window. - Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<WindowMode>	Yes	Callback used to return the window mode.

- Example ``` window.getAbilityWindowMode((err, data) => { if (err) { console.error(''Failed to obtain the window mode. Cause:' + JSON.stringify(err)); return; } console.info('Window mode obtained. Data:' + JSON.stringify(data)) }); ``` ## window.getSplitScreenBounds⁷⁺ getSplitScreenBounds\(splitRatio: SplitRatio, callback: AsyncCallback\): void Obtains the position and area of multiple windows in split-screen mode. - Parameters

Name	Type	Mandatory	Description
splitRatio	SplitRatio	Yes	Screen split ratio. The default ratio is 1:1. The value 1 indicates the ratio 1:2, and the value 2 indicates the ratio 2:1.
callback	AsyncCallback<SplitScreenBoundsInfo>	Yes	Callback used to return a SplitScreenBoundsInfo object that contains the split-screen boundary information.

- Example ``` var splitRatio = '1:1'; window.getSplitScreenBounds(splitRatio, (err, data) => { if (err) { console.error('Failed to obtain the split-screen boundary information. Cause: ' + JSON.stringify(err)); return; } console.info('Split-screen boundary information obtained. Data: ' + JSON.stringify(data)) }); ``` ## window.isFloatingAbilityWindowVisible⁷⁺ isFloatingAbilityWindowVisible\(callback:AsyncCallback\): void Checks whether the floating window is visible. - Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<boolean>	Yes	Callback used to indicate whether the floating window is visible.

- Example ``` window.isFloatingAbilityWindowVisible( (err, data) => { if (err) { console.error('Failed to check whether the floating window is visible. Cause:' + JSON.stringify(err)); return; } console.info('Succeeded in checking whether the floating window is visible. Data:' + JSON.stringify(data)) }); ``` ## window.setSplitBarVisibility⁷⁺ setSplitBarVisibility\(isVisibility: boolean, callback: AsyncCallback\): void Sets whether the split-screen divider is visible. - Parameters

Name	Type	Description
isVisibility	boolean	Whether to display the divider. The value true means to display the divider, and false means the opposite.
callback	AsyncCallback<void>	Callback used to return the execution result.

- Example ``` var isVisibility = false; window.setSplitBarVisibility(isVisibility , (err, data) => { if (err) { console.error('Failed to set the divider to be invisible. Cause:' + JSON.stringify(err)); return; } console.info('Succeeded in setting the divider to be invisible. Data:' + JSON.stringify(data)) }); ``` ## WindowType⁷⁺ Window type.

Name	Default Value	Description
TYPE_APP	0	Application window.
TYPE_SYSTEM_ALERT	1	System pop-up window.

## AvoidAreaType⁷⁺ Describes the type of the area where the window cannot be displayed.

Name	Default Value	Description
TYPE_SYSTEM	0	Default area of the system.
TYPE_CUTOUT	1	Notch.

## WindowMode⁷⁺ Describes the window mode of an application.

Name	Default Value	Description
UNDEFINED	1	The window mode is not defined by the application.
FULLSCREEN	2	The application is displayed in full screen.
PRIMARY	3	The application is displayed in the primary window in split-screen mode.
SECONDARY	4	The application is displayed in the secondary window in split-screen mode.
FLOATING	5	The application is displayed in a floating window.

## splitMode⁷⁺ Describes the split-screen mode.

Name	Default Value	Description
VERTICAL	0	Vertical split-screen mode.
HORIZONTAL	1	Horizontal split-screen mode.

## Window In the following API examples, you must use [getTopWindow\(\)](#section39061940191) to obtain a **Window** instance and then call the corresponding methods based on this instance. ## setBrightness setBrightness\(brightness:number, callback: AsyncCallback\): void Sets the brightness for this window. - Parameters

Name	Type	Mandatory	Description
brightness	number	Yes	Brightness to set, which ranges from 0 to 1. The value 1 indicates the brightest.
callback	AsyncCallback<void>	Yes	Callback invoked to return the result.

- Example ``` var brightness = 10; windowClass.setBrightness(brightness, (err, data) => { if (err) { console.error('Failed to set the brightness. Cause: ' + JSON.stringify(err)); return; } console.info('Succeeded in setting the brightness. Data: ' + JSON.stringify(data)); }); ``` ## setBackgroundColor setBackgroundColor\(color: string, callback: AsyncCallback\): void Sets the background color for this window. - Parameters

Name	Type	Mandatory	Description
color	string	Yes	Background color to set. The color is a hexadecimal value, for example, #00FF00 or #FF00FF00.
callback	AsyncCallback<void>	Yes	Callback invoked to return the result.

- Example ``` var color = '#00ff33'; windowClass.setBackgroundColor(color, (err, data) => { if (err) { console.error('Failed to set the background color. Cause: ' + JSON.stringify(err)); return; } console.info('Succeeded in setting the background color. Data: ' + JSON.stringify(data)); }); ``` ## setTransparent⁷⁺ setTransparent\(isTransparent: boolean, callback: AsyncCallback\): void Sets whether this window is transparent. - Parameters

Name	Type	Mandatory	Description
isTransparent	boolean	Yes	Whether the window is transparent.
callback	AsyncCallback<void>	Yes	Callback invoked to return the result.

- Example ``` var isTransparent = true; windowClass.setTransparent(isTransparent, (err, data) => { if (err) { console.error('Failed to set the window to be transparent. Cause: ' + JSON.stringify(err)); return; } console.info('Succeeded in setting the window to be transparent. Data: ' + JSON.stringify(data)) }); ``` ## setFullScreen setFullScreen\(isFullScreen: boolean, callback: AsyncCallback\): void Sets whether to enable the full-screen mode for this window. - Parameters

Name	Type	Mandatory	Description
isFullScreen	boolean	Yes	Whether to enable the full-screen mode.
callback	AsyncCallback<void>	Yes	Callback invoked to return the result.

- Example ``` var isFullScreen = true; windowClass.setFullScreen(isFullScreen, (err, data) => { if (err) { console.error('Failed to enable the full-screen mode. Cause: ' + JSON.stringify(err)); return; } console.info('Succeeded in enabling the full-screen mode. Data: ' + JSON.stringify(data)); }); ``` ## setKeepScreenOn setKeepScreenOn\(isKeepScreenOn: boolean, callback: AsyncCallback\): void Sets whether to keep the screen always on. - Parameters

Name	Type	Mandatory	Description
isKeepScreenOn	boolean	Yes	Whether to keep the screen always on.
callback	AsyncCallback<void>	Yes	Callback invoked to return the result.

- Example ``` var isKeepScreenOn = true; windowClass.setKeepScreenOn(isKeepScreenOn, (err, data) => { if (err) { console.error('Failed to set the screen to be always on. Cause: ' + JSON.stringify(err)); return; } console.info('Succeeded in setting the screen to be always on. Data: ' + JSON.stringify(data)); }); ``` ### setWindowType⁷⁺ setWindowType(type: WindowType, callback: AsyncCallback<void>): void Sets the window type. - Parameters | Name | Type | Mandatory | Description | | -------- | ---------------------------------- | --------- | ---------------------------------------- | | type | [WindowType](#section099619567453) | Yes | Window type. | | callback | AsyncCallback<void> | Yes | Callback used to return the window type. | - Example ``` var type = window.TYPE_APP; windowClass.setWindowType(type, (err, data) => { if (err) { console.error('Failed to set the window type. Cause: ' + JSON.stringify(err)); return; } console.info('Succeeded in setting the window type. Data: ' + JSON.stringify(data)) }); ``` ## setDimBehind⁷⁺ setDimBehind\(dimBehindValue: number, callback: AsyncCallback\): void Sets the dimness of the window that is not on top. - Parameters

Name	Type	Mandatory	Description
dimBehindValue	number	Yes	Dimness of the window to set. The value ranges from 0 to 1. The value 1 indicates the dimmest.
callback	AsyncCallback<void>	Yes	Callback invoked to return the result.

- Example ``` windowClass.setDimBehind(0.5, (err, data) => { if (err) { console.error('Failed to set the dimness. Cause: ' + JSON.stringify(err)); return; } console.info('Succeeded in setting the dimness. Data:' + JSON.stringify(data)); }); ``` ## setLayoutFullScreen⁷⁺ setLayoutFullScreen\(isLayoutFullScreen: boolean, callback: AsyncCallback\): void Sets whether the window layout is in full-screen mode. - Parameters

Name	Type	Mandatory	Description
isLayoutFullScreen	boolean	Yes	Whether the window layout is in full-screen mode.
callback	AsyncCallback<void>	Yes	Callback invoked to return the result.

- Example ``` var isLayoutFullScreen= true; windowClass.setLayoutFullScreen(isLayoutFullScreen, (err, data) => { if (err) { console.error('Failed to set the window layout to full-screen mode. Cause:' + JSON.stringify(err)); return; } console.info('Succeeded in setting the window layout to full-screen mode. Data:' + JSON.stringify(data)); }); ``` ## setFocusable⁷⁺ setFocusable\(isFocusable: boolean, callback: AsyncCallback\): void Sets whether this window can gain focus. - Parameters

Name	Type	Mandatory	Description
isFocusable	boolean	Yes	Whether the window can gain focus.
callback	AsyncCallback<void>	Yes	Callback invoked to return the result.

- Example ``` var isFocusable= true; windowClass.setFocusable(isFocusable, (err, data) => { if (err) { console.error('Failed to set the window to be focusable. Cause:' + JSON.stringify(err)); return; } console.info('Succeeded in setting the window to be focusable. Data: ' + JSON.stringify(data)); }); ``` ## setTouchable⁷⁺ setTouchable\(isTouchable: boolean, callback: AsyncCallback\): void Sets whether this window is touchable. - Parameters

Name	Type	Mandatory	Description
isTouchable	boolean	Yes	Whether the window is touchable.
callback	AsyncCallback<void>	Yes	Callback invoked to return the result.

- Example ``` var isTouchable = true; windowClass.setTouchable(isTouchable, (err, data) => { if (err) { console.error('Failed to set the window to be touchable. Cause:' + JSON.stringify(err)); return; } console.info('Succeeded in setting the window to be touchable. Data:' + JSON.stringify(data)); }); ``` ## setPrivacyMode⁷⁺ setPrivacyMode\(isPrivacyMode: boolean, callback: AsyncCallback\): void Sets whether this window is in privacy mode. - Parameters

Name	Type	Mandatory	Description
isPrivacyMode	boolean	Yes	Whether the window is in privacy mode.
callback	AsyncCallback<void>	Yes	Callback invoked to return the result.

- Example ``` var isPrivacyMode = true; windowClass.setPrivacyMode(isPrivacyMode, (err, data) => { if (err) { console.error('Failed to set the window to privacy mode. Cause:' + JSON.stringify(err)); return; } console.info('Succeeded in setting the window to privacy mode. Data:' + JSON.stringify(data)); }); ``` ## setSystemBarEnable⁷⁺ setSystemBarEnable\(names: Array, callback: AsyncCallback\): void Sets whether to display the status bar and navigation bar in this window. - Parameters

Name	Type	Mandatory	Description
names	Array	Yes	Whether to display the status bar and navigation bar. For example, to display the status bar and navigation bar, set this parameter to ["status", "navigation"].
callback	AsyncCallback<void>	Yes	Callback invoked to return the result.

- Example ``` var names = ["status", "navigation"]; windowClass.setSystemBarEnable(names, (err, data) => { if (err) { console.error('Failed to set the system bar to be visible. Cause:' + JSON.stringify(err)); return; } console.info('Succeeded in setting the system bar to be visible. Data: ' + JSON.stringify(data)); }); ``` ## setSystemBarProperties setSystemBarProperties\(systemBarProperties: SystemBarProperties, callback: AsyncCallback\): void Sets the properties of the status bar and navigation bar in this window. - Parameters

Name	Type	Mandatory	Description
SystemBarProperties	SystemBarProperties	Yes	Properties of the status bar and navigation bar to set.
callback	AsyncCallback<void>	Yes	Callback invoked to return the result.

- Example ``` var SystemBarProperties={ statusBarColor: '#ff00ff', navigationBarColor: '#00ff00', // The following properties are supported since API version 7. isStatusBarLightIcon: true, isNavigationBarLightIcon:false }; windowClass.setSystemBarProperties(SystemBarProperties, (err, data) => { if (err) { console.error('Failed to set the system bar properties. Cause: ' + JSON.stringify(err)); return; } console.info('Succeeded in setting the system bar properties. Data: ' + JSON.stringify(data)); }); ``` ## getProperties getProperties\(callback: AsyncCallback\): void Obtains the properties of this window. This method uses an asynchronous callback to return the window properties. - Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<WindowProperties>	Yes	Callback used to return the window properties.

- Example ``` windowClass.getProperties((err, data) => { if (err) { console.error('Failed to obtain the window properties. Cause: ' + JSON.stringify(err)); return; } console.info('Succeeded in obtaining the window properties. Data: ' + JSON.stringify(data)); }); ``` ## getAvoidArea⁷⁺ getAvoidArea\(type: AvoidAreaType, callback: AsyncCallback\): void Obtains the area where this window cannot be displayed, for example, the system bar area and notch area. - Parameters

Name	Type	Mandatory	Description
type	AvoidAreaType	Yes	Type of the area. TYPE_SYSTEM indicates the default area of the system. TYPE_CUTOUT indicates the notch area.
callback	AsyncCallback<AvoidArea>	Yes	Callback used to return the area.

- Example ``` var type = window.AvoidAreaType.TYPE_SYSTEM; windowClass.getAvoidArea(type, (err, data) => { if (err) { console.error('Failed to obtain the area. Cause:' + JSON.stringify(err)); return; } console.info('Succeeded in obtaining the area. Data:' + JSON.stringify(data)); }); ``` ## moveTo⁷⁺ moveTo\(x: number, y: number, callback: AsyncCallback\): void Moves this window. - Parameters

Name	Type	Mandatory	Description
x	number	Yes	Distance that the window moves along the x-axis. A positive value indicates that the window moves to the right.
y	number	Yes	Distance that the window moves along the y-axis. A positive value indicates that the window moves downwards.
callback	AsyncCallback<void>	Yes	Callback invoked to return the result.

- Example ``` windowClass.moveTo(300, 300, (err, data)=>{ if (err) { console.error('Failed to move the window. Cause:' + JSON.stringify(err)); return; } console.info('Window moved. Data:' + JSON.stringify(data)); }); ``` ## resetSize⁷⁺ resetSize\(width: number, height: number, callback: AsyncCallback\): void Changes the size of this window. - Parameters

Name	Type	Mandatory	Description
width	number	Yes	New width of the window.
height	number	Yes	New height of the window.
callback	AsyncCallback<void>	Yes	Callback invoked to return the result.

- Example ``` windowClass.resetSize(500, 1000, (err, data) => { if (err) { console.error('Failed to change the window size. Cause:' + JSON.stringify(err)); return; } console.info('Window size changed. Data:' + JSON.stringify(data)); }); ``` ## loadContent⁷⁺ loadContent\(path: string, callback: AsyncCallback\): void Loads content to the subwindow. - Parameters

Name	Type	Mandatory	Description
path	string	Yes	Path of the page to which the content will be loaded.
callback	AsyncCallback<void>	Yes	Callback invoked to return the result.

- Example ``` windowClass.loadContent("pages/page2/page2", (err, data) => { if (err) { console.error('Failed to load the content. Cause:' + JSON.stringify(err)); return; } console.info('Succeeded in loading the content. Data:' + JSON.stringify(data)); }); ``` ## hide⁷⁺ hide \(callback: AsyncCallback\): void Hides the subwindow. - Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback invoked to return the result.

- Example ``` windowClass.hide((err, data) => { if (err) { console.error('Failed to hide the subwindow. Cause: ' + JSON.stringify(err)); return; } console.info('Subwindow hidden. Data:' + JSON.stringify(data)) }) ``` ## show⁷⁺ show\(callback: AsyncCallback\): void Shows the subwindow. - Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback invoked to return the result.

- Example ``` windowClass.show((err, data) => { if (err) { console.error('Failed to show the subwindow. Cause: ' + JSON.stringify(err)); return; } console.info('Succeeded in showing the subwindow. Data: ' + JSON.stringify(data)) }) ``` ## isShowing⁷⁺ isShowing\(callback: AsyncCallback\): void Checks whether the subwindow is displayed. - Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<boolean>	Yes	Callback used to indicate whether the subwindow is displayed.

- Example ``` windowClass.isShowing((err, data) => { if (err) { console.error('Failed to check whether the subwindow is showing. Cause:' + JSON.stringify(err)); return; } console.info('Succeeded in checking whether the subwindow is showing. Cause:' + JSON.stringify(data)) }) ``` ## destroy⁷⁺ destroy\(callback: AsyncCallback\): void Destroys the subwindow. - Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback invoked to return the result.

- Example ``` windowClass.destroy((err, data) => { if (err) { console.error('Failed to destroy the subwindow. Cause:' + JSON.stringify(err)); return; } console.info('Succeeded in destroying the subwindow. Data:' + JSON.stringify(data)) }) ``` ## setOutsideTouchable⁷⁺ setOutsideTouchable\(touchable: boolean, callback: AsyncCallback\): void; Sets whether the area outside the subwindow is touchable. - Parameters

Name	Type	Mandatory	Description
touchable	boolean	Yes	Whether the area outside the subwindow is touchable. The value true means that such an area is touchable, and false means the opposite.
callback	AsyncCallback<void>	Yes	Callback invoked to return the result.

- Example ``` windowClass.setOutsideTouchable(true, (err, data) => { if (err) { console.error('Failed to set the area to be touchable. Cause: ' + JSON.stringify(err)); return; } console.info('Succeeded in setting the area to be touchable. Data: ' + JSON.stringify(data)) }) ``` ## on\('keyboardHeightChange'\) on\(type: string, callback: AsyncCallback\): void >![](../../public_sys-resources/icon-note.gif) **NOTE:** >This method is deprecated since API version 7. Enables listening for keyboard height changes. - Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. Set it to keyboardHeightChange, which indicates listening for keyboard height changes.
callback	AsyncCallback<number>	Yes	Callback used to return the keyboard height.

- Example ``` var type= 'keyboardHeightChange'; windowClass.on(type, (err, data) => { if (err) { console.error('Failed to enable the listener for keyboard height changes. Cause: ' + JSON.stringify(err)); return; } console.info('Succeeded in enabling the listener for keyboard height changes. Data: ' + JSON.stringify(data)); }); ``` ## off\('keyboardHeightChange'\) off\(type: string, callback?: AsyncCallback\): void >![](../../public_sys-resources/icon-note.gif) **NOTE:** >This method is deprecated since API version 7. Disables listening for keyboard height changes. - Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listener type. Set it to keyboardHeightChange, which indicates a listener for keyboard height changes.
callback	AsyncCallback<number>	No	Callback used to return the keyboard height.

- Example ``` var type= 'keyboardHeightChange'; windowClass.off(type); ``` ### on('keyboardHeightChange'|'windowSizeChange'⁷⁺|'systemAvoidAreaChange'⁷⁺) on(type: string, callback: Callback<AvoidArea | Size | number>): void Enables listening. - Parameters | Name | Type | Mandatory | Description | | -------- | ------------------------------------------------------------ | --------- | ------------------------------------------------------------ | | type | string | Yes | Listening type.
- **keyboardHeightChange**: listening for keyboard height changes.
- **windowSizeChange'7+**: listening for window size changes.
- **systemAvoidAreaChange'7+**: listening for changes to the area where the window cannot be displayed. | | callback | Callback<[AvoidArea](#section74393271254) \| [Size](#section695585431120) \| number> | Yes | Callback used to return the information. | - Example ``` var type = 'windowSizeChange'; windowClass.on(type, (data) => { console.info('Succeeded in enabling the listener for window size changes. Data: ' + JSON.stringify(data)); }); ``` ### off('keyboardHeightChange'|'windowSizeChange'⁷⁺|'systemAvoidAreaChange'⁷⁺) off(type: string, callback?: Callback<AvoidArea | Size | number>): void Disables listening. - Parameters | Name | Type | Mandatory | Description | | -------- | ------------------------------------------------------------ | --------- | ------------------------------------------------------------ | | type | string | Yes | Listening type.
- **'keyboardHeightChange'**: listening for keyboard height changes.
- **'windowSizeChange'⁷⁺**: listening for window size changes.
- **'systemAvoidAreaChange'⁷⁺**: listening for changes to the area where the window cannot be displayed. | | callback | Callback<[AvoidArea](#section74393271254) \| [Size](#section695585431120) \| number> | No | Callback used to return the information. | - Example ``` var type = 'windowSizeChange'; windowClass.off(type); ```