You're viewing the legacy site. Visit cxjs.io/docs for the latest documentation. Legacy site. Visit cxjs.io/docs for new docs.

Documentation

Report Edit

Tree Grid

The following example shows how to make a tree out of grid control.

NamePhoneCityNotified
Eriberto Boyer
094-410-4161West MellieYes
Kellen Kohler
268-967-4294EfrainviewNo
Delta Tremblay
199-354-2909SatterfieldburghYes
Berenice Grimes
674-305-8951VictorburghNo
Elton Schamberger
158-586-1486NoelchesterYes
Giuseppe Franecki
030-850-3745EffiefortNo
Gretchen Wilderman
471-924-7531East ThaliaboroughNo
Arnulfo Parker
594-140-6987East SammieNo
Rosanna Murray
781-144-6336DeckowlandNo
Jalen Bode
119-524-8652North JordyNo
Scotty Casper
975-554-0250North DelmerNo
Pamela Cassin
380-710-1207MissouritonNo
Eliza Romaguera
089-681-4456ClaireviewYes
Novella Fay
327-795-7773South TaylorboroughNo
Ida Eichmann
422-856-3413South ChrisburyNo
Keyon Prohaska
884-869-0656West MerrittYes
Kaci Ebert
130-509-9704East MinervaYes
Otto McGlynn
121-265-7649South GregsideYes
Cathryn Schuster
464-236-6031ArjunboroughYes
Leonardo Willms
473-967-2791Lake EinarhavenYes
NamePhoneCityNotified
ControllerGrid
<Grid
    buffered
    records-bind='$page.data'
    mod="tree"
    style={{width: "100%", height: '500px'}}
    scrollable={true}
    dataAdapter={{
        type: TreeAdapter,
        load: (context, {controller}, node) => controller.generateRecords(node)
    }}
    selection={{type: KeySelection, bind: "$page.selection"}}
    columns={[
        {
            header: 'Name', field: 'fullName', sortable: true, items: <cx>
            <TreeNode expanded-bind="$record.$expanded"
                leaf-bind="$record.$leaf"
                level-bind="$record.$level"
                loading-bind="$record.$loading"
                text-bind="$record.fullName"
                icon-bind="$record.icon"
            />
        </cx>
        },
        {header: 'Phone', field: 'phone'},
        {header: 'City', field: 'city', sortable: true},
        {
            header: 'Notified',
            field: 'notified',
            sortable: true,
            value: {expr: '{$record.notified} ? "Yes" : "No"'}
        }
    ]}
/>
Copied!Cx Fiddle

Searching Tree Grids

Check out this example to find out how to implement search functionality in a Tree Grid.

TreeNode Configuration

PropertyDescriptionType
expanded

A value indicating if tree node is expanded or not.

boolean
icon

An icon to be displayed. If not set, default icons will be used.

string
leaf

A value indicating if tree node is a leaf node or not. Leaf nodes cannot have any children.

boolean
level

A value indicating the depth level inside the tree used for indenting.

number
loading

A value indicating if tree node is currently loading its children.

boolean
text

Text to be displayed alongside the icon.

string
autoFocus

Set to true to automatically focus the element when mounted.

boolean
baseClass

Base CSS class to be applied to the element. Default is 'treenode'.

string
class
className

Additional CSS classes to be applied to the element. If an object is provided, all keys with a "truthy" value will be added to the CSS class list.

string/object
folderIcon

Icon to be used to represent folders. Default is folder.

string
hideArrow

A value indicating if arrow should be displayed or not. Can be used to hide arrow for folders with no children.

boolean
hideIcon

Set to true to hide icons.

boolean
innerHtml
html

HTML to be injected into the element.

string
itemIcon
leafIcon

Icon to represent leaf nodes. Default is file.

string
items
children

List of child elements.

array
layout

Define an inner layout.

string/object
loadingIcon

Icon to be used while in loading state. Default is loading.

string
mod

Appearance modifier. For example, mod="big" will add the CSS class .cxm-big to the block element.

string/array
openFolderIcon

Icon to be used to represent open folders. Default is folder-open.

string
outerLayout

Defines the outer layout which wraps the widget.

widget
plainText

Set to true to avoid converting inner strings to templates. Default is false.

boolean
preserveWhitespace
ws

Keep whitespace in text based children. Default is false. See also trimWhitespace.

boolean
putInto
contentFor

Used with outer layouts. Specifies the name of the content placeholder which should render the widget.

string
style

Style object applied to the wrapper div. Used for setting the dimensions of the element.

string/object
tag

Name of the HTML element to be rendered. Default is div.

string
tooltip

Tooltip configuration. For more info see Tooltips.

string/object
trimWhitespace

Remove all whitespace in text based children. Default is true. See also preserveWhitespace.

boolean
vdomKey

Key that will be used as the key when rendering the React component.

string
visible
if

Visibility of the widget. Defaults to true.

boolean