Addons, Extensions (SlickGrid controls,plugins) - ghiscoding/aurelia-slickgrid GitHub Wiki

updated for version 4.x

Description

SlickGrid, the core library, has multiple controls and plugins that can be added to SlickGrid to provide more capabilities. They are really addons that can be added and there are a few (Column Picker, Header Menu, Grid Menu, Draggable Grouping, Row Detail, ...). Within Aurelia-Slickgrid you can add them just be enabling certain flags (enableColumnPicker, enableGridMenu, ...). All of these SlickGrid controls/plugins have dedicated SlickGrid classes (e.g. new SlickRowDetail()) and so each addon is being instantiated internally by Aurelia-Slickgrid, typically you don't really need to know or use these instances but in some cases you might, so just read more below.

The wordings

Addon, Controls, Plugins, Extensions... this is all confusing, what is what? So to know exactly what is what, I decided to use the following wordings

• controls are extra SlickGrid addon like: Column Picker, Grid Menu (the full list is here)
• plugins are extra SlickGrid addon like: Cell Menu, Header Menu, Grid Menu, Draggable Grouping, Row Detail, ... (the full list is here)
• addon is what I decided to represent as being both controls and plugins together
• extension is what I decided to represent as the class that I created in Aurelia-Slickgrid that will instantiate the addon
  • for example the RowDetailViewExtension will internally instantiate the SlickGrid addon via addonInstance = new SlickRowDetail()

How to get the Addon instance?

Sometime you maybe want to use some function of the addon, for example if we use the Row Detail in Aurelia-Slickgrid, we enable the flag enableRowDetailView: true (which internally will call new SlickRowDetail()) and we pass a few options through the rowDetailView grid options... but what if we want to collapse all the rows? Aurelia-Slickgrid doesn't expose that directly but what you can do is get the addon instance and call the collapseAll() from it.

We can get the addon instance in 3 different ways, you choose whichever is easier for you (we'll demo with the Row Detail addon). The Option 1 or Option 3 are probably the best way of getting the instance.

1. use onExtensionRegistered from the rowDetailView grid options
2. use the (on-aurelia-grid-created) and then use getExtensionInstanceByName()
3. use the (on-aurelia-grid-created) and reference the addon instance via the extensions.[addonName].instance

Option 1. onExtensionRegistered

Component

export class MyComponent {
  rowDetailInstance: SlickRowDetailView;
  columnDefinitions: Column[];

  initGrid() {
    this.gridOptions = {
      enableRowDetailView: true,
      rowDetailView: {
        // ... other options
        onExtensionRegistered: (addon) => this.rowDetailInstance = addon,
      }
    };
  }

  closeAllRowDetail() {
    if (this.rowDetailInstance) {
      this.rowDetailInstance.collapseAll();
    }
  }
}

Option 2. on-aurelia-grid-created with getExtensionInstanceByName()

View

<aurelia-slickgrid
      grid-id="grid1"
      column-definitions.bind="columnDefinitions"
      grid-options.bind="gridOptions"
      dataset.bind="dataset"
      on-aurelia-grid-created.delegate="aureliaGridReady($event.detail)">
</aurelia-slickgrid>

Component

export class MyComponent {
  rowDetailInstance: SlickRowDetailView;
  aureliaGrid: AureliaGridInstance;
  columnDefinitions: Column[];

  aureliaGridReady(aureliaGrid: AureliaGridInstance) {
    this.aureliaGrid= aureliaGrid;
    this.rowDetailInstance = aureliaGrid.extensionService.getExtensionInstanceByName(ExtensionName.rowDetailView);
  }

  initGrid() {
    this.gridOptions = {
      enableRowDetailView: true,
      rowDetailView: {
        // ... other options
      }
    };
  }

  closeAllRowDetail() {
    if (this.rowDetailInstance) {
      this.rowDetailInstance.collapseAll();
    }
  }
}

Option 3. on-aurelia-grid-created with extensions.[addonName].instance

View

<aurelia-slickgrid
      grid-id="grid1"
      column-definitions.bind="columnDefinitions"
      grid-options.bind="gridOptions"
      dataset.bind="dataset"
      on-aurelia-grid-created.delegate="aureliaGridReady($event.detail)">
</aurelia-slickgrid>

Component

export class MyComponent {
  rowDetailInstance: SlickRowDetailView;
  aureliaGrid: AureliaGridInstance;
  columnDefinitions: Column[];

  aureliaGridReady(aureliaGrid: AureliaGridInstance) {
    this.aureliaGrid = aureliaGrid;
    this.rowDetailInstance = aureliaGrid.extensions.rowDetailView.instance;
  }

  initGrid() {
    this.gridOptions = {
      enableRowDetailView: true,
      rowDetailView: {
        // ... other options
      }
    };
  }

  closeAllRowDetail() {
    if (this.rowDetailInstance) {
      this.rowDetailInstance.collapseAll();
    }
  }
}