Merge pull request #3881 from PaulL1/fixes

PaulL1 · PaulL1 · commit 1ab77df7c423 · 2015-06-27T16:10:24.000+12:00
Export pdf in IE, extend tutorials to link to API doco
diff --git a/misc/tutorial/200_features.ngdoc b/misc/tutorial/200_features.ngdoc
@@ -12,4 +12,7 @@ angular.module('yourApp', ['ui.grid', 'ui.grid.feature1', 'ui.grid.feature2']);
 Each feature directive must also be included in alongside the ui-grid directive.  This allows you to have many grids in an application and enable certain features for each grid instance.
 <pre>
 <div ui-grid="gridOptions" class="grid" ui-grid-feature1 ui-grid-feature2></div>
-</pre>
+</pre>
+
+In general the feature documentation can be found in the api section, each feature will typically have a
+`gridOptions` section, it may have a `columnDef` section, and it may have a `publicApi` section.
diff --git a/misc/tutorial/201_editable.ngdoc b/misc/tutorial/201_editable.ngdoc
@@ -5,6 +5,12 @@
 The ui.grid.edit feature allows inline editing of grid data.  To enable, you must include the `'ui.grid.edit'` module
 and you must include the `ui-grid-edit` directive on your grid element.
 
+Documentation for the edit feature is provided in the api documentation, in particular:
+
+- {@link api/ui.grid.edit.api:ColumnDef columnDef}
+- {@link api/ui.grid.edit.api:GridOptions gridOptions}
+- {@link api/ui.grid.edit.api:PublicApi publicApi}
+
 You can use the `enableCellEdit` options in your column definitions to allow a column to be editable.
 
 Editing is invoked via double-click, f2, or start typing any non-navigable key. Cell editing ends on tab, enter or esc (cancel)
diff --git a/misc/tutorial/202_cellnav.ngdoc b/misc/tutorial/202_cellnav.ngdoc
@@ -5,6 +5,12 @@
 This grid example uses the ui-grid-cellNav directive to add cell navigation. To enable, you must include the 'ui.grid.cellNav' 
 module and you must include the ui-grid-cellNav directive on your grid element.
 
+Documentation for the cellNav feature is provided in the api documentation, in particular:
+
+- {@link api/ui.grid.cellNav.api:ColumnDef columnDef}
+- {@link api/ui.grid.cellNav.api:GridOptions gridOptions}
+- {@link api/ui.grid.cellNav.api:PublicApi publicApi}
+
 CellNav allows you to navigate around the grid using the arrow keys, pg-down and pg-up, enter (moves down),
 shift-enter (moves up), tab (moves right) and shift-tab (moves left).  When combined with the editable feature, the 
 left-right arrow keys will be subsumed when in "deep edit" mode, allowing you to move around within the text you're editing.  
diff --git a/misc/tutorial/203_pinning.ngdoc b/misc/tutorial/203_pinning.ngdoc
@@ -4,6 +4,12 @@
 
 The pinning feature allows the user to pin a column to left or right. To enable, you must include the 'ui.grid.pinning' module and you must include the ui-grid-pinning directive on your grid element.
 
+Documentation for the pinning feature is provided in the api documentation, in particular:
+
+- {@link api/ui.grid.pinning.api:ColumnDef columnDef}
+- {@link api/ui.grid.pinning.api:GridOptions gridOptions}
+- {@link api/ui.grid.pinning.api:PublicApi publicApi}
+
 It is also possible to disable pinning on column level. Note the 'id' column definition in the example below.
 
 @example
diff --git a/misc/tutorial/204_column_resizing.ngdoc b/misc/tutorial/204_column_resizing.ngdoc
@@ -7,6 +7,12 @@ The Resize Columns feature allows each column to be resized.
 To enable, you must include the 'ui.grid.resizeColumns' module and you must include the ui-grid-resize-columns directive 
 on your grid element.
 
+Documentation for the resize column feature is provided in the api documentation, in particular:
+
+- {@link api/ui.grid.resizeColumns.api:ColumnDef columnDef}
+- {@link api/ui.grid.resizeColumns.api:GridOptions gridOptions}
+- {@link api/ui.grid.resizeColumns.api:PublicApi publicApi}
+
 You can set individual columns to not be resizeable, if you do this it is recommended that those columns have a fixed
 pixel width - otherwise they may get automatically resized to fill the remaining space if other columns are reduced in size,
 and there will be no way to reduce their width again.
