Tree Grid Display Density
IgxTreeGrid design is based on Material Design Guidelines. We currently provide an option to choose between predefined set of display density options that will bring a cosy, comfortable or compact view respectively. By selecting the right density for your Material UI table / Material UI grid you can significantly improve the user experience when interacting with large amounts of content.
Demo
Usage
As you can see in the demo above, the IgxTreeGrid provides three density options: compact, cosy and comfortable. The code snippet below shows how to set displayDensity:
<igx-tree-grid #treeGrid [data]="data" [displayDensity]="'cosy'" >
</igx-tree-grid>
or
...
this.treeGrid.displayDensity = "cosy";
...
And now let's see in details how each option reflects on the Tree Grid component. When you switch between different density options the height of each Tree Grid element and the corresponding paddings will be changed. Also if you want to apply custom column width, please consider the fact that it must be bigger than the sum of left and right padding.
- comfortable - this is the default Tree Grid display density with the lowest intense and row height equal to
50px. Left and Right paddings are24px; Minimal columnwidthis48px; - cosy - this is the middle intense density with
40pxrow height. Left and Right paddings are16px; Minimal columnwidthis32px; - compact - this is the density with highest intense and
32pxrow height. Left and Right paddings are12px; Minimal columnwidthis24px;
Note
Please keep in mind that currently you can not override any of the sizes.
Let's now continue with our sample and see in action how the displayDensity is applied. Let's first add a button which will help us to switch between each density:
<div class="density-chooser">
<igx-buttongroup [values]="displayDensities"></igx-buttongroup>
</div>
@ViewChild(IgxButtonGroupComponent) public buttonGroup: IgxButtonGroupComponent;
public density = "compact";
public displayDensities;
public ngOnInit() {
this.displayDensities = [
{
label: "compact",
selected: this.density === "compact",
togglable: true
},
{
label: "cosy",
selected: this.density === "cosy",
togglable: true
},
{
label: "comfortable",
selected: this.density === "comfortable",
togglable: true
}
];
}
Now we can add the markup.
<div class="density-chooser">
<igx-buttongroup [values]="displayDensities" (onSelect)="selectDensity($event)"></igx-buttongroup>
</div>
<igx-tree-grid #treeGrid [data]="data" primaryKey="ID" foreignKey="ParentID" [displayDensity]="density" width="100%"
height="550px" [allowFiltering]="true">
<igx-column field="Name" dataType="string" [sortable]="true" [hasSummary]="true" width="200px"></igx-column>
<igx-column-group [pinned]="false" header="General Information">
<igx-column field="HireDate" dataType="date" [sortable]="true" [hasSummary]="true">
<ng-template igxCell let-cell="cell" let-val>
{{val | date:'dd/MM/yyyy'}}
</ng-template>
</igx-column>
<igx-column-group header="Person Details">
<igx-column field="ID" dataType="number" [filterable]="false"></igx-column>
<igx-column field="Title" dataType="string" [sortable]="true" [hasSummary]="true"></igx-column>
<igx-column field="Age" dataType="number" [sortable]="true" [hasSummary]="true"
[summaries]="numberSummaries" [filterable]="false"></igx-column>
</igx-column-group>
</igx-column-group>
<igx-column-group header="Address Information">
<igx-column-group header="Location">
<igx-column field="Country" dataType="string" [sortable]="true" [hasSummary]="true"></igx-column>
<igx-column field="City" dataType="string" [sortable]="true" [hasSummary]="true"></igx-column>
<igx-column field="Address" dataType="string" [sortable]="true" [hasSummary]="true"></igx-column>
</igx-column-group>
<igx-column-group header="Contact Information">
<igx-column field="Phone" dataType="string" [sortable]="true" [hasSummary]="true"></igx-column>
<igx-column field="Fax" dataType="string" [sortable]="true" [hasSummary]="true"></igx-column>
<igx-column field="PostalCode" dataType="string" [sortable]="true" [hasSummary]="true"></igx-column>
</igx-column-group>
</igx-column-group>
<igx-column-group header="Address Information">
<igx-column-group header="Location">
<igx-column field="Country" dataType="string" [sortable]="true" [hasSummary]="true"></igx-column>
<igx-column field="City" dataType="string" [sortable]="true" [hasSummary]="true"></igx-column>
<igx-column field="Address" dataType="string" [sortable]="true" [hasSummary]="true"></igx-column>
</igx-column-group>
<igx-column-group header="Contact Information">
<igx-column field="Phone" dataType="string" [sortable]="true" [resizable]="true"></igx-column>
<igx-column field="Fax" dataType="string" [sortable]="true" [resizable]="true"></igx-column>
<igx-column field="PostalCode" dataType="string" [sortable]="true" [resizable]="true"></igx-column>
</igx-column-group>
</igx-column-group>
</igx-tree-grid>
Finally, let's provide the necessary logic in order to actually apply the density:
@ViewChild("treeGrid", { read: IgxTreeGridComponent })
public treeGrid: IgxTreeGridComponent;
.....
public selectDensity(event) {
this.density = this.displayDensities[event.index].label;
}
Another option that IgxTreeGrid provides for you, in order to be able to change the height of the rows in the Tree Grid, is the property rowHeight. So let's see in action how this property affects the Tree Grid layout along with the displayDensity option.
Please keep in mind the following:
displayDensityoptions will have NO impact on row height if there is rowHeight specified;displayDensitywill affect all of the rest elements in the Tree Grid, as it has been described above;
And now we can extend our sample and add rowHeight property to the Tree Grid:
<igx-tree-grid #treeGrid [data]="data" [displayDensity]="density" [rowHeight]="'80px'" width="100%"
height="550px" [allowFiltering]="true">
..............
</igx-tree-grid>
