gh-pages v4.6.0-8bd67215

Author: grud

docs/grunt-scripts/pdfmake.js

@@ -37,7 +37,7 @@
 <ul class="events"><li><h3 id="events_navigate">navigate</h3>
 <div class="navigate"><div class="navigate-page"><p>raised when the active cell is changed
 <pre class="prettyprint linenums">
-     gridApi.cellNav.on.navigate(scope,function(newRowcol, oldRowCol){})
+     gridApi.cellNav.on.navigate(scope,function(newRowcol, oldRowCol) {})
 </pre>
 </div><div class="inline"></div>
 <div class="inline"></div>

docs/js/docs-setup.js

@@ -29,10 +29,10 @@ <h4 id="usage_parameters">Parameters</h4><table class="variables-matrix table ta
 </div><h5 id="methods_buildcolumndefsfromdata_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>rowBuilder</td><td><a href="" class="label type-hint type-hint-function">function(colDef, col, gridOptions</a></td><td><div class="buildcolumndefsfromdata-page"><p>function to be called</p>
 </div></td></tr></tbody></table></div>
 </li>
-<li><a href="https://github.com/{{repo}}/blob/{{sha}}/{{file}}#L{{codeline}}" class="view-source icon-eye-open"> </a><h3 id="methods_buildcolumns">buildColumns(options)</h3>
+<li><a href="https://github.com/{{repo}}/blob/{{sha}}/{{file}}#L{{codeline}}" class="view-source icon-eye-open"> </a><h3 id="methods_buildcolumns">buildColumns(opts)</h3>
 <div class="buildcolumns"><div class="buildcolumns-page"><p>creates GridColumn objects from the columnDefinition.  Calls each registered
 columnBuilder to further process the column</p>
-</div><h5 id="methods_buildcolumns_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>options</td><td><a href="" class="label type-hint type-hint-object">object</a></td><td><div class="buildcolumns-page"><p>An object contains options to use when building columns</p>
+</div><h5 id="methods_buildcolumns_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>opts</td><td><a href="" class="label type-hint type-hint-object">object</a></td><td><div class="buildcolumns-page"><p>An object contains options to use when building columns</p>
 <ul>
 <li><strong>orderByColumnDefs</strong>: defaults to <strong>false</strong>. When true, <code>buildColumns</code> will reorder existing columns according to the order within the column definitions.</li>
 </ul>
@@ -216,11 +216,11 @@ <h4 id="usage_parameters">Parameters</h4><table class="variables-matrix table ta
 </div></td></tr></tbody></table><h5 id="methods_processrowbuilders_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-gridrow">GridRow</a></td><td><div class="processrowbuilders-page"><p>the gridRow with all additional behavior added</p>
 </div></td></tr></table></div>
 </li>
-<li><a href="https://github.com/{{repo}}/blob/{{sha}}/{{file}}#L{{codeline}}" class="view-source icon-eye-open"> </a><h3 id="methods_processrowscallback">processRowsCallback(name)</h3>
+<li><a href="https://github.com/{{repo}}/blob/{{sha}}/{{file}}#L{{codeline}}" class="view-source icon-eye-open"> </a><h3 id="methods_processrowscallback">processRowsCallback(grid)</h3>
 <div class="processrowscallback"><div class="processrowscallback-page"><p>calls the row processors, specifically
 intended to reset the sorting when an edit is called,
 registered as a dataChangeCallback on uiGridConstants.dataChange.EDIT</p>
-</div><h5 id="methods_processrowscallback_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>name</td><td><a href="" class="label type-hint type-hint-string">string</a></td><td><div class="processrowscallback-page"><p>column name</p>
+</div><h5 id="methods_processrowscallback_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>grid</td><td><a href="" class="label type-hint type-hint-object">object</a></td><td><div class="processrowscallback-page"><p>The grid object.</p>
 </div></td></tr></tbody></table></div>
 </li>
 <li><a href="https://github.com/{{repo}}/blob/{{sha}}/{{file}}#L{{codeline}}" class="view-source icon-eye-open"> </a><h3 id="methods_queuegridrefresh">queueGridRefresh()</h3>
@@ -365,10 +365,10 @@ <h4 id="usage_parameters">Parameters</h4><table class="variables-matrix table ta
 <div class="updatecanvasheight"><div class="updatecanvasheight-page"><p>flags all render containers to update their canvas height</p>
 </div></div>
 </li>
-<li><a href="https://github.com/{{repo}}/blob/{{sha}}/{{file}}#L{{codeline}}" class="view-source icon-eye-open"> </a><h3 id="methods_updatefooterheightcallback">updateFooterHeightCallback(name)</h3>
+<li><a href="https://github.com/{{repo}}/blob/{{sha}}/{{file}}#L{{codeline}}" class="view-source icon-eye-open"> </a><h3 id="methods_updatefooterheightcallback">updateFooterHeightCallback(grid)</h3>
 <div class="updatefooterheightcallback"><div class="updatefooterheightcallback-page"><p>recalculates the footer height,
 registered as a dataChangeCallback on uiGridConstants.dataChange.OPTIONS</p>
