TRY NEW VERSION

Try now New API BETA

Try out the new view and capabilities of the API documentation

START

Getting viewport settings

Starting from version 8.1, you can get the viewport settings of the desktop editors. This method is used to set the space between the top panel and the Desktop Editors widget.

window.AscDesktopEditor.getViewportSettings();

This method returns an object with the following parameters:

{ 
    "widgetType": "window",
    "captionHeight" : 100
}
Parameters
Name Description Type Example
The widget type ("window" or "tab"). string "window"
The caption height. integer 100

You can also subscribe to the onViewportSettingsChanged event which is called every time the viewport settings are changed:

window.AscDesktopEditor.attachEvent("onViewportSettingsChanged", function(){
    console.log ("The viewport settings have been changed.");
});