ag-grid-aurelia-plugin 31.3.8 → 31.3.11

package/README.md

@@ -1,49 +1,54 @@
 ag-Grid Aurelia Component
 ==============
 
-This project contains the Aurelia Component for use with ag-Grid.
+This project contains the Aurelia Component for use with ag-Grid Community Edition.
 
 Usage
 ==============
 
-Please refer to www.ag-grid.com for full documentation on ag-Grid and Aurelia integration. Also take a look a the provided examples at https://github.com/ag-grid/ag-grid-aurelia-example.
+Please refer to www.ag-grid.com for full documentation on ag-Grid and Aurelia integration. Also take a look a the provided examples below.
 
 Frameworks Supported
 ====================
-Framework specific Getting Started guides:
-[Angular 1](https://www.ag-grid.com/best-angularjs-data-grid/) | [Angular 2](https://www.ag-grid.com/best-angular-2-data-grid/) | [Aurelia](https://www.ag-grid.com/best-aurelia-data-grid/)
-[Javascript](https://www.ag-grid.com/best-javascript-data-grid/) | [React](https://www.ag-grid.com/best-react-data-grid/) | [TypeScript](https://www.ag-grid.com/ag-grid-typescript-webpack-2/)
-[VueJS](https://www.ag-grid.com/best-vuejs-data-grid/) | [Web Components](https://www.ag-grid.com/best-web-component-data-grid/)
+Migration and Getting Started guides:
+
+[Migration Guide](https://www.ag-grid.com/javascript-data-grid/migration/)
+
+[API Reference](https://www.ag-grid.com/javascript-data-grid/reference/)
+
+[Docs](https://www.ag-grid.com/javascript-data-grid/getting-started/)
 
 In your main entry.
 ```
 aurelia.use
     .standardConfiguration()
-    .plugin('ag-grid-aurelia');
+    .plugin('ag-grid-aurelia-plugin');
 ```
 
 In your view model
 ```
-import {GridOptions} from 'ag-grid';
 export class MyGridPage {
-
-    public gridOptions:GridOptions;
-
-    constructor() {
-        this.gridOptions = <GridOptions>{};
-        this.gridOptions.rowData = [{id: 1, name: 'Shane'}, {id: 2, name: 'Sean'}];
+    gridOptions = {
+        onGridReady: params => {
+            console.log('Grid is ready!!');
+            console.log('1st col field = ' + this.gridOptions.columnDefs[0].field);
+            this.api = params.api;
+        }   
     }
-
-    public onGridReady(){
-        console.log('Grid is ready!!');
-        console.log('1st col field = ' + this.gridOptions.columnDefs[0].field);
+    
+    bind() {
+        this.api.setGridOption('rowData', [{id: 1, name: 'Shane'}, {id: 2, name: 'Sean'}]);
     }
 
-    public onIdClicked(row){
+    onIdClicked(row){
         console.log('id clicked ' + row.id);
     }
-}
-
+    
+    onGridReady() {
+        console.log('Grid is ready!!');
+        console.log('1st col field = ' + this.gridOptions.columnDefs[0].field);
+    }
+}  
 
 ```
 In your view template.  Here we are adding columns using markup. ColumnDefs can be added from your view model if you wish.
@@ -53,6 +58,7 @@ In your view template.  Here we are adding columns using markup. ColumnDefs can
       <ag-grid-aurelia grid-options.bind="gridOptions" class="ag-material"
                        row-height.bind="48"
                        grid-ready.call="onGridReady()">
+
         <ag-grid-column header-name="My Group Column">
           <ag-grid-column header-name="Id" field="id">
               <ag-cell-template>
@@ -62,7 +68,6 @@ In your view template.  Here we are adding columns using markup. ColumnDefs can
           <ag-grid-column header-name="Name" field="name" >
           </ag-grid-column>
         </ag-grid-column>
-
       </ag-grid-aurelia>
     </div>
 
@@ -74,10 +79,8 @@ Building
 
 To build:
 - npm install
-- npm install gulp -g
-- npm install aurelia-framework
-- npm install ag-grid
-- (or: npm install aurelia-framework@1.0.x && npm install ag-grid@13.0.2)
-
 - npm run build
-# ag-grid-aurelia1
+
+To develop:
+- npm install
+- npm run watch

package/lib/agGridAurelia.d.ts

@@ -1,33 +1,33 @@
-// ag-grid-aurelia-plugin v31.3.8
-import type { GridApi, GridOptions } from "ag-grid-community";
-import { ComponentAttached, ComponentDetached, Container, TaskQueue, ViewResources } from "aurelia-framework";
-import { AureliaFrameworkFactory } from "./aureliaFrameworkFactory";
-import { AgGridColumn } from "./agGridColumn";
-import { AgDateTemplate, AgFullWidthRowTemplate } from './agTemplate';
-import { AureliaFrameworkComponentWrapper } from "./aureliaFrameworkComponentWrapper";
-export declare class AgGridAurelia implements ComponentAttached, ComponentDetached {
-    private taskQueue;
-    private auFrameworkFactory;
-    private container;
-    private viewResources;
-    private aureliaFrameworkComponentWrapper;
-    private _nativeElement;
-    private _initialised;
-    private _destroyed;
-    gridOptions: GridOptions;
-    context: any;
-    private gridParams;
-    api: GridApi;
-    columns: AgGridColumn[];
-    fullWidthRowTemplate: AgFullWidthRowTemplate;
-    dateTemplate: AgDateTemplate;
-    constructor(element: Element, taskQueue: TaskQueue, auFrameworkFactory: AureliaFrameworkFactory, container: Container, viewResources: ViewResources, aureliaFrameworkComponentWrapper: AureliaFrameworkComponentWrapper);
-    attached(): void;
-    initGrid(): void;
-    /**
-     * Called by Aurelia whenever a bound property changes
-     */
-    propertyChanged(propertyName: string, newValue: any, oldValue: any): void;
-    detached(): void;
-    private globalEventListener;
-}
+// ag-grid-aurelia-plugin v31.3.10
+import type { GridApi, GridOptions } from "ag-grid-community";
+import { ComponentAttached, ComponentDetached, Container, TaskQueue, ViewResources } from "aurelia-framework";
+import { AureliaFrameworkFactory } from "./aureliaFrameworkFactory";
+import { AgGridColumn } from "./agGridColumn";
+import { AgDateTemplate, AgFullWidthRowTemplate } from './agTemplate';
+import { AureliaFrameworkComponentWrapper } from "./aureliaFrameworkComponentWrapper";
+export declare class AgGridAurelia implements ComponentAttached, ComponentDetached {
+    private taskQueue;
+    private auFrameworkFactory;
+    private container;
+    private viewResources;
+    private aureliaFrameworkComponentWrapper;
+    private _nativeElement;
+    private _initialised;
+    private _destroyed;
+    gridOptions: GridOptions;
+    context: any;
+    private gridParams;
+    api: GridApi;
+    columns: AgGridColumn[];
+    fullWidthRowTemplate: AgFullWidthRowTemplate;
+    dateTemplate: AgDateTemplate;
+    constructor(element: Element, taskQueue: TaskQueue, auFrameworkFactory: AureliaFrameworkFactory, container: Container, viewResources: ViewResources, aureliaFrameworkComponentWrapper: AureliaFrameworkComponentWrapper);
+    attached(): void;
+    initGrid(): void;
+    /**
+     * Called by Aurelia whenever a bound property changes
+     */
+    propertyChanged(propertyName: string, newValue: any, oldValue: any): void;
+    detached(): void;
+    private globalEventListener;
+}

package/lib/agGridAurelia.js

@@ -1,163 +1,163 @@
-// ag-grid-aurelia-plugin v31.3.8
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-import { autoinject, bindable, child, children, Container, customElement, inlineView, TaskQueue, ViewResources } from "aurelia-framework";
-import { ComponentUtil, createGrid } from "ag-grid-community";
-import { AureliaFrameworkFactory } from "./aureliaFrameworkFactory";
-import { generateBindables } from "./agUtils";
-import { AgDateTemplate, AgFullWidthRowTemplate } from './agTemplate';
-import { AureliaFrameworkComponentWrapper } from "./aureliaFrameworkComponentWrapper";
-let AgGridAurelia = class AgGridAurelia {
-    taskQueue;
-    auFrameworkFactory;
-    container;
-    viewResources;
-    aureliaFrameworkComponentWrapper;
-    // not intended for user to interact with. so putting _ in so if user gets reference
-    // to this object, they kind'a know it's not part of the agreed interface
-    _nativeElement;
-    _initialised = false;
-    _destroyed = false;
-    gridOptions;
-    context;
-    gridParams;
-    // making these public, so they are accessible to people using the aurelia component references
-    api;
-    columns = [];
-    fullWidthRowTemplate;
-    dateTemplate;
-    constructor(element, taskQueue, auFrameworkFactory, container, viewResources, aureliaFrameworkComponentWrapper) {
-        this.taskQueue = taskQueue;
-        this.auFrameworkFactory = auFrameworkFactory;
-        this.container = container;
-        this.viewResources = viewResources;
-        this.aureliaFrameworkComponentWrapper = aureliaFrameworkComponentWrapper;
-        this._nativeElement = element;
-        // create all the events generically. this is done generically so that
-        // if the list of grid events change, we don't need to change this code.
-        ComponentUtil.EVENTS.forEach((eventName) => {
-            //create an empty event
-            this[eventName] = () => {
-            };
-        });
-    }
-    attached() {
-        // initialize the grid in the queue
-        // because of bug in @children
-        // https://github.com/aurelia/templating/issues/403
-        this.taskQueue.queueTask(this.initGrid.bind(this));
-    }
-    initGrid() {
-        this._initialised = false;
-        this._destroyed = false;
-        this.auFrameworkFactory.setContainer(this.container);
-        this.auFrameworkFactory.setViewResources(this.viewResources);
-        this.aureliaFrameworkComponentWrapper.setContainer(this.container);
-        this.aureliaFrameworkComponentWrapper.setViewResources(this.viewResources);
-        this.gridOptions = ComponentUtil.combineAttributesAndGridOptions(this.gridOptions, this);
-        this.gridParams = {
-            globalEventListener: this.globalEventListener.bind(this),
-            frameworkFactory: this.auFrameworkFactory,
-            seedBeanInstances: {
-                frameworkComponentWrapper: this.aureliaFrameworkComponentWrapper
-            }
-        };
-        if (this.columns && this.columns.length > 0) {
-            this.gridOptions.columnDefs = this.columns
-                .map((column) => {
-                return column.toColDef();
-            });
-        }
-        if (this.fullWidthRowTemplate) {
-            this.gridOptions.fullWidthCellRenderer =
-                { template: this.fullWidthRowTemplate.template };
-        }
-        if (this.dateTemplate) {
-            this.gridOptions.dataTypeDefinitions = {
-                date: {
-                    baseDataType: 'date',
-                    extendsDataType: 'date',
-                    valueFormatter: () => this.dateTemplate.template
-                }
-            };
-        }
-        this.api = createGrid(this._nativeElement, this.gridOptions, this.gridParams);
-        this._initialised = true;
-    }
-    /**
-     * Called by Aurelia whenever a bound property changes
-     */
-    propertyChanged(propertyName, newValue, oldValue) {
-        // emulate an Angular2 SimpleChanges Object
-        let changes = {};
-        changes[propertyName] = { currentValue: newValue, previousValue: oldValue };
-        if (this._initialised) {
-            ComponentUtil.processOnChange(changes, this.api);
-        }
-    }
-    detached() {
-        if (this._initialised) {
-            // need to do this before the destroy, so we know not to emit any events
-            // while tearing down the grid.
-            this._destroyed = true;
-            this.api.destroy();
-        }
-    }
-    globalEventListener(eventType, event) {
-        // if we are tearing down, don't emit events
-        if (this._destroyed) {
-            return;
-        }
-        // generically look up the eventType
-        let emitter = this[eventType];
-        if (emitter) {
-            emitter(event);
-        }
-        else {
-            console.log('ag-Grid-aurelia: could not find EventEmitter: ' + eventType);
-        }
-    }
-};
-__decorate([
-    bindable(),
-    __metadata("design:type", Object)
-], AgGridAurelia.prototype, "gridOptions", void 0);
-__decorate([
-    bindable(),
-    __metadata("design:type", Object)
-], AgGridAurelia.prototype, "context", void 0);
-__decorate([
-    children('ag-grid-column'),
-    __metadata("design:type", Array)
-], AgGridAurelia.prototype, "columns", void 0);
-__decorate([
-    child('ag-full-width-row-template'),
-    __metadata("design:type", AgFullWidthRowTemplate)
-], AgGridAurelia.prototype, "fullWidthRowTemplate", void 0);
-__decorate([
-    child('ag-date-template'),
-    __metadata("design:type", AgDateTemplate)
-], AgGridAurelia.prototype, "dateTemplate", void 0);
-AgGridAurelia = __decorate([
-    customElement('ag-grid-aurelia'),
-    generateBindables(ComponentUtil.ALL_PROPERTIES.filter((property) => property !== 'gridOptions')),
-    generateBindables(ComponentUtil.EVENTS)
-    // <slot> is required for @children to work.  https://github.com/aurelia/templating/issues/451#issuecomment-254206622
-    ,
-    inlineView(`<template><slot></slot></template>`),
-    autoinject(),
-    __metadata("design:paramtypes", [Element,
-        TaskQueue,
-        AureliaFrameworkFactory,
-        Container,
-        ViewResources,
-        AureliaFrameworkComponentWrapper])
-], AgGridAurelia);
-export { AgGridAurelia };
+// ag-grid-aurelia-plugin v31.3.10
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { autoinject, bindable, child, children, Container, customElement, inlineView, TaskQueue, ViewResources, } from "aurelia-framework";
+import { ComponentUtil, createGrid } from "ag-grid-community-v31";
+import { AureliaFrameworkFactory } from "./aureliaFrameworkFactory";
+import { generateBindables } from "./agUtils";
+import { AgDateTemplate, AgFullWidthRowTemplate } from './agTemplate';
+import { AureliaFrameworkComponentWrapper } from "./aureliaFrameworkComponentWrapper";
+let AgGridAurelia = class AgGridAurelia {
+    taskQueue;
+    auFrameworkFactory;
+    container;
+    viewResources;
+    aureliaFrameworkComponentWrapper;
+    // not intended for user to interact with. so putting _ in so if user gets reference
+    // to this object, they kind'a know it's not part of the agreed interface
+    _nativeElement;
+    _initialised = false;
+    _destroyed = false;
+    gridOptions;
+    context;
+    gridParams;
+    // making these public, so they are accessible to people using the aurelia component references
+    api;
+    columns = [];
+    fullWidthRowTemplate;
+    dateTemplate;
+    constructor(element, taskQueue, auFrameworkFactory, container, viewResources, aureliaFrameworkComponentWrapper) {
+        this.taskQueue = taskQueue;
+        this.auFrameworkFactory = auFrameworkFactory;
+        this.container = container;
+        this.viewResources = viewResources;
+        this.aureliaFrameworkComponentWrapper = aureliaFrameworkComponentWrapper;
+        this._nativeElement = element;
+        // create all the events generically. this is done generically so that
+        // if the list of grid events change, we don't need to change this code.
+        ComponentUtil.EVENTS.forEach((eventName) => {
+            //create an empty event
+            this[eventName] = () => {
+            };
+        });
+    }
+    attached() {
+        // initialize the grid in the queue
+        // because of bug in @children
+        // https://github.com/aurelia/templating/issues/403
+        this.taskQueue.queueTask(this.initGrid.bind(this));
+    }
+    initGrid() {
+        this._initialised = false;
+        this._destroyed = false;
+        this.auFrameworkFactory.setContainer(this.container);
+        this.auFrameworkFactory.setViewResources(this.viewResources);
+        this.aureliaFrameworkComponentWrapper.setContainer(this.container);
+        this.aureliaFrameworkComponentWrapper.setViewResources(this.viewResources);
+        this.gridOptions = ComponentUtil.combineAttributesAndGridOptions(this.gridOptions, this);
+        this.gridParams = {
+            globalEventListener: this.globalEventListener.bind(this),
+            frameworkFactory: this.auFrameworkFactory,
+            seedBeanInstances: {
+                frameworkComponentWrapper: this.aureliaFrameworkComponentWrapper
+            }
+        };
+        if (this.columns && this.columns.length > 0) {
+            this.gridOptions.columnDefs = this.columns
+                .map((column) => {
+                return column.toColDef();
+            });
+        }
+        if (this.fullWidthRowTemplate) {
+            this.gridOptions.fullWidthCellRenderer =
+                { template: this.fullWidthRowTemplate.template };
+        }
+        if (this.dateTemplate) {
+            this.gridOptions.dataTypeDefinitions = {
+                date: {
+                    baseDataType: 'date',
+                    extendsDataType: 'date',
+                    valueFormatter: () => this.dateTemplate.template
+                }
+            };
+        }
+        this.api = createGrid(this._nativeElement, this.gridOptions, this.gridParams);
+        this._initialised = true;
+    }
+    /**
+     * Called by Aurelia whenever a bound property changes
+     */
+    propertyChanged(propertyName, newValue, oldValue) {
+        // emulate an Angular2 SimpleChanges Object
+        let changes = {};
+        changes[propertyName] = { currentValue: newValue, previousValue: oldValue };
+        if (this._initialised) {
+            ComponentUtil.processOnChange(changes, this.api);
+        }
+    }
+    detached() {
+        if (this._initialised) {
+            // need to do this before the destroy, so we know not to emit any events
+            // while tearing down the grid.
+            this._destroyed = true;
+            this.api.destroy();
+        }
+    }
+    globalEventListener(eventType, event) {
+        // if we are tearing down, don't emit events
+        if (this._destroyed) {
+            return;
+        }
+        // generically look up the eventType
+        let emitter = this[eventType];
+        if (emitter) {
+            emitter(event);
+        }
+        else {
+            console.log('ag-Grid-aurelia: could not find EventEmitter: ' + eventType);
+        }
+    }
+};
+__decorate([
+    bindable(),
+    __metadata("design:type", Object)
+], AgGridAurelia.prototype, "gridOptions", void 0);
+__decorate([
+    bindable(),
+    __metadata("design:type", Object)
+], AgGridAurelia.prototype, "context", void 0);
+__decorate([
+    children('ag-grid-column'),
+    __metadata("design:type", Array)
+], AgGridAurelia.prototype, "columns", void 0);
+__decorate([
+    child('ag-full-width-row-template'),
+    __metadata("design:type", AgFullWidthRowTemplate)
+], AgGridAurelia.prototype, "fullWidthRowTemplate", void 0);
+__decorate([
+    child('ag-date-template'),
+    __metadata("design:type", AgDateTemplate)
+], AgGridAurelia.prototype, "dateTemplate", void 0);
+AgGridAurelia = __decorate([
+    customElement('ag-grid-aurelia-m3'),
+    generateBindables(ComponentUtil.ALL_PROPERTIES.filter((property) => property !== 'gridOptions')),
+    generateBindables(ComponentUtil.EVENTS)
+    // <slot> is required for @children to work.  https://github.com/aurelia/templating/issues/451#issuecomment-254206622
+    ,
+    inlineView(`<template><slot></slot></template>`),
+    autoinject(),
+    __metadata("design:paramtypes", [Element,
+        TaskQueue,
+        AureliaFrameworkFactory,
+        Container,
+        ViewResources,
+        AureliaFrameworkComponentWrapper])
+], AgGridAurelia);
+export { AgGridAurelia };

package/lib/agGridColumn.d.ts

@@ -1,18 +1,18 @@
-// ag-grid-aurelia-plugin v31.3.8
-import { ColDef } from "ag-grid-community";
-import { AgCellTemplate, AgEditorTemplate, AgFilterTemplate, AgHeaderGroupTemplate, AgHeaderTemplate, AgPinnedRowTemplate } from "./agTemplate";
-export declare class AgGridColumn {
-    private mappedColumnProperties;
-    childColumns: AgGridColumn[];
-    cellTemplate: AgCellTemplate;
-    editorTemplate: AgEditorTemplate;
-    filterTemplate: AgFilterTemplate;
-    headerTemplate: AgHeaderTemplate;
-    headerGroupTemplate: AgHeaderGroupTemplate;
-    pinnedRowTemplate: AgPinnedRowTemplate;
-    constructor();
-    hasChildColumns(): boolean;
-    toColDef(): ColDef;
-    private static getChildColDefs;
-    private createColDefFromGridColumn;
-}
+// ag-grid-aurelia-plugin v31.3.10
+import { ColDef } from "ag-grid-community-v31";
+import { AgCellTemplate, AgEditorTemplate, AgFilterTemplate, AgHeaderGroupTemplate, AgHeaderTemplate, AgPinnedRowTemplate } from "./agTemplate";
+export declare class AgGridColumn {
+    private mappedColumnProperties;
+    childColumns: AgGridColumn[];
+    cellTemplate: AgCellTemplate;
+    editorTemplate: AgEditorTemplate;
+    filterTemplate: AgFilterTemplate;
+    headerTemplate: AgHeaderTemplate;
+    headerGroupTemplate: AgHeaderGroupTemplate;
+    pinnedRowTemplate: AgPinnedRowTemplate;
+    constructor();
+    hasChildColumns(): boolean;
+    toColDef(): ColDef;
+    private static getChildColDefs;
+    private createColDefFromGridColumn;
+}