DHTMLX Docs & Samples Explorer
Index
dhtmlxlayout
API Methods (by category)
Initialization
dhtmlXLayoutObject
- constructor
setSkin
- sets layout's skin
setImagePath
- sets path to images
Effects
setEffect
- sets effect
getEffect
- returns true if the effect is enabled
AutoSize
setAutoSize
- sets autosize for the layout
listAutoSizes
- returns array with available autosize settings
listViews
- returns array with available layout patterns
Items
getId
- returns cell's id
getIdByIndex
- returns cell's id by index
getIndex
- returns cell's index
getIndexById
- returns cell's index by id
cells
- returns cell's object by cell's id
forEachItem
- iterator, calls a user-defined function n-times
Header
setText
- sets header text
setCollapsedText
- sets header's text in a collapsed state
getText
- returns header text
showHeader
- shows the header
hideHeader
- hides the header
isHeaderVisible
- returns true if the header is visible
Views
view
- creates a view
Sizing
setWidth
- sets cell's width
setHeight
- sets cell's height
getWidth
- returns cell's width
getHeight
- returns cell's height
fixSize
- fixes cell's size (block resize)
setSizes
- adjusts layout's outer size in case of object-based init
Expand/Collapse
expand
- expands a cell
collapse
- collapses a cell
isCollapsed
- returns true if a cell is collapsed
Docking
dock
- docks a cell from a window
undock
- undocks a cell to a window
Progress Indicator
progressOn
- shows progress indicator for the whole layout
progressOff
- hides progress indicator for the whole layout
progressOn
- shows progress indicator for a cell
progressOff
- hides progress indicator for a cell
Attaching Objects/dhtmlx Components
Menu
attachMenu
- attaches dhtmlxMenu to the whole container or a cell
detachMenu
- removes attached menu from the whole container or a cell
showMenu
- shows menu attached to the whole container or a cell
hideMenu
- hides menu attached to the whole container or a cell
Toolbar
attachToolbar
- attaches dhtmlxToolbar to the whole container or a cell
detachToolbar
- removes attached toolbar from the whole container or a cell
showToolbar
- shows toolbar attached to the whole container or a cell
hideToolbar
- hides toolbar attached to the whole container or a cell
Status Bar
attachStatusBar
- attaches dhtmlxStatusBar to the whole container or a cell
detachStatusBar
- removes attached status bar from the whole container or a cell
showStatusBar
- shows status bar attached to the whole container or a cell
hideStatusBar
- hides status bar attached to the whole container or a cell
Other objects/components
attachAccordion
- attaches dhtmlxAccordion to a cell
attachChart
- attaches dhtmlxChart to a cell
attachDataView
- attaches dhtmlxDataView to a cell
attachEditor
- attaches dhtmlxEditor to a cell
attachForm
- attaches dhtmlxForm to a cell
attachGrid
- attaches dhtmlxGrid to a cell
attachLayout
- attaches dhtmlxLayout to a cell
attachMap
- attaches Google Maps to a cell
attachObject
- attaches html object to a cell
attachScheduler
- attaches dhtmlxScheduler to a cell
attachTabbar
- attaches dhtmlxTabbar to a cell
attachTree
- attaches dhtmlxTree to a cell
attachURL
- attaches dhtmlxURL to a cell
Events
attachEvent
- attaches an event handler to a dhtmlxLayout
checkEvent
- returns true if the event exists
detachEvent
- removes an event handler