-</div><h5 id="methods_updatefooterheightcallback_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>name</td><td><a href="" class="label type-hint type-hint-string">string</a></td><td><div class="updatefooterheightcallback-page"><p>column name</p>
+</div><h5 id="methods_updatefooterheightcallback_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>grid</td><td><a href="" class="label type-hint type-hint-object">object</a></td><td><div class="updatefooterheightcallback-page"><p>The grid object.</p>
 </div></td></tr></tbody></table></div>
 </li>
 </ul>

docs/partials/api/ui.grid.cellNav.api.PublicApi.html

@@ -5,12 +5,12 @@
 </h1>
 <div><h2 id="description">Description</h2>
 <div class="description"><div class="ui-grid-class-page ui-grid-class-gridapi-page"><p>GridApi provides the ability to register public methods events inside the grid and allow
-for other components to use the api via featureName.raise.methodName and featureName.on.eventName(function(args){}.
+for other components to use the api via featureName.raise.methodName and featureName.on.eventName(function(args) {}.
 <br/>
 To listen to events, you must add a callback to gridOptions.onRegisterApi
 <pre class="prettyprint linenums">
-  $scope.gridOptions.onRegisterApi = function(gridApi){
-     gridApi.cellNav.on.navigate($scope,function(newRowCol, oldRowCol){
+  $scope.gridOptions.onRegisterApi = function(gridApi) {
+     gridApi.cellNav.on.navigate($scope,function(newRowCol, oldRowCol) {
          $log.log('navigation event');
      });
   };
@@ -49,8 +49,8 @@ <h4 id="usage_parameters">Parameters</h4><table class="variables-matrix table ta
 <pre class="prettyprint linenums">
 {featureName:
        {
-         eventNameOne:function(args){},
-         eventNameTwo:function(args){}
+         eventNameOne:function(args) {},
+         eventNameTwo:function(args) {}
        }
  }
 </pre>
@@ -65,16 +65,16 @@ <h4 id="usage_parameters">Parameters</h4><table class="variables-matrix table ta
 </div></td></tr><tr><td>_this</td><td><a href="" class="label type-hint type-hint-object">object</a></td><td><div class="registermethod-page"><p>binds callBackFn &#39;this&#39; to _this.  Defaults to gridApi.grid</p>
 </div></td></tr></tbody></table></div>
 </li>
-<li><a href="https://github.com/{{repo}}/blob/{{sha}}/{{file}}#L{{codeline}}" class="view-source icon-eye-open"> </a><h3 id="methods_registermethodsfromobject">registerMethodsFromObject(eventObjectMap, _this)</h3>
+<li><a href="https://github.com/{{repo}}/blob/{{sha}}/{{file}}#L{{codeline}}" class="view-source icon-eye-open"> </a><h3 id="methods_registermethodsfromobject">registerMethodsFromObject(methodMap, _this)</h3>
 <div class="registermethodsfromobject"><div class="registermethodsfromobject-page"><p>Registers features and methods from a simple objectMap.
 eventObjectMap must be in this format (multiple features allowed)
 <br>
 {featureName:
        {
-         methodNameOne:function(args){},
-         methodNameTwo:function(args){}
+         methodNameOne:function(args) {},
+         methodNameTwo:function(args) {}
        }</p>
-</div><h5 id="methods_registermethodsfromobject_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>eventObjectMap</td><td><a href="" class="label type-hint type-hint-object">object</a></td><td><div class="registermethodsfromobject-page"><p>map of feature/event names</p>
+</div><h5 id="methods_registermethodsfromobject_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>methodMap</td><td><a href="" class="label type-hint type-hint-object">object</a></td><td><div class="registermethodsfromobject-page"><p>map of feature/event names</p>
 </div></td></tr><tr><td>_this</td><td><a href="" class="label type-hint type-hint-object">object</a></td><td><div class="registermethodsfromobject-page"><p>binds this to _this for all functions.  Defaults to gridApi.grid</p>
 </div></td></tr></tbody></table></div>
 </li>
@@ -87,7 +87,7 @@ <h4 id="usage_parameters">Parameters</h4><table class="variables-matrix table ta
 </div></td></tr><tr><td>callBackFn</td><td><a href="" class="label type-hint type-hint-object">object</a></td><td><div class="ui-grid-class-page ui-grid-class-suppressevents-page"><p>function to execute</p>
 </div></td></tr></tbody></table><h4 id="methods_suppressevents_example">Example</h4>
 <div class="example"><div class="ui-grid-class-page ui-grid-class-suppressevents-page"><pre class="prettyprint linenums">
-var navigate = function (newRowCol, oldRowCol){
+var navigate = function (newRowCol, oldRowCol) {
    //do something on navigate
 }
 
@@ -96,7 +96,7 @@ <h4 id="usage_parameters">Parameters</h4><table class="variables-matrix table ta
 
 //call the scrollTo event and suppress our navigate listener
 //scrollTo will still raise the event for other listeners
-gridApi.suppressEvents(navigate, function(){
+gridApi.suppressEvents(navigate, function() {
    gridApi.cellNav.scrollTo(aRow, aCol);
 });
 

docs/partials/api/ui.grid.class.Grid.html

@@ -55,7 +55,7 @@ <h4 id="usage_parameters">Parameters</h4><table class="variables-matrix table ta
 <li><a href="https://github.com/{{repo}}/blob/{{sha}}/{{file}}#L{{codeline}}" class="view-source icon-eye-open"> </a><h3 id="methods_setpropertyordefault">setPropertyOrDefault(colDef, propName, defaultValue)</h3>
 <div class="setpropertyordefault"><div class="setpropertyordefault-page"><p>Sets a property on the column using the passed in columnDef, and
 setting the defaultValue if the value cannot be found on the colDef</p>
-</div><h5 id="methods_setpropertyordefault_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>colDef</td><td><a href="" class="label type-hint type-hint-columndef">ColumnDef</a></td><td><div class="setpropertyordefault-page"><p>the column def to look in for the property value</p>
+</div><h5 id="methods_setpropertyordefault_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>colDef</td><td><a href="" class="label type-hint type-hint-gridcolumn">GridColumn</a></td><td><div class="setpropertyordefault-page"><p>the column def to look in for the property value</p>
 </div></td></tr><tr><td>propName</td><td><a href="" class="label type-hint type-hint-string">string</a></td><td><div class="setpropertyordefault-page"><p>the property name we&#39;d like to set</p>
 </div></td></tr><tr><td>defaultValue</td><td><a href="" class="label type-hint type-hint-object">object</a></td><td><div class="setpropertyordefault-page"><p>the value to use if the colDef doesn&#39;t provide the setting</p>
 </div></td></tr></tbody></table></div>
@@ -71,7 +71,7 @@ <h4 id="usage_parameters">Parameters</h4><table class="variables-matrix table ta
 <li><a href="https://github.com/{{repo}}/blob/{{sha}}/{{file}}#L{{codeline}}" class="view-source icon-eye-open"> </a><h3 id="methods_updatecolumndef">updateColumnDef(colDef, isNew)</h3>
 <div class="updatecolumndef"><div class="updatecolumndef-page"><p>Moves settings from the columnDef down onto the column,
 and sets properties as appropriate</p>
-</div><h5 id="methods_updatecolumndef_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>colDef</td><td><a href="" class="label type-hint type-hint-columndef">ColumnDef</a></td><td><div class="updatecolumndef-page"><p>the column def to look in for the property value</p>
+</div><h5 id="methods_updatecolumndef_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>colDef</td><td><a href="" class="label type-hint type-hint-gridcolumn">GridColumn</a></td><td><div class="updatecolumndef-page"><p>the column def to look in for the property value</p>
 </div></td></tr><tr><td>isNew</td><td><a href="" class="label type-hint type-hint-boolean">boolean</a></td><td><div class="updatecolumndef-page"><p>whether the column is being newly created, if not
 we&#39;re updating an existing column, and some items such as the sort shouldn&#39;t
 be copied down</p>
@@ -88,7 +88,7 @@ <h4 id="usage_parameters">Parameters</h4><table class="variables-matrix table ta
 <li><h3 id="properties_extrastyle">extraStyle</h3>
 <div class="extrastyle"><div class="extrastyle-page"><p>additional on this column.</p>
 </div><h4 id="properties_extrastyle_example">Example</h4>
-<div class="example"><div class="extrastyle-page"><pre class="prettyprint linenums">{extraStyle: {display:'table-cell'}}</pre>
+<div class="example"><div class="extrastyle-page"><pre class="prettyprint linenums">{extraStyle: {display: 'table-cell'}}</pre>
 </div></div>
 </div>
 </li>

docs/partials/api/ui.grid.class.GridApi.html

@@ -307,7 +307,7 @@
 <li>direction: values are <a href="#!/api/ui.grid.service:uiGridConstants#properties_asc">uiGridConstants.ASC</a>
 or <a href="#!/api/ui.grid.service:uiGridConstants#properties_desc">uiGridConstants.DESC</a></li>
 <li>ignoreSort: if set to true this sort is ignored (used by tree to manipulate the sort functionality)</li>
-<li>priority: says what order to sort the columns in (lower priority gets sorted first).</li>
+<li>priority: says what order to sort the columns in (lower priority gets sorted first). Starts from 0.</li>
 </ul>
 </div><h4 id="properties_sort_example">Example</h4>
 <div class="example"><div class="sort-page"><pre class="prettyprint linenums">
@@ -395,6 +395,6 @@
 </ul>
 </div>
 <h2 id="example">Example</h2>
-<div class="example"><div class="ui-grid-class-page ui-grid-class-gridoptions-columndef-page"><pre class="prettyprint linenums">{name:'field1', field: 'field1', filter: { term: 'xxx' }}</pre>
+<div class="example"><div class="ui-grid-class-page ui-grid-class-gridoptions-columndef-page"><pre class="prettyprint linenums">{name: 'field1', field: 'field1', filter: { term: 'xxx' }}</pre>
 </div></div>
 </div>

docs/partials/api/ui.grid.class.GridColumn.html

@@ -69,7 +69,7 @@ <h2 id="usage">Usage</h2>
 <a href="#!/api/ui.grid.class:GridOptions.columnDef">columnDef</a> section
 </br><em>field property can be used in place of name for backwards compatibility with 2.x</em></p>
 </div><h4 id="properties_columndefs_example">Example</h4>
-<div class="example"><div class="columndefs-page"><pre class="prettyprint linenums">var columnDefs = [{name:'field1'}, {name:'field2'}];</pre>
+<div class="example"><div class="columndefs-page"><pre class="prettyprint linenums">var columnDefs = [{name: 'field1'}, {name: 'field2'}];</pre>
 </div></div>
 </div>
 </li>
@@ -238,6 +238,16 @@ <h2 id="usage">Usage</h2>
 </div></div>
 </div>
 </li>
+<li><h3 id="properties_headerrowheight">headerRowHeight</h3>
+<div class="headerrowheight"><div class="headerrowheight-page"><p>The height of the header in pixels, defaults to 30.
+Although, we recommend that you alter header height with CSS rather than using this option:</p>
+<pre class="prettyprint linenums">
+    .grid .ui-grid-header-cell {
+        height: 60px;
+    }
+</pre>
+</div></div>
+</li>
 <li><h3 id="properties_headertemplate">headerTemplate</h3>
 <div class="headertemplate"><div class="headertemplate-page"><p>Null by default. When provided, this setting uses a custom header
 template, rather than the default template. Can be set to either the name of a template file:
@@ -384,8 +394,8 @@ <h2 id="example">Example</h2>
 <p>To provide default options for all of the grids within your application, use an angular
 decorator to modify the GridOptions factory.
 <pre class="prettyprint linenums">
-app.config(function($provide){
-  $provide.decorator('GridOptions',function($delegate){
+app.config(function($provide) {
+  $provide.decorator('GridOptions',function($delegate) {
     var gridOptions;
     gridOptions = angular.copy($delegate);
     gridOptions.initialize = function(options) {

docs/partials/api/ui.grid.class.GridOptions.columnDef.html

@@ -207,7 +207,7 @@
 columns with sorts on them, in priority order.</p>
 </div></td></tr></tbody></table><h4 id="methods_sortchanged_example">Example</h4>
 <div class="example"><div class="sortchanged-page"><pre class="prettyprint linenums">
-gridApi.core.on.sortChanged( $scope, function(grid, sortColumns){
+gridApi.core.on.sortChanged( $scope, function(grid, sortColumns) {
   // do something
 });
 </pre>
@@ -225,7 +225,7 @@
 <div class="example"><div class="sorthandlenulls-page"><pre class="prettyprint linenums">
 mySortFn = function(a, b) {
 var nulls = $scope.gridApi.core.sortHandleNulls(a, b);
-if ( nulls !== null ){
+if ( nulls !== null ) {
   return nulls;
 } else {
   // your code for sorting here

docs/partials/api/ui.grid.class.GridOptions.html

@@ -25,7 +25,7 @@ <h2 id="usage">Usage</h2>
 to the right place whilst hidden (it will make an assumption on menu width),
 then it asks the menu to show (it will animate), then it repositions the menu again
 once we can calculate it&#39;s size.</p>
-</div><h5 id="methods_showmenu_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>column</td><td><a href="" class="label type-hint type-hint-gridcol">GridCol</a></td><td><div class="showmenu-page"><p>the column we want to position below</p>
+</div><h5 id="methods_showmenu_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>column</td><td><a href="" class="label type-hint type-hint-gridcolumn">GridColumn</a></td><td><div class="showmenu-page"><p>the column we want to position below</p>
 </div></td></tr><tr><td>$columnElement</td><td><a href="" class="label type-hint type-hint-element">element</a></td><td><div class="showmenu-page"><p>the column element we want to position below</p>
 </div></td></tr></tbody></table></div>
 </li>