Display API Methods

The WMKS core object uses display API methods to control the remote screen size.

setRemoteScreenSize()

Sends a request to set the screen resolution of the currently connected VM console. If the requested width and height parameters are larger than the allocated size of the WMKS widget, the sizing is normalized.
Parameter1
Type: integer. Width of the screen in pixels.
Parameter2
Type: integer. Height of the screen in pixels.
Return Value
None
Example Call
wmks.setRemoteScreenSize(800,600);

getRemoteScreenSize()

Retrieves the screen width and height in pixels.
Parameter
None
Return Value
Object with format {width:
w
, height:
h
}
Example Call
var size = wmks.getRemoteScreenSize;

updateScreen()

Changes the resolution or rescales the remote screen to match the container size. Behavior depends on settings for changeResolution, rescale, and position options described in createMKS Options.
  • If changeResolution is true, the remote screen resolution changes to match the container size.
  • If changeResolution is false, check the rescale option. If true, the remote screen rescales to match the container size.
  • If both changeResolution and rescale are false, check the position option. Depending on the value, the remote screen appears in the container at either the center or top left.
Parameter
None
Return Value
None
Example Call
wmks.updateScreen();