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
August Weber
492-934-8337KristoffervilleYes
Myah Hagenes
209-337-9489JanetburyNo
Michelle Feest
620-147-3755WildermanburghNo
Raphael Rosenbaum
485-780-5975West VernonportNo
Bonita Rogahn
003-433-3144Lake KentonburghNo
Nick Kassulke
836-834-5829ShaunviewYes
Rylan Conn
334-520-7432DangelotonYes
Korbin Schaefer
415-601-7888East RowlandYes
Connie Becker
150-878-9943EdythviewNo
Fatima Marvin
459-157-5333East HeathbergNo
Monserrat Bergstrom
721-168-6788New DarrenmouthNo
Roel Mosciski
911-957-8987DannyportNo
Quinn Turner
147-874-0523Lake DonavontownYes
Billy Durgan
705-932-8785SatterfieldfurtYes
Troy Klein
324-165-7203JaimeburghYes
Burley Kiehn
007-916-5368ElmerburyYes
Alize Greenholt
355-724-9520JaylenburghNo
Leo Graham
067-095-0796JerroldviewNo
Porter Stark
039-815-9166McLaughlinboroughNo
Joesph Sauer
641-554-6828South BurniceburyYes
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