Class: CardLayout

CardLayout

layoutEngines/cardlayout.js, line 62

Creates a new instance of the card layout engine.

Parameters:
Name Type Description
options Object

An object used to initialize the CardLayout.

Name Type Default Description
cardHeight number 256 optional

The default row height.

cardWidth number | string "container width" optional

The default column width.

direction string "HORIZONTAL" optional

The layout direction. Accepts "HORIZONTAL" or "VERTICAL".

showScrollBar boolean true optional

Specifies whether to show the scroll bar.

rightToLeft boolean false optional

Indicates whether to lay out elements from right to left.

filterExpression string optional

A string filter expression used to filter the data collection.

defaultGroupingInfo Object optional

Default group setting object, settings in group descriptor has higher priority.

grouping Object | Array optional

A single group setting object or array of group setting objects used to initialize groups.

Name Type Description
field string optional

The column id used to group the column.

collapsed boolean optional

Whether the group is collapsed.

converter Object optional

A function that is used to specify the grouping name. The function requires a cell value parameter when calling.

header Object optional

The group header settings.

Name Type Default Description
visible boolean true optional

Specifies whether the group header is visible.

template string optional

The group header template.

height number optional

The group header height.

footer Object optional

The group footer settings.

Name Type Default Description
visible boolean false optional

Specifies whether the group footer is visible.

template string optional

The group footer template.

height number optional

The height of the group footer.

collapseWithGroup boolean optional

Specifies whether the footer is collapsed when the group is collapsed. If false, the footer remains visible even if the group is collapsed.

groupStrategy Object optional

A group strategy object used to define the group layout strategy.

rowTemplate string optional

A string that starts with '#'+templateID or a raw html string that represents the structure and layout of a row.

allowAsyncRender boolean false optional

Indicates whether to run asyncRender method in column.