visibility.md

Demo

Demo / Demo Component

Description

For column visibility, you can define the hidden property in your column definitions to initially hide some columns. You could also toggle the hidden property at any point in time (see below for more code usage).

initially hidden columns

Let's start by demoing how to initially hide some column(s) by using the hidden property.

define columns

this.columns = [
  { id: 'firstName', field: 'firstName', name: 'First Name' },
  { id: 'lastName', field: 'lastName', name: 'Last Name' },
  { id: 'age', field: 'age', name: 'Age', hidden: true }, // column initially hidden
];

change visibility afterward

At any point in time, you could toggle the hidden property by using grid.updateColumnById() and make sure to also call grid.updateColumns() so that the UI is also updated.

define columns

export class MyExample {
  columns: Column[];

  defineGrid() {
    this.columns = [
      { id: 'firstName', field: 'firstName', name: 'First Name' },
      { id: 'lastName', field: 'lastName', name: 'Last Name' },
      { id: 'age', field: 'age', name: 'Age' },
    ];
  }

  // toggle column visibility & then update columns to show changes in the grid
  toggleColumnVisibility(columnName: string) {
    this.sgb.slickGrid.updateColumnById(columnName, { hidden: true });
    this.sgb.slickGrid.updateColumns();
  }

  // get all columns (including `hidden` columns)
  getAllColumns() {
    this.sgb.slickGrid.getColumns();
  }

  // get only the visible columns
  getOnlyVisibleColumns() {
    this.sgb.slickGrid.getVisibleColumns();
  }
}