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's text
- setCollapsedText - sets header's text in a collapsed state
- getText - returns header's text
- showHeader - shows a header
- hideHeader - hides a header
- isHeaderVisible - returns true if a header is visible

#### Views

- view - creates a view
- show - shows 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 - hides progress indicator for full layout
- progressOff - hides progress indicator for full layout
- progressOn - shows progress indicator for cell
- progressOff - hides progress indicator for cell

#### Attaching Objects/dhtmlx Components

Google Maps

- attachGoogleMaps - attaches Google Maps to cell

Menu

- attachMenu - attaches a dhtmlxMenu to the whole container or to cell
- detachMenu - removes attached menu from the whole container or from cell
- showMenu - shows menu attached to the whole container or to cell
- hideMenu - hides menu attached to the whole container or to cell

Toolbar

- attachToolbar - attaches a dhtmlxToolbar to the whole container
- detachToolbar - removes attached toolbar from the whole container or from cell
- showToolbar - shows toolbar attached to the whole container or to cell
- hideToolbar - hides toolbar attached to the whole container or to cell

Status Bar

- attachStatusBar - attaches a status bar to the whole container
- detachStatusBar - removes attached status bar from the whole container or from cell
- showStatusBar - shows status bar attached to the whole container or to cell
- hideStatusBar - hides status bar attached to the whole container or to cell
- attachTree - attaches dhtmlxTree to cell
- attachGrid - attaches dhtmlxGrid to cell
- attachTabbar - attaches dhtmlxTabbar to cell
- attachFolders - attaches dhtmlxFolders to cell
- attachAccordion - attaches dhtmlxAccordion to cell
- attachEditor - attaches dhtmlxEditor to cell
- attachLayout - attaches dhtmlxLayout to cell
- attachURL - attaches dhtmlxURL to cell
- attachObject - attaches html object to cell

#### Events

- attachEvent - attaches an event handler to a dhtmlxLayout
- checkEvent - returns true if the event exists
- detachEvent - removes an event handler