diff --git a/misc/tutorial/205_row_editable.ngdoc b/misc/tutorial/205_row_editable.ngdoc
@@ -7,7 +7,12 @@ with that data saved "row at a time."  This feature attempts to give a user an e
 to a spreadsheet - in that they can edit whichever fields they wish, and the feature will seek to
 save the data "row at a time".  To the extent that the data doesn't generate errors, from a user
 perspective the saving is almost invisible - rows occassionally go grey (saving) and can't be edited whilst
-grey, but otherwise the user edits as if the data were local.  
+grey, but otherwise the user edits as if the data were local.
+
+Documentation for the rowEdit feature is provided in the api documentation, in particular:
+
+- {@link api/ui.grid.rowEdit.api:GridOptions gridOptions}
+- {@link api/ui.grid.rowEdit.api:PublicApi publicApi}
 
 Each row is in one of four states at any point in time:
 
diff --git a/misc/tutorial/206_exporting_data.ngdoc b/misc/tutorial/206_exporting_data.ngdoc
@@ -1,5 +1,5 @@
 @ngdoc overview
-@name Tutorial: 206 Exporting Data With Native UI
+@name Tutorial: 206 Exporting Data
 @description The exporter feature allows data to be exported from the grid in 
 csv or pdf format.  The exporter can export all data, visible data or selected data.
 
@@ -9,7 +9,11 @@ directive on your grid.  If you want to export as PDF you need to have installed
 available through:
 <pre>  bower install pdfmake  </pre>
 
-The options and API for exporter can be found at {@link api/ui.grid.exporter ui.grid.exporter}.
+The options and API for exporter can be found at {@link api/ui.grid.exporter ui.grid.exporter}, and
+
+- {@link api/ui.grid.exporter.api:ColumnDef columnDef}
+- {@link api/ui.grid.exporter.api:GridOptions gridOptions}
+- {@link api/ui.grid.exporter.api:PublicApi publicApi}
 
 The exporter adds menu items to the grid menu, to use the native UI you need to enable
 the grid menu using the gridOption `enableGridMenu`
diff --git a/misc/tutorial/207_importing_data.ngdoc b/misc/tutorial/207_importing_data.ngdoc
@@ -1,12 +1,17 @@
 @ngdoc overview
-@name Tutorial: 207 Importing Data With Native UI
+@name Tutorial: 207 Importing Data
 @description The importer feature allows data to be imported into the grid in 
 csv or json format.  The importer can use the native grid menu, or can accept a 
 file from a custom file picker implemented by the user.
 
 The importer imports files in json or csv format, with the ability to be extended
 to other file formats if demand exists.
 
+Documentation for the importer feature is provided in the api documentation, in particular:
+
+- {@link api/ui.grid.importer.api:GridOptions gridOptions}
+- {@link api/ui.grid.importer.api:PublicApi publicApi}
+
 For json format files the received elements are assumed to match the column.field 
 attributes in your columnDefs, and are loaded into the provided entity.  
 
diff --git a/misc/tutorial/208_save_state.ngdoc b/misc/tutorial/208_save_state.ngdoc
@@ -1,5 +1,5 @@
 @ngdoc overview
-@name Tutorial: 208 Saving and restoring the state of the grid
+@name Tutorial: 208 Save and restore state
 @description The save state feature allows you to save the current look of the grid
 and restore it upon returning to the grid.
 
@@ -9,6 +9,11 @@ might adjust their grid to look as they wish, and then navigate to another page.
 the user returns to the page with the grid, they might expect it to look like it
 did when they left.  The save state feature permits this.
 
+Documentation for the saveState feature is provided in the api documentation, in particular:
+
+- {@link api/ui.grid.saveState.api:GridOptions gridOptions}
+- {@link api/ui.grid.saveState.api:PublicApi publicApi}
+
 There are two core methods:
 
 - save, which packages the current grid state into an object which the calling application
diff --git a/misc/tutorial/209_grouping.ngdoc b/misc/tutorial/209_grouping.ngdoc
@@ -5,7 +5,7 @@ values in specific columns, providing an effect similar in some ways to an Excel
 Columns that aren't grouped by can be aggregated, providing for example a running count
 of the number of rows in each group.
 
-_**BREAKING CHANGES IN RC22 for grouping.  Prior to RC22 grouping was a standalone feature, with RC22
+_** BREAKING CHANGES IN RC22 for grouping.  Prior to RC22 grouping was a standalone feature, with RC22
 a number of things have changed as grouping and treeView move to a shared code base.  In particular:
 - methods such as expandAll are now on treeBase, not on grouping
 - aggregations move from being col.grouping.aggregation to col.treeAggregation
@@ -18,6 +18,15 @@ a number of things have changed as grouping and treeView move to a shared code b
 - groupingRowHeaderAlwaysVisible is now treeRowHeaderAlwaysVisible, and default has changed to true
 **_
 
