Skip to content

Latest commit

 

History

History
208 lines (171 loc) · 7 KB

API.md

File metadata and controls

208 lines (171 loc) · 7 KB

ax5docker

Kind: global class
Author: tom@axisj.com

ax5docker.config : Object

Kind: static property of ax5docker

ax5docker.xvar : Object

Kind: static property of ax5docker

ax5docker.menu : Object

Kind: static property of ax5docker

ax5docker.panels : Array

Kind: static property of ax5docker

ax5docker.panelId : Number

Kind: static property of ax5docker

ax5docker.modules : Object

Kind: static property of ax5docker

ax5docker.setConfig(config)

Kind: static method of ax5docker

Param Type Default Description
config Object
config.target Element
config.panels Array.<Object>
config.panels[].type String panel, stack, row, column
config.panels[].name String
[config.panels[].color] String
[config.panels[].borderColor] String
config.panels[].moduleName String
config.panels[].moduleState Object
config.panels[].panels Array.<Object>
[config.icons] Object
[config.icons.close] String
[config.icons.more] String
[config.disableClosePanel] Boolean false
[config.disableDragPanel] Boolean false
[config.control] Object
[config.control.before] function
[config.control.after] function
[config.menu] Object
[config.menu.theme] String "default"
[config.menu.position] String "absolute"
[config.menu.icons] Object
[config.menu.icons.arrow] String
[config.resizeDebounceTime] Number 100
[config.panelDebounceTime] Number 300

Example

var myDocker = new ax5.ui.docker();
myDocker.setConfig({
     target: $('[data-ax5docker="docker1"]'),
     panels: [
         {
             type: "panel",
             name: "panel name",
             color: "#ff3300",
             borderColor: "#000000",
             moduleName: "content",
             moduleState:{
                 data: "data1"
             }
         }
     ]
});

ax5docker.setPanels() ⇒ ax5docker

Kind: static method of ax5docker

ax5docker.addModule(modules) ⇒ ax5docker

Kind: static method of ax5docker

Param
modules

ax5docker.repaint() ⇒ ax5docker

repaint panels of docker

Kind: static method of ax5docker

ax5docker.addPanel(_addPath, _addType, _panel, _panelIndex) ⇒ ax5docker

Kind: static method of ax5docker

Param Type Description
_addPath String Position path to add panel
_addType
_panel
_panelIndex

Example

myDocker.addPanel('0.1', 'stack', {type:'panel', name:'addPanel', moduleName: 'content'});

ax5docker.removePanel(panelPath, callback) ⇒ ax5docker

패널 삭제하기

Kind: static method of ax5docker

Param Type
panelPath String
callback function

Example

function removePanel() {
     var p = myDocker.searchPanel(function (panel) {
         return (panel.key == "A");
     });

     if (p) {
         myDocker.removePanel(p.panelPath, function () {
             removePanel();
         });
     }
}
removePanel();

ax5docker.appendPanel(_panel, _appendPath, _appendType) ⇒ ax5docker

Kind: static method of ax5docker

Param
_panel
_appendPath
_appendType

ax5docker.align() ⇒ ax5docker

Kind: static method of ax5docker

ax5docker.searchPanel(_condition) ⇒ *

Kind: static method of ax5docker

Param
_condition

Example

var p = myDocker.searchPanel(function (panel) {
 return (panel.id == "A");
});

ax5docker.activePanel(_panelPath, callback) ⇒ ax5docker

Kind: static method of ax5docker

Param Type
_panelPath String
callback function

Example

myDocker.activePanel("0.1");
myDocker.activePanel("0.0.1");