gh-pages v4.5.0

Author: Portugal, Marcelo

docs/js/docs-setup.js

@@ -658,7 +658,7 @@ NG_DOCS={
       "type": "object",
       "moduleName": "ui.grid.expandable",
       "shortDescription": "Options for configuring the expandable feature, these are available to be",
-      "keywords": "$scope _this_ allows api application button buttons class collapsing column configuring custom defaults display enableexpandable enableexpandablerowheader expand expandable expandablerowheaderwidth expandablerowheight expandablerowscope expandablerowtemplate expandablescope expanded expanding false feature going grid gridoptions grids height hide html implies mandatory method modes object options pixels provide row rowheader scope set showexpandallbutton specific subgrid subgrids template true turn ui ui-grid variables width"
+      "keywords": "$scope _this_ allows api application boolean button buttons class collapsing column configuring custom defaults display enableexpandable enableexpandablerowheader enableondblclickexpand expand expandable expandablerowheaderwidth expandablerowheight expandablerowscope expandablerowtemplate expandablescope expanded expanding false feature going grid gridoptions grids height hide html implies mandatory method modes object ondblclickexpand options pixels provide row rowheader scope set showexpandallbutton specific subgrid subgrids template true turn ui ui-grid variables width"
     },
     {
       "section": "api",
@@ -676,7 +676,7 @@ NG_DOCS={
       "type": "object",
       "moduleName": "ui.grid.expandable",
       "shortDescription": "Public Api for expandable feature",
-      "keywords": "api array collapse collapseallrows collapserow data entity expand expandable expandallrows expandedrow expandrow feature function getexpandedrows grid gridapi gridoptions instance method object public references returns row rowentity specific subgrids toggle toggleallrows togglerowexpansion ui"
+      "keywords": "api array collapse collapseallrows collapserow data entity event exist expand expandable expandallrows expandedrow expandrow feature function getexpandedrows grid gridapi gridoptions instance method object public references returns row rowentity specific subgrids toggle toggleallrows togglerowexpansion ui"
     },
     {
       "section": "api",
@@ -702,8 +702,8 @@ NG_DOCS={
       "shortName": "uiGridExpandableRow",
       "type": "directive",
       "moduleName": "ui.grid.expandable",
-      "shortDescription": "directive to render the expandable row template",
-      "keywords": "api directive expandable grid render row template ui"
+      "shortDescription": "directive to render the Row template on Expand",
+      "keywords": "api directive expand expandable grid render row template ui"
     },
     {
       "section": "api",
@@ -1351,7 +1351,7 @@ NG_DOCS={
       "type": "object",
       "moduleName": "ui.grid.selection",
       "shortDescription": "GridOptions for selection feature, these are available to be",
-      "keywords": "allow api bulk called changed checkbox class clicking column conjunction create ctrlkey custom defaults enable enablefootertotalselected enablefullrowselection enablerowheaderselection enablerowselection enableselectall enableselection enableselectionbatchevent entire evaluates event false feature fired footer grid gridapi gridoptions header isrowselectable items method modifierkeystomultiselect multiple multiselect nounselect number object option prevent property requires row rows rowselectionchanged select selectall selected selection selectionrowheader selectionrowheaderwidth selectrow separate set sets setting shiftkey showgridfooter single times top total true ui ui-grid unselect unselected width works"
+      "keywords": "allow api bulk called changed checkbox class clicking column conjunction create ctrlkey custom defaults enable enablefocusrowonrowheaderclick enablefootertotalselected enablefullrowselection enablerowheaderselection enablerowselection enableselectall enableselection enableselectionbatchevent enableselectrowonfocus entire evaluates event false feature fired focuse footer grid gridapi gridoptions header isrowselectable items method modifierkeystomultiselect multiple multiselect nounselect number object option prevent property requires row rows rowselectionchanged select selectall selected selection selectionrowheader selectionrowheaderwidth selectrow separate set sets setting shiftkey showgridfooter single times top total true ui ui-grid unselect unselected width works"
     },
     {
       "section": "api",
@@ -1360,7 +1360,7 @@ NG_DOCS={
       "type": "object",
       "moduleName": "ui.grid.selection",
       "shortDescription": "GridRow prototype functions added for selection",
-      "keywords": "api changes code enable enableselection example false feature function functions grid gridrow group grouping header internal isselected object property prototype readonly row rows selectable selected selectedcount selection set sets setselected settable true ui updates"
+      "keywords": "api changes code enable enableselection example false feature focused function functions grid gridrow group grouping header internal isfocused isselected object property prototype readonly row rows selectable selected selectedcount selection set setfocused sets setselected settable true ui updates val"
     },
     {
       "section": "api",
@@ -1414,7 +1414,7 @@ NG_DOCS={
       "type": "object",
       "moduleName": "ui.grid.selection",
       "shortDescription": "Grid properties and functions added for selection",
-      "keywords": "api count current functions grid object properties rows selected selectedcount selection ui var"
+      "keywords": "api count current focused focusedrow functions grid object properties row rows selected selectedcount selection ui var"
     },
     {
       "section": "api",
@@ -2305,7 +2305,7 @@ NG_DOCS={
       "type": "overview",
       "moduleName": "Tutorial: 405 Exporting All Data With External Pagination",
       "shortDescription": "When using built in pagination, the data is fully loaded before export.",
-      "keywords": "$http $scope _scope angular angularjs app asc better break built case choose class columndefs combined company controller core css data default desc direction enablegridmenu enablesorting example export exportalldatapromise exporter exporteralldatafn exporting external false feature files firstrow fully function gender getpage grid gridapi gridoptions html js json length load loaded main mainctrl min module ng-controller ngtouch null onregisterapi options overview pagesize pagination paginationchanged paginationcurrentpage paginationoptions paginationpagesize paginationpagesizes performance purposes response return selection sense slice sort sortchanged sortcolumns sorting specific src switch totalitems true turn tutorial ui ui-grid ui-grid-exporter ui-grid-pagination ui-grid-selection uigridconstants url useexternalpagination useexternalsorting var width"
+      "keywords": "$http $scope _scope alldata angular angularjs app asc better break built case choose class columndefs combined company controller core css data default desc direction enablegridmenu enablesorting example export exportalldatapromise exporter exporteralldatafn exporting external false feature files firstrow fully function gender getpage grid gridapi gridoptions html js json length load loaded main mainctrl min module ng-controller ngtouch null onregisterapi options overview pagesize pagination paginationchanged paginationcurrentpage paginationoptions paginationpagesize paginationpagesizes performance purposes response return selection sense slice sort sortchanged sortcolumns sorting specific src switch totalitems true turn tutorial ui ui-grid ui-grid-exporter ui-grid-pagination ui-grid-selection uigridconstants url useexternalpagination useexternalsorting var width"
     },
     {
       "section": "tutorial",

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

@@ -81,7 +81,7 @@ <h4 id="usage_parameters">Parameters</h4><table class="variables-matrix table ta
 </div>
 <div class="member property"><h2 id="properties">Properties</h2>
 <ul class="properties"><li><h3 id="properties_displayname">displayName</h3>
-<div class="displayname"><div class="displayname-page"><p>Column name that will be shown in the header.  If displayName is not
+<div class="displayname"><div class="displayname-page"><p>Column name that will be shown in the header. If displayName is not
 provided then one is generated using the name.</p>
 </div></div>
 </li>

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

@@ -73,7 +73,7 @@
 </div>
 </li>
 <li><h3 id="properties_displayname">displayName</h3>
-<div class="displayname"><div class="displayname-page"><p>Column name that will be shown in the header.  If displayName is not
+<div class="displayname"><div class="displayname-page"><p>Column name that will be shown in the header. If displayName is not
 provided then one is generated using the name.</p>
 </div></div>
 </li>

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

@@ -32,6 +32,17 @@
 </div></div>
 </div>
 </li>
+<li><h3 id="properties_enableondblclickexpand">enableOnDblClickExpand</h3>
+<div class="enableondblclickexpand"><div class="enableondblclickexpand-page"><p>Defaults to true.</p>
+</div><h4 id="properties_enableondblclickexpand_example">Example</h4>
+<div class="example"><div class="enableondblclickexpand-page"><pre class="prettyprint linenums">
+$scope.gridOptions = {
+  onDblClickExpand: false
+}
+</pre>
+</div></div>
+</div>
+</li>
 <li><h3 id="properties_expandablerowheaderwidth">expandableRowHeaderWidth</h3>
 <div class="expandablerowheaderwidth"><div class="expandablerowheaderwidth-page"><p>Width in pixels of the expandable column. Defaults to 40</p>
 </div><h4 id="properties_expandablerowheaderwidth_example">Example</h4>

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

@@ -42,12 +42,13 @@
 </pre>
 </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_togglerowexpansion">toggleRowExpansion(rowEntity)</h3>
+<li><a href="https://github.com/{{repo}}/blob/{{sha}}/{{file}}#L{{codeline}}" class="view-source icon-eye-open"> </a><h3 id="methods_togglerowexpansion">toggleRowExpansion(rowEntity, [e])</h3>
 <div class="togglerowexpansion"><div class="togglerowexpansion-page"><p>Toggle a specific row
 <pre class="prettyprint linenums">
-     gridApi.expandable.toggleRowExpansion(rowEntity);
+     gridApi.expandable.toggleRowExpansion(rowEntity, event);
 </pre>
 </div><h5 id="methods_togglerowexpansion_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>rowEntity</td><td><a href="" class="label type-hint type-hint-object">object</a></td><td><div class="togglerowexpansion-page"><p>the data entity for the row you want to expand</p>
+</div></td></tr><tr><td>[e]</td><td><a href="" class="label type-hint type-hint-event">Event</a></td><td><div class="togglerowexpansion-page"><p>event (if exist)</p>
 </div></td></tr></tbody></table></div>
 </li>
 </ul>
@@ -56,23 +57,37 @@
 <ul class="events"><li><h3 id="events_rowexpandedbeforestatechanged">rowExpandedBeforeStateChanged</h3>
 <div class="rowexpandedbeforestatechanged"><div class="rowexpandedbeforestatechanged-page"><p>raised when row is expanding or collapsing
 <pre class="prettyprint linenums">
-     gridApi.expandable.on.rowExpandedBeforeStateChanged(scope,function(row){})
+     gridApi.expandable.on.rowExpandedBeforeStateChanged(scope,function(row, event){})
 </pre>
 </div><div class="inline"></div>
 <div class="inline"></div>
 <h5 id="events_rowexpandedbeforestatechanged_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>scope</td><td><a href="" class="label type-hint type-hint-scope">scope</a></td><td><div class="rowexpandedbeforestatechanged-page"><p>the application scope</p>
 </div></td></tr><tr><td>row</td><td><a href="" class="label type-hint type-hint-gridrow">GridRow</a></td><td><div class="rowexpandedbeforestatechanged-page"><p>the row that was expanded</p>
+</div></td></tr><tr><td>evt</td><td><a href="" class="label type-hint type-hint-event">Event</a></td><td><div class="rowexpandedbeforestatechanged-page"><p>object if raised from an event</p>
+</div></td></tr></tbody></table></div>
+</li>
+<li><h3 id="events_rowexpandedrendered">rowExpandedRendered</h3>
+<div class="rowexpandedrendered"><div class="rowexpandedrendered-page"><p>raised when expanded row is rendered
+<pre class="prettyprint linenums">
+     gridApi.expandable.on.rowExpandedRendered(scope,function(row, event){})
+</pre>
+</div><div class="inline"></div>
+<div class="inline"></div>
+<h5 id="events_rowexpandedrendered_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>scope</td><td><a href="" class="label type-hint type-hint-scope">scope</a></td><td><div class="rowexpandedrendered-page"><p>the application scope</p>
+</div></td></tr><tr><td>row</td><td><a href="" class="label type-hint type-hint-gridrow">GridRow</a></td><td><div class="rowexpandedrendered-page"><p>the row that was expanded</p>
+</div></td></tr><tr><td>evt</td><td><a href="" class="label type-hint type-hint-event">Event</a></td><td><div class="rowexpandedrendered-page"><p>object if raised from an event</p>
 </div></td></tr></tbody></table></div>
 </li>
 <li><h3 id="events_rowexpandedstatechanged">rowExpandedStateChanged</h3>
 <div class="rowexpandedstatechanged"><div class="rowexpandedstatechanged-page"><p>raised when row expanded or collapsed
 <pre class="prettyprint linenums">
-     gridApi.expandable.on.rowExpandedStateChanged(scope,function(row){})
+     gridApi.expandable.on.rowExpandedStateChanged(scope,function(row, event){})
 </pre>
 </div><div class="inline"></div>
 <div class="inline"></div>
 <h5 id="events_rowexpandedstatechanged_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>scope</td><td><a href="" class="label type-hint type-hint-scope">scope</a></td><td><div class="rowexpandedstatechanged-page"><p>the application scope</p>
 </div></td></tr><tr><td>row</td><td><a href="" class="label type-hint type-hint-gridrow">GridRow</a></td><td><div class="rowexpandedstatechanged-page"><p>the row that was expanded</p>
+</div></td></tr><tr><td>evt</td><td><a href="" class="label type-hint type-hint-event">Event</a></td><td><div class="rowexpandedstatechanged-page"><p>object if raised from an event</p>
 </div></td></tr></tbody></table></div>
 </li>
 </ul>

docs/partials/api/ui.grid.expandable.directive.uiGridExpandableRow.html

@@ -4,7 +4,7 @@
 </div>
 </h1>
 <div><h2 id="description">Description</h2>
-<div class="description"><div class="ui-grid-expandable-directive-page ui-grid-expandable-directive-uigridexpandablerow-page"><p>directive to render the expandable row template</p>
+<div class="description"><div class="ui-grid-expandable-directive-page ui-grid-expandable-directive-uigridexpandablerow-page"><p>directive to render the Row template on Expand</p>
 </div></div>
 <h2 id="usage">Usage</h2>
 <div class="usage">as attribute<pre class="prettyprint linenums">&lt;ANY ui-grid-expandable-row&gt;

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

@@ -8,15 +8,20 @@
 set using the ui-grid <a href="#!/api/ui.grid.class:GridOptions">gridOptions</a></p>
 </div></div>
 <div class="member property"><h2 id="properties">Properties</h2>
-<ul class="properties"><li><h3 id="properties_enablefootertotalselected">enableFooterTotalSelected</h3>
+<ul class="properties"><li><h3 id="properties_enablefocusrowonrowheaderclick">enableFocusRowOnRowHeaderClick</h3>
+<div class="enablefocusrowonrowheaderclick"><div class="enablefocusrowonrowheaderclick-page"><p>Enable focuse row by clicking on the row header.  Defaults to
+true if <code>enableRowHeaderSelection</code> is true, otherwise defaults to false.</p>
+</div></div>
+</li>
+<li><h3 id="properties_enablefootertotalselected">enableFooterTotalSelected</h3>
 <div class="enablefootertotalselected"><div class="enablefootertotalselected-page"><p>Shows the total number of selected items in footer if true.
 <br/>Defaults to true.
 <br/>GridOptions.showGridFooter must also be set to true.</p>
 </div></div>
 </li>
 <li><h3 id="properties_enablefullrowselection">enableFullRowSelection</h3>
 <div class="enablefullrowselection"><div class="enablefullrowselection-page"><p>Enable selection by clicking anywhere on the row.  Defaults to
-false if <code>enableRowHeaderSelection</code> is true, otherwise defaults to false.</p>
+false if <code>enableRowHeaderSelection</code> is true, otherwise defaults to true.</p>
 </div></div>
 </li>
 <li><h3 id="properties_enablerowheaderselection">enableRowHeaderSelection</h3>
@@ -34,6 +39,10 @@
 <br/>Defaults to true</p>
 </div></div>
 </li>
+<li><h3 id="properties_enableselectrowonfocus">enableSelectRowOnFocus</h3>
+<div class="enableselectrowonfocus"><div class="enableselectrowonfocus-page"><p>Enable focuse row by clicking on the row anywhere.  Defaults true.</p>
+</div></div>
+</li>
 <li><h3 id="properties_enableselectionbatchevent">enableSelectionBatchEvent</h3>
 <div class="enableselectionbatchevent"><div class="enableselectionbatchevent-page"><p>If selected rows are changed in bulk, either via the API or
 via the selectAll checkbox, then a separate event is fired.  Setting this

docs/partials/api/ui.grid.selection.api.GridRow.html

@@ -7,10 +7,16 @@
 <div class="description"><div class="ui-grid-selection-api-page ui-grid-selection-api-gridrow-page"><p>GridRow prototype functions added for selection</p>
 </div></div>
 <div class="member method"><h2 id="methods">Methods</h2>
-<ul class="methods"><li><a href="https://github.com/{{repo}}/blob/{{sha}}/{{file}}#L{{codeline}}" class="view-source icon-eye-open"> </a><h3 id="methods_setselected">setSelected(selected)</h3>
+<ul class="methods"><li><a href="https://github.com/{{repo}}/blob/{{sha}}/{{file}}#L{{codeline}}" class="view-source icon-eye-open"> </a><h3 id="methods_setfocused">setFocused(val)</h3>
+<div class="setfocused"><div class="setfocused-page"><p>Sets the isFocused property
+Changes to isFocused state should only be made via this function</p>
+</div><h5 id="methods_setfocused_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>val</td><td><a href="" class="label type-hint type-hint-boolean">Boolean</a></td><td><div class="setfocused-page"><p>value to set</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_setselected">setSelected(selected)</h3>
 <div class="setselected"><div class="setselected-page"><p>Sets the isSelected property and updates the selectedCount
 Changes to isSelected state should only be made via this function</p>
-</div><h5 id="methods_setselected_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>selected</td><td><a href="" class="label type-hint type-hint-bool">bool</a></td><td><div class="setselected-page"><p>value to set</p>
+</div><h5 id="methods_setselected_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>selected</td><td><a href="" class="label type-hint type-hint-boolean">Boolean</a></td><td><div class="setselected-page"><p>value to set</p>
 </div></td></tr></tbody></table></div>
 </li>
 </ul>
@@ -22,8 +28,13 @@
  <br/>Defaults to true</p>
 </div></div>
 </li>
+<li><h3 id="properties_isfocused">isFocused</h3>
+<div class="isfocused"><div class="isfocused-page"><p>Focused state of row. Should be readonly. Make any changes to focused state using setFocused().
+<br/>Defaults to false</p>
+</div></div>
+</li>
 <li><h3 id="properties_isselected">isSelected</h3>
-<div class="isselected"><div class="isselected-page"><p>Selected state of row.  Should be readonly. Make any changes to selected state using setSelected().
+<div class="isselected"><div class="isselected-page"><p>Selected state of row. Should be readonly. Make any changes to selected state using setSelected().
 <br/>Defaults to false</p>
 </div></div>
 </li>