Docking Layout API Reference


animation string advanced
autoHideItems Array
autoLoadState boolean false
autoSaveState boolean false
disabled boolean false
disableDragging boolean false
hideSplitterBars boolean false
items Array
closedItems Array
layout array
liveResize boolean false
locale string en
localizeFormatFunction function null
messages object {“en”:{“propertyUnknownType”:”‘{{name}}’ property is with undefined ‘type’ member!”,”propertyInvalidValue”:”Invalid ‘{{name}}’ property value! Actual value: {{actualValue}}, Expected value: {{value}}!”,”propertyInvalidValueType”:”Invalid ‘{{name}}’ property value type! Actual type: {{actualType}}, Expected type: {{type}}!”,”elementNotInDOM”:”Element does not exist in DOM! Please, add the element to the DOM, before invoking a method.”,”moduleUndefined”:”Module is undefined.”,”missingReference”:”{{elementType}}: Missing reference to {{files}}.”,”htmlTemplateNotSuported”:”{{elementType}}: Browser doesn’t support HTMLTemplate elements.”,”invalidTemplate”:”{{elementType}}: \”{{property}}\” property accepts a string that must match the id of an HTMLTemplate element from the DOM.”,”invalidNode”:”{{elementType}}: \”{{method}}\” method accepts an instance of Smart.TabsWindow”,”invalidNodeRemove”:”{{elementType}}: \”{{method}}\” method accepts an instance of Smart.TabsWindow that is a child of the DockingLayout.”,”invalidNodeType”:”{{elementType}}: The method \”{{method}}\” requires a \”smart-tabs-window\” element to be passed as an argument.”,”invalidTargetNode”:”{{elementType}}: The method \”{{method}}\” requires an index of an item that is not hidden/closed. Only visible items that are part of the Layout are valid.”,”invalidIndex”:”{{elementType}}: \”{{method}}\” method accepts an index of type number.”,”noId”:”smartDockingLayout requires an id in order to save/load a state.”}}
readonly boolean false
resizeStep number 5
snapMode string advanced
theme string
undockedItems Array
unfocusable boolean false


change Event
close Event
closing Event
stateChange Event
resizeStart Event
resizeEnd Event


autoHideBottom Method
autoHideLeft Method
autoHideRight Method
autoHideTop Method
clearState Method
dock Method
insertBeforeItem Method
insertAfterItem Method
insertIntoLeft Method
insertIntoRight Method
insertIntoTop Method
insertIntoBottom Method
insertLayoutTop Method
insertLayoutBottom Method
insertLayoutLeft Method
insertLayoutRight Method
insertOutsideTargetGroupTop Method
insertOutsideTargetGroupBottom Method
insertOutsideTargetGroupLeft Method
insertOutsideTargetGroupRight Method
getAutoHideItems Method
getIndex Method
getState Method
getItemGroupElement Method
getJSONStructure Method
loadState Method
remove Method
removeAll Method
removeChild Method
saveState Method
undock Method
update Method