+Documentation for the grouping feature is provided in the api documentation, both under
+grouping itself, and shared functions in the treeBase documentation.  In particular:
+
+- {@link api/ui.grid.grouping.api:ColumnDef grouping columnDef} and {@link api/ui.grid.treeBase.api:ColumnDef treeBase columnDef}
+- {@link api/ui.grid.grouping.api:GridOptions grouping gridOptions} and {@link api/ui.grid.treeBase.api:GridOptions treeBase gridOptions}
+- {@link api/ui.grid.grouping.api:PublicApi grouping publicApi} and {@link api/ui.grid.treeBase.api:PublicApi treeBase publicApi}
+
+The tree structure itself is documented at {@link api/ui.grid.treeBase.grid:treeBase treeBase}.
+
 Grouping can be set programmatically by using the columnDef option `grouping: { groupPriority: 0 }`,
 or for aggregations on a column by setting `treeAggregation: {type: uiGridGroupingConstants.aggregation.COUNT}`. 
 
diff --git a/misc/tutorial/210_selection.ngdoc b/misc/tutorial/210_selection.ngdoc
@@ -5,6 +5,11 @@
 This grid example uses the ui-grid-selection directive to row selection. To enable, you must include the 'ui.grid.selection' 
 module and you must include the ui-grid-selection directive on your grid element.
 
+Documentation for the selection feature is provided in the api documentation, in particular:
+
+- {@link api/ui.grid.selection.api:GridOptions gridOptions}
+- {@link api/ui.grid.selection.api:PublicApi publicApi}
+
 Uses the gridOptions.onRegisterApi callback to register the rowSelectionChanged event and log when the row is selected.
 By default the selection feature will divide selection changes into batch events and single events, there are
 two different events provided in the api.  By setting `enableSelectionBatchEvent: false` you can cause it to 
diff --git a/misc/tutorial/212_infinite_scroll.ngdoc b/misc/tutorial/212_infinite_scroll.ngdoc
@@ -2,7 +2,12 @@
 @name Tutorial: 212 Infinite scroll
 @description
 
-The infinite scroll feature allows the user to lazy load their data to gridOptions.data.  
+The infinite scroll feature allows the user to lazy load their data to gridOptions.data.
+
+Documentation for the infiniteScroll feature is provided in the api documentation, in particular:
+
+- {@link api/ui.grid.infiniteScroll.api:GridOptions gridOptions}
+- {@link api/ui.grid.infiniteScroll.api:PublicAPI publicApi}
 
 Once you reach the top (or bottom) of your real data set, you can notify that no more pages exist
 up (or down), and infinite scroll will stop triggering events in that direction.  You can also
diff --git a/misc/tutorial/214_pagination.ngdoc b/misc/tutorial/214_pagination.ngdoc
@@ -4,6 +4,11 @@
 
 When pagination is enabled, the data is displayed in pages that can be browsed using using the built in pagination selector.
 
+Documentation for the pagination feature is provided in the api documentation, in particular:
+
+- {@link api/ui.grid.pagination.api:GridOptions gridOptions}
+- {@link api/ui.grid.pagination.api:PublicAPI publicApi}
+
 If you wanted server based pagination, you could look at {@link 314_external_pagination the external pagination tutorial} or consider
 using {@link 212_infinite_scroll infinite scroll}, which also retrieves data in pages from the server.
 
diff --git a/misc/tutorial/215_treeView.ngdoc b/misc/tutorial/215_treeView.ngdoc
@@ -8,6 +8,15 @@ of the logic into a treeBase module.  This means that you may need to include th
 in your code, and that some of the events and methods have moved to grid.api.treeBase instead
 of grid.api.treeView_**
 
+Documentation for the treeView feature is provided in the api documentation, both under
+treeView itself, and shared functions in the treeBase documentation.  In particular:
+
+- {@link api/ui.grid.treeBase.api:ColumnDef treeBase columnDef}
+- {@link api/ui.grid.treeView.api:GridOptions treeView gridOptions} and {@link api/ui.grid.treeBase.api:GridOptions treeBase gridOptions}
+- {@link api/ui.grid.treeView.api:PublicApi treeView publicApi} and {@link api/ui.grid.treeBase.api:PublicApi treeBase publicApi}
+
+The tree structure itself is documented at {@link api/ui.grid.treeBase.grid:treeBase treeBase}.
+
 In your data you tell us the nodes by setting the property $$treeLevel on a given row.  Levels
 start at 0 and increase as you move down the tree.
 
diff --git a/misc/tutorial/216_expandable_grid.ngdoc b/misc/tutorial/216_expandable_grid.ngdoc
@@ -4,6 +4,11 @@
 
 Module 'ui.grid.expandable' adds the subgrid feature to grid. To show the subgrid you need to provide following grid option:
 
+Documentation for the expandable feature is provided in the api documentation, in particular:
+
+- {@link api/ui.grid.expandable.api:GridOptions gridOptions}
+- {@link api/ui.grid.expandable.api:PublicApi publicApi}
+
 <pre>
   $scope.gridOptions = {
     //This is the template that will be used to render subgrid.
diff --git a/misc/tutorial/217_column_moving.ngdoc b/misc/tutorial/217_column_moving.ngdoc
@@ -5,6 +5,12 @@
 Feature ui.grid.moveColumns allows moving column to a different position. To enable, you must include the `ui.grid.moveColumns` module
 and you must include the `ui-grid-move-columns` directive on your grid element.
 
+Documentation for the moveColumns feature is provided in the api documentation, in particular:
+
+- {@link api/ui.grid.moveColumns.api:ColumnDef columnDef}
+- {@link api/ui.grid.moveColumns.api:GridOptions gridOptions}
+- {@link api/ui.grid.moveColumns.api:PublicApi publicApi}
+
 By default column moving will be enabled for all the columns of the grid. To disable it for all columns of grid property `enableColumnMoving`
 of grid options can be used. To specifically enable or disable column moving for a specific column property `enableColumnMoving`
 of column definitions can be used.
diff --git a/misc/tutorial/301_editableOnFocus.ngdoc b/misc/tutorial/301_editableOnFocus.ngdoc
@@ -5,7 +5,7 @@
 Combine ui.grid.edit with ui.grid.cellNav, you can enable editing when the cell gets focus.
 grid.options.enableCellEditOnFocus must be set to true.
 <br/>
-See api docs for default navigation keys and how you can override.
+See api docs for both cellNav and edit for default navigation keys and how you can override.
 
 
 @example
diff --git a/misc/tutorial/304_two_grids.ngdoc b/misc/tutorial/304_two_grids.ngdoc
@@ -1,5 +1,5 @@
 @ngdoc overview
-@name Tutorial: 211 Two grids on a page
+@name Tutorial: 304 Two grids on a page
 @description
 
 This grid example puts two grids on the same page, and demonstrates that they are isolated from
@@ -16,7 +16,7 @@ each other.
           $scope.gridApi = gridApi;
         }
       };
-      
+
       $scope.scrollTo = function( rowIndex, colIndex ) {
         $scope.gridApi.core.scrollTo( $scope.gridOptions.data[rowIndex], $scope.gridOptions.columnDefs[colIndex]);
       };
@@ -63,10 +63,10 @@ each other.
       it('check second grid has rendered', function () {
         gridTestUtils.expectHeaderColumnCount( 'secondGrid', 3 );
       });
-  
+
 //      it('check that menus display over the correct grid', function () {
         // still working out how to get protractor to scroll an element
 //      });
-    });    
-  </file>  
+    });
+  </file>
 </example>
diff --git a/src/features/exporter/js/exporter.js b/src/features/exporter/js/exporter.js
@@ -991,30 +991,31 @@
           ieVersion = this.isIE();
           var doc = pdfMake.createPdf(docDefinition);
           var blob;
+
           doc.getBuffer( function (buffer) {
             blob = new Blob([buffer]);
-          });
 
-          if (ieVersion && ieVersion < 10) {
-            var frame = D.createElement('iframe');
-            document.body.appendChild(frame);
+            if (ieVersion && ieVersion < 10) {
+              var frame = D.createElement('iframe');
+              document.body.appendChild(frame);
 
-            frame.contentWindow.document.open("text/html", "replace");
-            frame.contentWindow.document.write(blob);
-            frame.contentWindow.document.close();
-            frame.contentWindow.focus();
-            frame.contentWindow.document.execCommand('SaveAs', true, fileName);
+              frame.contentWindow.document.open("text/html", "replace");
+              frame.contentWindow.document.write(blob);
+              frame.contentWindow.document.close();
+              frame.contentWindow.focus();
+              frame.contentWindow.document.execCommand('SaveAs', true, fileName);
 
-            document.body.removeChild(frame);
-            return true;
-          }
+              document.body.removeChild(frame);
+              return true;
+            }
 
-          // IE10+
-          if (navigator.msSaveBlob) {
-            return navigator.msSaveBlob(
-              blob, fileName
-            );
-          }
+            // IE10+
+            if (navigator.msSaveBlob) {
+              return navigator.msSaveBlob(
+                blob, fileName
+              );
+            }
+          });
         },
 
 
