uiGridTreeBaseExpandAllButtons
+ Improve this doc View sourceuiGridTreeBaseExpandAllButtons
ui.grid.treeBase
uiGridTreeRowHeaderButtons
+ Improve this doc View sourceuiGridTreeRowHeaderButtons
ui.grid.treeBase
uiGridViewport
+ Improve this doc View sourceuiGridViewport
ui.grid.treeBase
Services for treeBase feature
Accumulate the data from this row onto the aggregations for each parent
Iterate over the parents, then iterate over the aggregations for each of those parents, and perform the aggregation for each individual aggregation
@@ -49,7 +49,7 @@| boolean | whether or not the tree is all expanded |
Build the object which is stored on the column for holding meta-data about the aggregation. This method should only be called with columns which have an aggregation.
| Param | Type | Details |
|---|---|---|
| column | GridColumn | The column which this object relates to @@ -114,13 +114,13 @@ |
| row | GridRow | the row we want to expand |
Helper function used to finalize aggregation nodes and footer cells
| Param | Type | Details |
|---|---|---|
| row | gridRow | The parent we're finalising |
| aggregation | aggregation | The aggregation object manipulated by the aggregationFn |
Format the data from the aggregation into the rendered text e.g. if we had label: 'sum: ' and value: 25, we'd create 'sum: 25'.
As part of this we call any formatting callback routines we've been provided.
@@ -132,7 +132,7 @@| Param | Type | Details |
|---|---|---|
| row | gridRow | the parent we're finalising |
After filtering has run, we need to go back through the tree and make sure the parent rows are always visible if any of the child rows are visible (filtering may make a child visible, but the parent may not @@ -143,7 +143,7 @@
| Param | Type | Details |
|---|---|---|
| grid | Grid | the grid to fix filters on |
Looks at the parents array to determine our current state. If any node in the hierarchy is collapsed, then return collapsed, otherwise return expanded.
@@ -175,7 +175,7 @@| string | The state we should be setting to any nodes we see |
Performs a recursive sort on the tree nodes, sorting the children of each node and putting them back into the children array.
Before doing this it turns back on all the sortIgnore - things that were previously @@ -202,7 +202,7 @@
| promise | promise for the builder - actually we do it all inline so it's immediately resolved |
Uses the tree aggregation functions and finalizers to set the column footer aggregations.
| Param | Type | Details |
|---|---|---|
| rows | rows | The visible rows. not used, but accepted to match signature of GridColumn.aggregationType diff --git a/index.html b/index.html index f49195870..9232a535b 100644 --- a/index.html +++ b/index.html @@ -76,11 +76,11 @@Angular UI GridCode on Github - + - + - Download ( 4.9.1 ) + Download ( 4.9.2 ) diff --git a/release/4.9.2/css/ui-grid.cellnav.css b/release/4.9.2/css/ui-grid.cellnav.css new file mode 100644 index 000000000..6c2ccdd1c --- /dev/null +++ b/release/4.9.2/css/ui-grid.cellnav.css @@ -0,0 +1,25 @@ +.ui-grid-cell-focus { + outline: 0; + background-color: #b3c4c7; +} +.ui-grid-focuser { + position: absolute; + left: 0; + top: 0; + z-index: -1; + width: 100%; + height: 100%; +} +.ui-grid-focuser:focus { + border-color: #66afe9; + outline: 0; + -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 8px rgba(102, 175, 233, 0.6); + box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 8px rgba(102, 175, 233, 0.6); +} +.ui-grid-offscreen { + display: block; + position: absolute; + left: -10000px; + top: -10000px; + clip: rect(0px, 0px, 0px, 0px); +} diff --git a/release/4.9.2/css/ui-grid.cellnav.min.css b/release/4.9.2/css/ui-grid.cellnav.min.css new file mode 100644 index 000000000..0d826950c --- /dev/null +++ b/release/4.9.2/css/ui-grid.cellnav.min.css @@ -0,0 +1 @@ +.ui-grid-cell-focus{outline:0;background-color:#b3c4c7}.ui-grid-focuser{position:absolute;left:0;top:0;z-index:-1;width:100%;height:100%}.ui-grid-focuser:focus{border-color:#66afe9;outline:0;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 8px rgba(102,175,233,0.6);box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 8px rgba(102,175,233,0.6)}.ui-grid-offscreen{display:block;position:absolute;left:-10000px;top:-10000px;clip:rect(0, 0, 0, 0)} \ No newline at end of file diff --git a/release/4.9.2/css/ui-grid.core.css b/release/4.9.2/css/ui-grid.core.css new file mode 100644 index 000000000..4560afcc5 --- /dev/null +++ b/release/4.9.2/css/ui-grid.core.css @@ -0,0 +1,864 @@ +/*! + * ui-grid - v4.9.2 - 2020-12-01 + * Copyright (c) 2020 ; License: MIT + */ +.ui-grid { + border: 1px solid #d4d4d4; + box-sizing: content-box; + -webkit-border-radius: 0px; + -moz-border-radius: 0px; + border-radius: 0px; + -webkit-transform: translateZ(0); + -moz-transform: translateZ(0); + -o-transform: translateZ(0); + -ms-transform: translateZ(0); + transform: translateZ(0); +} +.ui-grid-vertical-bar { + position: absolute; + right: 0; + width: 0; +} +.ui-grid-header-cell:not(:last-child) .ui-grid-vertical-bar, +.ui-grid-cell:not(:last-child) .ui-grid-vertical-bar { + width: 1px; +} +.ui-grid-scrollbar-placeholder { + background-color: transparent; +} +.ui-grid-header-cell:not(:last-child) .ui-grid-vertical-bar { + background-color: #d4d4d4; +} +.ui-grid-cell:not(:last-child) .ui-grid-vertical-bar { + background-color: #d4d4d4; +} +.ui-grid-header-cell:last-child .ui-grid-vertical-bar { + right: -1px; + width: 1px; + background-color: #d4d4d4; +} +.ui-grid-clearfix:before, +.ui-grid-clearfix:after { + content: ""; + display: table; +} +.ui-grid-clearfix:after { + clear: both; +} +.ui-grid-invisible { + visibility: hidden; +} +.ui-grid-contents-wrapper { + position: relative; + height: 100%; + width: 100%; +} +.ui-grid-sr-only { + position: absolute; + width: 1px; + height: 1px; + margin: -1px; + padding: 0; + overflow: hidden; + clip: rect(0, 0, 0, 0); + border: 0; +} +.ui-grid-icon-button { + background-color: transparent; + border: none; + padding: 0; +} +.clickable { + cursor: pointer; +} +.ui-grid-top-panel-background { + background-color: #f3f3f3; +} +.ui-grid-header { + border-bottom: 1px solid #d4d4d4; + box-sizing: border-box; +} +.ui-grid-top-panel { + position: relative; + overflow: hidden; + font-weight: bold; + background-color: #f3f3f3; + -webkit-border-top-right-radius: -1px; + -webkit-border-bottom-right-radius: 0; + -webkit-border-bottom-left-radius: 0; + -webkit-border-top-left-radius: -1px; + -moz-border-radius-topright: -1px; + -moz-border-radius-bottomright: 0; + -moz-border-radius-bottomleft: 0; + -moz-border-radius-topleft: -1px; + border-top-right-radius: -1px; + border-bottom-right-radius: 0; + border-bottom-left-radius: 0; + border-top-left-radius: -1px; + -moz-background-clip: padding-box; + -webkit-background-clip: padding-box; + background-clip: padding-box; +} +.ui-grid-header-viewport { + overflow: hidden; +} +.ui-grid-header-canvas:before, +.ui-grid-header-canvas:after { + content: ""; + display: -ms-flexbox; + display: flex; + line-height: 0; +} +.ui-grid-header-canvas:after { + clear: both; +} +.ui-grid-header-cell-wrapper { + position: relative; + display: -ms-flexbox; + display: flex; + box-sizing: border-box; + height: 100%; + width: 100%; +} +.ui-grid-header-cell-row { + display: -ms-flexbox; + display: flex; + -ms-flex-direction: row; + flex-direction: row; + -ms-flex-wrap: wrap; + flex-wrap: wrap; +} +.ui-grid-header-cell { + position: relative; + box-sizing: border-box; + background-color: inherit; + border-right: 1px solid; + border-color: #d4d4d4; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + width: 0; +} +.ui-grid-header-cell:last-child { + border-right: 0; +} +.ui-grid-header-cell .sortable { + cursor: pointer; +} +.ui-grid-header-cell .ui-grid-sort-priority-number { + margin-left: -8px; +} +/* Fixes IE word-wrap if needed on header cells */ +.ui-grid-header-cell > div { + -ms-flex-basis: 100%; + flex-basis: 100%; +} +.ui-grid-header .ui-grid-vertical-bar { + top: 0; + bottom: 0; +} +.ui-grid-column-menu-button { + position: absolute; + right: 1px; + top: 0; +} +.ui-grid-column-menu-button .ui-grid-icon-angle-down { + vertical-align: sub; +} +.ui-grid-header-cell-last-col .ui-grid-cell-contents, +.ui-grid-header-cell-last-col .ui-grid-filter-container, +.ui-grid-header-cell-last-col .ui-grid-column-menu-button, +.ui-grid-header-cell-last-col + .ui-grid-column-resizer.right { + margin-right: 13px; +} +.ui-grid-render-container-right .ui-grid-header-cell-last-col .ui-grid-cell-contents, +.ui-grid-render-container-right .ui-grid-header-cell-last-col .ui-grid-filter-container, +.ui-grid-render-container-right .ui-grid-header-cell-last-col .ui-grid-column-menu-button, +.ui-grid-render-container-right .ui-grid-header-cell-last-col + .ui-grid-column-resizer.right { + margin-right: 28px; +} +.ui-grid-column-menu { + position: absolute; +} +/* Slide up/down animations */ +.ui-grid-column-menu .ui-grid-menu .ui-grid-menu-mid.ng-hide-add, +.ui-grid-column-menu .ui-grid-menu .ui-grid-menu-mid.ng-hide-remove { + -webkit-transition: all 0.04s linear; + -moz-transition: all 0.04s linear; + -o-transition: all 0.04s linear; + transition: all 0.04s linear; + display: block !important; +} +.ui-grid-column-menu .ui-grid-menu .ui-grid-menu-mid.ng-hide-add.ng-hide-add-active, +.ui-grid-column-menu .ui-grid-menu .ui-grid-menu-mid.ng-hide-remove { + -webkit-transform: translateY(-100%); + -moz-transform: translateY(-100%); + -o-transform: translateY(-100%); + -ms-transform: translateY(-100%); + transform: translateY(-100%); +} +.ui-grid-column-menu .ui-grid-menu .ui-grid-menu-mid.ng-hide-add, +.ui-grid-column-menu .ui-grid-menu .ui-grid-menu-mid.ng-hide-remove.ng-hide-remove-active { + -webkit-transform: translateY(0); + -moz-transform: translateY(0); + -o-transform: translateY(0); + -ms-transform: translateY(0); + transform: translateY(0); +} +/* Slide up/down animations */ +.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid.ng-hide-add, +.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid.ng-hide-remove { + -webkit-transition: all 0.04s linear; + -moz-transition: all 0.04s linear; + -o-transition: all 0.04s linear; + transition: all 0.04s linear; + display: block !important; +} +.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid.ng-hide-add.ng-hide-add-active, +.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid.ng-hide-remove { + -webkit-transform: translateY(-100%); + -moz-transform: translateY(-100%); + -o-transform: translateY(-100%); + -ms-transform: translateY(-100%); + transform: translateY(-100%); +} +.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid.ng-hide-add, +.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid.ng-hide-remove.ng-hide-remove-active { + -webkit-transform: translateY(0); + -moz-transform: translateY(0); + -o-transform: translateY(0); + -ms-transform: translateY(0); + transform: translateY(0); +} +.ui-grid-filter-container { + padding: 4px 10px; + position: relative; +} +.ui-grid-filter-container .ui-grid-filter-button { + position: absolute; + top: 0; + bottom: 0; + right: 0; +} +.ui-grid-filter-container .ui-grid-filter-button [class^="ui-grid-icon"] { + position: absolute; + top: 50%; + line-height: 32px; + margin-top: -16px; + right: 10px; + opacity: 0.66; +} +.ui-grid-filter-container .ui-grid-filter-button [class^="ui-grid-icon"]:hover { + opacity: 1; +} +.ui-grid-filter-container .ui-grid-filter-button-select { + position: absolute; + top: 0; + bottom: 0; + right: 0; +} +.ui-grid-filter-container .ui-grid-filter-button-select [class^="ui-grid-icon"] { + position: absolute; + top: 50%; + line-height: 32px; + margin-top: -16px; + right: 0px; + opacity: 0.66; +} +.ui-grid-filter-container .ui-grid-filter-button-select [class^="ui-grid-icon"]:hover { + opacity: 1; +} +input[type="text"].ui-grid-filter-input { + box-sizing: border-box; + padding: 0 18px 0 0; + margin: 0; + width: 100%; + border: 1px solid #d4d4d4; + -webkit-border-top-right-radius: 0px; + -webkit-border-bottom-right-radius: 0; + -webkit-border-bottom-left-radius: 0; + -webkit-border-top-left-radius: 0; + -moz-border-radius-topright: 0px; + -moz-border-radius-bottomright: 0; + -moz-border-radius-bottomleft: 0; + -moz-border-radius-topleft: 0; + border-top-right-radius: 0px; + border-bottom-right-radius: 0; + border-bottom-left-radius: 0; + border-top-left-radius: 0; + -moz-background-clip: padding-box; + -webkit-background-clip: padding-box; + background-clip: padding-box; +} +input[type="text"].ui-grid-filter-input:hover { + border: 1px solid #d4d4d4; +} +select.ui-grid-filter-select { + padding: 0; + margin: 0; + border: 0; + width: 90%; + border: 1px solid #d4d4d4; + -webkit-border-top-right-radius: 0px; + -webkit-border-bottom-right-radius: 0; + -webkit-border-bottom-left-radius: 0; + -webkit-border-top-left-radius: 0; + -moz-border-radius-topright: 0px; + -moz-border-radius-bottomright: 0; + -moz-border-radius-bottomleft: 0; + -moz-border-radius-topleft: 0; + border-top-right-radius: 0px; + border-bottom-right-radius: 0; + border-bottom-left-radius: 0; + border-top-left-radius: 0; + -moz-background-clip: padding-box; + -webkit-background-clip: padding-box; + background-clip: padding-box; +} +select.ui-grid-filter-select:hover { + border: 1px solid #d4d4d4; +} +.ui-grid-filter-cancel-button-hidden select.ui-grid-filter-select { + width: 100%; +} +.ui-grid-render-container { + position: inherit; + -webkit-border-top-right-radius: 0; + -webkit-border-bottom-right-radius: 0px; + -webkit-border-bottom-left-radius: 0px; + -webkit-border-top-left-radius: 0; + -moz-border-radius-topright: 0; + -moz-border-radius-bottomright: 0px; + -moz-border-radius-bottomleft: 0px; + -moz-border-radius-topleft: 0; + border-top-right-radius: 0; + border-bottom-right-radius: 0px; + border-bottom-left-radius: 0px; + border-top-left-radius: 0; + -moz-background-clip: padding-box; + -webkit-background-clip: padding-box; + background-clip: padding-box; +} +.ui-grid-render-container:focus { + outline: none; +} +.ui-grid-viewport { + min-height: 20px; + position: relative; + overflow-y: scroll; + -webkit-overflow-scrolling: touch; +} +.ui-grid-viewport:focus { + outline: none !important; +} +.ui-grid-canvas { + position: relative; + padding-top: 1px; +} +.ui-grid-row { + clear: both; +} +.ui-grid-row:nth-child(odd) .ui-grid-cell { + background-color: #fdfdfd; +} +.ui-grid-row:nth-child(even) .ui-grid-cell { + background-color: #f3f3f3; +} +.ui-grid-row:last-child .ui-grid-cell { + border-bottom-color: #d4d4d4; + border-bottom-style: solid; +} +.ui-grid-row:hover > [ui-grid-row] > .ui-grid-cell:hover .ui-grid-cell, +.ui-grid-row:nth-child(odd):hover .ui-grid-cell, +.ui-grid-row:nth-child(even):hover .ui-grid-cell { + background-color: #d5eaee; +} +.ui-grid-no-row-overlay { + position: absolute; + top: 0; + bottom: 0; + left: 0; + right: 0; + margin: 10%; + background-color: #f3f3f3; + -webkit-border-top-right-radius: 0px; + -webkit-border-bottom-right-radius: 0; + -webkit-border-bottom-left-radius: 0; + -webkit-border-top-left-radius: 0; + -moz-border-radius-topright: 0px; + -moz-border-radius-bottomright: 0; + -moz-border-radius-bottomleft: 0; + -moz-border-radius-topleft: 0; + border-top-right-radius: 0px; + border-bottom-right-radius: 0; + border-bottom-left-radius: 0; + border-top-left-radius: 0; + -moz-background-clip: padding-box; + -webkit-background-clip: padding-box; + background-clip: padding-box; + border: 1px solid #d4d4d4; + font-size: 2em; + text-align: center; +} +.ui-grid-no-row-overlay > * { + position: absolute; + display: table; + margin: auto 0; + width: 100%; + top: 0; + bottom: 0; + left: 0; + right: 0; + opacity: 0.66; +} +.ui-grid-cell { + overflow: hidden; + float: left; + background-color: inherit; + border-right: 1px solid; + border-color: #d4d4d4; + box-sizing: border-box; +} +.ui-grid-cell:last-child { + border-right: 0; +} +.ui-grid-cell-contents { + padding: 5px; + -moz-box-sizing: border-box; + -webkit-box-sizing: border-box; + box-sizing: border-box; + white-space: nowrap; + -ms-text-overflow: ellipsis; + -o-text-overflow: ellipsis; + text-overflow: ellipsis; + overflow: hidden; + height: 100%; +} +.ui-grid-cell-contents-hidden { + visibility: hidden; + width: 0; + height: 0; + display: none; +} +.ui-grid-row .ui-grid-cell.ui-grid-row-header-cell { + background-color: #F0F0EE; + border-bottom: solid 1px #d4d4d4; +} +.ui-grid-cell-empty { + display: inline-block; + width: 10px; + height: 10px; +} +.ui-grid-footer-info { + padding: 5px 10px; +} +.ui-grid-footer-panel-background { + background-color: #f3f3f3; +} +.ui-grid-footer-panel { + position: relative; + border-bottom: 1px solid #d4d4d4; + border-top: 1px solid #d4d4d4; + overflow: hidden; + font-weight: bold; + background-color: #f3f3f3; + -webkit-border-top-right-radius: -1px; + -webkit-border-bottom-right-radius: 0; + -webkit-border-bottom-left-radius: 0; + -webkit-border-top-left-radius: -1px; + -moz-border-radius-topright: -1px; + -moz-border-radius-bottomright: 0; + -moz-border-radius-bottomleft: 0; + -moz-border-radius-topleft: -1px; + border-top-right-radius: -1px; + border-bottom-right-radius: 0; + border-bottom-left-radius: 0; + border-top-left-radius: -1px; + -moz-background-clip: padding-box; + -webkit-background-clip: padding-box; + background-clip: padding-box; +} +.ui-grid-grid-footer { + float: left; + width: 100%; +} +.ui-grid-footer-viewport, +.ui-grid-footer-canvas { + height: 100%; +} +.ui-grid-footer-viewport { + overflow: hidden; +} +.ui-grid-footer-canvas { + position: relative; +} +.ui-grid-footer-canvas:before, +.ui-grid-footer-canvas:after { + content: ""; + display: table; + line-height: 0; +} +.ui-grid-footer-canvas:after { + clear: both; +} +.ui-grid-footer-cell-wrapper { + position: relative; + display: table; + box-sizing: border-box; + height: 100%; +} +.ui-grid-footer-cell-row { + display: table-row; +} +.ui-grid-footer-cell { + overflow: hidden; + background-color: inherit; + border-right: 1px solid; + border-color: #d4d4d4; + box-sizing: border-box; + display: table-cell; +} +.ui-grid-footer-cell:last-child { + border-right: 0; +} +.ui-grid-menu-button { + z-index: 2; + position: absolute; + right: 0; + top: 0; + background: #f3f3f3; + border: 0; + border-left: 1px solid #d4d4d4; + border-bottom: 1px solid #d4d4d4; + cursor: pointer; + height: 32px; + font-weight: normal; +} +.ui-grid-menu-button .ui-grid-icon-container { + margin-top: 5px; + margin-left: 2px; +} +.ui-grid-menu-button .ui-grid-menu { + right: 0; +} +.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid { + overflow: scroll; +} +.ui-grid-menu { + overflow: hidden; + max-width: 320px; + z-index: 2; + position: absolute; + right: 100%; + padding: 0 10px 20px 10px; + cursor: pointer; + box-sizing: border-box; +} +.ui-grid-menu-item { + width: 100%; + overflow: hidden; + text-overflow: ellipsis; + white-space: nowrap; +} +.ui-grid-menu .ui-grid-menu-inner { + background: #fff; + border: 1px solid #d4d4d4; + position: relative; + white-space: nowrap; + -webkit-border-radius: 0px; + -moz-border-radius: 0px; + border-radius: 0px; +} +.ui-grid-menu .ui-grid-menu-inner ul { + margin: 0; + padding: 0; + list-style-type: none; +} +.ui-grid-menu .ui-grid-menu-inner ul li { + padding: 0; +} +.ui-grid-menu .ui-grid-menu-inner ul li .ui-grid-menu-item { + color: #000; + min-width: 100%; + padding: 8px; + text-align: left; + background: transparent; + border: none; + cursor: default; +} +.ui-grid-menu .ui-grid-menu-inner ul li button.ui-grid-menu-item { + cursor: pointer; +} +.ui-grid-menu .ui-grid-menu-inner ul li button.ui-grid-menu-item:hover, +.ui-grid-menu .ui-grid-menu-inner ul li button.ui-grid-menu-item:focus { + background-color: #b3c4c7; +} +.ui-grid-menu .ui-grid-menu-inner ul li button.ui-grid-menu-item.ui-grid-menu-item-active { + background-color: #9cb2b6; +} +.ui-grid-menu .ui-grid-menu-inner ul li:not(:last-child) > .ui-grid-menu-item { + border-bottom: 1px solid #d4d4d4; +} +.ui-grid-sortarrow { + right: 5px; + position: absolute; + width: 20px; + top: 0; + bottom: 0; + background-position: center; +} +.ui-grid-sortarrow.down { + -webkit-transform: rotate(180deg); + -moz-transform: rotate(180deg); + -o-transform: rotate(180deg); + -ms-transform: rotate(180deg); + transform: rotate(180deg); +} +@font-face { + font-family: 'ui-grid'; + src: url('../fonts/ui-grid.eot'); + src: url('../fonts/ui-grid.eot#iefix') format('embedded-opentype'), url('../fonts/ui-grid.woff') format('woff'), url('../fonts/ui-grid.ttf') format('truetype'), url('../fonts/ui-grid.svg?#ui-grid') format('svg'); + font-weight: normal; + font-style: normal; +} +/* Chrome hack: SVG is rendered more smooth in Windozze. 100% magic, uncomment if you need it. */ +/* Note, that will break hinting! In other OS-es font will be not as sharp as it could be */ +/* +@media screen and (-webkit-min-device-pixel-ratio:0) { + @font-face { + font-family: 'ui-grid'; + src: url('@{font-path}ui-grid.svg?12312827#ui-grid') format('svg'); + } +} +*/ +[class^="ui-grid-icon"]:before, +[class*=" ui-grid-icon"]:before { + font-family: "ui-grid"; + font-style: normal; + font-weight: normal; + speak: none; + display: inline-block; + text-decoration: inherit; + width: 1em; + margin-right: 0.2em; + text-align: center; + /* opacity: .8; */ + /* For safety - reset parent styles, that can break glyph codes*/ + font-variant: normal; + text-transform: none; + /* fix buttons height, for twitter bootstrap */ + line-height: 1em; + /* Animation center compensation - margins should be symmetric */ + /* remove if not needed */ + margin-left: 0.2em; + /* you can be more comfortable with increased icons size */ + /* font-size: 120%; */ + /* Uncomment for 3D effect */ + /* text-shadow: 1px 1px 1px rgba(127, 127, 127, 0.3); */ +} +.ui-grid-icon-blank::before { + width: 1em; + content: ' '; +} +.ui-grid-icon-plus-squared:before { + content: '\c350'; +} +.ui-grid-icon-minus-squared:before { + content: '\c351'; +} +.ui-grid-icon-search:before { + content: '\c352'; +} +.ui-grid-icon-cancel:before { + content: '\c353'; +} +.ui-grid-icon-info-circled:before { + content: '\c354'; +} +.ui-grid-icon-lock:before { + content: '\c355'; +} +.ui-grid-icon-lock-open:before { + content: '\c356'; +} +.ui-grid-icon-pencil:before { + content: '\c357'; +} +.ui-grid-icon-down-dir:before { + content: '\c358'; +} +.ui-grid-icon-up-dir:before { + content: '\c359'; +} +.ui-grid-icon-left-dir:before { + content: '\c35a'; +} +.ui-grid-icon-right-dir:before { + content: '\c35b'; +} +.ui-grid-icon-left-open:before { + content: '\c35c'; +} +.ui-grid-icon-right-open:before { + content: '\c35d'; +} +.ui-grid-icon-angle-down:before { + content: '\c35e'; +} +.ui-grid-icon-filter:before { + content: '\c35f'; +} +.ui-grid-icon-sort-alt-up:before { + content: '\c360'; +} +.ui-grid-icon-sort-alt-down:before { + content: '\c361'; +} +.ui-grid-icon-ok:before { + content: '\c362'; +} +.ui-grid-icon-menu:before { + content: '\c363'; +} +.ui-grid-icon-indent-left:before { + content: '\e800'; +} +.ui-grid-icon-indent-right:before { + content: '\e801'; +} +.ui-grid-icon-spin5:before { + content: '\ea61'; +} +/* +* RTL Styles +*/ +.ui-grid[dir=rtl] .ui-grid-header-cell, +.ui-grid[dir=rtl] .ui-grid-footer-cell, +.ui-grid[dir=rtl] .ui-grid-cell { + float: right !important; +} +.ui-grid[dir=rtl] .ui-grid-column-menu-button { + position: absolute; + left: 1px; + top: 0; + right: inherit; +} +.ui-grid[dir=rtl] .ui-grid-cell:first-child, +.ui-grid[dir=rtl] .ui-grid-header-cell:first-child, +.ui-grid[dir=rtl] .ui-grid-footer-cell:first-child { + border-right: 0; +} +.ui-grid[dir=rtl] .ui-grid-cell:last-child, +.ui-grid[dir=rtl] .ui-grid-header-cell:last-child { + border-right: 1px solid #d4d4d4; + border-left: 0; +} +.ui-grid[dir=rtl] .ui-grid-header-cell:first-child .ui-grid-vertical-bar, +.ui-grid[dir=rtl] .ui-grid-footer-cell:first-child .ui-grid-vertical-bar, +.ui-grid[dir=rtl] .ui-grid-cell:first-child .ui-grid-vertical-bar { + width: 0; +} +.ui-grid[dir=rtl] .ui-grid-menu-button { + z-index: 2; + position: absolute; + left: 0; + right: auto; + background: #f3f3f3; + border: 1px solid #d4d4d4; + cursor: pointer; + min-height: 27px; + font-weight: normal; +} +.ui-grid[dir=rtl] .ui-grid-menu-button .ui-grid-menu { + left: 0; + right: auto; +} +.ui-grid[dir=rtl] .ui-grid-filter-container .ui-grid-filter-button { + right: initial; + left: 0; +} +.ui-grid[dir=rtl] .ui-grid-filter-container .ui-grid-filter-button [class^="ui-grid-icon"] { + right: initial; + left: 10px; +} +/* + Animation example, for spinners +*/ +.ui-grid-animate-spin { + -moz-animation: ui-grid-spin 2s infinite linear; + -o-animation: ui-grid-spin 2s infinite linear; + -webkit-animation: ui-grid-spin 2s infinite linear; + animation: ui-grid-spin 2s infinite linear; + display: inline-block; +} +@-moz-keyframes ui-grid-spin { + 0% { + -moz-transform: rotate(0deg); + -o-transform: rotate(0deg); + -webkit-transform: rotate(0deg); + transform: rotate(0deg); + } + 100% { + -moz-transform: rotate(359deg); + -o-transform: rotate(359deg); + -webkit-transform: rotate(359deg); + transform: rotate(359deg); + } +} +@-webkit-keyframes ui-grid-spin { + 0% { + -moz-transform: rotate(0deg); + -o-transform: rotate(0deg); + -webkit-transform: rotate(0deg); + transform: rotate(0deg); + } + 100% { + -moz-transform: rotate(359deg); + -o-transform: rotate(359deg); + -webkit-transform: rotate(359deg); + transform: rotate(359deg); + } +} +@-o-keyframes ui-grid-spin { + 0% { + -moz-transform: rotate(0deg); + -o-transform: rotate(0deg); + -webkit-transform: rotate(0deg); + transform: rotate(0deg); + } + 100% { + -moz-transform: rotate(359deg); + -o-transform: rotate(359deg); + -webkit-transform: rotate(359deg); + transform: rotate(359deg); + } +} +@-ms-keyframes ui-grid-spin { + 0% { + -moz-transform: rotate(0deg); + -o-transform: rotate(0deg); + -webkit-transform: rotate(0deg); + transform: rotate(0deg); + } + 100% { + -moz-transform: rotate(359deg); + -o-transform: rotate(359deg); + -webkit-transform: rotate(359deg); + transform: rotate(359deg); + } +} +@keyframes ui-grid-spin { + 0% { + -moz-transform: rotate(0deg); + -o-transform: rotate(0deg); + -webkit-transform: rotate(0deg); + transform: rotate(0deg); + } + 100% { + -moz-transform: rotate(359deg); + -o-transform: rotate(359deg); + -webkit-transform: rotate(359deg); + transform: rotate(359deg); + } +} diff --git a/release/4.9.2/css/ui-grid.core.min.css b/release/4.9.2/css/ui-grid.core.min.css new file mode 100644 index 000000000..d872513d5 --- /dev/null +++ b/release/4.9.2/css/ui-grid.core.min.css @@ -0,0 +1,4 @@ +/*! + * ui-grid - v4.9.2 - 2020-12-01 + * Copyright (c) 2020 ; License: MIT + */.ui-grid{border:1px solid #d4d4d4;box-sizing:content-box;-webkit-border-radius:0;-moz-border-radius:0;border-radius:0;-webkit-transform:translateZ(0);-moz-transform:translateZ(0);-o-transform:translateZ(0);-ms-transform:translateZ(0);transform:translateZ(0)}.ui-grid-vertical-bar{position:absolute;right:0;width:0}.ui-grid-header-cell:not(:last-child) .ui-grid-vertical-bar,.ui-grid-cell:not(:last-child) .ui-grid-vertical-bar{width:1px}.ui-grid-scrollbar-placeholder{background-color:transparent}.ui-grid-header-cell:not(:last-child) .ui-grid-vertical-bar{background-color:#d4d4d4}.ui-grid-cell:not(:last-child) .ui-grid-vertical-bar{background-color:#d4d4d4}.ui-grid-header-cell:last-child .ui-grid-vertical-bar{right:-1px;width:1px;background-color:#d4d4d4}.ui-grid-clearfix:before,.ui-grid-clearfix:after{content:"";display:table}.ui-grid-clearfix:after{clear:both}.ui-grid-invisible{visibility:hidden}.ui-grid-contents-wrapper{position:relative;height:100%;width:100%}.ui-grid-sr-only{position:absolute;width:1px;height:1px;margin:-1px;padding:0;overflow:hidden;clip:rect(0, 0, 0, 0);border:0}.ui-grid-icon-button{background-color:transparent;border:none;padding:0}.clickable{cursor:pointer}.ui-grid-top-panel-background{background-color:#f3f3f3}.ui-grid-header{border-bottom:1px solid #d4d4d4;box-sizing:border-box}.ui-grid-top-panel{position:relative;overflow:hidden;font-weight:bold;background-color:#f3f3f3;-webkit-border-top-right-radius:-1px;-webkit-border-bottom-right-radius:0;-webkit-border-bottom-left-radius:0;-webkit-border-top-left-radius:-1px;-moz-border-radius-topright:-1px;-moz-border-radius-bottomright:0;-moz-border-radius-bottomleft:0;-moz-border-radius-topleft:-1px;border-top-right-radius:-1px;border-bottom-right-radius:0;border-bottom-left-radius:0;border-top-left-radius:-1px;-moz-background-clip:padding-box;-webkit-background-clip:padding-box;background-clip:padding-box}.ui-grid-header-viewport{overflow:hidden}.ui-grid-header-canvas:before,.ui-grid-header-canvas:after{content:"";display:-ms-flexbox;display:flex;line-height:0}.ui-grid-header-canvas:after{clear:both}.ui-grid-header-cell-wrapper{position:relative;display:-ms-flexbox;display:flex;box-sizing:border-box;height:100%;width:100%}.ui-grid-header-cell-row{display:-ms-flexbox;display:flex;-ms-flex-direction:row;flex-direction:row;-ms-flex-wrap:wrap;flex-wrap:wrap}.ui-grid-header-cell{position:relative;box-sizing:border-box;background-color:inherit;border-right:1px solid;border-color:#d4d4d4;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;width:0}.ui-grid-header-cell:last-child{border-right:0}.ui-grid-header-cell .sortable{cursor:pointer}.ui-grid-header-cell .ui-grid-sort-priority-number{margin-left:-8px}.ui-grid-header-cell>div{-ms-flex-basis:100%;flex-basis:100%}.ui-grid-header .ui-grid-vertical-bar{top:0;bottom:0}.ui-grid-column-menu-button{position:absolute;right:1px;top:0}.ui-grid-column-menu-button .ui-grid-icon-angle-down{vertical-align:sub}.ui-grid-header-cell-last-col .ui-grid-cell-contents,.ui-grid-header-cell-last-col .ui-grid-filter-container,.ui-grid-header-cell-last-col .ui-grid-column-menu-button,.ui-grid-header-cell-last-col+.ui-grid-column-resizer.right{margin-right:13px}.ui-grid-render-container-right .ui-grid-header-cell-last-col .ui-grid-cell-contents,.ui-grid-render-container-right .ui-grid-header-cell-last-col .ui-grid-filter-container,.ui-grid-render-container-right .ui-grid-header-cell-last-col .ui-grid-column-menu-button,.ui-grid-render-container-right .ui-grid-header-cell-last-col+.ui-grid-column-resizer.right{margin-right:28px}.ui-grid-column-menu{position:absolute}.ui-grid-column-menu .ui-grid-menu .ui-grid-menu-mid.ng-hide-add,.ui-grid-column-menu .ui-grid-menu .ui-grid-menu-mid.ng-hide-remove{-webkit-transition:all .04s linear;-moz-transition:all .04s linear;-o-transition:all .04s linear;transition:all .04s linear;display:block !important}.ui-grid-column-menu .ui-grid-menu .ui-grid-menu-mid.ng-hide-add.ng-hide-add-active,.ui-grid-column-menu .ui-grid-menu .ui-grid-menu-mid.ng-hide-remove{-webkit-transform:translateY(-100%);-moz-transform:translateY(-100%);-o-transform:translateY(-100%);-ms-transform:translateY(-100%);transform:translateY(-100%)}.ui-grid-column-menu .ui-grid-menu .ui-grid-menu-mid.ng-hide-add,.ui-grid-column-menu .ui-grid-menu .ui-grid-menu-mid.ng-hide-remove.ng-hide-remove-active{-webkit-transform:translateY(0);-moz-transform:translateY(0);-o-transform:translateY(0);-ms-transform:translateY(0);transform:translateY(0)}.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid.ng-hide-add,.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid.ng-hide-remove{-webkit-transition:all .04s linear;-moz-transition:all .04s linear;-o-transition:all .04s linear;transition:all .04s linear;display:block !important}.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid.ng-hide-add.ng-hide-add-active,.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid.ng-hide-remove{-webkit-transform:translateY(-100%);-moz-transform:translateY(-100%);-o-transform:translateY(-100%);-ms-transform:translateY(-100%);transform:translateY(-100%)}.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid.ng-hide-add,.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid.ng-hide-remove.ng-hide-remove-active{-webkit-transform:translateY(0);-moz-transform:translateY(0);-o-transform:translateY(0);-ms-transform:translateY(0);transform:translateY(0)}.ui-grid-filter-container{padding:4px 10px;position:relative}.ui-grid-filter-container .ui-grid-filter-button{position:absolute;top:0;bottom:0;right:0}.ui-grid-filter-container .ui-grid-filter-button [class^="ui-grid-icon"]{position:absolute;top:50%;line-height:32px;margin-top:-16px;right:10px;opacity:.66}.ui-grid-filter-container .ui-grid-filter-button [class^="ui-grid-icon"]:hover{opacity:1}.ui-grid-filter-container .ui-grid-filter-button-select{position:absolute;top:0;bottom:0;right:0}.ui-grid-filter-container .ui-grid-filter-button-select [class^="ui-grid-icon"]{position:absolute;top:50%;line-height:32px;margin-top:-16px;right:0px;opacity:.66}.ui-grid-filter-container .ui-grid-filter-button-select [class^="ui-grid-icon"]:hover{opacity:1}input[type="text"].ui-grid-filter-input{box-sizing:border-box;padding:0 18px 0 0;margin:0;width:100%;border:1px solid #d4d4d4;-webkit-border-top-right-radius:0;-webkit-border-bottom-right-radius:0;-webkit-border-bottom-left-radius:0;-webkit-border-top-left-radius:0;-moz-border-radius-topright:0;-moz-border-radius-bottomright:0;-moz-border-radius-bottomleft:0;-moz-border-radius-topleft:0;border-top-right-radius:0;border-bottom-right-radius:0;border-bottom-left-radius:0;border-top-left-radius:0;-moz-background-clip:padding-box;-webkit-background-clip:padding-box;background-clip:padding-box}input[type="text"].ui-grid-filter-input:hover{border:1px solid #d4d4d4}select.ui-grid-filter-select{padding:0;margin:0;border:0;width:90%;border:1px solid #d4d4d4;-webkit-border-top-right-radius:0;-webkit-border-bottom-right-radius:0;-webkit-border-bottom-left-radius:0;-webkit-border-top-left-radius:0;-moz-border-radius-topright:0;-moz-border-radius-bottomright:0;-moz-border-radius-bottomleft:0;-moz-border-radius-topleft:0;border-top-right-radius:0;border-bottom-right-radius:0;border-bottom-left-radius:0;border-top-left-radius:0;-moz-background-clip:padding-box;-webkit-background-clip:padding-box;background-clip:padding-box}select.ui-grid-filter-select:hover{border:1px solid #d4d4d4}.ui-grid-filter-cancel-button-hidden select.ui-grid-filter-select{width:100%}.ui-grid-render-container{position:inherit;-webkit-border-top-right-radius:0;-webkit-border-bottom-right-radius:0;-webkit-border-bottom-left-radius:0;-webkit-border-top-left-radius:0;-moz-border-radius-topright:0;-moz-border-radius-bottomright:0;-moz-border-radius-bottomleft:0;-moz-border-radius-topleft:0;border-top-right-radius:0;border-bottom-right-radius:0;border-bottom-left-radius:0;border-top-left-radius:0;-moz-background-clip:padding-box;-webkit-background-clip:padding-box;background-clip:padding-box}.ui-grid-render-container:focus{outline:none}.ui-grid-viewport{min-height:20px;position:relative;overflow-y:scroll;-webkit-overflow-scrolling:touch}.ui-grid-viewport:focus{outline:none !important}.ui-grid-canvas{position:relative;padding-top:1px}.ui-grid-row{clear:both}.ui-grid-row:nth-child(odd) .ui-grid-cell{background-color:#fdfdfd}.ui-grid-row:nth-child(even) .ui-grid-cell{background-color:#f3f3f3}.ui-grid-row:last-child .ui-grid-cell{border-bottom-color:#d4d4d4;border-bottom-style:solid}.ui-grid-row:hover>[ui-grid-row]>.ui-grid-cell:hover .ui-grid-cell,.ui-grid-row:nth-child(odd):hover .ui-grid-cell,.ui-grid-row:nth-child(even):hover .ui-grid-cell{background-color:#d5eaee}.ui-grid-no-row-overlay{position:absolute;top:0;bottom:0;left:0;right:0;margin:10%;background-color:#f3f3f3;-webkit-border-top-right-radius:0;-webkit-border-bottom-right-radius:0;-webkit-border-bottom-left-radius:0;-webkit-border-top-left-radius:0;-moz-border-radius-topright:0;-moz-border-radius-bottomright:0;-moz-border-radius-bottomleft:0;-moz-border-radius-topleft:0;border-top-right-radius:0;border-bottom-right-radius:0;border-bottom-left-radius:0;border-top-left-radius:0;-moz-background-clip:padding-box;-webkit-background-clip:padding-box;background-clip:padding-box;border:1px solid #d4d4d4;font-size:2em;text-align:center}.ui-grid-no-row-overlay>*{position:absolute;display:table;margin:auto 0;width:100%;top:0;bottom:0;left:0;right:0;opacity:.66}.ui-grid-cell{overflow:hidden;float:left;background-color:inherit;border-right:1px solid;border-color:#d4d4d4;box-sizing:border-box}.ui-grid-cell:last-child{border-right:0}.ui-grid-cell-contents{padding:5px;-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box;white-space:nowrap;-ms-text-overflow:ellipsis;-o-text-overflow:ellipsis;text-overflow:ellipsis;overflow:hidden;height:100%}.ui-grid-cell-contents-hidden{visibility:hidden;width:0;height:0;display:none}.ui-grid-row .ui-grid-cell.ui-grid-row-header-cell{background-color:#F0F0EE;border-bottom:solid 1px #d4d4d4}.ui-grid-cell-empty{display:inline-block;width:10px;height:10px}.ui-grid-footer-info{padding:5px 10px}.ui-grid-footer-panel-background{background-color:#f3f3f3}.ui-grid-footer-panel{position:relative;border-bottom:1px solid #d4d4d4;border-top:1px solid #d4d4d4;overflow:hidden;font-weight:bold;background-color:#f3f3f3;-webkit-border-top-right-radius:-1px;-webkit-border-bottom-right-radius:0;-webkit-border-bottom-left-radius:0;-webkit-border-top-left-radius:-1px;-moz-border-radius-topright:-1px;-moz-border-radius-bottomright:0;-moz-border-radius-bottomleft:0;-moz-border-radius-topleft:-1px;border-top-right-radius:-1px;border-bottom-right-radius:0;border-bottom-left-radius:0;border-top-left-radius:-1px;-moz-background-clip:padding-box;-webkit-background-clip:padding-box;background-clip:padding-box}.ui-grid-grid-footer{float:left;width:100%}.ui-grid-footer-viewport,.ui-grid-footer-canvas{height:100%}.ui-grid-footer-viewport{overflow:hidden}.ui-grid-footer-canvas{position:relative}.ui-grid-footer-canvas:before,.ui-grid-footer-canvas:after{content:"";display:table;line-height:0}.ui-grid-footer-canvas:after{clear:both}.ui-grid-footer-cell-wrapper{position:relative;display:table;box-sizing:border-box;height:100%}.ui-grid-footer-cell-row{display:table-row}.ui-grid-footer-cell{overflow:hidden;background-color:inherit;border-right:1px solid;border-color:#d4d4d4;box-sizing:border-box;display:table-cell}.ui-grid-footer-cell:last-child{border-right:0}.ui-grid-menu-button{z-index:2;position:absolute;right:0;top:0;background:#f3f3f3;border:0;border-left:1px solid #d4d4d4;border-bottom:1px solid #d4d4d4;cursor:pointer;height:32px;font-weight:normal}.ui-grid-menu-button .ui-grid-icon-container{margin-top:5px;margin-left:2px}.ui-grid-menu-button .ui-grid-menu{right:0}.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid{overflow:scroll}.ui-grid-menu{overflow:hidden;max-width:320px;z-index:2;position:absolute;right:100%;padding:0 10px 20px 10px;cursor:pointer;box-sizing:border-box}.ui-grid-menu-item{width:100%;overflow:hidden;text-overflow:ellipsis;white-space:nowrap}.ui-grid-menu .ui-grid-menu-inner{background:#fff;border:1px solid #d4d4d4;position:relative;white-space:nowrap;-webkit-border-radius:0;-moz-border-radius:0;border-radius:0}.ui-grid-menu .ui-grid-menu-inner ul{margin:0;padding:0;list-style-type:none}.ui-grid-menu .ui-grid-menu-inner ul li{padding:0}.ui-grid-menu .ui-grid-menu-inner ul li .ui-grid-menu-item{color:#000;min-width:100%;padding:8px;text-align:left;background:transparent;border:none;cursor:default}.ui-grid-menu .ui-grid-menu-inner ul li button.ui-grid-menu-item{cursor:pointer}.ui-grid-menu .ui-grid-menu-inner ul li button.ui-grid-menu-item:hover,.ui-grid-menu .ui-grid-menu-inner ul li button.ui-grid-menu-item:focus{background-color:#b3c4c7}.ui-grid-menu .ui-grid-menu-inner ul li button.ui-grid-menu-item.ui-grid-menu-item-active{background-color:#9cb2b6}.ui-grid-menu .ui-grid-menu-inner ul li:not(:last-child)>.ui-grid-menu-item{border-bottom:1px solid #d4d4d4}.ui-grid-sortarrow{right:5px;position:absolute;width:20px;top:0;bottom:0;background-position:center}.ui-grid-sortarrow.down{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-o-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}@font-face{font-family:'ui-grid';src:url('../fonts/ui-grid.eot');src:url('../fonts/ui-grid.eot#iefix') format('embedded-opentype'),url('../fonts/ui-grid.woff') format('woff'),url('../fonts/ui-grid.ttf') format('truetype'),url('../fonts/ui-grid.svg?#ui-grid') format('svg');font-weight:normal;font-style:normal}[class^="ui-grid-icon"]:before,[class*=" ui-grid-icon"]:before{font-family:"ui-grid";font-style:normal;font-weight:normal;speak:none;display:inline-block;text-decoration:inherit;width:1em;margin-right:.2em;text-align:center;font-variant:normal;text-transform:none;line-height:1em;margin-left:.2em}.ui-grid-icon-blank::before{width:1em;content:' '}.ui-grid-icon-plus-squared:before{content:'\c350'}.ui-grid-icon-minus-squared:before{content:'\c351'}.ui-grid-icon-search:before{content:'\c352'}.ui-grid-icon-cancel:before{content:'\c353'}.ui-grid-icon-info-circled:before{content:'\c354'}.ui-grid-icon-lock:before{content:'\c355'}.ui-grid-icon-lock-open:before{content:'\c356'}.ui-grid-icon-pencil:before{content:'\c357'}.ui-grid-icon-down-dir:before{content:'\c358'}.ui-grid-icon-up-dir:before{content:'\c359'}.ui-grid-icon-left-dir:before{content:'\c35a'}.ui-grid-icon-right-dir:before{content:'\c35b'}.ui-grid-icon-left-open:before{content:'\c35c'}.ui-grid-icon-right-open:before{content:'\c35d'}.ui-grid-icon-angle-down:before{content:'\c35e'}.ui-grid-icon-filter:before{content:'\c35f'}.ui-grid-icon-sort-alt-up:before{content:'\c360'}.ui-grid-icon-sort-alt-down:before{content:'\c361'}.ui-grid-icon-ok:before{content:'\c362'}.ui-grid-icon-menu:before{content:'\c363'}.ui-grid-icon-indent-left:before{content:'\e800'}.ui-grid-icon-indent-right:before{content:'\e801'}.ui-grid-icon-spin5:before{content:'\ea61'}.ui-grid[dir=rtl] .ui-grid-header-cell,.ui-grid[dir=rtl] .ui-grid-footer-cell,.ui-grid[dir=rtl] .ui-grid-cell{float:right !important}.ui-grid[dir=rtl] .ui-grid-column-menu-button{position:absolute;left:1px;top:0;right:inherit}.ui-grid[dir=rtl] .ui-grid-cell:first-child,.ui-grid[dir=rtl] .ui-grid-header-cell:first-child,.ui-grid[dir=rtl] .ui-grid-footer-cell:first-child{border-right:0}.ui-grid[dir=rtl] .ui-grid-cell:last-child,.ui-grid[dir=rtl] .ui-grid-header-cell:last-child{border-right:1px solid #d4d4d4;border-left:0}.ui-grid[dir=rtl] .ui-grid-header-cell:first-child .ui-grid-vertical-bar,.ui-grid[dir=rtl] .ui-grid-footer-cell:first-child .ui-grid-vertical-bar,.ui-grid[dir=rtl] .ui-grid-cell:first-child .ui-grid-vertical-bar{width:0}.ui-grid[dir=rtl] .ui-grid-menu-button{z-index:2;position:absolute;left:0;right:auto;background:#f3f3f3;border:1px solid #d4d4d4;cursor:pointer;min-height:27px;font-weight:normal}.ui-grid[dir=rtl] .ui-grid-menu-button .ui-grid-menu{left:0;right:auto}.ui-grid[dir=rtl] .ui-grid-filter-container .ui-grid-filter-button{right:initial;left:0}.ui-grid[dir=rtl] .ui-grid-filter-container .ui-grid-filter-button [class^="ui-grid-icon"]{right:initial;left:10px}.ui-grid-animate-spin{-moz-animation:ui-grid-spin 2s infinite linear;-o-animation:ui-grid-spin 2s infinite linear;-webkit-animation:ui-grid-spin 2s infinite linear;animation:ui-grid-spin 2s infinite linear;display:inline-block}@-moz-keyframes ui-grid-spin{0%{-moz-transform:rotate(0deg);-o-transform:rotate(0deg);-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-moz-transform:rotate(359deg);-o-transform:rotate(359deg);-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@-webkit-keyframes ui-grid-spin{0%{-moz-transform:rotate(0deg);-o-transform:rotate(0deg);-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-moz-transform:rotate(359deg);-o-transform:rotate(359deg);-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@-o-keyframes ui-grid-spin{0%{-moz-transform:rotate(0deg);-o-transform:rotate(0deg);-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-moz-transform:rotate(359deg);-o-transform:rotate(359deg);-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@-ms-keyframes ui-grid-spin{0%{-moz-transform:rotate(0deg);-o-transform:rotate(0deg);-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-moz-transform:rotate(359deg);-o-transform:rotate(359deg);-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes ui-grid-spin{0%{-moz-transform:rotate(0deg);-o-transform:rotate(0deg);-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-moz-transform:rotate(359deg);-o-transform:rotate(359deg);-webkit-transform:rotate(359deg);transform:rotate(359deg)}} \ No newline at end of file diff --git a/release/4.9.2/css/ui-grid.edit.css b/release/4.9.2/css/ui-grid.edit.css new file mode 100644 index 000000000..be3d1461c --- /dev/null +++ b/release/4.9.2/css/ui-grid.edit.css @@ -0,0 +1,23 @@ +.ui-grid-cell input { + border-radius: inherit; + padding: 0; + width: 100%; + color: inherit; + height: auto; + font: inherit; + outline: none; +} +.ui-grid-cell input:focus { + color: inherit; + outline: none; +} +.ui-grid-cell input[type="checkbox"] { + margin: 9px 0 0 6px; + width: auto; +} +.ui-grid-cell input.ng-invalid { + border: 1px solid #fc8f8f; +} +.ui-grid-cell input.ng-valid { + border: 1px solid #d4d4d4; +} diff --git a/release/4.9.2/css/ui-grid.edit.min.css b/release/4.9.2/css/ui-grid.edit.min.css new file mode 100644 index 000000000..64ea11477 --- /dev/null +++ b/release/4.9.2/css/ui-grid.edit.min.css @@ -0,0 +1 @@ +.ui-grid-cell input{border-radius:inherit;padding:0;width:100%;color:inherit;height:auto;font:inherit;outline:none}.ui-grid-cell input:focus{color:inherit;outline:none}.ui-grid-cell input[type="checkbox"]{margin:9px 0 0 6px;width:auto}.ui-grid-cell input.ng-invalid{border:1px solid #fc8f8f}.ui-grid-cell input.ng-valid{border:1px solid #d4d4d4} \ No newline at end of file diff --git a/release/4.9.2/css/ui-grid.empty-base-layer.css b/release/4.9.2/css/ui-grid.empty-base-layer.css new file mode 100644 index 000000000..0bb8c09ae --- /dev/null +++ b/release/4.9.2/css/ui-grid.empty-base-layer.css @@ -0,0 +1,6 @@ +.ui-grid-viewport .ui-grid-empty-base-layer-container { + position: absolute; + overflow: hidden; + pointer-events: none; + z-index: -1; +} diff --git a/release/4.9.2/css/ui-grid.empty-base-layer.min.css b/release/4.9.2/css/ui-grid.empty-base-layer.min.css new file mode 100644 index 000000000..f89c68ac3 --- /dev/null +++ b/release/4.9.2/css/ui-grid.empty-base-layer.min.css @@ -0,0 +1 @@ +.ui-grid-viewport .ui-grid-empty-base-layer-container{position:absolute;overflow:hidden;pointer-events:none;z-index:-1} \ No newline at end of file diff --git a/release/4.9.2/css/ui-grid.expandable.css b/release/4.9.2/css/ui-grid.expandable.css new file mode 100644 index 000000000..541349049 --- /dev/null +++ b/release/4.9.2/css/ui-grid.expandable.css @@ -0,0 +1,16 @@ +.expandableRow .ui-grid-row:nth-child(odd) .ui-grid-cell { + background-color: #fdfdfd; +} +.expandableRow .ui-grid-row:nth-child(even) .ui-grid-cell { + background-color: #f3f3f3; +} +.ui-grid-cell.ui-grid-disable-selection.ui-grid-row-header-cell { + pointer-events: none; +} +.ui-grid-expandable-buttons-cell i { + pointer-events: all; +} +.scrollFiller { + float: left; + border: 1px solid #d4d4d4; +} diff --git a/release/4.9.2/css/ui-grid.expandable.min.css b/release/4.9.2/css/ui-grid.expandable.min.css new file mode 100644 index 000000000..2c133841a --- /dev/null +++ b/release/4.9.2/css/ui-grid.expandable.min.css @@ -0,0 +1 @@ +.expandableRow .ui-grid-row:nth-child(odd) .ui-grid-cell{background-color:#fdfdfd}.expandableRow .ui-grid-row:nth-child(even) .ui-grid-cell{background-color:#f3f3f3}.ui-grid-cell.ui-grid-disable-selection.ui-grid-row-header-cell{pointer-events:none}.ui-grid-expandable-buttons-cell i{pointer-events:all}.scrollFiller{float:left;border:1px solid #d4d4d4} \ No newline at end of file diff --git a/release/4.9.2/css/ui-grid.exporter.css b/release/4.9.2/css/ui-grid.exporter.css new file mode 100644 index 000000000..e69de29bb diff --git a/release/4.9.2/css/ui-grid.exporter.min.css b/release/4.9.2/css/ui-grid.exporter.min.css new file mode 100644 index 000000000..e69de29bb diff --git a/release/4.9.2/css/ui-grid.grouping.css b/release/4.9.2/css/ui-grid.grouping.css new file mode 100644 index 000000000..e0ba6cd1e --- /dev/null +++ b/release/4.9.2/css/ui-grid.grouping.css @@ -0,0 +1,3 @@ +.ui-grid-tree-header-row { + font-weight: bold !important; +} diff --git a/release/4.9.2/css/ui-grid.grouping.min.css b/release/4.9.2/css/ui-grid.grouping.min.css new file mode 100644 index 000000000..599cde666 --- /dev/null +++ b/release/4.9.2/css/ui-grid.grouping.min.css @@ -0,0 +1 @@ +.ui-grid-tree-header-row{font-weight:bold !important} \ No newline at end of file diff --git a/release/4.9.2/css/ui-grid.importer.css b/release/4.9.2/css/ui-grid.importer.css new file mode 100644 index 000000000..e69de29bb diff --git a/release/4.9.2/css/ui-grid.importer.min.css b/release/4.9.2/css/ui-grid.importer.min.css new file mode 100644 index 000000000..e69de29bb diff --git a/release/4.9.2/css/ui-grid.move-columns.css b/release/4.9.2/css/ui-grid.move-columns.css new file mode 100644 index 000000000..2c8fa80dc --- /dev/null +++ b/release/4.9.2/css/ui-grid.move-columns.css @@ -0,0 +1,9 @@ +.movingColumn { + position: absolute; + top: 0; + border: 1px solid #d4d4d4; + box-shadow: inset 0 0 14px rgba(0, 0, 0, 0.2); +} +.movingColumn .ui-grid-icon-angle-down { + display: none; +} diff --git a/release/4.9.2/css/ui-grid.move-columns.min.css b/release/4.9.2/css/ui-grid.move-columns.min.css new file mode 100644 index 000000000..064caf5e5 --- /dev/null +++ b/release/4.9.2/css/ui-grid.move-columns.min.css @@ -0,0 +1 @@ +.movingColumn{position:absolute;top:0;border:1px solid #d4d4d4;box-shadow:inset 0 0 14px rgba(0,0,0,0.2)}.movingColumn .ui-grid-icon-angle-down{display:none} \ No newline at end of file diff --git a/release/4.9.2/css/ui-grid.pagination.css b/release/4.9.2/css/ui-grid.pagination.css new file mode 100644 index 000000000..9799fa37e --- /dev/null +++ b/release/4.9.2/css/ui-grid.pagination.css @@ -0,0 +1,299 @@ +/* This file contains variable declarations (do not remove this line) */ +/*-- VARIABLES (DO NOT REMOVE THESE COMMENTS) --*/ +/** +* @section Grid styles +*/ +/** +* @section Header styles +*/ +/** @description Colors for header gradient */ +/** +* @section Grid body styles +*/ +/** @description Colors used for row alternation */ +/** +* @section Grid Menu colors +*/ +/** +* @section Sort arrow colors +*/ +/** +* @section Scrollbar styles +*/ +/** +* @section font library path +*/ +/*-- END VARIABLES (DO NOT REMOVE THESE COMMENTS) --*/ +/*--------------------------------------------------- + LESS Elements 0.9 + --------------------------------------------------- + A set of useful LESS mixins + More info at: http://lesselements.com + ---------------------------------------------------*/ +.ui-grid-pager-panel { + display: flex; + justify-content: space-between; + align-items: center; + position: absolute; + left: 0; + bottom: 0; + width: 100%; + padding-top: 3px; + padding-bottom: 3px; + box-sizing: content-box; +} +.ui-grid-pager-container { + float: left; +} +.ui-grid-pager-control { + padding: 5px 0; + display: flex; + flex-flow: row nowrap; + align-items: center; + margin-right: 10px; + margin-left: 10px; + min-width: 135px; + float: left; +} +.ui-grid-pager-control button, +.ui-grid-pager-control span, +.ui-grid-pager-control input { + margin-right: 4px; +} +.ui-grid-pager-control button { + height: 25px; + min-width: 26px; + display: inline-block; + margin-bottom: 0; + font-weight: normal; + text-align: center; + vertical-align: middle; + touch-action: manipulation; + cursor: pointer; + background: #f3f3f3; + border: 1px solid #ccc; + white-space: nowrap; + padding: 6px 12px; + font-size: 14px; + line-height: 1.42857143; + border-radius: 4px; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + color: #eee; +} +.ui-grid-pager-control button:hover { + border-color: #adadad; + text-decoration: none; +} +.ui-grid-pager-control button:focus { + border-color: #8c8c8c; + text-decoration: none; + outline: 5px auto -webkit-focus-ring-color; + outline-offset: -2px; +} +.ui-grid-pager-control button:active { + border-color: #adadad; + outline: 0; + -webkit-box-shadow: inset 0 3px 5px rgba(0, 0, 0, 0.125); + box-shadow: inset 0 3px 5px rgba(0, 0, 0, 0.125); +} +.ui-grid-pager-control button:active:focus { + outline: 5px auto -webkit-focus-ring-color; + outline-offset: -2px; +} +.ui-grid-pager-control button:active:hover, +.ui-grid-pager-control button:active:focus { + background-color: #c8c8c8; + border-color: #8c8c8c; +} +.ui-grid-pager-control button:hover, +.ui-grid-pager-control button:focus, +.ui-grid-pager-control button:active { + color: #eee; + background: #dadada; +} +.ui-grid-pager-control button[disabled] { + cursor: not-allowed; + opacity: 0.65; + filter: alpha(opacity=65); + -webkit-box-shadow: none; + box-shadow: none; +} +.ui-grid-pager-control button[disabled]:hover, +.ui-grid-pager-control button[disabled]:focus { + background-color: #f3f3f3; + border-color: #ccc; +} +.ui-grid-pager-control input { + display: inline; + height: 26px; + width: 50px; + vertical-align: top; + color: #555555; + background: #fff; + border: 1px solid #ccc; + -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075); + box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075); + -webkit-transition: border-color ease-in-out 0.15s, box-shadow ease-in-out 0.15s; + -o-transition: border-color ease-in-out 0.15s, box-shadow ease-in-out 0.15s; + transition: border-color ease-in-out 0.15s, box-shadow ease-in-out 0.15s; + padding: 5px 10px; + font-size: 12px; + line-height: 1.5; + border-radius: 3px; +} +.ui-grid-pager-control input:focus { + border-color: #66afe9; + outline: 0; + -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 8px rgba(102, 175, 233, 0.6); + box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 8px rgba(102, 175, 233, 0.6); +} +.ui-grid-pager-control input[disabled], +.ui-grid-pager-control input[readonly], +.ui-grid-pager-control input::-moz-placeholder { + opacity: 1; +} +.ui-grid-pager-control input::-moz-placeholder, +.ui-grid-pager-control input:-ms-input-placeholder, +.ui-grid-pager-control input::-webkit-input-placeholder { + color: #999; +} +.ui-grid-pager-control input::-ms-expand { + border: 0; + background-color: transparent; +} +.ui-grid-pager-control input[disabled], +.ui-grid-pager-control input[readonly] { + background-color: #eeeeee; +} +.ui-grid-pager-control input[disabled] { + cursor: not-allowed; +} +.ui-grid-pager-control .ui-grid-pager-max-pages-number { + vertical-align: bottom; +} +.ui-grid-pager-control .ui-grid-pager-max-pages-number > * { + vertical-align: bottom; +} +.ui-grid-pager-control .ui-grid-pager-max-pages-number abbr { + border-bottom: none; + text-decoration: none; +} +.ui-grid-pager-control .first-bar { + width: 10px; + border-left: 2px solid #4d4d4d; + margin-top: -6px; + height: 12px; + margin-left: -3px; +} +.ui-grid-pager-control .first-bar-rtl { + width: 10px; + border-left: 2px solid #4d4d4d; + margin-top: -6px; + height: 12px; + margin-right: -7px; +} +.ui-grid-pager-control .first-triangle { + width: 0; + height: 0; + border-style: solid; + border-width: 5px 8.7px 5px 0; + border-color: transparent #4d4d4d transparent transparent; + margin-left: 2px; +} +.ui-grid-pager-control .next-triangle { + margin-left: 1px; +} +.ui-grid-pager-control .prev-triangle { + margin-left: 0; +} +.ui-grid-pager-control .last-triangle { + width: 0; + height: 0; + border-style: solid; + border-width: 5px 0 5px 8.7px; + border-color: transparent transparent transparent #4d4d4d; + margin-left: -1px; +} +.ui-grid-pager-control .last-bar { + width: 10px; + border-left: 2px solid #4d4d4d; + margin-top: -6px; + height: 12px; + margin-left: 1px; +} +.ui-grid-pager-control .last-bar-rtl { + width: 10px; + border-left: 2px solid #4d4d4d; + margin-top: -6px; + height: 12px; + margin-right: -11px; +} +.ui-grid-pager-row-count-picker { + float: left; + padding: 5px 10px; +} +.ui-grid-pager-row-count-picker select { + color: #555555; + background: #fff; + border: 1px solid #ccc; + -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075); + box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075); + -webkit-transition: border-color ease-in-out 0.15s, box-shadow ease-in-out 0.15s; + -o-transition: border-color ease-in-out 0.15s, box-shadow ease-in-out 0.15s; + transition: border-color ease-in-out 0.15s, box-shadow ease-in-out 0.15s; + padding: 5px 10px; + font-size: 12px; + line-height: 1.5; + border-radius: 3px; + height: 25px; + width: 67px; + display: inline; + vertical-align: middle; +} +.ui-grid-pager-row-count-picker select:focus { + border-color: #66afe9; + outline: 0; + -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 8px rgba(102, 175, 233, 0.6); + box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 8px rgba(102, 175, 233, 0.6); +} +.ui-grid-pager-row-count-picker select[disabled], +.ui-grid-pager-row-count-picker select[readonly], +.ui-grid-pager-row-count-picker select::-moz-placeholder { + opacity: 1; +} +.ui-grid-pager-row-count-picker select::-moz-placeholder, +.ui-grid-pager-row-count-picker select:-ms-input-placeholder, +.ui-grid-pager-row-count-picker select::-webkit-input-placeholder { + color: #999; +} +.ui-grid-pager-row-count-picker select::-ms-expand { + border: 0; + background-color: transparent; +} +.ui-grid-pager-row-count-picker select[disabled], +.ui-grid-pager-row-count-picker select[readonly] { + background-color: #eeeeee; +} +.ui-grid-pager-row-count-picker select[disabled] { + cursor: not-allowed; +} +.ui-grid-pager-row-count-picker .ui-grid-pager-row-count-label { + margin-top: 3px; +} +.ui-grid-pager-count-container { + float: right; + margin-top: 4px; + min-width: 50px; +} +.ui-grid-pager-count-container .ui-grid-pager-count { + margin-right: 10px; + margin-left: 10px; + float: right; +} +.ui-grid-pager-count-container .ui-grid-pager-count abbr { + border-bottom: none; + text-decoration: none; +} diff --git a/release/4.9.2/css/ui-grid.pagination.min.css b/release/4.9.2/css/ui-grid.pagination.min.css new file mode 100644 index 000000000..395aec988 --- /dev/null +++ b/release/4.9.2/css/ui-grid.pagination.min.css @@ -0,0 +1 @@ +.ui-grid-pager-panel{display:flex;justify-content:space-between;align-items:center;position:absolute;left:0;bottom:0;width:100%;padding-top:3px;padding-bottom:3px;box-sizing:content-box}.ui-grid-pager-container{float:left}.ui-grid-pager-control{padding:5px 0;display:flex;flex-flow:row nowrap;align-items:center;margin-right:10px;margin-left:10px;min-width:135px;float:left}.ui-grid-pager-control button,.ui-grid-pager-control span,.ui-grid-pager-control input{margin-right:4px}.ui-grid-pager-control button{height:25px;min-width:26px;display:inline-block;margin-bottom:0;font-weight:normal;text-align:center;vertical-align:middle;touch-action:manipulation;cursor:pointer;background:#f3f3f3;border:1px solid #ccc;white-space:nowrap;padding:6px 12px;font-size:14px;line-height:1.42857143;border-radius:4px;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;color:#eee}.ui-grid-pager-control button:hover{border-color:#adadad;text-decoration:none}.ui-grid-pager-control button:focus{border-color:#8c8c8c;text-decoration:none;outline:5px auto -webkit-focus-ring-color;outline-offset:-2px}.ui-grid-pager-control button:active{border-color:#adadad;outline:0;-webkit-box-shadow:inset 0 3px 5px rgba(0,0,0,0.125);box-shadow:inset 0 3px 5px rgba(0,0,0,0.125)}.ui-grid-pager-control button:active:focus{outline:5px auto -webkit-focus-ring-color;outline-offset:-2px}.ui-grid-pager-control button:active:hover,.ui-grid-pager-control button:active:focus{background-color:#c8c8c8;border-color:#8c8c8c}.ui-grid-pager-control button:hover,.ui-grid-pager-control button:focus,.ui-grid-pager-control button:active{color:#eee;background:#dadada}.ui-grid-pager-control button[disabled]{cursor:not-allowed;opacity:.65;filter:alpha(opacity=65);-webkit-box-shadow:none;box-shadow:none}.ui-grid-pager-control button[disabled]:hover,.ui-grid-pager-control button[disabled]:focus{background-color:#f3f3f3;border-color:#ccc}.ui-grid-pager-control input{display:inline;height:26px;width:50px;vertical-align:top;color:#555555;background:#fff;border:1px solid #ccc;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);-webkit-transition:border-color ease-in-out .15s,box-shadow ease-in-out .15s;-o-transition:border-color ease-in-out .15s,box-shadow ease-in-out .15s;transition:border-color ease-in-out .15s,box-shadow ease-in-out .15s;padding:5px 10px;font-size:12px;line-height:1.5;border-radius:3px}.ui-grid-pager-control input:focus{border-color:#66afe9;outline:0;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 8px rgba(102,175,233,0.6);box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 8px rgba(102,175,233,0.6)}.ui-grid-pager-control input[disabled],.ui-grid-pager-control input[readonly],.ui-grid-pager-control input::-moz-placeholder{opacity:1}.ui-grid-pager-control input::-moz-placeholder,.ui-grid-pager-control input:-ms-input-placeholder,.ui-grid-pager-control input::-webkit-input-placeholder{color:#999}.ui-grid-pager-control input::-ms-expand{border:0;background-color:transparent}.ui-grid-pager-control input[disabled],.ui-grid-pager-control input[readonly]{background-color:#eeeeee}.ui-grid-pager-control input[disabled]{cursor:not-allowed}.ui-grid-pager-control .ui-grid-pager-max-pages-number{vertical-align:bottom}.ui-grid-pager-control .ui-grid-pager-max-pages-number>*{vertical-align:bottom}.ui-grid-pager-control .ui-grid-pager-max-pages-number abbr{border-bottom:none;text-decoration:none}.ui-grid-pager-control .first-bar{width:10px;border-left:2px solid #4d4d4d;margin-top:-6px;height:12px;margin-left:-3px}.ui-grid-pager-control .first-bar-rtl{width:10px;border-left:2px solid #4d4d4d;margin-top:-6px;height:12px;margin-right:-7px}.ui-grid-pager-control .first-triangle{width:0;height:0;border-style:solid;border-width:5px 8.7px 5px 0;border-color:transparent #4d4d4d transparent transparent;margin-left:2px}.ui-grid-pager-control .next-triangle{margin-left:1px}.ui-grid-pager-control .prev-triangle{margin-left:0}.ui-grid-pager-control .last-triangle{width:0;height:0;border-style:solid;border-width:5px 0 5px 8.7px;border-color:transparent transparent transparent #4d4d4d;margin-left:-1px}.ui-grid-pager-control .last-bar{width:10px;border-left:2px solid #4d4d4d;margin-top:-6px;height:12px;margin-left:1px}.ui-grid-pager-control .last-bar-rtl{width:10px;border-left:2px solid #4d4d4d;margin-top:-6px;height:12px;margin-right:-11px}.ui-grid-pager-row-count-picker{float:left;padding:5px 10px}.ui-grid-pager-row-count-picker select{color:#555555;background:#fff;border:1px solid #ccc;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);-webkit-transition:border-color ease-in-out .15s,box-shadow ease-in-out .15s;-o-transition:border-color ease-in-out .15s,box-shadow ease-in-out .15s;transition:border-color ease-in-out .15s,box-shadow ease-in-out .15s;padding:5px 10px;font-size:12px;line-height:1.5;border-radius:3px;height:25px;width:67px;display:inline;vertical-align:middle}.ui-grid-pager-row-count-picker select:focus{border-color:#66afe9;outline:0;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 8px rgba(102,175,233,0.6);box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 8px rgba(102,175,233,0.6)}.ui-grid-pager-row-count-picker select[disabled],.ui-grid-pager-row-count-picker select[readonly],.ui-grid-pager-row-count-picker select::-moz-placeholder{opacity:1}.ui-grid-pager-row-count-picker select::-moz-placeholder,.ui-grid-pager-row-count-picker select:-ms-input-placeholder,.ui-grid-pager-row-count-picker select::-webkit-input-placeholder{color:#999}.ui-grid-pager-row-count-picker select::-ms-expand{border:0;background-color:transparent}.ui-grid-pager-row-count-picker select[disabled],.ui-grid-pager-row-count-picker select[readonly]{background-color:#eeeeee}.ui-grid-pager-row-count-picker select[disabled]{cursor:not-allowed}.ui-grid-pager-row-count-picker .ui-grid-pager-row-count-label{margin-top:3px}.ui-grid-pager-count-container{float:right;margin-top:4px;min-width:50px}.ui-grid-pager-count-container .ui-grid-pager-count{margin-right:10px;margin-left:10px;float:right}.ui-grid-pager-count-container .ui-grid-pager-count abbr{border-bottom:none;text-decoration:none} \ No newline at end of file diff --git a/release/4.9.2/css/ui-grid.pinning.css b/release/4.9.2/css/ui-grid.pinning.css new file mode 100644 index 000000000..9c5eb1ae1 --- /dev/null +++ b/release/4.9.2/css/ui-grid.pinning.css @@ -0,0 +1,67 @@ +.ui-grid-pinned-container { + position: absolute; + display: inline; + top: 0; +} +.ui-grid-pinned-container.ui-grid-pinned-container-left { + float: left; + left: 0; +} +.ui-grid-pinned-container.ui-grid-pinned-container-right { + float: right; + right: 0; +} +.ui-grid-pinned-container.ui-grid-pinned-container-left .ui-grid-header-cell:last-child { + box-sizing: border-box; + border-right: 1px solid; + border-width: 1px; + border-right-color: #aeaeae; +} +.ui-grid-pinned-container.ui-grid-pinned-container-left .ui-grid-cell:last-child { + box-sizing: border-box; + border-right: 1px solid; + border-width: 1px; + border-right-color: #aeaeae; +} +.ui-grid-pinned-container.ui-grid-pinned-container-left .ui-grid-header-cell:not(:last-child) .ui-grid-vertical-bar, +.ui-grid-pinned-container .ui-grid-cell:not(:last-child) .ui-grid-vertical-bar { + width: 1px; +} +.ui-grid-pinned-container.ui-grid-pinned-container-left .ui-grid-header-cell:not(:last-child) .ui-grid-vertical-bar { + background-color: #d4d4d4; +} +.ui-grid-pinned-container.ui-grid-pinned-container-left .ui-grid-cell:not(:last-child) .ui-grid-vertical-bar { + background-color: #aeaeae; +} +.ui-grid-pinned-container.ui-grid-pinned-container-left .ui-grid-header-cell:last-child .ui-grid-vertical-bar { + right: -1px; + width: 1px; + background-color: #aeaeae; +} +.ui-grid-pinned-container.ui-grid-pinned-container-right .ui-grid-header-cell:first-child { + box-sizing: border-box; + border-left: 1px solid; + border-width: 1px; + border-left-color: #aeaeae; +} +.ui-grid-pinned-container.ui-grid-pinned-container-right .ui-grid-cell:first-child { + box-sizing: border-box; + border-left: 1px solid; + border-width: 1px; + border-left-color: #aeaeae; +} +.ui-grid-pinned-container.ui-grid-pinned-container-right .ui-grid-header-cell:not(:first-child) .ui-grid-vertical-bar, +.ui-grid-pinned-container .ui-grid-cell:not(:first-child) .ui-grid-vertical-bar { + width: 1px; +} +.ui-grid-pinned-container.ui-grid-pinned-container-right .ui-grid-header-cell:not(:first-child) .ui-grid-vertical-bar { + background-color: #d4d4d4; +} +.ui-grid-pinned-container.ui-grid-pinned-container-right .ui-grid-cell:not(:last-child) .ui-grid-vertical-bar { + background-color: #aeaeae; +} +.ui-grid-pinned-container.ui-grid-pinned-container-first .ui-grid-header-cell:first-child .ui-grid-vertical-bar { + left: -1px; + width: 1px; + background-color: #aeaeae; +} diff --git a/release/4.9.2/css/ui-grid.pinning.min.css b/release/4.9.2/css/ui-grid.pinning.min.css new file mode 100644 index 000000000..7068b8340 --- /dev/null +++ b/release/4.9.2/css/ui-grid.pinning.min.css @@ -0,0 +1 @@ +.ui-grid-pinned-container{position:absolute;display:inline;top:0}.ui-grid-pinned-container.ui-grid-pinned-container-left{float:left;left:0}.ui-grid-pinned-container.ui-grid-pinned-container-right{float:right;right:0}.ui-grid-pinned-container.ui-grid-pinned-container-left .ui-grid-header-cell:last-child{box-sizing:border-box;border-right:1px solid;border-width:1px;border-right-color:#aeaeae}.ui-grid-pinned-container.ui-grid-pinned-container-left .ui-grid-cell:last-child{box-sizing:border-box;border-right:1px solid;border-width:1px;border-right-color:#aeaeae}.ui-grid-pinned-container.ui-grid-pinned-container-left .ui-grid-header-cell:not(:last-child) .ui-grid-vertical-bar,.ui-grid-pinned-container .ui-grid-cell:not(:last-child) .ui-grid-vertical-bar{width:1px}.ui-grid-pinned-container.ui-grid-pinned-container-left .ui-grid-header-cell:not(:last-child) .ui-grid-vertical-bar{background-color:#d4d4d4}.ui-grid-pinned-container.ui-grid-pinned-container-left .ui-grid-cell:not(:last-child) .ui-grid-vertical-bar{background-color:#aeaeae}.ui-grid-pinned-container.ui-grid-pinned-container-left .ui-grid-header-cell:last-child .ui-grid-vertical-bar{right:-1px;width:1px;background-color:#aeaeae}.ui-grid-pinned-container.ui-grid-pinned-container-right .ui-grid-header-cell:first-child{box-sizing:border-box;border-left:1px solid;border-width:1px;border-left-color:#aeaeae}.ui-grid-pinned-container.ui-grid-pinned-container-right .ui-grid-cell:first-child{box-sizing:border-box;border-left:1px solid;border-width:1px;border-left-color:#aeaeae}.ui-grid-pinned-container.ui-grid-pinned-container-right .ui-grid-header-cell:not(:first-child) .ui-grid-vertical-bar,.ui-grid-pinned-container .ui-grid-cell:not(:first-child) .ui-grid-vertical-bar{width:1px}.ui-grid-pinned-container.ui-grid-pinned-container-right .ui-grid-header-cell:not(:first-child) .ui-grid-vertical-bar{background-color:#d4d4d4}.ui-grid-pinned-container.ui-grid-pinned-container-right .ui-grid-cell:not(:last-child) .ui-grid-vertical-bar{background-color:#aeaeae}.ui-grid-pinned-container.ui-grid-pinned-container-first .ui-grid-header-cell:first-child .ui-grid-vertical-bar{left:-1px;width:1px;background-color:#aeaeae} \ No newline at end of file diff --git a/release/4.9.2/css/ui-grid.resize-columns.css b/release/4.9.2/css/ui-grid.resize-columns.css new file mode 100644 index 000000000..100d05e43 --- /dev/null +++ b/release/4.9.2/css/ui-grid.resize-columns.css @@ -0,0 +1,38 @@ +.ui-grid-column-resizer { + top: 0; + bottom: 0; + width: 5px; + position: absolute; + cursor: col-resize; +} +.ui-grid-column-resizer.left { + left: 0; +} +.ui-grid-column-resizer.right { + right: 0; +} +.ui-grid-header-cell:last-child .ui-grid-column-resizer.right { + border-right: 1px solid #d4d4d4; +} +.ui-grid[dir=rtl] .ui-grid-header-cell:last-child .ui-grid-column-resizer.right { + border-right: 0; +} +.ui-grid[dir=rtl] .ui-grid-header-cell:last-child .ui-grid-column-resizer.left { + border-left: 1px solid #d4d4d4; +} +.ui-grid.column-resizing { + cursor: col-resize; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} +.ui-grid.column-resizing .ui-grid-resize-overlay { + position: absolute; + top: 0; + height: 100%; + width: 1px; + background-color: #aeaeae; +} diff --git a/release/4.9.2/css/ui-grid.resize-columns.min.css b/release/4.9.2/css/ui-grid.resize-columns.min.css new file mode 100644 index 000000000..0915bee16 --- /dev/null +++ b/release/4.9.2/css/ui-grid.resize-columns.min.css @@ -0,0 +1 @@ +.ui-grid-column-resizer{top:0;bottom:0;width:5px;position:absolute;cursor:col-resize}.ui-grid-column-resizer.left{left:0}.ui-grid-column-resizer.right{right:0}.ui-grid-header-cell:last-child .ui-grid-column-resizer.right{border-right:1px solid #d4d4d4}.ui-grid[dir=rtl] .ui-grid-header-cell:last-child .ui-grid-column-resizer.right{border-right:0}.ui-grid[dir=rtl] .ui-grid-header-cell:last-child .ui-grid-column-resizer.left{border-left:1px solid #d4d4d4}.ui-grid.column-resizing{cursor:col-resize;-webkit-touch-callout:none;-webkit-user-select:none;-khtml-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}.ui-grid.column-resizing .ui-grid-resize-overlay{position:absolute;top:0;height:100%;width:1px;background-color:#aeaeae} \ No newline at end of file diff --git a/release/4.9.2/css/ui-grid.row-edit.css b/release/4.9.2/css/ui-grid.row-edit.css new file mode 100644 index 000000000..741c68b30 --- /dev/null +++ b/release/4.9.2/css/ui-grid.row-edit.css @@ -0,0 +1,9 @@ +.ui-grid-row-saving .ui-grid-cell { + color: #848484 !important; +} +.ui-grid-row-dirty .ui-grid-cell { + color: #610B38; +} +.ui-grid-row-error .ui-grid-cell { + color: #FF0000 !important; +} diff --git a/release/4.9.2/css/ui-grid.row-edit.min.css b/release/4.9.2/css/ui-grid.row-edit.min.css new file mode 100644 index 000000000..362195a02 --- /dev/null +++ b/release/4.9.2/css/ui-grid.row-edit.min.css @@ -0,0 +1 @@ +.ui-grid-row-saving .ui-grid-cell{color:#848484 !important}.ui-grid-row-dirty .ui-grid-cell{color:#610B38}.ui-grid-row-error .ui-grid-cell{color:#FF0000 !important} \ No newline at end of file diff --git a/release/4.9.2/css/ui-grid.selection.css b/release/4.9.2/css/ui-grid.selection.css new file mode 100644 index 000000000..8267ac9af --- /dev/null +++ b/release/4.9.2/css/ui-grid.selection.css @@ -0,0 +1,25 @@ +.ui-grid-row.ui-grid-row-selected > [ui-grid-row] > .ui-grid-cell { + background-color: #C9DDE1; +} +.ui-grid-disable-selection { + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + cursor: default; +} +.ui-grid-selection-row-header-buttons { + display: flex; + align-items: center; + height: 100%; + cursor: pointer; +} +.ui-grid-selection-row-header-buttons::before { + opacity: 0.1; +} +.ui-grid-selection-row-header-buttons.ui-grid-row-selected::before, +.ui-grid-selection-row-header-buttons.ui-grid-all-selected::before { + opacity: 1; +} diff --git a/release/4.9.2/css/ui-grid.selection.min.css b/release/4.9.2/css/ui-grid.selection.min.css new file mode 100644 index 000000000..300e60f28 --- /dev/null +++ b/release/4.9.2/css/ui-grid.selection.min.css @@ -0,0 +1 @@ +.ui-grid-row.ui-grid-row-selected>[ui-grid-row]>.ui-grid-cell{background-color:#C9DDE1}.ui-grid-disable-selection{-webkit-touch-callout:none;-webkit-user-select:none;-khtml-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;cursor:default}.ui-grid-selection-row-header-buttons{display:flex;align-items:center;height:100%;cursor:pointer}.ui-grid-selection-row-header-buttons::before{opacity:.1}.ui-grid-selection-row-header-buttons.ui-grid-row-selected::before,.ui-grid-selection-row-header-buttons.ui-grid-all-selected::before{opacity:1} \ No newline at end of file diff --git a/release/4.9.2/css/ui-grid.tree-base.css b/release/4.9.2/css/ui-grid.tree-base.css new file mode 100644 index 000000000..3431ca558 --- /dev/null +++ b/release/4.9.2/css/ui-grid.tree-base.css @@ -0,0 +1,4 @@ +.ui-grid-tree-row-header-buttons.ui-grid-tree-header { + cursor: pointer; + opacity: 1; +} diff --git a/release/4.9.2/css/ui-grid.tree-base.min.css b/release/4.9.2/css/ui-grid.tree-base.min.css new file mode 100644 index 000000000..968a06a91 --- /dev/null +++ b/release/4.9.2/css/ui-grid.tree-base.min.css @@ -0,0 +1 @@ +.ui-grid-tree-row-header-buttons.ui-grid-tree-header{cursor:pointer;opacity:1} \ No newline at end of file diff --git a/release/4.9.2/css/ui-grid.tree-view.css b/release/4.9.2/css/ui-grid.tree-view.css new file mode 100644 index 000000000..6dfeb52b7 --- /dev/null +++ b/release/4.9.2/css/ui-grid.tree-view.css @@ -0,0 +1,6 @@ +.ui-grid-tree-header-row { + font-weight: bold !important; +} +.ui-grid-tree-header-row .ui-grid-cell.ui-grid-disable-selection.ui-grid-row-header-cell { + pointer-events: all; +} diff --git a/release/4.9.2/css/ui-grid.tree-view.min.css b/release/4.9.2/css/ui-grid.tree-view.min.css new file mode 100644 index 000000000..c2f4b5de9 --- /dev/null +++ b/release/4.9.2/css/ui-grid.tree-view.min.css @@ -0,0 +1 @@ +.ui-grid-tree-header-row{font-weight:bold !important}.ui-grid-tree-header-row .ui-grid-cell.ui-grid-disable-selection.ui-grid-row-header-cell{pointer-events:all} \ No newline at end of file diff --git a/release/4.9.2/css/ui-grid.validate.css b/release/4.9.2/css/ui-grid.validate.css new file mode 100644 index 000000000..622b0f6e8 --- /dev/null +++ b/release/4.9.2/css/ui-grid.validate.css @@ -0,0 +1,3 @@ +.ui-grid-cell-contents.invalid { + border: 1px solid #fc8f8f; +} diff --git a/release/4.9.2/css/ui-grid.validate.min.css b/release/4.9.2/css/ui-grid.validate.min.css new file mode 100644 index 000000000..4030e751d --- /dev/null +++ b/release/4.9.2/css/ui-grid.validate.min.css @@ -0,0 +1 @@ +.ui-grid-cell-contents.invalid{border:1px solid #fc8f8f} \ No newline at end of file diff --git a/release/4.9.2/fonts/ui-grid.eot b/release/4.9.2/fonts/ui-grid.eot new file mode 100644 index 000000000..59cf0aed2 Binary files /dev/null and b/release/4.9.2/fonts/ui-grid.eot differ diff --git a/release/4.9.2/fonts/ui-grid.svg b/release/4.9.2/fonts/ui-grid.svg new file mode 100644 index 000000000..9d2e03c0e --- /dev/null +++ b/release/4.9.2/fonts/ui-grid.svg @@ -0,0 +1,56 @@ + + + \ No newline at end of file diff --git a/release/4.9.2/fonts/ui-grid.ttf b/release/4.9.2/fonts/ui-grid.ttf new file mode 100644 index 000000000..b1a4b0611 Binary files /dev/null and b/release/4.9.2/fonts/ui-grid.ttf differ diff --git a/release/4.9.2/fonts/ui-grid.woff b/release/4.9.2/fonts/ui-grid.woff new file mode 100644 index 000000000..426c61150 Binary files /dev/null and b/release/4.9.2/fonts/ui-grid.woff differ diff --git a/release/4.9.2/i18n/ui-grid.auto-resize.js b/release/4.9.2/i18n/ui-grid.auto-resize.js new file mode 100644 index 000000000..33f3f9d70 --- /dev/null +++ b/release/4.9.2/i18n/ui-grid.auto-resize.js @@ -0,0 +1,68 @@ +/*! + * ui-grid - v4.9.2 - 2020-12-01 + * Copyright (c) 2020 ; License: MIT + */ + +(function() { + 'use strict'; + /** + * @ngdoc overview + * @name ui.grid.autoResize + * + * @description + * + * #ui.grid.autoResize + * + *Beta This feature is ready for testing, but it either hasn't seen a lot of use or has some known bugs.
+ *
+ * This module provides auto-resizing functionality to UI-Grid.
+ */
+ var module = angular.module('ui.grid.autoResize', ['ui.grid']);
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.autoResize.directive:uiGridAutoResize
+ * @element div
+ * @restrict A
+ *
+ * @description Stacks on top of the ui-grid directive and
+ * adds the a watch to the grid's height and width which refreshes
+ * the grid content whenever its dimensions change.
+ *
+ */
+ module.directive('uiGridAutoResize', ['gridUtil', function(gridUtil) {
+ return {
+ require: 'uiGrid',
+ scope: false,
+ link: function($scope, $elm, $attrs, uiGridCtrl) {
+ var debouncedRefresh;
+
+ function getDimensions() {
+ return {
+ width: gridUtil.elementWidth($elm),
+ height: gridUtil.elementHeight($elm)
+ };
+ }
+
+ function refreshGrid(prevWidth, prevHeight, width, height) {
+ if ($elm[0].offsetParent !== null) {
+ uiGridCtrl.grid.gridWidth = width;
+ uiGridCtrl.grid.gridHeight = height;
+ uiGridCtrl.grid.queueGridRefresh()
+ .then(function() {
+ uiGridCtrl.grid.api.core.raise.gridDimensionChanged(prevHeight, prevWidth, height, width);
+ });
+ }
+ }
+
+ debouncedRefresh = gridUtil.debounce(refreshGrid, 400);
+
+ $scope.$watchCollection(getDimensions, function(newValues, oldValues) {
+ if (!angular.equals(newValues, oldValues)) {
+ debouncedRefresh(oldValues.width, oldValues.height, newValues.width, newValues.height);
+ }
+ });
+ }
+ };
+ }]);
+})();
diff --git a/release/4.9.2/i18n/ui-grid.auto-resize.min.js b/release/4.9.2/i18n/ui-grid.auto-resize.min.js
new file mode 100644
index 000000000..a7cdd99b5
--- /dev/null
+++ b/release/4.9.2/i18n/ui-grid.auto-resize.min.js
@@ -0,0 +1,7 @@
+/*!
+ * ui-grid - v4.9.2 - 2020-12-01
+ * Copyright (c) 2020 ; License: MIT
+ */
+
+
+!function(){"use strict";angular.module("ui.grid.autoResize",["ui.grid"]).directive("uiGridAutoResize",["gridUtil",function(n){return{require:"uiGrid",scope:!1,link:function(i,r,e,u){var t;t=n.debounce(function(i,e,t,n){null!==r[0].offsetParent&&(u.grid.gridWidth=t,u.grid.gridHeight=n,u.grid.queueGridRefresh().then(function(){u.grid.api.core.raise.gridDimensionChanged(e,i,n,t)}))},400),i.$watchCollection(function(){return{width:n.elementWidth(r),height:n.elementHeight(r)}},function(i,e){angular.equals(i,e)||t(e.width,e.height,i.width,i.height)})}}}])}();
\ No newline at end of file
diff --git a/release/4.9.2/i18n/ui-grid.cellnav.js b/release/4.9.2/i18n/ui-grid.cellnav.js
new file mode 100644
index 000000000..e803b72df
--- /dev/null
+++ b/release/4.9.2/i18n/ui-grid.cellnav.js
@@ -0,0 +1,1181 @@
+/*!
+ * ui-grid - v4.9.2 - 2020-12-01
+ * Copyright (c) 2020 ; License: MIT
+ */
+
+(function () {
+ 'use strict';
+
+ /**
+ * @ngdoc overview
+ * @name ui.grid.cellNav
+ *
+ * @description
+
+ #ui.grid.cellNav
+
+ Stable This feature is stable. There should no longer be breaking api changes without a deprecation warning.
+
+ This module provides cell navigation functionality to UI-Grid.
+ */
+ var module = angular.module('ui.grid.cellNav', ['ui.grid']);
+
+ /**
+ * @ngdoc object
+ * @name ui.grid.cellNav.constant:uiGridCellNavConstants
+ *
+ * @description constants available in cellNav
+ */
+ module.constant('uiGridCellNavConstants', {
+ FEATURE_NAME: 'gridCellNav',
+ CELL_NAV_EVENT: 'cellNav',
+ direction: {LEFT: 0, RIGHT: 1, UP: 2, DOWN: 3, PG_UP: 4, PG_DOWN: 5},
+ EVENT_TYPE: {
+ KEYDOWN: 0,
+ CLICK: 1,
+ CLEAR: 2
+ }
+ });
+
+
+ module.factory('uiGridCellNavFactory', ['gridUtil', 'uiGridConstants', 'uiGridCellNavConstants', 'GridRowColumn', '$q',
+ function (gridUtil, uiGridConstants, uiGridCellNavConstants, GridRowColumn, $q) {
+ /**
+ * @ngdoc object
+ * @name ui.grid.cellNav.object:CellNav
+ * @description returns a CellNav prototype function
+ * @param {object} rowContainer container for rows
+ * @param {object} colContainer parent column container
+ * @param {object} leftColContainer column container to the left of parent
+ * @param {object} rightColContainer column container to the right of parent
+ */
+ var UiGridCellNav = function UiGridCellNav(rowContainer, colContainer, leftColContainer, rightColContainer) {
+ this.rows = rowContainer.visibleRowCache;
+ this.columns = colContainer.visibleColumnCache;
+ this.leftColumns = leftColContainer ? leftColContainer.visibleColumnCache : [];
+ this.rightColumns = rightColContainer ? rightColContainer.visibleColumnCache : [];
+ this.bodyContainer = rowContainer;
+ };
+
+ /** returns focusable columns of all containers */
+ UiGridCellNav.prototype.getFocusableCols = function () {
+ var allColumns = this.leftColumns.concat(this.columns, this.rightColumns);
+
+ return allColumns.filter(function (col) {
+ return col.colDef.allowCellFocus;
+ });
+ };
+
+ /**
+ * @ngdoc object
+ * @name ui.grid.cellNav.api:GridRow
+ *
+ * @description GridRow settings for cellNav feature, these are available to be
+ * set only internally (for example, by other features)
+ */
+
+ /**
+ * @ngdoc object
+ * @name allowCellFocus
+ * @propertyOf ui.grid.cellNav.api:GridRow
+ * @description Enable focus on a cell within this row. If set to false then no cells
+ * in this row can be focused - group header rows as an example would set this to false.
+ * Defaults to true + */ + /** returns focusable rows */ + UiGridCellNav.prototype.getFocusableRows = function () { + return this.rows.filter(function(row) { + return row.allowCellFocus !== false; + }); + }; + + UiGridCellNav.prototype.getNextRowCol = function (direction, curRow, curCol) { + switch (direction) { + case uiGridCellNavConstants.direction.LEFT: + return this.getRowColLeft(curRow, curCol); + case uiGridCellNavConstants.direction.RIGHT: + return this.getRowColRight(curRow, curCol); + case uiGridCellNavConstants.direction.UP: + return this.getRowColUp(curRow, curCol); + case uiGridCellNavConstants.direction.DOWN: + return this.getRowColDown(curRow, curCol); + case uiGridCellNavConstants.direction.PG_UP: + return this.getRowColPageUp(curRow, curCol); + case uiGridCellNavConstants.direction.PG_DOWN: + return this.getRowColPageDown(curRow, curCol); + } + }; + + UiGridCellNav.prototype.initializeSelection = function () { + var focusableCols = this.getFocusableCols(); + var focusableRows = this.getFocusableRows(); + if (focusableCols.length === 0 || focusableRows.length === 0) { + return null; + } + + return new GridRowColumn(focusableRows[0], focusableCols[0]); // return same row + }; + + UiGridCellNav.prototype.getRowColLeft = function (curRow, curCol) { + var focusableCols = this.getFocusableCols(); + var focusableRows = this.getFocusableRows(); + var curColIndex = focusableCols.indexOf(curCol); + var curRowIndex = focusableRows.indexOf(curRow); + + // could not find column in focusable Columns so set it to 1 + if (curColIndex === -1) { + curColIndex = 1; + } + + var nextColIndex = curColIndex === 0 ? focusableCols.length - 1 : curColIndex - 1; + + // get column to left + if (nextColIndex >= curColIndex) { + // On the first row + // if (curRowIndex === 0 && curColIndex === 0) { + // return null; + // } + if (curRowIndex === 0) { + return new GridRowColumn(curRow, focusableCols[nextColIndex]); // return same row + } + else { + // up one row and far right column + return new GridRowColumn(focusableRows[curRowIndex - 1], focusableCols[nextColIndex]); + } + } + else { + return new GridRowColumn(curRow, focusableCols[nextColIndex]); + } + }; + + + + UiGridCellNav.prototype.getRowColRight = function (curRow, curCol) { + var focusableCols = this.getFocusableCols(); + var focusableRows = this.getFocusableRows(); + var curColIndex = focusableCols.indexOf(curCol); + var curRowIndex = focusableRows.indexOf(curRow); + + // could not find column in focusable Columns so set it to 0 + if (curColIndex === -1) { + curColIndex = 0; + } + var nextColIndex = curColIndex === focusableCols.length - 1 ? 0 : curColIndex + 1; + + if (nextColIndex <= curColIndex) { + if (curRowIndex === focusableRows.length - 1) { + return new GridRowColumn(curRow, focusableCols[nextColIndex]); // return same row + } + else { + // down one row and far left column + return new GridRowColumn(focusableRows[curRowIndex + 1], focusableCols[nextColIndex]); + } + } + else { + return new GridRowColumn(curRow, focusableCols[nextColIndex]); + } + }; + + UiGridCellNav.prototype.getRowColDown = function (curRow, curCol) { + var focusableCols = this.getFocusableCols(); + var focusableRows = this.getFocusableRows(); + var curColIndex = focusableCols.indexOf(curCol); + var curRowIndex = focusableRows.indexOf(curRow); + + // could not find column in focusable Columns so set it to 0 + if (curColIndex === -1) { + curColIndex = 0; + } + + if (curRowIndex === focusableRows.length - 1) { + return new GridRowColumn(curRow, focusableCols[curColIndex]); // return same row + } + else { + // down one row + return new GridRowColumn(focusableRows[curRowIndex + 1], focusableCols[curColIndex]); + } + }; + + UiGridCellNav.prototype.getRowColPageDown = function (curRow, curCol) { + var focusableCols = this.getFocusableCols(); + var focusableRows = this.getFocusableRows(); + var curColIndex = focusableCols.indexOf(curCol); + var curRowIndex = focusableRows.indexOf(curRow); + + // could not find column in focusable Columns so set it to 0 + if (curColIndex === -1) { + curColIndex = 0; + } + + var pageSize = this.bodyContainer.minRowsToRender(); + if (curRowIndex >= focusableRows.length - pageSize) { + return new GridRowColumn(focusableRows[focusableRows.length - 1], focusableCols[curColIndex]); // return last row + } + else { + // down one page + return new GridRowColumn(focusableRows[curRowIndex + pageSize], focusableCols[curColIndex]); + } + }; + + UiGridCellNav.prototype.getRowColUp = function (curRow, curCol) { + var focusableCols = this.getFocusableCols(); + var focusableRows = this.getFocusableRows(); + var curColIndex = focusableCols.indexOf(curCol); + var curRowIndex = focusableRows.indexOf(curRow); + + // could not find column in focusable Columns so set it to 0 + if (curColIndex === -1) { + curColIndex = 0; + } + + if (curRowIndex === 0) { + return new GridRowColumn(curRow, focusableCols[curColIndex]); // return same row + } + else { + // up one row + return new GridRowColumn(focusableRows[curRowIndex - 1], focusableCols[curColIndex]); + } + }; + + UiGridCellNav.prototype.getRowColPageUp = function (curRow, curCol) { + var focusableCols = this.getFocusableCols(); + var focusableRows = this.getFocusableRows(); + var curColIndex = focusableCols.indexOf(curCol); + var curRowIndex = focusableRows.indexOf(curRow); + + // could not find column in focusable Columns so set it to 0 + if (curColIndex === -1) { + curColIndex = 0; + } + + var pageSize = this.bodyContainer.minRowsToRender(); + if (curRowIndex - pageSize < 0) { + return new GridRowColumn(focusableRows[0], focusableCols[curColIndex]); // return first row + } + else { + // up one page + return new GridRowColumn(focusableRows[curRowIndex - pageSize], focusableCols[curColIndex]); + } + }; + return UiGridCellNav; + }]); + + /** + * @ngdoc service + * @name ui.grid.cellNav.service:uiGridCellNavService + * + * @description Services for cell navigation features. If you don't like the key maps we use, + * or the direction cells navigation, override with a service decorator (see angular docs) + */ + module.service('uiGridCellNavService', ['gridUtil', 'uiGridConstants', 'uiGridCellNavConstants', '$q', 'uiGridCellNavFactory', 'GridRowColumn', 'ScrollEvent', + function (gridUtil, uiGridConstants, uiGridCellNavConstants, $q, UiGridCellNav, GridRowColumn, ScrollEvent) { + + var service = { + + initializeGrid: function (grid) { + grid.registerColumnBuilder(service.cellNavColumnBuilder); + + + /** + * @ngdoc object + * @name ui.grid.cellNav.Grid:cellNav + * @description cellNav properties added to grid class + */ + grid.cellNav = {}; + grid.cellNav.lastRowCol = null; + grid.cellNav.focusedCells = []; + + service.defaultGridOptions(grid.options); + + /** + * @ngdoc object + * @name ui.grid.cellNav.api:PublicApi + * + * @description Public Api for cellNav feature + */ + var publicApi = { + events: { + cellNav: { + /** + * @ngdoc event + * @name navigate + * @eventOf ui.grid.cellNav.api:PublicApi + * @description raised when the active cell is changed + *
+ * gridApi.cellNav.on.navigate(scope,function(newRowcol, oldRowCol) {})
+ *
+ * @param {object} newRowCol new position
+ * @param {object} oldRowCol old position
+ */
+ navigate: function (newRowCol, oldRowCol) {},
+ /**
+ * @ngdoc event
+ * @name viewPortKeyDown
+ * @eventOf ui.grid.cellNav.api:PublicApi
+ * @description is raised when the viewPort receives a keyDown event. Cells never get focus in uiGrid
+ * due to the difficulties of setting focus on a cell that is not visible in the viewport. Use this
+ * event whenever you need a keydown event on a cell
+ * + * @param {object} event keydown event + * @param {object} rowCol current rowCol position + */ + viewPortKeyDown: function (event, rowCol) {}, + + /** + * @ngdoc event + * @name viewPortKeyPress + * @eventOf ui.grid.cellNav.api:PublicApi + * @description is raised when the viewPort receives a keyPress event. Cells never get focus in uiGrid + * due to the difficulties of setting focus on a cell that is not visible in the viewport. Use this + * event whenever you need a keypress event on a cell + * + * @param {object} event keypress event + * @param {object} rowCol current rowCol position + */ + viewPortKeyPress: function (event, rowCol) {} + } + }, + methods: { + cellNav: { + /** + * @ngdoc function + * @name scrollToFocus + * @methodOf ui.grid.cellNav.api:PublicApi + * @description brings the specified row and column into view, and sets focus + * to that cell + * @param {object} rowEntity gridOptions.data[] array instance to make visible and set focus + * @param {object} colDef to make visible and set focus + * @returns {promise} a promise that is resolved after any scrolling is finished + */ + scrollToFocus: function (rowEntity, colDef) { + return service.scrollToFocus(grid, rowEntity, colDef); + }, + + /** + * @ngdoc function + * @name getFocusedCell + * @methodOf ui.grid.cellNav.api:PublicApi + * @description returns the current (or last if Grid does not have focus) focused row and column + * value is null if no selection has occurred + */ + getFocusedCell: function () { + return grid.cellNav.lastRowCol; + }, + + /** + * @ngdoc function + * @name getCurrentSelection + * @methodOf ui.grid.cellNav.api:PublicApi + * @description returns an array containing the current selection + * array is empty if no selection has occurred + */ + getCurrentSelection: function () { + return grid.cellNav.focusedCells; + }, + + /** + * @ngdoc function + * @name rowColSelectIndex + * @methodOf ui.grid.cellNav.api:PublicApi + * @description returns the index in the order in which the GridRowColumn was selected, returns -1 if the GridRowColumn + * isn't selected + * @param {object} rowCol the rowCol to evaluate + */ + rowColSelectIndex: function (rowCol) { + // return gridUtil.arrayContainsObjectWithProperty(grid.cellNav.focusedCells, 'col.uid', rowCol.col.uid) && + var index = -1; + for (var i = 0; i < grid.cellNav.focusedCells.length; i++) { + if (grid.cellNav.focusedCells[i].col.uid === rowCol.col.uid && + grid.cellNav.focusedCells[i].row.uid === rowCol.row.uid) { + index = i; + break; + } + } + return index; + } + } + } + }; + + grid.api.registerEventsFromObject(publicApi.events); + + grid.api.registerMethodsFromObject(publicApi.methods); + }, + + defaultGridOptions: function (gridOptions) { + /** + * @ngdoc object + * @name ui.grid.cellNav.api:GridOptions + * + * @description GridOptions for cellNav feature, these are available to be + * set using the ui-grid {@link ui.grid.class:GridOptions gridOptions} + */ + + /** + * @ngdoc object + * @name modifierKeysToMultiSelectCells + * @propertyOf ui.grid.cellNav.api:GridOptions + * @description Enable multiple cell selection only when using the ctrlKey or shiftKey. + * Defaults to false + */ + gridOptions.modifierKeysToMultiSelectCells = gridOptions.modifierKeysToMultiSelectCells === true; + + /** + * @ngdoc array + * @name keyDownOverrides + * @propertyOf ui.grid.cellNav.api:GridOptions + * @description An array of event objects to override on keydown. If an event is overridden, the viewPortKeyDown event will + * be raised with the overridden events, allowing custom keydown behavior. + * Defaults to [] + */ + gridOptions.keyDownOverrides = gridOptions.keyDownOverrides || []; + + }, + + /** + * @ngdoc service + * @name decorateRenderContainers + * @methodOf ui.grid.cellNav.service:uiGridCellNavService + * @description decorates grid renderContainers with cellNav functions + */ + decorateRenderContainers: function (grid) { + + var rightContainer = grid.hasRightContainer() ? grid.renderContainers.right : null; + var leftContainer = grid.hasLeftContainer() ? grid.renderContainers.left : null; + + if (leftContainer !== null) { + grid.renderContainers.left.cellNav = new UiGridCellNav(grid.renderContainers.body, leftContainer, rightContainer, grid.renderContainers.body); + } + if (rightContainer !== null) { + grid.renderContainers.right.cellNav = new UiGridCellNav(grid.renderContainers.body, rightContainer, grid.renderContainers.body, leftContainer); + } + + grid.renderContainers.body.cellNav = new UiGridCellNav(grid.renderContainers.body, grid.renderContainers.body, leftContainer, rightContainer); + }, + + /** + * @ngdoc service + * @name getDirection + * @methodOf ui.grid.cellNav.service:uiGridCellNavService + * @description determines which direction to for a given keyDown event + * @returns {uiGridCellNavConstants.direction} direction + */ + getDirection: function (evt) { + if (evt.keyCode === uiGridConstants.keymap.LEFT || + (evt.keyCode === uiGridConstants.keymap.TAB && evt.shiftKey)) { + return uiGridCellNavConstants.direction.LEFT; + } + if (evt.keyCode === uiGridConstants.keymap.RIGHT || + evt.keyCode === uiGridConstants.keymap.TAB) { + return uiGridCellNavConstants.direction.RIGHT; + } + + if (evt.keyCode === uiGridConstants.keymap.UP || + (evt.keyCode === uiGridConstants.keymap.ENTER && evt.shiftKey) ) { + return uiGridCellNavConstants.direction.UP; + } + + if (evt.keyCode === uiGridConstants.keymap.PG_UP) { + return uiGridCellNavConstants.direction.PG_UP; + } + + if (evt.keyCode === uiGridConstants.keymap.DOWN || + evt.keyCode === uiGridConstants.keymap.ENTER && !(evt.ctrlKey || evt.altKey)) { + return uiGridCellNavConstants.direction.DOWN; + } + + if (evt.keyCode === uiGridConstants.keymap.PG_DOWN) { + return uiGridCellNavConstants.direction.PG_DOWN; + } + + return null; + }, + + /** + * @ngdoc service + * @name cellNavColumnBuilder + * @methodOf ui.grid.cellNav.service:uiGridCellNavService + * @description columnBuilder function that adds cell navigation properties to grid column + * @returns {promise} promise that will load any needed templates when resolved + */ + cellNavColumnBuilder: function (colDef, col, gridOptions) { + var promises = []; + + /** + * @ngdoc object + * @name ui.grid.cellNav.api:ColumnDef + * + * @description Column Definitions for cellNav feature, these are available to be + * set using the ui-grid {@link ui.grid.class:GridOptions.columnDef gridOptions.columnDefs} + */ + + /** + * @ngdoc object + * @name allowCellFocus + * @propertyOf ui.grid.cellNav.api:ColumnDef + * @description Enable focus on a cell within this column. + * Defaults to true + */ + colDef.allowCellFocus = colDef.allowCellFocus === undefined ? true : colDef.allowCellFocus; + + return $q.all(promises); + }, + + /** + * @ngdoc method + * @methodOf ui.grid.cellNav.service:uiGridCellNavService + * @name scrollToFocus + * @description Scroll the grid such that the specified + * row and column is in view, and set focus to the cell in that row and column + * @param {Grid} grid the grid you'd like to act upon, usually available + * from gridApi.grid + * @param {object} rowEntity gridOptions.data[] array instance to make visible and set focus to + * @param {object} colDef to make visible and set focus to + * @returns {promise} a promise that is resolved after any scrolling is finished + */ + scrollToFocus: function (grid, rowEntity, colDef) { + var gridRow = null, gridCol = null; + + if (typeof(rowEntity) !== 'undefined' && rowEntity !== null) { + gridRow = grid.getRow(rowEntity); + } + + if (typeof(colDef) !== 'undefined' && colDef !== null) { + gridCol = grid.getColumn(colDef.name ? colDef.name : colDef.field); + } + return grid.api.core.scrollToIfNecessary(gridRow, gridCol).then(function () { + var rowCol = { row: gridRow, col: gridCol }; + + // Broadcast the navigation + if (gridRow !== null && gridCol !== null) { + grid.cellNav.broadcastCellNav(rowCol, null, null); + } + }); + }, + + + /** + * @ngdoc method + * @methodOf ui.grid.cellNav.service:uiGridCellNavService + * @name getLeftWidth + * @description Get the current drawn width of the columns in the + * grid up to the numbered column, and add an apportionment for the + * column that we're on. So if we are on column 0, we want to scroll + * 0% (i.e. exclude this column from calc). If we're on the last column + * we want to scroll to 100% (i.e. include this column in the calc). So + * we include (thisColIndex / totalNumberCols) % of this column width + * @param {Grid} grid the grid you'd like to act upon, usually available + * from gridApi.grid + * @param {GridColumn} upToCol the column to total up to and including + */ + getLeftWidth: function (grid, upToCol) { + var width = 0; + + if (!upToCol) { + return width; + } + + var lastIndex = grid.renderContainers.body.visibleColumnCache.indexOf( upToCol ); + + // total column widths up-to but not including the passed in column + grid.renderContainers.body.visibleColumnCache.forEach( function( col, index ) { + if ( index < lastIndex ) { + width += col.drawnWidth; + } + }); + + // pro-rata the final column based on % of total columns. + var percentage = lastIndex === 0 ? 0 : (lastIndex + 1) / grid.renderContainers.body.visibleColumnCache.length; + width += upToCol.drawnWidth * percentage; + + return width; + } + }; + + return service; + }]); + + /** + * @ngdoc directive + * @name ui.grid.cellNav.directive:uiCellNav + * @element div + * @restrict EA + * + * @description Adds cell navigation features to the grid columns + * + * @example +
+
+
+ ' +
+ ' ' +
+ ' ';
+
+ var ariaNotifier = $compile(ariaNotifierDomElt)($scope);
+ $elm.prepend(ariaNotifier);
+ $scope.$on(uiGridCellNavConstants.CELL_NAV_EVENT, function (evt, rowCol, modifierDown, originEvt) {
+ /*
+ * If the cell nav event was because of a focus event then we don't want to
+ * change the notifier text.
+ * Reasoning: Voice Over fires a focus events when moving arround the grid.
+ * If the screen reader is handing the grid nav properly then we don't need to
+ * use the alert to notify the user of the movement.
+ * In all other cases we do want a notification event.
+ */
+ if (originEvt && originEvt.type === 'focus') {return;}
+
+ function setNotifyText(text) {
+ if (text === ariaNotifier.text().trim()) {return;}
+ ariaNotifier[0].style.clip = 'rect(0px,0px,0px,0px)';
+ /*
+ * This is how google docs handles clearing the div. Seems to work better than setting the text of the div to ''
+ */
+ ariaNotifier[0].innerHTML = "";
+ ariaNotifier[0].style.visibility = 'hidden';
+ ariaNotifier[0].style.visibility = 'visible';
+ if (text !== '') {
+ ariaNotifier[0].style.clip = 'auto';
+ /*
+ * The space after the text is something that google docs does.
+ */
+ ariaNotifier[0].appendChild(document.createTextNode(text + " "));
+ ariaNotifier[0].style.visibility = 'hidden';
+ ariaNotifier[0].style.visibility = 'visible';
+ }
+ }
+
+ function getAppendedColumnHeaderText(col) {
+ return ', ' + i18nService.getSafeText('headerCell.aria.column') + ' ' + col.displayName;
+ }
+
+ function getCellDisplayValue(currentRowColumn) {
+ if (currentRowColumn.col.field === 'selectionRowHeaderCol') {
+ // This is the case when the 'selection' feature is used in the grid and the user has moved
+ // to or inside of the left grid container which holds the checkboxes for selecting rows.
+ // This is necessary for Accessibility. Without this a screen reader cannot determine if the row
+ // is or is not currently selected.
+ return currentRowColumn.row.isSelected ? i18nService.getSafeText('search.aria.selected') : i18nService.getSafeText('search.aria.notSelected');
+ } else {
+ return grid.getCellDisplayValue(currentRowColumn.row, currentRowColumn.col);
+ }
+ }
+
+ var values = [];
+ var currentSelection = grid.api.cellNav.getCurrentSelection();
+ for (var i = 0; i < currentSelection.length; i++) {
+ var cellDisplayValue = getCellDisplayValue(currentSelection[i]) + getAppendedColumnHeaderText(currentSelection[i].col);
+ values.push(cellDisplayValue);
+ }
+ var cellText = values.toString();
+ setNotifyText(cellText);
+
+ });
+ }
+ // Only add the ngAria stuff it will be used
+ if (usesAria) {
+ addAriaLiveRegion();
+ }
+ }
+ };
+ }
+ };
+ }]);
+
+ module.directive('uiGridRenderContainer', ['$timeout', '$document', 'gridUtil', 'uiGridConstants', 'uiGridCellNavService', '$compile','uiGridCellNavConstants',
+ function ($timeout, $document, gridUtil, uiGridConstants, uiGridCellNavService, $compile, uiGridCellNavConstants) {
+ return {
+ replace: true,
+ priority: -99999, // this needs to run very last
+ require: ['^uiGrid', 'uiGridRenderContainer', '?^uiGridCellnav'],
+ scope: false,
+ compile: function () {
+ return {
+ post: function ($scope, $elm, $attrs, controllers) {
+ var uiGridCtrl = controllers[0],
+ renderContainerCtrl = controllers[1],
+ uiGridCellnavCtrl = controllers[2];
+
+ // Skip attaching cell-nav specific logic if the directive is not attached above us
+ if (!uiGridCtrl.grid.api.cellNav) { return; }
+
+ var containerId = renderContainerCtrl.containerId;
+
+ var grid = uiGridCtrl.grid;
+
+ // run each time a render container is created
+ uiGridCellNavService.decorateRenderContainers(grid);
+
+ // focusser only created for body
+ if (containerId !== 'body') {
+ return;
+ }
+
+ if (uiGridCtrl.grid.options.modifierKeysToMultiSelectCells) {
+ $elm.attr('aria-multiselectable', true);
+ }
+ else {
+ $elm.attr('aria-multiselectable', false);
+ }
+
+ // add an element with no dimensions that can be used to set focus and capture keystrokes
+ var focuser = $compile('')($scope);
+ $elm.append(focuser);
+
+ focuser.on('focus', function (evt) {
+ evt.uiGridTargetRenderContainerId = containerId;
+ var rowCol = uiGridCtrl.grid.api.cellNav.getFocusedCell();
+ if (rowCol === null) {
+ rowCol = uiGridCtrl.grid.renderContainers[containerId].cellNav.getNextRowCol(uiGridCellNavConstants.direction.DOWN, null, null);
+ if (rowCol.row && rowCol.col) {
+ uiGridCtrl.cellNav.broadcastCellNav(rowCol);
+ }
+ }
+ });
+
+ uiGridCellnavCtrl.setAriaActivedescendant = function(id) {
+ $elm.attr('aria-activedescendant', id);
+ };
+
+ uiGridCellnavCtrl.removeAriaActivedescendant = function(id) {
+ if ($elm.attr('aria-activedescendant') === id) {
+ $elm.attr('aria-activedescendant', '');
+ }
+ };
+
+
+ uiGridCtrl.focus = function () {
+ gridUtil.focus.byElement(focuser[0]);
+ // allow for first time grid focus
+ };
+
+ var viewPortKeyDownWasRaisedForRowCol = null;
+ // Bind to keydown events in the render container
+ focuser.on('keydown', function (evt) {
+ evt.uiGridTargetRenderContainerId = containerId;
+ var rowCol = uiGridCtrl.grid.api.cellNav.getFocusedCell();
+ var raiseViewPortKeyDown = uiGridCtrl.grid.options.keyDownOverrides.some(function (override) {
+ return Object.keys(override).every( function (property) {
+ return override[property] === evt[property];
+ });
+ });
+ var result = raiseViewPortKeyDown ? null : uiGridCtrl.cellNav.handleKeyDown(evt);
+ if (result === null) {
+ uiGridCtrl.grid.api.cellNav.raise.viewPortKeyDown(evt, rowCol, uiGridCtrl.cellNav.handleKeyDown);
+ viewPortKeyDownWasRaisedForRowCol = rowCol;
+ }
+ });
+ // Bind to keypress events in the render container
+ // keypress events are needed by edit function so the key press
+ // that initiated an edit is not lost
+ // must fire the event in a timeout so the editor can
+ // initialize and subscribe to the event on another event loop
+ focuser.on('keypress', function (evt) {
+ if (viewPortKeyDownWasRaisedForRowCol) {
+ $timeout(function () {
+ uiGridCtrl.grid.api.cellNav.raise.viewPortKeyPress(evt, viewPortKeyDownWasRaisedForRowCol);
+ }, 4);
+
+ viewPortKeyDownWasRaisedForRowCol = null;
+ }
+ });
+
+ $scope.$on('$destroy', function() {
+ // Remove all event handlers associated with this focuser.
+ focuser.off();
+ });
+ }
+ };
+ }
+ };
+ }]);
+
+ module.directive('uiGridViewport',
+ function () {
+ return {
+ replace: true,
+ priority: -99999, // this needs to run very last
+ require: ['^uiGrid', '^uiGridRenderContainer', '?^uiGridCellnav'],
+ scope: false,
+ compile: function () {
+ return {
+ pre: function ($scope, $elm, $attrs, uiGridCtrl) {
+ },
+ post: function ($scope, $elm, $attrs, controllers) {
+ var uiGridCtrl = controllers[0],
+ renderContainerCtrl = controllers[1];
+
+ // Skip attaching cell-nav specific logic if the directive is not attached above us
+ if (!uiGridCtrl.grid.api.cellNav) { return; }
+
+ var containerId = renderContainerCtrl.containerId;
+ // no need to process for other containers
+ if (containerId !== 'body') {
+ return;
+ }
+
+ var grid = uiGridCtrl.grid;
+
+ grid.api.core.on.scrollBegin($scope, function () {
+
+ // Skip if there's no currently-focused cell
+ var lastRowCol = uiGridCtrl.grid.api.cellNav.getFocusedCell();
+ if (lastRowCol === null) {
+ return;
+ }
+
+ // if not in my container, move on
+ // todo: worry about horiz scroll
+ if (!renderContainerCtrl.colContainer.containsColumn(lastRowCol.col)) {
+ return;
+ }
+
+ uiGridCtrl.cellNav.clearFocus();
+
+ });
+
+ grid.api.core.on.scrollEnd($scope, function (args) {
+ // Skip if there's no currently-focused cell
+ var lastRowCol = uiGridCtrl.grid.api.cellNav.getFocusedCell();
+ if (lastRowCol === null) {
+ return;
+ }
+
+ // if not in my container, move on
+ // todo: worry about horiz scroll
+ if (!renderContainerCtrl.colContainer.containsColumn(lastRowCol.col)) {
+ return;
+ }
+
+ uiGridCtrl.cellNav.broadcastCellNav(lastRowCol);
+ });
+
+ grid.api.cellNav.on.navigate($scope, function () {
+ // focus again because it can be lost
+ uiGridCtrl.focus();
+ });
+ }
+ };
+ }
+ };
+ });
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.cellNav.directive:uiGridCell
+ * @element div
+ * @restrict A
+ * @description Stacks on top of ui.grid.uiGridCell to provide cell navigation
+ */
+ module.directive('uiGridCell', ['$timeout', '$document', 'uiGridCellNavService', 'gridUtil', 'uiGridCellNavConstants', 'uiGridConstants', 'GridRowColumn',
+ function ($timeout, $document, uiGridCellNavService, gridUtil, uiGridCellNavConstants, uiGridConstants, GridRowColumn) {
+ return {
+ priority: -150, // run after default uiGridCell directive and ui.grid.edit uiGridCell
+ restrict: 'A',
+ require: ['^uiGrid', '?^uiGridCellnav'],
+ scope: false,
+ link: function ($scope, $elm, $attrs, controllers) {
+ var uiGridCtrl = controllers[0],
+ uiGridCellnavCtrl = controllers[1];
+ // Skip attaching cell-nav specific logic if the directive is not attached above us
+ if (!uiGridCtrl.grid.api.cellNav) { return; }
+
+ if (!$scope.col.colDef.allowCellFocus) {
+ return;
+ }
+
+ // Convinience local variables
+ var grid = uiGridCtrl.grid;
+ $scope.focused = false;
+
+ // Make this cell focusable but only with javascript/a mouse click
+ $elm.attr('tabindex', -1);
+
+ // When a cell is clicked, broadcast a cellNav event saying that this row+col combo is now focused
+ $elm.find('div').on('click', function (evt) {
+ uiGridCtrl.cellNav.broadcastCellNav(new GridRowColumn($scope.row, $scope.col), evt.ctrlKey || evt.metaKey, evt);
+
+ evt.stopPropagation();
+ $scope.$apply();
+ });
+
+
+ /*
+ * XXX Hack for screen readers.
+ * This allows the grid to focus using only the screen reader cursor.
+ * Since the focus event doesn't include key press information we can't use it
+ * as our primary source of the event.
+ */
+ $elm.on('mousedown', preventMouseDown);
+
+ // turn on and off for edit events
+ if (uiGridCtrl.grid.api.edit) {
+ uiGridCtrl.grid.api.edit.on.beginCellEdit($scope, function () {
+ $elm.off('mousedown', preventMouseDown);
+ });
+
+ uiGridCtrl.grid.api.edit.on.afterCellEdit($scope, function () {
+ $elm.on('mousedown', preventMouseDown);
+ });
+
+ uiGridCtrl.grid.api.edit.on.cancelCellEdit($scope, function () {
+ $elm.on('mousedown', preventMouseDown);
+ });
+ }
+
+ // In case we created a new row, and we are the new created row by ngRepeat
+ // then this cell content might have been selected previously
+ refreshCellFocus();
+
+ function preventMouseDown(evt) {
+ // Prevents the foucus event from firing if the click event is already going to fire.
+ // If both events fire it will cause bouncing behavior.
+ evt.preventDefault();
+ }
+
+ // You can only focus on elements with a tabindex value
+ $elm.on('focus', function (evt) {
+ uiGridCtrl.cellNav.broadcastCellNav(new GridRowColumn($scope.row, $scope.col), false, evt);
+ evt.stopPropagation();
+ $scope.$apply();
+ });
+
+ // This event is fired for all cells. If the cell matches, then focus is set
+ $scope.$on(uiGridCellNavConstants.CELL_NAV_EVENT, refreshCellFocus);
+
+ // Refresh cell focus when a new row id added to the grid
+ var dataChangeDereg = uiGridCtrl.grid.registerDataChangeCallback(function (grid) {
+ // Clear the focus if it's set to avoid the wrong cell getting focused during
+ // a short period of time (from now until $timeout function executed)
+ clearFocus();
+
+ $scope.$applyAsync(refreshCellFocus);
+ }, [uiGridConstants.dataChange.ROW]);
+
+ function refreshCellFocus() {
+ var isFocused = grid.cellNav.focusedCells.some(function (focusedRowCol, index) {
+ return (focusedRowCol.row === $scope.row && focusedRowCol.col === $scope.col);
+ });
+ if (isFocused) {
+ setFocused();
+ } else {
+ clearFocus();
+ }
+ }
+
+ function setFocused() {
+ if (!$scope.focused) {
+ var div = $elm.find('div');
+ div.addClass('ui-grid-cell-focus');
+ $elm.attr('aria-selected', true);
+ uiGridCellnavCtrl.setAriaActivedescendant($elm.attr('id'));
+ $scope.focused = true;
+ }
+ }
+
+ function clearFocus() {
+ if ($scope.focused) {
+ var div = $elm.find('div');
+ div.removeClass('ui-grid-cell-focus');
+ $elm.attr('aria-selected', false);
+ uiGridCellnavCtrl.removeAriaActivedescendant($elm.attr('id'));
+ $scope.focused = false;
+ }
+ }
+
+ $scope.$on('$destroy', function () {
+ dataChangeDereg();
+
+ // .off withouth paramaters removes all handlers
+ $elm.find('div').off();
+ $elm.off();
+ });
+ }
+ };
+ }]);
+})();
diff --git a/release/4.9.2/i18n/ui-grid.cellnav.min.js b/release/4.9.2/i18n/ui-grid.cellnav.min.js
new file mode 100644
index 000000000..039383f41
--- /dev/null
+++ b/release/4.9.2/i18n/ui-grid.cellnav.min.js
@@ -0,0 +1,7 @@
+/*!
+ * ui-grid - v4.9.2 - 2020-12-01
+ * Copyright (c) 2020 ; License: MIT
+ */
+
+
+!function(){"use strict";var e=angular.module("ui.grid.cellNav",["ui.grid"]);e.constant("uiGridCellNavConstants",{FEATURE_NAME:"gridCellNav",CELL_NAV_EVENT:"cellNav",direction:{LEFT:0,RIGHT:1,UP:2,DOWN:3,PG_UP:4,PG_DOWN:5},EVENT_TYPE:{KEYDOWN:0,CLICK:1,CLEAR:2}}),e.factory("uiGridCellNavFactory",["gridUtil","uiGridConstants","uiGridCellNavConstants","GridRowColumn","$q",function(e,l,o,a,i){var n=function(e,l,i,o){this.rows=e.visibleRowCache,this.columns=l.visibleColumnCache,this.leftColumns=i?i.visibleColumnCache:[],this.rightColumns=o?o.visibleColumnCache:[],this.bodyContainer=e};return n.prototype.getFocusableCols=function(){return this.leftColumns.concat(this.columns,this.rightColumns).filter(function(e){return e.colDef.allowCellFocus})},n.prototype.getFocusableRows=function(){return this.rows.filter(function(e){return!1!==e.allowCellFocus})},n.prototype.getNextRowCol=function(e,l,i){switch(e){case o.direction.LEFT:return this.getRowColLeft(l,i);case o.direction.RIGHT:return this.getRowColRight(l,i);case o.direction.UP:return this.getRowColUp(l,i);case o.direction.DOWN:return this.getRowColDown(l,i);case o.direction.PG_UP:return this.getRowColPageUp(l,i);case o.direction.PG_DOWN:return this.getRowColPageDown(l,i)}},n.prototype.initializeSelection=function(){var e=this.getFocusableCols(),l=this.getFocusableRows();return 0===e.length||0===l.length?null:new a(l[0],e[0])},n.prototype.getRowColLeft=function(e,l){var i=this.getFocusableCols(),o=this.getFocusableRows(),n=i.indexOf(l),t=o.indexOf(e);-1===n&&(n=1);var r=0===n?i.length-1:n-1;return new a(n<=r?0===t?e:o[t-1]:e,i[r])},n.prototype.getRowColRight=function(e,l){var i=this.getFocusableCols(),o=this.getFocusableRows(),n=i.indexOf(l),t=o.indexOf(e);-1===n&&(n=0);var r=n===i.length-1?0:n+1;return r<=n?t===o.length-1?new a(e,i[r]):new a(o[t+1],i[r]):new a(e,i[r])},n.prototype.getRowColDown=function(e,l){var i=this.getFocusableCols(),o=this.getFocusableRows(),n=i.indexOf(l),t=o.indexOf(e);return-1===n&&(n=0),t===o.length-1?new a(e,i[n]):new a(o[t+1],i[n])},n.prototype.getRowColPageDown=function(e,l){var i=this.getFocusableCols(),o=this.getFocusableRows(),n=i.indexOf(l),t=o.indexOf(e);-1===n&&(n=0);var r=this.bodyContainer.minRowsToRender();return t>=o.length-r?new a(o[o.length-1],i[n]):new a(o[t+r],i[n])},n.prototype.getRowColUp=function(e,l){var i=this.getFocusableCols(),o=this.getFocusableRows(),n=i.indexOf(l),t=o.indexOf(e);return-1===n&&(n=0),new a(0===t?e:o[t-1],i[n])},n.prototype.getRowColPageUp=function(e,l){var i=this.getFocusableCols(),o=this.getFocusableRows(),n=i.indexOf(l),t=o.indexOf(e);-1===n&&(n=0);var r=this.bodyContainer.minRowsToRender();return new a(t-r<0?o[0]:o[t-r],i[n])},n}]),e.service("uiGridCellNavService",["gridUtil","uiGridConstants","uiGridCellNavConstants","$q","uiGridCellNavFactory","GridRowColumn","ScrollEvent",function(e,l,i,o,n,t,r){var a={initializeGrid:function(o){o.registerColumnBuilder(a.cellNavColumnBuilder),o.cellNav={},o.cellNav.lastRowCol=null,o.cellNav.focusedCells=[],a.defaultGridOptions(o.options);var e={events:{cellNav:{navigate:function(e,l){},viewPortKeyDown:function(e,l){},viewPortKeyPress:function(e,l){}}},methods:{cellNav:{scrollToFocus:function(e,l){return a.scrollToFocus(o,e,l)},getFocusedCell:function(){return o.cellNav.lastRowCol},getCurrentSelection:function(){return o.cellNav.focusedCells},rowColSelectIndex:function(e){for(var l=-1,i=0;i
+ * .ui-grid-column-menu-button {
+ * display: block;
+ * }
+ *
+ */
+ /**
+ * @ngdoc property
+ * @name enableColumnMenus
+ * @propertyOf ui.grid.class:GridOptions.columnDef
+ * @description Override for column menus everywhere - if set to false then you get no
+ * column menus. Defaults to true.
+ *
+ */
+
+ $scope.offAllEvents();
+
+ if ($scope.sortable || $scope.colMenu) {
+ $scope.onDownEvents();
+
+ $scope.$on('$destroy', function () {
+ $scope.offAllEvents();
+ });
+ }
+ };
+
+ updateHeaderOptions();
+
+ if ($scope.col.filterContainer === 'columnMenu' && $scope.col.filterable) {
+ $rootScope.$on('menu-shown', function() {
+ $scope.$applyAsync(function () {
+ setFilter($scope.col.filterable);
+ });
+ });
+ }
+
+ // Register a data change watch that would get triggered whenever someone edits a cell or modifies column defs
+ var dataChangeDereg = $scope.grid.registerDataChangeCallback( updateHeaderOptions, [uiGridConstants.dataChange.COLUMN]);
+
+ $scope.$on( '$destroy', dataChangeDereg );
+
+ $scope.handleClick = function(event) {
+ // If the shift key is being held down, add this column to the sort
+ var add = false;
+ if (event.shiftKey) {
+ add = true;
+ }
+
+ // Sort this column then rebuild the grid's rows
+ uiGridCtrl.grid.sortColumn($scope.col, add)
+ .then(function () {
+ if (uiGridCtrl.columnMenuScope) { uiGridCtrl.columnMenuScope.hideMenu(); }
+ uiGridCtrl.grid.refresh();
+ }).catch(angular.noop);
+ };
+
+ $scope.headerCellArrowKeyDown = function(event) {
+ if (event.keyCode === 32 || event.keyCode === 13) {
+ event.preventDefault();
+ $scope.toggleMenu(event);
+ }
+ };
+
+ $scope.toggleMenu = function(event) {
+
+ event.stopPropagation();
+
+ // If the menu is already showing...
+ if (uiGridCtrl.columnMenuScope.menuShown) {
+ // ... and we're the column the menu is on...
+ if (uiGridCtrl.columnMenuScope.col === $scope.col) {
+ // ... hide it
+ uiGridCtrl.columnMenuScope.hideMenu();
+ }
+ // ... and we're NOT the column the menu is on
+ else {
+ // ... move the menu to our column
+ uiGridCtrl.columnMenuScope.showMenu($scope.col, $elm);
+ }
+ }
+ // If the menu is NOT showing
+ else {
+ // ... show it on our column
+ uiGridCtrl.columnMenuScope.showMenu($scope.col, $elm);
+ }
+ };
+ }
+ };
+ }
+ };
+ }]);
+})();
+
+(function() {
+ 'use strict';
+
+ angular.module('ui.grid').directive('uiGridHeader', ['$templateCache', '$compile', 'uiGridConstants', 'gridUtil', '$timeout', 'ScrollEvent',
+ function($templateCache, $compile, uiGridConstants, gridUtil, $timeout, ScrollEvent) {
+ var defaultTemplate = 'ui-grid/ui-grid-header',
+ emptyTemplate = 'ui-grid/ui-grid-no-header';
+
+ return {
+ restrict: 'EA',
+ replace: true,
+ require: ['^uiGrid', '^uiGridRenderContainer'],
+ scope: true,
+ compile: function() {
+ return {
+ pre: function ($scope, $elm, $attrs, controllers) {
+ var uiGridCtrl = controllers[0],
+ containerCtrl = controllers[1];
+
+ $scope.grid = uiGridCtrl.grid;
+ $scope.colContainer = containerCtrl.colContainer;
+
+ updateHeaderReferences();
+
+ var headerTemplate;
+ if (!$scope.grid.options.showHeader) {
+ headerTemplate = emptyTemplate;
+ }
+ else {
+ headerTemplate = ($scope.grid.options.headerTemplate) ? $scope.grid.options.headerTemplate : defaultTemplate;
+ }
+
+ gridUtil.getTemplate(headerTemplate)
+ .then(function (contents) {
+ var template = angular.element(contents);
+
+ var newElm = $compile(template)($scope);
+ $elm.replaceWith(newElm);
+
+ // And update $elm to be the new element
+ $elm = newElm;
+
+ updateHeaderReferences();
+
+ if (containerCtrl) {
+ // Inject a reference to the header viewport (if it exists) into the grid controller for use in the horizontal scroll handler below
+ var headerViewport = $elm[0].getElementsByClassName('ui-grid-header-viewport')[0];
+
+
+ if (headerViewport) {
+ containerCtrl.headerViewport = headerViewport;
+ angular.element(headerViewport).on('scroll', scrollHandler);
+ $scope.$on('$destroy', function () {
+ angular.element(headerViewport).off('scroll', scrollHandler);
+ });
+ }
+ }
+
+ $scope.grid.queueRefresh();
+ }).catch(angular.noop);
+
+ function updateHeaderReferences() {
+ containerCtrl.header = containerCtrl.colContainer.header = $elm;
+
+ var headerCanvases = $elm[0].getElementsByClassName('ui-grid-header-canvas');
+
+ if (headerCanvases.length > 0) {
+ containerCtrl.headerCanvas = containerCtrl.colContainer.headerCanvas = headerCanvases[0];
+ }
+ else {
+ containerCtrl.headerCanvas = null;
+ }
+ }
+
+ function scrollHandler() {
+ if (uiGridCtrl.grid.isScrollingHorizontally) {
+ return;
+ }
+ var newScrollLeft = gridUtil.normalizeScrollLeft(containerCtrl.headerViewport, uiGridCtrl.grid);
+ var horizScrollPercentage = containerCtrl.colContainer.scrollHorizontal(newScrollLeft);
+
+ var scrollEvent = new ScrollEvent(uiGridCtrl.grid, null, containerCtrl.colContainer, ScrollEvent.Sources.ViewPortScroll);
+ scrollEvent.newScrollLeft = newScrollLeft;
+ if ( horizScrollPercentage > -1 ) {
+ scrollEvent.x = { percentage: horizScrollPercentage };
+ }
+
+ uiGridCtrl.grid.scrollContainers(null, scrollEvent);
+ }
+ },
+
+ post: function ($scope, $elm, $attrs, controllers) {
+ var uiGridCtrl = controllers[0];
+ var containerCtrl = controllers[1];
+
+ // gridUtil.logDebug('ui-grid-header link');
+
+ var grid = uiGridCtrl.grid;
+
+ // Don't animate header cells
+ gridUtil.disableAnimations($elm);
+
+ function updateColumnWidths() {
+ // this styleBuilder always runs after the renderContainer, so we can rely on the column widths
+ // already being populated correctly
+
+ var columnCache = containerCtrl.colContainer.visibleColumnCache;
+
+ // Build the CSS
+ // uiGridCtrl.grid.columns.forEach(function (column) {
+ var ret = '';
+ var canvasWidth = 0;
+ columnCache.forEach(function (column) {
+ ret = ret + column.getColClassDefinition();
+ canvasWidth += column.drawnWidth;
+ });
+
+ containerCtrl.colContainer.canvasWidth = canvasWidth;
+
+ // Return the styles back to buildStyles which pops them into the `customStyles` scope variable
+ return ret;
+ }
+
+ containerCtrl.header = $elm;
+
+ var headerViewport = $elm[0].getElementsByClassName('ui-grid-header-viewport')[0];
+ if (headerViewport) {
+ containerCtrl.headerViewport = headerViewport;
+ }
+
+ // todo: remove this if by injecting gridCtrl into unit tests
+ if (uiGridCtrl) {
+ uiGridCtrl.grid.registerStyleComputation({
+ priority: 15,
+ func: updateColumnWidths
+ });
+ }
+ }
+ };
+ }
+ };
+ }]);
+})();
+
+(function() {
+
+angular.module('ui.grid')
+.service('uiGridGridMenuService', [ 'gridUtil', 'i18nService', 'uiGridConstants', function( gridUtil, i18nService, uiGridConstants ) {
+ /**
+ * @ngdoc service
+ * @name ui.grid.uiGridGridMenuService
+ *
+ * @description Methods for working with the grid menu
+ */
+
+ var service = {
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.uiGridGridMenuService
+ * @name initialize
+ * @description Sets up the gridMenu. Most importantly, sets our
+ * scope onto the grid object as grid.gridMenuScope, allowing us
+ * to operate when passed only the grid. Second most importantly,
+ * we register the 'addToGridMenu' and 'removeFromGridMenu' methods
+ * on the core api.
+ * @param {$scope} $scope the scope of this gridMenu
+ * @param {Grid} grid the grid to which this gridMenu is associated
+ */
+ initialize: function( $scope, grid ) {
+ grid.gridMenuScope = $scope;
+ $scope.grid = grid;
+ $scope.registeredMenuItems = [];
+
+ // not certain this is needed, but would be bad to create a memory leak
+ $scope.$on('$destroy', function() {
+ if ( $scope.grid && $scope.grid.gridMenuScope ) {
+ $scope.grid.gridMenuScope = null;
+ }
+ if ( $scope.grid ) {
+ $scope.grid = null;
+ }
+ if ( $scope.registeredMenuItems ) {
+ $scope.registeredMenuItems = null;
+ }
+ });
+
+ $scope.registeredMenuItems = [];
+
+ /**
+ * @ngdoc function
+ * @name addToGridMenu
+ * @methodOf ui.grid.api:PublicApi
+ * @description add items to the grid menu. Used by features
+ * to add their menu items if they are enabled, can also be used by
+ * end users to add menu items. This method has the advantage of allowing
+ * remove again, which can simplify management of which items are included
+ * in the menu when. (Noting that in most cases the shown and active functions
+ * provide a better way to handle visibility of menu items)
+ * @param {Grid} grid the grid on which we are acting
+ * @param {array} items menu items in the format as described in the tutorial, with
+ * the added note that if you want to use remove you must also specify an `id` field,
+ * which is provided when you want to remove an item. The id should be unique.
+ *
+ */
+ grid.api.registerMethod( 'core', 'addToGridMenu', service.addToGridMenu );
+
+ /**
+ * @ngdoc function
+ * @name removeFromGridMenu
+ * @methodOf ui.grid.api:PublicApi
+ * @description Remove an item from the grid menu based on a provided id. Assumes
+ * that the id is unique, removes only the last instance of that id. Does nothing if
+ * the specified id is not found
+ * @param {Grid} grid the grid on which we are acting
+ * @param {string} id the id we'd like to remove from the menu
+ *
+ */
+ grid.api.registerMethod( 'core', 'removeFromGridMenu', service.removeFromGridMenu );
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name addToGridMenu
+ * @propertyOf ui.grid.uiGridGridMenuService
+ * @description add items to the grid menu. Used by features
+ * to add their menu items if they are enabled, can also be used by
+ * end users to add menu items. This method has the advantage of allowing
+ * remove again, which can simplify management of which items are included
+ * in the menu when. (Noting that in most cases the shown and active functions
+ * provide a better way to handle visibility of menu items)
+ * @param {Grid} grid the grid on which we are acting
+ * @param {array} menuItems menu items in the format as described in the tutorial, with
+ * the added note that if you want to use remove you must also specify an `id` field,
+ * which is provided when you want to remove an item. The id should be unique.
+ *
+ */
+ addToGridMenu: function( grid, menuItems ) {
+ if ( !angular.isArray( menuItems ) ) {
+ gridUtil.logError( 'addToGridMenu: menuItems must be an array, and is not, not adding any items');
+ } else {
+ if ( grid.gridMenuScope ) {
+ grid.gridMenuScope.registeredMenuItems = grid.gridMenuScope.registeredMenuItems ? grid.gridMenuScope.registeredMenuItems : [];
+ grid.gridMenuScope.registeredMenuItems = grid.gridMenuScope.registeredMenuItems.concat( menuItems );
+ } else {
+ gridUtil.logError( 'Asked to addToGridMenu, but gridMenuScope not present. Timing issue? Please log issue with ui-grid');
+ }
+ }
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name removeFromGridMenu
+ * @methodOf ui.grid.uiGridGridMenuService
+ * @description Remove an item from the grid menu based on a provided id. Assumes
+ * that the id is unique, removes only the last instance of that id. Does nothing if
+ * the specified id is not found. If there is no gridMenuScope or registeredMenuItems
+ * then do nothing silently - the desired result is those menu items not be present and they
+ * aren't.
+ * @param {Grid} grid the grid on which we are acting
+ * @param {string} id the id we'd like to remove from the menu
+ *
+ */
+ removeFromGridMenu: function( grid, id ) {
+ var foundIndex = -1;
+
+ if ( grid && grid.gridMenuScope ) {
+ grid.gridMenuScope.registeredMenuItems.forEach( function( value, index ) {
+ if ( value.id === id ) {
+ if (foundIndex > -1) {
+ gridUtil.logError( 'removeFromGridMenu: found multiple items with the same id, removing only the last' );
+ } else {
+
+ foundIndex = index;
+ }
+ }
+ });
+ }
+
+ if ( foundIndex > -1 ) {
+ grid.gridMenuScope.registeredMenuItems.splice( foundIndex, 1 );
+ }
+ },
+
+
+ /**
+ * @ngdoc array
+ * @name gridMenuCustomItems
+ * @propertyOf ui.grid.class:GridOptions
+ * @description (optional) An array of menu items that should be added to
+ * the gridMenu. Follow the format documented in the tutorial for column
+ * menu customisation. The context provided to the action function will
+ * include context.grid. An alternative if working with dynamic menus is to use the
+ * provided api - core.addToGridMenu and core.removeFromGridMenu, which handles
+ * some of the management of items for you.
+ *
+ */
+ /**
+ * @ngdoc boolean
+ * @name gridMenuShowHideColumns
+ * @propertyOf ui.grid.class:GridOptions
+ * @description true by default, whether the grid menu should allow hide/show
+ * of columns
+ *
+ */
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.uiGridGridMenuService
+ * @name getMenuItems
+ * @description Decides the menu items to show in the menu. This is a
+ * combination of:
+ *
+ * - the default menu items that are always included,
+ * - any menu items that have been provided through the addMenuItem api. These
+ * are typically added by features within the grid
+ * - any menu items included in grid.options.gridMenuCustomItems. These can be
+ * changed dynamically, as they're always recalculated whenever we show the
+ * menu
+ * @param {$scope} $scope the scope of this gridMenu, from which we can find all
+ * the information that we need
+ * @returns {Array} an array of menu items that can be shown
+ */
+ getMenuItems: function( $scope ) {
+ var menuItems = [
+ // this is where we add any menu items we want to always include
+ ];
+
+ if ( $scope.grid.options.gridMenuCustomItems ) {
+ if ( !angular.isArray( $scope.grid.options.gridMenuCustomItems ) ) {
+ gridUtil.logError( 'gridOptions.gridMenuCustomItems must be an array, and is not');
+ } else {
+ menuItems = menuItems.concat( $scope.grid.options.gridMenuCustomItems );
+ }
+ }
+
+ var clearFilters = [{
+ title: i18nService.getSafeText('gridMenu.clearAllFilters'),
+ action: function ($event) {
+ $scope.grid.clearAllFilters();
+ },
+ shown: function() {
+ return $scope.grid.options.enableFiltering;
+ },
+ order: 100
+ }];
+ menuItems = menuItems.concat( clearFilters );
+
+ menuItems = menuItems.concat( $scope.registeredMenuItems );
+
+ if ( $scope.grid.options.gridMenuShowHideColumns !== false ) {
+ menuItems = menuItems.concat( service.showHideColumns( $scope ) );
+ }
+
+ menuItems.sort(function(a, b) {
+ return a.order - b.order;
+ });
+
+ return menuItems;
+ },
+
+
+ /**
+ * @ngdoc array
+ * @name gridMenuTitleFilter
+ * @propertyOf ui.grid.class:GridOptions
+ * @description (optional) A function that takes a title string
+ * (usually the col.displayName), and converts it into a display value. The function
+ * must return either a string or a promise.
+ *
+ * Used for internationalization of the grid menu column names - for angular-translate
+ * you can pass $translate as the function, for i18nService you can pass getSafeText as the
+ * function
+ * @example
+ *
+ * gridOptions = {
+ * gridMenuTitleFilter: $translate
+ * }
+ *
+ */
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.uiGridGridMenuService
+ * @name showHideColumns
+ * @description Adds two menu items for each of the columns in columnDefs. One
+ * menu item for hide, one menu item for show. Each is visible when appropriate
+ * (show when column is not visible, hide when column is visible). Each toggles
+ * the visible property on the columnDef using toggleColumnVisibility
+ * @param {$scope} $scope of a gridMenu, which contains a reference to the grid
+ */
+ showHideColumns: function( $scope ) {
+ var showHideColumns = [];
+ if ( !$scope.grid.options.columnDefs || $scope.grid.options.columnDefs.length === 0 || $scope.grid.columns.length === 0 ) {
+ return showHideColumns;
+ }
+
+ function isColumnVisible(colDef) {
+ return colDef.visible === true || colDef.visible === undefined;
+ }
+
+ function getColumnIcon(colDef) {
+ return isColumnVisible(colDef) ? 'ui-grid-icon-ok' : 'ui-grid-icon-cancel';
+ }
+
+ // add header for columns
+ showHideColumns.push({
+ title: i18nService.getSafeText('gridMenu.columns'),
+ order: 300,
+ templateUrl: 'ui-grid/ui-grid-menu-header-item'
+ });
+
+ $scope.grid.options.gridMenuTitleFilter = $scope.grid.options.gridMenuTitleFilter ? $scope.grid.options.gridMenuTitleFilter : function( title ) { return title; };
+
+ $scope.grid.options.columnDefs.forEach( function( colDef, index ) {
+ if ( colDef.enableHiding !== false ) {
+ // add hide menu item - shows an OK icon as we only show when column is already visible
+ var menuItem = {
+ icon: getColumnIcon(colDef),
+ action: function($event) {
+ $event.stopPropagation();
+
+ service.toggleColumnVisibility( this.context.gridCol );
+
+ if ($event.target && $event.target.firstChild) {
+ if (angular.element($event.target)[0].nodeName === 'I') {
+ $event.target.className = getColumnIcon(this.context.gridCol.colDef);
+ }
+ else {
+ $event.target.firstChild.className = getColumnIcon(this.context.gridCol.colDef);
+ }
+ }
+ },
+ shown: function() {
+ return this.context.gridCol.colDef.enableHiding !== false;
+ },
+ context: { gridCol: $scope.grid.getColumn(colDef.name || colDef.field) },
+ leaveOpen: true,
+ order: 301 + index
+ };
+ service.setMenuItemTitle( menuItem, colDef, $scope.grid );
+ showHideColumns.push( menuItem );
+ }
+ });
+ return showHideColumns;
+ },
+
+
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.uiGridGridMenuService
+ * @name setMenuItemTitle
+ * @description Handles the response from gridMenuTitleFilter, adding it directly to the menu
+ * item if it returns a string, otherwise waiting for the promise to resolve or reject then
+ * putting the result into the title
+ * @param {object} menuItem the menuItem we want to put the title on
+ * @param {object} colDef the colDef from which we can get displayName, name or field
+ * @param {Grid} grid the grid, from which we can get the options.gridMenuTitleFilter
+ *
+ */
+ setMenuItemTitle: function( menuItem, colDef, grid ) {
+ var title = grid.options.gridMenuTitleFilter( colDef.displayName || gridUtil.readableColumnName(colDef.name) || colDef.field );
+
+ if ( typeof(title) === 'string' ) {
+ menuItem.title = title;
+ } else if ( title.then ) {
+ // must be a promise
+ menuItem.title = "";
+ title.then( function( successValue ) {
+ menuItem.title = successValue;
+ }, function( errorValue ) {
+ menuItem.title = errorValue;
+ }).catch(angular.noop);
+ } else {
+ gridUtil.logError('Expected gridMenuTitleFilter to return a string or a promise, it has returned neither, bad config');
+ menuItem.title = 'badconfig';
+ }
+ },
+
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.uiGridGridMenuService
+ * @name toggleColumnVisibility
+ * @description Toggles the visibility of an individual column. Expects to be
+ * provided a context that has on it a gridColumn, which is the column that
+ * we'll operate upon. We change the visibility, and refresh the grid as appropriate
+ * @param {GridColumn} gridCol the column that we want to toggle
+ *
+ */
+ toggleColumnVisibility: function( gridCol ) {
+ gridCol.colDef.visible = !( gridCol.colDef.visible === true || gridCol.colDef.visible === undefined );
+
+ gridCol.grid.refresh();
+ gridCol.grid.api.core.notifyDataChange( uiGridConstants.dataChange.COLUMN );
+ gridCol.grid.api.core.raise.columnVisibilityChanged( gridCol );
+ }
+ };
+
+ return service;
+}])
+
+.directive('uiGridMenuButton', ['gridUtil', 'uiGridConstants', 'uiGridGridMenuService', 'i18nService',
+function (gridUtil, uiGridConstants, uiGridGridMenuService, i18nService) {
+
+ return {
+ priority: 0,
+ scope: true,
+ require: ['^uiGrid'],
+ templateUrl: 'ui-grid/ui-grid-menu-button',
+ replace: true,
+
+ link: function ($scope, $elm, $attrs, controllers) {
+ var uiGridCtrl = controllers[0];
+
+ // For the aria label
+ $scope.i18n = {
+ aria: i18nService.getSafeText('gridMenu.aria')
+ };
+
+ uiGridGridMenuService.initialize($scope, uiGridCtrl.grid);
+
+ $scope.shown = false;
+
+ $scope.toggleMenu = function () {
+ if ( $scope.shown ) {
+ $scope.$broadcast('hide-menu');
+ $scope.shown = false;
+ } else {
+ $scope.menuItems = uiGridGridMenuService.getMenuItems( $scope );
+ $scope.$broadcast('show-menu');
+ $scope.shown = true;
+ }
+ };
+
+ $scope.$on('menu-hidden', function() {
+ $scope.shown = false;
+ gridUtil.focus.bySelector($elm, '.ui-grid-icon-container');
+ });
+ }
+ };
+}]);
+})();
+
+(function() {
+
+/**
+ * @ngdoc directive
+ * @name ui.grid.directive:uiGridMenu
+ * @element style
+ * @restrict A
+ *
+ * @description
+ * Allows us to interpolate expressions in `
+ I am in a box.
+
+
+ NOTE: It is important to remember to always pass in an event object to
+ * the scrollHandler as the grid scrolling behavior will break without it.
+ * Example+ *
+ * $scope.gridOptions = {
+ * customScroller: function myScrolling(uiGridViewport, scrollHandler) {
+ * uiGridViewport.on('scroll', function myScrollingOverride(event) {
+ * // Do something here
+ *
+ * scrollHandler(event);
+ * });
+ * }
+ * };
+ *
+ * @param {object} uiGridViewport Element being scrolled. (this gets passed in by the grid).
+ * @param {function} scrollHandler Function that needs to be called when scrolling happens. (this gets passed in by the grid).
+ */
+ if (grid && grid.options && grid.options.customScroller) {
+ grid.options.customScroller($elm, scrollHandler);
+ } else {
+ $elm.on('scroll', scrollHandler);
+ }
+
+ var ignoreScroll = false;
+
+ function scrollHandler() {
+ var newScrollTop = $elm[0].scrollTop;
+ var newScrollLeft = gridUtil.normalizeScrollLeft($elm, grid);
+
+ var vertScrollPercentage = rowContainer.scrollVertical(newScrollTop);
+ var horizScrollPercentage = colContainer.scrollHorizontal(newScrollLeft);
+
+ var scrollEvent = new ScrollEvent(grid, rowContainer, colContainer, ScrollEvent.Sources.ViewPortScroll);
+ scrollEvent.newScrollLeft = newScrollLeft;
+ scrollEvent.newScrollTop = newScrollTop;
+ if ( horizScrollPercentage > -1 ) {
+ scrollEvent.x = { percentage: horizScrollPercentage };
+ }
+
+ if ( vertScrollPercentage > -1 ) {
+ scrollEvent.y = { percentage: vertScrollPercentage };
+ }
+
+ grid.scrollContainers($scope.$parent.containerId, scrollEvent);
+ }
+
+ if ($scope.$parent.bindScrollVertical) {
+ grid.addVerticalScrollSync($scope.$parent.containerId, syncVerticalScroll);
+ }
+
+ if ($scope.$parent.bindScrollHorizontal) {
+ grid.addHorizontalScrollSync($scope.$parent.containerId, syncHorizontalScroll);
+ grid.addHorizontalScrollSync($scope.$parent.containerId + 'header', syncHorizontalHeader);
+ grid.addHorizontalScrollSync($scope.$parent.containerId + 'footer', syncHorizontalFooter);
+ }
+
+ function syncVerticalScroll(scrollEvent) {
+ containerCtrl.prevScrollArgs = scrollEvent;
+ $elm[0].scrollTop = scrollEvent.getNewScrollTop(rowContainer,containerCtrl.viewport);
+ }
+
+ function syncHorizontalScroll(scrollEvent) {
+ containerCtrl.prevScrollArgs = scrollEvent;
+ var newScrollLeft = scrollEvent.getNewScrollLeft(colContainer, containerCtrl.viewport);
+
+ $elm[0].scrollLeft = gridUtil.denormalizeScrollLeft(containerCtrl.viewport,newScrollLeft, grid);
+ }
+
+ function syncHorizontalHeader(scrollEvent) {
+ var newScrollLeft = scrollEvent.getNewScrollLeft(colContainer, containerCtrl.viewport);
+
+ if (containerCtrl.headerViewport) {
+ containerCtrl.headerViewport.scrollLeft = gridUtil.denormalizeScrollLeft(containerCtrl.viewport,newScrollLeft, grid);
+ }
+ }
+
+ function syncHorizontalFooter(scrollEvent) {
+ var newScrollLeft = scrollEvent.getNewScrollLeft(colContainer, containerCtrl.viewport);
+
+ if (containerCtrl.footerViewport) {
+ containerCtrl.footerViewport.scrollLeft = gridUtil.denormalizeScrollLeft(containerCtrl.viewport,newScrollLeft, grid);
+ }
+ }
+
+ $scope.$on('$destroy', function unbindEvents() {
+ $elm.off();
+ });
+ },
+ controller: ['$scope', function ($scope) {
+ this.rowStyle = function () {
+ var rowContainer = $scope.rowContainer;
+ var colContainer = $scope.colContainer;
+
+ var styles = {};
+
+ if (rowContainer.currentTopRow !== 0) {
+ // top offset based on hidden rows count
+ var translateY = "translateY("+ (rowContainer.currentTopRow * rowContainer.grid.options.rowHeight) +"px)";
+
+ styles['transform'] = translateY;
+ styles['-webkit-transform'] = translateY;
+ styles['-ms-transform'] = translateY;
+ }
+
+ if (colContainer.currentFirstColumn !== 0) {
+ if (colContainer.grid.isRTL()) {
+ styles['margin-right'] = colContainer.columnOffset + 'px';
+ }
+ else {
+ styles['margin-left'] = colContainer.columnOffset + 'px';
+ }
+ }
+
+ return styles;
+ };
+ }]
+ };
+ }
+ ]);
+
+})();
+
+(function() {
+ angular.module('ui.grid')
+ .directive('uiGridVisible', function uiGridVisibleAction() {
+ return function($scope, $elm, $attr) {
+ $scope.$watch($attr.uiGridVisible, function(visible) {
+ $elm[visible ? 'removeClass' : 'addClass']('ui-grid-invisible');
+ });
+ };
+ });
+})();
+
+(function () {
+ 'use strict';
+
+ angular.module('ui.grid').controller('uiGridController', ['$scope', '$element', '$attrs', 'gridUtil', '$q', 'uiGridConstants',
+ 'gridClassFactory', '$parse', '$compile',
+ function ($scope, $elm, $attrs, gridUtil, $q, uiGridConstants,
+ gridClassFactory, $parse, $compile) {
+ // gridUtil.logDebug('ui-grid controller');
+ var self = this;
+ var deregFunctions = [];
+
+ self.grid = gridClassFactory.createGrid($scope.uiGrid);
+
+ // assign $scope.$parent if appScope not already assigned
+ self.grid.appScope = self.grid.appScope || $scope.$parent;
+
+ $elm.addClass('grid' + self.grid.id);
+ self.grid.rtl = gridUtil.getStyles($elm[0])['direction'] === 'rtl';
+
+
+ // angular.extend(self.grid.options, );
+
+ // all properties of grid are available on scope
+ $scope.grid = self.grid;
+
+ if ($attrs.uiGridColumns) {
+ deregFunctions.push( $attrs.$observe('uiGridColumns', function(value) {
+ self.grid.options.columnDefs = angular.isString(value) ? angular.fromJson(value) : value;
+ self.grid.buildColumns()
+ .then(function() {
+ self.grid.preCompileCellTemplates();
+
+ self.grid.refreshCanvas(true);
+ }).catch(angular.noop);
+ }) );
+ }
+
+ // prevents an error from being thrown when the array is not defined yet and fastWatch is on
+ function getSize(array) {
+ return array ? array.length : 0;
+ }
+
+ // if fastWatch is set we watch only the length and the reference, not every individual object
+ if (self.grid.options.fastWatch) {
+ self.uiGrid = $scope.uiGrid;
+ if (angular.isString($scope.uiGrid.data)) {
+ deregFunctions.push( $scope.$parent.$watch($scope.uiGrid.data, dataWatchFunction) );
+ deregFunctions.push( $scope.$parent.$watch(function() {
+ if ( self.grid.appScope[$scope.uiGrid.data] ) {
+ return self.grid.appScope[$scope.uiGrid.data].length;
+ } else {
+ return undefined;
+ }
+ }, dataWatchFunction) );
+ } else {
+ deregFunctions.push( $scope.$parent.$watch(function() { return $scope.uiGrid.data; }, dataWatchFunction) );
+ deregFunctions.push( $scope.$parent.$watch(function() { return getSize($scope.uiGrid.data); }, function() { dataWatchFunction($scope.uiGrid.data); }) );
+ }
+ deregFunctions.push( $scope.$parent.$watch(function() { return $scope.uiGrid.columnDefs; }, columnDefsWatchFunction) );
+ deregFunctions.push( $scope.$parent.$watch(function() { return getSize($scope.uiGrid.columnDefs); }, function() { columnDefsWatchFunction($scope.uiGrid.columnDefs); }) );
+ } else {
+ if (angular.isString($scope.uiGrid.data)) {
+ deregFunctions.push( $scope.$parent.$watchCollection($scope.uiGrid.data, dataWatchFunction) );
+ } else {
+ deregFunctions.push( $scope.$parent.$watchCollection(function() { return $scope.uiGrid.data; }, dataWatchFunction) );
+ }
+ deregFunctions.push( $scope.$parent.$watchCollection(function() { return $scope.uiGrid.columnDefs; }, columnDefsWatchFunction) );
+ }
+
+
+ function columnDefsWatchFunction(n, o) {
+ if (n && n !== o) {
+ self.grid.options.columnDefs = $scope.uiGrid.columnDefs;
+ self.grid.callDataChangeCallbacks(uiGridConstants.dataChange.COLUMN, {
+ orderByColumnDefs: true,
+ preCompileCellTemplates: true
+ });
+ }
+ }
+
+ var mostRecentData;
+
+ function dataWatchFunction(newData) {
+ // gridUtil.logDebug('dataWatch fired');
+ var promises = [];
+
+ if ( self.grid.options.fastWatch ) {
+ if (angular.isString($scope.uiGrid.data)) {
+ newData = self.grid.appScope.$eval($scope.uiGrid.data);
+ } else {
+ newData = $scope.uiGrid.data;
+ }
+ }
+
+ mostRecentData = newData;
+
+ if (newData) {
+ // columns length is greater than the number of row header columns, which don't count because they're created automatically
+ var hasColumns = self.grid.columns.length > (self.grid.rowHeaderColumns ? self.grid.rowHeaderColumns.length : 0);
+
+ if (
+ // If we have no columns
+ !hasColumns &&
+ // ... and we don't have a ui-grid-columns attribute, which would define columns for us
+ !$attrs.uiGridColumns &&
+ // ... and we have no pre-defined columns
+ self.grid.options.columnDefs.length === 0 &&
+ // ... but we DO have data
+ newData.length > 0
+ ) {
+ // ... then build the column definitions from the data that we have
+ self.grid.buildColumnDefsFromData(newData);
+ }
+
+ // If we haven't built columns before and either have some columns defined or some data defined
+ if (!hasColumns && (self.grid.options.columnDefs.length > 0 || newData.length > 0)) {
+ // Build the column set, then pre-compile the column cell templates
+ promises.push(self.grid.buildColumns()
+ .then(function() {
+ self.grid.preCompileCellTemplates();
+ }).catch(angular.noop));
+ }
+
+ $q.all(promises).then(function() {
+ // use most recent data, rather than the potentially outdated data passed into watcher handler
+ self.grid.modifyRows(mostRecentData)
+ .then(function () {
+ // if (self.viewport) {
+ self.grid.redrawInPlace(true);
+ // }
+
+ $scope.$evalAsync(function() {
+ self.grid.refreshCanvas(true);
+ self.grid.callDataChangeCallbacks(uiGridConstants.dataChange.ROW);
+ });
+ }).catch(angular.noop);
+ }).catch(angular.noop);
+ }
+ }
+
+ var styleWatchDereg = $scope.$watch(function () { return self.grid.styleComputations; }, function() {
+ self.grid.refreshCanvas(true);
+ });
+
+ $scope.$on('$destroy', function() {
+ deregFunctions.forEach( function( deregFn ) { deregFn(); });
+ styleWatchDereg();
+ });
+
+ self.fireEvent = function(eventName, args) {
+ args = args || {};
+
+ // Add the grid to the event arguments if it's not there
+ if (angular.isUndefined(args.grid)) {
+ args.grid = self.grid;
+ }
+
+ $scope.$broadcast(eventName, args);
+ };
+
+ self.innerCompile = function innerCompile(elm) {
+ $compile(elm)($scope);
+ };
+ }]);
+
+/**
+ * @ngdoc directive
+ * @name ui.grid.directive:uiGrid
+ * @element div
+ * @restrict EA
+ * @param {Object} uiGrid Options for the grid to use
+ *
+ * @description Create a very basic grid.
+ *
+ * @example
+
+
+
+ '
+ + ''
+ + ' ',
+ scope: {
+ side: '=uiGridPinnedContainer'
+ },
+ require: '^uiGrid',
+ compile: function compile() {
+ return {
+ post: function ($scope, $elm, $attrs, uiGridCtrl) {
+ // gridUtil.logDebug('ui-grid-pinned-container ' + $scope.side + ' link');
+
+ var grid = uiGridCtrl.grid;
+
+ var myWidth = 0;
+
+ $elm.addClass('ui-grid-pinned-container-' + $scope.side);
+
+ // Monkey-patch the viewport width function
+ if ($scope.side === 'left' || $scope.side === 'right') {
+ grid.renderContainers[$scope.side].getViewportWidth = monkeyPatchedGetViewportWidth;
+ }
+
+ function monkeyPatchedGetViewportWidth() {
+ /*jshint validthis: true */
+ var self = this;
+
+ var viewportWidth = 0;
+ self.visibleColumnCache.forEach(function (column) {
+ viewportWidth += column.drawnWidth;
+ });
+
+ var adjustment = self.getViewportAdjustment();
+
+ viewportWidth = viewportWidth + adjustment.width;
+
+ return viewportWidth;
+ }
+
+ function updateContainerWidth() {
+ if ($scope.side === 'left' || $scope.side === 'right') {
+ var cols = grid.renderContainers[$scope.side].visibleColumnCache;
+ var width = 0;
+ for (var i = 0; i < cols.length; i++) {
+ var col = cols[i];
+ width += col.drawnWidth || col.width || 0;
+ }
+
+ return width;
+ }
+ }
+
+ function updateContainerDimensions() {
+ var ret = '';
+
+ // Column containers
+ if ($scope.side === 'left' || $scope.side === 'right') {
+ myWidth = updateContainerWidth();
+
+ // gridUtil.logDebug('myWidth', myWidth);
+
+ // TODO(c0bra): Subtract sum of col widths from grid viewport width and update it
+ $elm.attr('style', null);
+
+ // var myHeight = grid.renderContainers.body.getViewportHeight(); // + grid.horizontalScrollbarHeight;
+
+ ret += '.grid' + grid.id + ' .ui-grid-pinned-container-' + $scope.side + ', .grid' + grid.id + ' .ui-grid-pinned-container-' + $scope.side + ' .ui-grid-render-container-' + $scope.side + ' .ui-grid-viewport { width: ' + myWidth + 'px; } ';
+ }
+
+ return ret;
+ }
+
+ grid.renderContainers.body.registerViewportAdjuster(function (adjustment) {
+ myWidth = updateContainerWidth();
+
+ // Subtract our own width
+ adjustment.width -= myWidth;
+ adjustment.side = $scope.side;
+
+ return adjustment;
+ });
+
+ // Register style computation to adjust for columns in `side`'s render container
+ grid.registerStyleComputation({
+ priority: 15,
+ func: updateContainerDimensions
+ });
+ }
+ };
+ }
+ };
+ }]);
+})();
+
+(function () {
+ angular.module('ui.grid').config(['$provide', function($provide) {
+ $provide.decorator('i18nService', ['$delegate', function($delegate) {
+ $delegate.add('en', {
+ headerCell: {
+ aria: {
+ defaultFilterLabel: 'Filter for column',
+ removeFilter: 'Remove Filter',
+ columnMenuButtonLabel: 'Column Menu',
+ column: 'Column'
+ },
+ priority: 'Priority:',
+ filterLabel: "Filter for column: "
+ },
+ aggregate: {
+ label: 'items'
+ },
+ groupPanel: {
+ description: 'Drag a column header here and drop it to group by that column.'
+ },
+ search: {
+ aria: {
+ selected: 'Row selected',
+ notSelected: 'Row not selected'
+ },
+ placeholder: 'Search...',
+ showingItems: 'Showing Items:',
+ selectedItems: 'Selected Items:',
+ totalItems: 'Total Items:',
+ size: 'Page Size:',
+ first: 'First Page',
+ next: 'Next Page',
+ previous: 'Previous Page',
+ last: 'Last Page'
+ },
+ menu: {
+ text: 'Choose Columns:'
+ },
+ sort: {
+ ascending: 'Sort Ascending',
+ descending: 'Sort Descending',
+ none: 'Sort None',
+ remove: 'Remove Sort'
+ },
+ column: {
+ hide: 'Hide Column'
+ },
+ aggregation: {
+ count: 'total rows: ',
+ sum: 'total: ',
+ avg: 'avg: ',
+ min: 'min: ',
+ max: 'max: '
+ },
+ pinning: {
+ pinLeft: 'Pin Left',
+ pinRight: 'Pin Right',
+ unpin: 'Unpin'
+ },
+ columnMenu: {
+ close: 'Close'
+ },
+ gridMenu: {
+ aria: {
+ buttonLabel: 'Grid Menu'
+ },
+ columns: 'Columns:',
+ importerTitle: 'Import file',
+ exporterAllAsCsv: 'Export all data as csv',
+ exporterVisibleAsCsv: 'Export visible data as csv',
+ exporterSelectedAsCsv: 'Export selected data as csv',
+ exporterAllAsPdf: 'Export all data as pdf',
+ exporterVisibleAsPdf: 'Export visible data as pdf',
+ exporterSelectedAsPdf: 'Export selected data as pdf',
+ exporterAllAsExcel: 'Export all data as excel',
+ exporterVisibleAsExcel: 'Export visible data as excel',
+ exporterSelectedAsExcel: 'Export selected data as excel',
+ clearAllFilters: 'Clear all filters'
+ },
+ importer: {
+ noHeaders: 'Column names were unable to be derived, does the file have a header?',
+ noObjects: 'Objects were not able to be derived, was there data in the file other than headers?',
+ invalidCsv: 'File was unable to be processed, is it valid CSV?',
+ invalidJson: 'File was unable to be processed, is it valid Json?',
+ jsonNotArray: 'Imported json file must contain an array, aborting.'
+ },
+ pagination: {
+ aria: {
+ pageToFirst: 'Page to first',
+ pageBack: 'Page back',
+ pageSelected: 'Selected page',
+ pageForward: 'Page forward',
+ pageToLast: 'Page to last'
+ },
+ sizes: 'items per page',
+ totalItems: 'items',
+ through: 'through',
+ of: 'of'
+ },
+ grouping: {
+ group: 'Group',
+ ungroup: 'Ungroup',
+ aggregate_count: 'Agg: Count',
+ aggregate_sum: 'Agg: Sum',
+ aggregate_max: 'Agg: Max',
+ aggregate_min: 'Agg: Min',
+ aggregate_avg: 'Agg: Avg',
+ aggregate_remove: 'Agg: Remove'
+ },
+ validate: {
+ error: 'Error:',
+ minLength: 'Value should be at least THRESHOLD characters long.',
+ maxLength: 'Value should be at most THRESHOLD characters long.',
+ required: 'A value is needed.'
+ }
+ });
+ return $delegate;
+ }]);
+ }]);
+})();
+
+(function() {
+
+angular.module('ui.grid')
+.factory('Grid', ['$q', '$compile', '$parse', 'gridUtil', 'uiGridConstants', 'GridOptions', 'GridColumn', 'GridRow', 'GridApi', 'rowSorter', 'rowSearcher', 'GridRenderContainer', '$timeout','ScrollEvent',
+ function($q, $compile, $parse, gridUtil, uiGridConstants, GridOptions, GridColumn, GridRow, GridApi, rowSorter, rowSearcher, GridRenderContainer, $timeout, ScrollEvent) {
+
+ /**
+ * @ngdoc object
+ * @name ui.grid.api:PublicApi
+ * @description Public Api for the core grid features
+ *
+ */
+
+ /**
+ * @ngdoc function
+ * @name ui.grid.class:Grid
+ * @description Grid is the main viewModel. Any properties or methods needed to maintain state are defined in
+ * this prototype. One instance of Grid is created per Grid directive instance.
+ * @param {object} options Object map of options to pass into the grid. An 'id' property is expected.
+ */
+ var Grid = function Grid(options) {
+ var self = this;
+ // Get the id out of the options, then remove it
+ if (options !== undefined && typeof(options.id) !== 'undefined' && options.id) {
+ if (!/^[_a-zA-Z0-9-]+$/.test(options.id)) {
+ throw new Error("Grid id '" + options.id + '" is invalid. It must follow CSS selector syntax rules.');
+ }
+ }
+ else {
+ throw new Error('No ID provided. An ID must be given when creating a grid.');
+ }
+
+ self.id = options.id;
+ delete options.id;
+
+ // Get default options
+ self.options = GridOptions.initialize( options );
+
+ /**
+ * @ngdoc object
+ * @name appScope
+ * @propertyOf ui.grid.class:Grid
+ * @description reference to the application scope (the parent scope of the ui-grid element). Assigned in ui-grid controller
+ * + * use gridOptions.appScopeProvider to override the default assignment of $scope.$parent with any reference + */ + self.appScope = self.options.appScopeProvider; + + self.headerHeight = self.options.headerRowHeight; + + + /** + * @ngdoc object + * @name footerHeight + * @propertyOf ui.grid.class:Grid + * @description returns the total footer height gridFooter + columnFooter + */ + self.footerHeight = self.calcFooterHeight(); + + + /** + * @ngdoc object + * @name columnFooterHeight + * @propertyOf ui.grid.class:Grid + * @description returns the total column footer height + */ + self.columnFooterHeight = self.calcColumnFooterHeight(); + + self.rtl = false; + self.gridHeight = 0; + self.gridWidth = 0; + self.columnBuilders = []; + self.rowBuilders = []; + self.rowsProcessors = []; + self.columnsProcessors = []; + self.styleComputations = []; + self.viewportAdjusters = []; + self.rowHeaderColumns = []; + self.dataChangeCallbacks = {}; + self.verticalScrollSyncCallBackFns = {}; + self.horizontalScrollSyncCallBackFns = {}; + + // self.visibleRowCache = []; + + // Set of 'render' containers for self grid, which can render sets of rows + self.renderContainers = {}; + + // Create a + self.renderContainers.body = new GridRenderContainer('body', self); + + self.cellValueGetterCache = {}; + + // Cached function to use with custom row templates + self.getRowTemplateFn = null; + + + // representation of the rows on the grid. + // these are wrapped references to the actual data rows (options.data) + self.rows = []; + + // represents the columns on the grid + self.columns = []; + + /** + * @ngdoc boolean + * @name isScrollingVertically + * @propertyOf ui.grid.class:Grid + * @description set to true when Grid is scrolling vertically. Set to false via debounced method + */ + self.isScrollingVertically = false; + + /** + * @ngdoc boolean + * @name isScrollingHorizontally + * @propertyOf ui.grid.class:Grid + * @description set to true when Grid is scrolling horizontally. Set to false via debounced method + */ + self.isScrollingHorizontally = false; + + /** + * @ngdoc property + * @name scrollDirection + * @propertyOf ui.grid.class:Grid + * @description set one of the {@link ui.grid.service:uiGridConstants#properties_scrollDirection uiGridConstants.scrollDirection} + * values (UP, DOWN, LEFT, RIGHT, NONE), which tells us which direction we are scrolling. + * Set to NONE via debounced method + */ + self.scrollDirection = uiGridConstants.scrollDirection.NONE; + + // if true, grid will not respond to any scroll events + self.disableScrolling = false; + + + function vertical (scrollEvent) { + self.isScrollingVertically = false; + self.api.core.raise.scrollEnd(scrollEvent); + self.scrollDirection = uiGridConstants.scrollDirection.NONE; + } + + var debouncedVertical = gridUtil.debounce(vertical, self.options.scrollDebounce); + var debouncedVerticalMinDelay = gridUtil.debounce(vertical, 0); + + function horizontal (scrollEvent) { + self.isScrollingHorizontally = false; + self.api.core.raise.scrollEnd(scrollEvent); + self.scrollDirection = uiGridConstants.scrollDirection.NONE; + } + + var debouncedHorizontal = gridUtil.debounce(horizontal, self.options.scrollDebounce); + var debouncedHorizontalMinDelay = gridUtil.debounce(horizontal, 0); + + + /** + * @ngdoc function + * @name flagScrollingVertically + * @methodOf ui.grid.class:Grid + * @description sets isScrollingVertically to true and sets it to false in a debounced function + */ + self.flagScrollingVertically = function(scrollEvent) { + if (!self.isScrollingVertically && !self.isScrollingHorizontally) { + self.api.core.raise.scrollBegin(scrollEvent); + } + self.isScrollingVertically = true; + if (self.options.scrollDebounce === 0 || !scrollEvent.withDelay) { + debouncedVerticalMinDelay(scrollEvent); + } + else { + debouncedVertical(scrollEvent); + } + }; + + /** + * @ngdoc function + * @name flagScrollingHorizontally + * @methodOf ui.grid.class:Grid + * @description sets isScrollingHorizontally to true and sets it to false in a debounced function + */ + self.flagScrollingHorizontally = function(scrollEvent) { + if (!self.isScrollingVertically && !self.isScrollingHorizontally) { + self.api.core.raise.scrollBegin(scrollEvent); + } + self.isScrollingHorizontally = true; + if (self.options.scrollDebounce === 0 || !scrollEvent.withDelay) { + debouncedHorizontalMinDelay(scrollEvent); + } + else { + debouncedHorizontal(scrollEvent); + } + }; + + self.scrollbarHeight = 0; + self.scrollbarWidth = 0; + if (self.options.enableHorizontalScrollbar !== uiGridConstants.scrollbars.NEVER) { + self.scrollbarHeight = gridUtil.getScrollbarWidth(); + } + + if (self.options.enableVerticalScrollbar !== uiGridConstants.scrollbars.NEVER) { + self.scrollbarWidth = gridUtil.getScrollbarWidth(); + } + + self.api = new GridApi(self); + + /** + * @ngdoc function + * @name refresh + * @methodOf ui.grid.api:PublicApi + * @description Refresh the rendered grid on screen. + * The refresh method re-runs both the columnProcessors and the + * rowProcessors, as well as calling refreshCanvas to update all + * the grid sizing. In general you should prefer to use queueGridRefresh + * instead, which is basically a debounced version of refresh. + * + * If you only want to resize the grid, not regenerate all the rows + * and columns, you should consider directly calling refreshCanvas instead. + * + * @param {boolean} [rowsAltered] Optional flag for refreshing when the number of rows has changed + */ + self.api.registerMethod( 'core', 'refresh', this.refresh ); + + /** + * @ngdoc function + * @name queueGridRefresh + * @methodOf ui.grid.api:PublicApi + * @description Request a refresh of the rendered grid on screen, if multiple + * calls to queueGridRefresh are made within a digest cycle only one will execute. + * The refresh method re-runs both the columnProcessors and the + * rowProcessors, as well as calling refreshCanvas to update all + * the grid sizing. In general you should prefer to use queueGridRefresh + * instead, which is basically a debounced version of refresh. + * + */ + self.api.registerMethod( 'core', 'queueGridRefresh', this.queueGridRefresh ); + + /** + * @ngdoc function + * @name refreshRows + * @methodOf ui.grid.api:PublicApi + * @description Runs only the rowProcessors, columns remain as they were. + * It then calls redrawInPlace and refreshCanvas, which adjust the grid sizing. + * @returns {promise} promise that is resolved when render completes? + * + */ + self.api.registerMethod( 'core', 'refreshRows', this.refreshRows ); + + /** + * @ngdoc function + * @name queueRefresh + * @methodOf ui.grid.api:PublicApi + * @description Requests execution of refreshCanvas, if multiple requests are made + * during a digest cycle only one will run. RefreshCanvas updates the grid sizing. + * @returns {promise} promise that is resolved when render completes? + * + */ + self.api.registerMethod( 'core', 'queueRefresh', this.queueRefresh ); + + /** + * @ngdoc function + * @name handleWindowResize + * @methodOf ui.grid.api:PublicApi + * @description Trigger a grid resize, normally this would be picked + * up by a watch on window size, but in some circumstances it is necessary + * to call this manually + * @returns {promise} promise that is resolved when render completes? + * + */ + self.api.registerMethod( 'core', 'handleWindowResize', this.handleWindowResize ); + + + /** + * @ngdoc function + * @name addRowHeaderColumn + * @methodOf ui.grid.api:PublicApi + * @description adds a row header column to the grid + * @param {object} column def + * @param {number} order Determines order of header column on grid. Lower order means header + * is positioned to the left of higher order headers + * + */ + self.api.registerMethod( 'core', 'addRowHeaderColumn', this.addRowHeaderColumn ); + + /** + * @ngdoc function + * @name scrollToIfNecessary + * @methodOf ui.grid.api:PublicApi + * @description Scrolls the grid to make a certain row and column combo visible, + * in the case that it is not completely visible on the screen already. + * @param {GridRow} gridRow row to make visible + * @param {GridColumn} gridCol column to make visible + * @returns {promise} a promise that is resolved when scrolling is complete + * + */ + self.api.registerMethod( 'core', 'scrollToIfNecessary', function(gridRow, gridCol) { return self.scrollToIfNecessary(gridRow, gridCol);} ); + + /** + * @ngdoc function + * @name scrollTo + * @methodOf ui.grid.api:PublicApi + * @description Scroll the grid such that the specified + * row and column is in view + * @param {object} rowEntity gridOptions.data[] array instance to make visible + * @param {object} colDef to make visible + * @returns {promise} a promise that is resolved after any scrolling is finished + */ + self.api.registerMethod( 'core', 'scrollTo', function (rowEntity, colDef) { return self.scrollTo(rowEntity, colDef);} ); + + /** + * @ngdoc function + * @name registerRowsProcessor + * @methodOf ui.grid.api:PublicApi + * @description + * Register a "rows processor" function. When the rows are updated, + * the grid calls each registered "rows processor", which has a chance + * to alter the set of rows (sorting, etc) as long as the count is not + * modified. + * + * @param {function(renderedRowsToProcess, columns )} processorFunction rows processor function, which + * is run in the context of the grid (i.e. this for the function will be the grid), and must + * return the updated rows list, which is passed to the next processor in the chain + * @param {number} priority the priority of this processor. In general we try to do them in 100s to leave room + * for other people to inject rows processors at intermediate priorities. Lower priority rowsProcessors run earlier. + * + * At present allRowsVisible is running at 50, sort manipulations running at 60-65, filter is running at 100, + * sort is at 200, grouping and treeview at 400-410, selectable rows at 500, pagination at 900 (pagination will generally want to be last) + */ + self.api.registerMethod( 'core', 'registerRowsProcessor', this.registerRowsProcessor ); + + /** + * @ngdoc function + * @name registerColumnsProcessor + * @methodOf ui.grid.api:PublicApi + * @description + * Register a "columns processor" function. When the columns are updated, + * the grid calls each registered "columns processor", which has a chance + * to alter the set of columns as long as the count is not + * modified. + * + * @param {function(renderedColumnsToProcess, rows )} processorFunction columns processor function, which + * is run in the context of the grid (i.e. this for the function will be the grid), and must + * return the updated columns list, which is passed to the next processor in the chain + * @param {number} priority the priority of this processor. In general we try to do them in 100s to leave room + * for other people to inject columns processors at intermediate priorities. Lower priority columnsProcessors run earlier. + * + * At present allRowsVisible is running at 50, filter is running at 100, sort is at 200, grouping at 400, selectable rows at 500, pagination at 900 (pagination will generally want to be last) + */ + self.api.registerMethod( 'core', 'registerColumnsProcessor', this.registerColumnsProcessor ); + + /** + * @ngdoc function + * @name sortHandleNulls + * @methodOf ui.grid.api:PublicApi + * @description A null handling method that can be used when building custom sort + * functions + * @example + *
+ * mySortFn = function(a, b) {
+ * var nulls = $scope.gridApi.core.sortHandleNulls(a, b);
+ * if ( nulls !== null ) {
+ * return nulls;
+ * } else {
+ * // your code for sorting here
+ * };
+ *
+ * @param {object} a sort value a
+ * @param {object} b sort value b
+ * @returns {number} null if there were no nulls/undefineds, otherwise returns
+ * a sort value that should be passed back from the sort function
+ *
+ */
+ self.api.registerMethod( 'core', 'sortHandleNulls', rowSorter.handleNulls );
+
+ /**
+ * @ngdoc function
+ * @name sortChanged
+ * @methodOf ui.grid.api:PublicApi
+ * @description The sort criteria on one or more columns has
+ * changed. Provides as parameters the grid and the output of
+ * getColumnSorting, which is an array of gridColumns
+ * that have sorting on them, sorted in priority order.
+ *
+ * @param {$scope} scope The scope of the controller. This is used to deregister this event when the scope is destroyed.
+ * @param {Function} callBack Will be called when the event is emited. The function passes back the grid and an array of
+ * columns with sorts on them, in priority order.
+ *
+ * @example
+ *
+ * gridApi.core.on.sortChanged( $scope, function(grid, sortColumns) {
+ * // do something
+ * });
+ *
+ */
+ self.api.registerEvent( 'core', 'sortChanged' );
+
+ /**
+ * @ngdoc function
+ * @name columnVisibilityChanged
+ * @methodOf ui.grid.api:PublicApi
+ * @description The visibility of a column has changed,
+ * the column itself is passed out as a parameter of the event.
+ *
+ * @param {$scope} scope The scope of the controller. This is used to deregister this event when the scope is destroyed.
+ * @param {Function} callBack Will be called when the event is emited. The function passes back the GridCol that has changed.
+ *
+ * @example
+ *
+ * gridApi.core.on.columnVisibilityChanged( $scope, function (column) {
+ * // do something
+ * } );
+ *
+ */
+ self.api.registerEvent( 'core', 'columnVisibilityChanged' );
+
+ /**
+ * @ngdoc method
+ * @name notifyDataChange
+ * @methodOf ui.grid.api:PublicApi
+ * @description Notify the grid that a data or config change has occurred,
+ * where that change isn't something the grid was otherwise noticing. This
+ * might be particularly relevant where you've changed values within the data
+ * and you'd like cell classes to be re-evaluated, or changed config within
+ * the columnDef and you'd like headerCellClasses to be re-evaluated.
+ * @param {string} type one of the
+ * {@link ui.grid.service:uiGridConstants#properties_dataChange uiGridConstants.dataChange}
+ * values (ALL, ROW, EDIT, COLUMN, OPTIONS), which tells us which refreshes to fire.
+ *
+ * - ALL: listeners fired on any of these events, fires listeners on all events.
+ * - ROW: fired when a row is added or removed.
+ * - EDIT: fired when the data in a cell is edited.
+ * - COLUMN: fired when the column definitions are modified.
+ * - OPTIONS: fired when the grid options are modified.
+ */
+ self.api.registerMethod( 'core', 'notifyDataChange', this.notifyDataChange );
+
+ /**
+ * @ngdoc method
+ * @name clearAllFilters
+ * @methodOf ui.grid.api:PublicApi
+ * @description Clears all filters and optionally refreshes the visible rows.
+ * @param {object} refreshRows Defaults to true.
+ * @param {object} clearConditions Defaults to false.
+ * @param {object} clearFlags Defaults to false.
+ * @returns {promise} If `refreshRows` is true, returns a promise of the rows refreshing.
+ */
+ self.api.registerMethod('core', 'clearAllFilters', this.clearAllFilters);
+
+ self.registerDataChangeCallback( self.columnRefreshCallback, [uiGridConstants.dataChange.COLUMN]);
+ self.registerDataChangeCallback( self.processRowsCallback, [uiGridConstants.dataChange.EDIT]);
+ self.registerDataChangeCallback( self.updateFooterHeightCallback, [uiGridConstants.dataChange.OPTIONS]);
+
+ self.registerStyleComputation({
+ priority: 10,
+ func: self.getFooterStyles
+ });
+ };
+
+ Grid.prototype.calcFooterHeight = function () {
+ if (!this.hasFooter()) {
+ return 0;
+ }
+
+ var height = 0;
+ if (this.options.showGridFooter) {
+ height += this.options.gridFooterHeight;
+ }
+
+ height += this.calcColumnFooterHeight();
+
+ return height;
+ };
+
+ Grid.prototype.calcColumnFooterHeight = function () {
+ var height = 0;
+
+ if (this.options.showColumnFooter) {
+ height += this.options.columnFooterHeight;
+ }
+
+ return height;
+ };
+
+ Grid.prototype.getFooterStyles = function () {
+ var style = '.grid' + this.id + ' .ui-grid-footer-aggregates-row { height: ' + this.options.columnFooterHeight + 'px; }';
+ style += ' .grid' + this.id + ' .ui-grid-footer-info { height: ' + this.options.gridFooterHeight + 'px; }';
+ return style;
+ };
+
+ Grid.prototype.hasFooter = function () {
+ return this.options.showGridFooter || this.options.showColumnFooter;
+ };
+
+ /**
+ * @ngdoc function
+ * @name isRTL
+ * @methodOf ui.grid.class:Grid
+ * @description Returns true if grid is RightToLeft
+ */
+ Grid.prototype.isRTL = function () {
+ return this.rtl;
+ };
+
+
+ /**
+ * @ngdoc function
+ * @name registerColumnBuilder
+ * @methodOf ui.grid.class:Grid
+ * @description When the build creates columns from column definitions, the columnbuilders will be called to add
+ * additional properties to the column.
+ * @param {function(colDef, col, gridOptions)} columnBuilder function to be called
+ */
+ Grid.prototype.registerColumnBuilder = function registerColumnBuilder(columnBuilder) {
+ this.columnBuilders.push(columnBuilder);
+ };
+
+ /**
+ * @ngdoc function
+ * @name buildColumnDefsFromData
+ * @methodOf ui.grid.class:Grid
+ * @description Populates columnDefs from the provided data
+ * @param {function(colDef, col, gridOptions)} rowBuilder function to be called
+ */
+ Grid.prototype.buildColumnDefsFromData = function (dataRows) {
+ this.options.columnDefs = gridUtil.getColumnsFromData(dataRows, this.options.excludeProperties);
+ };
+
+ /**
+ * @ngdoc function
+ * @name registerRowBuilder
+ * @methodOf ui.grid.class:Grid
+ * @description When the build creates rows from gridOptions.data, the rowBuilders will be called to add
+ * additional properties to the row.
+ * @param {function(row, gridOptions)} rowBuilder function to be called
+ */
+ Grid.prototype.registerRowBuilder = function registerRowBuilder(rowBuilder) {
+ this.rowBuilders.push(rowBuilder);
+ };
+
+ /**
+ * @ngdoc function
+ * @name registerDataChangeCallback
+ * @methodOf ui.grid.class:Grid
+ * @description When a data change occurs, the data change callbacks of the specified type
+ * will be called. The rules are:
+ *
+ * - when the data watch fires, that is considered a ROW change (the data watch only notices
+ * added or removed rows)
+ * - when the api is called to inform us of a change, the declared type of that change is used
+ * - when a cell edit completes, the EDIT callbacks are triggered
+ * - when the columnDef watch fires, the COLUMN callbacks are triggered
+ * - when the options watch fires, the OPTIONS callbacks are triggered
+ *
+ * For a given event:
+ * - ALL calls ROW, EDIT, COLUMN, OPTIONS and ALL callbacks
+ * - ROW calls ROW and ALL callbacks
+ * - EDIT calls EDIT and ALL callbacks
+ * - COLUMN calls COLUMN and ALL callbacks
+ * - OPTIONS calls OPTIONS and ALL callbacks
+ *
+ * @param {function(grid)} callback function to be called
+ * @param {array} types the types of data change you want to be informed of. Values from
+ * the {@link ui.grid.service:uiGridConstants#properties_dataChange uiGridConstants.dataChange}
+ * values ( ALL, EDIT, ROW, COLUMN, OPTIONS ). Optional and defaults to ALL
+ * @returns {function} deregister function - a function that can be called to deregister this callback
+ */
+ Grid.prototype.registerDataChangeCallback = function registerDataChangeCallback(callback, types, _this) {
+ var self = this,
+ uid = gridUtil.nextUid();
+
+ if ( !types ) {
+ types = [uiGridConstants.dataChange.ALL];
+ }
+ if ( !Array.isArray(types)) {
+ gridUtil.logError("Expected types to be an array or null in registerDataChangeCallback, value passed was: " + types );
+ }
+ this.dataChangeCallbacks[uid] = { callback: callback, types: types, _this: _this };
+
+ return function() {
+ delete self.dataChangeCallbacks[uid];
+ };
+ };
+
+ /**
+ * @ngdoc function
+ * @name callDataChangeCallbacks
+ * @methodOf ui.grid.class:Grid
+ * @description Calls the callbacks based on the type of data change that
+ * has occurred. Always calls the ALL callbacks, calls the ROW, EDIT, COLUMN and OPTIONS callbacks if the
+ * event type is matching, or if the type is ALL.
+ * @param {string} type the type of event that occurred - one of the
+ * {@link ui.grid.service:uiGridConstants#properties_dataChange uiGridConstants.dataChange}
+ * values (ALL, ROW, EDIT, COLUMN, OPTIONS)
+ */
+ Grid.prototype.callDataChangeCallbacks = function callDataChangeCallbacks(type, options) {
+ angular.forEach( this.dataChangeCallbacks, function( callback, uid ) {
+ if ( callback.types.indexOf( uiGridConstants.dataChange.ALL ) !== -1 ||
+ callback.types.indexOf( type ) !== -1 ||
+ type === uiGridConstants.dataChange.ALL ) {
+ if (callback._this) {
+ callback.callback.apply(callback._this, this, options);
+ }
+ else {
+ callback.callback(this, options);
+ }
+ }
+ }, this);
+ };
+
+ /**
+ * @ngdoc function
+ * @name notifyDataChange
+ * @methodOf ui.grid.class:Grid
+ * @description Notifies us that a data change has occurred, used in the public
+ * api for users to tell us when they've changed data or some other event that
+ * our watches cannot pick up
+ * @param {string} type the type of event that occurred - one of the
+ * uiGridConstants.dataChange values (ALL, ROW, EDIT, COLUMN, OPTIONS)
+ *
+ * - ALL: listeners fired on any of these events, fires listeners on all events.
+ * - ROW: fired when a row is added or removed.
+ * - EDIT: fired when the data in a cell is edited.
+ * - COLUMN: fired when the column definitions are modified.
+ * - OPTIONS: fired when the grid options are modified.
+ */
+ Grid.prototype.notifyDataChange = function notifyDataChange(type) {
+ var constants = uiGridConstants.dataChange;
+
+ if ( type === constants.ALL ||
+ type === constants.COLUMN ||
+ type === constants.EDIT ||
+ type === constants.ROW ||
+ type === constants.OPTIONS ) {
+ this.callDataChangeCallbacks( type );
+ }
+ else {
+ gridUtil.logError("Notified of a data change, but the type was not recognised, so no action taken, type was: " + type);
+ }
+ };
+
+ /**
+ * @ngdoc function
+ * @name columnRefreshCallback
+ * @methodOf ui.grid.class:Grid
+ * @description refreshes the grid when a column refresh
+ * is notified, which triggers handling of the visible flag.
+ * This is called on uiGridConstants.dataChange.COLUMN, and is
+ * registered as a dataChangeCallback in grid.js
+ * @param {object} grid The grid object.
+ * @param {object} options Any options passed into the callback.
+ */
+ Grid.prototype.columnRefreshCallback = function columnRefreshCallback(grid, options) {
+ grid.buildColumns(options);
+ grid.queueGridRefresh();
+ };
+
+ /**
+ * @ngdoc function
+ * @name processRowsCallback
+ * @methodOf ui.grid.class:Grid
+ * @description calls the row processors, specifically
+ * intended to reset the sorting when an edit is called,
+ * registered as a dataChangeCallback on uiGridConstants.dataChange.EDIT
+ * @param {object} grid The grid object.
+ */
+ Grid.prototype.processRowsCallback = function processRowsCallback( grid ) {
+ grid.queueGridRefresh();
+ };
+
+
+ /**
+ * @ngdoc function
+ * @name updateFooterHeightCallback
+ * @methodOf ui.grid.class:Grid
+ * @description recalculates the footer height,
+ * registered as a dataChangeCallback on uiGridConstants.dataChange.OPTIONS
+ * @param {object} grid The grid object.
+ */
+ Grid.prototype.updateFooterHeightCallback = function updateFooterHeightCallback( grid ) {
+ grid.footerHeight = grid.calcFooterHeight();
+ grid.columnFooterHeight = grid.calcColumnFooterHeight();
+ };
+
+
+ /**
+ * @ngdoc function
+ * @name getColumn
+ * @methodOf ui.grid.class:Grid
+ * @description returns a grid column for the column name
+ * @param {string} name column name
+ */
+ Grid.prototype.getColumn = function getColumn(name) {
+ var columns = this.columns.filter(function (column) {
+ return column.colDef.name === name;
+ });
+
+ return columns.length > 0 ? columns[0] : null;
+ };
+
+ /**
+ * @ngdoc function
+ * @name getColDef
+ * @methodOf ui.grid.class:Grid
+ * @description returns a grid colDef for the column name
+ * @param {string} name column.field
+ */
+ Grid.prototype.getColDef = function getColDef(name) {
+ var colDefs = this.options.columnDefs.filter(function (colDef) {
+ return colDef.name === name;
+ });
+ return colDefs.length > 0 ? colDefs[0] : null;
+ };
+
+ /**
+ * @ngdoc function
+ * @name assignTypes
+ * @methodOf ui.grid.class:Grid
+ * @description uses the first row of data to assign colDef.type for any types not defined.
+ */
+ /**
+ * @ngdoc property
+ * @name type
+ * @propertyOf ui.grid.class:GridOptions.columnDef
+ * @description the type of the column, used in sorting. If not provided then the
+ * grid will guess the type. Add this only if the grid guessing is not to your
+ * satisfaction. One of:
+ * - 'string'
+ * - 'boolean'
+ * - 'number'
+ * - 'date'
+ * - 'object'
+ * - 'numberStr'
+ * Note that if you choose date, your dates should be in a javascript date type
+ *
+ */
+ Grid.prototype.assignTypes = function() {
+ var self = this;
+
+ self.options.columnDefs.forEach(function (colDef, index) {
+ // Assign colDef type if not specified
+ if (!colDef.type) {
+ var col = new GridColumn(colDef, index, self);
+ var firstRow = self.rows.length > 0 ? self.rows[0] : null;
+ if (firstRow) {
+ colDef.type = gridUtil.guessType(self.getCellValue(firstRow, col));
+ }
+ else {
+ colDef.type = 'string';
+ }
+ }
+ });
+ };
+
+
+ /**
+ * @ngdoc function
+ * @name isRowHeaderColumn
+ * @methodOf ui.grid.class:Grid
+ * @description returns true if the column is a row Header
+ * @param {object} column column
+ */
+ Grid.prototype.isRowHeaderColumn = function isRowHeaderColumn(column) {
+ return this.rowHeaderColumns.indexOf(column) !== -1;
+ };
+
+ /**
+ * @ngdoc function
+ * @name addRowHeaderColumn
+ * @methodOf ui.grid.class:Grid
+ * @description adds a row header column to the grid
+ * @param {object} colDef Column definition object.
+ * @param {float} order Number that indicates where the column should be placed in the grid.
+ * @param {boolean} stopColumnBuild Prevents the buildColumn callback from being triggered. This is useful to improve
+ * performance of the grid during initial load.
+ */
+ Grid.prototype.addRowHeaderColumn = function addRowHeaderColumn(colDef, order, stopColumnBuild) {
+ var self = this;
+
+ // default order
+ if (order === undefined) {
+ order = 0;
+ }
+
+ var rowHeaderCol = new GridColumn(colDef, gridUtil.nextUid(), self);
+ rowHeaderCol.isRowHeader = true;
+ if (self.isRTL()) {
+ self.createRightContainer();
+ rowHeaderCol.renderContainer = 'right';
+ }
+ else {
+ self.createLeftContainer();
+ rowHeaderCol.renderContainer = 'left';
+ }
+
+ // relies on the default column builder being first in array, as it is instantiated
+ // as part of grid creation
+ self.columnBuilders[0](colDef,rowHeaderCol,self.options)
+ .then(function() {
+ rowHeaderCol.enableFiltering = false;
+ rowHeaderCol.enableSorting = false;
+ rowHeaderCol.enableHiding = false;
+ rowHeaderCol.headerPriority = order;
+ self.rowHeaderColumns.push(rowHeaderCol);
+ self.rowHeaderColumns = self.rowHeaderColumns.sort(function (a, b) {
+ return a.headerPriority - b.headerPriority;
+ });
+
+ if (!stopColumnBuild) {
+ self.buildColumns()
+ .then(function() {
+ self.preCompileCellTemplates();
+ self.queueGridRefresh();
+ }).catch(angular.noop);
+ }
+ }).catch(angular.noop);
+ };
+
+ /**
+ * @ngdoc function
+ * @name getOnlyDataColumns
+ * @methodOf ui.grid.class:Grid
+ * @description returns all columns except for rowHeader columns
+ */
+ Grid.prototype.getOnlyDataColumns = function getOnlyDataColumns() {
+ var self = this,
+ cols = [];
+
+ self.columns.forEach(function (col) {
+ if (self.rowHeaderColumns.indexOf(col) === -1) {
+ cols.push(col);
+ }
+ });
+ return cols;
+ };
+
+ /**
+ * @ngdoc function
+ * @name buildColumns
+ * @methodOf ui.grid.class:Grid
+ * @description creates GridColumn objects from the columnDefinition. Calls each registered
+ * columnBuilder to further process the column
+ * @param {object} opts An object contains options to use when building columns
+ *
+ * * **orderByColumnDefs**: defaults to **false**. When true, `buildColumns` will reorder existing columns according to the order within the column definitions.
+ *
+ * @returns {Promise} a promise to load any needed column resources
+ */
+ Grid.prototype.buildColumns = function buildColumns(opts) {
+ var options = {
+ orderByColumnDefs: false
+ };
+
+ angular.extend(options, opts);
+
+ // gridUtil.logDebug('buildColumns');
+ var self = this;
+ var builderPromises = [];
+ var headerOffset = self.rowHeaderColumns.length;
+ var i;
+
+ // Remove any columns for which a columnDef cannot be found
+ // Deliberately don't use forEach, as it doesn't like splice being called in the middle
+ // Also don't cache columns.length, as it will change during this operation
+ for (i = 0; i < self.columns.length; i++) {
+ if (!self.getColDef(self.columns[i].name)) {
+ self.columns.splice(i, 1);
+ i--;
+ }
+ }
+
+ // add row header columns to the grid columns array _after_ columns without columnDefs have been removed
+ // rowHeaderColumns is ordered by priority so insert in reverse
+ for (var j = self.rowHeaderColumns.length - 1; j >= 0; j--) {
+ self.columns.unshift(self.rowHeaderColumns[j]);
+ }
+
+ // look at each column def, and update column properties to match. If the column def
+ // doesn't have a column, then splice in a new gridCol
+ self.options.columnDefs.forEach(function (colDef, index) {
+ self.preprocessColDef(colDef);
+ var col = self.getColumn(colDef.name);
+
+ if (!col) {
+ col = new GridColumn(colDef, gridUtil.nextUid(), self);
+ self.columns.splice(index + headerOffset, 0, col);
+ }
+ else {
+ // tell updateColumnDef that the column was pre-existing
+ col.updateColumnDef(colDef, false);
+ }
+
+ self.columnBuilders.forEach(function (builder) {
+ builderPromises.push(builder.call(self, colDef, col, self.options));
+ });
+ });
+
+ /*** Reorder columns if necessary ***/
+ if (!!options.orderByColumnDefs) {
+ // Create a shallow copy of the columns as a cache
+ var columnCache = self.columns.slice(0);
+
+ // We need to allow for the "row headers" when mapping from the column defs array to the columns array
+ // If we have a row header in columns[0] and don't account for it we'll overwrite it with the column in columnDefs[0]
+
+ // Go through all the column defs, use the shorter of columns length and colDefs.length because if a user has given two columns the same name then
+ // columns will be shorter than columnDefs. In this situation we'll avoid an error, but the user will still get an unexpected result
+ var len = Math.min(self.options.columnDefs.length, self.columns.length);
+ for (i = 0; i < len; i++) {
+ // If the column at this index has a different name than the column at the same index in the column defs...
+ if (self.columns[i + headerOffset].name !== self.options.columnDefs[i].name) {
+ // Replace the one in the cache with the appropriate column
+ columnCache[i + headerOffset] = self.getColumn(self.options.columnDefs[i].name);
+ }
+ else {
+ // Otherwise just copy over the one from the initial columns
+ columnCache[i + headerOffset] = self.columns[i + headerOffset];
+ }
+ }
+
+ // Empty out the columns array, non-destructively
+ self.columns.length = 0;
+
+ // And splice in the updated, ordered columns from the cache
+ Array.prototype.splice.apply(self.columns, [0, 0].concat(columnCache));
+ }
+
+ return $q.all(builderPromises).then(function() {
+ if (self.rows.length > 0) {
+ self.assignTypes();
+ }
+ if (options.preCompileCellTemplates) {
+ self.preCompileCellTemplates();
+ }
+ }).catch(angular.noop);
+ };
+
+ Grid.prototype.preCompileCellTemplate = function(col) {
+ var self = this;
+ var html = col.cellTemplate.replace(uiGridConstants.MODEL_COL_FIELD, self.getQualifiedColField(col));
+ html = html.replace(uiGridConstants.COL_FIELD, 'grid.getCellValue(row, col)');
+
+ col.compiledElementFn = $compile(html);
+
+ if (col.compiledElementFnDefer) {
+ col.compiledElementFnDefer.resolve(col.compiledElementFn);
+ }
+ };
+
+/**
+ * @ngdoc function
+ * @name preCompileCellTemplates
+ * @methodOf ui.grid.class:Grid
+ * @description precompiles all cell templates
+ */
+ Grid.prototype.preCompileCellTemplates = function() {
+ var self = this;
+ self.columns.forEach(function (col) {
+ if ( col.cellTemplate ) {
+ self.preCompileCellTemplate( col );
+ } else if ( col.cellTemplatePromise ) {
+ col.cellTemplatePromise.then( function() {
+ self.preCompileCellTemplate( col );
+ }).catch(angular.noop);
+ }
+ });
+ };
+
+ /**
+ * @ngdoc function
+ * @name getGridQualifiedColField
+ * @methodOf ui.grid.class:Grid
+ * @description Returns the $parse-able accessor for a column within its $scope
+ * @param {GridColumn} col col object
+ */
+ Grid.prototype.getQualifiedColField = function (col) {
+ var base = 'row.entity';
+ if ( col.field === uiGridConstants.ENTITY_BINDING ) {
+ return base;
+ }
+ return gridUtil.preEval(base + '.' + col.field);
+ };
+
+ /**
+ * @ngdoc function
+ * @name createLeftContainer
+ * @methodOf ui.grid.class:Grid
+ * @description creates the left render container if it doesn't already exist
+ */
+ Grid.prototype.createLeftContainer = function() {
+ if (!this.hasLeftContainer()) {
+ this.renderContainers.left = new GridRenderContainer('left', this, { disableColumnOffset: true });
+ }
+ };
+
+ /**
+ * @ngdoc function
+ * @name createRightContainer
+ * @methodOf ui.grid.class:Grid
+ * @description creates the right render container if it doesn't already exist
+ */
+ Grid.prototype.createRightContainer = function() {
+ if (!this.hasRightContainer()) {
+ this.renderContainers.right = new GridRenderContainer('right', this, { disableColumnOffset: true });
+ }
+ };
+
+ /**
+ * @ngdoc function
+ * @name hasLeftContainer
+ * @methodOf ui.grid.class:Grid
+ * @description returns true if leftContainer exists
+ */
+ Grid.prototype.hasLeftContainer = function() {
+ return this.renderContainers.left !== undefined;
+ };
+
+ /**
+ * @ngdoc function
+ * @name hasRightContainer
+ * @methodOf ui.grid.class:Grid
+ * @description returns true if rightContainer exists
+ */
+ Grid.prototype.hasRightContainer = function() {
+ return this.renderContainers.right !== undefined;
+ };
+
+
+ /**
+ * undocumented function
+ * @name preprocessColDef
+ * @methodOf ui.grid.class:Grid
+ * @description defaults the name property from field to maintain backwards compatibility with 2.x
+ * validates that name or field is present
+ */
+ Grid.prototype.preprocessColDef = function preprocessColDef(colDef) {
+ var self = this;
+
+ if (!colDef.field && !colDef.name) {
+ throw new Error('colDef.name or colDef.field property is required');
+ }
+
+ // maintain backwards compatibility with 2.x
+ // field was required in 2.x. now name is required
+ if (colDef.name === undefined && colDef.field !== undefined) {
+ // See if the column name already exists:
+ var newName = colDef.field,
+ counter = 2;
+ while (self.getColumn(newName)) {
+ newName = colDef.field + counter.toString();
+ counter++;
+ }
+ colDef.name = newName;
+ }
+ };
+
+ // Return a list of items that exist in the `n` array but not the `o` array. Uses optional property accessors passed as third & fourth parameters
+ Grid.prototype.newInN = function newInN(o, n, oAccessor, nAccessor) {
+ var self = this;
+
+ var t = [];
+ for (var i = 0; i < n.length; i++) {
+ var nV = nAccessor ? n[i][nAccessor] : n[i];
+
+ var found = false;
+ for (var j = 0; j < o.length; j++) {
+ var oV = oAccessor ? o[j][oAccessor] : o[j];
+ if (self.options.rowEquality(nV, oV)) {
+ found = true;
+ break;
+ }
+ }
+ if (!found) {
+ t.push(nV);
+ }
+ }
+
+ return t;
+ };
+
+ /**
+ * @ngdoc function
+ * @name getRow
+ * @methodOf ui.grid.class:Grid
+ * @description returns the GridRow that contains the rowEntity
+ * @param {object} rowEntity the gridOptions.data array element instance
+ * @param {array} lookInRows [optional] the rows to look in - if not provided then
+ * looks in grid.rows
+ */
+ Grid.prototype.getRow = function getRow(rowEntity, lookInRows) {
+ var self = this;
+
+ lookInRows = typeof(lookInRows) === 'undefined' ? self.rows : lookInRows;
+
+ var rows = lookInRows.filter(function (row) {
+ return self.options.rowEquality(row.entity, rowEntity);
+ });
+ return rows.length > 0 ? rows[0] : null;
+ };
+
+
+ /**
+ * @ngdoc function
+ * @name modifyRows
+ * @methodOf ui.grid.class:Grid
+ * @description creates or removes GridRow objects from the newRawData array. Calls each registered
+ * rowBuilder to further process the row
+ * @param {array} newRawData Modified set of data
+ *
+ * This method aims to achieve three things:
+ * 1. the resulting rows array is in the same order as the newRawData, we'll call
+ * rowsProcessors immediately after to sort the data anyway
+ * 2. if we have row hashing available, we try to use the rowHash to find the row
+ * 3. no memory leaks - rows that are no longer in newRawData need to be garbage collected
+ *
+ * The basic logic flow makes use of the newRawData, oldRows and oldHash, and creates
+ * the newRows and newHash
+ *
+ * ```
+ * newRawData.forEach newEntity
+ * if (hashing enabled)
+ * check oldHash for newEntity
+ * else
+ * look for old row directly in oldRows
+ * if !oldRowFound // must be a new row
+ * create newRow
+ * append to the newRows and add to newHash
+ * run the processors
+ * ```
+ *
+ * Rows are identified using the hashKey if configured. If not configured, then rows
+ * are identified using the gridOptions.rowEquality function
+ *
+ * This method is useful when trying to select rows immediately after loading data without
+ * using a $timeout/$interval, e.g.:
+ *
+ * $scope.gridOptions.data = someData;
+ * $scope.gridApi.grid.modifyRows($scope.gridOptions.data);
+ * $scope.gridApi.selection.selectRow($scope.gridOptions.data[0]);
+ *
+ * OR to persist row selection after data update (e.g. rows selected, new data loaded, want
+ * originally selected rows to be re-selected))
+ */
+ Grid.prototype.modifyRows = function modifyRows(newRawData) {
+ var self = this;
+ var oldRows = self.rows.slice(0);
+ var oldRowHash = self.rowHashMap || self.createRowHashMap();
+ var allRowsSelected = true;
+ self.rowHashMap = self.createRowHashMap();
+ self.rows.length = 0;
+
+ newRawData.forEach( function( newEntity, i ) {
+ var newRow, oldRow;
+
+ if ( self.options.enableRowHashing ) {
+ // if hashing is enabled, then this row will be in the hash if we already know about it
+ oldRow = oldRowHash.get( newEntity );
+ } else {
+ // otherwise, manually search the oldRows to see if we can find this row
+ oldRow = self.getRow(newEntity, oldRows);
+ }
+
+ // update newRow to have an entity
+ if ( oldRow ) {
+ newRow = oldRow;
+ newRow.entity = newEntity;
+ }
+
+ // if we didn't find the row, it must be new, so create it
+ if ( !newRow ) {
+ newRow = self.processRowBuilders(new GridRow(newEntity, i, self));
+ }
+
+ self.rows.push( newRow );
+ self.rowHashMap.put( newEntity, newRow );
+ if (!newRow.isSelected) {
+ allRowsSelected = false;
+ }
+ });
+
+ if (self.selection && self.rows.length) {
+ self.selection.selectAll = allRowsSelected;
+ }
+
+ self.assignTypes();
+
+ var p1 = $q.when(self.processRowsProcessors(self.rows))
+ .then(function (renderableRows) {
+ return self.setVisibleRows(renderableRows);
+ }).catch(angular.noop);
+
+ var p2 = $q.when(self.processColumnsProcessors(self.columns))
+ .then(function (renderableColumns) {
+ return self.setVisibleColumns(renderableColumns);
+ }).catch(angular.noop);
+
+ return $q.all([p1, p2]);
+ };
+
+
+ /**
+ * Private Undocumented Method
+ * @name addRows
+ * @methodOf ui.grid.class:Grid
+ * @description adds the newRawData array of rows to the grid and calls all registered
+ * rowBuilders. this keyword will reference the grid
+ */
+ Grid.prototype.addRows = function addRows(newRawData) {
+ var self = this,
+ existingRowCount = self.rows.length;
+
+ for (var i = 0; i < newRawData.length; i++) {
+ var newRow = self.processRowBuilders(new GridRow(newRawData[i], i + existingRowCount, self));
+
+ if (self.options.enableRowHashing) {
+ var found = self.rowHashMap.get(newRow.entity);
+ if (found) {
+ found.row = newRow;
+ }
+ }
+
+ self.rows.push(newRow);
+ }
+ };
+
+ /**
+ * @ngdoc function
+ * @name processRowBuilders
+ * @methodOf ui.grid.class:Grid
+ * @description processes all RowBuilders for the gridRow
+ * @param {GridRow} gridRow reference to gridRow
+ * @returns {GridRow} the gridRow with all additional behavior added
+ */
+ Grid.prototype.processRowBuilders = function processRowBuilders(gridRow) {
+ var self = this;
+
+ self.rowBuilders.forEach(function (builder) {
+ builder.call(self, gridRow, self.options);
+ });
+
+ return gridRow;
+ };
+
+ /**
+ * @ngdoc function
+ * @name registerStyleComputation
+ * @methodOf ui.grid.class:Grid
+ * @description registered a styleComputation function
+ *
+ * If the function returns a value it will be appended into the grid's `"
+ );
+
+
+ $templateCache.put('ui-grid/uiGridCell',
+ " {{COL_FIELD CUSTOM_FILTERS}} "
+ );
+
+
+ $templateCache.put('ui-grid/uiGridColumnMenu',
+ ""
+ );
+
+
+ $templateCache.put('ui-grid/uiGridFooterCell',
+ " {{ col.getAggregationText() + ( col.getAggregationValue() CUSTOM_FILTERS ) }} {{ col.displayName CUSTOM_FILTERS }} {{col.sort.priority + 1}} ')[0],r="reverse";return document.body.appendChild(t),0 \x3c!-- tfooter --\x3e '),e.put("ui-grid/ui-grid-grid-footer",'{{\'search.totalItems\' | t}} {{grid.rows.length}} ({{"search.showingItems" | t}} {{grid.renderContainers.body.visibleRowCache.length}}) '),e.put("ui-grid/ui-grid-header",'\x3c!-- theader --\x3e '),e.put("ui-grid/ui-grid-menu-button",'\x3c!-- TODO (c0bra): add "scoped" attr here, eventually? --\x3e '),e.put("ui-grid/uiGridCell",'{{COL_FIELD CUSTOM_FILTERS}} '),e.put("ui-grid/uiGridColumnMenu",'\x3c!-- \n --\x3e\n \n
\n \n {{ col.getAggregationText() + ( col.getAggregationValue() CUSTOM_FILTERS ) }} {{ col.displayName CUSTOM_FILTERS }} {{col.sort.priority + 1}} \x3c!-- All of these dom elements are replaced in place --\x3e "),e.put("ui-grid/uiGridViewport",'\x3c!-- tbody --\x3e ')}]);
\ No newline at end of file
diff --git a/release/4.9.2/i18n/ui-grid.edit.js b/release/4.9.2/i18n/ui-grid.edit.js
new file mode 100644
index 000000000..59383d962
--- /dev/null
+++ b/release/4.9.2/i18n/ui-grid.edit.js
@@ -0,0 +1,1324 @@
+/*!
+ * ui-grid - v4.9.2 - 2020-12-01
+ * Copyright (c) 2020 ; License: MIT
+ */
+
+(function () {
+ 'use strict';
+
+ /**
+ * @ngdoc overview
+ * @name ui.grid.edit
+ * @description
+ *
+ * # ui.grid.edit
+ *
+ * Stable This feature is stable. There should no longer be breaking api changes without a deprecation warning.
+ *
+ * This module provides cell editing capability to ui.grid. The goal was to emulate keying data in a spreadsheet via
+ * a keyboard.
+ * + * + * To really get the full spreadsheet-like data entry, the ui.grid.cellNav module should be used. This will allow the + * user to key data and then tab, arrow, or enter to the cells beside or below. + * + * + */ + + var module = angular.module('ui.grid.edit', ['ui.grid']); + + /** + * @ngdoc object + * @name ui.grid.edit.constant:uiGridEditConstants + * + * @description constants available in edit module + */ + module.constant('uiGridEditConstants', { + EDITABLE_CELL_TEMPLATE: /EDITABLE_CELL_TEMPLATE/g, + // must be lowercase because template bulder converts to lower + EDITABLE_CELL_DIRECTIVE: /editable_cell_directive/g, + events: { + BEGIN_CELL_EDIT: 'uiGridEventBeginCellEdit', + END_CELL_EDIT: 'uiGridEventEndCellEdit', + CANCEL_CELL_EDIT: 'uiGridEventCancelCellEdit' + } + }); + + /** + * @ngdoc service + * @name ui.grid.edit.service:uiGridEditService + * + * @description Services for editing features + */ + module.service('uiGridEditService', ['$q', 'uiGridConstants', 'gridUtil', + function ($q, uiGridConstants, gridUtil) { + + var service = { + + initializeGrid: function (grid) { + + service.defaultGridOptions(grid.options); + + grid.registerColumnBuilder(service.editColumnBuilder); + grid.edit = {}; + + /** + * @ngdoc object + * @name ui.grid.edit.api:PublicApi + * + * @description Public Api for edit feature + */ + var publicApi = { + events: { + edit: { + /** + * @ngdoc event + * @name afterCellEdit + * @eventOf ui.grid.edit.api:PublicApi + * @description raised when cell editing is complete + *
+ * gridApi.edit.on.afterCellEdit(scope,function(rowEntity, colDef) {})
+ *
+ * @param {object} rowEntity the options.data element that was edited
+ * @param {object} colDef the column that was edited
+ * @param {object} newValue new value
+ * @param {object} oldValue old value
+ */
+ afterCellEdit: function (rowEntity, colDef, newValue, oldValue) {
+ },
+ /**
+ * @ngdoc event
+ * @name beginCellEdit
+ * @eventOf ui.grid.edit.api:PublicApi
+ * @description raised when cell editing starts on a cell
+ *
+ * gridApi.edit.on.beginCellEdit(scope,function(rowEntity, colDef) {})
+ *
+ * @param {object} rowEntity the options.data element that was edited
+ * @param {object} colDef the column that was edited
+ * @param {object} triggerEvent the event that triggered the edit. Useful to prevent losing keystrokes on some
+ * complex editors
+ */
+ beginCellEdit: function (rowEntity, colDef, triggerEvent) {
+ },
+ /**
+ * @ngdoc event
+ * @name cancelCellEdit
+ * @eventOf ui.grid.edit.api:PublicApi
+ * @description raised when cell editing is cancelled on a cell
+ *
+ * gridApi.edit.on.cancelCellEdit(scope,function(rowEntity, colDef) {})
+ *
+ * @param {object} rowEntity the options.data element that was edited
+ * @param {object} colDef the column that was edited
+ */
+ cancelCellEdit: function (rowEntity, colDef) {
+ }
+ }
+ },
+ methods: {
+ edit: { }
+ }
+ };
+
+ grid.api.registerEventsFromObject(publicApi.events);
+ // grid.api.registerMethodsFromObject(publicApi.methods);
+ },
+
+ defaultGridOptions: function (gridOptions) {
+
+ /**
+ * @ngdoc object
+ * @name ui.grid.edit.api:GridOptions
+ *
+ * @description Options for configuring the edit feature, these are available to be
+ * set using the ui-grid {@link ui.grid.class:GridOptions gridOptions}
+ */
+
+ /**
+ * @ngdoc object
+ * @name enableCellEdit
+ * @propertyOf ui.grid.edit.api:GridOptions
+ * @description If defined, sets the default value for the editable flag on each individual colDefs
+ * if their individual enableCellEdit configuration is not defined. Defaults to undefined.
+ */
+
+ /**
+ * @ngdoc object
+ * @name cellEditableCondition
+ * @propertyOf ui.grid.edit.api:GridOptions
+ * @description If specified, either a value or function to be used by all columns before editing.
+ * If false, then editing of cell is not allowed.
+ * @example
+ *
+ * function($scope, triggerEvent) {
+ * //use $scope.row.entity, $scope.col.colDef and triggerEvent to determine if editing is allowed
+ * return true;
+ * }
+ *
+ */
+ gridOptions.cellEditableCondition = gridOptions.cellEditableCondition === undefined ? true : gridOptions.cellEditableCondition;
+
+ /**
+ * @ngdoc object
+ * @name editableCellTemplate
+ * @propertyOf ui.grid.edit.api:GridOptions
+ * @description If specified, cellTemplate to use as the editor for all columns.
+ * defaults to 'ui-grid/cellTextEditor' + */ + + /** + * @ngdoc object + * @name enableCellEditOnFocus + * @propertyOf ui.grid.edit.api:GridOptions + * @description If true, then editor is invoked as soon as cell receives focus. Default false. + * _requires cellNav feature and the edit feature to be enabled_ + */ + // enableCellEditOnFocus can only be used if cellnav module is used + gridOptions.enableCellEditOnFocus = gridOptions.enableCellEditOnFocus === undefined ? false : gridOptions.enableCellEditOnFocus; + }, + + /** + * @ngdoc service + * @name editColumnBuilder + * @methodOf ui.grid.edit.service:uiGridEditService + * @description columnBuilder function that adds edit properties to grid column + * @returns {promise} promise that will load any needed templates when resolved + */ + editColumnBuilder: function (colDef, col, gridOptions) { + + var promises = []; + + /** + * @ngdoc object + * @name ui.grid.edit.api:ColumnDef + * + * @description Column Definition for edit feature, these are available to be + * set using the ui-grid {@link ui.grid.class:GridOptions.columnDef gridOptions.columnDefs} + */ + + /** + * @ngdoc object + * @name enableCellEdit + * @propertyOf ui.grid.edit.api:ColumnDef + * @description enable editing on column + */ + colDef.enableCellEdit = colDef.enableCellEdit === undefined ? (gridOptions.enableCellEdit === undefined ? + (colDef.type !== 'object') : gridOptions.enableCellEdit) : colDef.enableCellEdit; + + /** + * @ngdoc object + * @name cellEditableCondition + * @propertyOf ui.grid.edit.api:ColumnDef + * @description If specified, either a value or function evaluated before editing cell. If falsy, then editing of cell is not allowed. + * @example + *
+ * function($scope, triggerEvent) {
+ * //use $scope.row.entity, $scope.col.colDef and triggerEvent to determine if editing is allowed
+ * return true;
+ * }
+ *
+ */
+ colDef.cellEditableCondition = colDef.cellEditableCondition === undefined ? gridOptions.cellEditableCondition : colDef.cellEditableCondition;
+
+ /**
+ * @ngdoc object
+ * @name editableCellTemplate
+ * @propertyOf ui.grid.edit.api:ColumnDef
+ * @description cell template to be used when editing this column. Can be Url or text template
+ * Defaults to gridOptions.editableCellTemplate + */ + if (colDef.enableCellEdit) { + colDef.editableCellTemplate = colDef.editableCellTemplate || gridOptions.editableCellTemplate || 'ui-grid/cellEditor'; + + promises.push(gridUtil.getTemplate(colDef.editableCellTemplate) + .then( + function (template) { + col.editableCellTemplate = template; + }, + function (res) { + // Todo handle response error here? + throw new Error("Couldn't fetch/use colDef.editableCellTemplate '" + colDef.editableCellTemplate + "'"); + })); + } + + /** + * @ngdoc object + * @name enableCellEditOnFocus + * @propertyOf ui.grid.edit.api:ColumnDef + * @requires ui.grid.cellNav + * @description If true, then editor is invoked as soon as cell receives focus. Default false. + * _requires both the cellNav feature and the edit feature to be enabled_ + */ + // enableCellEditOnFocus can only be used if cellnav module is used + colDef.enableCellEditOnFocus = colDef.enableCellEditOnFocus === undefined ? gridOptions.enableCellEditOnFocus : colDef.enableCellEditOnFocus; + + + /** + * @ngdoc string + * @name editModelField + * @propertyOf ui.grid.edit.api:ColumnDef + * @description a bindable string value that is used when binding to edit controls instead of colDef.field + * example: You have a complex property on and object like state:{abbrev: 'MS',name: 'Mississippi'}. The + * grid should display state.name in the cell and sort/filter based on the state.name property but the editor + * requires the full state object. + * colDef.field = 'state.name' + * colDef.editModelField = 'state' + */ + // colDef.editModelField + + return $q.all(promises); + }, + + /** + * @ngdoc service + * @name isStartEditKey + * @methodOf ui.grid.edit.service:uiGridEditService + * @description Determines if a keypress should start editing. Decorate this service to override with your + * own key events. See service decorator in angular docs. + * @param {Event} evt keydown event + * @returns {boolean} true if an edit should start + */ + isStartEditKey: function (evt) { + return !(evt.metaKey || + evt.keyCode === uiGridConstants.keymap.ESC || + evt.keyCode === uiGridConstants.keymap.SHIFT || + evt.keyCode === uiGridConstants.keymap.CTRL || + evt.keyCode === uiGridConstants.keymap.ALT || + evt.keyCode === uiGridConstants.keymap.WIN || + evt.keyCode === uiGridConstants.keymap.CAPSLOCK || + + evt.keyCode === uiGridConstants.keymap.LEFT || + (evt.keyCode === uiGridConstants.keymap.TAB && evt.shiftKey) || + + evt.keyCode === uiGridConstants.keymap.RIGHT || + evt.keyCode === uiGridConstants.keymap.TAB || + + evt.keyCode === uiGridConstants.keymap.UP || + (evt.keyCode === uiGridConstants.keymap.ENTER && evt.shiftKey) || + + evt.keyCode === uiGridConstants.keymap.DOWN || + evt.keyCode === uiGridConstants.keymap.ENTER); + } + }; + + return service; + + }]); + + /** + * @ngdoc directive + * @name ui.grid.edit.directive:uiGridEdit + * @element div + * @restrict A + * + * @description Adds editing features to the ui-grid directive. + * + * @example +
+
+
+
+ * $scope.gridOptions = {
+ * columnDefs: [
+ * {name: 'status', editableCellTemplate: 'ui-grid/dropdownEditor',
+ * editDropdownOptionsArray: [{code: 1, status: 'active'}, {code: 2, status: 'inactive'}],
+ * editDropdownIdLabel: 'code', editDropdownValueLabel: 'status' }
+ * ],
+ *
+ *
+ */
+ /**
+ * @ngdoc property
+ * @name editDropdownRowEntityOptionsArrayPath
+ * @propertyOf ui.grid.edit.api:ColumnDef
+ * @description a path to a property on row.entity containing an
+ * array of values in the format
+ * [ {id: xxx, value: xxx} ], which will be used to populate
+ * the edit dropdown. This can be used when the dropdown values are dependent on
+ * the backing row entity.
+ * If this property is set then editDropdownOptionsArray will be ignored.
+ * @example
+ *
+ * $scope.gridOptions = {
+ * columnDefs: [
+ * {name: 'status', editableCellTemplate: 'ui-grid/dropdownEditor',
+ * editDropdownRowEntityOptionsArrayPath: 'foo.bars[0].baz',
+ * editDropdownIdLabel: 'code', editDropdownValueLabel: 'status' }
+ * ],
+ *
+ *
+ */
+ /**
+ * @ngdoc service
+ * @name editDropdownOptionsFunction
+ * @methodOf ui.grid.edit.api:ColumnDef
+ * @description a function returning an array of values in the format
+ * [ {id: xxx, value: xxx} ], which will be used to populate
+ * the edit dropdown. This can be used when the dropdown values are dependent on
+ * the backing row entity with some kind of algorithm.
+ * If this property is set then both editDropdownOptionsArray and
+ * editDropdownRowEntityOptionsArrayPath will be ignored.
+ * @param {object} rowEntity the options.data element that the returned array refers to
+ * @param {object} colDef the column that implements this dropdown
+ * @returns {object} an array of values in the format
+ * [ {id: xxx, value: xxx} ] used to populate the edit dropdown
+ * @example
+ *
+ * $scope.gridOptions = {
+ * columnDefs: [
+ * {name: 'status', editableCellTemplate: 'ui-grid/dropdownEditor',
+ * editDropdownOptionsFunction: function(rowEntity, colDef) {
+ * if (rowEntity.foo === 'bar') {
+ * return [{id: 'bar1', value: 'BAR 1'},
+ * {id: 'bar2', value: 'BAR 2'},
+ * {id: 'bar3', value: 'BAR 3'}];
+ * } else {
+ * return [{id: 'foo1', value: 'FOO 1'},
+ * {id: 'foo2', value: 'FOO 2'}];
+ * }
+ * },
+ * editDropdownIdLabel: 'code', editDropdownValueLabel: 'status' }
+ * ],
+ *
+ *
+ */
+ /**
+ * @ngdoc property
+ * @name editDropdownValueLabel
+ * @propertyOf ui.grid.edit.api:ColumnDef
+ * @description the label for the "value" field
+ * in the editDropdownOptionsArray. Defaults
+ * to 'value'
+ * @example
+ *
+ * $scope.gridOptions = {
+ * columnDefs: [
+ * {name: 'status', editableCellTemplate: 'ui-grid/dropdownEditor',
+ * editDropdownOptionsArray: [{code: 1, status: 'active'}, {code: 2, status: 'inactive'}],
+ * editDropdownIdLabel: 'code', editDropdownValueLabel: 'status' }
+ * ],
+ *
+ *
+ */
+ /**
+ * @ngdoc property
+ * @name editDropdownFilter
+ * @propertyOf ui.grid.edit.api:ColumnDef
+ * @description A filter that you would like to apply to the values in the options list
+ * of the dropdown. For example if you were using angular-translate you might set this
+ * to `'translate'`
+ * @example
+ *
+ * $scope.gridOptions = {
+ * columnDefs: [
+ * {name: 'status', editableCellTemplate: 'ui-grid/dropdownEditor',
+ * editDropdownOptionsArray: [{code: 1, status: 'active'}, {code: 2, status: 'inactive'}],
+ * editDropdownIdLabel: 'code', editDropdownValueLabel: 'status', editDropdownFilter: 'translate' }
+ * ],
+ *
+ *
+ */
+ function beginEditAfterScroll(triggerEvent) {
+ // If we are already editing, then just skip this so we don't try editing twice...
+ if (inEdit) {
+ return;
+ }
+
+ if (!shouldEdit($scope.col, $scope.row, triggerEvent)) {
+ return;
+ }
+
+ var modelField = $scope.row.getQualifiedColField($scope.col);
+ if ($scope.col.colDef.editModelField) {
+ modelField = gridUtil.preEval('row.entity.' + $scope.col.colDef.editModelField);
+ }
+
+ cellModel = $parse(modelField);
+
+ // get original value from the cell
+ origCellValue = cellModel($scope);
+
+ html = $scope.col.editableCellTemplate;
+ html = html.replace(uiGridConstants.MODEL_COL_FIELD, modelField);
+ html = html.replace(uiGridConstants.COL_FIELD, 'grid.getCellValue(row, col)');
+
+ var optionFilter = $scope.col.colDef.editDropdownFilter ? '|' + $scope.col.colDef.editDropdownFilter : '';
+ html = html.replace(uiGridConstants.CUSTOM_FILTERS, optionFilter);
+
+ var inputType = 'text';
+ switch ($scope.col.colDef.type) {
+ case 'boolean':
+ inputType = 'checkbox';
+ break;
+ case 'number':
+ inputType = 'number';
+ break;
+ case 'date':
+ inputType = 'date';
+ break;
+ }
+ html = html.replace('INPUT_TYPE', inputType);
+
+ // In order to fill dropdown options we use:
+ // - A function/promise or
+ // - An array inside of row entity if no function exists or
+ // - A single array for the whole column if none of the previous exists.
+ var editDropdownOptionsFunction = $scope.col.colDef.editDropdownOptionsFunction;
+ if (editDropdownOptionsFunction) {
+ $q.when(editDropdownOptionsFunction($scope.row.entity, $scope.col.colDef))
+ .then(function(result) {
+ $scope.editDropdownOptionsArray = result;
+ });
+ } else {
+ var editDropdownRowEntityOptionsArrayPath = $scope.col.colDef.editDropdownRowEntityOptionsArrayPath;
+ if (editDropdownRowEntityOptionsArrayPath) {
+ $scope.editDropdownOptionsArray = resolveObjectFromPath($scope.row.entity, editDropdownRowEntityOptionsArrayPath);
+ }
+ else {
+ $scope.editDropdownOptionsArray = $scope.col.colDef.editDropdownOptionsArray;
+ }
+ }
+ $scope.editDropdownIdLabel = $scope.col.colDef.editDropdownIdLabel ? $scope.col.colDef.editDropdownIdLabel : 'id';
+ $scope.editDropdownValueLabel = $scope.col.colDef.editDropdownValueLabel ? $scope.col.colDef.editDropdownValueLabel : 'value';
+
+ var createEditor = function() {
+ inEdit = true;
+ cancelBeginEditEvents();
+ var cellElement = angular.element(html);
+ $elm.append(cellElement);
+ editCellScope = $scope.$new();
+ $compile(cellElement)(editCellScope);
+ var gridCellContentsEl = angular.element($elm.children()[0]);
+ gridCellContentsEl.addClass('ui-grid-cell-contents-hidden');
+ };
+ if (!$rootScope.$$phase) {
+ $scope.$apply(createEditor);
+ } else {
+ createEditor();
+ }
+
+ // stop editing when grid is scrolled
+ var deregOnGridScroll = $scope.col.grid.api.core.on.scrollBegin($scope, function () {
+ if ($scope.grid.disableScrolling) {
+ return;
+ }
+ endEdit();
+ $scope.grid.api.edit.raise.afterCellEdit($scope.row.entity, $scope.col.colDef, cellModel($scope), origCellValue);
+ deregOnGridScroll();
+ deregOnEndCellEdit();
+ deregOnCancelCellEdit();
+ });
+
+ // end editing
+ var deregOnEndCellEdit = $scope.$on(uiGridEditConstants.events.END_CELL_EDIT, function () {
+ endEdit();
+ $scope.grid.api.edit.raise.afterCellEdit($scope.row.entity, $scope.col.colDef, cellModel($scope), origCellValue);
+ deregOnEndCellEdit();
+ deregOnGridScroll();
+ deregOnCancelCellEdit();
+ });
+
+ // cancel editing
+ var deregOnCancelCellEdit = $scope.$on(uiGridEditConstants.events.CANCEL_CELL_EDIT, function () {
+ cancelEdit();
+ deregOnCancelCellEdit();
+ deregOnGridScroll();
+ deregOnEndCellEdit();
+ });
+
+ $scope.$broadcast(uiGridEditConstants.events.BEGIN_CELL_EDIT, triggerEvent);
+ $timeout(function () {
+ // execute in a timeout to give any complex editor templates a cycle to completely render
+ $scope.grid.api.edit.raise.beginCellEdit($scope.row.entity, $scope.col.colDef, triggerEvent);
+ });
+ }
+
+ function endEdit() {
+ $scope.grid.disableScrolling = false;
+ if (!inEdit) {
+ return;
+ }
+
+ // sometimes the events can't keep up with the keyboard and grid focus is lost, so always focus
+ // back to grid here. The focus call needs to be before the $destroy and removal of the control,
+ // otherwise ng-model-options of UpdateOn: 'blur' will not work.
+ if (uiGridCtrl && uiGridCtrl.grid.api.cellNav) {
+ uiGridCtrl.focus();
+ }
+
+ var gridCellContentsEl = angular.element($elm.children()[0]);
+ // remove edit element
+ editCellScope.$destroy();
+ var children = $elm.children();
+ for (var i = 1; i < children.length; i++) {
+ angular.element(children[i]).remove();
+ }
+ gridCellContentsEl.removeClass('ui-grid-cell-contents-hidden');
+ inEdit = false;
+ registerBeginEditEvents();
+ $scope.grid.api.core.notifyDataChange( uiGridConstants.dataChange.EDIT );
+ }
+
+ function cancelEdit() {
+ $scope.grid.disableScrolling = false;
+ if (!inEdit) {
+ return;
+ }
+ cellModel.assign($scope, origCellValue);
+ $scope.$apply();
+
+ $scope.grid.api.edit.raise.cancelCellEdit($scope.row.entity, $scope.col.colDef);
+ endEdit();
+ }
+
+ // resolves a string path against the given object
+ // shamelessly borrowed from
+ // http://stackoverflow.com/questions/6491463/accessing-nested-javascript-objects-with-string-key
+ function resolveObjectFromPath(object, path) {
+ path = path.replace(/\[(\w+)\]/g, '.$1'); // convert indexes to properties
+ path = path.replace(/^\./, ''); // strip a leading dot
+ var a = path.split('.');
+ while (a.length) {
+ var n = a.shift();
+ if (n in object) {
+ object = object[n];
+ } else {
+ return;
+ }
+ }
+ return object;
+ }
+ }
+ };
+ }]);
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.edit.directive:uiGridEditor
+ * @element div
+ * @restrict A
+ *
+ * @description input editor directive for editable fields.
+ * Provides EndEdit and CancelEdit events
+ *
+ * Events that end editing:
+ * blur and enter keydown
+ *
+ * Events that cancel editing:
+ * - Esc keydown
+ *
+ */
+ module.directive('uiGridEditor',
+ ['gridUtil', 'uiGridConstants', 'uiGridEditConstants','$timeout', 'uiGridEditService',
+ function (gridUtil, uiGridConstants, uiGridEditConstants, $timeout, uiGridEditService) {
+ return {
+ scope: true,
+ require: ['?^uiGrid', '?^uiGridRenderContainer', 'ngModel'],
+ compile: function () {
+ return {
+ pre: function ($scope, $elm, $attrs) {
+
+ },
+ post: function ($scope, $elm, $attrs, controllers) {
+ var uiGridCtrl, renderContainerCtrl, ngModel;
+ if (controllers[0]) { uiGridCtrl = controllers[0]; }
+ if (controllers[1]) { renderContainerCtrl = controllers[1]; }
+ if (controllers[2]) { ngModel = controllers[2]; }
+
+ // set focus at start of edit
+ $scope.$on(uiGridEditConstants.events.BEGIN_CELL_EDIT, function () {
+ // must be in a timeout since it requires a new digest cycle
+ $timeout(function () {
+ $elm[0].focus();
+ // only select text if it is not being replaced below in the cellNav viewPortKeyPress
+ if ($elm[0].select && ($scope.col.colDef.enableCellEditOnFocus || !(uiGridCtrl && uiGridCtrl.grid.api.cellNav))) {
+ $elm[0].select();
+ }
+ else {
+ // some browsers (Chrome) stupidly, imo, support the w3 standard that number, email, ...
+ // fields should not allow setSelectionRange. We ignore the error for those browsers
+ // https://www.w3.org/Bugs/Public/show_bug.cgi?id=24796
+ try {
+ $elm[0].setSelectionRange($elm[0].value.length, $elm[0].value.length);
+ }
+ catch (ex) {
+ // ignore
+ }
+ }
+ });
+
+ // set the keystroke that started the edit event
+ // we must do this because the BeginEdit is done in a different event loop than the intitial
+ // keydown event
+ // fire this event for the keypress that is received
+ if (uiGridCtrl && uiGridCtrl.grid.api.cellNav) {
+ var viewPortKeyDownUnregister = uiGridCtrl.grid.api.cellNav.on.viewPortKeyPress($scope, function (evt, rowCol) {
+ if (uiGridEditService.isStartEditKey(evt)) {
+ var code = typeof evt.which === 'number' ? evt.which : evt.keyCode;
+ if (code > 0) {
+ ngModel.$setViewValue(String.fromCharCode(code), evt);
+ ngModel.$render();
+ }
+ }
+ viewPortKeyDownUnregister();
+ });
+ }
+
+ // macOS will blur the checkbox when clicked in Safari and Firefox,
+ // to get around this, we disable the blur handler on mousedown,
+ // and then focus the checkbox and re-enable the blur handler after $timeout
+ $elm.on('mousedown', function(evt) {
+ if ($elm[0].type === 'checkbox') {
+ $elm.off('blur', $scope.stopEdit);
+ $timeout(function() {
+ $elm[0].focus();
+ $elm.on('blur', $scope.stopEdit);
+ });
+ }
+ });
+
+ if ($elm[0]) {
+ $elm[0].focus();
+ }
+ $elm.on('blur', $scope.stopEdit);
+ });
+
+
+ $scope.deepEdit = false;
+
+ $scope.stopEdit = function (evt) {
+ if ($scope.inputForm && !$scope.inputForm.$valid) {
+ evt.stopPropagation();
+ $scope.$emit(uiGridEditConstants.events.CANCEL_CELL_EDIT);
+ }
+ else {
+ $scope.$emit(uiGridEditConstants.events.END_CELL_EDIT);
+ }
+ $scope.deepEdit = false;
+ };
+
+
+ $elm.on('click', function (evt) {
+ if ($elm[0].type !== 'checkbox') {
+ $scope.deepEdit = true;
+ $scope.$applyAsync(function () {
+ $scope.grid.disableScrolling = true;
+ });
+ }
+ });
+
+ $elm.on('keydown', function (evt) {
+ switch (evt.keyCode) {
+ case uiGridConstants.keymap.ESC:
+ evt.stopPropagation();
+ $scope.$emit(uiGridEditConstants.events.CANCEL_CELL_EDIT);
+ break;
+ }
+
+ if ($scope.deepEdit &&
+ (evt.keyCode === uiGridConstants.keymap.LEFT ||
+ evt.keyCode === uiGridConstants.keymap.RIGHT ||
+ evt.keyCode === uiGridConstants.keymap.UP ||
+ evt.keyCode === uiGridConstants.keymap.DOWN)) {
+ evt.stopPropagation();
+ }
+ // Pass the keydown event off to the cellNav service, if it exists
+ else if (uiGridCtrl && uiGridCtrl.grid.api.cellNav) {
+ evt.uiGridTargetRenderContainerId = renderContainerCtrl.containerId;
+ if (uiGridCtrl.cellNav.handleKeyDown(evt) !== null) {
+ $scope.stopEdit(evt);
+ }
+ }
+ else {
+ // handle enter and tab for editing not using cellNav
+ switch (evt.keyCode) {
+ case uiGridConstants.keymap.ENTER: // Enter (Leave Field)
+ case uiGridConstants.keymap.TAB:
+ evt.stopPropagation();
+ evt.preventDefault();
+ $scope.stopEdit(evt);
+ break;
+ }
+ }
+
+ return true;
+ });
+
+ $scope.$on('$destroy', function unbindEvents() {
+ // unbind all jquery events in order to avoid memory leaks
+ $elm.off();
+ });
+ }
+ };
+ }
+ };
+ }]);
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.edit.directive:input
+ * @element input
+ * @restrict E
+ *
+ * @description directive to provide binding between input[date] value and ng-model for angular 1.2
+ * It is similar to input[date] directive of angular 1.3
+ *
+ * Supported date format for input is 'yyyy-MM-dd'
+ * The directive will set the $valid property of input element and the enclosing form to false if
+ * model is invalid date or value of input is entered wrong.
+ *
+ */
+ module.directive('uiGridEditor', ['$filter', function ($filter) {
+ function parseDateString(dateString) {
+ if (typeof(dateString) === 'undefined' || dateString === '') {
+ return null;
+ }
+ var parts = dateString.split('-');
+ if (parts.length !== 3) {
+ return null;
+ }
+ var year = parseInt(parts[0], 10);
+ var month = parseInt(parts[1], 10);
+ var day = parseInt(parts[2], 10);
+
+ if (month < 1 || year < 1 || day < 1) {
+ return null;
+ }
+ return new Date(year, (month - 1), day);
+ }
+ return {
+ priority: -100, // run after default uiGridEditor directive
+ require: '?ngModel',
+ link: function (scope, element, attrs, ngModel) {
+ if (angular.version.minor === 2 && attrs.type && attrs.type === 'date' && ngModel) {
+ ngModel.$formatters.push(function (modelValue) {
+ ngModel.$setValidity(null,(!modelValue || !isNaN(modelValue.getTime())));
+ return $filter('date')(modelValue, 'yyyy-MM-dd');
+ });
+
+ ngModel.$parsers.push(function (viewValue) {
+ if (viewValue && viewValue.length > 0) {
+ var dateValue = parseDateString(viewValue);
+ ngModel.$setValidity(null, (dateValue && !isNaN(dateValue.getTime())));
+ return dateValue;
+ }
+ else {
+ ngModel.$setValidity(null, true);
+ return null;
+ }
+ });
+ }
+ }
+ };
+ }]);
+
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.edit.directive:uiGridEditDropdown
+ * @element div
+ * @restrict A
+ *
+ * @description dropdown editor for editable fields.
+ * Provides EndEdit and CancelEdit events
+ *
+ * Events that end editing:
+ * blur and enter keydown, and any left/right nav
+ *
+ * Events that cancel editing:
+ * - Esc keydown
+ *
+ */
+ module.directive('uiGridEditDropdown',
+ ['uiGridConstants', 'uiGridEditConstants', '$timeout',
+ function (uiGridConstants, uiGridEditConstants, $timeout) {
+ return {
+ require: ['?^uiGrid', '?^uiGridRenderContainer'],
+ scope: true,
+ compile: function () {
+ return {
+ pre: function ($scope, $elm, $attrs) {
+
+ },
+ post: function ($scope, $elm, $attrs, controllers) {
+ var uiGridCtrl = controllers[0];
+ var renderContainerCtrl = controllers[1];
+
+ // set focus at start of edit
+ $scope.$on(uiGridEditConstants.events.BEGIN_CELL_EDIT, function () {
+ $timeout(function() {
+ $elm[0].focus();
+ });
+
+ $elm[0].style.width = ($elm[0].parentElement.offsetWidth - 1) + 'px';
+ $elm.on('blur', function (evt) {
+ $scope.stopEdit(evt);
+ });
+ });
+
+
+ $scope.stopEdit = function (evt) {
+ // no need to validate a dropdown - invalid values shouldn't be
+ // available in the list
+ $scope.$emit(uiGridEditConstants.events.END_CELL_EDIT);
+ };
+
+ $elm.on('keydown', function (evt) {
+ switch (evt.keyCode) {
+ case uiGridConstants.keymap.ESC:
+ evt.stopPropagation();
+ $scope.$emit(uiGridEditConstants.events.CANCEL_CELL_EDIT);
+ break;
+ }
+ if (uiGridCtrl && uiGridCtrl.grid.api.cellNav) {
+ evt.uiGridTargetRenderContainerId = renderContainerCtrl.containerId;
+ if (uiGridCtrl.cellNav.handleKeyDown(evt) !== null) {
+ $scope.stopEdit(evt);
+ }
+ }
+ else {
+ // handle enter and tab for editing not using cellNav
+ switch (evt.keyCode) {
+ case uiGridConstants.keymap.ENTER: // Enter (Leave Field)
+ case uiGridConstants.keymap.TAB:
+ evt.stopPropagation();
+ evt.preventDefault();
+ $scope.stopEdit(evt);
+ break;
+ }
+ }
+ return true;
+ });
+
+ $scope.$on('$destroy', function unbindEvents() {
+ // unbind jquery events to prevent memory leaks
+ $elm.off();
+ });
+ }
+ };
+ }
+ };
+ }]);
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.edit.directive:uiGridEditFileChooser
+ * @element div
+ * @restrict A
+ *
+ * @description input editor directive for editable fields.
+ * Provides EndEdit and CancelEdit events
+ *
+ * Events that end editing:
+ * blur and enter keydown
+ *
+ * Events that cancel editing:
+ * - Esc keydown
+ *
+ */
+ module.directive('uiGridEditFileChooser',
+ ['gridUtil', 'uiGridConstants', 'uiGridEditConstants',
+ function (gridUtil, uiGridConstants, uiGridEditConstants) {
+ return {
+ scope: true,
+ require: ['?^uiGrid', '?^uiGridRenderContainer'],
+ compile: function () {
+ return {
+ pre: function ($scope, $elm, $attrs) {
+
+ },
+ post: function ($scope, $elm) {
+ function handleFileSelect(event) {
+ var target = event.srcElement || event.target;
+
+ if (target && target.files && target.files.length > 0) {
+ /**
+ * @ngdoc property
+ * @name editFileChooserCallback
+ * @propertyOf ui.grid.edit.api:ColumnDef
+ * @description A function that should be called when any files have been chosen
+ * by the user. You should use this to process the files appropriately for your
+ * application.
+ *
+ * It passes the gridCol, the gridRow (from which you can get gridRow.entity),
+ * and the files. The files are in the format as returned from the file chooser,
+ * an array of files, with each having useful information such as:
+ * - `files[0].lastModifiedDate`
+ * - `files[0].name`
+ * - `files[0].size` (appears to be in bytes)
+ * - `files[0].type` (MIME type by the looks)
+ *
+ * Typically you would do something with these files - most commonly you would
+ * use the filename or read the file itself in. The example function does both.
+ *
+ * @example
+ *
+ * editFileChooserCallBack: function(gridRow, gridCol, files ) {
+ * // ignore all but the first file, it can only choose one anyway
+ * // set the filename into this column
+ * gridRow.entity.filename = file[0].name;
+ *
+ * // read the file and set it into a hidden column, which we may do stuff with later
+ * var setFile = function(fileContent) {
+ * gridRow.entity.file = fileContent.currentTarget.result;
+ * };
+ * var reader = new FileReader();
+ * reader.onload = setFile;
+ * reader.readAsText( files[0] );
+ * }
+ *
+ */
+ if ( typeof($scope.col.colDef.editFileChooserCallback) === 'function' ) {
+ $scope.col.colDef.editFileChooserCallback($scope.row, $scope.col, target.files);
+ } else {
+ gridUtil.logError('You need to set colDef.editFileChooserCallback to use the file chooser');
+ }
+
+ target.form.reset();
+ $scope.$emit(uiGridEditConstants.events.END_CELL_EDIT);
+ } else {
+ $scope.$emit(uiGridEditConstants.events.CANCEL_CELL_EDIT);
+ }
+ $elm[0].removeEventListener('change', handleFileSelect, false);
+ }
+
+ $elm[0].addEventListener('change', handleFileSelect, false);
+
+ $scope.$on(uiGridEditConstants.events.BEGIN_CELL_EDIT, function () {
+ $elm[0].focus();
+ $elm[0].select();
+
+ $elm.on('blur', function () {
+ $scope.$emit(uiGridEditConstants.events.END_CELL_EDIT);
+ $elm.off();
+ });
+ });
+ }
+ };
+ }
+ };
+ }]);
+})();
+
+angular.module('ui.grid.edit').run(['$templateCache', function($templateCache) {
+ 'use strict';
+
+ $templateCache.put('ui-grid/cellEditor',
+ ""
+ );
+
+
+ $templateCache.put('ui-grid/dropdownEditor',
+ ""
+ );
+
+
+ $templateCache.put('ui-grid/fileChooserEditor',
+ ""
+ );
+
+}]);
diff --git a/release/4.9.2/i18n/ui-grid.edit.min.js b/release/4.9.2/i18n/ui-grid.edit.min.js
new file mode 100644
index 000000000..7ebac9fab
--- /dev/null
+++ b/release/4.9.2/i18n/ui-grid.edit.min.js
@@ -0,0 +1,7 @@
+/*!
+ * ui-grid - v4.9.2 - 2020-12-01
+ * Copyright (c) 2020 ; License: MIT
+ */
+
+
+!function(){"use strict";var e=angular.module("ui.grid.edit",["ui.grid"]);e.constant("uiGridEditConstants",{EDITABLE_CELL_TEMPLATE:/EDITABLE_CELL_TEMPLATE/g,EDITABLE_CELL_DIRECTIVE:/editable_cell_directive/g,events:{BEGIN_CELL_EDIT:"uiGridEventBeginCellEdit",END_CELL_EDIT:"uiGridEventEndCellEdit",CANCEL_CELL_EDIT:"uiGridEventCancelCellEdit"}}),e.service("uiGridEditService",["$q","uiGridConstants","gridUtil",function(o,i,l){var t={initializeGrid:function(e){t.defaultGridOptions(e.options),e.registerColumnBuilder(t.editColumnBuilder),e.edit={};e.api.registerEventsFromObject({edit:{afterCellEdit:function(e,i,t,n){},beginCellEdit:function(e,i,t){},cancelCellEdit:function(e,i){}}})},defaultGridOptions:function(e){e.cellEditableCondition=void 0===e.cellEditableCondition||e.cellEditableCondition,e.enableCellEditOnFocus=void 0!==e.enableCellEditOnFocus&&e.enableCellEditOnFocus},editColumnBuilder:function(i,t,e){var n=[];return i.enableCellEdit=void 0===i.enableCellEdit?void 0===e.enableCellEdit?"object"!==i.type:e.enableCellEdit:i.enableCellEdit,i.cellEditableCondition=void 0===i.cellEditableCondition?e.cellEditableCondition:i.cellEditableCondition,i.enableCellEdit&&(i.editableCellTemplate=i.editableCellTemplate||e.editableCellTemplate||"ui-grid/cellEditor",n.push(l.getTemplate(i.editableCellTemplate).then(function(e){t.editableCellTemplate=e},function(e){throw new Error("Couldn't fetch/use colDef.editableCellTemplate '"+i.editableCellTemplate+"'")}))),i.enableCellEditOnFocus=void 0===i.enableCellEditOnFocus?e.enableCellEditOnFocus:i.enableCellEditOnFocus,o.all(n)},isStartEditKey:function(e){return!(e.metaKey||e.keyCode===i.keymap.ESC||e.keyCode===i.keymap.SHIFT||e.keyCode===i.keymap.CTRL||e.keyCode===i.keymap.ALT||e.keyCode===i.keymap.WIN||e.keyCode===i.keymap.CAPSLOCK||e.keyCode===i.keymap.LEFT||e.keyCode===i.keymap.TAB&&e.shiftKey||e.keyCode===i.keymap.RIGHT||e.keyCode===i.keymap.TAB||e.keyCode===i.keymap.UP||e.keyCode===i.keymap.ENTER&&e.shiftKey||e.keyCode===i.keymap.DOWN||e.keyCode===i.keymap.ENTER)}};return t}]),e.directive("uiGridEdit",["gridUtil","uiGridEditService",function(e,o){return{replace:!0,priority:0,require:"^uiGrid",scope:!1,compile:function(){return{pre:function(e,i,t,n){o.initializeGrid(n.grid)},post:function(e,i,t,n){}}}}}]),e.directive("uiGridViewport",["uiGridEditConstants",function(l){return{replace:!0,priority:-99998,require:["^uiGrid","^uiGridRenderContainer"],scope:!1,compile:function(){return{post:function(e,i,t,n){var o=n[0];o.grid.api.edit&&o.grid.api.cellNav&&("body"===n[1].containerId&&(e.$on(l.events.CANCEL_CELL_EDIT,function(){o.focus()}),e.$on(l.events.END_CELL_EDIT,function(){o.focus()})))}}}}}]),e.directive("uiGridCell",["$compile","$injector","$timeout","uiGridConstants","uiGridEditConstants","gridUtil","$parse","uiGridEditService","$rootScope","$q",function(b,e,h,T,k,w,_,f,I,G){if(e.has("uiGridCellNavService"))e.get("uiGridCellNavService");return{priority:-100,restrict:"A",scope:!1,require:"?^uiGrid",link:function(E,p,e,n){var C,v,g,i,y,m=!1;if(E.col.colDef.enableCellEdit){var t=function(){},o=function(){},l=function(){E.col.colDef.enableCellEdit&&!1!==E.row.enableCellEdit?E.beginEditEventsWired||d():E.beginEditEventsWired&&D()};l();var r=E.$watch("row",function(e,i){e!==i&&l()});E.$on("$destroy",function(){r(),p.off()})}function d(){p.on("dblclick",s),p.on("touchstart",c),n&&n.grid.api.cellNav&&(o=n.grid.api.cellNav.on.viewPortKeyDown(E,function(e,i){null!==i&&(i.row!==E.row||i.col!==E.col||E.col.colDef.enableCellEditOnFocus||u(e))}),t=n.grid.api.cellNav.on.navigate(E,function(e,i,t){E.col.colDef.enableCellEditOnFocus&&(e.row!==E.row||e.col!==E.col||null!==t&&(!t||"click"!==t.type&&"keydown"!==t.type)||h(function(){s(t)}))})),E.beginEditEventsWired=!0}function c(e){void 0!==e.originalEvent&&void 0!==e.originalEvent&&(e=e.originalEvent),p.on("touchend",a),(i=h(function(){},500)).then(function(){setTimeout(s,0),p.off("touchend",a)}).catch(angular.noop)}function a(){h.cancel(i),p.off("touchend",a)}function D(){p.off("dblclick",s),p.off("keydown",u),p.off("touchstart",c),t(),o(),E.beginEditEventsWired=!1}function u(e){f.isStartEditKey(e)&&s(e)}function s(e){E.grid.api.core.scrollToIfNecessary(E.row,E.col).then(function(){!function(e){if(m)return;if(i=E.col,t=E.row,n=e,t.isSaving||(angular.isFunction(i.colDef.cellEditableCondition)?!i.colDef.cellEditableCondition(E,n):!i.colDef.cellEditableCondition))return;var i,t,n;var o=E.row.getQualifiedColField(E.col);E.col.colDef.editModelField&&(o=w.preEval("row.entity."+E.col.colDef.editModelField));g=_(o),v=g(E),C=(C=(C=E.col.editableCellTemplate).replace(T.MODEL_COL_FIELD,o)).replace(T.COL_FIELD,"grid.getCellValue(row, col)");var l=E.col.colDef.editDropdownFilter?"|"+E.col.colDef.editDropdownFilter:"";C=C.replace(T.CUSTOM_FILTERS,l);var r="text";switch(E.col.colDef.type){case"boolean":r="checkbox";break;case"number":r="number";break;case"date":r="date"}C=C.replace("INPUT_TYPE",r);var d=E.col.colDef.editDropdownOptionsFunction;if(d)G.when(d(E.row.entity,E.col.colDef)).then(function(e){E.editDropdownOptionsArray=e});else{var c=E.col.colDef.editDropdownRowEntityOptionsArrayPath;E.editDropdownOptionsArray=c?function(e,i){var t=(i=(i=i.replace(/\[(\w+)\]/g,".$1")).replace(/^\./,"")).split(".");for(;t.length;){var n=t.shift();if(!(n in e))return;e=e[n]}return e}(E.row.entity,c):E.col.colDef.editDropdownOptionsArray}E.editDropdownIdLabel=E.col.colDef.editDropdownIdLabel?E.col.colDef.editDropdownIdLabel:"id",E.editDropdownValueLabel=E.col.colDef.editDropdownValueLabel?E.col.colDef.editDropdownValueLabel:"value";var a=function(){m=!0,D();var e=angular.element(C);p.append(e),y=E.$new(),b(e)(y);var i=angular.element(p.children()[0]);i.addClass("ui-grid-cell-contents-hidden")};I.$$phase?a():E.$apply(a);var u=E.col.grid.api.core.on.scrollBegin(E,function(){E.grid.disableScrolling||(L(),E.grid.api.edit.raise.afterCellEdit(E.row.entity,E.col.colDef,g(E),v),u(),s(),f())}),s=E.$on(k.events.END_CELL_EDIT,function(){L(),E.grid.api.edit.raise.afterCellEdit(E.row.entity,E.col.colDef,g(E),v),s(),u(),f()}),f=E.$on(k.events.CANCEL_CELL_EDIT,function(){!function(){if(E.grid.disableScrolling=!1,!m)return;g.assign(E,v),E.$apply(),E.grid.api.edit.raise.cancelCellEdit(E.row.entity,E.col.colDef),L()}(),f(),u(),s()});E.$broadcast(k.events.BEGIN_CELL_EDIT,e),h(function(){E.grid.api.edit.raise.beginCellEdit(E.row.entity,E.col.colDef,e)})}(e)})}function L(){if(E.grid.disableScrolling=!1,m){n&&n.grid.api.cellNav&&n.focus();var e=angular.element(p.children()[0]);y.$destroy();for(var i=p.children(),t=1;tAlpha This feature is in development. There will almost certainly be breaking api changes, or there are major outstanding bugs.
+ *
+ * This module provides the ability to have the background of the ui-grid be empty rows, this would be displayed in the case were
+ * the grid height is greater then the amount of rows displayed.
+ *
+ *
+ */
+ var module = angular.module('ui.grid.emptyBaseLayer', ['ui.grid']);
+
+
+ /**
+ * @ngdoc service
+ * @name ui.grid.emptyBaseLayer.service:uiGridBaseLayerService
+ *
+ * @description Services for the empty base layer grid
+ */
+ module.service('uiGridBaseLayerService', ['gridUtil', '$compile', function (gridUtil, $compile) {
+ return {
+ initializeGrid: function (grid, disableEmptyBaseLayer) {
+
+ /**
+ * @ngdoc object
+ * @name ui.grid.emptyBaseLayer.api:GridOptions
+ *
+ * @description GridOptions for emptyBaseLayer feature, these are available to be
+ * set using the ui-grid {@link ui.grid.class:GridOptions gridOptions}
+ */
+ grid.baseLayer = {
+ emptyRows: []
+ };
+
+ /**
+ * @ngdoc object
+ * @name enableEmptyGridBaseLayer
+ * @propertyOf ui.grid.emptyBaseLayer.api:GridOptions
+ * @description Enable empty base layer, which shows empty rows as background on the entire grid
+ * Defaults to true, if the directive is used. + * Set to false either by setting this attribute or passing false to the directive. + */ + // default option to true unless it was explicitly set to false + if (grid.options.enableEmptyGridBaseLayer !== false) { + grid.options.enableEmptyGridBaseLayer = !disableEmptyBaseLayer; + } + }, + + setNumberOfEmptyRows: function(viewportHeight, grid) { + var rowHeight = grid.options.rowHeight, + rows = Math.ceil(viewportHeight / rowHeight); + + if (rows > 0) { + grid.baseLayer.emptyRows = []; + for (var i = 0; i < rows; i++) { + grid.baseLayer.emptyRows.push({}); + } + } + } + }; + }]); + + /** + * @ngdoc object + * @name ui.grid.emptyBaseLayer.directive:uiGridEmptyBaseLayer + * @description Shows empty rows in the background of the ui-grid, these span + * the full height of the ui-grid, so that there won't be blank space below the shown rows. + * @example + * + * + *+ * Or you can enable/disable it dynamically by passing in true or false. It doesn't + * the value, so it would only be set on initial render. + * + * + *+ */ + module.directive('uiGridEmptyBaseLayer', ['gridUtil', 'uiGridBaseLayerService', + '$parse', + function (gridUtil, uiGridBaseLayerService, $parse) { + return { + require: '^uiGrid', + scope: false, + compile: function () { + return { + pre: function ($scope, $elm, $attrs, uiGridCtrl) { + var disableEmptyBaseLayer = $parse($attrs.uiGridEmptyBaseLayer)($scope) === false; + + uiGridBaseLayerService.initializeGrid(uiGridCtrl.grid, disableEmptyBaseLayer); + }, + post: function ($scope, $elm, $attrs, uiGridCtrl) { + if (!uiGridCtrl.grid.options.enableEmptyGridBaseLayer) { + return; + } + + var renderBodyContainer = uiGridCtrl.grid.renderContainers.body, + viewportHeight = renderBodyContainer.getViewportHeight(); + + function heightHasChanged() { + var newViewPortHeight = renderBodyContainer.getViewportHeight(); + + if (newViewPortHeight !== viewportHeight) { + viewportHeight = newViewPortHeight; + return true; + } + return false; + } + + function getEmptyBaseLayerCss(viewportHeight) { + // Set ui-grid-empty-base-layer height + return '.grid' + uiGridCtrl.grid.id + + ' .ui-grid-render-container ' + + '.ui-grid-empty-base-layer-container.ui-grid-canvas ' + + '{ height: ' + viewportHeight + 'px; }'; + } + + uiGridCtrl.grid.registerStyleComputation({ + func: function() { + if (heightHasChanged()) { + uiGridBaseLayerService.setNumberOfEmptyRows(viewportHeight, uiGridCtrl.grid); + } + return getEmptyBaseLayerCss(viewportHeight); + } + }); + } + }; + } + }; + }]); + + /** + * @ngdoc directive + * @name ui.grid.emptyBaseLayer.directive:uiGridViewport + * @description stacks on the uiGridViewport directive to append the empty grid base layer html elements to the + * default gridRow template + */ + module.directive('uiGridViewport', + ['$compile', 'gridUtil', '$templateCache', + function ($compile, gridUtil, $templateCache) { + return { + priority: -200, + scope: false, + compile: function ($elm) { + var emptyBaseLayerContainer = $templateCache.get('ui-grid/emptyBaseLayerContainer'); + $elm.prepend(emptyBaseLayerContainer); + return { + pre: function ($scope, $elm, $attrs, controllers) { + }, + post: function ($scope, $elm, $attrs, controllers) { + } + }; + } + }; + }]); + +})(); + +angular.module('ui.grid.emptyBaseLayer').run(['$templateCache', function($templateCache) { + 'use strict'; + + $templateCache.put('ui-grid/emptyBaseLayerContainer', + " Alpha This feature is in development. There will almost certainly be breaking api changes, or there are major outstanding bugs.
+ *
+ * This module provides the ability to create subgrids with the ability to expand a row
+ * to show the subgrid.
+ *
+ *
+ */
+ var module = angular.module('ui.grid.expandable', ['ui.grid']);
+
+ /**
+ * @ngdoc service
+ * @name ui.grid.expandable.service:uiGridExpandableService
+ *
+ * @description Services for the expandable grid
+ */
+ module.service('uiGridExpandableService', ['gridUtil', function (gridUtil) {
+ var service = {
+ initializeGrid: function (grid) {
+
+ grid.expandable = {};
+ grid.expandable.expandedAll = false;
+
+ /**
+ * @ngdoc boolean
+ * @name enableOnDblClickExpand
+ * @propertyOf ui.grid.expandable.api:GridOptions
+ * @description Defaults to true.
+ * @example
+ *
+ * $scope.gridOptions = {
+ * onDblClickExpand: false
+ * }
+ *
+ */
+ grid.options.enableOnDblClickExpand = grid.options.enableOnDblClickExpand !== false;
+ /**
+ * @ngdoc boolean
+ * @name enableExpandable
+ * @propertyOf ui.grid.expandable.api:GridOptions
+ * @description Whether or not to use expandable feature, allows you to turn off expandable on specific grids
+ * within your application, or in specific modes on _this_ grid. Defaults to true.
+ * @example
+ *
+ * $scope.gridOptions = {
+ * enableExpandable: false
+ * }
+ *
+ */
+ grid.options.enableExpandable = grid.options.enableExpandable !== false;
+
+ /**
+ * @ngdoc object
+ * @name showExpandAllButton
+ * @propertyOf ui.grid.expandable.api:GridOptions
+ * @description Whether or not to display the expand all button, allows you to hide expand all button on specific grids
+ * within your application, or in specific modes on _this_ grid. Defaults to true.
+ * @example
+ *
+ * $scope.gridOptions = {
+ * showExpandAllButton: false
+ * }
+ *
+ */
+ grid.options.showExpandAllButton = grid.options.showExpandAllButton !== false;
+
+ /**
+ * @ngdoc object
+ * @name expandableRowHeight
+ * @propertyOf ui.grid.expandable.api:GridOptions
+ * @description Height in pixels of the expanded subgrid. Defaults to
+ * 150
+ * @example
+ *
+ * $scope.gridOptions = {
+ * expandableRowHeight: 150
+ * }
+ *
+ */
+ grid.options.expandableRowHeight = grid.options.expandableRowHeight || 150;
+
+ /**
+ * @ngdoc object
+ * @name expandableRowHeaderWidth
+ * @propertyOf ui.grid.expandable.api:GridOptions
+ * @description Width in pixels of the expandable column. Defaults to 40
+ * @example
+ *
+ * $scope.gridOptions = {
+ * expandableRowHeaderWidth: 40
+ * }
+ *
+ */
+ grid.options.expandableRowHeaderWidth = grid.options.expandableRowHeaderWidth || 40;
+
+ /**
+ * @ngdoc object
+ * @name expandableRowTemplate
+ * @propertyOf ui.grid.expandable.api:GridOptions
+ * @description Mandatory. The template for your expanded row
+ * @example
+ *
+ * $scope.gridOptions = {
+ * expandableRowTemplate: 'expandableRowTemplate.html'
+ * }
+ *
+ */
+ if ( grid.options.enableExpandable && !grid.options.expandableRowTemplate ) {
+ gridUtil.logError( 'You have not set the expandableRowTemplate, disabling expandable module' );
+ grid.options.enableExpandable = false;
+ }
+
+ /**
+ * @ngdoc object
+ * @name ui.grid.expandable.api:PublicApi
+ *
+ * @description Public Api for expandable feature
+ */
+ /**
+ * @ngdoc object
+ * @name ui.grid.expandable.api:GridRow
+ *
+ * @description Additional properties added to GridRow when using the expandable module
+ */
+ /**
+ * @ngdoc object
+ * @name ui.grid.expandable.api:GridOptions
+ *
+ * @description Options for configuring the expandable feature, these are available to be
+ * set using the ui-grid {@link ui.grid.class:GridOptions gridOptions}
+ */
+ var publicApi = {
+ events: {
+ expandable: {
+ /**
+ * @ngdoc event
+ * @name rowExpandedBeforeStateChanged
+ * @eventOf ui.grid.expandable.api:PublicApi
+ * @description raised when row is expanding or collapsing
+ *
+ * gridApi.expandable.on.rowExpandedBeforeStateChanged(scope,function(row, event) {})
+ *
+ * @param {scope} scope the application scope
+ * @param {GridRow} row the row that was expanded
+ * @param {Event} evt object if raised from an event
+ */
+ rowExpandedBeforeStateChanged: function(scope, row, evt) {},
+
+ /**
+ * @ngdoc event
+ * @name rowExpandedStateChanged
+ * @eventOf ui.grid.expandable.api:PublicApi
+ * @description raised when row expanded or collapsed
+ *
+ * gridApi.expandable.on.rowExpandedStateChanged(scope,function(row, event) {})
+ *
+ * @param {scope} scope the application scope
+ * @param {GridRow} row the row that was expanded
+ * @param {Event} evt object if raised from an event
+ */
+ rowExpandedStateChanged: function (scope, row, evt) {},
+
+ /**
+ * @ngdoc event
+ * @name rowExpandedRendered
+ * @eventOf ui.grid.expandable.api:PublicApi
+ * @description raised when expanded row is rendered
+ *
+ * gridApi.expandable.on.rowExpandedRendered(scope,function(row, event) {})
+ *
+ * @param {scope} scope the application scope
+ * @param {GridRow} row the row that was expanded
+ * @param {Event} evt object if raised from an event
+ */
+ rowExpandedRendered: function (scope, row, evt) {}
+ }
+ },
+
+ methods: {
+ expandable: {
+ /**
+ * @ngdoc method
+ * @name toggleRowExpansion
+ * @methodOf ui.grid.expandable.api:PublicApi
+ * @description Toggle a specific row
+ * + * gridApi.expandable.toggleRowExpansion(rowEntity, event); + *+ * @param {object} rowEntity the data entity for the row you want to expand + * @param {Event} [e] event (if exist) + */ + toggleRowExpansion: function (rowEntity, e) { + var row = grid.getRow(rowEntity); + + if (row !== null) { + service.toggleRowExpansion(grid, row, e); + } + }, + + /** + * @ngdoc method + * @name expandAllRows + * @methodOf ui.grid.expandable.api:PublicApi + * @description Expand all subgrids. + * + * gridApi.expandable.expandAllRows(); + *+ */ + expandAllRows: function() { + service.expandAllRows(grid); + }, + + /** + * @ngdoc method + * @name collapseAllRows + * @methodOf ui.grid.expandable.api:PublicApi + * @description Collapse all subgrids. + * + * gridApi.expandable.collapseAllRows(); + *+ */ + collapseAllRows: function() { + service.collapseAllRows(grid); + }, + + /** + * @ngdoc method + * @name toggleAllRows + * @methodOf ui.grid.expandable.api:PublicApi + * @description Toggle all subgrids. + * + * gridApi.expandable.toggleAllRows(); + *+ */ + toggleAllRows: function() { + service.toggleAllRows(grid); + }, + /** + * @ngdoc function + * @name expandRow + * @methodOf ui.grid.expandable.api:PublicApi + * @description Expand the data row + * @param {object} rowEntity gridOptions.data[] array instance + */ + expandRow: function (rowEntity) { + var row = grid.getRow(rowEntity); + + if (row !== null && !row.isExpanded) { + service.toggleRowExpansion(grid, row); + } + }, + /** + * @ngdoc function + * @name collapseRow + * @methodOf ui.grid.expandable.api:PublicApi + * @description Collapse the data row + * @param {object} rowEntity gridOptions.data[] array instance + */ + collapseRow: function (rowEntity) { + var row = grid.getRow(rowEntity); + + if (row !== null && row.isExpanded) { + service.toggleRowExpansion(grid, row); + } + }, + /** + * @ngdoc function + * @name getExpandedRows + * @methodOf ui.grid.expandable.api:PublicApi + * @description returns all expandedRow's entity references + */ + getExpandedRows: function () { + return service.getExpandedRows(grid).map(function (gridRow) { + return gridRow.entity; + }); + } + } + } + }; + grid.api.registerEventsFromObject(publicApi.events); + grid.api.registerMethodsFromObject(publicApi.methods); + }, + + /** + * + * @param grid + * @param row + * @param {Event} [e] event (if exist) + */ + toggleRowExpansion: function (grid, row, e) { + // trigger the "before change" event. Can change row height dynamically this way. + grid.api.expandable.raise.rowExpandedBeforeStateChanged(row); + /** + * @ngdoc object + * @name isExpanded + * @propertyOf ui.grid.expandable.api:GridRow + * @description Whether or not the row is currently expanded. + * @example + *
+ * $scope.api.expandable.on.rowExpandedStateChanged($scope, function (row) {
+ * if (row.isExpanded) {
+ * //...
+ * }
+ * });
+ *
+ */
+ row.isExpanded = !row.isExpanded;
+ if (angular.isUndefined(row.expandedRowHeight)) {
+ row.expandedRowHeight = grid.options.expandableRowHeight;
+ }
+
+ if (row.isExpanded) {
+ row.height = row.grid.options.rowHeight + row.expandedRowHeight;
+ grid.expandable.expandedAll = service.getExpandedRows(grid).length === grid.rows.length;
+ }
+ else {
+ row.height = row.grid.options.rowHeight;
+ grid.expandable.expandedAll = false;
+ }
+ grid.api.expandable.raise.rowExpandedStateChanged(row, e);
+
+ // fire event on render complete
+ function _tWatcher() {
+ if (row.expandedRendered) {
+ grid.api.expandable.raise.rowExpandedRendered(row, e);
+ }
+ else {
+ window.setTimeout(_tWatcher, 1e2);
+ }
+ }
+ _tWatcher();
+ },
+
+ expandAllRows: function(grid) {
+ grid.renderContainers.body.visibleRowCache.forEach( function(row) {
+ if (!row.isExpanded && !(row.entity.subGridOptions && row.entity.subGridOptions.disableRowExpandable)) {
+ service.toggleRowExpansion(grid, row);
+ }
+ });
+ grid.expandable.expandedAll = true;
+ grid.queueGridRefresh();
+ },
+
+ collapseAllRows: function(grid) {
+ grid.renderContainers.body.visibleRowCache.forEach( function(row) {
+ if (row.isExpanded) {
+ service.toggleRowExpansion(grid, row);
+ }
+ });
+ grid.expandable.expandedAll = false;
+ grid.queueGridRefresh();
+ },
+
+ toggleAllRows: function(grid) {
+ if (grid.expandable.expandedAll) {
+ service.collapseAllRows(grid);
+ }
+ else {
+ service.expandAllRows(grid);
+ }
+ },
+
+ getExpandedRows: function (grid) {
+ return grid.rows.filter(function (row) {
+ return row.isExpanded;
+ });
+ }
+ };
+ return service;
+ }]);
+
+ /**
+ * @ngdoc object
+ * @name enableExpandableRowHeader
+ * @propertyOf ui.grid.expandable.api:GridOptions
+ * @description Show a rowHeader to provide the expandable buttons. If set to false then implies
+ * you're going to use a custom method for expanding and collapsing the subgrids. Defaults to true.
+ * @example
+ *
+ * $scope.gridOptions = {
+ * enableExpandableRowHeader: false
+ * }
+ *
+ */
+
+ module.directive('uiGridExpandable', ['uiGridExpandableService', '$templateCache',
+ function (uiGridExpandableService, $templateCache) {
+ return {
+ replace: true,
+ priority: 0,
+ require: '^uiGrid',
+ scope: false,
+ compile: function () {
+ return {
+ pre: function ($scope, $elm, $attrs, uiGridCtrl) {
+ uiGridExpandableService.initializeGrid(uiGridCtrl.grid);
+
+ if (!uiGridCtrl.grid.options.enableExpandable) {
+ return;
+ }
+
+ if (uiGridCtrl.grid.options.enableExpandableRowHeader !== false ) {
+ var expandableRowHeaderColDef = {
+ name: 'expandableButtons',
+ displayName: '',
+ exporterSuppressExport: true,
+ enableColumnResizing: false,
+ enableColumnMenu: false,
+ width: uiGridCtrl.grid.options.expandableRowHeaderWidth || 30
+ };
+
+ expandableRowHeaderColDef.cellTemplate = $templateCache.get('ui-grid/expandableRowHeader');
+ expandableRowHeaderColDef.headerCellTemplate = $templateCache.get('ui-grid/expandableTopRowHeader');
+ uiGridCtrl.grid.addRowHeaderColumn(expandableRowHeaderColDef, -90);
+ }
+ },
+ post: function ($scope, $elm, $attrs, uiGridCtrl) {}
+ };
+ }
+ };
+ }]);
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.expandable.directive:uiGrid
+ * @description stacks on the uiGrid directive to register child grid with parent row when child is created
+ */
+ module.directive('uiGrid',
+ function () {
+ return {
+ replace: true,
+ priority: 599,
+ require: '^uiGrid',
+ scope: false,
+ compile: function () {
+ return {
+ pre: function ($scope, $elm, $attrs, uiGridCtrl) {
+
+ uiGridCtrl.grid.api.core.on.renderingComplete($scope, function() {
+ // if a parent grid row is on the scope, then add the parentRow property to this childGrid
+ if ($scope.row && $scope.row.grid && $scope.row.grid.options
+ && $scope.row.grid.options.enableExpandable) {
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.expandable.class:Grid
+ * @description Additional Grid properties added by expandable module
+ */
+
+ /**
+ * @ngdoc object
+ * @name parentRow
+ * @propertyOf ui.grid.expandable.class:Grid
+ * @description reference to the expanded parent row that owns this grid
+ */
+ uiGridCtrl.grid.parentRow = $scope.row;
+
+ // todo: adjust height on parent row when child grid height changes. we need some sort of gridHeightChanged event
+ // uiGridCtrl.grid.core.on.canvasHeightChanged($scope, function(oldHeight, newHeight) {
+ // uiGridCtrl.grid.parentRow = newHeight;
+ // });
+ }
+ });
+ },
+ post: function ($scope, $elm, $attrs, uiGridCtrl) {}
+ };
+ }
+ };
+ });
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.expandable.directive:uiGridExpandableRow
+ * @description directive to render the Row template on Expand
+ */
+ module.directive('uiGridExpandableRow',
+ ['uiGridExpandableService', '$compile', 'uiGridConstants','gridUtil',
+ function (uiGridExpandableService, $compile, uiGridConstants, gridUtil) {
+
+ return {
+ replace: false,
+ priority: 0,
+ scope: false,
+ compile: function () {
+ return {
+ pre: function ($scope, $elm) {
+ gridUtil.getTemplate($scope.grid.options.expandableRowTemplate).then(
+ function (template) {
+ if ($scope.grid.options.expandableRowScope) {
+ /**
+ * @ngdoc object
+ * @name expandableRowScope
+ * @propertyOf ui.grid.expandable.api:GridOptions
+ * @description Variables of object expandableScope will be available in the scope of the expanded subgrid
+ * @example
+ *
+ * $scope.gridOptions = {
+ * expandableRowScope: expandableScope
+ * }
+ *
+ */
+ var expandableRowScope = $scope.grid.options.expandableRowScope;
+
+ for (var property in expandableRowScope) {
+ if (expandableRowScope.hasOwnProperty(property)) {
+ $scope[property] = expandableRowScope[property];
+ }
+ }
+ }
+ var expandedRowElement = angular.element(template);
+
+ expandedRowElement = $compile(expandedRowElement)($scope);
+ $elm.append(expandedRowElement);
+ $scope.row.element = $elm;
+ $scope.row.expandedRendered = true;
+ });
+ },
+
+ post: function ($scope, $elm) {
+ $scope.row.element = $elm;
+ $scope.$on('$destroy', function() {
+ $scope.row.expandedRendered = false;
+ });
+ }
+ };
+ }
+ };
+ }]);
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.expandable.directive:uiGridRow
+ * @description stacks on the uiGridRow directive to add support for expandable rows
+ */
+ module.directive('uiGridRow',
+ function () {
+ return {
+ priority: -200,
+ scope: false,
+ compile: function () {
+ return {
+ pre: function ($scope, $elm) {
+ if (!$scope.grid.options.enableExpandable) {
+ return;
+ }
+
+ $scope.expandableRow = {};
+
+ $scope.expandableRow.shouldRenderExpand = function () {
+ return $scope.colContainer.name === 'body'
+ && $scope.grid.options.enableExpandable !== false
+ && $scope.row.isExpanded
+ && (!$scope.grid.isScrollingVertically || $scope.row.expandedRendered);
+ };
+
+ $scope.expandableRow.shouldRenderFiller = function () {
+ return $scope.row.isExpanded
+ && (
+ $scope.colContainer.name !== 'body'
+ || ($scope.grid.isScrollingVertically && !$scope.row.expandedRendered));
+ };
+
+ if ($scope.grid.options.enableOnDblClickExpand) {
+ $elm.on('dblclick', function (event) {
+ // if necessary, it is possible for everyone to stop the processing of a single click OR
+ // Inside the Config in the output agent to enter a line:
+ // event.stopPropagation()
+ $scope.grid.api.expandable.toggleRowExpansion($scope.row.entity, event);
+ });
+ }
+ },
+ post: function ($scope, $elm, $attrs, controllers) {}
+ };
+ }
+ };
+ });
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.expandable.directive:uiGridViewport
+ * @description stacks on the uiGridViewport directive to append the expandable row html elements to the
+ * default gridRow template
+ */
+ module.directive('uiGridViewport',
+ ['$compile', 'gridUtil', '$templateCache',
+ function ($compile, gridUtil, $templateCache) {
+ return {
+ priority: -200,
+ scope: false,
+ compile: function ($elm) {
+
+ // todo: this adds ng-if watchers to each row even if the grid is not using expandable directive
+ // or options.enableExpandable == false
+ // The alternative is to compile the template and append to each row in a uiGridRow directive
+
+ var rowRepeatDiv = angular.element($elm.children().children()[0]),
+ expandedRowFillerElement = $templateCache.get('ui-grid/expandableScrollFiller'),
+ expandedRowElement = $templateCache.get('ui-grid/expandableRow');
+
+ rowRepeatDiv.append(expandedRowElement);
+ rowRepeatDiv.append(expandedRowFillerElement);
+ return {
+ pre: function ($scope, $elm, $attrs, controllers) {
+ },
+ post: function ($scope, $elm, $attrs, controllers) {
+ }
+ };
+ }
+ };
+ }]);
+
+})();
+
+angular.module('ui.grid.expandable').run(['$templateCache', function($templateCache) {
+ 'use strict';
+
+ $templateCache.put('ui-grid/expandableRow',
+ ""
+ );
+
+
+ $templateCache.put('ui-grid/expandableRowHeader',
+ "Stable This feature is stable. There should no longer be breaking api changes without a deprecation warning.
+ *
+ * This module provides the ability to export data from the grid.
+ *
+ * Data can be exported in a range of formats, and all data, visible
+ * data, or selected rows can be exported, with all columns or visible
+ * columns.
+ *
+ * No UI is provided, the caller should provide their own UI/buttons
+ * as appropriate, or enable the gridMenu
+ *
+ * + * + * + * + */ + + var module = angular.module('ui.grid.exporter', ['ui.grid']); + + /** + * @ngdoc object + * @name ui.grid.exporter.constant:uiGridExporterConstants + * + * @description constants available in exporter module + */ + /** + * @ngdoc property + * @propertyOf ui.grid.exporter.constant:uiGridExporterConstants + * @name ALL + * @description export all data, including data not visible. Can + * be set for either rowTypes or colTypes + */ + /** + * @ngdoc property + * @propertyOf ui.grid.exporter.constant:uiGridExporterConstants + * @name VISIBLE + * @description export only visible data, including data not visible. Can + * be set for either rowTypes or colTypes + */ + /** + * @ngdoc property + * @propertyOf ui.grid.exporter.constant:uiGridExporterConstants + * @name SELECTED + * @description export all data, including data not visible. Can + * be set only for rowTypes, selection of only some columns is + * not supported + */ + module.constant('uiGridExporterConstants', { + featureName: 'exporter', + rowHeaderColName: 'treeBaseRowHeaderCol', + selectionRowHeaderColName: 'selectionRowHeaderCol', + ALL: 'all', + VISIBLE: 'visible', + SELECTED: 'selected', + CSV_CONTENT: 'CSV_CONTENT', + BUTTON_LABEL: 'BUTTON_LABEL', + FILE_NAME: 'FILE_NAME' + }); + + /** + * @ngdoc service + * @name ui.grid.exporter.service:uiGridExporterService + * + * @description Services for exporter feature + */ + module.service('uiGridExporterService', ['$filter', '$q', 'uiGridExporterConstants', 'gridUtil', '$compile', '$interval', 'i18nService', + function ($filter, $q, uiGridExporterConstants, gridUtil, $compile, $interval, i18nService) { + var service = { + + delay: 100, + + initializeGrid: function (grid) { + + // add feature namespace and any properties to grid for needed state + grid.exporter = {}; + this.defaultGridOptions(grid.options); + + /** + * @ngdoc object + * @name ui.grid.exporter.api:PublicApi + * + * @description Public Api for exporter feature + */ + var publicApi = { + events: { + exporter: { + } + }, + methods: { + exporter: { + /** + * @ngdoc function + * @name csvExport + * @methodOf ui.grid.exporter.api:PublicApi + * @description Exports rows from the grid in csv format, + * the data exported is selected based on the provided options + * @param {string} rowTypes which rows to export, valid values are + * uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE, + * uiGridExporterConstants.SELECTED + * @param {string} colTypes which columns to export, valid values are + * uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE + */ + csvExport: function (rowTypes, colTypes) { + service.csvExport(grid, rowTypes, colTypes); + }, + /** + * @ngdoc function + * @name pdfExport + * @methodOf ui.grid.exporter.api:PublicApi + * @description Exports rows from the grid in pdf format, + * the data exported is selected based on the provided options + * Note that this function has a dependency on pdfMake, all + * going well this has been installed for you. + * The resulting pdf opens in a new browser window. + * @param {string} rowTypes which rows to export, valid values are + * uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE, + * uiGridExporterConstants.SELECTED + * @param {string} colTypes which columns to export, valid values are + * uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE + */ + pdfExport: function (rowTypes, colTypes) { + service.pdfExport(grid, rowTypes, colTypes); + }, + /** + * @ngdoc function + * @name excelExport + * @methodOf ui.grid.exporter.api:PublicApi + * @description Exports rows from the grid in excel format, + * the data exported is selected based on the provided options + * @param {string} rowTypes which rows to export, valid values are + * uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE, + * uiGridExporterConstants.SELECTED + * @param {string} colTypes which columns to export, valid values are + * uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE + */ + excelExport: function (rowTypes, colTypes) { + service.excelExport(grid, rowTypes, colTypes); + } + } + } + }; + + grid.api.registerEventsFromObject(publicApi.events); + + grid.api.registerMethodsFromObject(publicApi.methods); + + if (grid.api.core.addToGridMenu) { + service.addToMenu( grid ); + } else { + // order of registration is not guaranteed, register in a little while + $interval( function() { + if (grid.api.core.addToGridMenu) { + service.addToMenu( grid ); + } + }, this.delay, 1); + } + + }, + + defaultGridOptions: function (gridOptions) { + // default option to true unless it was explicitly set to false + /** + * @ngdoc object + * @name ui.grid.exporter.api:GridOptions + * + * @description GridOptions for exporter feature, these are available to be + * set using the ui-grid {@link ui.grid.class:GridOptions gridOptions} + */ + /** + * @ngdoc object + * @name ui.grid.exporter.api:ColumnDef + * @description ColumnDef settings for exporter + */ + /** + * @ngdoc object + * @name exporterSuppressMenu + * @propertyOf ui.grid.exporter.api:GridOptions + * @description Don't show the export menu button, implying the user + * will roll their own UI for calling the exporter + * Defaults to false + */ + gridOptions.exporterSuppressMenu = gridOptions.exporterSuppressMenu === true; + /** + * @ngdoc object + * @name exporterMenuLabel + * @propertyOf ui.grid.exporter.api:GridOptions + * @description The text to show on the exporter menu button + * link + * Defaults to 'Export' + */ + gridOptions.exporterMenuLabel = gridOptions.exporterMenuLabel ? gridOptions.exporterMenuLabel : 'Export'; + /** + * @ngdoc object + * @name exporterSuppressColumns + * @propertyOf ui.grid.exporter.api:GridOptions + * @description Columns that should not be exported. The selectionRowHeader is already automatically + * suppressed, but if you had a button column or some other "system" column that shouldn't be shown in the + * output then add it in this list. You should provide an array of column names. + * Defaults to: [] + * + * gridOptions.exporterSuppressColumns = [ 'buttons' ]; + *+ */ + gridOptions.exporterSuppressColumns = gridOptions.exporterSuppressColumns ? gridOptions.exporterSuppressColumns : []; + /** + * @ngdoc object + * @name exporterCsvColumnSeparator + * @propertyOf ui.grid.exporter.api:GridOptions + * @description The character to use as column separator + * link + * Defaults to ',' + */ + gridOptions.exporterCsvColumnSeparator = gridOptions.exporterCsvColumnSeparator ? gridOptions.exporterCsvColumnSeparator : ','; + /** + * @ngdoc object + * @name exporterCsvFilename + * @propertyOf ui.grid.exporter.api:GridOptions + * @description The default filename to use when saving the downloaded csv. + * This will only work in some browsers. + * Defaults to 'download.csv' + */ + gridOptions.exporterCsvFilename = gridOptions.exporterCsvFilename ? gridOptions.exporterCsvFilename : 'download.csv'; + /** + * @ngdoc object + * @name exporterPdfFilename + * @propertyOf ui.grid.exporter.api:GridOptions + * @description The default filename to use when saving the downloaded pdf, only used in IE (other browsers open pdfs in a new window) + * Defaults to 'download.pdf' + */ + gridOptions.exporterPdfFilename = gridOptions.exporterPdfFilename ? gridOptions.exporterPdfFilename : 'download.pdf'; + /** + * @ngdoc object + * @name exporterExcelFilename + * @propertyOf ui.grid.exporter.api:GridOptions + * @description The default filename to use when saving the downloaded excel, only used in IE (other browsers open excels in a new window) + * Defaults to 'download.xlsx' + */ + gridOptions.exporterExcelFilename = gridOptions.exporterExcelFilename ? gridOptions.exporterExcelFilename : 'download.xlsx'; + + /** + * @ngdoc object + * @name exporterExcelSheetName + * @propertyOf ui.grid.exporter.api:GridOptions + * @description The default sheetname to use when saving the downloaded to excel + * Defaults to 'Sheet1' + */ + gridOptions.exporterExcelSheetName = gridOptions.exporterExcelSheetName ? gridOptions.exporterExcelSheetName : 'Sheet1'; + + /** + * @ngdoc object + * @name exporterOlderExcelCompatibility + * @propertyOf ui.grid.exporter.api:GridOptions + * @description Some versions of excel don't like the utf-16 BOM on the front, and it comes + * through as  in the first column header. Setting this option to false will suppress this, at the + * expense of proper utf-16 handling in applications that do recognise the BOM + * Defaults to false + */ + gridOptions.exporterOlderExcelCompatibility = gridOptions.exporterOlderExcelCompatibility === true; + /** + * @ngdoc object + * @name exporterIsExcelCompatible + * @propertyOf ui.grid.exporter.api:GridOptions + * @description Separator header, used to set a custom column separator in a csv file, only works on MS Excel. + * Used it on other programs will make csv content display unproperly. Setting this option to false won't add this header. + * Defaults to false + */ + gridOptions.exporterIsExcelCompatible = gridOptions.exporterIsExcelCompatible === true; + /** + * @ngdoc object + * @name exporterMenuItemOrder + * @propertyOf ui.grid.exporter.api:GridOptions + * @description An option to determine the starting point for the menu items created by the exporter + * Defaults to 200 + */ + gridOptions.exporterMenuItemOrder = gridOptions.exporterMenuItemOrder ? gridOptions.exporterMenuItemOrder : 200; + /** + * @ngdoc object + * @name exporterPdfDefaultStyle + * @propertyOf ui.grid.exporter.api:GridOptions + * @description The default style in pdfMake format + * Defaults to: + *
+ * {
+ * fontSize: 11
+ * }
+ *
+ */
+ gridOptions.exporterPdfDefaultStyle = gridOptions.exporterPdfDefaultStyle ? gridOptions.exporterPdfDefaultStyle : { fontSize: 11 };
+ /**
+ * @ngdoc object
+ * @name exporterPdfTableStyle
+ * @propertyOf ui.grid.exporter.api:GridOptions
+ * @description The table style in pdfMake format
+ * Defaults to: + *
+ * {
+ * margin: [0, 5, 0, 15]
+ * }
+ *
+ */
+ gridOptions.exporterPdfTableStyle = gridOptions.exporterPdfTableStyle ? gridOptions.exporterPdfTableStyle : { margin: [0, 5, 0, 15] };
+ /**
+ * @ngdoc object
+ * @name exporterPdfTableHeaderStyle
+ * @propertyOf ui.grid.exporter.api:GridOptions
+ * @description The tableHeader style in pdfMake format
+ * Defaults to: + *
+ * {
+ * bold: true,
+ * fontSize: 12,
+ * color: 'black'
+ * }
+ *
+ */
+ gridOptions.exporterPdfTableHeaderStyle = gridOptions.exporterPdfTableHeaderStyle ? gridOptions.exporterPdfTableHeaderStyle : { bold: true, fontSize: 12, color: 'black' };
+ /**
+ * @ngdoc object
+ * @name exporterPdfHeader
+ * @propertyOf ui.grid.exporter.api:GridOptions
+ * @description The header section for pdf exports. Can be
+ * simple text:
+ * + * gridOptions.exporterPdfHeader = 'My Header'; + *+ * Can be a more complex object in pdfMake format: + *
+ * gridOptions.exporterPdfHeader = {
+ * columns: [
+ * 'Left part',
+ * { text: 'Right part', alignment: 'right' }
+ * ]
+ * };
+ *
+ * Or can be a function, allowing page numbers and the like
+ *
+ * gridOptions.exporterPdfHeader: function(currentPage, pageCount) { return currentPage.toString() + ' of ' + pageCount; };
+ *
+ */
+ gridOptions.exporterPdfHeader = gridOptions.exporterPdfHeader ? gridOptions.exporterPdfHeader : null;
+ /**
+ * @ngdoc object
+ * @name exporterPdfFooter
+ * @propertyOf ui.grid.exporter.api:GridOptions
+ * @description The header section for pdf exports. Can be
+ * simple text:
+ * + * gridOptions.exporterPdfFooter = 'My Footer'; + *+ * Can be a more complex object in pdfMake format: + *
+ * gridOptions.exporterPdfFooter = {
+ * columns: [
+ * 'Left part',
+ * { text: 'Right part', alignment: 'right' }
+ * ]
+ * };
+ *
+ * Or can be a function, allowing page numbers and the like
+ *
+ * gridOptions.exporterPdfFooter: function(currentPage, pageCount) { return currentPage.toString() + ' of ' + pageCount; };
+ *
+ */
+ gridOptions.exporterPdfFooter = gridOptions.exporterPdfFooter ? gridOptions.exporterPdfFooter : null;
+ /**
+ * @ngdoc object
+ * @name exporterPdfOrientation
+ * @propertyOf ui.grid.exporter.api:GridOptions
+ * @description The orientation, should be a valid pdfMake value,
+ * 'landscape' or 'portrait'
+ * Defaults to landscape + */ + gridOptions.exporterPdfOrientation = gridOptions.exporterPdfOrientation ? gridOptions.exporterPdfOrientation : 'landscape'; + /** + * @ngdoc object + * @name exporterPdfPageSize + * @propertyOf ui.grid.exporter.api:GridOptions + * @description The orientation, should be a valid pdfMake + * paper size, usually 'A4' or 'LETTER' + * {@link https://github.com/bpampuch/pdfmake/blob/master/src/standardPageSizes.js pdfMake page sizes} + * Defaults to A4 + */ + gridOptions.exporterPdfPageSize = gridOptions.exporterPdfPageSize ? gridOptions.exporterPdfPageSize : 'A4'; + /** + * @ngdoc object + * @name exporterPdfMaxGridWidth + * @propertyOf ui.grid.exporter.api:GridOptions + * @description The maxium grid width - the current grid width + * will be scaled to match this, with any fixed width columns + * being adjusted accordingly. + * Defaults to 720 (for A4 landscape), use 670 for LETTER + */ + gridOptions.exporterPdfMaxGridWidth = gridOptions.exporterPdfMaxGridWidth ? gridOptions.exporterPdfMaxGridWidth : 720; + /** + * @ngdoc object + * @name exporterPdfTableLayout + * @propertyOf ui.grid.exporter.api:GridOptions + * @description A tableLayout in pdfMake format, + * controls gridlines and the like. We use the default + * layout usually. + * Defaults to null, which means no layout + */ + + /** + * @ngdoc object + * @name exporterMenuAllData + * @propertyOf ui.grid.exporter.api:GridOptions + * @description Add export all data as cvs/pdf menu items to the ui-grid grid menu, if it's present. Defaults to true. + */ + gridOptions.exporterMenuAllData = gridOptions.exporterMenuAllData !== undefined ? gridOptions.exporterMenuAllData : true; + + /** + * @ngdoc object + * @name exporterMenuVisibleData + * @propertyOf ui.grid.exporter.api:GridOptions + * @description Add export visible data as cvs/pdf menu items to the ui-grid grid menu, if it's present. Defaults to true. + */ + gridOptions.exporterMenuVisibleData = gridOptions.exporterMenuVisibleData !== undefined ? gridOptions.exporterMenuVisibleData : true; + + /** + * @ngdoc object + * @name exporterMenuSelectedData + * @propertyOf ui.grid.exporter.api:GridOptions + * @description Add export selected data as cvs/pdf menu items to the ui-grid grid menu, if it's present. Defaults to true. + */ + gridOptions.exporterMenuSelectedData = gridOptions.exporterMenuSelectedData !== undefined ? gridOptions.exporterMenuSelectedData : true; + + /** + * @ngdoc object + * @name exporterMenuCsv + * @propertyOf ui.grid.exporter.api:GridOptions + * @description Add csv export menu items to the ui-grid grid menu, if it's present. Defaults to true. + */ + gridOptions.exporterMenuCsv = gridOptions.exporterMenuCsv !== undefined ? gridOptions.exporterMenuCsv : true; + + /** + * @ngdoc object + * @name exporterMenuPdf + * @propertyOf ui.grid.exporter.api:GridOptions + * @description Add pdf export menu items to the ui-grid grid menu, if it's present. Defaults to true. + */ + gridOptions.exporterMenuPdf = gridOptions.exporterMenuPdf !== undefined ? gridOptions.exporterMenuPdf : true; + + /** + * @ngdoc object + * @name exporterMenuExcel + * @propertyOf ui.grid.exporter.api:GridOptions + * @description Add excel export menu items to the ui-grid grid menu, if it's present. Defaults to true. + */ + gridOptions.exporterMenuExcel = gridOptions.exporterMenuExcel !== undefined ? gridOptions.exporterMenuExcel : true; + + /** + * @ngdoc object + * @name exporterPdfCustomFormatter + * @propertyOf ui.grid.exporter.api:GridOptions + * @description A custom callback routine that changes the pdf document, adding any + * custom styling or content that is supported by pdfMake. Takes in the complete docDefinition, and + * must return an updated docDefinition ready for pdfMake. + * @example + * In this example we add a style to the style array, so that we can use it in our + * footer definition. + *
+ * gridOptions.exporterPdfCustomFormatter = function ( docDefinition ) {
+ * docDefinition.styles.footerStyle = { bold: true, fontSize: 10 };
+ * return docDefinition;
+ * }
+ *
+ * gridOptions.exporterPdfFooter = { text: 'My footer', style: 'footerStyle' }
+ *
+ */
+ gridOptions.exporterPdfCustomFormatter = ( gridOptions.exporterPdfCustomFormatter && typeof( gridOptions.exporterPdfCustomFormatter ) === 'function' ) ? gridOptions.exporterPdfCustomFormatter : function ( docDef ) { return docDef; };
+
+ /**
+ * @ngdoc object
+ * @name exporterHeaderFilterUseName
+ * @propertyOf ui.grid.exporter.api:GridOptions
+ * @description Defaults to false, which leads to `displayName` being passed into the headerFilter.
+ * If set to true, then will pass `name` instead.
+ *
+ *
+ * @example
+ * + * gridOptions.exporterHeaderFilterUseName = true; + *+ */ + gridOptions.exporterHeaderFilterUseName = gridOptions.exporterHeaderFilterUseName === true; + + /** + * @ngdoc object + * @name exporterHeaderFilter + * @propertyOf ui.grid.exporter.api:GridOptions + * @description A function to apply to the header displayNames before exporting. Useful for internationalisation, + * for example if you were using angular-translate you'd set this to `$translate.instant`. Note that this + * call must be synchronous, it cannot be a call that returns a promise. + * + * Behaviour can be changed to pass in `name` instead of `displayName` through use of `exporterHeaderFilterUseName: true`. + * + * @example + *
+ * gridOptions.exporterHeaderFilter = function( displayName ) { return 'col: ' + name; };
+ *
+ * OR
+ * + * gridOptions.exporterHeaderFilter = $translate.instant; + *+ */ + + /** + * @ngdoc function + * @name exporterFieldCallback + * @propertyOf ui.grid.exporter.api:GridOptions + * @description A function to call for each field before exporting it. Allows + * massaging of raw data into a display format, for example if you have applied + * filters to convert codes into decodes, or you require + * a specific date format in the exported content. + * + * The method is called once for each field exported, and provides the grid, the + * gridCol and the GridRow for you to use as context in massaging the data. + * + * @param {Grid} grid provides the grid in case you have need of it + * @param {GridRow} row the row from which the data comes + * @param {GridColumn} col the column from which the data comes + * @param {object} value the value for your massaging + * @returns {object} you must return the massaged value ready for exporting + * + * @example + *
+ * gridOptions.exporterFieldCallback = function ( grid, row, col, value ) {
+ * if ( col.name === 'status' ) {
+ * value = decodeStatus( value );
+ * }
+ * return value;
+ * }
+ *
+ */
+ gridOptions.exporterFieldCallback = gridOptions.exporterFieldCallback ? gridOptions.exporterFieldCallback : defaultExporterFieldCallback;
+
+ /**
+ * @ngdoc function
+ * @name exporterFieldFormatCallback
+ * @propertyOf ui.grid.exporter.api:GridOptions
+ * @description A function to call for each field before exporting it. Allows
+ * general object to be return to modify the format of a cell in the case of
+ * excel exports
+ *
+ * The method is called once for each field exported, and provides the grid, the
+ * gridCol and the GridRow for you to use as context in massaging the data.
+ *
+ * @param {Grid} grid provides the grid in case you have need of it
+ * @param {GridRow} row the row from which the data comes
+ * @param {GridColumn} col the column from which the data comes
+ * @param {object} value the value for your massaging
+ * @returns {object} you must return the massaged value ready for exporting
+ *
+ * @example
+ *
+ * gridOptions.exporterFieldCallback = function ( grid, row, col, value ) {
+ * if ( col.name === 'status' ) {
+ * value = decodeStatus( value );
+ * }
+ * return value;
+ * }
+ *
+ */
+ gridOptions.exporterFieldFormatCallback = gridOptions.exporterFieldFormatCallback ? gridOptions.exporterFieldFormatCallback : function( grid, row, col, value ) { return null; };
+
+ /**
+ * @ngdoc function
+ * @name exporterExcelCustomFormatters
+ * @propertyOf ui.grid.exporter.api:GridOptions
+ * @description A function to call to setup formatters and store on docDefinition.
+ *
+ * The method is called at the start and can setup all the formatters to export to excel
+ *
+ * @param {Grid} grid provides the grid in case you have need of it
+ * @param {Workbook} row the row from which the data comes
+ * @param {docDefinition} The docDefinition that will have styles as a object to store formatters
+ * @returns {docDefinition} Updated docDefinition with formatter styles
+ *
+ * @example
+ *
+ * gridOptions.exporterExcelCustomFormatters = function(grid, workbook, docDefinition) {
+ * const formatters = {};
+ * const stylesheet = workbook.getStyleSheet();
+ * const headerFormatDefn = {
+ * 'font': { 'size': 11, 'fontName': 'Calibri', 'bold': true },
+ * 'alignment': { 'wrapText': false }
+ * };
+ *
+ * formatters['header'] = headerFormatter;
+ * Object.assign(docDefinition.styles , formatters);
+ * grid.docDefinition = docDefinition;
+ * return docDefinition;
+ * }
+ *
+ */
+ gridOptions.exporterExcelCustomFormatters = gridOptions.exporterExcelCustomFormatters ? gridOptions.exporterExcelCustomFormatters : function( grid, workbook, docDefinition ) { return docDefinition; };
+
+ /**
+ * @ngdoc function
+ * @name exporterExcelHeader
+ * @propertyOf ui.grid.exporter.api:GridOptions
+ * @description A function to write formatted header data to sheet.
+ *
+ * The method is called to provide custom header building for Excel. This data comes before the grid header
+ *
+ * @param {grid} grid provides the grid in case you have need of it
+ * @param {Workbook} row the row from which the data comes
+ * @param {Sheet} the sheet to insert data
+ * @param {docDefinition} The docDefinition that will have styles as a object to store formatters
+ * @returns {docDefinition} Updated docDefinition with formatter styles
+ *
+ * @example
+ *
+ * gridOptions.exporterExcelCustomFormatters = function (grid, workbook, sheet, docDefinition) {
+ * const headerFormatter = docDefinition.styles['header'];
+ * let cols = [];
+ * // push data in A1 cell with metadata formatter
+ * cols.push({ value: 'Summary Report', metadata: {style: headerFormatter.id} });
+ * sheet.data.push(cols);
+ * }
+ *
+ */
+ gridOptions.exporterExcelHeader = gridOptions.exporterExcelHeader ? gridOptions.exporterExcelHeader : function( grid, workbook, sheet, docDefinition ) { return null; };
+
+
+ /**
+ * @ngdoc object
+ * @name exporterColumnScaleFactor
+ * @propertyOf ui.grid.exporter.api:GridOptions
+ * @description A scaling factor to divide the drawnwidth of a column to convert to target excel column
+ * format size
+ * @example
+ * In this example we add a number to divide the drawnwidth of a column to get the excel width.
+ * Defaults to 3.5 + */ + gridOptions.exporterColumnScaleFactor = gridOptions.exporterColumnScaleFactor ? gridOptions.exporterColumnScaleFactor : 3.5; + + /** + * @ngdoc object + * @name exporterFieldApplyFilters + * @propertyOf ui.grid.exporter.api:GridOptions + * @description Defaults to false, which leads to filters being evaluated on export * + * + * @example + * + * gridOptions.exporterFieldApplyFilters = true; + *+ */ + gridOptions.exporterFieldApplyFilters = gridOptions.exporterFieldApplyFilters === true; + + /** + * @ngdoc function + * @name exporterAllDataFn + * @propertyOf ui.grid.exporter.api:GridOptions + * @description This promise is needed when exporting all rows, + * and the data need to be provided by server side. Default is null. + * @returns {Promise} a promise to load all data from server + * + * @example + *
+ * gridOptions.exporterAllDataFn = function () {
+ * return $http.get('/data/100.json')
+ * }
+ *
+ */
+ gridOptions.exporterAllDataFn = gridOptions.exporterAllDataFn ? gridOptions.exporterAllDataFn : null;
+
+ /**
+ * @ngdoc function
+ * @name exporterAllDataPromise
+ * @propertyOf ui.grid.exporter.api:GridOptions
+ * @description DEPRECATED - exporterAllDataFn used to be
+ * called this, but it wasn't a promise, it was a function that returned
+ * a promise. Deprecated, but supported for backward compatibility, use
+ * exporterAllDataFn instead.
+ * @returns {Promise} a promise to load all data from server
+ *
+ * @example
+ *
+ * gridOptions.exporterAllDataFn = function () {
+ * return $http.get('/data/100.json')
+ * }
+ *
+ */
+ if ( gridOptions.exporterAllDataFn === null && gridOptions.exporterAllDataPromise ) {
+ gridOptions.exporterAllDataFn = gridOptions.exporterAllDataPromise;
+ }
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name addToMenu
+ * @methodOf ui.grid.exporter.service:uiGridExporterService
+ * @description Adds export items to the grid menu,
+ * allowing the user to select export options
+ * @param {Grid} grid the grid from which data should be exported
+ */
+ addToMenu: function ( grid ) {
+ grid.api.core.addToGridMenu( grid, [
+ {
+ title: i18nService.getSafeText('gridMenu.exporterAllAsCsv'),
+ action: function () {
+ grid.api.exporter.csvExport( uiGridExporterConstants.ALL, uiGridExporterConstants.ALL );
+ },
+ shown: function() {
+ return grid.options.exporterMenuCsv && grid.options.exporterMenuAllData;
+ },
+ order: grid.options.exporterMenuItemOrder
+ },
+ {
+ title: i18nService.getSafeText('gridMenu.exporterVisibleAsCsv'),
+ action: function () {
+ grid.api.exporter.csvExport( uiGridExporterConstants.VISIBLE, uiGridExporterConstants.VISIBLE );
+ },
+ shown: function() {
+ return grid.options.exporterMenuCsv && grid.options.exporterMenuVisibleData;
+ },
+ order: grid.options.exporterMenuItemOrder + 1
+ },
+ {
+ title: i18nService.getSafeText('gridMenu.exporterSelectedAsCsv'),
+ action: function () {
+ grid.api.exporter.csvExport( uiGridExporterConstants.SELECTED, uiGridExporterConstants.VISIBLE );
+ },
+ shown: function() {
+ return grid.options.exporterMenuCsv && grid.options.exporterMenuSelectedData &&
+ ( grid.api.selection && grid.api.selection.getSelectedRows().length > 0 );
+ },
+ order: grid.options.exporterMenuItemOrder + 2
+ },
+ {
+ title: i18nService.getSafeText('gridMenu.exporterAllAsPdf'),
+ action: function () {
+ grid.api.exporter.pdfExport( uiGridExporterConstants.ALL, uiGridExporterConstants.ALL );
+ },
+ shown: function() {
+ return grid.options.exporterMenuPdf && grid.options.exporterMenuAllData;
+ },
+ order: grid.options.exporterMenuItemOrder + 3
+ },
+ {
+ title: i18nService.getSafeText('gridMenu.exporterVisibleAsPdf'),
+ action: function () {
+ grid.api.exporter.pdfExport( uiGridExporterConstants.VISIBLE, uiGridExporterConstants.VISIBLE );
+ },
+ shown: function() {
+ return grid.options.exporterMenuPdf && grid.options.exporterMenuVisibleData;
+ },
+ order: grid.options.exporterMenuItemOrder + 4
+ },
+ {
+ title: i18nService.getSafeText('gridMenu.exporterSelectedAsPdf'),
+ action: function () {
+ grid.api.exporter.pdfExport( uiGridExporterConstants.SELECTED, uiGridExporterConstants.VISIBLE );
+ },
+ shown: function() {
+ return grid.options.exporterMenuPdf && grid.options.exporterMenuSelectedData &&
+ ( grid.api.selection && grid.api.selection.getSelectedRows().length > 0 );
+ },
+ order: grid.options.exporterMenuItemOrder + 5
+ },
+ {
+ title: i18nService.getSafeText('gridMenu.exporterAllAsExcel'),
+ action: function () {
+ grid.api.exporter.excelExport( uiGridExporterConstants.ALL, uiGridExporterConstants.ALL );
+ },
+ shown: function() {
+ return grid.options.exporterMenuExcel && grid.options.exporterMenuAllData;
+ },
+ order: grid.options.exporterMenuItemOrder + 6
+ },
+ {
+ title: i18nService.getSafeText('gridMenu.exporterVisibleAsExcel'),
+ action: function () {
+ grid.api.exporter.excelExport( uiGridExporterConstants.VISIBLE, uiGridExporterConstants.VISIBLE );
+ },
+ shown: function() {
+ return grid.options.exporterMenuExcel && grid.options.exporterMenuVisibleData;
+ },
+ order: grid.options.exporterMenuItemOrder + 7
+ },
+ {
+ title: i18nService.getSafeText('gridMenu.exporterSelectedAsExcel'),
+ action: function () {
+ grid.api.exporter.excelExport( uiGridExporterConstants.SELECTED, uiGridExporterConstants.VISIBLE );
+ },
+ shown: function() {
+ return grid.options.exporterMenuExcel && grid.options.exporterMenuSelectedData &&
+ ( grid.api.selection && grid.api.selection.getSelectedRows().length > 0 );
+ },
+ order: grid.options.exporterMenuItemOrder + 8
+ }
+ ]);
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name csvExport
+ * @methodOf ui.grid.exporter.service:uiGridExporterService
+ * @description Exports rows from the grid in csv format,
+ * the data exported is selected based on the provided options
+ * @param {Grid} grid the grid from which data should be exported
+ * @param {string} rowTypes which rows to export, valid values are
+ * uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE,
+ * uiGridExporterConstants.SELECTED
+ * @param {string} colTypes which columns to export, valid values are
+ * uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE,
+ * uiGridExporterConstants.SELECTED
+ */
+ csvExport: function (grid, rowTypes, colTypes) {
+ var self = this;
+ this.loadAllDataIfNeeded(grid, rowTypes, colTypes).then(function() {
+ var exportColumnHeaders = grid.options.showHeader ? self.getColumnHeaders(grid, colTypes) : [];
+ var exportData = self.getData(grid, rowTypes, colTypes);
+ var csvContent = self.formatAsCsv(exportColumnHeaders, exportData, grid.options.exporterCsvColumnSeparator);
+
+ self.downloadFile (grid.options.exporterCsvFilename, csvContent, grid.options.exporterCsvColumnSeparator, grid.options.exporterOlderExcelCompatibility, grid.options.exporterIsExcelCompatible);
+ });
+ },
+
+ /**
+ * @ngdoc function
+ * @name loadAllDataIfNeeded
+ * @methodOf ui.grid.exporter.service:uiGridExporterService
+ * @description When using server side pagination, use exporterAllDataFn to
+ * load all data before continuing processing.
+ * When using client side pagination, return a resolved promise so processing
+ * continues immediately
+ * @param {Grid} grid the grid from which data should be exported
+ * @param {string} rowTypes which rows to export, valid values are
+ * uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE,
+ * uiGridExporterConstants.SELECTED
+ * @param {string} colTypes which columns to export, valid values are
+ * uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE,
+ * uiGridExporterConstants.SELECTED
+ */
+ loadAllDataIfNeeded: function (grid, rowTypes, colTypes) {
+ if ( rowTypes === uiGridExporterConstants.ALL && grid.rows.length !== grid.options.totalItems && grid.options.exporterAllDataFn) {
+ return grid.options.exporterAllDataFn()
+ .then(function(allData) {
+ grid.modifyRows(allData);
+ });
+ } else {
+ var deferred = $q.defer();
+ deferred.resolve();
+ return deferred.promise;
+ }
+ },
+
+ /**
+ * @ngdoc property
+ * @propertyOf ui.grid.exporter.api:ColumnDef
+ * @name exporterSuppressExport
+ * @description Suppresses export for this column. Used by selection and expandable.
+ */
+
+ /**
+ * @ngdoc function
+ * @name getColumnHeaders
+ * @methodOf ui.grid.exporter.service:uiGridExporterService
+ * @description Gets the column headers from the grid to use
+ * as a title row for the exported file, all headers have
+ * headerCellFilters applied as appropriate.
+ *
+ * Column headers are an array of objects, each object has
+ * name, displayName, width and align attributes. Only name is
+ * used for csv, all attributes are used for pdf.
+ *
+ * @param {Grid} grid the grid from which data should be exported
+ * @param {string} colTypes which columns to export, valid values are
+ * uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE,
+ * uiGridExporterConstants.SELECTED
+ */
+ getColumnHeaders: function (grid, colTypes) {
+ var headers = [],
+ columns;
+
+ if ( colTypes === uiGridExporterConstants.ALL ) {
+ columns = grid.columns;
+ } else {
+ var leftColumns = grid.renderContainers.left ? grid.renderContainers.left.visibleColumnCache.filter( function( column ) { return column.visible; } ) : [],
+ bodyColumns = grid.renderContainers.body ? grid.renderContainers.body.visibleColumnCache.filter( function( column ) { return column.visible; } ) : [],
+ rightColumns = grid.renderContainers.right ? grid.renderContainers.right.visibleColumnCache.filter( function( column ) { return column.visible; } ) : [];
+
+ columns = leftColumns.concat(bodyColumns, rightColumns);
+ }
+
+ columns.forEach( function( gridCol ) {
+ // $$hashKey check since when grouping and sorting pragmatically this ends up in export. Filtering it out
+ if ( gridCol.colDef.exporterSuppressExport !== true && gridCol.field !== '$$hashKey' &&
+ grid.options.exporterSuppressColumns.indexOf( gridCol.name ) === -1 ) {
+ var headerEntry = {
+ name: gridCol.field,
+ displayName: getDisplayName(grid, gridCol),
+ width: gridCol.drawnWidth ? gridCol.drawnWidth : gridCol.width,
+ align: gridCol.colDef.align ? gridCol.colDef.align : (gridCol.colDef.type === 'number' ? 'right' : 'left')
+ };
+
+ headers.push(headerEntry);
+ }
+ });
+
+ return headers;
+ },
+
+ /**
+ * @ngdoc property
+ * @propertyOf ui.grid.exporter.api:ColumnDef
+ * @name exporterPdfAlign
+ * @description the alignment you'd like for this specific column when
+ * exported into a pdf. Can be 'left', 'right', 'center' or any other
+ * valid pdfMake alignment option.
+ */
+
+ /**
+ * @ngdoc object
+ * @name ui.grid.exporter.api:GridRow
+ * @description GridRow settings for exporter
+ */
+
+ /**
+ * @ngdoc object
+ * @name exporterEnableExporting
+ * @propertyOf ui.grid.exporter.api:GridRow
+ * @description If set to false, then don't export this row, notwithstanding visible or
+ * other settings
+ * Defaults to true + */ + + /** + * @ngdoc function + * @name getRowsFromNode + * @methodOf ui.grid.exporter.service:uiGridExporterService + * @description Gets rows from a node. If the node is grouped it will + * recurse down into the children to get to the raw data element + * which is a row without children (a leaf). + * @param {Node} aNode the tree node on the grid + * @returns {Array} an array with all child nodes from aNode + */ + getRowsFromNode: function(aNode) { + var rows = []; + + // Push parent node if it is not undefined and has values other than 'children' + var nodeKeys = aNode ? Object.keys(aNode) : ['children']; + if (nodeKeys.length > 1 || nodeKeys[0] != 'children') { + rows.push(aNode); + } + + if (aNode && aNode.children && aNode.children.length > 0) { + for (var i = 0; i < aNode.children.length; i++) { + rows = rows.concat(this.getRowsFromNode(aNode.children[i])); + } + } + return rows; + }, + /** + * @ngdoc function + * @name getDataSorted + * @methodOf ui.grid.exporter.service:uiGridExporterService + * @description Gets rows from a node. If the node is grouped it will + * recurse down into the children to get to the raw data element + * which is a row without children (a leaf). If the grid is not + * grouped this will return just the raw rows + * @param {Grid} grid the grid from which data should be exported + * @returns {Array} an array of leaf nodes + */ + getDataSorted: function (grid) { + if (!grid.treeBase || grid.treeBase.numberLevels === 0) { + return grid.rows; + } + var rows = []; + + for (var i = 0; i< grid.treeBase.tree.length; i++) { + var nodeRows = this.getRowsFromNode(grid.treeBase.tree[i]); + + for (var j = 0; j
+
+
+ Beta This feature is ready for testing, but it either hasn't seen a lot of use or has some known bugs.
+ *
+ * This module provides grouping of rows based on the data in them, similar
+ * in concept to excel grouping. You can group multiple columns, resulting in
+ * nested grouping.
+ *
+ * In concept this feature is similar to sorting + grid footer/aggregation, it
+ * sorts the data based on the grouped columns, then creates group rows that
+ * reflect a break in the data. Each of those group rows can have aggregations for
+ * the data within that group.
+ *
+ * This feature leverages treeBase to provide the tree functionality itself,
+ * the key thing this feature does therefore is to set treeLevels on the rows
+ * and insert the group headers.
+ *
+ * Design information:
+ * -------------------
+ *
+ * Each column will get new menu items - group by, and aggregate by. Group by
+ * will cause this column to be sorted (if not already), and will move this column
+ * to the front of the sorted columns (i.e. grouped columns take precedence over
+ * sorted columns). It will respect the sort order already set if there is one,
+ * and it will allow the sorting logic to change that sort order, it just forces
+ * the column to the front of the sorting. You can group by multiple columns, the
+ * logic will add this column to the sorting after any already grouped columns.
+ *
+ * Once a grouping is defined, grouping logic is added to the rowsProcessors. This
+ * will process the rows, identifying a break in the data value, and inserting a grouping row.
+ * Grouping rows have specific attributes on them:
+ *
+ * - internalRow = true: tells us that this isn't a real row, so we can ignore it
+ * from any processing that it looking at core data rows. This is used by the core
+ * logic (or will be one day), as it's not grouping specific
+ * - groupHeader = true: tells us this is a groupHeader. This is used by the grouping logic
+ * to know if this is a groupHeader row or not
+ *
+ * Since the logic is baked into the rowsProcessors, it should get triggered whenever
+ * row order or filtering or anything like that is changed. In order to avoid the row instantiation
+ * time, and to preserve state across invocations, we hold a cache of the rows that we created
+ * last time, and we use them again this time if we can.
+ *
+ * By default rows are collapsed, which means all data rows have their visible property
+ * set to false, and only level 0 group rows are set to visible.
+ *
+ * + * + * + * + */ + + var module = angular.module('ui.grid.grouping', ['ui.grid', 'ui.grid.treeBase']); + + /** + * @ngdoc object + * @name ui.grid.grouping.constant:uiGridGroupingConstants + * + * @description constants available in grouping module, this includes + * all the constants declared in the treeBase module (these are manually copied + * as there isn't an easy way to include constants in another constants file, and + * we don't want to make users include treeBase) + * + */ + module.constant('uiGridGroupingConstants', { + featureName: "grouping", + rowHeaderColName: 'treeBaseRowHeaderCol', + EXPANDED: 'expanded', + COLLAPSED: 'collapsed', + aggregation: { + COUNT: 'count', + SUM: 'sum', + MAX: 'max', + MIN: 'min', + AVG: 'avg' + } + }); + + /** + * @ngdoc service + * @name ui.grid.grouping.service:uiGridGroupingService + * + * @description Services for grouping features + */ + module.service('uiGridGroupingService', ['$q', 'uiGridGroupingConstants', 'gridUtil', 'rowSorter', 'GridRow', 'gridClassFactory', 'i18nService', 'uiGridConstants', 'uiGridTreeBaseService', + function ($q, uiGridGroupingConstants, gridUtil, rowSorter, GridRow, gridClassFactory, i18nService, uiGridConstants, uiGridTreeBaseService) { + var service = { + initializeGrid: function (grid, $scope) { + uiGridTreeBaseService.initializeGrid( grid, $scope ); + + // add feature namespace and any properties to grid for needed + /** + * @ngdoc object + * @name ui.grid.grouping.grid:grouping + * + * @description Grid properties and functions added for grouping + */ + grid.grouping = {}; + + /** + * @ngdoc property + * @propertyOf ui.grid.grouping.grid:grouping + * @name groupHeaderCache + * + * @description Cache that holds the group header rows we created last time, we'll + * reuse these next time, not least because they hold our expanded states. + * + * We need to take care with these that they don't become a memory leak, we + * create a new cache each time using the values from the old cache. This works + * so long as we're creating group rows for invisible rows as well. + * + * The cache is a nested hash, indexed on the value we grouped by. So if we + * grouped by gender then age, we'd maybe have something like: + * ``` + * { + * male: { + * row:
+ * gridApi.grouping.on.aggregationChanged(scope,function(col) {})
+ *
+ * @param {GridColumn} col the column on which aggregation changed. The aggregation
+ * type is available as `col.treeAggregation.type`
+ */
+ aggregationChanged: {},
+ /**
+ * @ngdoc event
+ * @eventOf ui.grid.grouping.api:PublicApi
+ * @name groupingChanged
+ * @description raised whenever the grouped columns changes
+ *
+ *
+ * gridApi.grouping.on.groupingChanged(scope,function(col) {})
+ *
+ * @param {GridColumn} col the column on which grouping changed. The new grouping is
+ * available as `col.grouping`
+ */
+ groupingChanged: {}
+ }
+ },
+ methods: {
+ grouping: {
+ /**
+ * @ngdoc function
+ * @name getGrouping
+ * @methodOf ui.grid.grouping.api:PublicApi
+ * @description Get the grouping configuration for this grid,
+ * used by the saveState feature. Adds expandedState to the information
+ * provided by the internal getGrouping, and removes any aggregations that have a source
+ * of grouping (i.e. will be automatically reapplied when we regroup the column)
+ * Returned grouping is an object
+ * `{ grouping: groupArray, treeAggregations: aggregateArray, expandedState: hash }`
+ * where grouping contains an array of objects:
+ * `{ field: column.field, colName: column.name, groupPriority: column.grouping.groupPriority }`
+ * and aggregations contains an array of objects:
+ * `{ field: column.field, colName: column.name, aggregation: column.grouping.aggregation }`
+ * and expandedState is a hash of the currently expanded nodes
+ *
+ * The groupArray will be sorted by groupPriority.
+ *
+ * @param {boolean} getExpanded whether or not to return the expanded state
+ * @returns {object} grouping configuration
+ */
+ getGrouping: function ( getExpanded ) {
+ var grouping = service.getGrouping(grid);
+
+ grouping.grouping.forEach( function( group ) {
+ group.colName = group.col.name;
+ delete group.col;
+ });
+
+ grouping.aggregations.forEach( function( aggregation ) {
+ aggregation.colName = aggregation.col.name;
+ delete aggregation.col;
+ });
+
+ grouping.aggregations = grouping.aggregations.filter( function( aggregation ) {
+ return !aggregation.aggregation.source || aggregation.aggregation.source !== 'grouping';
+ });
+
+ if ( getExpanded ) {
+ grouping.rowExpandedStates = service.getRowExpandedStates( grid.grouping.groupingHeaderCache );
+ }
+
+ return grouping;
+ },
+
+ /**
+ * @ngdoc function
+ * @name setGrouping
+ * @methodOf ui.grid.grouping.api:PublicApi
+ * @description Set the grouping configuration for this grid,
+ * used by the saveState feature, but can also be used by any
+ * user to specify a combined grouping and aggregation configuration
+ * @param {object} config the config you want to apply, in the format
+ * provided out by getGrouping
+ */
+ setGrouping: function ( config ) {
+ service.setGrouping(grid, config);
+ },
+
+ /**
+ * @ngdoc function
+ * @name groupColumn
+ * @methodOf ui.grid.grouping.api:PublicApi
+ * @description Adds this column to the existing grouping, at the end of the priority order.
+ * If the column doesn't have a sort, adds one, by default ASC
+ *
+ * This column will move to the left of any non-group columns, the
+ * move is handled in a columnProcessor, so gets called as part of refresh
+ *
+ * @param {string} columnName the name of the column we want to group
+ */
+ groupColumn: function(columnName) {
+ var column = grid.getColumn(columnName);
+
+ service.groupColumn(grid, column);
+ },
+
+ /**
+ * @ngdoc function
+ * @name ungroupColumn
+ * @methodOf ui.grid.grouping.api:PublicApi
+ * @description Removes the groupPriority from this column. If the
+ * column was previously aggregated the aggregation will come back.
+ * The sort will remain.
+ *
+ * This column will move to the right of any other group columns, the
+ * move is handled in a columnProcessor, so gets called as part of refresh
+ *
+ * @param {string} columnName the name of the column we want to ungroup
+ */
+ ungroupColumn: function(columnName) {
+ var column = grid.getColumn(columnName);
+
+ service.ungroupColumn(grid, column);
+ },
+
+ /**
+ * @ngdoc function
+ * @name clearGrouping
+ * @methodOf ui.grid.grouping.api:PublicApi
+ * @description Clear any grouped columns and any aggregations. Doesn't remove sorting,
+ * as we don't know whether that sorting was added by grouping or was there beforehand
+ *
+ */
+ clearGrouping: function() {
+ service.clearGrouping(grid);
+ },
+
+ /**
+ * @ngdoc function
+ * @name aggregateColumn
+ * @methodOf ui.grid.grouping.api:PublicApi
+ * @description Sets the aggregation type on a column, if the
+ * column is currently grouped then it removes the grouping first.
+ * If the aggregationDef is null then will result in the aggregation
+ * being removed
+ *
+ * @param {string} columnName the column we want to aggregate
+ * @param {string|function} aggregationDef one of the recognised types
+ * from uiGridGroupingConstants or a custom aggregation function.
+ * @param {string} aggregationLabel (optional) The label to use for this aggregation.
+ */
+ aggregateColumn: function(columnName, aggregationDef, aggregationLabel) {
+ var column = grid.getColumn(columnName);
+
+ service.aggregateColumn(grid, column, aggregationDef, aggregationLabel);
+ }
+ }
+ }
+ };
+
+ grid.api.registerEventsFromObject(publicApi.events);
+
+ grid.api.registerMethodsFromObject(publicApi.methods);
+
+ grid.api.core.on.sortChanged($scope, service.tidyPriorities);
+ },
+
+ defaultGridOptions: function (gridOptions) {
+ // default option to true unless it was explicitly set to false
+ /**
+ * @ngdoc object
+ * @name ui.grid.grouping.api:GridOptions
+ *
+ * @description GridOptions for grouping feature, these are available to be
+ * set using the ui-grid {@link ui.grid.class:GridOptions gridOptions}
+ */
+
+ /**
+ * @ngdoc object
+ * @name enableGrouping
+ * @propertyOf ui.grid.grouping.api:GridOptions
+ * @description Enable row grouping for entire grid.
+ * Defaults to true + */ + gridOptions.enableGrouping = gridOptions.enableGrouping !== false; + + /** + * @ngdoc object + * @name groupingShowCounts + * @propertyOf ui.grid.grouping.api:GridOptions + * @description shows counts on the groupHeader rows. Not that if you are using a cellFilter or a + * sortingAlgorithm which relies on a specific format or data type, showing counts may cause that + * to break, since the group header rows will always be a string with groupingShowCounts enabled. + * Defaults to true except on columns of types 'date' and 'object' + */ + gridOptions.groupingShowCounts = gridOptions.groupingShowCounts !== false; + + /** + * @ngdoc object + * @name groupingNullLabel + * @propertyOf ui.grid.grouping.api:GridOptions + * @description The string to use for the grouping header row label on rows which contain a null or undefined value in the grouped column. + * Defaults to "Null" + */ + gridOptions.groupingNullLabel = typeof(gridOptions.groupingNullLabel) === 'undefined' ? 'Null' : gridOptions.groupingNullLabel; + + /** + * @ngdoc object + * @name enableGroupHeaderSelection + * @propertyOf ui.grid.grouping.api:GridOptions + * @description Allows group header rows to be selected. + * Defaults to false + */ + gridOptions.enableGroupHeaderSelection = gridOptions.enableGroupHeaderSelection === true; + }, + + + /** + * @ngdoc function + * @name groupingColumnBuilder + * @methodOf ui.grid.grouping.service:uiGridGroupingService + * @description Sets the grouping defaults based on the columnDefs + * + * @param {object} colDef columnDef we're basing on + * @param {GridColumn} col the column we're to update + * @param {object} gridOptions the options we should use + * @returns {promise} promise for the builder - actually we do it all inline so it's immediately resolved + */ + groupingColumnBuilder: function (colDef, col, gridOptions) { + /** + * @ngdoc object + * @name ui.grid.grouping.api:ColumnDef + * + * @description ColumnDef for grouping feature, these are available to be + * set using the ui-grid {@link ui.grid.class:GridOptions.columnDef gridOptions.columnDefs} + */ + + /** + * @ngdoc object + * @name enableGrouping + * @propertyOf ui.grid.grouping.api:ColumnDef + * @description Enable grouping on this column + * Defaults to true. + */ + if (colDef.enableGrouping === false) { + return; + } + + /** + * @ngdoc object + * @name grouping + * @propertyOf ui.grid.grouping.api:ColumnDef + * @description Set the grouping for a column. Format is: + * ``` + * { + * groupPriority: Defaults to undefined. + */ + + if ( typeof(col.grouping) === 'undefined' && typeof(colDef.grouping) !== 'undefined') { + col.grouping = angular.copy(colDef.grouping); + if ( typeof(col.grouping.groupPriority) !== 'undefined' && col.grouping.groupPriority > -1 ) { + col.treeAggregationFn = uiGridTreeBaseService.nativeAggregations()[uiGridGroupingConstants.aggregation.COUNT].aggregationFn; + col.treeAggregationFinalizerFn = service.groupedFinalizerFn; + } + } else if (typeof(col.grouping) === 'undefined') { + col.grouping = {}; + } + + if (typeof(col.grouping) !== 'undefined' && typeof(col.grouping.groupPriority) !== 'undefined' && col.grouping.groupPriority >= 0) { + col.suppressRemoveSort = true; + } + + var groupColumn = { + name: 'ui.grid.grouping.group', + title: i18nService.get().grouping.group, + icon: 'ui-grid-icon-indent-right', + shown: function () { + return typeof(this.context.col.grouping) === 'undefined' || + typeof(this.context.col.grouping.groupPriority) === 'undefined' || + this.context.col.grouping.groupPriority < 0; + }, + action: function () { + service.groupColumn( this.context.col.grid, this.context.col ); + } + }; + + var ungroupColumn = { + name: 'ui.grid.grouping.ungroup', + title: i18nService.get().grouping.ungroup, + icon: 'ui-grid-icon-indent-left', + shown: function () { + return typeof(this.context.col.grouping) !== 'undefined' && + typeof(this.context.col.grouping.groupPriority) !== 'undefined' && + this.context.col.grouping.groupPriority >= 0; + }, + action: function () { + service.ungroupColumn( this.context.col.grid, this.context.col ); + } + }; + + var aggregateRemove = { + name: 'ui.grid.grouping.aggregateRemove', + title: i18nService.get().grouping.aggregate_remove, + shown: function () { + return typeof(this.context.col.treeAggregationFn) !== 'undefined'; + }, + action: function () { + service.aggregateColumn( this.context.col.grid, this.context.col, null); + } + }; + + // generic adder for the aggregation menus, which follow a pattern + var addAggregationMenu = function(type, title) { + title = title || i18nService.get().grouping['aggregate_' + type] || type; + var menuItem = { + name: 'ui.grid.grouping.aggregate' + type, + title: title, + shown: function () { + return typeof(this.context.col.treeAggregation) === 'undefined' || + typeof(this.context.col.treeAggregation.type) === 'undefined' || + this.context.col.treeAggregation.type !== type; + }, + action: function () { + service.aggregateColumn( this.context.col.grid, this.context.col, type); + } + }; + + if (!gridUtil.arrayContainsObjectWithProperty(col.menuItems, 'name', 'ui.grid.grouping.aggregate' + type)) { + col.menuItems.push(menuItem); + } + }; + + /** + * @ngdoc object + * @name groupingShowGroupingMenu + * @propertyOf ui.grid.grouping.api:ColumnDef + * @description Show the grouping (group and ungroup items) menu on this column + * Defaults to true. + */ + if ( col.colDef.groupingShowGroupingMenu !== false ) { + if (!gridUtil.arrayContainsObjectWithProperty(col.menuItems, 'name', 'ui.grid.grouping.group')) { + col.menuItems.push(groupColumn); + } + + if (!gridUtil.arrayContainsObjectWithProperty(col.menuItems, 'name', 'ui.grid.grouping.ungroup')) { + col.menuItems.push(ungroupColumn); + } + } + + + /** + * @ngdoc object + * @name groupingShowAggregationMenu + * @propertyOf ui.grid.grouping.api:ColumnDef + * @description Show the aggregation menu on this column + * Defaults to true. + */ + if ( col.colDef.groupingShowAggregationMenu !== false ) { + angular.forEach(uiGridTreeBaseService.nativeAggregations(), function(aggregationDef, name) { + addAggregationMenu(name); + }); + angular.forEach(gridOptions.treeCustomAggregations, function(aggregationDef, name) { + addAggregationMenu(name, aggregationDef.menuTitle); + }); + + if (!gridUtil.arrayContainsObjectWithProperty(col.menuItems, 'name', 'ui.grid.grouping.aggregateRemove')) { + col.menuItems.push(aggregateRemove); + } + } + }, + + + + + /** + * @ngdoc function + * @name groupingColumnProcessor + * @methodOf ui.grid.grouping.service:uiGridGroupingService + * @description Moves the columns around based on which are grouped + * + * @param {array} columns the columns to consider rendering + * @param {array} rows the grid rows, which we don't use but are passed to us + * @returns {array} updated columns array + */ + groupingColumnProcessor: function( columns, rows ) { + columns = service.moveGroupColumns(this, columns, rows); + return columns; + }, + + /** + * @ngdoc function + * @name groupedFinalizerFn + * @methodOf ui.grid.grouping.service:uiGridGroupingService + * @description Used on group columns to display the rendered value and optionally + * display the count of rows. + * + * @param {aggregation} aggregation The aggregation entity for a grouped column + */ + groupedFinalizerFn: function( aggregation ) { + var col = this; + + if ( typeof(aggregation.groupVal) !== 'undefined') { + aggregation.rendered = aggregation.groupVal; + if ( col.grid.options.groupingShowCounts && col.colDef.type !== 'date' && col.colDef.type !== 'object' ) { + aggregation.rendered += (' (' + aggregation.value + ')'); + } + } else { + aggregation.rendered = null; + } + }, + + /** + * @ngdoc function + * @name moveGroupColumns + * @methodOf ui.grid.grouping.service:uiGridGroupingService + * @description Moves the column order so that the grouped columns are lined up + * to the left (well, unless you're RTL, then it's the right). By doing this in + * the columnsProcessor, we make it transient - when the column is ungrouped it'll + * go back to where it was. + * + * Does nothing if the option `moveGroupColumns` is set to false. + * + * @param {Grid} grid grid object + * @param {array} columns the columns that we should process/move + * @returns {array} updated columns + */ + moveGroupColumns: function( grid, columns ) { + if ( grid.options.moveGroupColumns === false) { + return columns; + } + + columns.forEach(function(column, index) { + // position used to make stable sort in moveGroupColumns + column.groupingPosition = index; + }); + + columns.sort(function(a, b) { + var a_group, b_group; + + if (a.isRowHeader) { + a_group = a.headerPriority; + } + else if ( typeof(a.grouping) === 'undefined' || typeof(a.grouping.groupPriority) === 'undefined' || a.grouping.groupPriority < 0) { + a_group = null; + } + else { + a_group = a.grouping.groupPriority; + } + + if (b.isRowHeader) { + b_group = b.headerPriority; + } + else if ( typeof(b.grouping) === 'undefined' || typeof(b.grouping.groupPriority) === 'undefined' || b.grouping.groupPriority < 0) { + b_group = null; + } + else { + b_group = b.grouping.groupPriority; + } + + // groups get sorted to the top + if ( a_group !== null && b_group === null) { return -1; } + if ( b_group !== null && a_group === null) { return 1; } + if ( a_group !== null && b_group !== null) {return a_group - b_group; } + + return a.groupingPosition - b.groupingPosition; + }); + + columns.forEach( function(column) { + delete column.groupingPosition; + }); + + return columns; + }, + + + /** + * @ngdoc function + * @name groupColumn + * @methodOf ui.grid.grouping.service:uiGridGroupingService + * @description Adds this column to the existing grouping, at the end of the priority order. + * If the column doesn't have a sort, adds one, by default ASC + * + * This column will move to the left of any non-group columns, the + * move is handled in a columnProcessor, so gets called as part of refresh + * + * @param {Grid} grid grid object + * @param {GridColumn} column the column we want to group + */ + groupColumn: function( grid, column) { + if ( typeof(column.grouping) === 'undefined' ) { + column.grouping = {}; + } + + // set the group priority to the next number in the hierarchy + var existingGrouping = service.getGrouping( grid ); + column.grouping.groupPriority = existingGrouping.grouping.length; + + // save sort in order to restore it when column is ungrouped + column.previousSort = angular.copy(column.sort); + + // add sort if not present + if ( !column.sort ) { + column.sort = { direction: uiGridConstants.ASC }; + } else if ( typeof(column.sort.direction) === 'undefined' || column.sort.direction === null ) { + column.sort.direction = uiGridConstants.ASC; + } + + column.treeAggregation = { type: uiGridGroupingConstants.aggregation.COUNT, source: 'grouping' }; + + if ( column.colDef && angular.isFunction(column.colDef.customTreeAggregationFn) ) { + column.treeAggregationFn = column.colDef.customTreeAggregationFn; + } else { + column.treeAggregationFn = uiGridTreeBaseService.nativeAggregations()[uiGridGroupingConstants.aggregation.COUNT].aggregationFn; + } + + column.treeAggregationFinalizerFn = service.groupedFinalizerFn; + + grid.api.grouping.raise.groupingChanged(column); + // This indirectly calls service.tidyPriorities( grid ); + grid.api.core.raise.sortChanged(grid, grid.getColumnSorting()); + + grid.queueGridRefresh(); + }, + + + /** + * @ngdoc function + * @name ungroupColumn + * @methodOf ui.grid.grouping.service:uiGridGroupingService + * @description Removes the groupPriority from this column. If the + * column was previously aggregated the aggregation will come back. + * The sort will remain. + * + * This column will move to the right of any other group columns, the + * move is handled in a columnProcessor, so gets called as part of refresh + * + * @param {Grid} grid grid object + * @param {GridColumn} column the column we want to ungroup + */ + ungroupColumn: function( grid, column) { + if ( typeof(column.grouping) === 'undefined' ) { + return; + } + + delete column.grouping.groupPriority; + delete column.treeAggregation; + delete column.customTreeAggregationFinalizer; + + if (column.previousSort) { + column.sort = column.previousSort; + delete column.previousSort; + } + + service.tidyPriorities( grid ); + + grid.api.grouping.raise.groupingChanged(column); + grid.api.core.raise.sortChanged(grid, grid.getColumnSorting()); + + grid.queueGridRefresh(); + }, + + /** + * @ngdoc function + * @name aggregateColumn + * @methodOf ui.grid.grouping.service:uiGridGroupingService + * @description Sets the aggregation type on a column, if the + * column is currently grouped then it removes the grouping first. + * + * @param {Grid} grid grid object + * @param {GridColumn} column the column we want to aggregate + * @param {string} aggregationType of the recognised types from uiGridGroupingConstants or one of the custom aggregations from gridOptions + * @param {string} aggregationLabel to be used instead of the default label. If empty string is passed, label is omitted + */ + aggregateColumn: function( grid, column, aggregationType, aggregationLabel ) { + if (typeof(column.grouping) !== 'undefined' && typeof(column.grouping.groupPriority) !== 'undefined' && column.grouping.groupPriority >= 0) { + service.ungroupColumn( grid, column ); + } + + var aggregationDef = {}; + + if ( typeof(grid.options.treeCustomAggregations[aggregationType]) !== 'undefined' ) { + aggregationDef = grid.options.treeCustomAggregations[aggregationType]; + } else if ( typeof(uiGridTreeBaseService.nativeAggregations()[aggregationType]) !== 'undefined' ) { + aggregationDef = uiGridTreeBaseService.nativeAggregations()[aggregationType]; + } + + column.treeAggregation = { + type: aggregationType, + label: ( typeof aggregationLabel === 'string') ? + aggregationLabel : + i18nService.get().aggregation[aggregationDef.label] || aggregationDef.label + }; + column.treeAggregationFn = aggregationDef.aggregationFn; + column.treeAggregationFinalizerFn = aggregationDef.finalizerFn; + + grid.api.grouping.raise.aggregationChanged(column); + + grid.queueGridRefresh(); + }, + + + /** + * @ngdoc function + * @name setGrouping + * @methodOf ui.grid.grouping.service:uiGridGroupingService + * @description Set the grouping based on a config object, used by the save state feature + * (more specifically, by the restore function in that feature ) + * + * @param {Grid} grid grid object + * @param {object} config the config we want to set, same format as that returned by getGrouping + */ + setGrouping: function ( grid, config ) { + if ( typeof(config) === 'undefined' ) { + return; + } + + // first remove any existing grouping + service.clearGrouping(grid); + + if ( config.grouping && config.grouping.length && config.grouping.length > 0 ) { + config.grouping.forEach( function( group ) { + var col = grid.getColumn(group.colName); + + if ( col ) { + service.groupColumn( grid, col ); + } + }); + } + + if ( config.aggregations && config.aggregations.length ) { + config.aggregations.forEach( function( aggregation ) { + var col = grid.getColumn(aggregation.colName); + + if ( col ) { + service.aggregateColumn( grid, col, aggregation.aggregation.type ); + } + }); + } + + if ( config.rowExpandedStates ) { + service.applyRowExpandedStates( grid.grouping.groupingHeaderCache, config.rowExpandedStates ); + } + }, + + + /** + * @ngdoc function + * @name clearGrouping + * @methodOf ui.grid.grouping.service:uiGridGroupingService + * @description Clear any grouped columns and any aggregations. Doesn't remove sorting, + * as we don't know whether that sorting was added by grouping or was there beforehand + * + * @param {Grid} grid grid object + */ + clearGrouping: function( grid ) { + var currentGrouping = service.getGrouping(grid); + + if ( currentGrouping.grouping.length > 0 ) { + currentGrouping.grouping.forEach( function( group ) { + if (!group.col) { + // should have a group.colName if there's no col + group.col = grid.getColumn(group.colName); + } + service.ungroupColumn(grid, group.col); + }); + } + + if ( currentGrouping.aggregations.length > 0 ) { + currentGrouping.aggregations.forEach( function( aggregation ) { + if (!aggregation.col) { + // should have a group.colName if there's no col + aggregation.col = grid.getColumn(aggregation.colName); + } + service.aggregateColumn(grid, aggregation.col, null); + }); + } + }, + + + /** + * @ngdoc function + * @name tidyPriorities + * @methodOf ui.grid.grouping.service:uiGridGroupingService + * @description Renumbers groupPriority and sortPriority such that + * groupPriority is contiguous, and sortPriority either matches + * groupPriority (for group columns), and otherwise is contiguous and + * higher than groupPriority. + * + * @param {Grid} grid grid object + */ + tidyPriorities: function( grid ) { + // if we're called from sortChanged, grid is in this, not passed as param, the param can be a column or undefined + if ( ( typeof(grid) === 'undefined' || typeof(grid.grid) !== 'undefined' ) && typeof(this.grid) !== 'undefined' ) { + grid = this.grid; + } + + var groupArray = [], + sortArray = []; + + grid.columns.forEach( function(column, index) { + if ( typeof(column.grouping) !== 'undefined' && typeof(column.grouping.groupPriority) !== 'undefined' && column.grouping.groupPriority >= 0) { + groupArray.push(column); + } + else if ( typeof(column.sort) !== 'undefined' && typeof(column.sort.priority) !== 'undefined' && column.sort.priority >= 0) { + sortArray.push(column); + } + }); + + groupArray.sort(function(a, b) { return a.grouping.groupPriority - b.grouping.groupPriority; }); + groupArray.forEach( function(column, index) { + column.grouping.groupPriority = index; + column.suppressRemoveSort = true; + if ( typeof(column.sort) === 'undefined') { + column.sort = {}; + } + column.sort.priority = index; + }); + + var i = groupArray.length; + + sortArray.sort(function(a, b) { return a.sort.priority - b.sort.priority; }); + sortArray.forEach(function(column) { + column.sort.priority = i; + column.suppressRemoveSort = column.colDef.suppressRemoveSort; + i++; + }); + }, + + /** + * @ngdoc function + * @name groupRows + * @methodOf ui.grid.grouping.service:uiGridGroupingService + * @description The rowProcessor that creates the groupHeaders (i.e. does + * the actual grouping). + * + * Assumes it is always called after the sorting processor, guaranteed by the priority setting + * + * Processes all the rows in order, inserting a groupHeader row whenever there is a change + * in value of a grouped row, based on the sortAlgorithm used for the column. The group header row + * is looked up in the groupHeaderCache, and used from there if there is one. The entity is reset + * to {} if one is found. + * + * As it processes it maintains a `processingState` array. This records, for each level of grouping we're + * working with, the following information: + * ``` + * { + * fieldName: name, + * col: col, + * initialised: boolean, + * currentValue: value, + * currentRow: gridRow, + * } + * ``` + * We look for changes in the currentValue at any of the levels. Where we find a change we: + * + * - create a new groupHeader row in the array + * + * @param {array} renderableRows the rows we want to process, usually the output from the previous rowProcessor + * @returns {array} the updated rows, including our new group rows + */ + groupRows: function( renderableRows ) { + if (renderableRows.length === 0) { + return renderableRows; + } + + var grid = this; + grid.grouping.oldGroupingHeaderCache = grid.grouping.groupingHeaderCache || {}; + grid.grouping.groupingHeaderCache = {}; + + var processingState = service.initialiseProcessingState( grid ); + + // processes each of the fields we are grouping by, checks if the value has changed and inserts a groupHeader + // Broken out as shouldn't create functions in a loop. + var updateProcessingState = function( groupFieldState, stateIndex ) { + var fieldValue = grid.getCellValue(row, groupFieldState.col); + + // look for change of value - and insert a header + if ( !groupFieldState.initialised || rowSorter.getSortFn(grid, groupFieldState.col, renderableRows)(fieldValue, groupFieldState.currentValue) !== 0 ) { + service.insertGroupHeader( grid, renderableRows, i, processingState, stateIndex ); + i++; + } + }; + + // use a for loop because it's tolerant of the array length changing whilst we go - we can + // manipulate the iterator when we insert groupHeader rows + for (var i = 0; i < renderableRows.length; i++ ) { + var row = renderableRows[i]; + + if ( row.visible ) { + processingState.forEach( updateProcessingState ); + } + } + + delete grid.grouping.oldGroupingHeaderCache; + return renderableRows; + }, + + + /** + * @ngdoc function + * @name initialiseProcessingState + * @methodOf ui.grid.grouping.service:uiGridGroupingService + * @description Creates the processing state array that is used + * for groupRows. + * + * @param {Grid} grid grid object + * @returns {array} an array in the format described in the groupRows method, + * initialised with blank values + */ + initialiseProcessingState: function( grid ) { + var processingState = []; + var columnSettings = service.getGrouping( grid ); + + columnSettings.grouping.forEach( function( groupItem, index) { + processingState.push({ + fieldName: groupItem.field, + col: groupItem.col, + initialised: false, + currentValue: null, + currentRow: null + }); + }); + + return processingState; + }, + + + /** + * @ngdoc function + * @name getGrouping + * @methodOf ui.grid.grouping.service:uiGridGroupingService + * @description Get the grouping settings from the columns. As a side effect + * this always renumbers the grouping starting at 0 + * @param {Grid} grid grid object + * @returns {array} an array of the group fields, in order of priority + */ + getGrouping: function( grid ) { + var groupArray = [], + aggregateArray = []; + + // get all the grouping + grid.columns.forEach(function(column) { + if ( column.grouping ) { + if ( typeof(column.grouping.groupPriority) !== 'undefined' && column.grouping.groupPriority >= 0) { + groupArray.push({ field: column.field, col: column, groupPriority: column.grouping.groupPriority, grouping: column.grouping }); + } + } + if ( column.treeAggregation && column.treeAggregation.type ) { + aggregateArray.push({ field: column.field, col: column, aggregation: column.treeAggregation }); + } + }); + + // sort grouping into priority order + groupArray.sort( function(a, b) { + return a.groupPriority - b.groupPriority; + }); + + // renumber the priority in case it was somewhat messed up, then remove the grouping reference + groupArray.forEach( function( group, index) { + group.grouping.groupPriority = index; + group.groupPriority = index; + delete group.grouping; + }); + + return { grouping: groupArray, aggregations: aggregateArray }; + }, + + + /** + * @ngdoc function + * @name insertGroupHeader + * @methodOf ui.grid.grouping.service:uiGridGroupingService + * @description Create a group header row, and link it to the various configuration + * items that we use. + * + * Look for the row in the oldGroupingHeaderCache, write the row into the new groupingHeaderCache. + * + * @param {Grid} grid grid object + * @param {array} renderableRows the rows that we are processing + * @param {number} rowIndex the row we were up to processing + * @param {array} processingState the current processing state + * @param {number} stateIndex the processing state item that we were on when we triggered a new group header - + * i.e. the column that we want to create a header for + */ + insertGroupHeader: function( grid, renderableRows, rowIndex, processingState, stateIndex ) { + // set the value that caused the end of a group into the header row and the processing state + var col = processingState[stateIndex].col, + newValue = grid.getCellValue(renderableRows[rowIndex], col), + newDisplayValue = newValue; + + if ( typeof(newValue) === 'undefined' || newValue === null ) { + newDisplayValue = grid.options.groupingNullLabel; + } + + function getKeyAsValueForCacheMap(key) { + return angular.isObject(key) ? JSON.stringify(key) : key; + } + + var cacheItem = grid.grouping.oldGroupingHeaderCache; + + for ( var i = 0; i < stateIndex; i++ ) { + if ( cacheItem && cacheItem[getKeyAsValueForCacheMap(processingState[i].currentValue)] ) { + cacheItem = cacheItem[getKeyAsValueForCacheMap(processingState[i].currentValue)].children; + } + } + + var headerRow; + + if ( cacheItem && cacheItem[getKeyAsValueForCacheMap(newValue)]) { + headerRow = cacheItem[getKeyAsValueForCacheMap(newValue)].row; + headerRow.entity = {}; + } else { + headerRow = new GridRow( {}, null, grid ); + gridClassFactory.rowTemplateAssigner.call(grid, headerRow); + } + + headerRow.entity['$$' + processingState[stateIndex].col.uid] = { groupVal: newDisplayValue }; + headerRow.treeLevel = stateIndex; + headerRow.groupHeader = true; + headerRow.internalRow = true; + headerRow.enableCellEdit = false; + headerRow.enableSelection = grid.options.enableGroupHeaderSelection; + processingState[stateIndex].initialised = true; + processingState[stateIndex].currentValue = newValue; + processingState[stateIndex].currentRow = headerRow; + + // set all processing states below this one to not be initialised - change of this state + // means all those need to start again + service.finaliseProcessingState( processingState, stateIndex + 1); + + // insert our new header row + renderableRows.splice(rowIndex, 0, headerRow); + + // add our new header row to the cache + cacheItem = grid.grouping.groupingHeaderCache; + for ( i = 0; i < stateIndex; i++ ) { + cacheItem = cacheItem[getKeyAsValueForCacheMap(processingState[i].currentValue)].children; + } + cacheItem[getKeyAsValueForCacheMap(newValue)] = { row: headerRow, children: {} }; + }, + + + /** + * @ngdoc function + * @name finaliseProcessingState + * @methodOf ui.grid.grouping.service:uiGridGroupingService + * @description Set all processing states lower than the one that had a break in value to + * no longer be initialised. Render the counts into the entity ready for display. + * + * @param {array} processingState the current processing state + * @param {number} stateIndex the processing state item that we were on when we triggered a new group header, all + * processing states after this need to be finalised + */ + finaliseProcessingState: function( processingState, stateIndex ) { + for ( var i = stateIndex; i < processingState.length; i++) { + processingState[i].initialised = false; + processingState[i].currentRow = null; + processingState[i].currentValue = null; + } + }, + + + /** + * @ngdoc function + * @name getRowExpandedStates + * @methodOf ui.grid.grouping.service:uiGridGroupingService + * @description Extract the groupHeaderCache hash, pulling out only the states. + * + * The example below shows a grid that is grouped by gender then age + * + *
+ * {
+ * male: {
+ * state: 'expanded',
+ * children: {
+ * 22: { state: 'expanded' },
+ * 30: { state: 'collapsed' }
+ * }
+ * },
+ * female: {
+ * state: 'expanded',
+ * children: {
+ * 28: { state: 'expanded' },
+ * 55: { state: 'collapsed' }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param {object} treeChildren The tree children elements object
+ * @returns {object} the expanded states as an object
+ */
+ getRowExpandedStates: function(treeChildren) {
+ if ( typeof(treeChildren) === 'undefined' ) {
+ return {};
+ }
+
+ var newChildren = {};
+
+ angular.forEach( treeChildren, function( value, key ) {
+ newChildren[key] = { state: value.row.treeNode.state };
+ if ( value.children ) {
+ newChildren[key].children = service.getRowExpandedStates( value.children );
+ } else {
+ newChildren[key].children = {};
+ }
+ });
+
+ return newChildren;
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name applyRowExpandedStates
+ * @methodOf ui.grid.grouping.service:uiGridGroupingService
+ * @description Take a hash in the format as created by getRowExpandedStates,
+ * and apply it to the grid.grouping.groupHeaderCache.
+ *
+ * Takes a treeSubset, and applies to a treeSubset - so can be called
+ * recursively.
+ *
+ * @param {object} currentNode can be grid.grouping.groupHeaderCache, or any of
+ * the children of that hash
+ * @param {object} expandedStates can be the full expanded states, or children
+ * of that expanded states (which hopefully matches the subset of the groupHeaderCache)
+ */
+ applyRowExpandedStates: function( currentNode, expandedStates ) {
+ if ( typeof(expandedStates) === 'undefined' ) {
+ return;
+ }
+
+ angular.forEach(expandedStates, function( value, key ) {
+ if ( currentNode[key] ) {
+ currentNode[key].row.treeNode.state = value.state;
+
+ if (value.children && currentNode[key].children) {
+ service.applyRowExpandedStates( currentNode[key].children, value.children );
+ }
+ }
+ });
+ }
+
+
+ };
+
+ return service;
+
+ }]);
+
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.grouping.directive:uiGridGrouping
+ * @element div
+ * @restrict A
+ *
+ * @description Adds grouping features to grid
+ *
+ * @example
+
+
+
+
+ * gridOptions.importerProcessHeaders: function( grid, headerArray ) {
+ * var myHeaderColumns = [];
+ * var thisCol;
+ * headerArray.forEach( function( value, index ) {
+ * thisCol = mySpecialLookupFunction( value );
+ * myHeaderColumns.push( thisCol.name );
+ * });
+ *
+ * return myHeaderCols;
+ * })
+ *
+ * @param {Grid} grid the grid we're importing into
+ * @param {array} headerArray an array of the text from the first row of the csv file,
+ * which you need to match to column.names
+ * @returns {array} array of matching column names, in the same order as the headerArray
+ *
+ */
+ gridOptions.importerProcessHeaders = gridOptions.importerProcessHeaders || service.processHeaders;
+
+ /**
+ * @ngdoc method
+ * @name importerHeaderFilter
+ * @methodOf ui.grid.importer.api:GridOptions
+ * @description A callback function that will filter (usually translate) a single
+ * header. Used when you want to match the passed in column names to the column
+ * displayName after the header filter.
+ *
+ * Your callback routine needs to return the filtered header value.
+ *
+ * gridOptions.importerHeaderFilter: function( displayName ) {
+ * return $translate.instant( displayName );
+ * })
+ *
+ *
+ * or:
+ * + * gridOptions.importerHeaderFilter: $translate.instant + *+ * @param {string} displayName the displayName that we'd like to translate + * @returns {string} the translated name + * + */ + gridOptions.importerHeaderFilter = gridOptions.importerHeaderFilter || function( displayName ) { return displayName; }; + + /** + * @ngdoc method + * @name importerErrorCallback + * @methodOf ui.grid.importer.api:GridOptions + * @description A callback function that provides custom error handling, rather + * than the standard grid behaviour of an alert box and a console message. You + * might use this to internationalise the console log messages, or to write to a + * custom logging routine that returned errors to the server. + * + *
+ * gridOptions.importerErrorCallback: function( grid, errorKey, consoleMessage, context ) {
+ * myUserDisplayRoutine( errorKey );
+ * myLoggingRoutine( consoleMessage, context );
+ * })
+ *
+ * @param {Grid} grid the grid we're importing into, may be useful if you're positioning messages
+ * in some way
+ * @param {string} errorKey one of the i18n keys the importer can return - importer.noHeaders,
+ * importer.noObjects, importer.invalidCsv, importer.invalidJson, importer.jsonNotArray
+ * @param {string} consoleMessage the English console message that importer would have written
+ * @param {object} context the context data that importer would have appended to that console message,
+ * often the file content itself or the element that is in error
+ *
+ */
+ if ( !gridOptions.importerErrorCallback || typeof(gridOptions.importerErrorCallback) !== 'function' ) {
+ delete gridOptions.importerErrorCallback;
+ }
+
+ /**
+ * @ngdoc method
+ * @name importerDataAddCallback
+ * @methodOf ui.grid.importer.api:GridOptions
+ * @description A mandatory callback function that adds data to the source data array. The grid
+ * generally doesn't add rows to the source data array, it is tidier to handle this through a user
+ * callback.
+ *
+ *
+ * gridOptions.importerDataAddCallback: function( grid, newObjects ) {
+ * $scope.myData = $scope.myData.concat( newObjects );
+ * })
+ *
+ * @param {Grid} grid the grid we're importing into, may be useful in some way
+ * @param {array} newObjects an array of new objects that you should add to your data
+ *
+ */
+ if ( gridOptions.enableImporter === true && !gridOptions.importerDataAddCallback ) {
+ gridUtil.logError("You have not set an importerDataAddCallback, importer is disabled");
+ gridOptions.enableImporter = false;
+ }
+
+ /**
+ * @ngdoc object
+ * @name importerNewObject
+ * @propertyOf ui.grid.importer.api:GridOptions
+ * @description An object on which we call `new` to create each new row before inserting it into
+ * the data array. Typically this would be a $resource entity, which means that if you're using
+ * the rowEdit feature, you can directly call save on this entity when the save event is triggered.
+ *
+ * Defaults to a vanilla javascript object
+ *
+ * @example
+ * + * gridOptions.importerNewObject = MyRes; + *+ * + */ + + /** + * @ngdoc property + * @propertyOf ui.grid.importer.api:GridOptions + * @name importerShowMenu + * @description Whether or not to show an item in the grid menu. Defaults to true. + * + */ + gridOptions.importerShowMenu = gridOptions.importerShowMenu !== false; + + /** + * @ngdoc method + * @methodOf ui.grid.importer.api:GridOptions + * @name importerObjectCallback + * @description A callback that massages the data for each object. For example, + * you might have data stored as a code value, but display the decode. This callback + * can be used to change the decoded value back into a code. Defaults to doing nothing. + * @param {Grid} grid in case you need it + * @param {object} newObject the new object as importer has created it, modify it + * then return the modified version + * @returns {object} the modified object + * @example + *
+ * gridOptions.importerObjectCallback = function ( grid, newObject ) {
+ * switch newObject.status {
+ * case 'Active':
+ * newObject.status = 1;
+ * break;
+ * case 'Inactive':
+ * newObject.status = 2;
+ * break;
+ * }
+ * return newObject;
+ * };
+ *
+ */
+ gridOptions.importerObjectCallback = gridOptions.importerObjectCallback || function( grid, newObject ) { return newObject; };
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name addToMenu
+ * @methodOf ui.grid.importer.service:uiGridImporterService
+ * @description Adds import menu item to the grid menu,
+ * allowing the user to request import of a file
+ * @param {Grid} grid the grid into which data should be imported
+ */
+ addToMenu: function ( grid ) {
+ grid.api.core.addToGridMenu( grid, [
+ {
+ title: i18nService.getSafeText('gridMenu.importerTitle'),
+ order: 150
+ },
+ {
+ templateUrl: 'ui-grid/importerMenuItemContainer',
+ action: function () {
+ this.grid.api.importer.importAFile( grid );
+ },
+ order: 151
+ }
+ ]);
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name importThisFile
+ * @methodOf ui.grid.importer.service:uiGridImporterService
+ * @description Imports the provided file into the grid using the file object
+ * provided. Bypasses the grid menu
+ * @param {Grid} grid the grid we're importing into
+ * @param {File} fileObject the file we want to import, as returned from the File
+ * javascript object
+ */
+ importThisFile: function ( grid, fileObject ) {
+ if (!fileObject) {
+ gridUtil.logError( 'No file object provided to importThisFile, should be impossible, aborting');
+ return;
+ }
+
+ var reader = new FileReader();
+
+ switch ( fileObject.type ) {
+ case 'application/json':
+ reader.onload = service.importJsonClosure( grid );
+ break;
+ default:
+ reader.onload = service.importCsvClosure( grid );
+ break;
+ }
+
+ reader.readAsText( fileObject );
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name importJson
+ * @methodOf ui.grid.importer.service:uiGridImporterService
+ * @description Creates a function that imports a json file into the grid.
+ * The json data is imported into new objects of type `gridOptions.importerNewObject`,
+ * and if the rowEdit feature is enabled the rows are marked as dirty
+ * @param {Grid} grid the grid we want to import into
+ * @return {function} Function that receives the file that we want to import, as
+ * a FileObject as an argument
+ */
+ importJsonClosure: function( grid ) {
+ return function( importFile ) {
+ var newObjects = [],
+ newObject,
+ importArray = service.parseJson( grid, importFile );
+
+ if (importArray === null) {
+ return;
+ }
+ importArray.forEach( function( value ) {
+ newObject = service.newObject( grid );
+ angular.extend( newObject, value );
+ newObject = grid.options.importerObjectCallback( grid, newObject );
+ newObjects.push( newObject );
+ });
+
+ service.addObjects( grid, newObjects );
+ };
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name parseJson
+ * @methodOf ui.grid.importer.service:uiGridImporterService
+ * @description Parses a json file, returns the parsed data.
+ * Displays an error if file doesn't parse
+ * @param {Grid} grid the grid that we want to import into
+ * @param {FileObject} importFile the file that we want to import, as
+ * a FileObject
+ * @returns {array} array of objects from the imported json
+ */
+ parseJson: function( grid, importFile ) {
+ var loadedObjects;
+
+ try {
+ loadedObjects = JSON.parse( importFile.target.result );
+ } catch (e) {
+ service.alertError( grid, 'importer.invalidJson', 'File could not be processed, is it valid json? Content was: ', importFile.target.result );
+ return;
+ }
+
+ if ( !Array.isArray( loadedObjects ) ) {
+ service.alertError( grid, 'importer.jsonNotarray', 'Import failed, file is not an array, file was: ', importFile.target.result );
+ return [];
+ } else {
+ return loadedObjects;
+ }
+ },
+
+
+
+ /**
+ * @ngdoc function
+ * @name importCsvClosure
+ * @methodOf ui.grid.importer.service:uiGridImporterService
+ * @description Creates a function that imports a csv file into the grid
+ * (allowing it to be used in the reader.onload event)
+ * @param {Grid} grid the grid that we want to import into
+ * @return {function} Function that receives the file that we want to import, as
+ * a file object
+ */
+ importCsvClosure: function( grid ) {
+ return function( importFile ) {
+ var importArray = service.parseCsv( importFile );
+
+ if ( !importArray || importArray.length < 1 ) {
+ service.alertError( grid, 'importer.invalidCsv', 'File could not be processed, is it valid csv? Content was: ', importFile.target.result );
+ return;
+ }
+
+ var newObjects = service.createCsvObjects( grid, importArray );
+
+ if ( !newObjects || newObjects.length === 0 ) {
+ service.alertError( grid, 'importer.noObjects', 'Objects were not able to be derived, content was: ', importFile.target.result );
+ return;
+ }
+
+ service.addObjects( grid, newObjects );
+ };
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name parseCsv
+ * @methodOf ui.grid.importer.service:uiGridImporterService
+ * @description Parses a csv file into an array of arrays, with the first
+ * array being the headers, and the remaining arrays being the data.
+ * The logic for this comes from https://github.com/thetalecrafter/excel.js/blob/master/src/csv.js,
+ * which is noted as being under the MIT license. The code is modified to pass the jscs yoda condition
+ * checker
+ * @param {FileObject} importFile the file that we want to import, as a
+ * file object
+ */
+ parseCsv: function( importFile ) {
+ var csv = importFile.target.result;
+
+ // use the CSV-JS library to parse
+ return CSV.parse(csv);
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name createCsvObjects
+ * @methodOf ui.grid.importer.service:uiGridImporterService
+ * @description Converts an array of arrays (representing the csv file)
+ * into a set of objects. Uses the provided `gridOptions.importerNewObject`
+ * to create the objects, and maps the header row into the individual columns
+ * using either `gridOptions.importerProcessHeaders`, or by using a native method
+ * of matching to either the displayName, column name or column field of
+ * the columns in the column defs. The resulting objects will have attributes
+ * that are named based on the column.field or column.name, in that order.
+ * @param {Grid} grid the grid that we want to import into
+ * @param {Array} importArray the data that we want to import, as an array
+ */
+ createCsvObjects: function( grid, importArray ) {
+ // pull off header row and turn into headers
+ var headerMapping = grid.options.importerProcessHeaders( grid, importArray.shift() );
+
+ if ( !headerMapping || headerMapping.length === 0 ) {
+ service.alertError( grid, 'importer.noHeaders', 'Column names could not be derived, content was: ', importArray );
+ return [];
+ }
+
+ var newObjects = [],
+ newObject;
+
+ importArray.forEach( function( row ) {
+ newObject = service.newObject( grid );
+ if ( row !== null ) {
+ row.forEach( function( field, index ) {
+ if ( headerMapping[index] !== null ) {
+ newObject[ headerMapping[index] ] = field;
+ }
+ });
+ }
+ newObject = grid.options.importerObjectCallback( grid, newObject );
+ newObjects.push( newObject );
+ });
+
+ return newObjects;
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name processHeaders
+ * @methodOf ui.grid.importer.service:uiGridImporterService
+ * @description Determines the columns that the header row from
+ * a csv (or other) file represents.
+ * @param {Grid} grid the grid we're importing into
+ * @param {array} headerRow the header row that we wish to match against
+ * the column definitions
+ * @returns {array} an array of the attribute names that should be used
+ * for that column, based on matching the headers or creating the headers
+ *
+ */
+ processHeaders: function( grid, headerRow ) {
+ var headers = [];
+
+ if ( !grid.options.columnDefs || grid.options.columnDefs.length === 0 ) {
+ // we are going to create new columnDefs for all these columns, so just remove
+ // spaces from the names to create fields
+ headerRow.forEach( function( value ) {
+ headers.push( value.replace( /[^0-9a-zA-Z\-_]/g, '_' ) );
+ });
+ return headers;
+ }
+ else {
+ var lookupHash = service.flattenColumnDefs( grid, grid.options.columnDefs );
+ headerRow.forEach( function( value ) {
+ if ( lookupHash[value] ) {
+ headers.push( lookupHash[value] );
+ }
+ else if ( lookupHash[ value.toLowerCase() ] ) {
+ headers.push( lookupHash[ value.toLowerCase() ] );
+ }
+ else {
+ headers.push( null );
+ }
+ });
+ return headers;
+ }
+ },
+
+
+ /**
+ * @name flattenColumnDefs
+ * @methodOf ui.grid.importer.service:uiGridImporterService
+ * @description Runs through the column defs and creates a hash of
+ * the displayName, name and field, and of each of those values forced to lower case,
+ * with each pointing to the field or name
+ * (whichever is present). Used to lookup column headers and decide what
+ * attribute name to give to the resulting field.
+ * @param {Grid} grid the grid we're importing into
+ * @param {array} columnDefs the columnDefs that we should flatten
+ * @returns {hash} the flattened version of the column def information, allowing
+ * us to look up a value by `flattenedHash[ headerValue ]`
+ */
+ flattenColumnDefs: function( grid, columnDefs ) {
+ var flattenedHash = {};
+
+ columnDefs.forEach( function( columnDef) {
+ if ( columnDef.name ) {
+ flattenedHash[ columnDef.name ] = columnDef.field || columnDef.name;
+ flattenedHash[ columnDef.name.toLowerCase() ] = columnDef.field || columnDef.name;
+ }
+
+ if ( columnDef.field ) {
+ flattenedHash[ columnDef.field ] = columnDef.field || columnDef.name;
+ flattenedHash[ columnDef.field.toLowerCase() ] = columnDef.field || columnDef.name;
+ }
+
+ if ( columnDef.displayName ) {
+ flattenedHash[ columnDef.displayName ] = columnDef.field || columnDef.name;
+ flattenedHash[ columnDef.displayName.toLowerCase() ] = columnDef.field || columnDef.name;
+ }
+
+ if ( columnDef.displayName && grid.options.importerHeaderFilter ) {
+ flattenedHash[ grid.options.importerHeaderFilter(columnDef.displayName) ] = columnDef.field || columnDef.name;
+ flattenedHash[ grid.options.importerHeaderFilter(columnDef.displayName).toLowerCase() ] = columnDef.field || columnDef.name;
+ }
+ });
+
+ return flattenedHash;
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name addObjects
+ * @methodOf ui.grid.importer.service:uiGridImporterService
+ * @description Inserts our new objects into the grid data, and
+ * sets the rows to dirty if the rowEdit feature is being used
+ *
+ * Does this by registering a watch on dataChanges, which essentially
+ * is waiting on the result of the grid data watch, and downstream processing.
+ *
+ * When the callback is called, it deregisters itself - we don't want to run
+ * again next time data is added.
+ *
+ * If we never get called, we deregister on destroy.
+ *
+ * @param {Grid} grid the grid we're importing into
+ * @param {array} newObjects the objects we want to insert into the grid data
+ * @returns {object} the new object
+ */
+ addObjects: function( grid, newObjects ) {
+ if ( grid.api.rowEdit ) {
+ var dataChangeDereg = grid.registerDataChangeCallback( function() {
+ grid.api.rowEdit.setRowsDirty( newObjects );
+ dataChangeDereg();
+ }, [uiGridConstants.dataChange.ROW] );
+
+ grid.importer.$scope.$on( '$destroy', dataChangeDereg );
+ }
+
+ grid.importer.$scope.$apply( grid.options.importerDataAddCallback( grid, newObjects ) );
+
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name newObject
+ * @methodOf ui.grid.importer.service:uiGridImporterService
+ * @description Makes a new object based on `gridOptions.importerNewObject`,
+ * or based on an empty object if not present
+ * @param {Grid} grid the grid we're importing into
+ * @returns {object} the new object
+ */
+ newObject: function( grid ) {
+ if ( typeof(grid.options) !== "undefined" && typeof(grid.options.importerNewObject) !== "undefined" ) {
+ return new grid.options.importerNewObject();
+ }
+ else {
+ return {};
+ }
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name alertError
+ * @methodOf ui.grid.importer.service:uiGridImporterService
+ * @description Provides an internationalised user alert for the failure,
+ * and logs a console message including diagnostic content.
+ * Optionally, if the the `gridOptions.importerErrorCallback` routine
+ * is defined, then calls that instead, allowing user specified error routines
+ * @param {Grid} grid the grid we're importing into
+ * @param {array} headerRow the header row that we wish to match against
+ * the column definitions
+ */
+ alertError: function( grid, alertI18nToken, consoleMessage, context ) {
+ if ( grid.options.importerErrorCallback ) {
+ grid.options.importerErrorCallback( grid, alertI18nToken, consoleMessage, context );
+ }
+ else {
+ $window.alert(i18nService.getSafeText( alertI18nToken ));
+ gridUtil.logError(consoleMessage + context );
+ }
+ }
+ };
+
+ return service;
+
+ }
+ ]);
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.importer.directive:uiGridImporter
+ * @element div
+ * @restrict A
+ *
+ * @description Adds importer features to grid
+ *
+ */
+ module.directive('uiGridImporter', ['uiGridImporterConstants', 'uiGridImporterService', 'gridUtil', '$compile',
+ function (uiGridImporterConstants, uiGridImporterService, gridUtil, $compile) {
+ return {
+ replace: true,
+ priority: 0,
+ require: '^uiGrid',
+ scope: false,
+ link: function ($scope, $elm, $attrs, uiGridCtrl) {
+ uiGridImporterService.initializeGrid($scope, uiGridCtrl.grid);
+ }
+ };
+ }
+ ]);
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.importer.directive:uiGridImporterMenuItem
+ * @element div
+ * @restrict A
+ *
+ * @description Handles the processing from the importer menu item - once a file is
+ * selected
+ *
+ */
+ module.directive('uiGridImporterMenuItem', ['uiGridImporterConstants', 'uiGridImporterService', 'gridUtil', '$compile',
+ function (uiGridImporterConstants, uiGridImporterService, gridUtil, $compile) {
+ return {
+ replace: true,
+ priority: 0,
+ require: '?^uiGrid',
+ scope: false,
+ templateUrl: 'ui-grid/importerMenuItem',
+ link: function ($scope, $elm, $attrs, uiGridCtrl) {
+ var grid;
+
+ function handleFileSelect(event) {
+ var target = event.srcElement || event.target;
+
+ if (target && target.files && target.files.length === 1) {
+ var fileObject = target.files[0];
+
+ // Define grid if the uiGrid controller is present
+ if (typeof(uiGridCtrl) !== 'undefined' && uiGridCtrl) {
+ grid = uiGridCtrl.grid;
+
+ uiGridImporterService.importThisFile( grid, fileObject );
+ target.form.reset();
+ }
+ else {
+ gridUtil.logError('Could not import file because UI Grid was not found.');
+ }
+ }
+ }
+
+ var fileChooser = $elm[0].querySelectorAll('.ui-grid-importer-file-chooser');
+
+ if ( fileChooser.length !== 1 ) {
+ gridUtil.logError('Found > 1 or < 1 file choosers within the menu item, error, cannot continue');
+ }
+ else {
+ fileChooser[0].addEventListener('change', handleFileSelect, false);
+ }
+ }
+ };
+ }
+ ]);
+})();
+
+angular.module('ui.grid.importer').run(['$templateCache', function($templateCache) {
+ 'use strict';
+
+ $templateCache.put('ui-grid/importerMenuItem',
+ ""
+ );
+
+
+ $templateCache.put('ui-grid/importerMenuItemContainer',
+ ""
+ );
+
+}]);
diff --git a/release/4.9.2/i18n/ui-grid.importer.min.js b/release/4.9.2/i18n/ui-grid.importer.min.js
new file mode 100644
index 000000000..d47b30d87
--- /dev/null
+++ b/release/4.9.2/i18n/ui-grid.importer.min.js
@@ -0,0 +1,7 @@
+/*!
+ * ui-grid - v4.9.2 - 2020-12-01
+ * Copyright (c) 2020 ; License: MIT
+ */
+
+
+!function(){"use strict";var e=angular.module("ui.grid.importer",["ui.grid"]);e.constant("uiGridImporterConstants",{featureName:"importer"}),e.service("uiGridImporterService",["$q","uiGridConstants","uiGridImporterConstants","gridUtil","$compile","$interval","i18nService","$window",function(e,i,r,o,t,n,a,s){var l={initializeGrid:function(e,r){r.importer={$scope:e},this.defaultGridOptions(r.options);var t={events:{importer:{}},methods:{importer:{importFile:function(e){l.importThisFile(r,e)}}}};r.api.registerEventsFromObject(t.events),r.api.registerMethodsFromObject(t.methods),r.options.enableImporter&&r.options.importerShowMenu&&(r.api.core.addToGridMenu?l.addToMenu(r):n(function(){r.api.core.addToGridMenu&&l.addToMenu(r)},100,1))},defaultGridOptions:function(e){e.enableImporter||void 0===e.enableImporter?s.hasOwnProperty("File")&&s.hasOwnProperty("FileReader")&&s.hasOwnProperty("FileList")&&s.hasOwnProperty("Blob")?e.enableImporter=!0:(o.logError("The File APIs are not fully supported in this browser, grid importer cannot be used."),e.enableImporter=!1):e.enableImporter=!1,e.importerProcessHeaders=e.importerProcessHeaders||l.processHeaders,e.importerHeaderFilter=e.importerHeaderFilter||function(e){return e},e.importerErrorCallback&&"function"==typeof e.importerErrorCallback||delete e.importerErrorCallback,!0!==e.enableImporter||e.importerDataAddCallback||(o.logError("You have not set an importerDataAddCallback, importer is disabled"),e.enableImporter=!1),e.importerShowMenu=!1!==e.importerShowMenu,e.importerObjectCallback=e.importerObjectCallback||function(e,r){return r}},addToMenu:function(e){e.api.core.addToGridMenu(e,[{title:a.getSafeText("gridMenu.importerTitle"),order:150},{templateUrl:"ui-grid/importerMenuItemContainer",action:function(){this.grid.api.importer.importAFile(e)},order:151}])},importThisFile:function(e,r){if(r){var t=new FileReader;switch(r.type){case"application/json":t.onload=l.importJsonClosure(e);break;default:t.onload=l.importCsvClosure(e)}t.readAsText(r)}else o.logError("No file object provided to importThisFile, should be impossible, aborting")},importJsonClosure:function(o){return function(e){var r,t=[],i=l.parseJson(o,e);null!==i&&(i.forEach(function(e){r=l.newObject(o),angular.extend(r,e),r=o.options.importerObjectCallback(o,r),t.push(r)}),l.addObjects(o,t))}},parseJson:function(r,t){var e;try{e=JSON.parse(t.target.result)}catch(e){return void l.alertError(r,"importer.invalidJson","File could not be processed, is it valid json? Content was: ",t.target.result)}return Array.isArray(e)?e:(l.alertError(r,"importer.jsonNotarray","Import failed, file is not an array, file was: ",t.target.result),[])},importCsvClosure:function(i){return function(e){var r=l.parseCsv(e);if(!r||r.length<1)l.alertError(i,"importer.invalidCsv","File could not be processed, is it valid csv? Content was: ",e.target.result);else{var t=l.createCsvObjects(i,r);t&&0!==t.length?l.addObjects(i,t):l.alertError(i,"importer.noObjects","Objects were not able to be derived, content was: ",e.target.result)}}},parseCsv:function(e){var r=e.target.result;return CSV.parse(r)},createCsvObjects:function(r,e){var t=r.options.importerProcessHeaders(r,e.shift());if(!t||0===t.length)return l.alertError(r,"importer.noHeaders","Column names could not be derived, content was: ",e),[];var i,o=[];return e.forEach(function(e){i=l.newObject(r),null!==e&&e.forEach(function(e,r){null!==t[r]&&(i[t[r]]=e)}),i=r.options.importerObjectCallback(r,i),o.push(i)}),o},processHeaders:function(e,r){var t=[];if(e.options.columnDefs&&0!==e.options.columnDefs.length){var i=l.flattenColumnDefs(e,e.options.columnDefs);return r.forEach(function(e){i[e]?t.push(i[e]):i[e.toLowerCase()]?t.push(i[e.toLowerCase()]):t.push(null)}),t}return r.forEach(function(e){t.push(e.replace(/[^0-9a-zA-Z\-_]/g,"_"))}),t},flattenColumnDefs:function(r,e){var t={};return e.forEach(function(e){e.name&&(t[e.name]=e.field||e.name,t[e.name.toLowerCase()]=e.field||e.name),e.field&&(t[e.field]=e.field||e.name,t[e.field.toLowerCase()]=e.field||e.name),e.displayName&&(t[e.displayName]=e.field||e.name,t[e.displayName.toLowerCase()]=e.field||e.name),e.displayName&&r.options.importerHeaderFilter&&(t[r.options.importerHeaderFilter(e.displayName)]=e.field||e.name,t[r.options.importerHeaderFilter(e.displayName).toLowerCase()]=e.field||e.name)}),t},addObjects:function(e,r){if(e.api.rowEdit){var t=e.registerDataChangeCallback(function(){e.api.rowEdit.setRowsDirty(r),t()},[i.dataChange.ROW]);e.importer.$scope.$on("$destroy",t)}e.importer.$scope.$apply(e.options.importerDataAddCallback(e,r))},newObject:function(e){return void 0!==e.options&&void 0!==e.options.importerNewObject?new e.options.importerNewObject:{}},alertError:function(e,r,t,i){e.options.importerErrorCallback?e.options.importerErrorCallback(e,r,t,i):(s.alert(a.getSafeText(r)),o.logError(t+i))}};return l}]),e.directive("uiGridImporter",["uiGridImporterConstants","uiGridImporterService","gridUtil","$compile",function(e,o,r,t){return{replace:!0,priority:0,require:"^uiGrid",scope:!1,link:function(e,r,t,i){o.initializeGrid(e,i.grid)}}}]),e.directive("uiGridImporterMenuItem",["uiGridImporterConstants","uiGridImporterService","gridUtil","$compile",function(e,a,s,r){return{replace:!0,priority:0,require:"?^uiGrid",scope:!1,templateUrl:"ui-grid/importerMenuItem",link:function(e,r,t,i){var o;var n=r[0].querySelectorAll(".ui-grid-importer-file-chooser");1!==n.length?s.logError("Found > 1 or < 1 file choosers within the menu item, error, cannot continue"):n[0].addEventListener("change",function(e){var r=e.srcElement||e.target;if(r&&r.files&&1===r.files.length){var t=r.files[0];void 0!==i&&i?(o=i.grid,a.importThisFile(o,t),r.form.reset()):s.logError("Could not import file because UI Grid was not found.")}},!1)}}}])}(),angular.module("ui.grid.importer").run(["$templateCache",function(e){"use strict";e.put("ui-grid/importerMenuItem",''),e.put("ui-grid/importerMenuItemContainer","")}]);
\ No newline at end of file
diff --git a/release/4.9.2/i18n/ui-grid.infinite-scroll.js b/release/4.9.2/i18n/ui-grid.infinite-scroll.js
new file mode 100644
index 000000000..6dfba39e4
--- /dev/null
+++ b/release/4.9.2/i18n/ui-grid.infinite-scroll.js
@@ -0,0 +1,548 @@
+/*!
+ * ui-grid - v4.9.2 - 2020-12-01
+ * Copyright (c) 2020 ; License: MIT
+ */
+
+(function() {
+ 'use strict';
+ /**
+ * @ngdoc overview
+ * @name ui.grid.infiniteScroll
+ *
+ * @description
+ *
+ * #ui.grid.infiniteScroll
+ *
+ * Beta This feature is ready for testing, but it either hasn't seen a lot of use or has some known bugs.
+ *
+ * This module provides infinite scroll functionality to ui-grid
+ *
+ */
+ var module = angular.module('ui.grid.infiniteScroll', ['ui.grid']);
+ /**
+ * @ngdoc service
+ * @name ui.grid.infiniteScroll.service:uiGridInfiniteScrollService
+ *
+ * @description Service for infinite scroll features
+ */
+ module.service('uiGridInfiniteScrollService', ['gridUtil', '$compile', '$rootScope', 'uiGridConstants', 'ScrollEvent', '$q', function (gridUtil, $compile, $rootScope, uiGridConstants, ScrollEvent, $q) {
+ var service = {
+
+ /**
+ * @ngdoc function
+ * @name initializeGrid
+ * @methodOf ui.grid.infiniteScroll.service:uiGridInfiniteScrollService
+ * @description This method register events and methods into grid public API
+ */
+
+ initializeGrid: function(grid, $scope) {
+ service.defaultGridOptions(grid.options);
+
+ if (!grid.options.enableInfiniteScroll) {
+ return;
+ }
+
+ grid.infiniteScroll = { dataLoading: false };
+ service.setScrollDirections( grid, grid.options.infiniteScrollUp, grid.options.infiniteScrollDown );
+ grid.api.core.on.scrollEnd($scope, service.handleScroll);
+
+ /**
+ * @ngdoc object
+ * @name ui.grid.infiniteScroll.api:PublicAPI
+ *
+ * @description Public API for infinite scroll feature
+ */
+ var publicApi = {
+ events: {
+ infiniteScroll: {
+
+ /**
+ * @ngdoc event
+ * @name needLoadMoreData
+ * @eventOf ui.grid.infiniteScroll.api:PublicAPI
+ * @description This event fires when scroll reaches bottom percentage of grid
+ * and needs to load data
+ */
+
+ needLoadMoreData: function ($scope, fn) {
+ },
+
+ /**
+ * @ngdoc event
+ * @name needLoadMoreDataTop
+ * @eventOf ui.grid.infiniteScroll.api:PublicAPI
+ * @description This event fires when scroll reaches top percentage of grid
+ * and needs to load data
+ */
+
+ needLoadMoreDataTop: function ($scope, fn) {
+ }
+ }
+ },
+ methods: {
+ infiniteScroll: {
+
+ /**
+ * @ngdoc function
+ * @name dataLoaded
+ * @methodOf ui.grid.infiniteScroll.api:PublicAPI
+ * @description Call this function when you have loaded the additional data
+ * requested. You should set scrollUp and scrollDown to indicate
+ * whether there are still more pages in each direction.
+ *
+ * If you call dataLoaded without first calling `saveScrollPercentage` then we will
+ * scroll the user to the start of the newly loaded data, which usually gives a smooth scroll
+ * experience, but can give a jumpy experience with large `infiniteScrollRowsFromEnd` values, and
+ * on variable speed internet connections. Using `saveScrollPercentage` as demonstrated in the tutorial
+ * should give a smoother scrolling experience for users.
+ *
+ * See infinite_scroll tutorial for example of usage
+ * @param {boolean} scrollUp if set to false flags that there are no more pages upwards, so don't fire
+ * any more infinite scroll events upward
+ * @param {boolean} scrollDown if set to false flags that there are no more pages downwards, so don't
+ * fire any more infinite scroll events downward
+ * @returns {promise} a promise that is resolved when the grid scrolling is fully adjusted. If you're
+ * planning to remove pages, you should wait on this promise first, or you'll break the scroll positioning
+ */
+ dataLoaded: function( scrollUp, scrollDown ) {
+ service.setScrollDirections(grid, scrollUp, scrollDown);
+
+ return service.adjustScroll(grid).then(function() {
+ grid.infiniteScroll.dataLoading = false;
+ });
+ },
+
+ /**
+ * @ngdoc function
+ * @name resetScroll
+ * @methodOf ui.grid.infiniteScroll.api:PublicAPI
+ * @description Call this function when you have taken some action that makes the current
+ * scroll position invalid. For example, if you're using external sorting and you've resorted
+ * then you might reset the scroll, or if you've otherwise substantially changed the data, perhaps
+ * you've reused an existing grid for a new data set
+ *
+ * You must tell us whether there is data upwards or downwards after the reset
+ *
+ * @param {boolean} scrollUp flag that there are pages upwards, fire
+ * infinite scroll events upward
+ * @param {boolean} scrollDown flag that there are pages downwards, so
+ * fire infinite scroll events downward
+ */
+ resetScroll: function( scrollUp, scrollDown ) {
+ service.setScrollDirections( grid, scrollUp, scrollDown);
+
+ service.adjustInfiniteScrollPosition(grid, 0);
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name saveScrollPercentage
+ * @methodOf ui.grid.infiniteScroll.api:PublicAPI
+ * @description Saves the scroll percentage and number of visible rows before you adjust the data,
+ * used if you're subsequently going to call `dataRemovedTop` or `dataRemovedBottom`
+ */
+ saveScrollPercentage: function() {
+ grid.infiniteScroll.prevScrollTop = grid.renderContainers.body.prevScrollTop;
+ grid.infiniteScroll.previousVisibleRows = grid.getVisibleRowCount();
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name dataRemovedTop
+ * @methodOf ui.grid.infiniteScroll.api:PublicAPI
+ * @description Adjusts the scroll position after you've removed data at the top
+ * @param {boolean} scrollUp flag that there are pages upwards, fire
+ * infinite scroll events upward
+ * @param {boolean} scrollDown flag that there are pages downwards, so
+ * fire infinite scroll events downward
+ */
+ dataRemovedTop: function( scrollUp, scrollDown ) {
+ service.dataRemovedTop( grid, scrollUp, scrollDown );
+ },
+
+ /**
+ * @ngdoc function
+ * @name dataRemovedBottom
+ * @methodOf ui.grid.infiniteScroll.api:PublicAPI
+ * @description Adjusts the scroll position after you've removed data at the bottom
+ * @param {boolean} scrollUp flag that there are pages upwards, fire
+ * infinite scroll events upward
+ * @param {boolean} scrollDown flag that there are pages downwards, so
+ * fire infinite scroll events downward
+ */
+ dataRemovedBottom: function( scrollUp, scrollDown ) {
+ service.dataRemovedBottom( grid, scrollUp, scrollDown );
+ },
+
+ /**
+ * @ngdoc function
+ * @name setScrollDirections
+ * @methodOf ui.grid.infiniteScroll.service:uiGridInfiniteScrollService
+ * @description Sets the scrollUp and scrollDown flags, handling nulls and undefined,
+ * and also sets the grid.suppressParentScroll
+ * @param {boolean} scrollUp whether there are pages available up - defaults to false
+ * @param {boolean} scrollDown whether there are pages available down - defaults to true
+ */
+ setScrollDirections: function ( scrollUp, scrollDown ) {
+ service.setScrollDirections( grid, scrollUp, scrollDown );
+ }
+
+ }
+ }
+ };
+ grid.api.registerEventsFromObject(publicApi.events);
+ grid.api.registerMethodsFromObject(publicApi.methods);
+ },
+
+
+ defaultGridOptions: function (gridOptions) {
+ // default option to true unless it was explicitly set to false
+ /**
+ * @ngdoc object
+ * @name ui.grid.infiniteScroll.api:GridOptions
+ *
+ * @description GridOptions for infinite scroll feature, these are available to be
+ * set using the ui-grid {@link ui.grid.class:GridOptions gridOptions}
+ */
+
+ /**
+ * @ngdoc object
+ * @name enableInfiniteScroll
+ * @propertyOf ui.grid.infiniteScroll.api:GridOptions
+ * @description Enable infinite scrolling for this grid
+ * Defaults to true + */ + gridOptions.enableInfiniteScroll = gridOptions.enableInfiniteScroll !== false; + + /** + * @ngdoc property + * @name infiniteScrollRowsFromEnd + * @propertyOf ui.grid.class:GridOptions + * @description This setting controls how close to the end of the dataset a user gets before + * more data is requested by the infinite scroll, whether scrolling up or down. This allows you to + * 'prefetch' rows before the user actually runs out of scrolling. + * + * Note that if you set this value too high it may give jumpy scrolling behaviour, if you're getting + * this behaviour you could use the `saveScrollPercentageMethod` right before loading your data, and we'll + * preserve that scroll position + * + * Defaults to 20 + */ + gridOptions.infiniteScrollRowsFromEnd = gridOptions.infiniteScrollRowsFromEnd || 20; + + /** + * @ngdoc property + * @name infiniteScrollUp + * @propertyOf ui.grid.class:GridOptions + * @description Whether you allow infinite scroll up, implying that the first page of data + * you have displayed is in the middle of your data set. If set to true then we trigger the + * needMoreDataTop event when the user hits the top of the scrollbar. + * Defaults to false + */ + gridOptions.infiniteScrollUp = gridOptions.infiniteScrollUp === true; + + /** + * @ngdoc property + * @name infiniteScrollDown + * @propertyOf ui.grid.class:GridOptions + * @description Whether you allow infinite scroll down, implying that the first page of data + * you have displayed is in the middle of your data set. If set to true then we trigger the + * needMoreData event when the user hits the bottom of the scrollbar. + * Defaults to true + */ + gridOptions.infiniteScrollDown = gridOptions.infiniteScrollDown !== false; + }, + + + /** + * @ngdoc function + * @name setScrollDirections + * @methodOf ui.grid.infiniteScroll.service:uiGridInfiniteScrollService + * @description Sets the scrollUp and scrollDown flags, handling nulls and undefined, + * and also sets the grid.suppressParentScroll + * @param {grid} grid the grid we're operating on + * @param {boolean} scrollUp whether there are pages available up - defaults to false + * @param {boolean} scrollDown whether there are pages available down - defaults to true + */ + setScrollDirections: function ( grid, scrollUp, scrollDown ) { + grid.infiniteScroll.scrollUp = ( scrollUp === true ); + grid.suppressParentScrollUp = ( scrollUp === true ); + + grid.infiniteScroll.scrollDown = ( scrollDown !== false); + grid.suppressParentScrollDown = ( scrollDown !== false); + }, + + + /** + * @ngdoc function + * @name handleScroll + * @methodOf ui.grid.infiniteScroll.service:uiGridInfiniteScrollService + * @description Called whenever the grid scrolls, determines whether the scroll should + * trigger an infinite scroll request for more data + * @param {object} args the args from the event + */ + handleScroll: function (args) { + // don't request data if already waiting for data, or if source is coming from ui.grid.adjustInfiniteScrollPosition() function + if ( args.grid.infiniteScroll && args.grid.infiniteScroll.dataLoading || args.source === 'ui.grid.adjustInfiniteScrollPosition' ) { + return; + } + + if (args.y) { + + // If the user is scrolling very quickly all the way to the top/bottom, the scroll handler can get confused + // about the direction. First we check if they've gone all the way, and data always is loaded in this case. + if (args.y.percentage === 0) { + args.grid.scrollDirection = uiGridConstants.scrollDirection.UP; + service.loadData(args.grid); + } + else if (args.y.percentage === 1) { + args.grid.scrollDirection = uiGridConstants.scrollDirection.DOWN; + service.loadData(args.grid); + } + else { // Scroll position is somewhere in between top/bottom, so determine whether it's far enough to load more data. + var percentage, + targetPercentage = args.grid.options.infiniteScrollRowsFromEnd / args.grid.renderContainers.body.visibleRowCache.length; + + if (args.grid.scrollDirection === uiGridConstants.scrollDirection.UP ) { + percentage = args.y.percentage; + if (percentage <= targetPercentage) { + service.loadData(args.grid); + } + } + else if (args.grid.scrollDirection === uiGridConstants.scrollDirection.DOWN) { + percentage = 1 - args.y.percentage; + if (percentage <= targetPercentage) { + service.loadData(args.grid); + } + } + } + } + }, + + + /** + * @ngdoc function + * @name loadData + * @methodOf ui.grid.infiniteScroll.service:uiGridInfiniteScrollService + * @description This function fires 'needLoadMoreData' or 'needLoadMoreDataTop' event based on scrollDirection + * and whether there are more pages upwards or downwards. It also stores the number of rows that we had previously, + * and clears out any saved scroll position so that we know whether or not the user calls `saveScrollPercentage` + * @param {Grid} grid the grid we're working on + */ + loadData: function (grid) { + // save number of currently visible rows to calculate new scroll position later - we know that we want + // to be at approximately the row we're currently at + grid.infiniteScroll.previousVisibleRows = grid.renderContainers.body.visibleRowCache.length; + grid.infiniteScroll.direction = grid.scrollDirection; + delete grid.infiniteScroll.prevScrollTop; + + if (grid.scrollDirection === uiGridConstants.scrollDirection.UP && grid.infiniteScroll.scrollUp ) { + grid.infiniteScroll.dataLoading = true; + grid.api.infiniteScroll.raise.needLoadMoreDataTop(); + } + else if (grid.scrollDirection === uiGridConstants.scrollDirection.DOWN && grid.infiniteScroll.scrollDown ) { + grid.infiniteScroll.dataLoading = true; + grid.api.infiniteScroll.raise.needLoadMoreData(); + } + }, + + + /** + * @ngdoc function + * @name adjustScroll + * @methodOf ui.grid.infiniteScroll.service:uiGridInfiniteScrollService + * @description Once we are informed that data has been loaded, adjust the scroll position to account for that + * addition and to make things look clean. + * + * If we're scrolling up we scroll to the first row of the old data set - + * so we're assuming that you would have gotten to the top of the grid (from the 20% need more data trigger) by + * the time the data comes back. If we're scrolling down we scroll to the last row of the old data set - so we're + * assuming that you would have gotten to the bottom of the grid (from the 80% need more data trigger) by the time + * the data comes back. + * + * Neither of these are good assumptions, but making this a smoother experience really requires + * that trigger to not be a percentage, and to be much closer to the end of the data (say, 5 rows off the end). Even then + * it'd be better still to actually run into the end. But if the data takes a while to come back, they may have scrolled + * somewhere else in the mean-time, in which case they'll get a jump back to the new data. Anyway, this will do for + * now, until someone wants to do better. + * @param {Grid} grid the grid we're working on + * @returns {promise} a promise that is resolved when scrolling has finished + */ + adjustScroll: function(grid) { + var promise = $q.defer(); + $rootScope.$applyAsync(function () { + var viewportHeight, rowHeight, newVisibleRows, oldTop, newTop; + + viewportHeight = grid.getViewportHeight() + grid.headerHeight - grid.renderContainers.body.headerHeight - grid.scrollbarHeight; + rowHeight = grid.options.rowHeight; + + if ( grid.infiniteScroll.direction === undefined ) { + // called from initialize, tweak our scroll up a little + service.adjustInfiniteScrollPosition(grid, 0); + } + + newVisibleRows = grid.getVisibleRowCount(); + + // in case not enough data is loaded to enable scroller - load more data + var canvasHeight = rowHeight * newVisibleRows; + if (grid.infiniteScroll.scrollDown && (viewportHeight > canvasHeight)) { + grid.api.infiniteScroll.raise.needLoadMoreData(); + } + + if ( grid.infiniteScroll.direction === uiGridConstants.scrollDirection.UP ) { + oldTop = grid.infiniteScroll.prevScrollTop || 0; + newTop = oldTop + (newVisibleRows - grid.infiniteScroll.previousVisibleRows)*rowHeight; + service.adjustInfiniteScrollPosition(grid, newTop); + $rootScope.$applyAsync( function() { + promise.resolve(); + }); + } + + if ( grid.infiniteScroll.direction === uiGridConstants.scrollDirection.DOWN ) { + newTop = grid.infiniteScroll.prevScrollTop || (grid.infiniteScroll.previousVisibleRows*rowHeight - viewportHeight); + service.adjustInfiniteScrollPosition(grid, newTop); + $rootScope.$applyAsync( function() { + promise.resolve(); + }); + } + }, 0); + + return promise.promise; + }, + + + /** + * @ngdoc function + * @name adjustInfiniteScrollPosition + * @methodOf ui.grid.infiniteScroll.service:uiGridInfiniteScrollService + * @description This function fires 'needLoadMoreData' or 'needLoadMoreDataTop' event based on scrollDirection + * @param {Grid} grid the grid we're working on + * @param {number} scrollTop the position through the grid that we want to scroll to + */ + adjustInfiniteScrollPosition: function (grid, scrollTop) { + var scrollEvent = new ScrollEvent(grid, null, null, 'ui.grid.adjustInfiniteScrollPosition'), + visibleRows = grid.getVisibleRowCount(), + viewportHeight = grid.getViewportHeight() + grid.headerHeight - grid.renderContainers.body.headerHeight - grid.scrollbarHeight, + rowHeight = grid.options.rowHeight, + scrollHeight = visibleRows*rowHeight-viewportHeight; + + // for infinite scroll, if there are pages upwards then never allow it to be at the zero position so the up button can be active + if (scrollTop === 0 && grid.infiniteScroll.scrollUp) { + // using pixels results in a relative scroll, hence we have to use percentage + scrollEvent.y = {pixels: 1}; + } + else { + scrollEvent.y = {percentage: scrollTop/scrollHeight}; + } + grid.scrollContainers('', scrollEvent); + }, + + + /** + * @ngdoc function + * @name dataRemovedTop + * @methodOf ui.grid.infiniteScroll.api:PublicAPI + * @description Adjusts the scroll position after you've removed data at the top. You should + * have called `saveScrollPercentage` before you remove the data, and if you're doing this in + * response to a `needMoreData` you should wait until the promise from `loadData` has resolved + * before you start removing data + * @param {Grid} grid the grid we're working on + * @param {boolean} scrollUp flag that there are pages upwards, fire + * infinite scroll events upward + * @param {boolean} scrollDown flag that there are pages downwards, so + * fire infinite scroll events downward + */ + dataRemovedTop: function( grid, scrollUp, scrollDown ) { + var newVisibleRows, oldTop, newTop, rowHeight; + service.setScrollDirections( grid, scrollUp, scrollDown ); + + newVisibleRows = grid.renderContainers.body.visibleRowCache.length; + oldTop = grid.infiniteScroll.prevScrollTop; + rowHeight = grid.options.rowHeight; + + // since we removed from the top, our new scroll row will be the old scroll row less the number + // of rows removed + newTop = oldTop - ( grid.infiniteScroll.previousVisibleRows - newVisibleRows )*rowHeight; + + service.adjustInfiniteScrollPosition( grid, newTop ); + }, + + /** + * @ngdoc function + * @name dataRemovedBottom + * @methodOf ui.grid.infiniteScroll.api:PublicAPI + * @description Adjusts the scroll position after you've removed data at the bottom. You should + * have called `saveScrollPercentage` before you remove the data, and if you're doing this in + * response to a `needMoreData` you should wait until the promise from `loadData` has resolved + * before you start removing data + * @param {Grid} grid the grid we're working on + * @param {boolean} scrollUp flag that there are pages upwards, fire + * infinite scroll events upward + * @param {boolean} scrollDown flag that there are pages downwards, so + * fire infinite scroll events downward + */ + dataRemovedBottom: function( grid, scrollUp, scrollDown ) { + var newTop; + + service.setScrollDirections( grid, scrollUp, scrollDown ); + + newTop = grid.infiniteScroll.prevScrollTop; + + service.adjustInfiniteScrollPosition( grid, newTop ); + } + }; + return service; + }]); + /** + * @ngdoc directive + * @name ui.grid.infiniteScroll.directive:uiGridInfiniteScroll + * @element div + * @restrict A + * + * @description Adds infinite scroll features to grid + * + * @example +
+
+
+
+ * gridApi.colMovable.on.columnPositionChanged(scope,function(colDef, originalPosition, newPosition) {})
+ *
+ * @param {object} colDef the column that was moved
+ * @param {integer} originalPosition of the column
+ * @param {integer} finalPosition of the column
+ */
+ colMovable: {
+ columnPositionChanged: function (colDef, originalPosition, newPosition) {
+ }
+ }
+ },
+ methods: {
+ /**
+ * @ngdoc method
+ * @name moveColumn
+ * @methodOf ui.grid.moveColumns.api:PublicApi
+ * @description Method can be used to change column position.
+ * + * gridApi.colMovable.moveColumn(oldPosition, newPosition) + *+ * @param {integer} originalPosition of the column + * @param {integer} finalPosition of the column + */ + colMovable: { + moveColumn: function (originalPosition, finalPosition) { + var columns = grid.columns; + if (!angular.isNumber(originalPosition) || !angular.isNumber(finalPosition)) { + gridUtil.logError('MoveColumn: Please provide valid values for originalPosition and finalPosition'); + return; + } + var nonMovableColumns = 0; + for (var i = 0; i < columns.length; i++) { + if ((angular.isDefined(columns[i].colDef.visible) && columns[i].colDef.visible === false) || columns[i].isRowHeader === true) { + nonMovableColumns++; + } + } + if (originalPosition >= (columns.length - nonMovableColumns) || finalPosition >= (columns.length - nonMovableColumns)) { + gridUtil.logError('MoveColumn: Invalid values for originalPosition, finalPosition'); + return; + } + var findPositionForRenderIndex = function (index) { + var position = index; + for (var i = 0; i <= position; i++) { + if (angular.isDefined(columns[i]) && ((angular.isDefined(columns[i].colDef.visible) && columns[i].colDef.visible === false) || columns[i].isRowHeader === true)) { + position++; + } + } + return position; + }; + self.redrawColumnAtPosition(grid, findPositionForRenderIndex(originalPosition), findPositionForRenderIndex(finalPosition)); + } + } + } + }; + grid.api.registerEventsFromObject(publicApi.events); + grid.api.registerMethodsFromObject(publicApi.methods); + }, + defaultGridOptions: function (gridOptions) { + /** + * @ngdoc object + * @name ui.grid.moveColumns.api:GridOptions + * + * @description Options for configuring the move column feature, these are available to be + * set using the ui-grid {@link ui.grid.class:GridOptions gridOptions} + */ + /** + * @ngdoc object + * @name enableColumnMoving + * @propertyOf ui.grid.moveColumns.api:GridOptions + * @description If defined, sets the default value for the colMovable flag on each individual colDefs + * if their individual enableColumnMoving configuration is not defined. Defaults to true. + */ + gridOptions.enableColumnMoving = gridOptions.enableColumnMoving !== false; + }, + movableColumnBuilder: function (colDef, col, gridOptions) { + var promises = []; + /** + * @ngdoc object + * @name ui.grid.moveColumns.api:ColumnDef + * + * @description Column Definition for move column feature, these are available to be + * set using the ui-grid {@link ui.grid.class:GridOptions.columnDef gridOptions.columnDefs} + */ + /** + * @ngdoc object + * @name enableColumnMoving + * @propertyOf ui.grid.moveColumns.api:ColumnDef + * @description Enable column moving for the column. + */ + colDef.enableColumnMoving = colDef.enableColumnMoving === undefined ? gridOptions.enableColumnMoving + : colDef.enableColumnMoving; + return $q.all(promises); + }, + /** + * @ngdoc method + * @name updateColumnCache + * @methodOf ui.grid.moveColumns + * @description Cache the current order of columns, so we can restore them after new columnDefs are defined + */ + updateColumnCache: function(grid) { + grid.moveColumns.orderCache = grid.getOnlyDataColumns(); + }, + /** + * @ngdoc method + * @name verifyColumnOrder + * @methodOf ui.grid.moveColumns + * @description dataChangeCallback which uses the cached column order to restore the column order + * when it is reset by altering the columnDefs array. + */ + verifyColumnOrder: function(grid) { + var headerRowOffset = grid.rowHeaderColumns.length; + var newIndex; + + angular.forEach(grid.moveColumns.orderCache, function(cacheCol, cacheIndex) { + newIndex = grid.columns.indexOf(cacheCol); + if ( newIndex !== -1 && newIndex - headerRowOffset !== cacheIndex ) { + var column = grid.columns.splice(newIndex, 1)[0]; + grid.columns.splice(cacheIndex + headerRowOffset, 0, column); + } + }); + }, + redrawColumnAtPosition: function (grid, originalPosition, newPosition) { + var columns = grid.columns; + + if (originalPosition === newPosition) { + return; + } + + // check columns in between move-range to make sure they are visible columns + var pos = (originalPosition < newPosition) ? originalPosition + 1 : originalPosition - 1; + var i0 = Math.min(pos, newPosition); + for (i0; i0 <= Math.max(pos, newPosition); i0++) { + if (columns[i0].visible) { + break; + } + } + if (i0 > Math.max(pos, newPosition)) { + // no visible column found, column did not visibly move + return; + } + + var originalColumn = columns[originalPosition]; + if (originalColumn.colDef.enableColumnMoving) { + if (originalPosition > newPosition) { + for (var i1 = originalPosition; i1 > newPosition; i1--) { + columns[i1] = columns[i1 - 1]; + } + } + else if (newPosition > originalPosition) { + for (var i2 = originalPosition; i2 < newPosition; i2++) { + columns[i2] = columns[i2 + 1]; + } + } + columns[newPosition] = originalColumn; + service.updateColumnCache(grid); + grid.queueGridRefresh(); + $rootScope.$applyAsync(function () { + grid.api.core.notifyDataChange( uiGridConstants.dataChange.COLUMN ); + grid.api.colMovable.raise.columnPositionChanged(originalColumn.colDef, originalPosition, newPosition); + }); + } + } + }; + return service; + }]); + + /** + * @ngdoc directive + * @name ui.grid.moveColumns.directive:uiGridMoveColumns + * @element div + * @restrict A + * @description Adds column moving features to the ui-grid directive. + * @example +
+
+
+
+
+
+ 0\">/ {{ paginationApi.getTotalPages() }} 1 && !grid.options.useCustomPagination\"> {{sizesLabel}} {{grid.options.paginationPageSize}} {{sizesLabel}} 0\">{{ 1 + paginationApi.getFirstRowIndex() }} - {{ 1 + paginationApi.getLastRowIndex() }} {{paginationOf}} {{grid.options.totalItems}} {{totalItemsLabel}} / {{ paginationApi.getTotalPages() }} {{sizesLabel}} {{grid.options.paginationPageSize}} {{sizesLabel}}{{ 1 + paginationApi.getFirstRowIndex() }} - {{ 1 + paginationApi.getLastRowIndex() }} {{paginationOf}} {{grid.options.totalItems}} {{totalItemsLabel}} Stable This feature is stable. There should no longer be breaking api changes without a deprecation warning.
+ *
+ * This module provides column pinning to the end user via menu options in the column header
+ *
+ *
+ */
+
+ var module = angular.module('ui.grid.pinning', ['ui.grid']);
+
+ module.constant('uiGridPinningConstants', {
+ container: {
+ LEFT: 'left',
+ RIGHT: 'right',
+ NONE: ''
+ }
+ });
+
+ module.service('uiGridPinningService', ['gridUtil', 'GridRenderContainer', 'i18nService', 'uiGridPinningConstants', function (gridUtil, GridRenderContainer, i18nService, uiGridPinningConstants) {
+ var service = {
+
+ initializeGrid: function (grid) {
+ service.defaultGridOptions(grid.options);
+
+ // Register a column builder to add new menu items for pinning left and right
+ grid.registerColumnBuilder(service.pinningColumnBuilder);
+
+ /**
+ * @ngdoc object
+ * @name ui.grid.pinning.api:PublicApi
+ *
+ * @description Public Api for pinning feature
+ */
+ var publicApi = {
+ events: {
+ pinning: {
+ /**
+ * @ngdoc event
+ * @name columnPinned
+ * @eventOf ui.grid.pinning.api:PublicApi
+ * @description raised when column pin state has changed
+ *
+ * gridApi.pinning.on.columnPinned(scope, function(colDef){})
+ *
+ * @param {object} colDef the column that was changed
+ * @param {string} container the render container the column is in ('left', 'right', '')
+ */
+ columnPinned: function(colDef, container) {
+ }
+ }
+ },
+ methods: {
+ pinning: {
+ /**
+ * @ngdoc function
+ * @name pinColumn
+ * @methodOf ui.grid.pinning.api:PublicApi
+ * @description pin column left, right, or none
+ * + * gridApi.pinning.pinColumn(col, uiGridPinningConstants.container.LEFT) + *+ * @param {gridColumn} col the column being pinned + * @param {string} container one of the recognised types + * from uiGridPinningConstants + */ + pinColumn: function(col, container) { + service.pinColumn(grid, col, container); + } + } + } + }; + + grid.api.registerEventsFromObject(publicApi.events); + grid.api.registerMethodsFromObject(publicApi.methods); + }, + + defaultGridOptions: function (gridOptions) { + // default option to true unless it was explicitly set to false + /** + * @ngdoc object + * @name ui.grid.pinning.api:GridOptions + * + * @description GridOptions for pinning feature, these are available to be + * set using the ui-grid {@link ui.grid.class:GridOptions gridOptions} + */ + + /** + * @ngdoc object + * @name enablePinning + * @propertyOf ui.grid.pinning.api:GridOptions + * @description Enable pinning for the entire grid. + * Defaults to true + */ + gridOptions.enablePinning = gridOptions.enablePinning !== false; + /** + * @ngdoc object + * @name hidePinLeft + * @propertyOf ui.grid.pinning.api:GridOptions + * @description Hide Pin Left for the entire grid. + * Defaults to false + */ + gridOptions.hidePinLeft = gridOptions.enablePinning && gridOptions.hidePinLeft; + /** + * @ngdoc object + * @name hidePinRight + * @propertyOf ui.grid.pinning.api:GridOptions + * @description Hide Pin Right pinning for the entire grid. + * Defaults to false + */ + gridOptions.hidePinRight = gridOptions.enablePinning && gridOptions.hidePinRight; + }, + + pinningColumnBuilder: function (colDef, col, gridOptions) { + // default to true unless gridOptions or colDef is explicitly false + + /** + * @ngdoc object + * @name ui.grid.pinning.api:ColumnDef + * + * @description ColumnDef for pinning feature, these are available to be + * set using the ui-grid {@link ui.grid.class:GridOptions.columnDef gridOptions.columnDefs} + */ + + /** + * @ngdoc object + * @name enablePinning + * @propertyOf ui.grid.pinning.api:ColumnDef + * @description Enable pinning for the individual column. + * Defaults to true + */ + colDef.enablePinning = colDef.enablePinning === undefined ? gridOptions.enablePinning : colDef.enablePinning; + /** + * @ngdoc object + * @name hidePinLeft + * @propertyOf ui.grid.pinning.api:ColumnDef + * @description Hide Pin Left for the individual column. + * Defaults to false + */ + colDef.hidePinLeft = colDef.hidePinLeft === undefined ? gridOptions.hidePinLeft : colDef.hidePinLeft; + /** + * @ngdoc object + * @name hidePinRight + * @propertyOf ui.grid.pinning.api:ColumnDef + * @description Hide Pin Right for the individual column. + * Defaults to false + */ + colDef.hidePinRight = colDef.hidePinRight === undefined ? gridOptions.hidePinRight : colDef.hidePinRight; + + /** + * @ngdoc object + * @name pinnedLeft + * @propertyOf ui.grid.pinning.api:ColumnDef + * @description Column is pinned left when grid is rendered + * Defaults to false + */ + + /** + * @ngdoc object + * @name pinnedRight + * @propertyOf ui.grid.pinning.api:ColumnDef + * @description Column is pinned right when grid is rendered + * Defaults to false + */ + if (colDef.pinnedLeft) { + col.renderContainer = 'left'; + col.grid.createLeftContainer(); + } + else if (colDef.pinnedRight) { + col.renderContainer = 'right'; + col.grid.createRightContainer(); + } + + if (!colDef.enablePinning) { + return; + } + + var pinColumnLeftAction = { + name: 'ui.grid.pinning.pinLeft', + title: i18nService.get().pinning.pinLeft, + icon: 'ui-grid-icon-left-open', + shown: function () { + return typeof(this.context.col.renderContainer) === 'undefined' || !this.context.col.renderContainer || this.context.col.renderContainer !== 'left'; + }, + action: function () { + service.pinColumn(this.context.col.grid, this.context.col, uiGridPinningConstants.container.LEFT); + } + }; + + var pinColumnRightAction = { + name: 'ui.grid.pinning.pinRight', + title: i18nService.get().pinning.pinRight, + icon: 'ui-grid-icon-right-open', + shown: function () { + return typeof(this.context.col.renderContainer) === 'undefined' || !this.context.col.renderContainer || this.context.col.renderContainer !== 'right'; + }, + action: function () { + service.pinColumn(this.context.col.grid, this.context.col, uiGridPinningConstants.container.RIGHT); + } + }; + + var removePinAction = { + name: 'ui.grid.pinning.unpin', + title: i18nService.get().pinning.unpin, + icon: 'ui-grid-icon-cancel', + shown: function () { + return typeof(this.context.col.renderContainer) !== 'undefined' && this.context.col.renderContainer !== null && this.context.col.renderContainer !== 'body'; + }, + action: function () { + service.pinColumn(this.context.col.grid, this.context.col, uiGridPinningConstants.container.NONE); + } + }; + + // Skip from menu if hidePinLeft or hidePinRight is true + if (!colDef.hidePinLeft && !gridUtil.arrayContainsObjectWithProperty(col.menuItems, 'name', 'ui.grid.pinning.pinLeft')) { + col.menuItems.push(pinColumnLeftAction); + } + if (!colDef.hidePinRight && !gridUtil.arrayContainsObjectWithProperty(col.menuItems, 'name', 'ui.grid.pinning.pinRight')) { + col.menuItems.push(pinColumnRightAction); + } + if (!gridUtil.arrayContainsObjectWithProperty(col.menuItems, 'name', 'ui.grid.pinning.unpin')) { + col.menuItems.push(removePinAction); + } + }, + + pinColumn: function(grid, col, container) { + if (container === uiGridPinningConstants.container.NONE) { + col.renderContainer = null; + col.colDef.pinnedLeft = col.colDef.pinnedRight = false; + } + else { + col.renderContainer = container; + if (container === uiGridPinningConstants.container.LEFT) { + grid.createLeftContainer(); + } + else if (container === uiGridPinningConstants.container.RIGHT) { + grid.createRightContainer(); + } + } + + grid.refresh() + .then(function() { + grid.api.pinning.raise.columnPinned( col.colDef, container ); + }); + } + }; + + return service; + }]); + + module.directive('uiGridPinning', ['gridUtil', 'uiGridPinningService', + function (gridUtil, uiGridPinningService) { + return { + require: 'uiGrid', + scope: false, + compile: function () { + return { + pre: function ($scope, $elm, $attrs, uiGridCtrl) { + uiGridPinningService.initializeGrid(uiGridCtrl.grid); + }, + post: function ($scope, $elm, $attrs, uiGridCtrl) { + } + }; + } + }; + }]); +})(); diff --git a/release/4.9.2/i18n/ui-grid.pinning.min.js b/release/4.9.2/i18n/ui-grid.pinning.min.js new file mode 100644 index 000000000..e1c7607de --- /dev/null +++ b/release/4.9.2/i18n/ui-grid.pinning.min.js @@ -0,0 +1,7 @@ +/*! + * ui-grid - v4.9.2 - 2020-12-01 + * Copyright (c) 2020 ; License: MIT + */ + + +!function(){"use strict";var n=angular.module("ui.grid.pinning",["ui.grid"]);n.constant("uiGridPinningConstants",{container:{LEFT:"left",RIGHT:"right",NONE:""}}),n.service("uiGridPinningService",["gridUtil","GridRenderContainer","i18nService","uiGridPinningConstants",function(c,n,d,u){var a={initializeGrid:function(e){a.defaultGridOptions(e.options),e.registerColumnBuilder(a.pinningColumnBuilder);var n={events:{pinning:{columnPinned:function(n,i){}}},methods:{pinning:{pinColumn:function(n,i){a.pinColumn(e,n,i)}}}};e.api.registerEventsFromObject(n.events),e.api.registerMethodsFromObject(n.methods)},defaultGridOptions:function(n){n.enablePinning=!1!==n.enablePinning,n.hidePinLeft=n.enablePinning&&n.hidePinLeft,n.hidePinRight=n.enablePinning&&n.hidePinRight},pinningColumnBuilder:function(n,i,e){if(n.enablePinning=void 0===n.enablePinning?e.enablePinning:n.enablePinning,n.hidePinLeft=void 0===n.hidePinLeft?e.hidePinLeft:n.hidePinLeft,n.hidePinRight=void 0===n.hidePinRight?e.hidePinRight:n.hidePinRight,n.pinnedLeft?(i.renderContainer="left",i.grid.createLeftContainer()):n.pinnedRight&&(i.renderContainer="right",i.grid.createRightContainer()),n.enablePinning){var t={name:"ui.grid.pinning.pinLeft",title:d.get().pinning.pinLeft,icon:"ui-grid-icon-left-open",shown:function(){return void 0===this.context.col.renderContainer||!this.context.col.renderContainer||"left"!==this.context.col.renderContainer},action:function(){a.pinColumn(this.context.col.grid,this.context.col,u.container.LEFT)}},r={name:"ui.grid.pinning.pinRight",title:d.get().pinning.pinRight,icon:"ui-grid-icon-right-open",shown:function(){return void 0===this.context.col.renderContainer||!this.context.col.renderContainer||"right"!==this.context.col.renderContainer},action:function(){a.pinColumn(this.context.col.grid,this.context.col,u.container.RIGHT)}},o={name:"ui.grid.pinning.unpin",title:d.get().pinning.unpin,icon:"ui-grid-icon-cancel",shown:function(){return void 0!==this.context.col.renderContainer&&null!==this.context.col.renderContainer&&"body"!==this.context.col.renderContainer},action:function(){a.pinColumn(this.context.col.grid,this.context.col,u.container.NONE)}};n.hidePinLeft||c.arrayContainsObjectWithProperty(i.menuItems,"name","ui.grid.pinning.pinLeft")||i.menuItems.push(t),n.hidePinRight||c.arrayContainsObjectWithProperty(i.menuItems,"name","ui.grid.pinning.pinRight")||i.menuItems.push(r),c.arrayContainsObjectWithProperty(i.menuItems,"name","ui.grid.pinning.unpin")||i.menuItems.push(o)}},pinColumn:function(n,i,e){e===u.container.NONE?(i.renderContainer=null,i.colDef.pinnedLeft=i.colDef.pinnedRight=!1):(i.renderContainer=e)===u.container.LEFT?n.createLeftContainer():e===u.container.RIGHT&&n.createRightContainer(),n.refresh().then(function(){n.api.pinning.raise.columnPinned(i.colDef,e)})}};return a}]),n.directive("uiGridPinning",["gridUtil","uiGridPinningService",function(n,r){return{require:"uiGrid",scope:!1,compile:function(){return{pre:function(n,i,e,t){r.initializeGrid(t.grid)},post:function(n,i,e,t){}}}}}])}(); \ No newline at end of file diff --git a/release/4.9.2/i18n/ui-grid.resize-columns.js b/release/4.9.2/i18n/ui-grid.resize-columns.js new file mode 100644 index 000000000..52f8b97f4 --- /dev/null +++ b/release/4.9.2/i18n/ui-grid.resize-columns.js @@ -0,0 +1,573 @@ +/*! + * ui-grid - v4.9.2 - 2020-12-01 + * Copyright (c) 2020 ; License: MIT + */ + +(function() { + 'use strict'; + + /** + * @ngdoc overview + * @name ui.grid.resizeColumns + * @description + * + * # ui.grid.resizeColumns + * + * Stable This feature is stable. There should no longer be breaking api changes without a deprecation warning.
+ *
+ * This module allows columns to be resized.
+ */
+ var module = angular.module('ui.grid.resizeColumns', ['ui.grid']);
+
+ module.service('uiGridResizeColumnsService', ['gridUtil', '$q', '$rootScope',
+ function (gridUtil, $q, $rootScope) {
+ return {
+ defaultGridOptions: function(gridOptions) {
+ // default option to true unless it was explicitly set to false
+ /**
+ * @ngdoc object
+ * @name ui.grid.resizeColumns.api:GridOptions
+ *
+ * @description GridOptions for resizeColumns feature, these are available to be
+ * set using the ui-grid {@link ui.grid.class:GridOptions gridOptions}
+ */
+
+ /**
+ * @ngdoc object
+ * @name enableColumnResizing
+ * @propertyOf ui.grid.resizeColumns.api:GridOptions
+ * @description Enable column resizing on the entire grid
+ * Defaults to true + */ + gridOptions.enableColumnResizing = gridOptions.enableColumnResizing !== false; + + // legacy support + // use old name if it is explicitly false + if (gridOptions.enableColumnResize === false) { + gridOptions.enableColumnResizing = false; + } + }, + + colResizerColumnBuilder: function (colDef, col, gridOptions) { + var promises = []; + + /** + * @ngdoc object + * @name ui.grid.resizeColumns.api:ColumnDef + * + * @description ColumnDef for resizeColumns feature, these are available to be + * set using the ui-grid {@link ui.grid.class:GridOptions.columnDef gridOptions.columnDefs} + */ + + /** + * @ngdoc object + * @name enableColumnResizing + * @propertyOf ui.grid.resizeColumns.api:ColumnDef + * @description Enable column resizing on an individual column + * Defaults to GridOptions.enableColumnResizing + */ + // default to true unless gridOptions or colDef is explicitly false + colDef.enableColumnResizing = colDef.enableColumnResizing === undefined ? gridOptions.enableColumnResizing : colDef.enableColumnResizing; + + + // legacy support of old option name + if (colDef.enableColumnResize === false) { + colDef.enableColumnResizing = false; + } + + return $q.all(promises); + }, + + registerPublicApi: function (grid) { + /** + * @ngdoc object + * @name ui.grid.resizeColumns.api:PublicApi + * @description Public Api for column resize feature. + */ + var publicApi = { + events: { + /** + * @ngdoc event + * @name columnSizeChanged + * @eventOf ui.grid.resizeColumns.api:PublicApi + * @description raised when column is resized + *
+ * gridApi.colResizable.on.columnSizeChanged(scope,function(colDef, deltaChange) {})
+ *
+ * @param {object} colDef the column that was resized
+ * @param {integer} delta of the column size change
+ */
+ colResizable: {
+ columnSizeChanged: function (colDef, deltaChange) {
+ }
+ }
+ }
+ };
+ grid.api.registerEventsFromObject(publicApi.events);
+ },
+
+ fireColumnSizeChanged: function (grid, colDef, deltaChange) {
+ $rootScope.$applyAsync(function () {
+ if ( grid.api.colResizable ) {
+ grid.api.colResizable.raise.columnSizeChanged(colDef, deltaChange);
+ } else {
+ gridUtil.logError("The resizeable api is not registered, this may indicate that you've included the module but not added the 'ui-grid-resize-columns' directive to your grid definition. Cannot raise any events.");
+ }
+ });
+ },
+
+ // get either this column, or the column next to this column, to resize,
+ // returns the column we're going to resize
+ findTargetCol: function(col, position, rtlMultiplier) {
+ var renderContainer = col.getRenderContainer();
+
+ if (position === 'left') {
+ // Get the column to the left of this one
+ var colIndex = renderContainer.visibleColumnCache.indexOf(col);
+ if (colIndex === 0) {
+ return renderContainer.visibleColumnCache[0];
+ }
+ return renderContainer.visibleColumnCache[colIndex - 1 * rtlMultiplier];
+ } else {
+ return col;
+ }
+ }
+ };
+ }]);
+
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.resizeColumns.directive:uiGridResizeColumns
+ * @element div
+ * @restrict A
+ * @description
+ * Enables resizing for all columns on the grid. If, for some reason, you want to use the ui-grid-resize-columns directive, but not allow column resizing, you can explicitly set the
+ * option to false. This prevents resizing for the entire grid, regardless of individual columnDef options.
+ *
+ * @example
+
+
+
+
+
+
+ Stable This feature is stable. There should no longer be breaking api changes without a deprecation warning.
+ *
+ * This module extends the edit feature to provide tracking and saving of rows
+ * of data. The tutorial provides more information on how this feature is best
+ * used {@link tutorial/205_row_editable here}.
+ * + * This feature depends on usage of the ui-grid-edit feature, and also benefits + * from use of ui-grid-cellNav to provide the full spreadsheet-like editing + * experience + * + */ + + var module = angular.module('ui.grid.rowEdit', ['ui.grid', 'ui.grid.edit', 'ui.grid.cellNav']); + + /** + * @ngdoc object + * @name ui.grid.rowEdit.constant:uiGridRowEditConstants + * + * @description constants available in row edit module + */ + module.constant('uiGridRowEditConstants', { + }); + + /** + * @ngdoc service + * @name ui.grid.rowEdit.service:uiGridRowEditService + * + * @description Services for row editing features + */ + module.service('uiGridRowEditService', ['$interval', '$q', 'uiGridConstants', 'uiGridRowEditConstants', 'gridUtil', + function ($interval, $q, uiGridConstants, uiGridRowEditConstants, gridUtil) { + + var service = { + + initializeGrid: function (scope, grid) { + /** + * @ngdoc object + * @name ui.grid.rowEdit.api:PublicApi + * + * @description Public Api for rowEdit feature + */ + + grid.rowEdit = {}; + + var publicApi = { + events: { + rowEdit: { + /** + * @ngdoc event + * @eventOf ui.grid.rowEdit.api:PublicApi + * @name saveRow + * @description raised when a row is ready for saving. Once your + * row has saved you may need to use angular.extend to update the + * data entity with any changed data from your save (for example, + * lock version information if you're using optimistic locking, + * or last update time/user information). + * + * Your method should call setSavePromise somewhere in the body before + * returning control. The feature will then wait, with the gridRow greyed out + * whilst this promise is being resolved. + * + *
+ * gridApi.rowEdit.on.saveRow(scope,function(rowEntity) {})
+ *
+ * and somewhere within the event handler:
+ * + * gridApi.rowEdit.setSavePromise( rowEntity, savePromise) + *+ * @param {object} rowEntity the options.data element that was edited + * @returns {promise} Your saveRow method should return a promise, the + * promise should either be resolved (implying successful save), or + * rejected (implying an error). + */ + saveRow: function (rowEntity) { + } + } + }, + methods: { + rowEdit: { + /** + * @ngdoc method + * @methodOf ui.grid.rowEdit.api:PublicApi + * @name setSavePromise + * @description Sets the promise associated with the row save, mandatory that + * the saveRow event handler calls this method somewhere before returning. + * + * gridApi.rowEdit.setSavePromise(rowEntity, savePromise) + *+ * @param {object} rowEntity a data row from the grid for which a save has + * been initiated + * @param {promise} savePromise the promise that will be resolved when the + * save is successful, or rejected if the save fails + * + */ + setSavePromise: function ( rowEntity, savePromise) { + service.setSavePromise(grid, rowEntity, savePromise); + }, + /** + * @ngdoc method + * @methodOf ui.grid.rowEdit.api:PublicApi + * @name getDirtyRows + * @description Returns all currently dirty rows + * + * gridApi.rowEdit.getDirtyRows(grid) + *+ * @returns {array} An array of gridRows that are currently dirty + * + */ + getDirtyRows: function () { + return grid.rowEdit.dirtyRows ? grid.rowEdit.dirtyRows : []; + }, + /** + * @ngdoc method + * @methodOf ui.grid.rowEdit.api:PublicApi + * @name getErrorRows + * @description Returns all currently errored rows + * + * gridApi.rowEdit.getErrorRows(grid) + *+ * @returns {array} An array of gridRows that are currently in error + * + */ + getErrorRows: function () { + return grid.rowEdit.errorRows ? grid.rowEdit.errorRows : []; + }, + /** + * @ngdoc method + * @methodOf ui.grid.rowEdit.api:PublicApi + * @name flushDirtyRows + * @description Triggers a save event for all currently dirty rows, could + * be used where user presses a save button or navigates away from the page + * + * gridApi.rowEdit.flushDirtyRows(grid) + *+ * @returns {promise} a promise that represents the aggregate of all + * of the individual save promises - i.e. it will be resolved when all + * the individual save promises have been resolved. + * + */ + flushDirtyRows: function () { + return service.flushDirtyRows(grid); + }, + + /** + * @ngdoc method + * @methodOf ui.grid.rowEdit.api:PublicApi + * @name setRowsDirty + * @description Sets each of the rows passed in dataRows + * to be dirty. Note that if you have only just inserted the + * rows into your data you will need to wait for a $digest cycle + * before the gridRows are present - so often you would wrap this + * call in a $interval or $timeout. Also, you must pass row.entity + * into this function rather than row objects themselves. + *
+ * $interval( function() {
+ * gridApi.rowEdit.setRowsDirty(myDataRows);
+ * }, 0, 1);
+ *
+ * @param {array} dataRows the data entities for which the gridRows
+ * should be set dirty.
+ *
+ */
+ setRowsDirty: function ( dataRows) {
+ service.setRowsDirty(grid, dataRows);
+ },
+
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.rowEdit.api:PublicApi
+ * @name setRowsClean
+ * @description Sets each of the rows passed in dataRows
+ * to be clean, removing them from the dirty cache and the error cache,
+ * and clearing the error flag and the dirty flag
+ *
+ * var gridRows = $scope.gridApi.rowEdit.getDirtyRows();
+ * var dataRows = gridRows.map( function( gridRow ) { return gridRow.entity; });
+ * $scope.gridApi.rowEdit.setRowsClean( dataRows );
+ *
+ * @param {array} dataRows the data entities for which the gridRows
+ * should be set clean.
+ *
+ */
+ setRowsClean: function ( dataRows) {
+ service.setRowsClean(grid, dataRows);
+ }
+ }
+ }
+ };
+
+ grid.api.registerEventsFromObject(publicApi.events);
+ grid.api.registerMethodsFromObject(publicApi.methods);
+
+ grid.api.core.on.renderingComplete( scope, function ( gridApi ) {
+ grid.api.edit.on.afterCellEdit( scope, service.endEditCell );
+ grid.api.edit.on.beginCellEdit( scope, service.beginEditCell );
+ grid.api.edit.on.cancelCellEdit( scope, service.cancelEditCell );
+
+ if ( grid.api.cellNav ) {
+ grid.api.cellNav.on.navigate( scope, service.navigate );
+ }
+ });
+
+ },
+
+ defaultGridOptions: function (gridOptions) {
+
+ /**
+ * @ngdoc object
+ * @name ui.grid.rowEdit.api:GridOptions
+ *
+ * @description Options for configuring the rowEdit feature, these are available to be
+ * set using the ui-grid {@link ui.grid.class:GridOptions gridOptions}
+ */
+
+ },
+
+
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.rowEdit.service:uiGridRowEditService
+ * @name saveRow
+ * @description Returns a function that saves the specified row from the grid,
+ * and returns a promise
+ * @param {object} grid the grid for which dirty rows should be flushed
+ * @param {GridRow} gridRow the row that should be saved
+ * @returns {function} the saveRow function returns a function. That function
+ * in turn, when called, returns a promise relating to the save callback
+ */
+ saveRow: function ( grid, gridRow ) {
+ var self = this;
+
+ return function() {
+ gridRow.isSaving = true;
+
+ if ( gridRow.rowEditSavePromise ) {
+ // don't save the row again if it's already saving - that causes stale object exceptions
+ return gridRow.rowEditSavePromise;
+ }
+
+ var promise = grid.api.rowEdit.raise.saveRow( gridRow.entity );
+
+ if ( gridRow.rowEditSavePromise ) {
+ gridRow.rowEditSavePromise.then( self.processSuccessPromise( grid, gridRow ), self.processErrorPromise( grid, gridRow ));
+ } else {
+ gridUtil.logError( 'A promise was not returned when saveRow event was raised, either nobody is listening to event, or event handler did not return a promise' );
+ }
+ return promise;
+ };
+ },
+
+
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.rowEdit.service:uiGridRowEditService
+ * @name setSavePromise
+ * @description Sets the promise associated with the row save, mandatory that
+ * the saveRow event handler calls this method somewhere before returning.
+ * + * gridApi.rowEdit.setSavePromise(grid, rowEntity) + *+ * @param {object} grid the grid for which dirty rows should be returned + * @param {object} rowEntity a data row from the grid for which a save has + * been initiated + * @param {promise} savePromise the promise that will be resolved when the + * save is successful, or rejected if the save fails + * + */ + setSavePromise: function (grid, rowEntity, savePromise) { + var gridRow = grid.getRow( rowEntity ); + gridRow.rowEditSavePromise = savePromise; + }, + + + /** + * @ngdoc method + * @methodOf ui.grid.rowEdit.service:uiGridRowEditService + * @name processSuccessPromise + * @description Returns a function that processes the successful + * resolution of a save promise + * @param {object} grid the grid for which the promise should be processed + * @param {GridRow} gridRow the row that has been saved + * @returns {function} the success handling function + */ + processSuccessPromise: function ( grid, gridRow ) { + var self = this; + + return function() { + delete gridRow.isSaving; + delete gridRow.isDirty; + delete gridRow.isError; + delete gridRow.rowEditSaveTimer; + delete gridRow.rowEditSavePromise; + self.removeRow( grid.rowEdit.errorRows, gridRow ); + self.removeRow( grid.rowEdit.dirtyRows, gridRow ); + }; + }, + + + /** + * @ngdoc method + * @methodOf ui.grid.rowEdit.service:uiGridRowEditService + * @name processErrorPromise + * @description Returns a function that processes the failed + * resolution of a save promise + * @param {object} grid the grid for which the promise should be processed + * @param {GridRow} gridRow the row that is now in error + * @returns {function} the error handling function + */ + processErrorPromise: function ( grid, gridRow ) { + return function() { + delete gridRow.isSaving; + delete gridRow.rowEditSaveTimer; + delete gridRow.rowEditSavePromise; + + gridRow.isError = true; + + if (!grid.rowEdit.errorRows) { + grid.rowEdit.errorRows = []; + } + if (!service.isRowPresent( grid.rowEdit.errorRows, gridRow ) ) { + grid.rowEdit.errorRows.push( gridRow ); + } + }; + }, + + + /** + * @ngdoc method + * @methodOf ui.grid.rowEdit.service:uiGridRowEditService + * @name removeRow + * @description Removes a row from a cache of rows - either + * grid.rowEdit.errorRows or grid.rowEdit.dirtyRows. If the row + * is not present silently does nothing. + * @param {array} rowArray the array from which to remove the row + * @param {GridRow} gridRow the row that should be removed + */ + removeRow: function( rowArray, removeGridRow ) { + if (typeof(rowArray) === 'undefined' || rowArray === null) { + return; + } + + rowArray.forEach( function( gridRow, index ) { + if ( gridRow.uid === removeGridRow.uid ) { + rowArray.splice( index, 1); + } + }); + }, + + + /** + * @ngdoc method + * @methodOf ui.grid.rowEdit.service:uiGridRowEditService + * @name isRowPresent + * @description Checks whether a row is already present + * in the given array + * @param {array} rowArray the array in which to look for the row + * @param {GridRow} gridRow the row that should be looked for + */ + isRowPresent: function( rowArray, removeGridRow ) { + var present = false; + rowArray.forEach( function( gridRow, index ) { + if ( gridRow.uid === removeGridRow.uid ) { + present = true; + } + }); + return present; + }, + + + /** + * @ngdoc method + * @methodOf ui.grid.rowEdit.service:uiGridRowEditService + * @name flushDirtyRows + * @description Triggers a save event for all currently dirty rows, could + * be used where user presses a save button or navigates away from the page + * + * gridApi.rowEdit.flushDirtyRows(grid) + *+ * @param {object} grid the grid for which dirty rows should be flushed + * @returns {promise} a promise that represents the aggregate of all + * of the individual save promises - i.e. it will be resolved when all + * the individual save promises have been resolved. + * + */ + flushDirtyRows: function(grid) { + var promises = []; + grid.api.rowEdit.getDirtyRows().forEach( function( gridRow ) { + service.cancelTimer( grid, gridRow ); + service.saveRow( grid, gridRow )(); + promises.push( gridRow.rowEditSavePromise ); + }); + + return $q.all( promises ); + }, + + + /** + * @ngdoc method + * @methodOf ui.grid.rowEdit.service:uiGridRowEditService + * @name endEditCell + * @description Receives an afterCellEdit event from the edit function, + * and sets flags as appropriate. Only the rowEntity parameter + * is processed, although other params are available. Grid + * is automatically provided by the gridApi. + * @param {object} rowEntity the data entity for which the cell + * was edited + */ + endEditCell: function( rowEntity, colDef, newValue, previousValue ) { + var grid = this.grid; + var gridRow = grid.getRow( rowEntity ); + if ( !gridRow ) { gridUtil.logError( 'Unable to find rowEntity in grid data, dirty flag cannot be set' ); return; } + + if ( newValue !== previousValue || gridRow.isDirty ) { + if ( !grid.rowEdit.dirtyRows ) { + grid.rowEdit.dirtyRows = []; + } + + if ( !gridRow.isDirty ) { + gridRow.isDirty = true; + grid.rowEdit.dirtyRows.push( gridRow ); + } + + delete gridRow.isError; + + service.considerSetTimer( grid, gridRow ); + } + }, + + + /** + * @ngdoc method + * @methodOf ui.grid.rowEdit.service:uiGridRowEditService + * @name beginEditCell + * @description Receives a beginCellEdit event from the edit function, + * and cancels any rowEditSaveTimers if present, as the user is still editing + * this row. Only the rowEntity parameter + * is processed, although other params are available. Grid + * is automatically provided by the gridApi. + * @param {object} rowEntity the data entity for which the cell + * editing has commenced + */ + beginEditCell: function( rowEntity, colDef ) { + var grid = this.grid; + var gridRow = grid.getRow( rowEntity ); + if ( !gridRow ) { gridUtil.logError( 'Unable to find rowEntity in grid data, timer cannot be cancelled' ); return; } + + service.cancelTimer( grid, gridRow ); + }, + + + /** + * @ngdoc method + * @methodOf ui.grid.rowEdit.service:uiGridRowEditService + * @name cancelEditCell + * @description Receives a cancelCellEdit event from the edit function, + * and if the row was already dirty, restarts the save timer. If the row + * was not already dirty, then it's not dirty now either and does nothing. + * + * Only the rowEntity parameter + * is processed, although other params are available. Grid + * is automatically provided by the gridApi. + * + * @param {object} rowEntity the data entity for which the cell + * editing was cancelled + */ + cancelEditCell: function( rowEntity, colDef ) { + var grid = this.grid; + var gridRow = grid.getRow( rowEntity ); + if ( !gridRow ) { gridUtil.logError( 'Unable to find rowEntity in grid data, timer cannot be set' ); return; } + + service.considerSetTimer( grid, gridRow ); + }, + + + /** + * @ngdoc method + * @methodOf ui.grid.rowEdit.service:uiGridRowEditService + * @name navigate + * @description cellNav tells us that the selected cell has changed. If + * the new row had a timer running, then stop it similar to in a beginCellEdit + * call. If the old row is dirty and not the same as the new row, then + * start a timer on it. + * @param {object} newRowCol the row and column that were selected + * @param {object} oldRowCol the row and column that was left + * + */ + navigate: function( newRowCol, oldRowCol ) { + var grid = this.grid; + if ( newRowCol.row.rowEditSaveTimer ) { + service.cancelTimer( grid, newRowCol.row ); + } + + if ( oldRowCol && oldRowCol.row && oldRowCol.row !== newRowCol.row ) { + service.considerSetTimer( grid, oldRowCol.row ); + } + }, + + + /** + * @ngdoc property + * @propertyOf ui.grid.rowEdit.api:GridOptions + * @name rowEditWaitInterval + * @description How long the grid should wait for another change on this row + * before triggering a save (in milliseconds). If set to -1, then saves are + * never triggered by timer (implying that the user will call flushDirtyRows() + * manually) + * + * @example + * Setting the wait interval to 4 seconds + *
+ * $scope.gridOptions = { rowEditWaitInterval: 4000 }
+ *
+ *
+ */
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.rowEdit.service:uiGridRowEditService
+ * @name considerSetTimer
+ * @description Consider setting a timer on this row (if it is dirty). if there is a timer running
+ * on the row and the row isn't currently saving, cancel it, using cancelTimer, then if the row is
+ * dirty and not currently saving then set a new timer
+ * @param {object} grid the grid for which we are processing
+ * @param {GridRow} gridRow the row for which the timer should be adjusted
+ *
+ */
+ considerSetTimer: function( grid, gridRow ) {
+ service.cancelTimer( grid, gridRow );
+
+ if ( gridRow.isDirty && !gridRow.isSaving ) {
+ if ( grid.options.rowEditWaitInterval !== -1 ) {
+ var waitTime = grid.options.rowEditWaitInterval ? grid.options.rowEditWaitInterval : 2000;
+ gridRow.rowEditSaveTimer = $interval( service.saveRow( grid, gridRow ), waitTime, 1);
+ }
+ }
+ },
+
+
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.rowEdit.service:uiGridRowEditService
+ * @name cancelTimer
+ * @description cancel the $interval for any timer running on this row
+ * then delete the timer itself
+ * @param {object} grid the grid for which we are processing
+ * @param {GridRow} gridRow the row for which the timer should be adjusted
+ *
+ */
+ cancelTimer: function( grid, gridRow ) {
+ if ( gridRow.rowEditSaveTimer && !gridRow.isSaving ) {
+ $interval.cancel(gridRow.rowEditSaveTimer);
+ delete gridRow.rowEditSaveTimer;
+ }
+ },
+
+
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.rowEdit.service:uiGridRowEditService
+ * @name setRowsDirty
+ * @description Sets each of the rows passed in dataRows
+ * to be dirty. note that if you have only just inserted the
+ * rows into your data you will need to wait for a $digest cycle
+ * before the gridRows are present - so often you would wrap this
+ * call in a $interval or $timeout
+ *
+ * $interval( function() {
+ * gridApi.rowEdit.setRowsDirty( myDataRows);
+ * }, 0, 1);
+ *
+ * @param {object} grid the grid for which rows should be set dirty
+ * @param {array} dataRows the data entities for which the gridRows
+ * should be set dirty.
+ *
+ */
+ setRowsDirty: function( grid, myDataRows ) {
+ var gridRow;
+ myDataRows.forEach( function( value, index ) {
+ gridRow = grid.getRow( value );
+ if ( gridRow ) {
+ if ( !grid.rowEdit.dirtyRows ) {
+ grid.rowEdit.dirtyRows = [];
+ }
+
+ if ( !gridRow.isDirty ) {
+ gridRow.isDirty = true;
+ grid.rowEdit.dirtyRows.push( gridRow );
+ }
+
+ delete gridRow.isError;
+
+ service.considerSetTimer( grid, gridRow );
+ } else {
+ gridUtil.logError( "requested row not found in rowEdit.setRowsDirty, row was: " + value );
+ }
+ });
+ },
+
+
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.rowEdit.service:uiGridRowEditService
+ * @name setRowsClean
+ * @description Sets each of the rows passed in dataRows
+ * to be clean, clearing the dirty flag and the error flag, and removing
+ * the rows from the dirty and error caches.
+ * @param {object} grid the grid for which rows should be set clean
+ * @param {array} dataRows the data entities for which the gridRows
+ * should be set clean.
+ *
+ */
+ setRowsClean: function( grid, myDataRows ) {
+ var gridRow;
+
+ myDataRows.forEach( function( value, index ) {
+ gridRow = grid.getRow( value );
+ if ( gridRow ) {
+ delete gridRow.isDirty;
+ service.removeRow( grid.rowEdit.dirtyRows, gridRow );
+ service.cancelTimer( grid, gridRow );
+
+ delete gridRow.isError;
+ service.removeRow( grid.rowEdit.errorRows, gridRow );
+ } else {
+ gridUtil.logError( "requested row not found in rowEdit.setRowsClean, row was: " + value );
+ }
+ });
+ }
+
+ };
+
+ return service;
+
+ }]);
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.rowEdit.directive:uiGridEdit
+ * @element div
+ * @restrict A
+ *
+ * @description Adds row editing features to the ui-grid-edit directive.
+ *
+ */
+ module.directive('uiGridRowEdit', ['gridUtil', 'uiGridRowEditService', 'uiGridEditConstants',
+ function (gridUtil, uiGridRowEditService, uiGridEditConstants) {
+ return {
+ replace: true,
+ priority: 0,
+ require: '^uiGrid',
+ scope: false,
+ compile: function () {
+ return {
+ pre: function ($scope, $elm, $attrs, uiGridCtrl) {
+ uiGridRowEditService.initializeGrid($scope, uiGridCtrl.grid);
+ },
+ post: function ($scope, $elm, $attrs, uiGridCtrl) {
+ }
+ };
+ }
+ };
+ }]);
+
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.rowEdit.directive:uiGridViewport
+ * @element div
+ *
+ * @description Stacks on top of ui.grid.uiGridViewport to alter the attributes used
+ * for the grid row to allow coloring of saving and error rows
+ */
+ module.directive('uiGridViewport',
+ ['$compile', 'uiGridConstants', 'gridUtil', '$parse',
+ function ($compile, uiGridConstants, gridUtil, $parse) {
+ return {
+ priority: -200, // run after default directive
+ scope: false,
+ compile: function ($elm, $attrs) {
+ var rowRepeatDiv = angular.element($elm.children().children()[0]);
+
+ var existingNgClass = rowRepeatDiv.attr("ng-class");
+ var newNgClass = '';
+ if ( existingNgClass ) {
+ newNgClass = existingNgClass.slice(0, -1) + ", 'ui-grid-row-dirty': row.isDirty, 'ui-grid-row-saving': row.isSaving, 'ui-grid-row-error': row.isError}";
+ } else {
+ newNgClass = "{'ui-grid-row-dirty': row.isDirty, 'ui-grid-row-saving': row.isSaving, 'ui-grid-row-error': row.isError}";
+ }
+ rowRepeatDiv.attr("ng-class", newNgClass);
+
+ return {
+ pre: function ($scope, $elm, $attrs, controllers) {
+
+ },
+ post: function ($scope, $elm, $attrs, controllers) {
+ }
+ };
+ }
+ };
+ }]);
+
+})();
diff --git a/release/4.9.2/i18n/ui-grid.row-edit.min.js b/release/4.9.2/i18n/ui-grid.row-edit.min.js
new file mode 100644
index 000000000..9d6b8f620
--- /dev/null
+++ b/release/4.9.2/i18n/ui-grid.row-edit.min.js
@@ -0,0 +1,7 @@
+/*!
+ * ui-grid - v4.9.2 - 2020-12-01
+ * Copyright (c) 2020 ; License: MIT
+ */
+
+
+!function(){"use strict";var r=angular.module("ui.grid.rowEdit",["ui.grid","ui.grid.edit","ui.grid.cellNav"]);r.constant("uiGridRowEditConstants",{}),r.service("uiGridRowEditService",["$interval","$q","uiGridConstants","uiGridRowEditConstants","gridUtil",function(t,r,i,e,s){var d={initializeGrid:function(i,e){e.rowEdit={};var r={events:{rowEdit:{saveRow:function(r){}}},methods:{rowEdit:{setSavePromise:function(r,i){d.setSavePromise(e,r,i)},getDirtyRows:function(){return e.rowEdit.dirtyRows?e.rowEdit.dirtyRows:[]},getErrorRows:function(){return e.rowEdit.errorRows?e.rowEdit.errorRows:[]},flushDirtyRows:function(){return d.flushDirtyRows(e)},setRowsDirty:function(r){d.setRowsDirty(e,r)},setRowsClean:function(r){d.setRowsClean(e,r)}}}};e.api.registerEventsFromObject(r.events),e.api.registerMethodsFromObject(r.methods),e.api.core.on.renderingComplete(i,function(r){e.api.edit.on.afterCellEdit(i,d.endEditCell),e.api.edit.on.beginCellEdit(i,d.beginEditCell),e.api.edit.on.cancelCellEdit(i,d.cancelEditCell),e.api.cellNav&&e.api.cellNav.on.navigate(i,d.navigate)})},defaultGridOptions:function(r){},saveRow:function(i,e){var t=this;return function(){if(e.isSaving=!0,e.rowEditSavePromise)return e.rowEditSavePromise;var r=i.api.rowEdit.raise.saveRow(e.entity);return e.rowEditSavePromise?e.rowEditSavePromise.then(t.processSuccessPromise(i,e),t.processErrorPromise(i,e)):s.logError("A promise was not returned when saveRow event was raised, either nobody is listening to event, or event handler did not return a promise"),r}},setSavePromise:function(r,i,e){r.getRow(i).rowEditSavePromise=e},processSuccessPromise:function(r,i){var e=this;return function(){delete i.isSaving,delete i.isDirty,delete i.isError,delete i.rowEditSaveTimer,delete i.rowEditSavePromise,e.removeRow(r.rowEdit.errorRows,i),e.removeRow(r.rowEdit.dirtyRows,i)}},processErrorPromise:function(r,i){return function(){delete i.isSaving,delete i.rowEditSaveTimer,delete i.rowEditSavePromise,i.isError=!0,r.rowEdit.errorRows||(r.rowEdit.errorRows=[]),d.isRowPresent(r.rowEdit.errorRows,i)||r.rowEdit.errorRows.push(i)}},removeRow:function(e,t){null!=e&&e.forEach(function(r,i){r.uid===t.uid&&e.splice(i,1)})},isRowPresent:function(r,e){var t=!1;return r.forEach(function(r,i){r.uid===e.uid&&(t=!0)}),t},flushDirtyRows:function(i){var e=[];return i.api.rowEdit.getDirtyRows().forEach(function(r){d.cancelTimer(i,r),d.saveRow(i,r)(),e.push(r.rowEditSavePromise)}),r.all(e)},endEditCell:function(r,i,e,t){var o=this.grid,n=o.getRow(r);n?(e!==t||n.isDirty)&&(o.rowEdit.dirtyRows||(o.rowEdit.dirtyRows=[]),n.isDirty||(n.isDirty=!0,o.rowEdit.dirtyRows.push(n)),delete n.isError,d.considerSetTimer(o,n)):s.logError("Unable to find rowEntity in grid data, dirty flag cannot be set")},beginEditCell:function(r,i){var e=this.grid,t=e.getRow(r);t?d.cancelTimer(e,t):s.logError("Unable to find rowEntity in grid data, timer cannot be cancelled")},cancelEditCell:function(r,i){var e=this.grid,t=e.getRow(r);t?d.considerSetTimer(e,t):s.logError("Unable to find rowEntity in grid data, timer cannot be set")},navigate:function(r,i){var e=this.grid;r.row.rowEditSaveTimer&&d.cancelTimer(e,r.row),i&&i.row&&i.row!==r.row&&d.considerSetTimer(e,i.row)},considerSetTimer:function(r,i){if(d.cancelTimer(r,i),i.isDirty&&!i.isSaving&&-1!==r.options.rowEditWaitInterval){var e=r.options.rowEditWaitInterval?r.options.rowEditWaitInterval:2e3;i.rowEditSaveTimer=t(d.saveRow(r,i),e,1)}},cancelTimer:function(r,i){i.rowEditSaveTimer&&!i.isSaving&&(t.cancel(i.rowEditSaveTimer),delete i.rowEditSaveTimer)},setRowsDirty:function(e,r){var t;r.forEach(function(r,i){(t=e.getRow(r))?(e.rowEdit.dirtyRows||(e.rowEdit.dirtyRows=[]),t.isDirty||(t.isDirty=!0,e.rowEdit.dirtyRows.push(t)),delete t.isError,d.considerSetTimer(e,t)):s.logError("requested row not found in rowEdit.setRowsDirty, row was: "+r)})},setRowsClean:function(e,r){var t;r.forEach(function(r,i){(t=e.getRow(r))?(delete t.isDirty,d.removeRow(e.rowEdit.dirtyRows,t),d.cancelTimer(e,t),delete t.isError,d.removeRow(e.rowEdit.errorRows,t)):s.logError("requested row not found in rowEdit.setRowsClean, row was: "+r)})}};return d}]),r.directive("uiGridRowEdit",["gridUtil","uiGridRowEditService","uiGridEditConstants",function(r,o,i){return{replace:!0,priority:0,require:"^uiGrid",scope:!1,compile:function(){return{pre:function(r,i,e,t){o.initializeGrid(r,t.grid)},post:function(r,i,e,t){}}}}}]),r.directive("uiGridViewport",["$compile","uiGridConstants","gridUtil","$parse",function(r,i,e,t){return{priority:-200,scope:!1,compile:function(r,i){var e=angular.element(r.children().children()[0]),t=e.attr("ng-class"),o="";return o=t?t.slice(0,-1)+", 'ui-grid-row-dirty': row.isDirty, 'ui-grid-row-saving': row.isSaving, 'ui-grid-row-error': row.isError}":"{'ui-grid-row-dirty': row.isDirty, 'ui-grid-row-saving': row.isSaving, 'ui-grid-row-error': row.isError}",e.attr("ng-class",o),{pre:function(r,i,e,t){},post:function(r,i,e,t){}}}}}])}();
\ No newline at end of file
diff --git a/release/4.9.2/i18n/ui-grid.saveState.js b/release/4.9.2/i18n/ui-grid.saveState.js
new file mode 100644
index 000000000..026421497
--- /dev/null
+++ b/release/4.9.2/i18n/ui-grid.saveState.js
@@ -0,0 +1,830 @@
+/*!
+ * ui-grid - v4.9.2 - 2020-12-01
+ * Copyright (c) 2020 ; License: MIT
+ */
+
+(function () {
+ 'use strict';
+
+ /**
+ * @ngdoc overview
+ * @name ui.grid.saveState
+ * @description
+ *
+ * # ui.grid.saveState
+ *
+ * Stable This feature is stable. There should no longer be breaking api changes without a deprecation warning.
+ *
+ * This module provides the ability to save the grid state, and restore
+ * it when the user returns to the page.
+ *
+ * No UI is provided, the caller should provide their own UI/buttons
+ * as appropriate. Usually the navigate events would be used to save
+ * the grid state and restore it.
+ *
+ * + * + * + * + */ + + var module = angular.module('ui.grid.saveState', ['ui.grid', 'ui.grid.selection', 'ui.grid.cellNav', 'ui.grid.grouping', 'ui.grid.pinning', 'ui.grid.treeView']); + + /** + * @ngdoc object + * @name ui.grid.saveState.constant:uiGridSaveStateConstants + * + * @description constants available in save state module + */ + + module.constant('uiGridSaveStateConstants', { + featureName: 'saveState' + }); + + /** + * @ngdoc service + * @name ui.grid.saveState.service:uiGridSaveStateService + * + * @description Services for saveState feature + */ + module.service('uiGridSaveStateService', + function () { + var service = { + + initializeGrid: function (grid) { + + // add feature namespace and any properties to grid for needed state + grid.saveState = {}; + this.defaultGridOptions(grid.options); + + /** + * @ngdoc object + * @name ui.grid.saveState.api:PublicApi + * + * @description Public Api for saveState feature + */ + var publicApi = { + events: { + saveState: { + } + }, + methods: { + saveState: { + /** + * @ngdoc function + * @name save + * @methodOf ui.grid.saveState.api:PublicApi + * @description Packages the current state of the grid into + * an object, and provides it to the user for saving + * @returns {object} the state as a javascript object that can be saved + */ + save: function () { + return service.save(grid); + }, + /** + * @ngdoc function + * @name restore + * @methodOf ui.grid.saveState.api:PublicApi + * @description Restores the provided state into the grid + * @param {scope} $scope a scope that we can broadcast on + * @param {object} state the state that should be restored into the grid + * @returns {object} the promise created by refresh + */ + restore: function ( $scope, state) { + return service.restore(grid, $scope, state); + } + } + } + }; + + grid.api.registerEventsFromObject(publicApi.events); + + grid.api.registerMethodsFromObject(publicApi.methods); + }, + + defaultGridOptions: function (gridOptions) { + // default option to true unless it was explicitly set to false + /** + * @ngdoc object + * @name ui.grid.saveState.api:GridOptions + * + * @description GridOptions for saveState feature, these are available to be + * set using the ui-grid {@link ui.grid.class:GridOptions gridOptions} + */ + /** + * @ngdoc object + * @name saveWidths + * @propertyOf ui.grid.saveState.api:GridOptions + * @description Save the current column widths. Note that unless + * you've provided the user with some way to resize their columns (say + * the resize columns feature), then this makes little sense. + * Defaults to true + */ + gridOptions.saveWidths = gridOptions.saveWidths !== false; + /** + * @ngdoc object + * @name saveOrder + * @propertyOf ui.grid.saveState.api:GridOptions + * @description Restore the current column order. Note that unless + * you've provided the user with some way to reorder their columns (for + * example the move columns feature), this makes little sense. + * Defaults to true + */ + gridOptions.saveOrder = gridOptions.saveOrder !== false; + /** + * @ngdoc object + * @name saveScroll + * @propertyOf ui.grid.saveState.api:GridOptions + * @description Save the current scroll position. Note that this + * is saved as the percentage of the grid scrolled - so if your + * user returns to a grid with a significantly different number of + * rows (perhaps some data has been deleted) then the scroll won't + * actually show the same rows as before. If you want to scroll to + * a specific row then you should instead use the saveFocus option, which + * is the default. + * + * Note that this element will only be saved if the cellNav feature is + * enabled + * Defaults to false + */ + gridOptions.saveScroll = gridOptions.saveScroll === true; + /** + * @ngdoc object + * @name saveFocus + * @propertyOf ui.grid.saveState.api:GridOptions + * @description Save the current focused cell. On returning + * to this focused cell we'll also scroll. This option is + * preferred to the saveScroll option, so is set to true by + * default. If saveScroll is set to true then this option will + * be disabled. + * + * By default this option saves the current row number and column + * number, and returns to that row and column. However, if you define + * a saveRowIdentity function, then it will return you to the currently + * selected column within that row (in a business sense - so if some + * rows have been deleted, it will still find the same data, presuming it + * still exists in the list. If it isn't in the list then it will instead + * return to the same row number - i.e. scroll percentage) + * + * Note that this option will do nothing if the cellNav + * feature is not enabled. + * + * Defaults to true (unless saveScroll is true) + */ + gridOptions.saveFocus = gridOptions.saveScroll !== true && gridOptions.saveFocus !== false; + /** + * @ngdoc object + * @name saveRowIdentity + * @propertyOf ui.grid.saveState.api:GridOptions + * @description A function that can be called, passing in a rowEntity, + * and that will return a unique id for that row. This might simply + * return the `id` field from that row (if you have one), or it might + * concatenate some fields within the row to make a unique value. + * + * This value will be used to find the same row again and set the focus + * to it, if it exists when we return. + * + * Defaults to undefined + */ + /** + * @ngdoc object + * @name saveVisible + * @propertyOf ui.grid.saveState.api:GridOptions + * @description Save whether or not columns are visible. + * + * Defaults to true + */ + gridOptions.saveVisible = gridOptions.saveVisible !== false; + /** + * @ngdoc object + * @name saveSort + * @propertyOf ui.grid.saveState.api:GridOptions + * @description Save the current sort state for each column + * + * Defaults to true + */ + gridOptions.saveSort = gridOptions.saveSort !== false; + /** + * @ngdoc object + * @name saveFilter + * @propertyOf ui.grid.saveState.api:GridOptions + * @description Save the current filter state for each column + * + * Defaults to true + */ + gridOptions.saveFilter = gridOptions.saveFilter !== false; + /** + * @ngdoc object + * @name saveSelection + * @propertyOf ui.grid.saveState.api:GridOptions + * @description Save the currently selected rows. If the `saveRowIdentity` callback + * is defined, then it will save the id of the row and select that. If not, then + * it will attempt to select the rows by row number, which will give the wrong results + * if the data set has changed in the mean-time. + * + * Note that this option only does anything + * if the selection feature is enabled. + * + * Defaults to true + */ + gridOptions.saveSelection = gridOptions.saveSelection !== false; + /** + * @ngdoc object + * @name saveGrouping + * @propertyOf ui.grid.saveState.api:GridOptions + * @description Save the grouping configuration. If set to true and the + * grouping feature is not enabled then does nothing. + * + * Defaults to true + */ + gridOptions.saveGrouping = gridOptions.saveGrouping !== false; + /** + * @ngdoc object + * @name saveGroupingExpandedStates + * @propertyOf ui.grid.saveState.api:GridOptions + * @description Save the grouping row expanded states. If set to true and the + * grouping feature is not enabled then does nothing. + * + * This can be quite a bit of data, in many cases you wouldn't want to save this + * information. + * + * Defaults to false + */ + gridOptions.saveGroupingExpandedStates = gridOptions.saveGroupingExpandedStates === true; + /** + * @ngdoc object + * @name savePinning + * @propertyOf ui.grid.saveState.api:GridOptions + * @description Save pinning state for columns. + * + * Defaults to true + */ + gridOptions.savePinning = gridOptions.savePinning !== false; + /** + * @ngdoc object + * @name saveTreeView + * @propertyOf ui.grid.saveState.api:GridOptions + * @description Save the treeView configuration. If set to true and the + * treeView feature is not enabled then does nothing. + * + * Defaults to true + */ + gridOptions.saveTreeView = gridOptions.saveTreeView !== false; + }, + + /** + * @ngdoc function + * @name save + * @methodOf ui.grid.saveState.service:uiGridSaveStateService + * @description Saves the current grid state into an object, and + * passes that object back to the caller + * @param {Grid} grid the grid whose state we'd like to save + * @returns {object} the state ready to be saved + */ + save: function (grid) { + var savedState = {}; + + savedState.columns = service.saveColumns( grid ); + savedState.scrollFocus = service.saveScrollFocus( grid ); + savedState.selection = service.saveSelection( grid ); + savedState.grouping = service.saveGrouping( grid ); + savedState.treeView = service.saveTreeView( grid ); + savedState.pagination = service.savePagination( grid ); + + return savedState; + }, + + + /** + * @ngdoc function + * @name restore + * @methodOf ui.grid.saveState.service:uiGridSaveStateService + * @description Applies the provided state to the grid + * + * @param {Grid} grid the grid whose state we'd like to restore + * @param {scope} $scope a scope that we can broadcast on + * @param {object} state the state we'd like to restore + * @returns {object} the promise created by refresh + */ + restore: function( grid, $scope, state ) { + if ( state.columns ) { + service.restoreColumns( grid, state.columns ); + } + + if ( state.scrollFocus ) { + service.restoreScrollFocus( grid, $scope, state.scrollFocus ); + } + + if ( state.selection ) { + service.restoreSelection( grid, state.selection ); + } + + if ( state.grouping ) { + service.restoreGrouping( grid, state.grouping ); + } + + if ( state.treeView ) { + service.restoreTreeView( grid, state.treeView ); + } + + if ( state.pagination ) { + service.restorePagination( grid, state.pagination ); + } + + return grid.refresh(); + }, + + + /** + * @ngdoc function + * @name saveColumns + * @methodOf ui.grid.saveState.service:uiGridSaveStateService + * @description Saves the column setup, including sort, filters, ordering, + * pinning and column widths. + * + * Works through the current columns, storing them in order. Stores the + * column name, then the visible flag, width, sort and filters for each column. + * + * @param {Grid} grid the grid whose state we'd like to save + * @returns {array} the columns state ready to be saved + */ + saveColumns: function( grid ) { + var columns = []; + + grid.getOnlyDataColumns().forEach( function( column ) { + var savedColumn = {}; + savedColumn.name = column.name; + + if ( grid.options.saveVisible ) { + savedColumn.visible = column.visible; + } + + if ( grid.options.saveWidths ) { + savedColumn.width = column.width; + } + + // these two must be copied, not just pointed too - otherwise our saved state is pointing to the same object as current state + if ( grid.options.saveSort ) { + savedColumn.sort = angular.copy( column.sort ); + } + + if ( grid.options.saveFilter ) { + savedColumn.filters = []; + column.filters.forEach( function( filter ) { + var copiedFilter = {}; + angular.forEach( filter, function( value, key) { + if ( key !== 'condition' && key !== '$$hashKey' && key !== 'placeholder') { + copiedFilter[key] = value; + } + }); + savedColumn.filters.push(copiedFilter); + }); + } + + if ( !!grid.api.pinning && grid.options.savePinning ) { + savedColumn.pinned = column.renderContainer ? column.renderContainer : ''; + } + + columns.push( savedColumn ); + }); + + return columns; + }, + + + /** + * @ngdoc function + * @name saveScrollFocus + * @methodOf ui.grid.saveState.service:uiGridSaveStateService + * @description Saves the currently scroll or focus. + * + * If cellNav isn't present then does nothing - we can't return + * to the scroll position without cellNav anyway. + * + * If the cellNav module is present, and saveFocus is true, then + * it saves the currently focused cell. If rowIdentity is present + * then saves using rowIdentity, otherwise saves visibleRowNum. + * + * If the cellNav module is not present, and saveScroll is true, then + * it approximates the current scroll row and column, and saves that. + * + * @param {Grid} grid the grid whose state we'd like to save + * @returns {object} the selection state ready to be saved + */ + saveScrollFocus: function( grid ) { + if ( !grid.api.cellNav ) { + return {}; + } + + var scrollFocus = {}; + if ( grid.options.saveFocus ) { + scrollFocus.focus = true; + var rowCol = grid.api.cellNav.getFocusedCell(); + if ( rowCol !== null ) { + if ( rowCol.col !== null ) { + scrollFocus.colName = rowCol.col.colDef.name; + } + if ( rowCol.row !== null ) { + scrollFocus.rowVal = service.getRowVal( grid, rowCol.row ); + } + } + } + + if ( grid.options.saveScroll || grid.options.saveFocus && !scrollFocus.colName && !scrollFocus.rowVal ) { + scrollFocus.focus = false; + if ( grid.renderContainers.body.prevRowScrollIndex ) { + scrollFocus.rowVal = service.getRowVal( grid, grid.renderContainers.body.visibleRowCache[ grid.renderContainers.body.prevRowScrollIndex ]); + } + + if ( grid.renderContainers.body.prevColScrollIndex ) { + scrollFocus.colName = grid.renderContainers.body.visibleColumnCache[ grid.renderContainers.body.prevColScrollIndex ].name; + } + } + + return scrollFocus; + }, + + + /** + * @ngdoc function + * @name saveSelection + * @methodOf ui.grid.saveState.service:uiGridSaveStateService + * @description Saves the currently selected rows, if the selection feature is enabled + * @param {Grid} grid the grid whose state we'd like to save + * @returns {array} the selection state ready to be saved + */ + saveSelection: function( grid ) { + if ( !grid.api.selection || !grid.options.saveSelection ) { + return []; + } + + return grid.api.selection.getSelectedGridRows().map( function( gridRow ) { + return service.getRowVal( grid, gridRow ); + }); + }, + + + /** + * @ngdoc function + * @name saveGrouping + * @methodOf ui.grid.saveState.service:uiGridSaveStateService + * @description Saves the grouping state, if the grouping feature is enabled + * @param {Grid} grid the grid whose state we'd like to save + * @returns {object} the grouping state ready to be saved + */ + saveGrouping: function( grid ) { + if ( !grid.api.grouping || !grid.options.saveGrouping ) { + return {}; + } + + return grid.api.grouping.getGrouping( grid.options.saveGroupingExpandedStates ); + }, + + + /** + * @ngdoc function + * @name savePagination + * @methodOf ui.grid.saveState.service:uiGridSaveStateService + * @description Saves the pagination state, if the pagination feature is enabled + * @param {Grid} grid the grid whose state we'd like to save + * @returns {object} the pagination state ready to be saved + */ + savePagination: function( grid ) { + if ( !grid.api.pagination || !grid.options.paginationPageSize ) { + return {}; + } + + return { + paginationCurrentPage: grid.options.paginationCurrentPage, + paginationPageSize: grid.options.paginationPageSize + }; + }, + + + /** + * @ngdoc function + * @name saveTreeView + * @methodOf ui.grid.saveState.service:uiGridSaveStateService + * @description Saves the tree view state, if the tree feature is enabled + * @param {Grid} grid the grid whose state we'd like to save + * @returns {object} the tree view state ready to be saved + */ + saveTreeView: function( grid ) { + if ( !grid.api.treeView || !grid.options.saveTreeView ) { + return {}; + } + + return grid.api.treeView.getTreeView(); + }, + + + /** + * @ngdoc function + * @name getRowVal + * @methodOf ui.grid.saveState.service:uiGridSaveStateService + * @description Helper function that gets either the rowNum or + * the saveRowIdentity, given a gridRow + * @param {Grid} grid the grid the row is in + * @param {GridRow} gridRow the row we want the rowNum for + * @returns {object} an object containing { identity: true/false, row: rowNumber/rowIdentity } + * + */ + getRowVal: function( grid, gridRow ) { + if ( !gridRow ) { + return null; + } + + var rowVal = {}; + if ( grid.options.saveRowIdentity ) { + rowVal.identity = true; + rowVal.row = grid.options.saveRowIdentity( gridRow.entity ); + } + else { + rowVal.identity = false; + rowVal.row = grid.renderContainers.body.visibleRowCache.indexOf( gridRow ); + } + return rowVal; + }, + + + /** + * @ngdoc function + * @name restoreColumns + * @methodOf ui.grid.saveState.service:uiGridSaveStateService + * @description Restores the columns, including order, visible, width, + * pinning, sort and filters. + * + * @param {Grid} grid the grid whose state we'd like to restore + * @param {object} columnsState the list of columns we had before, with their state + */ + restoreColumns: function( grid, columnsState ) { + var isSortChanged = false; + + columnsState.forEach( function( columnState, index ) { + var currentCol = grid.getColumn( columnState.name ); + + if ( currentCol && !grid.isRowHeaderColumn(currentCol) ) { + if ( grid.options.saveVisible && + ( currentCol.visible !== columnState.visible || + currentCol.colDef.visible !== columnState.visible ) ) { + currentCol.visible = columnState.visible; + currentCol.colDef.visible = columnState.visible; + grid.api.core.raise.columnVisibilityChanged(currentCol); + } + + if ( grid.options.saveWidths && currentCol.width !== columnState.width) { + currentCol.width = columnState.width; + currentCol.hasCustomWidth = true; + } + + if ( grid.options.saveSort && + !angular.equals(currentCol.sort, columnState.sort) && + !( currentCol.sort === undefined && angular.isEmpty(columnState.sort) ) ) { + currentCol.sort = angular.copy( columnState.sort ); + isSortChanged = true; + } + + if ( grid.options.saveFilter && + !angular.equals(currentCol.filters, columnState.filters ) ) { + columnState.filters.forEach( function( filter, index ) { + angular.extend( currentCol.filters[index], filter ); + if ( typeof(filter.term) === 'undefined' || filter.term === null ) { + delete currentCol.filters[index].term; + } + }); + grid.api.core.raise.filterChanged( currentCol ); + } + + if ( !!grid.api.pinning && grid.options.savePinning && currentCol.renderContainer !== columnState.pinned ) { + grid.api.pinning.pinColumn(currentCol, columnState.pinned); + } + + var currentIndex = grid.getOnlyDataColumns().indexOf( currentCol ); + if (currentIndex !== -1) { + if (grid.options.saveOrder && currentIndex !== index) { + var column = grid.columns.splice(currentIndex + grid.rowHeaderColumns.length, 1)[0]; + grid.columns.splice(index + grid.rowHeaderColumns.length, 0, column); + } + } + } + }); + + if ( isSortChanged ) { + grid.api.core.raise.sortChanged( grid, grid.getColumnSorting() ); + } + }, + + + /** + * @ngdoc function + * @name restoreScrollFocus + * @methodOf ui.grid.saveState.service:uiGridSaveStateService + * @description Scrolls to the position that was saved. If focus is true, then + * sets focus to the specified row/col. If focus is false, then scrolls to the + * specified row/col. + * + * @param {Grid} grid the grid whose state we'd like to restore + * @param {scope} $scope a scope that we can broadcast on + * @param {object} scrollFocusState the scroll/focus state ready to be restored + */ + restoreScrollFocus: function( grid, $scope, scrollFocusState ) { + if ( !grid.api.cellNav ) { + return; + } + + var colDef, row; + if ( scrollFocusState.colName ) { + var colDefs = grid.options.columnDefs.filter( function( colDef ) { return colDef.name === scrollFocusState.colName; }); + if ( colDefs.length > 0 ) { + colDef = colDefs[0]; + } + } + + if ( scrollFocusState.rowVal && scrollFocusState.rowVal.row ) { + if ( scrollFocusState.rowVal.identity ) { + row = service.findRowByIdentity( grid, scrollFocusState.rowVal ); + } + else { + row = grid.renderContainers.body.visibleRowCache[ scrollFocusState.rowVal.row ]; + } + } + + var entity = row && row.entity ? row.entity : null ; + + if ( colDef || entity ) { + if (scrollFocusState.focus ) { + grid.api.cellNav.scrollToFocus( entity, colDef ); + } + else { + grid.scrollTo( entity, colDef ); + } + } + }, + + + /** + * @ngdoc function + * @name restoreSelection + * @methodOf ui.grid.saveState.service:uiGridSaveStateService + * @description Selects the rows that are provided in the selection + * state. If you are using `saveRowIdentity` and more than one row matches the identity + * function then only the first is selected. + * @param {Grid} grid the grid whose state we'd like to restore + * @param {object} selectionState the selection state ready to be restored + */ + restoreSelection: function( grid, selectionState ) { + if ( !grid.api.selection ) { + return; + } + + grid.api.selection.clearSelectedRows(); + + selectionState.forEach(function( rowVal ) { + if ( rowVal.identity ) { + var foundRow = service.findRowByIdentity( grid, rowVal ); + + if ( foundRow ) { + grid.api.selection.selectRow( foundRow.entity ); + } + + } + else { + grid.api.selection.selectRowByVisibleIndex( rowVal.row ); + } + }); + }, + + + /** + * @ngdoc function + * @name restoreGrouping + * @methodOf ui.grid.saveState.service:uiGridSaveStateService + * @description Restores the grouping configuration, if the grouping feature + * is enabled. + * @param {Grid} grid the grid whose state we'd like to restore + * @param {object} groupingState the grouping state ready to be restored + */ + restoreGrouping: function( grid, groupingState ) { + if ( !grid.api.grouping || typeof(groupingState) === 'undefined' || groupingState === null || angular.equals(groupingState, {}) ) { + return; + } + + grid.api.grouping.setGrouping( groupingState ); + }, + + /** + * @ngdoc function + * @name restoreTreeView + * @methodOf ui.grid.saveState.service:uiGridSaveStateService + * @description Restores the tree view configuration, if the tree view feature + * is enabled. + * @param {Grid} grid the grid whose state we'd like to restore + * @param {object} treeViewState the tree view state ready to be restored + */ + restoreTreeView: function( grid, treeViewState ) { + if ( !grid.api.treeView || typeof(treeViewState) === 'undefined' || treeViewState === null || angular.equals(treeViewState, {}) ) { + return; + } + + grid.api.treeView.setTreeView( treeViewState ); + }, + + /** + * @ngdoc function + * @name restorePagination + * @methodOf ui.grid.saveState.service:uiGridSaveStateService + * @description Restores the pagination information, if pagination is enabled. + * @param {Grid} grid the grid whose state we'd like to restore + * @param {object} pagination the pagination object to be restored + * @param {number} pagination.paginationCurrentPage the page number to restore + * @param {number} pagination.paginationPageSize the number of items displayed per page + */ + restorePagination: function( grid, pagination ) { + if ( !grid.api.pagination || !grid.options.paginationPageSize ) { + return; + } + + grid.options.paginationCurrentPage = pagination.paginationCurrentPage; + grid.options.paginationPageSize = pagination.paginationPageSize; + }, + + /** + * @ngdoc function + * @name findRowByIdentity + * @methodOf ui.grid.saveState.service:uiGridSaveStateService + * @description Finds a row given it's identity value, returns the first found row + * if any are found, otherwise returns null if no rows are found. + * @param {Grid} grid the grid whose state we'd like to restore + * @param {object} rowVal the row we'd like to find + * @returns {gridRow} the found row, or null if none found + */ + findRowByIdentity: function( grid, rowVal ) { + if ( !grid.options.saveRowIdentity ) { + return null; + } + + var filteredRows = grid.rows.filter( function( gridRow ) { + return ( grid.options.saveRowIdentity( gridRow.entity ) === rowVal.row ); + }); + + if ( filteredRows.length > 0 ) { + return filteredRows[0]; + } else { + return null; + } + } + }; + + return service; + } + ); + + /** + * @ngdoc directive + * @name ui.grid.saveState.directive:uiGridSaveState + * @element div + * @restrict A + * + * @description Adds saveState features to grid + * + * @example +
+
+
+ Defaults to true + */ + + /** + * @ngdoc object + * @name isSelected + * @propertyOf ui.grid.selection.api:GridRow + * @description Selected state of row. Should be readonly. Make any changes to selected state using setSelected(). + * Defaults to false + */ + + /** + * @ngdoc object + * @name isFocused + * @propertyOf ui.grid.selection.api:GridRow + * @description Focused state of row. Should be readonly. Make any changes to focused state using setFocused(). + * Defaults to false + */ + + /** + * @ngdoc function + * @name setSelected + * @methodOf ui.grid.selection.api:GridRow + * @description Sets the isSelected property and updates the selectedCount + * Changes to isSelected state should only be made via this function + * @param {Boolean} selected value to set + */ + $delegate.prototype.setSelected = function (selected) { + if (selected !== this.isSelected) { + this.isSelected = selected; + this.grid.selection.selectedCount += selected ? 1 : -1; + } + }; + + /** + * @ngdoc function + * @name setFocused + * @methodOf ui.grid.selection.api:GridRow + * @description Sets the isFocused property + * Changes to isFocused state should only be made via this function + * @param {Boolean} val value to set + */ + $delegate.prototype.setFocused = function(val) { + if (val !== this.isFocused) { + this.grid.selection.focusedRow && (this.grid.selection.focusedRow.isFocused = false); + this.grid.selection.focusedRow = val ? this : null; + this.isFocused = val; + } + }; + + return $delegate; + }]); + }]); + + /** + * @ngdoc service + * @name ui.grid.selection.service:uiGridSelectionService + * + * @description Services for selection features + */ + module.service('uiGridSelectionService', + function () { + var service = { + + initializeGrid: function (grid) { + + // add feature namespace and any properties to grid for needed + /** + * @ngdoc object + * @name ui.grid.selection.grid:selection + * + * @description Grid properties and functions added for selection + */ + grid.selection = { + lastSelectedRow: null, + /** + * @ngdoc object + * @name focusedRow + * @propertyOf ui.grid.selection.grid:selection + * @description Focused row. + */ + focusedRow: null, + selectAll: false + }; + + + /** + * @ngdoc object + * @name selectedCount + * @propertyOf ui.grid.selection.grid:selection + * @description Current count of selected rows + * @example + * var count = grid.selection.selectedCount + */ + grid.selection.selectedCount = 0; + + service.defaultGridOptions(grid.options); + + /** + * @ngdoc object + * @name ui.grid.selection.api:PublicApi + * + * @description Public Api for selection feature + */ + var publicApi = { + events: { + selection: { + /** + * @ngdoc event + * @name rowFocusChanged + * @eventOf ui.grid.selection.api:PublicApi + * @description is raised after the row.isFocused state is changed + * @param {object} scope the scope associated with the grid + * @param {GridRow} row the row that was focused/unfocused + * @param {Event} evt object if raised from an event + */ + rowFocusChanged: function (scope, row, evt) {}, + /** + * @ngdoc event + * @name rowSelectionChanged + * @eventOf ui.grid.selection.api:PublicApi + * @description is raised after the row.isSelected state is changed + * @param {object} scope the scope associated with the grid + * @param {GridRow} row the row that was selected/deselected + * @param {Event} evt object if raised from an event + */ + rowSelectionChanged: function (scope, row, evt) { + }, + /** + * @ngdoc event + * @name rowSelectionChangedBatch + * @eventOf ui.grid.selection.api:PublicApi + * @description is raised after the row.isSelected state is changed + * in bulk, if the `enableSelectionBatchEvent` option is set to true + * (which it is by default). This allows more efficient processing + * of bulk events. + * @param {object} scope the scope associated with the grid + * @param {array} rows the rows that were selected/deselected + * @param {Event} evt object if raised from an event + */ + rowSelectionChangedBatch: function (scope, rows, evt) { + } + } + }, + methods: { + selection: { + /** + * @ngdoc function + * @name toggleRowSelection + * @methodOf ui.grid.selection.api:PublicApi + * @description Toggles data row as selected or unselected + * @param {object} rowEntity gridOptions.data[] array instance + * @param {Event} evt object if raised from an event + */ + toggleRowSelection: function (rowEntity, evt) { + var row = grid.getRow(rowEntity); + if (row !== null) { + service.toggleRowSelection(grid, row, evt, grid.options.multiSelect, grid.options.noUnselect); + } + }, + /** + * @ngdoc function + * @name selectRow + * @methodOf ui.grid.selection.api:PublicApi + * @description Select the data row + * @param {object} rowEntity gridOptions.data[] array instance + * @param {Event} evt object if raised from an event + */ + selectRow: function (rowEntity, evt) { + var row = grid.getRow(rowEntity); + if (row !== null && !row.isSelected) { + service.toggleRowSelection(grid, row, evt, grid.options.multiSelect, grid.options.noUnselect); + } + }, + /** + * @ngdoc function + * @name selectRowByVisibleIndex + * @methodOf ui.grid.selection.api:PublicApi + * @description Select the specified row by visible index (i.e. if you + * specify row 0 you'll get the first visible row selected). In this context + * visible means of those rows that are theoretically visible (i.e. not filtered), + * rather than rows currently rendered on the screen. + * @param {number} rowNum index within the rowsVisible array + * @param {Event} evt object if raised from an event + */ + selectRowByVisibleIndex: function (rowNum, evt) { + var row = grid.renderContainers.body.visibleRowCache[rowNum]; + if (row !== null && typeof (row) !== 'undefined' && !row.isSelected) { + service.toggleRowSelection(grid, row, evt, grid.options.multiSelect, grid.options.noUnselect); + } + }, + /** + * @ngdoc function + * @name unSelectRow + * @methodOf ui.grid.selection.api:PublicApi + * @description UnSelect the data row + * @param {object} rowEntity gridOptions.data[] array instance + * @param {Event} evt object if raised from an event + */ + unSelectRow: function (rowEntity, evt) { + var row = grid.getRow(rowEntity); + if (row !== null && row.isSelected) { + service.toggleRowSelection(grid, row, evt, grid.options.multiSelect, grid.options.noUnselect); + } + }, + /** + * @ngdoc function + * @name unSelectRowByVisibleIndex + * @methodOf ui.grid.selection.api:PublicApi + * @description Unselect the specified row by visible index (i.e. if you + * specify row 0 you'll get the first visible row unselected). In this context + * visible means of those rows that are theoretically visible (i.e. not filtered), + * rather than rows currently rendered on the screen. + * @param {number} rowNum index within the rowsVisible array + * @param {Event} evt object if raised from an event + */ + unSelectRowByVisibleIndex: function (rowNum, evt) { + var row = grid.renderContainers.body.visibleRowCache[rowNum]; + if (row !== null && typeof (row) !== 'undefined' && row.isSelected) { + service.toggleRowSelection(grid, row, evt, grid.options.multiSelect, grid.options.noUnselect); + } + }, + /** + * @ngdoc function + * @name selectAllRows + * @methodOf ui.grid.selection.api:PublicApi + * @description Selects all rows. Does nothing if multiSelect = false + * @param {Event} evt object if raised from an event + */ + selectAllRows: function (evt) { + if (grid.options.multiSelect !== false) { + var changedRows = []; + grid.rows.forEach(function (row) { + if (!row.isSelected && row.enableSelection !== false && grid.options.isRowSelectable(row) !== false) { + row.setSelected(true); + service.decideRaiseSelectionEvent(grid, row, changedRows, evt); + } + }); + grid.selection.selectAll = true; + service.decideRaiseSelectionBatchEvent(grid, changedRows, evt); + } + }, + /** + * @ngdoc function + * @name selectAllVisibleRows + * @methodOf ui.grid.selection.api:PublicApi + * @description Selects all visible rows. Does nothing if multiSelect = false + * @param {Event} evt object if raised from an event + */ + selectAllVisibleRows: function (evt) { + if (grid.options.multiSelect !== false) { + var changedRows = []; + grid.rows.forEach(function(row) { + if (row.visible) { + if (!row.isSelected && row.enableSelection !== false && grid.options.isRowSelectable(row) !== false) { + row.setSelected(true); + service.decideRaiseSelectionEvent(grid, row, changedRows, evt); + } + } else if (row.isSelected) { + row.setSelected(false); + service.decideRaiseSelectionEvent(grid, row, changedRows, evt); + } + }); + grid.selection.selectAll = true; + service.decideRaiseSelectionBatchEvent(grid, changedRows, evt); + } + }, + /** + * @ngdoc function + * @name clearSelectedRows + * @methodOf ui.grid.selection.api:PublicApi + * @description Unselects all rows + * @param {Event} evt object if raised from an event + */ + clearSelectedRows: function (evt) { + service.clearSelectedRows(grid, evt); + }, + /** + * @ngdoc function + * @name getSelectedRows + * @methodOf ui.grid.selection.api:PublicApi + * @description returns all selectedRow's entity references + */ + getSelectedRows: function () { + return service.getSelectedRows(grid).map(function (gridRow) { + return gridRow.entity; + }).filter(function (entity) { + return entity.hasOwnProperty('$$hashKey') || !angular.isObject(entity); + }); + }, + /** + * @ngdoc function + * @name getSelectedGridRows + * @methodOf ui.grid.selection.api:PublicApi + * @description returns all selectedRow's as gridRows + */ + getSelectedGridRows: function () { + return service.getSelectedRows(grid); + }, + /** + * @ngdoc function + * @name getSelectedCount + * @methodOf ui.grid.selection.api:PublicApi + * @description returns the number of rows selected + */ + getSelectedCount: function () { + return grid.selection.selectedCount; + }, + /** + * @ngdoc function + * @name setMultiSelect + * @methodOf ui.grid.selection.api:PublicApi + * @description Sets the current gridOption.multiSelect to true or false + * @param {bool} multiSelect true to allow multiple rows + */ + setMultiSelect: function (multiSelect) { + grid.options.multiSelect = multiSelect; + }, + /** + * @ngdoc function + * @name setModifierKeysToMultiSelect + * @methodOf ui.grid.selection.api:PublicApi + * @description Sets the current gridOption.modifierKeysToMultiSelect to true or false + * @param {bool} modifierKeysToMultiSelect true to only allow multiple rows when using ctrlKey or shiftKey is used + */ + setModifierKeysToMultiSelect: function (modifierKeysToMultiSelect) { + grid.options.modifierKeysToMultiSelect = modifierKeysToMultiSelect; + }, + /** + * @ngdoc function + * @name getSelectAllState + * @methodOf ui.grid.selection.api:PublicApi + * @description Returns whether or not the selectAll checkbox is currently ticked. The + * grid doesn't automatically select rows when you add extra data - so when you add data + * you need to explicitly check whether the selectAll is set, and then call setVisible rows + * if it is + */ + getSelectAllState: function () { + return grid.selection.selectAll; + } + + } + } + }; + + grid.api.registerEventsFromObject(publicApi.events); + + grid.api.registerMethodsFromObject(publicApi.methods); + + }, + + defaultGridOptions: function (gridOptions) { + // default option to true unless it was explicitly set to false + /** + * @ngdoc object + * @name ui.grid.selection.api:GridOptions + * + * @description GridOptions for selection feature, these are available to be + * set using the ui-grid {@link ui.grid.class:GridOptions gridOptions} + */ + + /** + * @ngdoc object + * @name enableRowSelection + * @propertyOf ui.grid.selection.api:GridOptions + * @description Enable row selection for entire grid. + * Defaults to true + */ + gridOptions.enableRowSelection = gridOptions.enableRowSelection !== false; + /** + * @ngdoc object + * @name multiSelect + * @propertyOf ui.grid.selection.api:GridOptions + * @description Enable multiple row selection for entire grid + * Defaults to true + */ + gridOptions.multiSelect = gridOptions.multiSelect !== false; + /** + * @ngdoc object + * @name noUnselect + * @propertyOf ui.grid.selection.api:GridOptions + * @description Prevent a row from being unselected. Works in conjunction + * with `multiselect = false` and `gridApi.selection.selectRow()` to allow + * you to create a single selection only grid - a row is always selected, you + * can only select different rows, you can't unselect the row. + * Defaults to false + */ + gridOptions.noUnselect = gridOptions.noUnselect === true; + /** + * @ngdoc object + * @name modifierKeysToMultiSelect + * @propertyOf ui.grid.selection.api:GridOptions + * @description Enable multiple row selection only when using the ctrlKey or shiftKey. Requires multiSelect to be true. + * Defaults to false + */ + gridOptions.modifierKeysToMultiSelect = gridOptions.modifierKeysToMultiSelect === true; + /** + * @ngdoc object + * @name enableRowHeaderSelection + * @propertyOf ui.grid.selection.api:GridOptions + * @description Enable a row header to be used for selection + * Defaults to true + */ + gridOptions.enableRowHeaderSelection = gridOptions.enableRowHeaderSelection !== false; + /** + * @ngdoc object + * @name enableFullRowSelection + * @propertyOf ui.grid.selection.api:GridOptions + * @description Enable selection by clicking anywhere on the row. Defaults to + * false if `enableRowHeaderSelection` is true, otherwise defaults to true. + */ + if (typeof (gridOptions.enableFullRowSelection) === 'undefined') { + gridOptions.enableFullRowSelection = !gridOptions.enableRowHeaderSelection; + } + /** + * @ngdoc object + * @name enableFocusRowOnRowHeaderClick + * @propertyOf ui.grid.selection.api:GridOptions + * @description Enable focuse row by clicking on the row header. Defaults to + * true if `enableRowHeaderSelection` is true, otherwise defaults to false. + */ + gridOptions.enableFocusRowOnRowHeaderClick = (gridOptions.enableFocusRowOnRowHeaderClick !== false) + || !gridOptions.enableRowHeaderSelection; + /** + * @ngdoc object + * @name enableSelectRowOnFocus + * @propertyOf ui.grid.selection.api:GridOptions + * @description Enable focuse row by clicking on the row anywhere. Defaults true. + */ + gridOptions.enableSelectRowOnFocus = (gridOptions.enableSelectRowOnFocus !== false); + /** + * @ngdoc object + * @name enableSelectAll + * @propertyOf ui.grid.selection.api:GridOptions + * @description Enable the select all checkbox at the top of the selectionRowHeader + * Defaults to true + */ + gridOptions.enableSelectAll = gridOptions.enableSelectAll !== false; + /** + * @ngdoc object + * @name enableSelectionBatchEvent + * @propertyOf ui.grid.selection.api:GridOptions + * @description If selected rows are changed in bulk, either via the API or + * via the selectAll checkbox, then a separate event is fired. Setting this + * option to false will cause the rowSelectionChanged event to be called multiple times + * instead + * Defaults to true + */ + gridOptions.enableSelectionBatchEvent = gridOptions.enableSelectionBatchEvent !== false; + /** + * @ngdoc object + * @name selectionRowHeaderWidth + * @propertyOf ui.grid.selection.api:GridOptions + * @description can be used to set a custom width for the row header selection column + * Defaults to 30px + */ + gridOptions.selectionRowHeaderWidth = angular.isDefined(gridOptions.selectionRowHeaderWidth) ? gridOptions.selectionRowHeaderWidth : 30; + /** + * @ngdoc object + * @name enableFooterTotalSelected + * @propertyOf ui.grid.selection.api:GridOptions + * @description Shows the total number of selected items in footer if true. + * Defaults to true. + * GridOptions.showGridFooter must also be set to true. + */ + gridOptions.enableFooterTotalSelected = gridOptions.enableFooterTotalSelected !== false; + + /** + * @ngdoc object + * @name isRowSelectable + * @propertyOf ui.grid.selection.api:GridOptions + * @description Makes it possible to specify a method that evaluates for each row and sets its "enableSelection" property. + */ + gridOptions.isRowSelectable = angular.isDefined(gridOptions.isRowSelectable) ? gridOptions.isRowSelectable : angular.noop; + }, + + /** + * @ngdoc function + * @name toggleRowSelection + * @methodOf ui.grid.selection.service:uiGridSelectionService + * @description Toggles row as selected or unselected + * @param {Grid} grid grid object + * @param {GridRow} row row to select or deselect + * @param {Event} evt object if resulting from event + * @param {bool} multiSelect if false, only one row at time can be selected + * @param {bool} noUnselect if true then rows cannot be unselected + */ + toggleRowSelection: function (grid, row, evt, multiSelect, noUnselect) { + if ( row.enableSelection === false ) { + return; + } + + var selected = row.isSelected, + selectedRows; + + if (!multiSelect) { + if (!selected) { + service.clearSelectedRows(grid, evt); + } + else { + selectedRows = service.getSelectedRows(grid); + if (selectedRows.length > 1) { + selected = false; // Enable reselect of the row + service.clearSelectedRows(grid, evt); + } + } + } + + // only select row in this case + if (!(selected && noUnselect)) { + row.setSelected(!selected); + if (row.isSelected === true) { + grid.selection.lastSelectedRow = row; + } + + selectedRows = service.getSelectedRows(grid); + grid.selection.selectAll = grid.rows.length === selectedRows.length; + + grid.api.selection.raise.rowSelectionChanged(row, evt); + } + }, + /** + * @ngdoc function + * @name shiftSelect + * @methodOf ui.grid.selection.service:uiGridSelectionService + * @description selects a group of rows from the last selected row using the shift key + * @param {Grid} grid grid object + * @param {GridRow} row clicked row + * @param {Event} evt object if raised from an event + * @param {bool} multiSelect if false, does nothing this is for multiSelect only + */ + shiftSelect: function (grid, row, evt, multiSelect) { + if (!multiSelect) { + return; + } + var selectedRows = service.getSelectedRows(grid); + var fromRow = selectedRows.length > 0 ? grid.renderContainers.body.visibleRowCache.indexOf(grid.selection.lastSelectedRow) : 0; + var toRow = grid.renderContainers.body.visibleRowCache.indexOf(row); + // reverse select direction + if (fromRow > toRow) { + var tmp = fromRow; + fromRow = toRow; + toRow = tmp; + } + + var changedRows = []; + for (var i = fromRow; i <= toRow; i++) { + var rowToSelect = grid.renderContainers.body.visibleRowCache[i]; + if (rowToSelect) { + if (!rowToSelect.isSelected && rowToSelect.enableSelection !== false) { + rowToSelect.setSelected(true); + grid.selection.lastSelectedRow = rowToSelect; + service.decideRaiseSelectionEvent(grid, rowToSelect, changedRows, evt); + } + } + } + service.decideRaiseSelectionBatchEvent(grid, changedRows, evt); + }, + /** + * @ngdoc function + * @name getSelectedRows + * @methodOf ui.grid.selection.service:uiGridSelectionService + * @description Returns all the selected rows + * @param {Grid} grid grid object + */ + getSelectedRows: function (grid) { + return grid.rows.filter(function (row) { + return row.isSelected; + }); + }, + + /** + * @ngdoc function + * @name clearSelectedRows + * @methodOf ui.grid.selection.service:uiGridSelectionService + * @description Clears all selected rows + * @param {Grid} grid grid object + * @param {Event} evt object if raised from an event + */ + clearSelectedRows: function (grid, evt) { + var changedRows = []; + service.getSelectedRows(grid).forEach(function (row) { + if (row.isSelected) { + row.setSelected(false); + service.decideRaiseSelectionEvent(grid, row, changedRows, evt); + } + }); + grid.selection.selectAll = false; + grid.selection.selectedCount = 0; + service.decideRaiseSelectionBatchEvent(grid, changedRows, evt); + }, + + /** + * @ngdoc function + * @name decideRaiseSelectionEvent + * @methodOf ui.grid.selection.service:uiGridSelectionService + * @description Decides whether to raise a single event or a batch event + * @param {Grid} grid grid object + * @param {GridRow} row row that has changed + * @param {array} changedRows an array to which we can append the changed + * @param {Event} evt object if raised from an event + * row if we're doing batch events + */ + decideRaiseSelectionEvent: function (grid, row, changedRows, evt) { + if (!grid.options.enableSelectionBatchEvent) { + grid.api.selection.raise.rowSelectionChanged(row, evt); + } + else { + changedRows.push(row); + } + }, + + /** + * @ngdoc function + * @name raiseSelectionEvent + * @methodOf ui.grid.selection.service:uiGridSelectionService + * @description Decides whether we need to raise a batch event, and + * raises it if we do. + * @param {Grid} grid grid object + * @param {array} changedRows an array of changed rows, only populated + * @param {Event} evt object if raised from an event + * if we're doing batch events + */ + decideRaiseSelectionBatchEvent: function (grid, changedRows, evt) { + if (changedRows.length > 0) { + grid.api.selection.raise.rowSelectionChangedBatch(changedRows, evt); + } + } + }; + + return service; + }); + + /** + * @ngdoc directive + * @name ui.grid.selection.directive:uiGridSelection + * @element div + * @restrict A + * + * @description Adds selection features to grid + * + * @example +
+
+
+ \x3c!-- '),e.put("ui-grid/selectionRowHeader",'Beta This feature is ready for testing, but it either hasn't seen a lot of use or has some known bugs.
+ *
+ * This module provides base tree handling functions that are shared by other features, notably grouping
+ * and treeView. It provides a tree view of the data, with nodes in that
+ * tree and leaves.
+ *
+ * Design information:
+ * -------------------
+ *
+ * The raw data that is provided must come with a $$treeLevel on any non-leaf node. Grouping will create
+ * these on all the group header rows, treeView will expect these to be set in the raw data by the user.
+ * TreeBase will run a rowsProcessor that:
+ * - builds `treeBase.tree` out of the provided rows
+ * - permits a recursive sort of the tree
+ * - maintains the expand/collapse state of each node
+ * - provides the expand/collapse all button and the expand/collapse buttons
+ * - maintains the count of children for each node
+ *
+ * Each row is updated with a link to the tree node that represents it. Refer {@link ui.grid.treeBase.grid:treeBase.tree tree documentation}
+ * for information.
+ *
+ * TreeBase adds information to the rows
+ * - treeLevel: if present and > -1 tells us the level (level 0 is the top level)
+ * - treeNode: pointer to the node in the grid.treeBase.tree that refers
+ * to this row, allowing us to manipulate the state
+ *
+ * Since the logic is baked into the rowsProcessors, it should get triggered whenever
+ * row order or filtering or anything like that is changed. We recall the expanded state
+ * across invocations of the rowsProcessors by the reference to the treeNode on the individual
+ * rows. We rebuild the tree itself quite frequently, when we do this we use the saved treeNodes to
+ * get the state, but we overwrite the other data in that treeNode.
+ *
+ * By default rows are collapsed, which means all data rows have their visible property
+ * set to false, and only level 0 group rows are set to visible.
+ *
+ * We rely on the rowsProcessors to do the actual expanding and collapsing, so we set the flags we want into
+ * grid.treeBase.tree, then call refresh. This is because we can't easily change the visible
+ * row cache without calling the processors, and once we've built the logic into the rowProcessors we may as
+ * well use it all the time.
+ *
+ * Tree base provides sorting (on non-grouped columns).
+ *
+ * Sorting works in two passes. The standard sorting is performed for any columns that are important to building
+ * the tree (for example, any grouped columns). Then after the tree is built, a recursive tree sort is performed
+ * for the remaining sort columns (including the original sort) - these columns are sorted within each tree level
+ * (so all the level 1 nodes are sorted, then all the level 2 nodes within each level 1 node etc).
+ *
+ * To achieve this we make use of the `ignoreSort` property on the sort configuration. The parent feature (treeView or grouping)
+ * must provide a rowsProcessor that runs with very low priority (typically in the 60-65 range), and that sets
+ * the `ignoreSort`on any sort that it wants to run on the tree. TreeBase will clear the ignoreSort on all sorts - so it
+ * will turn on any sorts that haven't run. It will then call a recursive sort on the tree.
+ *
+ * Tree base provides treeAggregation. It checks the treeAggregation configuration on each column, and aggregates based on
+ * the logic provided as it builds the tree. Footer aggregation from the uiGrid core should not be used with treeBase aggregation,
+ * since it operates on all visible rows, as opposed to to leaf nodes only. Setting `showColumnFooter: true` will show the
+ * treeAggregations in the column footer. Aggregation information will be collected in the format:
+ *
+ * ```
+ * {
+ * type: 'count',
+ * value: 4,
+ * label: 'count: ',
+ * rendered: 'count: 4'
+ * }
+ * ```
+ *
+ * A callback is provided to format the value once it is finalised (aka a valueFilter).
+ *
+ * + * + * + * + */ + + var module = angular.module('ui.grid.treeBase', ['ui.grid']); + + /** + * @ngdoc object + * @name ui.grid.treeBase.constant:uiGridTreeBaseConstants + * + * @description constants available in treeBase module. + * + * These constants are manually copied into grouping and treeView, + * as I haven't found a way to simply include them, and it's not worth + * investing time in for something that changes very infrequently. + * + */ + module.constant('uiGridTreeBaseConstants', { + featureName: "treeBase", + rowHeaderColName: 'treeBaseRowHeaderCol', + EXPANDED: 'expanded', + COLLAPSED: 'collapsed', + aggregation: { + COUNT: 'count', + SUM: 'sum', + MAX: 'max', + MIN: 'min', + AVG: 'avg' + } + }); + + /** + * @ngdoc service + * @name ui.grid.treeBase.service:uiGridTreeBaseService + * + * @description Services for treeBase feature + */ + /** + * @ngdoc object + * @name ui.grid.treeBase.api:ColumnDef + * + * @description ColumnDef for tree feature, these are available to be + * set using the ui-grid {@link ui.grid.class:GridOptions.columnDef gridOptions.columnDefs} + */ + + module.service('uiGridTreeBaseService', ['$q', 'uiGridTreeBaseConstants', 'gridUtil', 'GridRow', 'gridClassFactory', 'i18nService', 'uiGridConstants', 'rowSorter', + function ($q, uiGridTreeBaseConstants, gridUtil, GridRow, gridClassFactory, i18nService, uiGridConstants, rowSorter) { + + var service = { + + initializeGrid: function (grid) { + + // add feature namespace and any properties to grid for needed + /** + * @ngdoc object + * @name ui.grid.treeBase.grid:treeBase + * + * @description Grid properties and functions added for treeBase + */ + grid.treeBase = {}; + + /** + * @ngdoc property + * @propertyOf ui.grid.treeBase.grid:treeBase + * @name numberLevels + * + * @description Total number of tree levels currently used, calculated by the rowsProcessor by + * retaining the highest tree level it sees + */ + grid.treeBase.numberLevels = 0; + + /** + * @ngdoc property + * @propertyOf ui.grid.treeBase.grid:treeBase + * @name expandAll + * + * @description Whether or not the expandAll box is selected + */ + grid.treeBase.expandAll = false; + + /** + * @ngdoc property + * @propertyOf ui.grid.treeBase.grid:treeBase + * @name tree + * + * @description Tree represented as a nested array that holds the state of each node, along with a + * pointer to the row. The array order is material - we will display the children in the order + * they are stored in the array + * + * Each node stores: + * + * - the state of this node + * - an array of children of this node + * - a pointer to the parent of this node (reverse pointer, allowing us to walk up the tree) + * - the number of children of this node + * - aggregation information calculated from the nodes + * + * ``` + * [{ + * state: 'expanded', + * row:
+ * gridApi.treeBase.on.rowExpanded(scope,function(row) {})
+ *
+ * @param {gridRow} row the row that was expanded. You can also
+ * retrieve the grid from this row with row.grid
+ */
+ rowExpanded: {},
+
+ /**
+ * @ngdoc event
+ * @eventOf ui.grid.treeBase.api:PublicApi
+ * @name rowCollapsed
+ * @description raised whenever a row is collapsed. Doesn't really have
+ * a purpose at the moment, included for symmetry
+ *
+ *
+ * gridApi.treeBase.on.rowCollapsed(scope,function(row) {})
+ *
+ * @param {gridRow} row the row that was collapsed. You can also
+ * retrieve the grid from this row with row.grid
+ */
+ rowCollapsed: {}
+ }
+ },
+
+ methods: {
+ treeBase: {
+ /**
+ * @ngdoc function
+ * @name expandAllRows
+ * @methodOf ui.grid.treeBase.api:PublicApi
+ * @description Expands all tree rows
+ */
+ expandAllRows: function () {
+ service.expandAllRows(grid);
+ },
+
+ /**
+ * @ngdoc function
+ * @name collapseAllRows
+ * @methodOf ui.grid.treeBase.api:PublicApi
+ * @description collapse all tree rows
+ */
+ collapseAllRows: function () {
+ service.collapseAllRows(grid);
+ },
+
+ /**
+ * @ngdoc function
+ * @name toggleRowTreeState
+ * @methodOf ui.grid.treeBase.api:PublicApi
+ * @description call expand if the row is collapsed, collapse if it is expanded
+ * @param {gridRow} row the row you wish to toggle
+ */
+ toggleRowTreeState: function (row) {
+ service.toggleRowTreeState(grid, row);
+ },
+
+ /**
+ * @ngdoc function
+ * @name expandRow
+ * @methodOf ui.grid.treeBase.api:PublicApi
+ * @description expand the immediate children of the specified row
+ * @param {gridRow} row the row you wish to expand
+ * @param {boolean} recursive true if you wish to expand the row's ancients
+ */
+ expandRow: function (row, recursive) {
+ service.expandRow(grid, row, recursive);
+ },
+
+ /**
+ * @ngdoc function
+ * @name expandRowChildren
+ * @methodOf ui.grid.treeBase.api:PublicApi
+ * @description expand all children of the specified row
+ * @param {gridRow} row the row you wish to expand
+ */
+ expandRowChildren: function (row) {
+ service.expandRowChildren(grid, row);
+ },
+
+ /**
+ * @ngdoc function
+ * @name collapseRow
+ * @methodOf ui.grid.treeBase.api:PublicApi
+ * @description collapse the specified row. When
+ * you expand the row again, all grandchildren will retain their state
+ * @param {gridRow} row the row you wish to collapse
+ */
+ collapseRow: function ( row ) {
+ service.collapseRow(grid, row);
+ },
+
+ /**
+ * @ngdoc function
+ * @name collapseRowChildren
+ * @methodOf ui.grid.treeBase.api:PublicApi
+ * @description collapse all children of the specified row. When
+ * you expand the row again, all grandchildren will be collapsed
+ * @param {gridRow} row the row you wish to collapse children for
+ */
+ collapseRowChildren: function ( row ) {
+ service.collapseRowChildren(grid, row);
+ },
+
+ /**
+ * @ngdoc function
+ * @name getTreeState
+ * @methodOf ui.grid.treeBase.api:PublicApi
+ * @description Get the tree state for this grid,
+ * used by the saveState feature
+ * Returned treeState as an object
+ * `{ expandedState: { uid: 'expanded', uid: 'collapsed' } }`
+ * where expandedState is a hash of row uid and the current expanded state
+ *
+ * @returns {object} tree state
+ *
+ * TODO - this needs work - we need an identifier that persists across instantiations,
+ * not uid. This really means we need a row identity defined, but that won't work for
+ * grouping. Perhaps this needs to be moved up to treeView and grouping, rather than
+ * being in base.
+ */
+ getTreeExpandedState: function () {
+ return { expandedState: service.getTreeState(grid) };
+ },
+
+ /**
+ * @ngdoc function
+ * @name setTreeState
+ * @methodOf ui.grid.treeBase.api:PublicApi
+ * @description Set the expanded states of the tree
+ * @param {object} config the config you want to apply, in the format
+ * provided by getTreeState
+ */
+ setTreeState: function ( config ) {
+ service.setTreeState( grid, config );
+ },
+
+ /**
+ * @ngdoc function
+ * @name getRowChildren
+ * @methodOf ui.grid.treeBase.api:PublicApi
+ * @description Get the children of the specified row
+ * @param {GridRow} row the row you want the children of
+ * @returns {Array} array of children of this row, the children
+ * are all gridRows
+ */
+ getRowChildren: function ( row ) {
+ return row.treeNode.children.map( function( childNode ) {
+ return childNode.row;
+ });
+ }
+ }
+ }
+ };
+
+ grid.api.registerEventsFromObject(publicApi.events);
+
+ grid.api.registerMethodsFromObject(publicApi.methods);
+ },
+
+
+ defaultGridOptions: function (gridOptions) {
+ // default option to true unless it was explicitly set to false
+ /**
+ * @ngdoc object
+ * @name ui.grid.treeBase.api:GridOptions
+ *
+ * @description GridOptions for treeBase feature, these are available to be
+ * set using the ui-grid {@link ui.grid.class:GridOptions gridOptions}
+ */
+
+ /**
+ * @ngdoc object
+ * @name treeRowHeaderBaseWidth
+ * @propertyOf ui.grid.treeBase.api:GridOptions
+ * @description Base width of the tree header, provides for a single level of tree. This
+ * is incremented by `treeIndent` for each extra level
+ * Defaults to 30 + */ + gridOptions.treeRowHeaderBaseWidth = gridOptions.treeRowHeaderBaseWidth || 30; + + /** + * @ngdoc object + * @name treeIndent + * @propertyOf ui.grid.treeBase.api:GridOptions + * @description Number of pixels of indent for the icon at each tree level, wider indents are visually more pleasing, + * but will make the tree row header wider + * Defaults to 10 + */ + gridOptions.treeIndent = (gridOptions.treeIndent != null) ? gridOptions.treeIndent : 10; + + /** + * @ngdoc object + * @name showTreeRowHeader + * @propertyOf ui.grid.treeBase.api:GridOptions + * @description If set to false, don't create the row header. You'll need to programmatically control the expand + * states + * Defaults to true + */ + gridOptions.showTreeRowHeader = gridOptions.showTreeRowHeader !== false; + + /** + * @ngdoc object + * @name showTreeExpandNoChildren + * @propertyOf ui.grid.treeBase.api:GridOptions + * @description If set to true, show the expand/collapse button even if there are no + * children of a node. You'd use this if you're planning to dynamically load the children + * + * Defaults to true, grouping overrides to false + */ + gridOptions.showTreeExpandNoChildren = gridOptions.showTreeExpandNoChildren !== false; + + /** + * @ngdoc object + * @name treeRowHeaderAlwaysVisible + * @propertyOf ui.grid.treeBase.api:GridOptions + * @description If set to true, row header even if there are no tree nodes + * + * Defaults to true + */ + gridOptions.treeRowHeaderAlwaysVisible = gridOptions.treeRowHeaderAlwaysVisible !== false; + + /** + * @ngdoc object + * @name treeCustomAggregations + * @propertyOf ui.grid.treeBase.api:GridOptions + * @description Define custom aggregation functions. The properties of this object will be + * aggregation types available for use on columnDef with {@link ui.grid.treeBase.api:ColumnDef treeAggregationType} or through the column menu. + * If a function defined here uses the same name as one of the native aggregations, this one will take precedence. + * The object format is: + * + *
+ * {
+ * aggregationName: {
+ * label: (optional) string,
+ * aggregationFn: function( aggregation, fieldValue, numValue, row ) {...},
+ * finalizerFn: (optional) function( aggregation ) {...}
+ * },
+ * mean: {
+ * label: 'mean',
+ * aggregationFn: function( aggregation, fieldValue, numValue ) {
+ * aggregation.count = (aggregation.count || 1) + 1;
+ * aggregation.sum = (aggregation.sum || 0) + numValue;
+ * },
+ * finalizerFn: function( aggregation ) {
+ * aggregation.value = aggregation.sum / aggregation.count
+ * }
+ * }
+ * }
+ *
+ *
+ * The `finalizerFn` may be used to manipulate the value before rendering, or to + * apply a custom rendered value. If `aggregation.rendered` is left undefined, the value will be + * rendered. Note that the native aggregation functions use an `finalizerFn` to concatenate + * the label and the value. + * + * Defaults to {} + */ + gridOptions.treeCustomAggregations = gridOptions.treeCustomAggregations || {}; + + /** + * @ngdoc object + * @name enableExpandAll + * @propertyOf ui.grid.treeBase.api:GridOptions + * @description Enable the expand all button at the top of the row header + * + * Defaults to true + */ + gridOptions.enableExpandAll = gridOptions.enableExpandAll !== false; + }, + + + /** + * @ngdoc function + * @name treeBaseColumnBuilder + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Sets the tree defaults based on the columnDefs + * + * @param {object} colDef columnDef we're basing on + * @param {GridColumn} col the column we're to update + * @param {object} gridOptions the options we should use + * @returns {promise} promise for the builder - actually we do it all inline so it's immediately resolved + */ + treeBaseColumnBuilder: function (colDef, col, gridOptions) { + + + /** + * @ngdoc object + * @name customTreeAggregationFn + * @propertyOf ui.grid.treeBase.api:ColumnDef + * @description A custom function that aggregates rows into some form of + * total. Aggregations run row-by-row, the function needs to be capable of + * creating a running total. + * + * The function will be provided the aggregation item (in which you can store running + * totals), the row value that is to be aggregated, and that same row value converted to + * a number (most aggregations work on numbers) + * @example + *
+ * customTreeAggregationFn = function ( aggregation, fieldValue, numValue, row ) {
+ * // calculates the average of the squares of the values
+ * if ( typeof(aggregation.count) === 'undefined' ) {
+ * aggregation.count = 0;
+ * }
+ * aggregation.count++;
+ *
+ * if ( !isNaN(numValue) ) {
+ * if ( typeof(aggregation.total) === 'undefined' ) {
+ * aggregation.total = 0;
+ * }
+ * aggregation.total = aggregation.total + numValue * numValue;
+ * }
+ *
+ * aggregation.value = aggregation.total / aggregation.count;
+ * }
+ *
+ * Defaults to undefined. May be overwritten by treeAggregationType, the two options should not be used together. + */ + if ( typeof(colDef.customTreeAggregationFn) !== 'undefined' ) { + col.treeAggregationFn = colDef.customTreeAggregationFn; + } + + /** + * @ngdoc object + * @name treeAggregationType + * @propertyOf ui.grid.treeBase.api:ColumnDef + * @description Use one of the native or grid-level aggregation methods for calculating aggregations on this column. + * Native method are in the constants file and include: SUM, COUNT, MIN, MAX, AVG. This may also be the property the + * name of an aggregation function defined with {@link ui.grid.treeBase.api:GridOptions treeCustomAggregations}. + * + * + * treeAggregationType = uiGridTreeBaseConstants.aggregation.SUM, + * } + *+ * + * If you are using aggregations you should either: + * + * - also use grouping, in which case the aggregations are displayed in the group header, OR + * - use treeView, in which case you can set `treeAggregationUpdateEntity: true` in the colDef, and + * treeBase will store the aggregation information in the entity, or you can set `treeAggregationUpdateEntity: false` + * in the colDef, and you need to manual retrieve the calculated aggregations from the row.treeNode.aggregations + * + * Takes precendence over a treeAggregationFn, the two options should not be used together. + * Defaults to undefined. + */ + if ( typeof(colDef.treeAggregationType) !== 'undefined' ) { + col.treeAggregation = { type: colDef.treeAggregationType }; + if ( typeof(gridOptions.treeCustomAggregations[colDef.treeAggregationType]) !== 'undefined' ) { + col.treeAggregationFn = gridOptions.treeCustomAggregations[colDef.treeAggregationType].aggregationFn; + col.treeAggregationFinalizerFn = gridOptions.treeCustomAggregations[colDef.treeAggregationType].finalizerFn; + col.treeAggregation.label = gridOptions.treeCustomAggregations[colDef.treeAggregationType].label; + } + else if ( typeof(service.nativeAggregations()[colDef.treeAggregationType]) !== 'undefined' ) { + col.treeAggregationFn = service.nativeAggregations()[colDef.treeAggregationType].aggregationFn; + col.treeAggregation.label = service.nativeAggregations()[colDef.treeAggregationType].label; + } + } + + /** + * @ngdoc object + * @name treeAggregationLabel + * @propertyOf ui.grid.treeBase.api:ColumnDef + * @description A custom label to use for this aggregation. If provided we don't use native i18n. + */ + if ( typeof(colDef.treeAggregationLabel) !== 'undefined' ) { + if (typeof(col.treeAggregation) === 'undefined' ) { + col.treeAggregation = {}; + } + col.treeAggregation.label = colDef.treeAggregationLabel; + } + + /** + * @ngdoc object + * @name treeAggregationUpdateEntity + * @propertyOf ui.grid.treeBase.api:ColumnDef + * @description Store calculated aggregations into the entity, allowing them + * to be displayed in the grid using a standard cellTemplate. This defaults to true, + * if you are using grouping then you shouldn't set it to false, as then the aggregations won't + * display. + * + * If you are using treeView in most cases you'll want to set this to true. This will result in + * getCellValue returning the aggregation rather than whatever was stored in the cell attribute on + * the entity. If you want to render the underlying entity value (and do something else with the aggregation) + * then you could use a custom cellTemplate to display `row.entity.myAttribute`, rather than using getCellValue. + * + * Defaults to true + * + * @example + *
+ * gridOptions.columns = [{
+ * name: 'myCol',
+ * treeAggregation: { type: uiGridTreeBaseConstants.aggregation.SUM },
+ * treeAggregationUpdateEntity: true
+ * cellTemplate: '
+ */
+ col.treeAggregationUpdateEntity = colDef.treeAggregationUpdateEntity !== false;
+
+ /**
+ * @ngdoc object
+ * @name customTreeAggregationFinalizerFn
+ * @propertyOf ui.grid.treeBase.api:ColumnDef
+ * @description A custom function that populates aggregation.rendered, this is called when
+ * a particular aggregation has been fully calculated, and we want to render the value.
+ *
+ * With the native aggregation options we just concatenate `aggregation.label` and
+ * `aggregation.value`, but if you wanted to apply a filter or otherwise manipulate the label
+ * or the value, you can do so with this function. This function will be called after the
+ * the default `finalizerFn`.
+ *
+ * @example
+ *
+ * customTreeAggregationFinalizerFn = function ( aggregation ) {
+ * aggregation.rendered = aggregation.label + aggregation.value / 100 + '%';
+ * }
+ *
+ * Defaults to undefined. + */ + if ( typeof(col.customTreeAggregationFinalizerFn) === 'undefined' ) { + col.customTreeAggregationFinalizerFn = colDef.customTreeAggregationFinalizerFn; + } + + }, + + + /** + * @ngdoc function + * @name createRowHeader + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Create the rowHeader. If treeRowHeaderAlwaysVisible then + * set it to visible, otherwise set it to invisible + * + * @param {Grid} grid grid object + */ + createRowHeader: function( grid ) { + var rowHeaderColumnDef = { + name: uiGridTreeBaseConstants.rowHeaderColName, + displayName: '', + width: grid.options.treeRowHeaderBaseWidth, + minWidth: 10, + cellTemplate: 'ui-grid/treeBaseRowHeader', + headerCellTemplate: 'ui-grid/treeBaseHeaderCell', + enableColumnResizing: false, + enableColumnMenu: false, + exporterSuppressExport: true, + allowCellFocus: true + }; + + rowHeaderColumnDef.visible = grid.options.treeRowHeaderAlwaysVisible; + grid.addRowHeaderColumn(rowHeaderColumnDef, -100); + }, + + + /** + * @ngdoc function + * @name expandAllRows + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Expands all nodes in the tree + * + * @param {Grid} grid grid object + */ + expandAllRows: function (grid) { + grid.treeBase.tree.forEach( function( node ) { + service.setAllNodes( grid, node, uiGridTreeBaseConstants.EXPANDED); + }); + grid.treeBase.expandAll = true; + grid.queueGridRefresh(); + }, + + + /** + * @ngdoc function + * @name collapseAllRows + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Collapses all nodes in the tree + * + * @param {Grid} grid grid object + */ + collapseAllRows: function (grid) { + grid.treeBase.tree.forEach( function( node ) { + service.setAllNodes( grid, node, uiGridTreeBaseConstants.COLLAPSED); + }); + grid.treeBase.expandAll = false; + grid.queueGridRefresh(); + }, + + + /** + * @ngdoc function + * @name setAllNodes + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Works through a subset of grid.treeBase.rowExpandedStates, setting + * all child nodes (and their descendents) of the provided node to the given state. + * + * Calls itself recursively on all nodes so as to achieve this. + * + * @param {Grid} grid the grid we're operating on (so we can raise events) + * @param {object} treeNode a node in the tree that we want to update + * @param {string} targetState the state we want to set it to + */ + setAllNodes: function (grid, treeNode, targetState) { + if ( typeof(treeNode.state) !== 'undefined' && treeNode.state !== targetState ) { + treeNode.state = targetState; + + if ( targetState === uiGridTreeBaseConstants.EXPANDED ) { + grid.api.treeBase.raise.rowExpanded(treeNode.row); + } + else { + grid.api.treeBase.raise.rowCollapsed(treeNode.row); + } + } + + // set all child nodes + if ( treeNode.children ) { + treeNode.children.forEach(function( childNode ) { + service.setAllNodes(grid, childNode, targetState); + }); + } + }, + + + /** + * @ngdoc function + * @name toggleRowTreeState + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Toggles the expand or collapse state of this grouped row, if + * it's a parent row + * + * @param {Grid} grid grid object + * @param {GridRow} row the row we want to toggle + */ + toggleRowTreeState: function ( grid, row ) { + if ( typeof(row.treeLevel) === 'undefined' || row.treeLevel === null || row.treeLevel < 0 ) { + return; + } + + if (row.treeNode.state === uiGridTreeBaseConstants.EXPANDED) { + service.collapseRow(grid, row); + } + else { + service.expandRow(grid, row, false); + } + + grid.queueGridRefresh(); + }, + + + /** + * @ngdoc function + * @name expandRow + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Expands this specific row, showing only immediate children. + * + * @param {Grid} grid grid object + * @param {GridRow} row the row we want to expand + * @param {boolean} recursive true if you wish to expand the row's ancients + */ + expandRow: function ( grid, row, recursive ) { + if ( recursive ) { + var parents = []; + while ( row && typeof(row.treeLevel) !== 'undefined' && row.treeLevel !== null && row.treeLevel >= 0 && row.treeNode.state !== uiGridTreeBaseConstants.EXPANDED ) { + parents.push(row); + row = row.treeNode.parentRow; + } + + if ( parents.length > 0 ) { + row = parents.pop(); + while ( row ) { + row.treeNode.state = uiGridTreeBaseConstants.EXPANDED; + grid.api.treeBase.raise.rowExpanded(row); + row = parents.pop(); + } + + grid.treeBase.expandAll = service.allExpanded(grid.treeBase.tree); + grid.queueGridRefresh(); + } + } + else { + if ( typeof(row.treeLevel) === 'undefined' || row.treeLevel === null || row.treeLevel < 0 ) { + return; + } + + if ( row.treeNode.state !== uiGridTreeBaseConstants.EXPANDED ) { + row.treeNode.state = uiGridTreeBaseConstants.EXPANDED; + grid.api.treeBase.raise.rowExpanded(row); + grid.treeBase.expandAll = service.allExpanded(grid.treeBase.tree); + grid.queueGridRefresh(); + } + } + }, + + + /** + * @ngdoc function + * @name expandRowChildren + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Expands this specific row, showing all children. + * + * @param {Grid} grid grid object + * @param {GridRow} row the row we want to expand + */ + expandRowChildren: function ( grid, row ) { + if ( typeof(row.treeLevel) === 'undefined' || row.treeLevel === null || row.treeLevel < 0 ) { + return; + } + + service.setAllNodes(grid, row.treeNode, uiGridTreeBaseConstants.EXPANDED); + grid.treeBase.expandAll = service.allExpanded(grid.treeBase.tree); + grid.queueGridRefresh(); + }, + + + /** + * @ngdoc function + * @name collapseRow + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Collapses this specific row + * + * @param {Grid} grid grid object + * @param {GridRow} row the row we want to collapse + */ + collapseRow: function( grid, row ) { + if ( typeof(row.treeLevel) === 'undefined' || row.treeLevel === null || row.treeLevel < 0 ) { + return; + } + + if ( row.treeNode.state !== uiGridTreeBaseConstants.COLLAPSED ) { + row.treeNode.state = uiGridTreeBaseConstants.COLLAPSED; + grid.treeBase.expandAll = false; + grid.api.treeBase.raise.rowCollapsed(row); + grid.queueGridRefresh(); + } + }, + + + /** + * @ngdoc function + * @name collapseRowChildren + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Collapses this specific row and all children + * + * @param {Grid} grid grid object + * @param {GridRow} row the row we want to collapse + */ + collapseRowChildren: function( grid, row ) { + if ( typeof(row.treeLevel) === 'undefined' || row.treeLevel === null || row.treeLevel < 0 ) { + return; + } + + service.setAllNodes(grid, row.treeNode, uiGridTreeBaseConstants.COLLAPSED); + grid.treeBase.expandAll = false; + grid.queueGridRefresh(); + }, + + + /** + * @ngdoc function + * @name allExpanded + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Returns true if all rows are expanded, false + * if they're not. Walks the tree to determine this. Used + * to set the expandAll state. + * + * If the node has no children, then return true (it's immaterial + * whether it is expanded). If the node has children, then return + * false if this node is collapsed, or if any child node is not all expanded + * + * @param {object} tree the grid to check + * @returns {boolean} whether or not the tree is all expanded + */ + allExpanded: function( tree ) { + var allExpanded = true; + + tree.forEach(function( node ) { + if ( !service.allExpandedInternal( node ) ) { + allExpanded = false; + } + }); + return allExpanded; + }, + + allExpandedInternal: function( treeNode ) { + if ( treeNode.children && treeNode.children.length > 0 ) { + if ( treeNode.state === uiGridTreeBaseConstants.COLLAPSED ) { + return false; + } + var allExpanded = true; + treeNode.children.forEach( function( node ) { + if ( !service.allExpandedInternal( node ) ) { + allExpanded = false; + } + }); + return allExpanded; + } + else { + return true; + } + }, + + + /** + * @ngdoc function + * @name treeRows + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description The rowProcessor that adds the nodes to the tree, and sets the visible + * state of each row based on it's parent state + * + * Assumes it is always called after the sorting processor, and the grouping processor if there is one. + * Performs any tree sorts itself after having built the tree + * + * Processes all the rows in order, setting the group level based on the $$treeLevel in the associated + * entity, and setting the visible state based on the parent's state. + * + * Calculates the deepest level of tree whilst it goes, and updates that so that the header column can be correctly + * sized. + * + * Aggregates if necessary along the way. + * + * @param {array} renderableRows the rows we want to process, usually the output from the previous rowProcessor + * @returns {array} the updated rows + */ + treeRows: function( renderableRows ) { + var grid = this; + + if (renderableRows.length === 0) { + service.updateRowHeaderWidth( grid ); + return renderableRows; + } + + grid.treeBase.tree = service.createTree( grid, renderableRows ); + service.updateRowHeaderWidth( grid ); + + service.sortTree( grid ); + service.fixFilter( grid ); + + return service.renderTree( grid.treeBase.tree ); + }, + + + /** + * @ngdoc function + * @name createOrUpdateRowHeaderWidth + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Calculates the rowHeader width. + * + * If rowHeader is always present, updates the width. + * + * If rowHeader is only sometimes present (`treeRowHeaderAlwaysVisible: false`), determines whether there + * should be one, then creates or removes it as appropriate, with the created rowHeader having the + * right width. + * + * If there's never a rowHeader then never creates one: `showTreeRowHeader: false` + * + * @param {Grid} grid the grid we want to set the row header on + */ + updateRowHeaderWidth: function( grid ) { + var rowHeader = grid.getColumn(uiGridTreeBaseConstants.rowHeaderColName), + newWidth = grid.options.treeRowHeaderBaseWidth + grid.options.treeIndent * Math.max(grid.treeBase.numberLevels - 1, 0); + + if ( rowHeader && newWidth !== rowHeader.width ) { + rowHeader.width = newWidth; + grid.queueRefresh(); + } + + var newVisibility = true; + + if ( grid.options.showTreeRowHeader === false ) { + newVisibility = false; + } + if ( grid.options.treeRowHeaderAlwaysVisible === false && grid.treeBase.numberLevels <= 0 ) { + newVisibility = false; + } + if ( rowHeader && rowHeader.visible !== newVisibility ) { + rowHeader.visible = newVisibility; + rowHeader.colDef.visible = newVisibility; + grid.queueGridRefresh(); + } + }, + + + /** + * @ngdoc function + * @name renderTree + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Creates an array of rows based on the tree, exporting only + * the visible nodes and leaves + * + * @param {array} nodeList The list of nodes - can be grid.treeBase.tree, or can be node.children when + * we're calling recursively + * @returns {array} renderable rows + */ + renderTree: function( nodeList ) { + var renderableRows = []; + + nodeList.forEach( function ( node ) { + if ( node.row.visible ) { + renderableRows.push( node.row ); + } + if ( node.state === uiGridTreeBaseConstants.EXPANDED && node.children && node.children.length > 0 ) { + renderableRows = renderableRows.concat( service.renderTree( node.children ) ); + } + }); + return renderableRows; + }, + + + /** + * @ngdoc function + * @name createTree + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Creates a tree from the renderableRows + * + * @param {Grid} grid The grid + * @param {array} renderableRows The rows we want to create a tree from + * @returns {object} The tree we've build + */ + createTree: function( grid, renderableRows ) { + var currentLevel = -1, + parentsCache = {}, + parents = [], + currentState; + + grid.treeBase.tree = []; + grid.treeBase.numberLevels = 0; + + var aggregations = service.getAggregations( grid ); + + function createNode( row ) { + if ( !row.internalRow && row.treeLevel !== row.entity.$$treeLevel ) { + row.treeLevel = row.entity.$$treeLevel; + } + + if ( row.treeLevel <= currentLevel ) { + // pop any levels that aren't parents of this level, formatting the aggregation at the same time + while ( row.treeLevel <= currentLevel ) { + var lastParent = parents.pop(); + service.finaliseAggregations( lastParent ); + currentLevel--; + } + + // reset our current state based on the new parent, set to expanded if this is a level 0 node + if ( parents.length > 0 ) { + currentState = service.setCurrentState(parents); + } + else { + currentState = uiGridTreeBaseConstants.EXPANDED; + } + } + + // If row header as parent exists in parentsCache + if ( + typeof row.treeLevel !== 'undefined' && + row.treeLevel !== null && + row.treeLevel >= 0 && + parentsCache.hasOwnProperty(row.uid) + ) { + parents.push(parentsCache[row.uid]); + } + + // aggregate if this is a leaf node + if ( ( typeof(row.treeLevel) === 'undefined' || row.treeLevel === null || row.treeLevel < 0 ) && row.visible ) { + service.aggregate( grid, row, parents ); + } + + // add this node to the tree + if (!parentsCache.hasOwnProperty(row.uid)) { + service.addOrUseNode(grid, row, parents, aggregations); + } + + if ( typeof(row.treeLevel) !== 'undefined' && row.treeLevel !== null && row.treeLevel >= 0 ) { + if (!parentsCache.hasOwnProperty(row.uid)) { + parentsCache[row.uid] = row; + parents.push(row); + } + currentLevel++; + currentState = service.setCurrentState(parents); + } + + // update the tree number of levels, so we can set header width if we need to + if ( grid.treeBase.numberLevels < row.treeLevel + 1) { + grid.treeBase.numberLevels = row.treeLevel + 1; + } + } + + renderableRows.forEach( createNode ); + + // finalize remaining aggregations + while ( parents.length > 0 ) { + var lastParent = parents.pop(); + service.finaliseAggregations( lastParent ); + } + + return grid.treeBase.tree; + }, + + + /** + * @ngdoc function + * @name addOrUseNode + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Creates a tree node for this row. If this row already has a treeNode + * recorded against it, preserves the state, but otherwise overwrites the data. + * + * @param {grid} grid The grid we're operating on + * @param {gridRow} row The row we want to set + * @param {array} parents An array of the parents this row should have + * @param {array} aggregationBase Empty aggregation information + * @returns {undefined} Updates the parents array, updates the row to have a treeNode, and updates the + * grid.treeBase.tree + */ + addOrUseNode: function( grid, row, parents, aggregationBase ) { + var newAggregations = []; + aggregationBase.forEach( function(aggregation) { + newAggregations.push(service.buildAggregationObject(aggregation.col)); + }); + + var newNode = { state: uiGridTreeBaseConstants.COLLAPSED, row: row, parentRow: null, aggregations: newAggregations, children: [] }; + if ( row.treeNode ) { + newNode.state = row.treeNode.state; + } + if ( parents.length > 0 ) { + newNode.parentRow = parents[parents.length - 1]; + } + row.treeNode = newNode; + + if ( parents.length === 0 ) { + grid.treeBase.tree.push( newNode ); + } else { + parents[parents.length - 1].treeNode.children.push( newNode ); + } + }, + + + /** + * @ngdoc function + * @name setCurrentState + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Looks at the parents array to determine our current state. + * If any node in the hierarchy is collapsed, then return collapsed, otherwise return + * expanded. + * + * @param {array} parents An array of the parents this row should have + * @returns {string} The state we should be setting to any nodes we see + */ + setCurrentState: function( parents ) { + var currentState = uiGridTreeBaseConstants.EXPANDED; + + parents.forEach( function(parent) { + if ( parent.treeNode.state === uiGridTreeBaseConstants.COLLAPSED ) { + currentState = uiGridTreeBaseConstants.COLLAPSED; + } + }); + return currentState; + }, + + + /** + * @ngdoc function + * @name sortTree + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Performs a recursive sort on the tree nodes, sorting the + * children of each node and putting them back into the children array. + * + * Before doing this it turns back on all the sortIgnore - things that were previously + * ignored we process now. Since we're sorting within the nodes, presumably anything + * that was already sorted is how we derived the nodes, we can keep those sorts too. + * + * We only sort tree nodes that are expanded - no point in wasting effort sorting collapsed + * nodes + * + * @param {Grid} grid The grid to get the aggregation information from + * @returns {array} The aggregation information + */ + sortTree: function( grid ) { + grid.columns.forEach( function( column ) { + if ( column.sort && column.sort.ignoreSort ) { + delete column.sort.ignoreSort; + } + }); + + grid.treeBase.tree = service.sortInternal( grid, grid.treeBase.tree ); + }, + + sortInternal: function( grid, treeList ) { + var rows = treeList.map( function( node ) { + return node.row; + }); + + rows = rowSorter.sort( grid, rows, grid.columns ); + + var treeNodes = rows.map( function( row ) { + return row.treeNode; + }); + + treeNodes.forEach( function( node ) { + if ( node.state === uiGridTreeBaseConstants.EXPANDED && node.children && node.children.length > 0 ) { + node.children = service.sortInternal( grid, node.children ); + } + }); + + return treeNodes; + }, + + /** + * @ngdoc function + * @name fixFilter + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description After filtering has run, we need to go back through the tree + * and make sure the parent rows are always visible if any of the child rows + * are visible (filtering may make a child visible, but the parent may not + * match the filter criteria) + * + * This has a risk of being computationally expensive, we do it by walking + * the tree and remembering whether there are any invisible nodes on the + * way down. + * + * @param {Grid} grid the grid to fix filters on + */ + fixFilter: function( grid ) { + var parentsVisible; + + grid.treeBase.tree.forEach( function( node ) { + if ( node.children && node.children.length > 0 ) { + parentsVisible = node.row.visible; + service.fixFilterInternal( node.children, parentsVisible ); + } + }); + }, + + fixFilterInternal: function( nodes, parentsVisible) { + nodes.forEach(function( node ) { + if ( node.row.visible && !parentsVisible ) { + service.setParentsVisible( node ); + parentsVisible = true; + } + + if ( node.children && node.children.length > 0 ) { + if ( service.fixFilterInternal( node.children, ( parentsVisible && node.row.visible ) ) ) { + parentsVisible = true; + } + } + }); + + return parentsVisible; + }, + + setParentsVisible: function( node ) { + while ( node.parentRow ) { + node.parentRow.visible = true; + node = node.parentRow.treeNode; + } + }, + + /** + * @ngdoc function + * @name buildAggregationObject + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Build the object which is stored on the column for holding meta-data about the aggregation. + * This method should only be called with columns which have an aggregation. + * + * @param {GridColumn} column The column which this object relates to + * @returns {object} {col: GridColumn object, label: string, type: string (optional)} + */ + buildAggregationObject: function( column ) { + var newAggregation = { col: column }; + + if ( column.treeAggregation && column.treeAggregation.type ) { + newAggregation.type = column.treeAggregation.type; + } + + if ( column.treeAggregation && column.treeAggregation.label ) { + newAggregation.label = column.treeAggregation.label; + } + + return newAggregation; + }, + + /** + * @ngdoc function + * @name getAggregations + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Looks through the grid columns to find those with aggregations, + * and collates the aggregation information into an array, returns that array + * + * @param {Grid} grid the grid to get the aggregation information from + * @returns {array} the aggregation information + */ + getAggregations: function( grid ) { + var aggregateArray = []; + + grid.columns.forEach( function(column) { + if ( typeof(column.treeAggregationFn) !== 'undefined' ) { + aggregateArray.push( service.buildAggregationObject(column) ); + + if ( grid.options.showColumnFooter && typeof(column.colDef.aggregationType) === 'undefined' && column.treeAggregation ) { + // Add aggregation object for footer + column.treeFooterAggregation = service.buildAggregationObject(column); + column.aggregationType = service.treeFooterAggregationType; + } + } + }); + return aggregateArray; + }, + + + /** + * @ngdoc function + * @name aggregate + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Accumulate the data from this row onto the aggregations for each parent + * + * Iterate over the parents, then iterate over the aggregations for each of those parents, + * and perform the aggregation for each individual aggregation + * + * @param {Grid} grid grid object + * @param {GridRow} row the row we want to set grouping visibility on + * @param {array} parents the parents that we would want to aggregate onto + */ + aggregate: function( grid, row, parents ) { + if (parents.length === 0 && row.treeNode && row.treeNode.aggregations) { + row.treeNode.aggregations.forEach(function(aggregation) { + // Calculate aggregations for footer even if there are no grouped rows + if (typeof(aggregation.col.treeFooterAggregation) !== 'undefined') { + var fieldValue = grid.getCellValue(row, aggregation.col); + var numValue = Number(fieldValue); + if (aggregation.col.treeAggregationFn) { + aggregation.col.treeAggregationFn(aggregation.col.treeFooterAggregation, fieldValue, numValue, row); + } else { + aggregation.col.treeFooterAggregation.value = undefined; + } + } + }); + } + + parents.forEach( function( parent, index ) { + if (parent.treeNode.aggregations) { + parent.treeNode.aggregations.forEach( function( aggregation ) { + var fieldValue = grid.getCellValue(row, aggregation.col); + var numValue = Number(fieldValue); + aggregation.col.treeAggregationFn(aggregation, fieldValue, numValue, row); + + if (index === 0 && typeof(aggregation.col.treeFooterAggregation) !== 'undefined') { + if (aggregation.col.treeAggregationFn) { + aggregation.col.treeAggregationFn(aggregation.col.treeFooterAggregation, fieldValue, numValue, row); + } else { + aggregation.col.treeFooterAggregation.value = undefined; + } + } + }); + } + }); + }, + + + // Aggregation routines - no doco needed as self evident + nativeAggregations: function() { + return { + count: { + label: i18nService.get().aggregation.count, + menuTitle: i18nService.get().grouping.aggregate_count, + aggregationFn: function (aggregation, fieldValue, numValue) { + if (typeof(aggregation.value) === 'undefined') { + aggregation.value = 1; + } else { + aggregation.value++; + } + } + }, + + sum: { + label: i18nService.get().aggregation.sum, + menuTitle: i18nService.get().grouping.aggregate_sum, + aggregationFn: function( aggregation, fieldValue, numValue ) { + if (!isNaN(numValue)) { + if (typeof(aggregation.value) === 'undefined') { + aggregation.value = numValue; + } else { + aggregation.value += numValue; + } + } + } + }, + + min: { + label: i18nService.get().aggregation.min, + menuTitle: i18nService.get().grouping.aggregate_min, + aggregationFn: function( aggregation, fieldValue, numValue ) { + if (typeof(aggregation.value) === 'undefined') { + aggregation.value = fieldValue; + } else { + if (typeof(fieldValue) !== 'undefined' && fieldValue !== null && (fieldValue < aggregation.value || aggregation.value === null)) { + aggregation.value = fieldValue; + } + } + } + }, + + max: { + label: i18nService.get().aggregation.max, + menuTitle: i18nService.get().grouping.aggregate_max, + aggregationFn: function( aggregation, fieldValue, numValue ) { + if ( typeof(aggregation.value) === 'undefined' ) { + aggregation.value = fieldValue; + } else { + if ( typeof(fieldValue) !== 'undefined' && fieldValue !== null && (fieldValue > aggregation.value || aggregation.value === null)) { + aggregation.value = fieldValue; + } + } + } + }, + + avg: { + label: i18nService.get().aggregation.avg, + menuTitle: i18nService.get().grouping.aggregate_avg, + aggregationFn: function( aggregation, fieldValue, numValue ) { + if ( typeof(aggregation.count) === 'undefined' ) { + aggregation.count = 1; + } else { + aggregation.count++; + } + + if ( isNaN(numValue) ) { + return; + } + + if ( typeof(aggregation.value) === 'undefined' || typeof(aggregation.sum) === 'undefined' ) { + aggregation.value = numValue; + aggregation.sum = numValue; + } else { + aggregation.sum += numValue; + aggregation.value = aggregation.sum / aggregation.count; + } + } + } + }; + }, + + /** + * @ngdoc function + * @name finaliseAggregation + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Helper function used to finalize aggregation nodes and footer cells + * + * @param {gridRow} row The parent we're finalising + * @param {aggregation} aggregation The aggregation object manipulated by the aggregationFn + */ + finaliseAggregation: function(row, aggregation) { + if ( aggregation.col.treeAggregationUpdateEntity && typeof(row) !== 'undefined' && typeof(row.entity[ '$$' + aggregation.col.uid ]) !== 'undefined' ) { + angular.extend( aggregation, row.entity[ '$$' + aggregation.col.uid ]); + } + + if ( typeof(aggregation.col.treeAggregationFinalizerFn) === 'function' ) { + aggregation.col.treeAggregationFinalizerFn( aggregation ); + } + if ( typeof(aggregation.col.customTreeAggregationFinalizerFn) === 'function' ) { + aggregation.col.customTreeAggregationFinalizerFn( aggregation ); + } + if ( typeof(aggregation.rendered) === 'undefined' ) { + aggregation.rendered = aggregation.label ? aggregation.label + aggregation.value : aggregation.value; + } + }, + + /** + * @ngdoc function + * @name finaliseAggregations + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Format the data from the aggregation into the rendered text + * e.g. if we had label: 'sum: ' and value: 25, we'd create 'sum: 25'. + * + * As part of this we call any formatting callback routines we've been provided. + * + * We write our aggregation out to the row.entity if treeAggregationUpdateEntity is + * set on the column - we don't overwrite any information that's already there, we append + * to it so that grouping can have set the groupVal beforehand without us overwriting it. + * + * We need to copy the data from the row.entity first before we finalise the aggregation, + * we need that information for the finaliserFn + * + * @param {gridRow} row the parent we're finalising + */ + finaliseAggregations: function( row ) { + if ( row == null || typeof(row.treeNode.aggregations) === 'undefined' ) { + return; + } + + row.treeNode.aggregations.forEach( function( aggregation ) { + service.finaliseAggregation(row, aggregation); + + if ( aggregation.col.treeAggregationUpdateEntity ) { + var aggregationCopy = {}; + + angular.forEach( aggregation, function( value, key ) { + if ( aggregation.hasOwnProperty(key) && key !== 'col' ) { + aggregationCopy[key] = value; + } + }); + + row.entity[ '$$' + aggregation.col.uid ] = aggregationCopy; + } + }); + }, + + /** + * @ngdoc function + * @name treeFooterAggregationType + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Uses the tree aggregation functions and finalizers to set the + * column footer aggregations. + * + * @param {rows} rows The visible rows. not used, but accepted to match signature of GridColumn.aggregationType + * @param {GridColumn} column The column we are finalizing + */ + treeFooterAggregationType: function( rows, column ) { + service.finaliseAggregation(undefined, column.treeFooterAggregation); + if ( typeof(column.treeFooterAggregation.value) === 'undefined' || column.treeFooterAggregation.rendered === null ) { + // The was apparently no aggregation performed (perhaps this is a grouped column + return ''; + } + return column.treeFooterAggregation.rendered; + } + }; + + return service; + }]); + + + /** + * @ngdoc directive + * @name ui.grid.treeBase.directive:uiGridTreeRowHeaderButtons + * @element div + * + * @description Provides the expand/collapse button on rows + */ + module.directive('uiGridTreeBaseRowHeaderButtons', ['$templateCache', 'uiGridTreeBaseService', + function ($templateCache, uiGridTreeBaseService) { + return { + replace: true, + restrict: 'E', + template: $templateCache.get('ui-grid/treeBaseRowHeaderButtons'), + scope: true, + require: '^uiGrid', + link: function($scope, $elm, $attrs, uiGridCtrl) { + var self = uiGridCtrl.grid; + $scope.treeButtonClass = function(row) { + if ( ( self.options.showTreeExpandNoChildren && row.treeLevel > -1 ) || ( row.treeNode.children && row.treeNode.children.length > 0 ) ) { + if (row.treeNode.state === 'expanded' ) { + return 'ui-grid-icon-minus-squared'; + } + if (row.treeNode.state === 'collapsed' ) { + return 'ui-grid-icon-plus-squared'; + } + } + }; + $scope.treeButtonClick = function(row, evt) { + evt.stopPropagation(); + uiGridTreeBaseService.toggleRowTreeState(self, row, evt); + }; + $scope.treeButtonKeyDown = function (row, evt) { + if (evt.keyCode === 32 || evt.keyCode === 13) { + $scope.treeButtonClick(row, evt); + } + }; + } + }; + }]); + + + /** + * @ngdoc directive + * @name ui.grid.treeBase.directive:uiGridTreeBaseExpandAllButtons + * @element div + * + * @description Provides the expand/collapse all button + */ + module.directive('uiGridTreeBaseExpandAllButtons', ['$templateCache', 'uiGridTreeBaseService', + function ($templateCache, uiGridTreeBaseService) { + return { + replace: true, + restrict: 'E', + template: $templateCache.get('ui-grid/treeBaseExpandAllButtons'), + scope: false, + link: function($scope) { + var self = $scope.col.grid; + $scope.headerButtonClass = function() { + if (self.treeBase.numberLevels > 0 && self.treeBase.expandAll) { + return 'ui-grid-icon-minus-squared'; + } + if (self.treeBase.numberLevels > 0 && !self.treeBase.expandAll) { + return 'ui-grid-icon-plus-squared'; + } + }; + $scope.headerButtonClick = function(row, evt) { + if ( self.treeBase.expandAll ) { + uiGridTreeBaseService.collapseAllRows(self, evt); + } else { + uiGridTreeBaseService.expandAllRows(self, evt); + } + }; + $scope.headerButtonKeyDown = function (evt) { + if (evt.keyCode === 32 || evt.keyCode === 13) { + $scope.headerButtonClick(self, evt); + } + }; + } + }; + }]); + + + /** + * @ngdoc directive + * @name ui.grid.treeBase.directive:uiGridViewport + * @element div + * + * @description Stacks on top of ui.grid.uiGridViewport to set formatting on a tree header row + */ + module.directive('uiGridViewport', + function () { + return { + priority: -200, // run after default directive + scope: false, + compile: function ($elm) { + var rowRepeatDiv = angular.element($elm.children().children()[0]); + + var existingNgClass = rowRepeatDiv.attr("ng-class"); + var newNgClass = ''; + if ( existingNgClass ) { + newNgClass = existingNgClass.slice(0, -1) + ",'ui-grid-tree-header-row': row.treeLevel > -1}"; + } else { + newNgClass = "{'ui-grid-tree-header-row': row.treeLevel > -1}"; + } + rowRepeatDiv.attr("ng-class", newNgClass); + + return { + pre: function ($scope, $elm, $attrs, controllers) { + + }, + post: function ($scope, $elm, $attrs, controllers) { + } + }; + } + }; + }); +})(); + +angular.module('ui.grid.treeBase').run(['$templateCache', function($templateCache) { + 'use strict'; + + $templateCache.put('ui-grid/treeBaseExpandAllButtons', + "" + ); + + + $templateCache.put('ui-grid/treeBaseHeaderCell', + " -1 }\" tabindex=\"0\" ng-keydown=\"treeButtonKeyDown(row, $event)\" ng-click=\"treeButtonClick(row, $event)\"> "
+ );
+
+}]);
diff --git a/release/4.9.2/i18n/ui-grid.tree-base.min.js b/release/4.9.2/i18n/ui-grid.tree-base.min.js
new file mode 100644
index 000000000..5150373cd
--- /dev/null
+++ b/release/4.9.2/i18n/ui-grid.tree-base.min.js
@@ -0,0 +1,7 @@
+/*!
+ * ui-grid - v4.9.2 - 2020-12-01
+ * Copyright (c) 2020 ; License: MIT
+ */
+
+
+!function(){"use strict";var e=angular.module("ui.grid.treeBase",["ui.grid"]);e.constant("uiGridTreeBaseConstants",{featureName:"treeBase",rowHeaderColName:"treeBaseRowHeaderCol",EXPANDED:"expanded",COLLAPSED:"collapsed",aggregation:{COUNT:"count",SUM:"sum",MAX:"max",MIN:"min",AVG:"avg"}}),e.service("uiGridTreeBaseService",["$q","uiGridTreeBaseConstants","gridUtil","GridRow","gridClassFactory","i18nService","uiGridConstants","rowSorter",function(e,l,t,r,n,o,a,i){var g={initializeGrid:function(r){r.treeBase={},r.treeBase.numberLevels=0,r.treeBase.expandAll=!1,r.treeBase.tree=[],g.defaultGridOptions(r.options),r.registerRowsProcessor(g.treeRows,410),r.registerColumnBuilder(g.treeBaseColumnBuilder),g.createRowHeader(r);var e={events:{treeBase:{rowExpanded:{},rowCollapsed:{}}},methods:{treeBase:{expandAllRows:function(){g.expandAllRows(r)},collapseAllRows:function(){g.collapseAllRows(r)},toggleRowTreeState:function(e){g.toggleRowTreeState(r,e)},expandRow:function(e,t){g.expandRow(r,e,t)},expandRowChildren:function(e){g.expandRowChildren(r,e)},collapseRow:function(e){g.collapseRow(r,e)},collapseRowChildren:function(e){g.collapseRowChildren(r,e)},getTreeExpandedState:function(){return{expandedState:g.getTreeState(r)}},setTreeState:function(e){g.setTreeState(r,e)},getRowChildren:function(e){return e.treeNode.children.map(function(e){return e.row})}}}};r.api.registerEventsFromObject(e.events),r.api.registerMethodsFromObject(e.methods)},defaultGridOptions:function(e){e.treeRowHeaderBaseWidth=e.treeRowHeaderBaseWidth||30,e.treeIndent=null!=e.treeIndent?e.treeIndent:10,e.showTreeRowHeader=!1!==e.showTreeRowHeader,e.showTreeExpandNoChildren=!1!==e.showTreeExpandNoChildren,e.treeRowHeaderAlwaysVisible=!1!==e.treeRowHeaderAlwaysVisible,e.treeCustomAggregations=e.treeCustomAggregations||{},e.enableExpandAll=!1!==e.enableExpandAll},treeBaseColumnBuilder:function(e,t,r){void 0!==e.customTreeAggregationFn&&(t.treeAggregationFn=e.customTreeAggregationFn),void 0!==e.treeAggregationType&&(t.treeAggregation={type:e.treeAggregationType},void 0!==r.treeCustomAggregations[e.treeAggregationType]?(t.treeAggregationFn=r.treeCustomAggregations[e.treeAggregationType].aggregationFn,t.treeAggregationFinalizerFn=r.treeCustomAggregations[e.treeAggregationType].finalizerFn,t.treeAggregation.label=r.treeCustomAggregations[e.treeAggregationType].label):void 0!==g.nativeAggregations()[e.treeAggregationType]&&(t.treeAggregationFn=g.nativeAggregations()[e.treeAggregationType].aggregationFn,t.treeAggregation.label=g.nativeAggregations()[e.treeAggregationType].label)),void 0!==e.treeAggregationLabel&&(void 0===t.treeAggregation&&(t.treeAggregation={}),t.treeAggregation.label=e.treeAggregationLabel),t.treeAggregationUpdateEntity=!1!==e.treeAggregationUpdateEntity,void 0===t.customTreeAggregationFinalizerFn&&(t.customTreeAggregationFinalizerFn=e.customTreeAggregationFinalizerFn)},createRowHeader:function(e){var t={name:l.rowHeaderColName,displayName:"",width:e.options.treeRowHeaderBaseWidth,minWidth:10,cellTemplate:"ui-grid/treeBaseRowHeader",headerCellTemplate:"ui-grid/treeBaseHeaderCell",enableColumnResizing:!1,enableColumnMenu:!1,exporterSuppressExport:!0,allowCellFocus:!0};t.visible=e.options.treeRowHeaderAlwaysVisible,e.addRowHeaderColumn(t,-100)},expandAllRows:function(t){t.treeBase.tree.forEach(function(e){g.setAllNodes(t,e,l.EXPANDED)}),t.treeBase.expandAll=!0,t.queueGridRefresh()},collapseAllRows:function(t){t.treeBase.tree.forEach(function(e){g.setAllNodes(t,e,l.COLLAPSED)}),t.treeBase.expandAll=!1,t.queueGridRefresh()},setAllNodes:function(t,e,r){void 0!==e.state&&e.state!==r&&((e.state=r)===l.EXPANDED?t.api.treeBase.raise.rowExpanded(e.row):t.api.treeBase.raise.rowCollapsed(e.row)),e.children&&e.children.forEach(function(e){g.setAllNodes(t,e,r)})},toggleRowTreeState:function(e,t){void 0===t.treeLevel||null===t.treeLevel||t.treeLevel<0||(t.treeNode.state===l.EXPANDED?g.collapseRow(e,t):g.expandRow(e,t,!1),e.queueGridRefresh())},expandRow:function(e,t,r){if(r){for(var n=[];t&&void 0!==t.treeLevel&&null!==t.treeLevel&&0<=t.treeLevel&&t.treeNode.state!==l.EXPANDED;)n.push(t),t=t.treeNode.parentRow;if(0Beta This feature is ready for testing, but it either hasn't seen a lot of use or has some known bugs.
+ *
+ * This module provides a tree view of the data that it is provided, with nodes in that
+ * tree and leaves. Unlike grouping, the tree is an inherent property of the data and must
+ * be provided with your data array.
+ *
+ * Design information:
+ * -------------------
+ *
+ * TreeView uses treeBase for the underlying functionality, and is a very thin wrapper around
+ * that logic. Most of the design information has now moved to treebase.
+ * + * + * + * + */ + + var module = angular.module('ui.grid.treeView', ['ui.grid', 'ui.grid.treeBase']); + + /** + * @ngdoc object + * @name ui.grid.treeView.constant:uiGridTreeViewConstants + * + * @description constants available in treeView module, this includes + * all the constants declared in the treeBase module (these are manually copied + * as there isn't an easy way to include constants in another constants file, and + * we don't want to make users include treeBase) + * + */ + module.constant('uiGridTreeViewConstants', { + featureName: "treeView", + rowHeaderColName: 'treeBaseRowHeaderCol', + EXPANDED: 'expanded', + COLLAPSED: 'collapsed', + aggregation: { + COUNT: 'count', + SUM: 'sum', + MAX: 'max', + MIN: 'min', + AVG: 'avg' + } + }); + + /** + * @ngdoc service + * @name ui.grid.treeView.service:uiGridTreeViewService + * + * @description Services for treeView features + */ + module.service('uiGridTreeViewService', ['$q', 'uiGridTreeViewConstants', 'uiGridTreeBaseConstants', 'uiGridTreeBaseService', 'gridUtil', 'GridRow', 'gridClassFactory', 'i18nService', 'uiGridConstants', + function ($q, uiGridTreeViewConstants, uiGridTreeBaseConstants, uiGridTreeBaseService, gridUtil, GridRow, gridClassFactory, i18nService, uiGridConstants) { + + var service = { + + initializeGrid: function (grid, $scope) { + uiGridTreeBaseService.initializeGrid( grid, $scope ); + + /** + * @ngdoc object + * @name ui.grid.treeView.grid:treeView + * + * @description Grid properties and functions added for treeView + */ + grid.treeView = {}; + + grid.registerRowsProcessor(service.adjustSorting, 60); + + /** + * @ngdoc object + * @name ui.grid.treeView.api:PublicApi + * + * @description Public Api for treeView feature + */ + var publicApi = { + events: { + treeView: { + } + }, + methods: { + treeView: { + } + } + }; + + grid.api.registerEventsFromObject(publicApi.events); + + grid.api.registerMethodsFromObject(publicApi.methods); + + }, + + defaultGridOptions: function (gridOptions) { + // default option to true unless it was explicitly set to false + /** + * @ngdoc object + * @name ui.grid.treeView.api:GridOptions + * + * @description GridOptions for treeView feature, these are available to be + * set using the ui-grid {@link ui.grid.class:GridOptions gridOptions} + * + * Many tree options are set on treeBase, make sure to look at that feature in + * conjunction with these options. + */ + + /** + * @ngdoc object + * @name enableTreeView + * @propertyOf ui.grid.treeView.api:GridOptions + * @description Enable row tree view for entire grid. + * Defaults to true + */ + gridOptions.enableTreeView = gridOptions.enableTreeView !== false; + + }, + + + /** + * @ngdoc function + * @name adjustSorting + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Trees cannot be sorted the same as flat lists of rows - + * trees are sorted recursively within each level - so the children of each + * node are sorted, but not the full set of rows. + * + * To achieve this, we suppress the normal sorting by setting ignoreSort on + * each of the sort columns. When the treeBase rowsProcessor runs it will then + * unignore these, and will perform a recursive sort against the tree that it builds. + * + * @param {array} renderableRows the rows that we need to pass on through + * @returns {array} renderableRows that we passed on through + */ + adjustSorting: function( renderableRows ) { + var grid = this; + + grid.columns.forEach( function( column ) { + if ( column.sort ) { + column.sort.ignoreSort = true; + } + }); + + return renderableRows; + } + }; + + return service; + }]); + + /** + * @ngdoc directive + * @name ui.grid.treeView.directive:uiGridTreeView + * @element div + * @restrict A + * + * @description Adds treeView features to grid + * + * @example +
+
+
+ Alpha This feature is in development. There will almost certainly be breaking api changes, or there are major outstanding bugs.
+ *
+ * This module provides the ability to validate cells upon change.
+ *
+ * Design information:
+ * -------------------
+ *
+ * Validation is not based on angularjs validation, since it would work only when editing the field.
+ *
+ * Instead it adds custom properties to any field considered as invalid.
+ *
+ * + * + * + * + */ + var module = angular.module('ui.grid.validate', ['ui.grid']); + + /** + * @ngdoc service + * @name ui.grid.validate.service:uiGridValidateService + * + * @description Services for validation features + */ + module.service('uiGridValidateService', ['$sce', '$q', '$http', 'i18nService', 'uiGridConstants', function ($sce, $q, $http, i18nService, uiGridConstants) { + + var service = { + + /** + * @ngdoc object + * @name validatorFactories + * @propertyOf ui.grid.validate.service:uiGridValidateService + * @description object containing all the factories used to validate data. + * These factories will be in the form + * ``` + * { + * validatorFactory: function(argument) { + * return function(newValue, oldValue, rowEntity, colDef) { + * return true || false || promise + * } + * }, + * messageFunction: function(argument) { + * return string + * } + * } + * ``` + * + * Promises should return true or false as result according to the result of validation. + */ + validatorFactories: {}, + + /** + * @ngdoc service + * @name setExternalFactoryFunction + * @methodOf ui.grid.validate.service:uiGridValidateService + * @description Adds a way to retrieve validators from an external service + * Validators from this external service have a higher priority than default
+ * ones
+ * @param {function} externalFactoryFunction a function that accepts name and argument to pass to a
+ * validator factory and that returns an object with the same properties as
+ * you can see in {@link ui.grid.validate.service:uiGridValidateService#properties_validatorFactories validatorFactories}
+ */
+ setExternalFactoryFunction: function(externalFactoryFunction) {
+ service.externalFactoryFunction = externalFactoryFunction;
+ },
+
+ /**
+ * @ngdoc service
+ * @name clearExternalFactory
+ * @methodOf ui.grid.validate.service:uiGridValidateService
+ * @description Removes any link to external factory from this service
+ */
+ clearExternalFactory: function() {
+ delete service.externalFactoryFunction;
+ },
+
+ /**
+ * @ngdoc service
+ * @name getValidatorFromExternalFactory
+ * @methodOf ui.grid.validate.service:uiGridValidateService
+ * @description Retrieves a validator by executing a validatorFactory
+ * stored in an external service.
+ * @param {string} name the name of the validator to retrieve
+ * @param {object} argument an argument to pass to the validator factory
+ */
+ getValidatorFromExternalFactory: function(name, argument) {
+ return service.externalFactoryFunction(name, argument).validatorFactory(argument);
+ },
+
+ /**
+ * @ngdoc service
+ * @name getMessageFromExternalFactory
+ * @methodOf ui.grid.validate.service:uiGridValidateService
+ * @description Retrieves a message stored in an external service.
+ * @param {string} name the name of the validator
+ * @param {object} argument an argument to pass to the message function
+ */
+ getMessageFromExternalFactory: function(name, argument) {
+ return service.externalFactoryFunction(name, argument).messageFunction(argument);
+ },
+
+ /**
+ * @ngdoc service
+ * @name setValidator
+ * @methodOf ui.grid.validate.service:uiGridValidateService
+ * @description Adds a new validator to the service
+ * @param {string} name the name of the validator, must be unique
+ * @param {function} validatorFactory a factory that return a validatorFunction
+ * @param {function} messageFunction a function that return the error message
+ */
+ setValidator: function(name, validatorFactory, messageFunction) {
+ service.validatorFactories[name] = {
+ validatorFactory: validatorFactory,
+ messageFunction: messageFunction
+ };
+ },
+
+ /**
+ * @ngdoc service
+ * @name getValidator
+ * @methodOf ui.grid.validate.service:uiGridValidateService
+ * @description Returns a validator registered to the service
+ * or retrieved from the external factory
+ * @param {string} name the name of the validator to retrieve
+ * @param {object} argument an argument to pass to the validator factory
+ * @returns {object} the validator function
+ */
+ getValidator: function(name, argument) {
+ if (service.externalFactoryFunction) {
+ var validator = service.getValidatorFromExternalFactory(name, argument);
+ if (validator) {
+ return validator;
+ }
+ }
+ if (!service.validatorFactories[name]) {
+ throw ("Invalid validator name: " + name);
+ }
+ return service.validatorFactories[name].validatorFactory(argument);
+ },
+
+ /**
+ * @ngdoc service
+ * @name getMessage
+ * @methodOf ui.grid.validate.service:uiGridValidateService
+ * @description Returns the error message related to the validator
+ * @param {string} name the name of the validator
+ * @param {object} argument an argument to pass to the message function
+ * @returns {string} the error message related to the validator
+ */
+ getMessage: function(name, argument) {
+ if (service.externalFactoryFunction) {
+ var message = service.getMessageFromExternalFactory(name, argument);
+ if (message) {
+ return message;
+ }
+ }
+ return service.validatorFactories[name].messageFunction(argument);
+ },
+
+ /**
+ * @ngdoc service
+ * @name isInvalid
+ * @methodOf ui.grid.validate.service:uiGridValidateService
+ * @description Returns true if the cell (identified by rowEntity, colDef) is invalid
+ * @param {object} rowEntity the row entity of the cell
+ * @param {object} colDef the colDef of the cell
+ * @returns {boolean} true if the cell is invalid
+ */
+ isInvalid: function (rowEntity, colDef) {
+ return rowEntity['$$invalid'+colDef.name];
+ },
+
+ /**
+ * @ngdoc service
+ * @name setInvalid
+ * @methodOf ui.grid.validate.service:uiGridValidateService
+ * @description Makes the cell invalid by adding the proper field to the entity
+ * @param {object} rowEntity the row entity of the cell
+ * @param {object} colDef the colDef of the cell
+ */
+ setInvalid: function (rowEntity, colDef) {
+ rowEntity['$$invalid'+colDef.name] = true;
+ },
+
+ /**
+ * @ngdoc service
+ * @name setValid
+ * @methodOf ui.grid.validate.service:uiGridValidateService
+ * @description Makes the cell valid by removing the proper error field from the entity
+ * @param {object} rowEntity the row entity of the cell
+ * @param {object} colDef the colDef of the cell
+ */
+ setValid: function (rowEntity, colDef) {
+ delete rowEntity['$$invalid'+colDef.name];
+ },
+
+ /**
+ * @ngdoc service
+ * @name setError
+ * @methodOf ui.grid.validate.service:uiGridValidateService
+ * @description Adds the proper error to the entity errors field
+ * @param {object} rowEntity the row entity of the cell
+ * @param {object} colDef the colDef of the cell
+ * @param {string} validatorName the name of the validator that is failing
+ */
+ setError: function(rowEntity, colDef, validatorName) {
+ if (!rowEntity['$$errors'+colDef.name]) {
+ rowEntity['$$errors'+colDef.name] = {};
+ }
+ rowEntity['$$errors'+colDef.name][validatorName] = true;
+ },
+
+ /**
+ * @ngdoc service
+ * @name clearError
+ * @methodOf ui.grid.validate.service:uiGridValidateService
+ * @description Removes the proper error from the entity errors field
+ * @param {object} rowEntity the row entity of the cell
+ * @param {object} colDef the colDef of the cell
+ * @param {string} validatorName the name of the validator that is failing
+ */
+ clearError: function(rowEntity, colDef, validatorName) {
+ if (!rowEntity['$$errors'+colDef.name]) {
+ return;
+ }
+ if (validatorName in rowEntity['$$errors'+colDef.name]) {
+ delete rowEntity['$$errors'+colDef.name][validatorName];
+ }
+ },
+
+ /**
+ * @ngdoc function
+ * @name getErrorMessages
+ * @methodOf ui.grid.validate.service:uiGridValidateService
+ * @description returns an array of i18n-ed error messages.
+ * @param {object} rowEntity gridOptions.data[] array instance whose errors we are looking for
+ * @param {object} colDef the column whose errors we are looking for
+ * @returns {array} An array of strings containing all the error messages for the cell
+ */
+ getErrorMessages: function(rowEntity, colDef) {
+ var errors = [];
+
+ if (!rowEntity['$$errors'+colDef.name] || Object.keys(rowEntity['$$errors'+colDef.name]).length === 0) {
+ return errors;
+ }
+
+ Object.keys(rowEntity['$$errors'+colDef.name]).sort().forEach(function(validatorName) {
+ errors.push(service.getMessage(validatorName, colDef.validators[validatorName]));
+ });
+
+ return errors;
+ },
+
+ /**
+ * @ngdoc function
+ * @name getFormattedErrors
+ * @methodOf ui.grid.validate.service:uiGridValidateService
+ * @description returns the error i18n-ed and formatted in html to be shown inside the page.
+ * @param {object} rowEntity gridOptions.data[] array instance whose errors we are looking for
+ * @param {object} colDef the column whose errors we are looking for
+ * @returns {object} An object that can be used in a template (like a cellTemplate) to display the
+ * message inside the page (i.e. inside a div)
+ */
+ getFormattedErrors: function(rowEntity, colDef) {
+ var msgString = "",
+ errors = service.getErrorMessages(rowEntity, colDef);
+
+ if (!errors.length) {
+ return;
+ }
+
+ errors.forEach(function(errorMsg) {
+ msgString += errorMsg + " ' + i18nService.getSafeText('validate.error') + ' ' + msgString ); + }, + + /** + * @ngdoc function + * @name getTitleFormattedErrors + * @methodOf ui.grid.validate.service:uiGridValidateService + * @description returns the error i18n-ed and formatted in javaScript to be shown inside an html + * title attribute. + * @param {object} rowEntity gridOptions.data[] array instance whose errors we are looking for + * @param {object} colDef the column whose errors we are looking for + * @returns {object} An object that can be used in a template (like a cellTemplate) to display the + * message inside an html title attribute + */ + getTitleFormattedErrors: function(rowEntity, colDef) { + var newLine = "\n", + msgString = "", + errors = service.getErrorMessages(rowEntity, colDef); + + if (!errors.length) { + return; + } + + errors.forEach(function(errorMsg) { + msgString += errorMsg + newLine; + }); + + return $sce.trustAsHtml(i18nService.getSafeText('validate.error') + newLine + msgString); + }, + + /** + * @ngdoc function + * @name getTitleFormattedErrors + * @methodOf ui.grid.validate.service:uiGridValidateService + * @description Executes all validators on a cell (identified by row entity and column definition) and sets or clears errors + * @param {object} rowEntity the row entity of the cell we want to run the validators on + * @param {object} colDef the column definition of the cell we want to run the validators on + * @param {object} newValue the value the user just entered + * @param {object} oldValue the value the field had before + */ + runValidators: function(rowEntity, colDef, newValue, oldValue, grid) { + if (newValue === oldValue) { + // If the value has not changed we perform no validation + return; + } + + if (typeof(colDef.name) === 'undefined' || !colDef.name) { + throw new Error('colDef.name is required to perform validation'); + } + + service.setValid(rowEntity, colDef); + + var validateClosureFactory = function(rowEntity, colDef, validatorName) { + return function(value) { + if (!value) { + service.setInvalid(rowEntity, colDef); + service.setError(rowEntity, colDef, validatorName); + if (grid) { + grid.api.validate.raise.validationFailed(rowEntity, colDef, newValue, oldValue); + } + } + }; + }; + + var promises = []; + + for (var validatorName in colDef.validators) { + service.clearError(rowEntity, colDef, validatorName); + var validatorFunction = service.getValidator(validatorName, colDef.validators[validatorName]); + + // We pass the arguments as oldValue, newValue so they are in the same order + // as ng-model validators (modelValue, viewValue) + var promise = $q.when(validatorFunction(oldValue, newValue, rowEntity, colDef)) + .then(validateClosureFactory(rowEntity, colDef, validatorName)); + + promises.push(promise); + } + + return $q.all(promises); + }, + + /** + * @ngdoc function + * @name createDefaultValidators + * @methodOf ui.grid.validate.service:uiGridValidateService + * @description adds the basic validators to the list of service validators + */ + createDefaultValidators: function() { + service.setValidator('minLength', function (argument) { + return function (oldValue, newValue) { + if (newValue === undefined || newValue === null || newValue === '') { + return true; + } + return newValue.length >= argument; + }; + }, function(argument) { + return i18nService.getSafeText('validate.minLength').replace('THRESHOLD', argument); + }); + + service.setValidator('maxLength', function (argument) { + return function (oldValue, newValue) { + if (newValue === undefined || newValue === null || newValue === '') { + return true; + } + return newValue.length <= argument; + }; + }, function(threshold) { + return i18nService.getSafeText('validate.maxLength').replace('THRESHOLD', threshold); + }); + + service.setValidator('required', function (argument) { + return function (oldValue, newValue) { + if (argument) { + return !(newValue === undefined || newValue === null || newValue === ''); + } + return true; + }; + }, function() { + return i18nService.getSafeText('validate.required'); + }); + }, + + initializeGrid: function (scope, grid) { + grid.validate = { + + isInvalid: service.isInvalid, + + getErrorMessages: service.getErrorMessages, + + getFormattedErrors: service.getFormattedErrors, + + getTitleFormattedErrors: service.getTitleFormattedErrors, + + runValidators: service.runValidators + }; + + /** + * @ngdoc object + * @name ui.grid.validate.api:PublicApi + * + * @description Public Api for validation feature + */ + var publicApi = { + events: { + validate: { + /** + * @ngdoc event + * @name validationFailed + * @eventOf ui.grid.validate.api:PublicApi + * @description raised when one or more failure happened during validation + *
+ * gridApi.validate.on.validationFailed(scope, function(rowEntity, colDef, newValue, oldValue){...})
+ *
+ * @param {object} rowEntity the options.data element whose validation failed
+ * @param {object} colDef the column whose validation failed
+ * @param {object} newValue new value
+ * @param {object} oldValue old value
+ */
+ validationFailed: function (rowEntity, colDef, newValue, oldValue) {
+ }
+ }
+ },
+ methods: {
+ validate: {
+ /**
+ * @ngdoc function
+ * @name isInvalid
+ * @methodOf ui.grid.validate.api:PublicApi
+ * @description checks if a cell (identified by rowEntity, colDef) is invalid
+ * @param {object} rowEntity gridOptions.data[] array instance we want to check
+ * @param {object} colDef the column whose errors we want to check
+ * @returns {boolean} true if the cell value is not valid
+ */
+ isInvalid: function(rowEntity, colDef) {
+ return grid.validate.isInvalid(rowEntity, colDef);
+ },
+ /**
+ * @ngdoc function
+ * @name getErrorMessages
+ * @methodOf ui.grid.validate.api:PublicApi
+ * @description returns an array of i18n-ed error messages.
+ * @param {object} rowEntity gridOptions.data[] array instance whose errors we are looking for
+ * @param {object} colDef the column whose errors we are looking for
+ * @returns {array} An array of strings containing all the error messages for the cell
+ */
+ getErrorMessages: function (rowEntity, colDef) {
+ return grid.validate.getErrorMessages(rowEntity, colDef);
+ },
+ /**
+ * @ngdoc function
+ * @name getFormattedErrors
+ * @methodOf ui.grid.validate.api:PublicApi
+ * @description returns the error i18n-ed and formatted in html to be shown inside the page.
+ * @param {object} rowEntity gridOptions.data[] array instance whose errors we are looking for
+ * @param {object} colDef the column whose errors we are looking for
+ * @returns {object} An object that can be used in a template (like a cellTemplate) to display the
+ * message inside the page (i.e. inside a div)
+ */
+ getFormattedErrors: function (rowEntity, colDef) {
+ return grid.validate.getFormattedErrors(rowEntity, colDef);
+ },
+ /**
+ * @ngdoc function
+ * @name getTitleFormattedErrors
+ * @methodOf ui.grid.validate.api:PublicApi
+ * @description returns the error i18n-ed and formatted in javaScript to be shown inside an html
+ * title attribute.
+ * @param {object} rowEntity gridOptions.data[] array instance whose errors we are looking for
+ * @param {object} colDef the column whose errors we are looking for
+ * @returns {object} An object that can be used in a template (like a cellTemplate) to display the
+ * message inside an html title attribute
+ */
+ getTitleFormattedErrors: function (rowEntity, colDef) {
+ return grid.validate.getTitleFormattedErrors(rowEntity, colDef);
+ }
+ }
+ }
+ };
+
+ grid.api.registerEventsFromObject(publicApi.events);
+ grid.api.registerMethodsFromObject(publicApi.methods);
+
+ if (grid.edit) {
+ grid.api.edit.on.afterCellEdit(scope, function(rowEntity, colDef, newValue, oldValue) {
+ grid.validate.runValidators(rowEntity, colDef, newValue, oldValue, grid);
+ });
+ }
+
+ service.createDefaultValidators();
+ }
+ };
+
+ return service;
+ }]);
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.validate.directive:uiGridValidate
+ * @element div
+ * @restrict A
+ * @description Adds validating features to the ui-grid directive.
+ * @example
+
+
+
+ {{COL_FIELD CUSTOM_FILTERS}} "
+ );
+
+
+ $templateCache.put('ui-grid/cellTooltipValidator',
+ "{{COL_FIELD CUSTOM_FILTERS}} "
+ );
+
+}]);
diff --git a/release/4.9.2/i18n/ui-grid.validate.min.js b/release/4.9.2/i18n/ui-grid.validate.min.js
new file mode 100644
index 000000000..bd1d6b9e3
--- /dev/null
+++ b/release/4.9.2/i18n/ui-grid.validate.min.js
@@ -0,0 +1,7 @@
+/*!
+ * ui-grid - v4.9.2 - 2020-12-01
+ * Copyright (c) 2020 ; License: MIT
+ */
+
+
+!function(){"use strict";var t=angular.module("ui.grid.validate",["ui.grid"]);t.service("uiGridValidateService",["$sce","$q","$http","i18nService","uiGridConstants",function(i,c,t,n,r){var u={validatorFactories:{},setExternalFactoryFunction:function(t){u.externalFactoryFunction=t},clearExternalFactory:function(){delete u.externalFactoryFunction},getValidatorFromExternalFactory:function(t,r){return u.externalFactoryFunction(t,r).validatorFactory(r)},getMessageFromExternalFactory:function(t,r){return u.externalFactoryFunction(t,r).messageFunction(r)},setValidator:function(t,r,e){u.validatorFactories[t]={validatorFactory:r,messageFunction:e}},getValidator:function(t,r){if(u.externalFactoryFunction){var e=u.getValidatorFromExternalFactory(t,r);if(e)return e}if(!u.validatorFactories[t])throw"Invalid validator name: "+t;return u.validatorFactories[t].validatorFactory(r)},getMessage:function(t,r){if(u.externalFactoryFunction){var e=u.getMessageFromExternalFactory(t,r);if(e)return e}return u.validatorFactories[t].messageFunction(r)},isInvalid:function(t,r){return t["$$invalid"+r.name]},setInvalid:function(t,r){t["$$invalid"+r.name]=!0},setValid:function(t,r){delete t["$$invalid"+r.name]},setError:function(t,r,e){t["$$errors"+r.name]||(t["$$errors"+r.name]={}),t["$$errors"+r.name][e]=!0},clearError:function(t,r,e){t["$$errors"+r.name]&&e in t["$$errors"+r.name]&&delete t["$$errors"+r.name][e]},getErrorMessages:function(t,r){var e=[];return t["$$errors"+r.name]&&0!==Object.keys(t["$$errors"+r.name]).length&&Object.keys(t["$$errors"+r.name]).sort().forEach(function(t){e.push(u.getMessage(t,r.validators[t]))}),e},getFormattedErrors:function(t,r){var e="",a=u.getErrorMessages(t,r);if(a.length)return a.forEach(function(t){e+=t+""}),i.trustAsHtml(" "+n.getSafeText("validate.error")+" "+e)},getTitleFormattedErrors:function(t,r){var e="",a=u.getErrorMessages(t,r);if(a.length)return a.forEach(function(t){e+=t+"\n"}),i.trustAsHtml(n.getSafeText("validate.error")+"\n"+e)},runValidators:function(t,r,i,n,o){if(i!==n){if(void 0===r.name||!r.name)throw new Error("colDef.name is required to perform validation");u.setValid(t,r);var e=function(r,e,a){return function(t){t||(u.setInvalid(r,e),u.setError(r,e,a),o&&o.api.validate.raise.validationFailed(r,e,i,n))}},a=[];for(var l in r.validators){u.clearError(t,r,l);var d=u.getValidator(l,r.validators[l]),s=c.when(d(n,i,t,r)).then(e(t,r,l));a.push(s)}return c.all(a)}},createDefaultValidators:function(){u.setValidator("minLength",function(e){return function(t,r){return null==r||""===r||r.length>=e}},function(t){return n.getSafeText("validate.minLength").replace("THRESHOLD",t)}),u.setValidator("maxLength",function(e){return function(t,r){return null==r||""===r||r.length<=e}},function(t){return n.getSafeText("validate.maxLength").replace("THRESHOLD",t)}),u.setValidator("required",function(e){return function(t,r){return!e||!(null==r||""===r)}},function(){return n.getSafeText("validate.required")})},initializeGrid:function(t,i){i.validate={isInvalid:u.isInvalid,getErrorMessages:u.getErrorMessages,getFormattedErrors:u.getFormattedErrors,getTitleFormattedErrors:u.getTitleFormattedErrors,runValidators:u.runValidators};var r={events:{validate:{validationFailed:function(t,r,e,a){}}},methods:{validate:{isInvalid:function(t,r){return i.validate.isInvalid(t,r)},getErrorMessages:function(t,r){return i.validate.getErrorMessages(t,r)},getFormattedErrors:function(t,r){return i.validate.getFormattedErrors(t,r)},getTitleFormattedErrors:function(t,r){return i.validate.getTitleFormattedErrors(t,r)}}}};i.api.registerEventsFromObject(r.events),i.api.registerMethodsFromObject(r.methods),i.edit&&i.api.edit.on.afterCellEdit(t,function(t,r,e,a){i.validate.runValidators(t,r,e,a,i)}),u.createDefaultValidators()}};return u}]),t.directive("uiGridValidate",["gridUtil","uiGridValidateService",function(t,i){return{priority:0,replace:!0,require:"^uiGrid",scope:!1,compile:function(){return{pre:function(t,r,e,a){i.initializeGrid(t,a.grid)},post:function(t,r,e,a){}}}}}])}(),angular.module("ui.grid.validate").run(["$templateCache",function(t){"use strict";t.put("ui-grid/cellTitleValidator",'{{COL_FIELD CUSTOM_FILTERS}} '),t.put("ui-grid/cellTooltipValidator",'{{COL_FIELD CUSTOM_FILTERS}} ')}]);
\ No newline at end of file
diff --git a/release/4.9.2/less/animation.less b/release/4.9.2/less/animation.less
new file mode 100644
index 000000000..cd78e6d21
--- /dev/null
+++ b/release/4.9.2/less/animation.less
@@ -0,0 +1,85 @@
+/*
+ Animation example, for spinners
+*/
+.ui-grid-animate-spin {
+ -moz-animation: ui-grid-spin 2s infinite linear;
+ -o-animation: ui-grid-spin 2s infinite linear;
+ -webkit-animation: ui-grid-spin 2s infinite linear;
+ animation: ui-grid-spin 2s infinite linear;
+ display: inline-block;
+}
+@-moz-keyframes ui-grid-spin {
+ 0% {
+ -moz-transform: rotate(0deg);
+ -o-transform: rotate(0deg);
+ -webkit-transform: rotate(0deg);
+ transform: rotate(0deg);
+ }
+
+ 100% {
+ -moz-transform: rotate(359deg);
+ -o-transform: rotate(359deg);
+ -webkit-transform: rotate(359deg);
+ transform: rotate(359deg);
+ }
+}
+@-webkit-keyframes ui-grid-spin {
+ 0% {
+ -moz-transform: rotate(0deg);
+ -o-transform: rotate(0deg);
+ -webkit-transform: rotate(0deg);
+ transform: rotate(0deg);
+ }
+
+ 100% {
+ -moz-transform: rotate(359deg);
+ -o-transform: rotate(359deg);
+ -webkit-transform: rotate(359deg);
+ transform: rotate(359deg);
+ }
+}
+@-o-keyframes ui-grid-spin {
+ 0% {
+ -moz-transform: rotate(0deg);
+ -o-transform: rotate(0deg);
+ -webkit-transform: rotate(0deg);
+ transform: rotate(0deg);
+ }
+
+ 100% {
+ -moz-transform: rotate(359deg);
+ -o-transform: rotate(359deg);
+ -webkit-transform: rotate(359deg);
+ transform: rotate(359deg);
+ }
+}
+@-ms-keyframes ui-grid-spin {
+ 0% {
+ -moz-transform: rotate(0deg);
+ -o-transform: rotate(0deg);
+ -webkit-transform: rotate(0deg);
+ transform: rotate(0deg);
+ }
+
+ 100% {
+ -moz-transform: rotate(359deg);
+ -o-transform: rotate(359deg);
+ -webkit-transform: rotate(359deg);
+ transform: rotate(359deg);
+ }
+}
+@keyframes ui-grid-spin {
+ 0% {
+ -moz-transform: rotate(0deg);
+ -o-transform: rotate(0deg);
+ -webkit-transform: rotate(0deg);
+ transform: rotate(0deg);
+ }
+
+ 100% {
+ -moz-transform: rotate(359deg);
+ -o-transform: rotate(359deg);
+ -webkit-transform: rotate(359deg);
+ transform: rotate(359deg);
+ }
+}
diff --git a/release/4.9.2/less/body.less b/release/4.9.2/less/body.less
new file mode 100644
index 000000000..b044267fb
--- /dev/null
+++ b/release/4.9.2/less/body.less
@@ -0,0 +1,83 @@
+@import (reference) 'variables.less';
+@import (reference) 'elements.less';
+@import (reference) 'header.less';
+
+.ui-grid-render-container {
+ position: inherit;
+
+ .border-radius(0, @gridBorderRadius, @gridBorderRadius, 0);
+
+ // Prevent an outline from showing if we focus the render container element
+ &:focus {
+ outline: none;
+ }
+}
+
+.ui-grid-viewport {
+ min-height: 20px;
+ position: relative;
+ overflow-y: scroll;
+ -webkit-overflow-scrolling: touch;
+
+ &:focus {
+ outline: none !important;
+ }
+}
+
+.ui-grid-canvas {
+ position: relative;
+ padding-top: 1px; // to prevent canvas from absorbing the 1st rendered row's margin
+}
+
+.ui-grid-row {
+ clear: both; // prevent columns mixing after expand
+
+ &:nth-child(odd) .ui-grid-cell {
+ background-color: @rowColorOdd; // rgb(253, 253, 253);
+ }
+
+ &:nth-child(even) .ui-grid-cell {
+ background-color: @rowColorEven;
+ }
+
+ &:last-child .ui-grid-cell {
+ border-bottom-color: @borderColor;
+ border-bottom-style: solid;
+ }
+
+ &:hover > [ui-grid-row] > .ui-grid-cell,
+ &:nth-child(odd),
+ &:nth-child(even){
+ &:hover .ui-grid-cell {
+ background-color: @rowColorHovered;
+ }
+ }
+}
+
+.ui-grid-no-row-overlay {
+ position: absolute;
+ top: 0;
+ bottom: 0;
+ left: 0;
+ right: 0;
+ margin: 10%;
+
+ .ui-grid-top-panel-background;
+ .border-radius(@gridBorderRadius);
+ border: @gridBorderWidth solid @borderColor;
+
+ font-size: 2em;
+ text-align: center;
+
+ > * {
+ position: absolute;
+ display: table;
+ margin: auto 0;
+ width: 100%;
+ top: 0;
+ bottom: 0;
+ left: 0;
+ right: 0;
+ opacity: 0.66;
+ }
+}
diff --git a/release/4.9.2/less/cell.less b/release/4.9.2/less/cell.less
new file mode 100644
index 000000000..3ca5c4894
--- /dev/null
+++ b/release/4.9.2/less/cell.less
@@ -0,0 +1,46 @@
+@import 'variables';
+
+.ui-grid-cell {
+ overflow: hidden;
+ float: left;
+ background-color: inherit;
+ border-right: @gridBorderWidth solid;
+ border-color: @borderColor;
+ box-sizing: border-box;
+
+ &:last-child {
+ border-right: 0;
+ }
+}
+
+.ui-grid-cell-contents {
+ padding: 5px;
+ -moz-box-sizing: border-box;
+ -webkit-box-sizing: border-box;
+ box-sizing: border-box;
+ white-space: nowrap;
+ -ms-text-overflow: ellipsis;
+ -o-text-overflow: ellipsis;
+ text-overflow: ellipsis;
+ overflow: hidden;
+ height: 100%;
+}
+
+.ui-grid-cell-contents-hidden {
+ visibility: hidden;
+ width: 0;
+ height:0;
+ display: none;
+}
+
+.ui-grid-row .ui-grid-cell.ui-grid-row-header-cell {
+ background-color: @rowHeaderCell;
+ border-bottom: solid @gridBorderWidth @borderColor;
+}
+
+.ui-grid-cell-empty {
+ display: inline-block;
+ width: 10px;
+ height: 10px;
+}
+
diff --git a/release/4.9.2/less/cellNav.less b/release/4.9.2/less/cellNav.less
new file mode 100644
index 000000000..87c5601c4
--- /dev/null
+++ b/release/4.9.2/less/cellNav.less
@@ -0,0 +1,29 @@
+@import (reference) './variables';
+
+.ui-grid-cell-focus {
+ outline: 0;
+ background-color: @focusedCell;
+}
+
+.ui-grid-focuser {
+ position: absolute;
+ left: 0;
+ top: 0;
+ z-index: -1;
+ width:100%;
+ height:100%;
+ &:focus {
+ border-color: #66afe9;
+ outline: 0;
+ -webkit-box-shadow: inset 0 1px 1px rgba(0,0,0,.075), 0 0 8px rgba(102, 175, 233, 0.6);
+ box-shadow: inset 0 1px 1px rgba(0,0,0,.075), 0 0 8px rgba(102, 175, 233, 0.6);
+ }
+}
+
+.ui-grid-offscreen{
+ display: block;
+ position: absolute;
+ left: -10000px;
+ top: -10000px;
+ clip:rect(0px,0px,0px,0px);
+}
diff --git a/release/4.9.2/less/colMovable.less b/release/4.9.2/less/colMovable.less
new file mode 100644
index 000000000..511293d5b
--- /dev/null
+++ b/release/4.9.2/less/colMovable.less
@@ -0,0 +1,12 @@
+@import (reference) './variables';
+
+.movingColumn {
+ position: absolute;
+ top: 0;
+ border: 1px solid @borderColor;
+ box-shadow: inset 0 0 14px rgba(0, 0, 0, 0.2);
+
+ .ui-grid-icon-angle-down {
+ display: none;
+ }
+}
diff --git a/release/4.9.2/less/column-resizer.less b/release/4.9.2/less/column-resizer.less
new file mode 100644
index 000000000..8c3934679
--- /dev/null
+++ b/release/4.9.2/less/column-resizer.less
@@ -0,0 +1,53 @@
+@import (reference) './variables';
+
+.ui-grid-column-resizer {
+ top: 0;
+ bottom: 0;
+ width: 5px;
+ position: absolute;
+ cursor: col-resize;
+
+ &.left {
+ left: 0;
+ }
+
+ &.right {
+ right: 0;
+ }
+}
+
+// Add a visual border for final column's resizer element
+.ui-grid-header-cell:last-child .ui-grid-column-resizer.right {
+ border-right: @gridBorderWidth solid @borderColor;
+}
+
+// Put visual border on left of last header cell when direction is rtl
+.ui-grid[dir=rtl] .ui-grid-header-cell:last-child {
+ .ui-grid-column-resizer.right {
+ border-right: 0;
+ }
+
+ .ui-grid-column-resizer.left {
+ border-left: @gridBorderWidth solid @borderColor;
+ }
+}
+
+.ui-grid {
+ &.column-resizing {
+ cursor: col-resize;
+ -webkit-touch-callout: none;
+ -webkit-user-select: none;
+ -khtml-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+ }
+}
+
+.ui-grid.column-resizing .ui-grid-resize-overlay {
+ position: absolute;
+ top: 0;
+ height: 100%;
+ width: @gridBorderWidth;
+ background-color: darken(@verticalBarColor, 15%);
+}
\ No newline at end of file
diff --git a/release/4.9.2/less/core.less b/release/4.9.2/less/core.less
new file mode 100644
index 000000000..c4f22d421
--- /dev/null
+++ b/release/4.9.2/less/core.less
@@ -0,0 +1,11 @@
+@import (reference) 'elements';
+@import 'grid';
+@import 'header';
+@import 'body';
+@import 'cell';
+@import 'footer';
+@import 'menu';
+@import 'sorting';
+@import 'icons';
+@import 'rtl';
+@import 'animation';
\ No newline at end of file
diff --git a/release/4.9.2/less/edit.less b/release/4.9.2/less/edit.less
new file mode 100644
index 000000000..4ba9fe470
--- /dev/null
+++ b/release/4.9.2/less/edit.less
@@ -0,0 +1,27 @@
+@import (reference) './variables';
+
+.ui-grid-cell {
+ input {
+ border-radius: inherit;
+ padding: 0;
+ width: 100%;
+ color: inherit;
+ height: auto;
+ font: inherit;
+ outline: none;
+ }
+ input:focus {
+ color: inherit;
+ outline: none;
+ }
+ input[type="checkbox"] {
+ margin: 9px 0 0 6px;
+ width: auto;
+ }
+ input.ng-invalid {
+ border: @invalidValueBorder;
+ }
+ input.ng-valid {
+ border: @validValueBorder;
+ }
+}
\ No newline at end of file
diff --git a/release/4.9.2/less/elements.less b/release/4.9.2/less/elements.less
new file mode 100644
index 000000000..f5c032209
--- /dev/null
+++ b/release/4.9.2/less/elements.less
@@ -0,0 +1,156 @@
+/*---------------------------------------------------
+ LESS Elements 0.9
+ ---------------------------------------------------
+ A set of useful LESS mixins
+ More info at: http://lesselements.com
+ ---------------------------------------------------*/
+
+.gradient(@color: #F5F5F5, @start: #EEE, @stop: #FFF) {
+ background: @color;
+ background: -webkit-gradient(linear,
+ left bottom,
+ left top,
+ color-stop(0, @start),
+ color-stop(1, @stop));
+ background: -ms-linear-gradient(bottom,
+ @start,
+ @stop);
+ background: -moz-linear-gradient(center bottom,
+ @start 0%,
+ @stop 100%);
+ background: -o-linear-gradient(@stop,
+ @start);
+ filter: e(%("progid:DXImageTransform.Microsoft.gradient(startColorstr='%d', endColorstr='%d', GradientType=0)",@stop,@start));
+}
+.bw-gradient(@color: #F5F5F5, @start: 0, @stop: 255) {
+ background: @color;
+ background: -webkit-gradient(linear,
+ left bottom,
+ left top,
+ color-stop(0, rgb(@start,@start,@start)),
+ color-stop(1, rgb(@stop,@stop,@stop)));
+ background: -ms-linear-gradient(bottom,
+ rgb(@start,@start,@start) 0%,
+ rgb(@stop,@stop,@stop) 100%);
+ background: -moz-linear-gradient(center bottom,
+ rgb(@start,@start,@start) 0%,
+ rgb(@stop,@stop,@stop) 100%);
+ background: -o-linear-gradient(rgb(@stop,@stop,@stop),
+ rgb(@start,@start,@start));
+ filter: e(%("progid:DXImageTransform.Microsoft.gradient(startColorstr='%d', endColorstr='%d', GradientType=0)",rgb(@stop,@stop,@stop),rgb(@start,@start,@start)));
+}
+.bordered(@top-color: #EEE, @right-color: #EEE, @bottom-color: #EEE, @left-color: #EEE) {
+ border-top: solid 1px @top-color;
+ border-left: solid 1px @left-color;
+ border-right: solid 1px @right-color;
+ border-bottom: solid 1px @bottom-color;
+}
+.drop-shadow(@x-axis: 0, @y-axis: 1px, @blur: 2px, @alpha: 0.1) {
+ -webkit-box-shadow: @x-axis @y-axis @blur rgba(0, 0, 0, @alpha);
+ -moz-box-shadow: @x-axis @y-axis @blur rgba(0, 0, 0, @alpha);
+ box-shadow: @x-axis @y-axis @blur rgba(0, 0, 0, @alpha);
+}
+.rounded(@radius: 2px) {
+ -webkit-border-radius: @radius;
+ -moz-border-radius: @radius;
+ border-radius: @radius;
+}
+.border-radius(@topright: 0, @bottomright: 0, @bottomleft: 0, @topleft: 0) {
+ -webkit-border-top-right-radius: @topright;
+ -webkit-border-bottom-right-radius: @bottomright;
+ -webkit-border-bottom-left-radius: @bottomleft;
+ -webkit-border-top-left-radius: @topleft;
+ -moz-border-radius-topright: @topright;
+ -moz-border-radius-bottomright: @bottomright;
+ -moz-border-radius-bottomleft: @bottomleft;
+ -moz-border-radius-topleft: @topleft;
+ border-top-right-radius: @topright;
+ border-bottom-right-radius: @bottomright;
+ border-bottom-left-radius: @bottomleft;
+ border-top-left-radius: @topleft;
+ .background-clip(padding-box);
+}
+.opacity(@opacity: 0.5) {
+ -moz-opacity: @opacity;
+ -khtml-opacity: @opacity;
+ -webkit-opacity: @opacity;
+ opacity: @opacity;
+ @opperc: @opacity * 100;
+ -ms-filter: ~"progid:DXImageTransform.Microsoft.Alpha(opacity=@{opperc})";
+ filter: ~"alpha(opacity=@{opperc})";
+}
+.transition-duration(@duration: 0.2s) {
+ -moz-transition-duration: @duration;
+ -webkit-transition-duration: @duration;
+ -o-transition-duration: @duration;
+ transition-duration: @duration;
+}
+.transform(...) {
+ -webkit-transform: @arguments;
+ -moz-transform: @arguments;
+ -o-transform: @arguments;
+ -ms-transform: @arguments;
+ transform: @arguments;
+}
+.rotation(@deg:5deg){
+ .transform(rotate(@deg));
+}
+.scale(@ratio:1.5){
+ .transform(scale(@ratio));
+}
+.transition(@type:all, @duration:0.2s, @ease:ease-out) {
+ -webkit-transition: @type @duration @ease;
+ -moz-transition: @type @duration @ease;
+ -o-transition: @type @duration @ease;
+ transition: @type @duration @ease;
+}
+.inner-shadow(@horizontal:0, @vertical:1px, @blur:2px, @alpha: 0.4) {
+ -webkit-box-shadow: inset @horizontal @vertical @blur rgba(0, 0, 0, @alpha);
+ -moz-box-shadow: inset @horizontal @vertical @blur rgba(0, 0, 0, @alpha);
+ box-shadow: inset @horizontal @vertical @blur rgba(0, 0, 0, @alpha);
+}
+.box-shadow(@arguments) {
+ -webkit-box-shadow: @arguments;
+ -moz-box-shadow: @arguments;
+ box-shadow: @arguments;
+}
+.box-sizing(@sizing: border-box) {
+ -ms-box-sizing: @sizing;
+ -moz-box-sizing: @sizing;
+ -webkit-box-sizing: @sizing;
+ box-sizing: @sizing;
+}
+.user-select(@argument: none) {
+ -webkit-user-select: @argument;
+ -moz-user-select: @argument;
+ -ms-user-select: @argument;
+ user-select: @argument;
+}
+.columns(@colwidth: 250px, @colcount: 0, @colgap: 50px, @columnRuleColor: #EEE, @columnRuleStyle: solid, @columnRuleWidth: 1px) {
+ -moz-column-width: @colwidth;
+ -moz-column-count: @colcount;
+ -moz-column-gap: @colgap;
+ -moz-column-rule-color: @columnRuleColor;
+ -moz-column-rule-style: @columnRuleStyle;
+ -moz-column-rule-width: @columnRuleWidth;
+ -webkit-column-width: @colwidth;
+ -webkit-column-count: @colcount;
+ -webkit-column-gap: @colgap;
+ -webkit-column-rule-color: @columnRuleColor;
+ -webkit-column-rule-style: @columnRuleStyle;
+ -webkit-column-rule-width: @columnRuleWidth;
+ column-width: @colwidth;
+ column-count: @colcount;
+ column-gap: @colgap;
+ column-rule-color: @columnRuleColor;
+ column-rule-style: @columnRuleStyle;
+ column-rule-width: @columnRuleWidth;
+}
+.translate(@x:0, @y:0) {
+ .transform(translate(@x, @y));
+}
+.background-clip(@argument: padding-box) {
+ -moz-background-clip: @argument;
+ -webkit-background-clip: @argument;
+ background-clip: @argument;
+}
\ No newline at end of file
diff --git a/release/4.9.2/less/emptyBaseLayer.less b/release/4.9.2/less/emptyBaseLayer.less
new file mode 100644
index 000000000..8f5bc0609
--- /dev/null
+++ b/release/4.9.2/less/emptyBaseLayer.less
@@ -0,0 +1,8 @@
+@import (reference) './variables';
+
+.ui-grid-viewport .ui-grid-empty-base-layer-container {
+ position: absolute;
+ overflow: hidden;
+ pointer-events: none;
+ z-index: -1;
+}
diff --git a/release/4.9.2/less/expandable.less b/release/4.9.2/less/expandable.less
new file mode 100644
index 000000000..f48814fa0
--- /dev/null
+++ b/release/4.9.2/less/expandable.less
@@ -0,0 +1,29 @@
+@import (reference) './variables';
+
+.expandableRow {
+ .ui-grid-row {
+
+ &:nth-child(odd) .ui-grid-cell {
+ background-color: @rowColorOdd;
+ }
+
+ &:nth-child(even) .ui-grid-cell {
+ background-color: @rowColorEven;
+ }
+
+ }
+}
+
+
+.ui-grid-cell.ui-grid-disable-selection.ui-grid-row-header-cell{
+ pointer-events: none;
+}
+.ui-grid-expandable-buttons-cell i{
+ pointer-events: all;
+}
+
+.scrollFiller {
+ float:left;
+ border:1px solid @borderColor;
+}
+
diff --git a/release/4.9.2/less/exporter.less b/release/4.9.2/less/exporter.less
new file mode 100644
index 000000000..1d01f04ff
--- /dev/null
+++ b/release/4.9.2/less/exporter.less
@@ -0,0 +1,4 @@
+@import (reference) './variables';
+
+.ui-grid-exporter-header {
+}
diff --git a/release/4.9.2/less/footer.less b/release/4.9.2/less/footer.less
new file mode 100644
index 000000000..7521819ae
--- /dev/null
+++ b/release/4.9.2/less/footer.less
@@ -0,0 +1,76 @@
+@import (reference) 'variables.less';
+@import (reference) 'elements.less';
+
+.ui-grid-footer-info {
+ padding: 5px 10px;
+}
+
+.ui-grid-footer-panel-background {
+ background-color: @headerBackgroundColor;
+}
+
+@topPanelRadius: @gridBorderRadius - @gridBorderWidth;
+.ui-grid-footer-panel {
+ position: relative;
+ border-bottom: 1px solid @borderColor; // #D4D4D4
+ border-top: 1px solid @borderColor;
+ overflow: hidden; // Disable so menus show up
+ font-weight: bold;
+
+ .ui-grid-footer-panel-background;
+
+ .border-radius(@topPanelRadius, 0, 0, @topPanelRadius);
+}
+
+.ui-grid-grid-footer {
+ float: left;
+ width: 100%;
+}
+
+.ui-grid-footer-viewport,
+.ui-grid-footer-canvas {
+ height: 100%;
+}
+
+.ui-grid-footer-viewport {
+ overflow: hidden; // Disable so menus show up
+}
+
+.ui-grid-footer-canvas {
+ position: relative;
+
+ // Clearfix for floating header cells
+ &:before, &:after {
+ content: "";
+ display: table;
+ line-height: 0;
+ }
+
+ &:after {
+ clear:both;
+ }
+}
+
+.ui-grid-footer-cell-wrapper {
+ position: relative;
+ display: table;
+ box-sizing: border-box;
+ height: 100%;
+}
+
+.ui-grid-footer-cell-row {
+ display: table-row;
+}
+
+.ui-grid-footer-cell {
+ overflow: hidden;
+ background-color: inherit;
+ border-right: @gridBorderWidth solid;
+ border-color: @borderColor;
+ box-sizing: border-box;
+ display: table-cell;
+
+ &:last-child {
+ border-right: 0;
+ }
+}
diff --git a/release/4.9.2/less/grid.less b/release/4.9.2/less/grid.less
new file mode 100644
index 000000000..2f8a53da0
--- /dev/null
+++ b/release/4.9.2/less/grid.less
@@ -0,0 +1,86 @@
+@import (reference) 'variables.less';
+@import (reference) 'elements.less';
+
+.ui-grid {
+ border: @gridBorderWidth solid @borderColor;
+ box-sizing: content-box; // If bootstrap (or another included library) makes the default sizing on element "border-box", then calculations get messed up
+
+ .rounded(@gridBorderRadius);
+
+ .transform(translateZ(0));
+}
+
+.ui-grid-vertical-bar {
+ position: absolute;
+ right: 0;
+ width: 0;
+}
+
+.ui-grid-header-cell:not(:last-child) .ui-grid-vertical-bar, .ui-grid-cell:not(:last-child) .ui-grid-vertical-bar {
+ width: @gridBorderWidth;
+}
+
+.ui-grid-scrollbar-placeholder{
+ background-color: transparent;
+}
+
+.ui-grid-header-cell:not(:last-child) .ui-grid-vertical-bar {
+ background-color: @headerVerticalBarColor;
+}
+
+.ui-grid-cell:not(:last-child) .ui-grid-vertical-bar {
+ background-color: @verticalBarColor;
+}
+
+.ui-grid-header-cell:last-child .ui-grid-vertical-bar {
+ right: -1px; // TODO(c0bra): Should this be grid width? Test column resizing with custom grid border width
+ width: @gridBorderWidth;
+ background-color: @headerVerticalBarColor;
+}
+
+.ui-grid-clearfix {
+ &:before, &:after {
+ content: "";
+ display: table;
+ }
+
+ &:after {
+ clear:both;
+ }
+}
+
+.ui-grid-invisible {
+ visibility: hidden;
+}
+
+// Wraps the contents inside the grid directive with a relatively-positioned element so that all absolute elements are positioned relative to the grid, and not the page
+.ui-grid-contents-wrapper {
+ position: relative;
+ height: 100%;
+ width: 100%;
+}
+
+// Only display content to screen readers
+//
+// See: http://a11yproject.com/posts/how-to-hide-content/
+
+.ui-grid-sr-only {
+ position: absolute;
+ width: 1px;
+ height: 1px;
+ margin: -1px;
+ padding: 0;
+ overflow: hidden;
+ clip: rect(0,0,0,0);
+ border: 0;
+}
+
+.ui-grid-icon-button {
+ background-color: transparent;
+ border: none;
+ padding: 0;
+}
+
+.clickable {
+ cursor: pointer;
+}
diff --git a/release/4.9.2/less/grouping.less b/release/4.9.2/less/grouping.less
new file mode 100644
index 000000000..49b0273d5
--- /dev/null
+++ b/release/4.9.2/less/grouping.less
@@ -0,0 +1,5 @@
+@import (reference) './variables';
+
+.ui-grid-tree-header-row {
+ font-weight: bold !important;
+}
diff --git a/release/4.9.2/less/header.less b/release/4.9.2/less/header.less
new file mode 100644
index 000000000..a6894133e
--- /dev/null
+++ b/release/4.9.2/less/header.less
@@ -0,0 +1,250 @@
+@import (reference) 'variables.less';
+@import (reference) 'elements.less';
+
+.ui-grid-top-panel-background {
+ background-color: @headerBackgroundColor;
+}
+
+@topPanelRadius: @gridBorderRadius - @gridBorderWidth;
+
+.ui-grid-header {
+ border-bottom: 1px solid @borderColor;
+ box-sizing: border-box;
+}
+
+.ui-grid-top-panel {
+ position: relative;
+
+ overflow: hidden; // Disable so menus show up
+ font-weight: bold;
+
+ .ui-grid-top-panel-background;
+
+ .border-radius(@topPanelRadius, 0, 0, @topPanelRadius);
+}
+
+
+.ui-grid-header-viewport {
+ overflow: hidden; // Disable so menus show up
+}
+
+.ui-grid-header-canvas {
+ // Clearfix for floating header cells
+ &:before, &:after {
+ content: "";
+ display: -ms-flexbox;
+ display: flex;
+ line-height: 0;
+ }
+
+ &:after {
+ clear:both;
+ }
+}
+
+
+.ui-grid-header-cell-wrapper {
+ position: relative;
+ display: -ms-flexbox;
+ display: flex;
+ box-sizing: border-box;
+ height: 100%;
+ width: 100%;
+}
+
+.ui-grid-header-cell-row {
+ display: -ms-flexbox;
+ display: flex;
+ -ms-flex-direction: row;
+ flex-direction: row;
+ -ms-flex-wrap: wrap;
+ flex-wrap: wrap;
+}
+
+.ui-grid-header-cell {
+ position: relative;
+ box-sizing: border-box;
+ background-color: inherit;
+ border-right: @gridBorderWidth solid;
+ border-color: @headerVerticalBarColor;
+
+ &:last-child {
+ border-right: 0;
+ }
+
+ .user-select(none);
+
+ // Default to width 0 so header height can calculate right. Otherwise
+ // the header cells will flow onto the next line of the header container
+ // and cause the header height to be calculated as twice the height
+ // it should be. The column widths are calculated dynamically
+ width: 0;
+
+ .sortable {
+ cursor: pointer;
+ }
+
+ // Moves the sort priority number closer to the icon
+ .ui-grid-sort-priority-number {
+ margin-left: -8px;
+ }
+}
+/* Fixes IE word-wrap if needed on header cells */
+.ui-grid-header-cell > div {
+ -ms-flex-basis: 100%;
+ flex-basis: 100%;
+}
+
+// Make vertical bar in header row fill the height of the cell completely
+.ui-grid-header .ui-grid-vertical-bar {
+ top: 0;
+ bottom: 0;
+}
+
+.ui-grid-column-menu-button {
+ position: absolute;
+ right: @gridBorderWidth; // So it doesn't overlay the vertical bar
+ top: 0;
+
+ .ui-grid-icon-angle-down {
+ vertical-align: sub;
+ }
+}
+
+.ui-grid-header-cell-last-col {
+ .ui-grid-cell-contents,
+ .ui-grid-filter-container,
+ .ui-grid-column-menu-button,
+ & + .ui-grid-column-resizer.right {
+ margin-right: 13px;
+ }
+}
+
+.ui-grid-render-container-right {
+ .ui-grid-header-cell-last-col {
+ .ui-grid-cell-contents,
+ .ui-grid-filter-container,
+ .ui-grid-column-menu-button,
+ & + .ui-grid-column-resizer.right {
+ margin-right: 28px;
+ }
+ }
+}
+
+.ui-grid-column-menu {
+ position: absolute;
+}
+
+/* Slide up/down animations */
+.ui-grid-column-menu .ui-grid-menu .ui-grid-menu-mid {
+ &.ng-hide-add, &.ng-hide-remove {
+ .transition(all, 0.04s, linear);
+ display: block !important;
+ }
+
+ &.ng-hide-add.ng-hide-add-active,
+ &.ng-hide-remove {
+ .transform(translateY(-100%));
+ }
+
+ &.ng-hide-add,
+ &.ng-hide-remove.ng-hide-remove-active {
+ .transform(translateY(0));
+ }
+}
+
+/* Slide up/down animations */
+.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid {
+ &.ng-hide-add, &.ng-hide-remove {
+ .transition(all, 0.04s, linear);
+ display: block !important;
+ }
+
+ &.ng-hide-add.ng-hide-add-active,
+ &.ng-hide-remove {
+ .transform(translateY(-100%));
+ }
+
+ &.ng-hide-add,
+ &.ng-hide-remove.ng-hide-remove-active {
+ .transform(translateY(0));
+ }
+}
+
+
+.ui-grid-filter-container {
+ padding: 4px 10px;
+ position: relative;
+
+ .ui-grid-filter-button {
+ position: absolute;
+ top: 0;
+ bottom: 0;
+ right: 0;
+
+ [class^="ui-grid-icon"] {
+ position: absolute;
+ top: 50%;
+ line-height: 32px;
+ margin-top: -16px;
+ right: 10px;
+ opacity: 0.66;
+
+ &:hover {
+ opacity: 1;
+ }
+ }
+ }
+
+ .ui-grid-filter-button-select {
+ position: absolute;
+ top: 0;
+ bottom: 0;
+ right: 0;
+
+ [class^="ui-grid-icon"] {
+ position: absolute;
+ top: 50%;
+ line-height: 32px;
+ margin-top: -16px;
+ right: 0px;
+ opacity: 0.66;
+
+ &:hover {
+ opacity: 1;
+ }
+ }
+ }
+}
+
+input[type="text"].ui-grid-filter-input {
+ box-sizing: border-box;
+ padding: 0 18px 0 0;
+ margin: 0;
+ width: 100%;
+
+ border: @gridBorderWidth solid @borderColor;
+ .border-radius(@gridBorderRadius);
+
+ &:hover {
+ border: @gridBorderWidth solid @borderColor;
+ }
+}
+
+select.ui-grid-filter-select {
+ padding: 0;
+ margin: 0;
+ border: 0;
+ width: 90%;
+
+ border: @gridBorderWidth solid @borderColor;
+ .border-radius(@gridBorderRadius);
+
+ &:hover {
+ border: @gridBorderWidth solid @borderColor;
+ }
+
+ .ui-grid-filter-cancel-button-hidden & {
+ width: 100%;
+ }
+}
diff --git a/release/4.9.2/less/icons.less b/release/4.9.2/less/icons.less
new file mode 100644
index 000000000..88b1d129f
--- /dev/null
+++ b/release/4.9.2/less/icons.less
@@ -0,0 +1,151 @@
+@import (reference) 'variables.less';
+
+@font-face {
+ font-family: 'ui-grid';
+ src: url('@{font-path}ui-grid.eot');
+ src: url('@{font-path}ui-grid.eot#iefix') format('embedded-opentype'),
+ url('@{font-path}ui-grid.woff') format('woff'),
+ url('@{font-path}ui-grid.ttf') format('truetype'),
+ url('@{font-path}ui-grid.svg?#ui-grid') format('svg');
+ font-weight: normal;
+ font-style: normal;
+}
+
+/* Chrome hack: SVG is rendered more smooth in Windozze. 100% magic, uncomment if you need it. */
+/* Note, that will break hinting! In other OS-es font will be not as sharp as it could be */
+/*
+@media screen and (-webkit-min-device-pixel-ratio:0) {
+ @font-face {
+ font-family: 'ui-grid';
+ src: url('@{font-path}ui-grid.svg?12312827#ui-grid') format('svg');
+ }
+}
+*/
+
+[class^="ui-grid-icon"]:before, [class*=" ui-grid-icon"]:before {
+ font-family: "ui-grid";
+ font-style: normal;
+ font-weight: normal;
+ speak: none;
+
+ display: inline-block;
+ text-decoration: inherit;
+ width: 1em;
+ margin-right: .2em;
+ text-align: center;
+ /* opacity: .8; */
+
+ /* For safety - reset parent styles, that can break glyph codes*/
+ font-variant: normal;
+ text-transform: none;
+
+ /* fix buttons height, for twitter bootstrap */
+ line-height: 1em;
+
+ /* Animation center compensation - margins should be symmetric */
+ /* remove if not needed */
+ margin-left: .2em;
+
+ /* you can be more comfortable with increased icons size */
+ /* font-size: 120%; */
+
+ /* Uncomment for 3D effect */
+ /* text-shadow: 1px 1px 1px rgba(127, 127, 127, 0.3); */
+}
+
+.ui-grid-icon-blank::before {
+ width: 1em;
+ content: ' ';
+}
+
+.ui-grid-icon-plus-squared:before {
+ content: '\c350'
+}
+
+.ui-grid-icon-minus-squared:before {
+ content: '\c351'
+}
+
+.ui-grid-icon-search:before {
+ content: '\c352'
+}
+
+.ui-grid-icon-cancel:before {
+ content: '\c353'
+}
+
+.ui-grid-icon-info-circled:before {
+ content: '\c354'
+}
+
+.ui-grid-icon-lock:before {
+ content: '\c355'
+}
+
+.ui-grid-icon-lock-open:before {
+ content: '\c356'
+}
+
+.ui-grid-icon-pencil:before {
+ content: '\c357'
+}
+
+.ui-grid-icon-down-dir:before {
+ content: '\c358'
+}
+
+.ui-grid-icon-up-dir:before {
+ content: '\c359'
+}
+
+.ui-grid-icon-left-dir:before {
+ content: '\c35a'
+}
+
+.ui-grid-icon-right-dir:before {
+ content: '\c35b'
+}
+
+.ui-grid-icon-left-open:before {
+ content: '\c35c'
+}
+
+.ui-grid-icon-right-open:before {
+ content: '\c35d'
+}
+
+.ui-grid-icon-angle-down:before {
+ content: '\c35e'
+}
+
+.ui-grid-icon-filter:before {
+ content: '\c35f'
+}
+
+.ui-grid-icon-sort-alt-up:before {
+ content: '\c360'
+}
+
+.ui-grid-icon-sort-alt-down:before {
+ content: '\c361'
+}
+
+.ui-grid-icon-ok:before {
+ content: '\c362'
+}
+
+.ui-grid-icon-menu:before {
+ content: '\c363'
+}
+
+.ui-grid-icon-indent-left:before {
+ content: '\e800'
+}
+
+.ui-grid-icon-indent-right:before {
+ content: '\e801'
+}
+
+.ui-grid-icon-spin5:before {
+ content: '\ea61'
+}
diff --git a/release/4.9.2/less/importer.less b/release/4.9.2/less/importer.less
new file mode 100644
index 000000000..1f82d37ee
--- /dev/null
+++ b/release/4.9.2/less/importer.less
@@ -0,0 +1,4 @@
+@import (reference) './variables';
+
+.ui-grid-importer-header {
+}
diff --git a/release/4.9.2/less/main.less b/release/4.9.2/less/main.less
new file mode 100644
index 000000000..619eafe8a
--- /dev/null
+++ b/release/4.9.2/less/main.less
@@ -0,0 +1,2 @@
+@import (reference) 'variables';
+@import 'core';
\ No newline at end of file
diff --git a/release/4.9.2/less/menu.less b/release/4.9.2/less/menu.less
new file mode 100644
index 000000000..94920709d
--- /dev/null
+++ b/release/4.9.2/less/menu.less
@@ -0,0 +1,91 @@
+@import (reference) 'variables.less';
+@import (reference) 'elements.less';
+
+.ui-grid-menu-button {
+ z-index: 2;
+ position: absolute;
+ right: 0;
+ top: 0;
+ background: @headerBackgroundColor;
+ border: 0;
+ border-left: @gridBorderWidth solid @borderColor;
+ border-bottom: @gridBorderWidth solid @borderColor;
+ cursor: pointer;
+ height: 32px;
+ font-weight: normal;
+}
+
+.ui-grid-menu-button .ui-grid-icon-container {
+ margin-top: 5px;
+ margin-left: 2px;
+}
+
+.ui-grid-menu-button .ui-grid-menu {
+ right: 0;
+ .ui-grid-menu-mid {
+ overflow: scroll;
+ }
+}
+
+.ui-grid-menu {
+ overflow: hidden;
+ max-width: 320px;
+ z-index: 2; // So it shows up over grid canvas
+ position: absolute;
+ right: 100%;
+ padding: 0 10px 20px 10px;
+ cursor: pointer;
+ box-sizing: border-box;
+}
+
+.ui-grid-menu-item {
+ width: 100%;
+ overflow: hidden;
+ text-overflow: ellipsis;
+ white-space: nowrap;
+}
+
+.ui-grid-menu .ui-grid-menu-inner {
+ background: @menuBackgroundColor;
+ border: @gridBorderWidth solid @borderColor;
+ position: relative;
+ white-space: nowrap;
+
+ .rounded(@gridBorderRadius);
+}
+
+.ui-grid-menu .ui-grid-menu-inner ul {
+ margin: 0;
+ padding: 0;
+ list-style-type: none;
+
+ li {
+ padding: 0;
+ .ui-grid-menu-item {
+ color: @menuTextColor;
+ min-width: 100%;
+ padding: 8px;
+ text-align: left;
+ background: transparent;
+ border: none;
+ cursor: default;
+ }
+ button.ui-grid-menu-item {
+ cursor: pointer;
+
+ // Show a shadow when hovering over a menu item
+ &:hover,
+ &:focus {
+ background-color: @menuHoverColor;
+ }
+ &.ui-grid-menu-item-active {
+ background-color: @menuSelectedColor;
+ }
+ }
+ }
+
+ // Show a bottom border on all but the last menu item
+ li:not(:last-child) > .ui-grid-menu-item {
+ border-bottom: @gridBorderWidth solid @borderColor;
+ }
+}
diff --git a/release/4.9.2/less/pagination.less b/release/4.9.2/less/pagination.less
new file mode 100644
index 000000000..20c5d3292
--- /dev/null
+++ b/release/4.9.2/less/pagination.less
@@ -0,0 +1,297 @@
+@import "./variables";
+@import "./elements";
+
+@btnColor: #eee;
+@btnBgColor: #dadada;
+@btnBorderHoverColor: #adadad;
+@btnActiveColor: #8c8c8c;
+
+.ui-grid-pager-panel {
+ display: flex;
+ justify-content: space-between;
+ align-items: center;
+ position: absolute;
+ left: 0;
+ bottom: 0;
+ width: 100%;
+ padding-top: 3px;
+ padding-bottom: 3px;
+ box-sizing: content-box;
+}
+
+.ui-grid-pager-container {
+ float: left;
+}
+
+.ui-grid-pager-control {
+ padding: 5px 0;
+ display: flex;
+ flex-flow: row nowrap;
+ align-items: center;
+ margin-right: 10px;
+ margin-left: 10px;
+ min-width: 135px;
+ float: left;
+
+ button, span, input {
+ margin-right: 4px;
+ }
+
+ button {
+ height: 25px;
+ min-width: 26px;
+ display: inline-block;
+ margin-bottom: 0;
+ font-weight: normal;
+ text-align: center;
+ vertical-align: middle;
+ touch-action: manipulation;
+ cursor: pointer;
+ background: #f3f3f3;
+ border: 1px solid #ccc;
+ white-space: nowrap;
+ padding: 6px 12px;
+ font-size: 14px;
+ line-height: 1.42857143;
+ border-radius: 4px;
+ -webkit-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+ color: @btnColor;
+
+ &:hover {
+ border-color: @btnBorderHoverColor;
+ text-decoration: none;
+ }
+
+ &:focus {
+ border-color: @btnActiveColor;
+ text-decoration: none;
+ outline: 5px auto -webkit-focus-ring-color;
+ outline-offset: -2px;
+ }
+
+ &:active {
+ border-color: @btnBorderHoverColor;
+ outline: 0;
+ -webkit-box-shadow: inset 0 3px 5px rgba(0, 0, 0, 0.125);
+ box-shadow: inset 0 3px 5px rgba(0, 0, 0, 0.125);
+ &:focus {
+ outline: 5px auto -webkit-focus-ring-color;
+ outline-offset: -2px;
+ }
+ &:hover,
+ &:focus {
+ background-color: #c8c8c8;
+ border-color: @btnActiveColor;
+ }
+ }
+
+ &:hover, &:focus, &:active {
+ color: @btnColor;
+ background: @btnBgColor;
+ }
+
+ &[disabled] {
+ cursor: not-allowed;
+ opacity: 0.65;
+ filter: alpha(opacity=65);
+ -webkit-box-shadow: none;
+ box-shadow: none;
+ &:hover,
+ &:focus {
+ background-color: #f3f3f3;
+ border-color: #ccc;
+ }
+ }
+ }
+
+ input {
+ display: inline;
+ height: 26px;
+ width: 50px;
+ vertical-align: top;
+ color: #555555;
+ background: #fff;
+ border: 1px solid #ccc;
+ -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075);
+ box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075);
+ -webkit-transition: border-color ease-in-out .15s, box-shadow ease-in-out .15s;
+ -o-transition: border-color ease-in-out .15s, box-shadow ease-in-out .15s;
+ transition: border-color ease-in-out .15s, box-shadow ease-in-out .15s;
+ padding: 5px 10px;
+ font-size: 12px;
+ line-height: 1.5;
+ border-radius: 3px;
+
+ &:focus {
+ border-color: #66afe9;
+ outline: 0;
+ -webkit-box-shadow: inset 0 1px 1px rgba(0,0,0,.075), 0 0 8px rgba(102, 175, 233, 0.6);
+ box-shadow: inset 0 1px 1px rgba(0,0,0,.075), 0 0 8px rgba(102, 175, 233, 0.6);
+ }
+ &[disabled],
+ &[readonly],
+ &::-moz-placeholder {
+ opacity: 1;
+ }
+ &::-moz-placeholder,
+ &:-ms-input-placeholder,
+ &::-webkit-input-placeholder {
+ color: #999;
+ }
+ &::-ms-expand {
+ border: 0;
+ background-color: transparent;
+ }
+ &[disabled],
+ &[readonly] {
+ background-color: #eeeeee;
+ }
+ &[disabled] {
+ cursor: not-allowed;
+ }
+ }
+
+ .ui-grid-pager-max-pages-number {
+ vertical-align: bottom;
+ > * {
+ vertical-align: bottom;
+ }
+ abbr {
+ border-bottom: none;
+ text-decoration: none;
+ }
+ }
+
+ .first-bar {
+ width: 10px;
+ border-left: 2px solid #4d4d4d;
+ margin-top: -6px;
+ height: 12px;
+ margin-left: -3px;
+ }
+
+ .first-bar-rtl {
+ width: 10px;
+ border-left: 2px solid #4d4d4d;
+ margin-top: -6px;
+ height: 12px;
+ margin-right: -7px;
+ }
+
+ .first-triangle {
+ width: 0;
+ height: 0;
+ border-style: solid;
+ border-width: 5px 8.7px 5px 0;
+ border-color: transparent #4d4d4d transparent transparent;
+ margin-left: 2px;
+ }
+
+ .next-triangle {
+ margin-left: 1px;
+ }
+
+ .prev-triangle {
+ margin-left: 0;
+ }
+
+ .last-triangle {
+ width: 0;
+ height: 0;
+ border-style: solid;
+ border-width: 5px 0 5px 8.7px;
+ border-color: transparent transparent transparent #4d4d4d;
+ margin-left: -1px;
+ }
+
+ .last-bar {
+ width: 10px;
+ border-left: 2px solid #4d4d4d;
+ margin-top: -6px;
+ height: 12px;
+ margin-left: 1px;
+ }
+
+ .last-bar-rtl {
+ width: 10px;
+ border-left: 2px solid #4d4d4d;
+ margin-top: -6px;
+ height: 12px;
+ margin-right: -11px;
+ }
+}
+
+.ui-grid-pager-row-count-picker {
+ float: left;
+ padding: 5px 10px;
+
+ select {
+ color: #555555;
+ background: #fff;
+ border: 1px solid #ccc;
+ -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075);
+ box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075);
+ -webkit-transition: border-color ease-in-out .15s, box-shadow ease-in-out .15s;
+ -o-transition: border-color ease-in-out .15s, box-shadow ease-in-out .15s;
+ transition: border-color ease-in-out .15s, box-shadow ease-in-out .15s;
+ padding: 5px 10px;
+ font-size: 12px;
+ line-height: 1.5;
+ border-radius: 3px;
+ height: 25px;
+ width: 67px;
+ display: inline;
+ vertical-align: middle;
+
+ &:focus {
+ border-color: #66afe9;
+ outline: 0;
+ -webkit-box-shadow: inset 0 1px 1px rgba(0,0,0,.075), 0 0 8px rgba(102, 175, 233, 0.6);
+ box-shadow: inset 0 1px 1px rgba(0,0,0,.075), 0 0 8px rgba(102, 175, 233, 0.6);
+ }
+ &[disabled],
+ &[readonly],
+ &::-moz-placeholder {
+ opacity: 1;
+ }
+ &::-moz-placeholder,
+ &:-ms-input-placeholder,
+ &::-webkit-input-placeholder {
+ color: #999;
+ }
+ &::-ms-expand {
+ border: 0;
+ background-color: transparent;
+ }
+ &[disabled],
+ &[readonly] {
+ background-color: #eeeeee;
+ }
+ &[disabled] {
+ cursor: not-allowed;
+ }
+ }
+
+ .ui-grid-pager-row-count-label {
+ margin-top: 3px;
+ }
+}
+
+.ui-grid-pager-count-container {
+ float: right;
+ margin-top: 4px;
+ min-width: 50px;
+
+ .ui-grid-pager-count {
+ margin-right: 10px;
+ margin-left: 10px;
+ float: right;
+ abbr {
+ border-bottom: none;
+ text-decoration: none;
+ }
+ }
+}
diff --git a/release/4.9.2/less/pinning.less b/release/4.9.2/less/pinning.less
new file mode 100644
index 000000000..eb771d0f6
--- /dev/null
+++ b/release/4.9.2/less/pinning.less
@@ -0,0 +1,86 @@
+@import (reference) './variables';
+
+.ui-grid-pinned-container {
+ position: absolute;
+ display: inline;
+ top: 0;
+
+ &.ui-grid-pinned-container-left {
+ float: left;
+ left: 0;
+ }
+
+ &.ui-grid-pinned-container-right {
+ float: right;
+ right: 0;
+ }
+
+ &.ui-grid-pinned-container-left .ui-grid-header-cell:last-child {
+ box-sizing: border-box;
+ border-right: @gridBorderWidth solid;
+ border-width: @gridBorderWidth;
+ border-right-color: darken(@headerVerticalBarColor, 15%);
+ }
+
+ &.ui-grid-pinned-container-left .ui-grid-cell:last-child {
+ box-sizing: border-box;
+ border-right: @gridBorderWidth solid;
+ border-width: @gridBorderWidth;
+ border-right-color: darken(@verticalBarColor, 15%);
+ }
+
+ &.ui-grid-pinned-container-left .ui-grid-header-cell:not(:last-child) .ui-grid-vertical-bar, .ui-grid-cell:not(:last-child) .ui-grid-vertical-bar {
+ width: @gridBorderWidth;
+ }
+
+ &.ui-grid-pinned-container-left .ui-grid-header-cell:not(:last-child) .ui-grid-vertical-bar {
+ background-color: @headerVerticalBarColor;
+ }
+
+ &.ui-grid-pinned-container-left .ui-grid-cell:not(:last-child) .ui-grid-vertical-bar {
+ background-color: darken(@verticalBarColor, 15%);
+ }
+
+ &.ui-grid-pinned-container-left .ui-grid-header-cell:last-child .ui-grid-vertical-bar {
+ right: -1px; // TODO(c0bra): Should this be grid width? Test column resizing with custom grid border width
+ width: @gridBorderWidth;
+ background-color: darken(@headerVerticalBarColor, 15%);
+ }
+
+
+ &.ui-grid-pinned-container-right .ui-grid-header-cell:first-child {
+ box-sizing: border-box;
+ border-left: @gridBorderWidth solid;
+ border-width: @gridBorderWidth;
+ border-left-color: darken(@headerVerticalBarColor, 15%);
+ }
+
+ &.ui-grid-pinned-container-right .ui-grid-cell:first-child {
+ box-sizing: border-box;
+ border-left: @gridBorderWidth solid;
+ border-width: @gridBorderWidth;
+ border-left-color: darken(@verticalBarColor, 15%);
+ }
+
+ &.ui-grid-pinned-container-right .ui-grid-header-cell:not(:first-child) .ui-grid-vertical-bar, .ui-grid-cell:not(:first-child) .ui-grid-vertical-bar {
+ width: @gridBorderWidth;
+ }
+
+ &.ui-grid-pinned-container-right .ui-grid-header-cell:not(:first-child) .ui-grid-vertical-bar {
+ background-color: @headerVerticalBarColor;
+ }
+
+ &.ui-grid-pinned-container-right .ui-grid-cell:not(:last-child) .ui-grid-vertical-bar {
+ background-color: darken(@verticalBarColor, 15%);
+ }
+
+ &.ui-grid-pinned-container-first .ui-grid-header-cell:first-child .ui-grid-vertical-bar {
+ left: -1px; // TODO(c0bra): Should this be grid width? Test column resizing with custom grid border width
+ width: @gridBorderWidth;
+ background-color: darken(@headerVerticalBarColor, 15%);
+ }
+}
+
+.ui-grid-render-container-body {
+ // float: left;
+}
diff --git a/release/4.9.2/less/rowEdit.less b/release/4.9.2/less/rowEdit.less
new file mode 100644
index 000000000..7416974a6
--- /dev/null
+++ b/release/4.9.2/less/rowEdit.less
@@ -0,0 +1,19 @@
+@import (reference) './variables';
+
+.ui-grid-row-saving {
+ .ui-grid-cell {
+ color: @rowSavingForeground !important;
+ }
+}
+
+.ui-grid-row-dirty {
+ .ui-grid-cell {
+ color: @rowDirtyForeground;
+ }
+}
+
+.ui-grid-row-error {
+ .ui-grid-cell {
+ color: @rowErrorForeground !important;
+ }
+}
diff --git a/release/4.9.2/less/rtl.less b/release/4.9.2/less/rtl.less
new file mode 100644
index 000000000..4ae83312e
--- /dev/null
+++ b/release/4.9.2/less/rtl.less
@@ -0,0 +1,67 @@
+@import (reference) 'variables.less';
+
+/*
+* RTL Styles
+*/
+
+.ui-grid[dir=rtl] {
+
+ .ui-grid-header-cell,
+ .ui-grid-footer-cell,
+ .ui-grid-cell {
+ float: right !important;
+ }
+
+ .ui-grid-column-menu-button {
+ position: absolute;
+ left: 1px;
+ top: 0;
+ right: inherit;
+ }
+
+ .ui-grid-cell:first-child,
+ .ui-grid-header-cell:first-child,
+ .ui-grid-footer-cell:first-child {
+ border-right: 0;
+ }
+
+ .ui-grid-cell:last-child, .ui-grid-header-cell:last-child {
+ border-right: @gridBorderWidth solid @borderColor;
+ border-left: 0;
+ }
+
+ .ui-grid-header-cell:first-child .ui-grid-vertical-bar,
+ .ui-grid-footer-cell:first-child .ui-grid-vertical-bar,
+ .ui-grid-cell:first-child .ui-grid-vertical-bar {
+ width: 0;
+ }
+
+ .ui-grid-menu-button {
+ z-index: 2;
+ position: absolute;
+ left: 0;
+ right: auto;
+ background: @headerBackgroundColor;
+ border: @gridBorderWidth solid @borderColor;
+ cursor: pointer;
+ min-height: 27px;
+ font-weight: normal;
+ }
+
+ .ui-grid-menu-button .ui-grid-menu {
+ left: 0;
+ right: auto;
+ }
+
+ // Position filter-cancel button on the left for rtl grids
+ .ui-grid-filter-container .ui-grid-filter-button {
+ right: initial;
+ left: 0;
+
+ [class^="ui-grid-icon"] {
+ right: initial;
+ left: 10px;
+ }
+ }
+
+}
\ No newline at end of file
diff --git a/release/4.9.2/less/selection.less b/release/4.9.2/less/selection.less
new file mode 100644
index 000000000..f12fad3ac
--- /dev/null
+++ b/release/4.9.2/less/selection.less
@@ -0,0 +1,29 @@
+@import (reference) './variables';
+
+.ui-grid-row.ui-grid-row-selected > [ui-grid-row] > .ui-grid-cell {
+ background-color: @rowSelected;
+}
+
+.ui-grid-disable-selection {
+ -webkit-touch-callout: none;
+ -webkit-user-select: none;
+ -khtml-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+ cursor: default;
+}
+
+.ui-grid-selection-row-header-buttons {
+ display: flex;
+ align-items: center;
+ height: 100%;
+ cursor: pointer;
+ &::before {
+ opacity: 0.1;
+ }
+ &.ui-grid-row-selected::before,
+ &.ui-grid-all-selected::before {
+ opacity: 1;
+ }
+}
diff --git a/release/4.9.2/less/sorting.less b/release/4.9.2/less/sorting.less
new file mode 100644
index 000000000..7fd626651
--- /dev/null
+++ b/release/4.9.2/less/sorting.less
@@ -0,0 +1,16 @@
+@import (reference) 'elements.less';
+
+@sortArrowWidth: 20px;
+
+.ui-grid-sortarrow {
+ right: 5px;
+ position: absolute;
+ width: @sortArrowWidth;
+ top: 0;
+ bottom: 0;
+ background-position: center;
+
+ &.down {
+ .transform(rotate(180deg));
+ }
+}
\ No newline at end of file
diff --git a/release/4.9.2/less/tree-base.less b/release/4.9.2/less/tree-base.less
new file mode 100644
index 000000000..b936a8804
--- /dev/null
+++ b/release/4.9.2/less/tree-base.less
@@ -0,0 +1,6 @@
+@import (reference) './variables';
+
+.ui-grid-tree-row-header-buttons.ui-grid-tree-header {
+ cursor: pointer;
+ opacity: 1;
+}
diff --git a/release/4.9.2/less/tree-view.less b/release/4.9.2/less/tree-view.less
new file mode 100644
index 000000000..b283aaaa7
--- /dev/null
+++ b/release/4.9.2/less/tree-view.less
@@ -0,0 +1,8 @@
+@import (reference) './variables';
+
+.ui-grid-tree-header-row {
+ font-weight: bold !important;
+}
+.ui-grid-tree-header-row .ui-grid-cell.ui-grid-disable-selection.ui-grid-row-header-cell {
+ pointer-events: all;
+}
diff --git a/release/4.9.2/less/validate.less b/release/4.9.2/less/validate.less
new file mode 100644
index 000000000..97dbf2971
--- /dev/null
+++ b/release/4.9.2/less/validate.less
@@ -0,0 +1,5 @@
+@import (reference) './variables';
+
+.ui-grid-cell-contents.invalid {
+ border: @invalidValueBorder;
+}
\ No newline at end of file
diff --git a/release/4.9.2/less/variables.less b/release/4.9.2/less/variables.less
new file mode 100644
index 000000000..7b0632df8
--- /dev/null
+++ b/release/4.9.2/less/variables.less
@@ -0,0 +1,90 @@
+
+/* This file contains variable declarations (do not remove this line) */
+
+/*-- VARIABLES (DO NOT REMOVE THESE COMMENTS) --*/
+
+/**
+* @section Grid styles
+*/
+@gridBorderWidth: 1px;
+@gridBorderRadius: 0px;
+@borderColor: #d4d4d4;
+@focusColor: #b3c4c7;
+@activeColor: darken(@focusColor, 8%);
+
+/**
+* @section Header styles
+*/
+
+/** @description Colors for header gradient */
+@headerBackgroundColor: #f3f3f3;
+@headerGradientStart: #eee;
+@headerGradientStop: #fff;
+@headerVerticalBarColor: @borderColor;
+
+/**
+* @section Grid body styles
+*/
+
+/** @description Colors used for row alternation */
+@verticalBarColor: @borderColor;
+@rowColorHovered: #d5eaee;
+@rowColorEven: #f3f3f3;
+@rowColorOdd: #fdfdfd;
+
+/**
+* @section Grid Menu colors
+*/
+@menuBackgroundColor: #fff;
+@menuHoverColor: @focusColor;
+@menuSelectedColor: @activeColor;
+@menuTextColor: #000;
+
+/**
+* @section Sort arrow colors
+*/
+
+@sortArrowBackgroundColor: #aaaaaa;
+@sortArrowBorderColor: #777777;
+
+
+@rowHeaderCell: #F0F0EE;
+@rowSelected: #C9DDE1;
+@rowSavingForeground: #848484;
+@rowErrorForeground: #FF0000;
+@rowDirtyForeground: #610B38;
+
+// TODO: color for cell selections
+@focusedCell: @focusColor;
+
+// Color to use for enabled or selected settings/items/cells, etc. Should probably override the one above
+@selectedColor: @activeColor;
+
+/**
+* @section Scrollbar styles
+*/
+@scrollbarBackground: darken(@rowColorEven, 15%);
+@scrollbarBackgroundHover: darken(@scrollbarBackground, 15%);
+@scrollbarBackgroundScrolling: darken(@scrollbarBackgroundHover, 15%);
+@scrollbarWidth: 10px;
+@scrollbarBorderRadius: 2px;
+@scrollbarShadow: 0 0 0px #fff;
+@scrollbarBorder: 1px solid darken(@scrollbarBackground, 15%);
+@scrollbarBorderScrolling: 1px solid darken(@scrollbarBackgroundScrolling, 15%);
+
+//Border to be applied to editors when the input value or invalid
+@invalidValueBorder: 1px solid #fc8f8f;
+@validValueBorder: 1px solid @borderColor;
+
+//Pagination controls
+@paginationButtonColor: @headerGradientStart;
+@paginationButtonBackgroundColor: @headerBackgroundColor;
+@paginationButtonBorderColor: #ccc;
+
+
+/**
+* @section font library path
+*/
+@font-path: 'fonts/';
+
+/*-- END VARIABLES (DO NOT REMOVE THESE COMMENTS) --*/
diff --git a/release/4.9.2/ui-grid.auto-resize.js b/release/4.9.2/ui-grid.auto-resize.js
new file mode 100644
index 000000000..33f3f9d70
--- /dev/null
+++ b/release/4.9.2/ui-grid.auto-resize.js
@@ -0,0 +1,68 @@
+/*!
+ * ui-grid - v4.9.2 - 2020-12-01
+ * Copyright (c) 2020 ; License: MIT
+ */
+
+(function() {
+ 'use strict';
+ /**
+ * @ngdoc overview
+ * @name ui.grid.autoResize
+ *
+ * @description
+ *
+ * #ui.grid.autoResize
+ *
+ * Beta This feature is ready for testing, but it either hasn't seen a lot of use or has some known bugs.
+ *
+ * This module provides auto-resizing functionality to UI-Grid.
+ */
+ var module = angular.module('ui.grid.autoResize', ['ui.grid']);
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.autoResize.directive:uiGridAutoResize
+ * @element div
+ * @restrict A
+ *
+ * @description Stacks on top of the ui-grid directive and
+ * adds the a watch to the grid's height and width which refreshes
+ * the grid content whenever its dimensions change.
+ *
+ */
+ module.directive('uiGridAutoResize', ['gridUtil', function(gridUtil) {
+ return {
+ require: 'uiGrid',
+ scope: false,
+ link: function($scope, $elm, $attrs, uiGridCtrl) {
+ var debouncedRefresh;
+
+ function getDimensions() {
+ return {
+ width: gridUtil.elementWidth($elm),
+ height: gridUtil.elementHeight($elm)
+ };
+ }
+
+ function refreshGrid(prevWidth, prevHeight, width, height) {
+ if ($elm[0].offsetParent !== null) {
+ uiGridCtrl.grid.gridWidth = width;
+ uiGridCtrl.grid.gridHeight = height;
+ uiGridCtrl.grid.queueGridRefresh()
+ .then(function() {
+ uiGridCtrl.grid.api.core.raise.gridDimensionChanged(prevHeight, prevWidth, height, width);
+ });
+ }
+ }
+
+ debouncedRefresh = gridUtil.debounce(refreshGrid, 400);
+
+ $scope.$watchCollection(getDimensions, function(newValues, oldValues) {
+ if (!angular.equals(newValues, oldValues)) {
+ debouncedRefresh(oldValues.width, oldValues.height, newValues.width, newValues.height);
+ }
+ });
+ }
+ };
+ }]);
+})();
diff --git a/release/4.9.2/ui-grid.auto-resize.min.js b/release/4.9.2/ui-grid.auto-resize.min.js
new file mode 100644
index 000000000..a7cdd99b5
--- /dev/null
+++ b/release/4.9.2/ui-grid.auto-resize.min.js
@@ -0,0 +1,7 @@
+/*!
+ * ui-grid - v4.9.2 - 2020-12-01
+ * Copyright (c) 2020 ; License: MIT
+ */
+
+
+!function(){"use strict";angular.module("ui.grid.autoResize",["ui.grid"]).directive("uiGridAutoResize",["gridUtil",function(n){return{require:"uiGrid",scope:!1,link:function(i,r,e,u){var t;t=n.debounce(function(i,e,t,n){null!==r[0].offsetParent&&(u.grid.gridWidth=t,u.grid.gridHeight=n,u.grid.queueGridRefresh().then(function(){u.grid.api.core.raise.gridDimensionChanged(e,i,n,t)}))},400),i.$watchCollection(function(){return{width:n.elementWidth(r),height:n.elementHeight(r)}},function(i,e){angular.equals(i,e)||t(e.width,e.height,i.width,i.height)})}}}])}();
\ No newline at end of file
diff --git a/release/4.9.2/ui-grid.cellnav.js b/release/4.9.2/ui-grid.cellnav.js
new file mode 100644
index 000000000..e803b72df
--- /dev/null
+++ b/release/4.9.2/ui-grid.cellnav.js
@@ -0,0 +1,1181 @@
+/*!
+ * ui-grid - v4.9.2 - 2020-12-01
+ * Copyright (c) 2020 ; License: MIT
+ */
+
+(function () {
+ 'use strict';
+
+ /**
+ * @ngdoc overview
+ * @name ui.grid.cellNav
+ *
+ * @description
+
+ #ui.grid.cellNav
+
+ Stable This feature is stable. There should no longer be breaking api changes without a deprecation warning.
+
+ This module provides cell navigation functionality to UI-Grid.
+ */
+ var module = angular.module('ui.grid.cellNav', ['ui.grid']);
+
+ /**
+ * @ngdoc object
+ * @name ui.grid.cellNav.constant:uiGridCellNavConstants
+ *
+ * @description constants available in cellNav
+ */
+ module.constant('uiGridCellNavConstants', {
+ FEATURE_NAME: 'gridCellNav',
+ CELL_NAV_EVENT: 'cellNav',
+ direction: {LEFT: 0, RIGHT: 1, UP: 2, DOWN: 3, PG_UP: 4, PG_DOWN: 5},
+ EVENT_TYPE: {
+ KEYDOWN: 0,
+ CLICK: 1,
+ CLEAR: 2
+ }
+ });
+
+
+ module.factory('uiGridCellNavFactory', ['gridUtil', 'uiGridConstants', 'uiGridCellNavConstants', 'GridRowColumn', '$q',
+ function (gridUtil, uiGridConstants, uiGridCellNavConstants, GridRowColumn, $q) {
+ /**
+ * @ngdoc object
+ * @name ui.grid.cellNav.object:CellNav
+ * @description returns a CellNav prototype function
+ * @param {object} rowContainer container for rows
+ * @param {object} colContainer parent column container
+ * @param {object} leftColContainer column container to the left of parent
+ * @param {object} rightColContainer column container to the right of parent
+ */
+ var UiGridCellNav = function UiGridCellNav(rowContainer, colContainer, leftColContainer, rightColContainer) {
+ this.rows = rowContainer.visibleRowCache;
+ this.columns = colContainer.visibleColumnCache;
+ this.leftColumns = leftColContainer ? leftColContainer.visibleColumnCache : [];
+ this.rightColumns = rightColContainer ? rightColContainer.visibleColumnCache : [];
+ this.bodyContainer = rowContainer;
+ };
+
+ /** returns focusable columns of all containers */
+ UiGridCellNav.prototype.getFocusableCols = function () {
+ var allColumns = this.leftColumns.concat(this.columns, this.rightColumns);
+
+ return allColumns.filter(function (col) {
+ return col.colDef.allowCellFocus;
+ });
+ };
+
+ /**
+ * @ngdoc object
+ * @name ui.grid.cellNav.api:GridRow
+ *
+ * @description GridRow settings for cellNav feature, these are available to be
+ * set only internally (for example, by other features)
+ */
+
+ /**
+ * @ngdoc object
+ * @name allowCellFocus
+ * @propertyOf ui.grid.cellNav.api:GridRow
+ * @description Enable focus on a cell within this row. If set to false then no cells
+ * in this row can be focused - group header rows as an example would set this to false.
+ * Defaults to true + */ + /** returns focusable rows */ + UiGridCellNav.prototype.getFocusableRows = function () { + return this.rows.filter(function(row) { + return row.allowCellFocus !== false; + }); + }; + + UiGridCellNav.prototype.getNextRowCol = function (direction, curRow, curCol) { + switch (direction) { + case uiGridCellNavConstants.direction.LEFT: + return this.getRowColLeft(curRow, curCol); + case uiGridCellNavConstants.direction.RIGHT: + return this.getRowColRight(curRow, curCol); + case uiGridCellNavConstants.direction.UP: + return this.getRowColUp(curRow, curCol); + case uiGridCellNavConstants.direction.DOWN: + return this.getRowColDown(curRow, curCol); + case uiGridCellNavConstants.direction.PG_UP: + return this.getRowColPageUp(curRow, curCol); + case uiGridCellNavConstants.direction.PG_DOWN: + return this.getRowColPageDown(curRow, curCol); + } + }; + + UiGridCellNav.prototype.initializeSelection = function () { + var focusableCols = this.getFocusableCols(); + var focusableRows = this.getFocusableRows(); + if (focusableCols.length === 0 || focusableRows.length === 0) { + return null; + } + + return new GridRowColumn(focusableRows[0], focusableCols[0]); // return same row + }; + + UiGridCellNav.prototype.getRowColLeft = function (curRow, curCol) { + var focusableCols = this.getFocusableCols(); + var focusableRows = this.getFocusableRows(); + var curColIndex = focusableCols.indexOf(curCol); + var curRowIndex = focusableRows.indexOf(curRow); + + // could not find column in focusable Columns so set it to 1 + if (curColIndex === -1) { + curColIndex = 1; + } + + var nextColIndex = curColIndex === 0 ? focusableCols.length - 1 : curColIndex - 1; + + // get column to left + if (nextColIndex >= curColIndex) { + // On the first row + // if (curRowIndex === 0 && curColIndex === 0) { + // return null; + // } + if (curRowIndex === 0) { + return new GridRowColumn(curRow, focusableCols[nextColIndex]); // return same row + } + else { + // up one row and far right column + return new GridRowColumn(focusableRows[curRowIndex - 1], focusableCols[nextColIndex]); + } + } + else { + return new GridRowColumn(curRow, focusableCols[nextColIndex]); + } + }; + + + + UiGridCellNav.prototype.getRowColRight = function (curRow, curCol) { + var focusableCols = this.getFocusableCols(); + var focusableRows = this.getFocusableRows(); + var curColIndex = focusableCols.indexOf(curCol); + var curRowIndex = focusableRows.indexOf(curRow); + + // could not find column in focusable Columns so set it to 0 + if (curColIndex === -1) { + curColIndex = 0; + } + var nextColIndex = curColIndex === focusableCols.length - 1 ? 0 : curColIndex + 1; + + if (nextColIndex <= curColIndex) { + if (curRowIndex === focusableRows.length - 1) { + return new GridRowColumn(curRow, focusableCols[nextColIndex]); // return same row + } + else { + // down one row and far left column + return new GridRowColumn(focusableRows[curRowIndex + 1], focusableCols[nextColIndex]); + } + } + else { + return new GridRowColumn(curRow, focusableCols[nextColIndex]); + } + }; + + UiGridCellNav.prototype.getRowColDown = function (curRow, curCol) { + var focusableCols = this.getFocusableCols(); + var focusableRows = this.getFocusableRows(); + var curColIndex = focusableCols.indexOf(curCol); + var curRowIndex = focusableRows.indexOf(curRow); + + // could not find column in focusable Columns so set it to 0 + if (curColIndex === -1) { + curColIndex = 0; + } + + if (curRowIndex === focusableRows.length - 1) { + return new GridRowColumn(curRow, focusableCols[curColIndex]); // return same row + } + else { + // down one row + return new GridRowColumn(focusableRows[curRowIndex + 1], focusableCols[curColIndex]); + } + }; + + UiGridCellNav.prototype.getRowColPageDown = function (curRow, curCol) { + var focusableCols = this.getFocusableCols(); + var focusableRows = this.getFocusableRows(); + var curColIndex = focusableCols.indexOf(curCol); + var curRowIndex = focusableRows.indexOf(curRow); + + // could not find column in focusable Columns so set it to 0 + if (curColIndex === -1) { + curColIndex = 0; + } + + var pageSize = this.bodyContainer.minRowsToRender(); + if (curRowIndex >= focusableRows.length - pageSize) { + return new GridRowColumn(focusableRows[focusableRows.length - 1], focusableCols[curColIndex]); // return last row + } + else { + // down one page + return new GridRowColumn(focusableRows[curRowIndex + pageSize], focusableCols[curColIndex]); + } + }; + + UiGridCellNav.prototype.getRowColUp = function (curRow, curCol) { + var focusableCols = this.getFocusableCols(); + var focusableRows = this.getFocusableRows(); + var curColIndex = focusableCols.indexOf(curCol); + var curRowIndex = focusableRows.indexOf(curRow); + + // could not find column in focusable Columns so set it to 0 + if (curColIndex === -1) { + curColIndex = 0; + } + + if (curRowIndex === 0) { + return new GridRowColumn(curRow, focusableCols[curColIndex]); // return same row + } + else { + // up one row + return new GridRowColumn(focusableRows[curRowIndex - 1], focusableCols[curColIndex]); + } + }; + + UiGridCellNav.prototype.getRowColPageUp = function (curRow, curCol) { + var focusableCols = this.getFocusableCols(); + var focusableRows = this.getFocusableRows(); + var curColIndex = focusableCols.indexOf(curCol); + var curRowIndex = focusableRows.indexOf(curRow); + + // could not find column in focusable Columns so set it to 0 + if (curColIndex === -1) { + curColIndex = 0; + } + + var pageSize = this.bodyContainer.minRowsToRender(); + if (curRowIndex - pageSize < 0) { + return new GridRowColumn(focusableRows[0], focusableCols[curColIndex]); // return first row + } + else { + // up one page + return new GridRowColumn(focusableRows[curRowIndex - pageSize], focusableCols[curColIndex]); + } + }; + return UiGridCellNav; + }]); + + /** + * @ngdoc service + * @name ui.grid.cellNav.service:uiGridCellNavService + * + * @description Services for cell navigation features. If you don't like the key maps we use, + * or the direction cells navigation, override with a service decorator (see angular docs) + */ + module.service('uiGridCellNavService', ['gridUtil', 'uiGridConstants', 'uiGridCellNavConstants', '$q', 'uiGridCellNavFactory', 'GridRowColumn', 'ScrollEvent', + function (gridUtil, uiGridConstants, uiGridCellNavConstants, $q, UiGridCellNav, GridRowColumn, ScrollEvent) { + + var service = { + + initializeGrid: function (grid) { + grid.registerColumnBuilder(service.cellNavColumnBuilder); + + + /** + * @ngdoc object + * @name ui.grid.cellNav.Grid:cellNav + * @description cellNav properties added to grid class + */ + grid.cellNav = {}; + grid.cellNav.lastRowCol = null; + grid.cellNav.focusedCells = []; + + service.defaultGridOptions(grid.options); + + /** + * @ngdoc object + * @name ui.grid.cellNav.api:PublicApi + * + * @description Public Api for cellNav feature + */ + var publicApi = { + events: { + cellNav: { + /** + * @ngdoc event + * @name navigate + * @eventOf ui.grid.cellNav.api:PublicApi + * @description raised when the active cell is changed + *
+ * gridApi.cellNav.on.navigate(scope,function(newRowcol, oldRowCol) {})
+ *
+ * @param {object} newRowCol new position
+ * @param {object} oldRowCol old position
+ */
+ navigate: function (newRowCol, oldRowCol) {},
+ /**
+ * @ngdoc event
+ * @name viewPortKeyDown
+ * @eventOf ui.grid.cellNav.api:PublicApi
+ * @description is raised when the viewPort receives a keyDown event. Cells never get focus in uiGrid
+ * due to the difficulties of setting focus on a cell that is not visible in the viewport. Use this
+ * event whenever you need a keydown event on a cell
+ * + * @param {object} event keydown event + * @param {object} rowCol current rowCol position + */ + viewPortKeyDown: function (event, rowCol) {}, + + /** + * @ngdoc event + * @name viewPortKeyPress + * @eventOf ui.grid.cellNav.api:PublicApi + * @description is raised when the viewPort receives a keyPress event. Cells never get focus in uiGrid + * due to the difficulties of setting focus on a cell that is not visible in the viewport. Use this + * event whenever you need a keypress event on a cell + * + * @param {object} event keypress event + * @param {object} rowCol current rowCol position + */ + viewPortKeyPress: function (event, rowCol) {} + } + }, + methods: { + cellNav: { + /** + * @ngdoc function + * @name scrollToFocus + * @methodOf ui.grid.cellNav.api:PublicApi + * @description brings the specified row and column into view, and sets focus + * to that cell + * @param {object} rowEntity gridOptions.data[] array instance to make visible and set focus + * @param {object} colDef to make visible and set focus + * @returns {promise} a promise that is resolved after any scrolling is finished + */ + scrollToFocus: function (rowEntity, colDef) { + return service.scrollToFocus(grid, rowEntity, colDef); + }, + + /** + * @ngdoc function + * @name getFocusedCell + * @methodOf ui.grid.cellNav.api:PublicApi + * @description returns the current (or last if Grid does not have focus) focused row and column + * value is null if no selection has occurred + */ + getFocusedCell: function () { + return grid.cellNav.lastRowCol; + }, + + /** + * @ngdoc function + * @name getCurrentSelection + * @methodOf ui.grid.cellNav.api:PublicApi + * @description returns an array containing the current selection + * array is empty if no selection has occurred + */ + getCurrentSelection: function () { + return grid.cellNav.focusedCells; + }, + + /** + * @ngdoc function + * @name rowColSelectIndex + * @methodOf ui.grid.cellNav.api:PublicApi + * @description returns the index in the order in which the GridRowColumn was selected, returns -1 if the GridRowColumn + * isn't selected + * @param {object} rowCol the rowCol to evaluate + */ + rowColSelectIndex: function (rowCol) { + // return gridUtil.arrayContainsObjectWithProperty(grid.cellNav.focusedCells, 'col.uid', rowCol.col.uid) && + var index = -1; + for (var i = 0; i < grid.cellNav.focusedCells.length; i++) { + if (grid.cellNav.focusedCells[i].col.uid === rowCol.col.uid && + grid.cellNav.focusedCells[i].row.uid === rowCol.row.uid) { + index = i; + break; + } + } + return index; + } + } + } + }; + + grid.api.registerEventsFromObject(publicApi.events); + + grid.api.registerMethodsFromObject(publicApi.methods); + }, + + defaultGridOptions: function (gridOptions) { + /** + * @ngdoc object + * @name ui.grid.cellNav.api:GridOptions + * + * @description GridOptions for cellNav feature, these are available to be + * set using the ui-grid {@link ui.grid.class:GridOptions gridOptions} + */ + + /** + * @ngdoc object + * @name modifierKeysToMultiSelectCells + * @propertyOf ui.grid.cellNav.api:GridOptions + * @description Enable multiple cell selection only when using the ctrlKey or shiftKey. + * Defaults to false + */ + gridOptions.modifierKeysToMultiSelectCells = gridOptions.modifierKeysToMultiSelectCells === true; + + /** + * @ngdoc array + * @name keyDownOverrides + * @propertyOf ui.grid.cellNav.api:GridOptions + * @description An array of event objects to override on keydown. If an event is overridden, the viewPortKeyDown event will + * be raised with the overridden events, allowing custom keydown behavior. + * Defaults to [] + */ + gridOptions.keyDownOverrides = gridOptions.keyDownOverrides || []; + + }, + + /** + * @ngdoc service + * @name decorateRenderContainers + * @methodOf ui.grid.cellNav.service:uiGridCellNavService + * @description decorates grid renderContainers with cellNav functions + */ + decorateRenderContainers: function (grid) { + + var rightContainer = grid.hasRightContainer() ? grid.renderContainers.right : null; + var leftContainer = grid.hasLeftContainer() ? grid.renderContainers.left : null; + + if (leftContainer !== null) { + grid.renderContainers.left.cellNav = new UiGridCellNav(grid.renderContainers.body, leftContainer, rightContainer, grid.renderContainers.body); + } + if (rightContainer !== null) { + grid.renderContainers.right.cellNav = new UiGridCellNav(grid.renderContainers.body, rightContainer, grid.renderContainers.body, leftContainer); + } + + grid.renderContainers.body.cellNav = new UiGridCellNav(grid.renderContainers.body, grid.renderContainers.body, leftContainer, rightContainer); + }, + + /** + * @ngdoc service + * @name getDirection + * @methodOf ui.grid.cellNav.service:uiGridCellNavService + * @description determines which direction to for a given keyDown event + * @returns {uiGridCellNavConstants.direction} direction + */ + getDirection: function (evt) { + if (evt.keyCode === uiGridConstants.keymap.LEFT || + (evt.keyCode === uiGridConstants.keymap.TAB && evt.shiftKey)) { + return uiGridCellNavConstants.direction.LEFT; + } + if (evt.keyCode === uiGridConstants.keymap.RIGHT || + evt.keyCode === uiGridConstants.keymap.TAB) { + return uiGridCellNavConstants.direction.RIGHT; + } + + if (evt.keyCode === uiGridConstants.keymap.UP || + (evt.keyCode === uiGridConstants.keymap.ENTER && evt.shiftKey) ) { + return uiGridCellNavConstants.direction.UP; + } + + if (evt.keyCode === uiGridConstants.keymap.PG_UP) { + return uiGridCellNavConstants.direction.PG_UP; + } + + if (evt.keyCode === uiGridConstants.keymap.DOWN || + evt.keyCode === uiGridConstants.keymap.ENTER && !(evt.ctrlKey || evt.altKey)) { + return uiGridCellNavConstants.direction.DOWN; + } + + if (evt.keyCode === uiGridConstants.keymap.PG_DOWN) { + return uiGridCellNavConstants.direction.PG_DOWN; + } + + return null; + }, + + /** + * @ngdoc service + * @name cellNavColumnBuilder + * @methodOf ui.grid.cellNav.service:uiGridCellNavService + * @description columnBuilder function that adds cell navigation properties to grid column + * @returns {promise} promise that will load any needed templates when resolved + */ + cellNavColumnBuilder: function (colDef, col, gridOptions) { + var promises = []; + + /** + * @ngdoc object + * @name ui.grid.cellNav.api:ColumnDef + * + * @description Column Definitions for cellNav feature, these are available to be + * set using the ui-grid {@link ui.grid.class:GridOptions.columnDef gridOptions.columnDefs} + */ + + /** + * @ngdoc object + * @name allowCellFocus + * @propertyOf ui.grid.cellNav.api:ColumnDef + * @description Enable focus on a cell within this column. + * Defaults to true + */ + colDef.allowCellFocus = colDef.allowCellFocus === undefined ? true : colDef.allowCellFocus; + + return $q.all(promises); + }, + + /** + * @ngdoc method + * @methodOf ui.grid.cellNav.service:uiGridCellNavService + * @name scrollToFocus + * @description Scroll the grid such that the specified + * row and column is in view, and set focus to the cell in that row and column + * @param {Grid} grid the grid you'd like to act upon, usually available + * from gridApi.grid + * @param {object} rowEntity gridOptions.data[] array instance to make visible and set focus to + * @param {object} colDef to make visible and set focus to + * @returns {promise} a promise that is resolved after any scrolling is finished + */ + scrollToFocus: function (grid, rowEntity, colDef) { + var gridRow = null, gridCol = null; + + if (typeof(rowEntity) !== 'undefined' && rowEntity !== null) { + gridRow = grid.getRow(rowEntity); + } + + if (typeof(colDef) !== 'undefined' && colDef !== null) { + gridCol = grid.getColumn(colDef.name ? colDef.name : colDef.field); + } + return grid.api.core.scrollToIfNecessary(gridRow, gridCol).then(function () { + var rowCol = { row: gridRow, col: gridCol }; + + // Broadcast the navigation + if (gridRow !== null && gridCol !== null) { + grid.cellNav.broadcastCellNav(rowCol, null, null); + } + }); + }, + + + /** + * @ngdoc method + * @methodOf ui.grid.cellNav.service:uiGridCellNavService + * @name getLeftWidth + * @description Get the current drawn width of the columns in the + * grid up to the numbered column, and add an apportionment for the + * column that we're on. So if we are on column 0, we want to scroll + * 0% (i.e. exclude this column from calc). If we're on the last column + * we want to scroll to 100% (i.e. include this column in the calc). So + * we include (thisColIndex / totalNumberCols) % of this column width + * @param {Grid} grid the grid you'd like to act upon, usually available + * from gridApi.grid + * @param {GridColumn} upToCol the column to total up to and including + */ + getLeftWidth: function (grid, upToCol) { + var width = 0; + + if (!upToCol) { + return width; + } + + var lastIndex = grid.renderContainers.body.visibleColumnCache.indexOf( upToCol ); + + // total column widths up-to but not including the passed in column + grid.renderContainers.body.visibleColumnCache.forEach( function( col, index ) { + if ( index < lastIndex ) { + width += col.drawnWidth; + } + }); + + // pro-rata the final column based on % of total columns. + var percentage = lastIndex === 0 ? 0 : (lastIndex + 1) / grid.renderContainers.body.visibleColumnCache.length; + width += upToCol.drawnWidth * percentage; + + return width; + } + }; + + return service; + }]); + + /** + * @ngdoc directive + * @name ui.grid.cellNav.directive:uiCellNav + * @element div + * @restrict EA + * + * @description Adds cell navigation features to the grid columns + * + * @example +
+
+
+ ' +
+ ' ' +
+ ' ';
+
+ var ariaNotifier = $compile(ariaNotifierDomElt)($scope);
+ $elm.prepend(ariaNotifier);
+ $scope.$on(uiGridCellNavConstants.CELL_NAV_EVENT, function (evt, rowCol, modifierDown, originEvt) {
+ /*
+ * If the cell nav event was because of a focus event then we don't want to
+ * change the notifier text.
+ * Reasoning: Voice Over fires a focus events when moving arround the grid.
+ * If the screen reader is handing the grid nav properly then we don't need to
+ * use the alert to notify the user of the movement.
+ * In all other cases we do want a notification event.
+ */
+ if (originEvt && originEvt.type === 'focus') {return;}
+
+ function setNotifyText(text) {
+ if (text === ariaNotifier.text().trim()) {return;}
+ ariaNotifier[0].style.clip = 'rect(0px,0px,0px,0px)';
+ /*
+ * This is how google docs handles clearing the div. Seems to work better than setting the text of the div to ''
+ */
+ ariaNotifier[0].innerHTML = "";
+ ariaNotifier[0].style.visibility = 'hidden';
+ ariaNotifier[0].style.visibility = 'visible';
+ if (text !== '') {
+ ariaNotifier[0].style.clip = 'auto';
+ /*
+ * The space after the text is something that google docs does.
+ */
+ ariaNotifier[0].appendChild(document.createTextNode(text + " "));
+ ariaNotifier[0].style.visibility = 'hidden';
+ ariaNotifier[0].style.visibility = 'visible';
+ }
+ }
+
+ function getAppendedColumnHeaderText(col) {
+ return ', ' + i18nService.getSafeText('headerCell.aria.column') + ' ' + col.displayName;
+ }
+
+ function getCellDisplayValue(currentRowColumn) {
+ if (currentRowColumn.col.field === 'selectionRowHeaderCol') {
+ // This is the case when the 'selection' feature is used in the grid and the user has moved
+ // to or inside of the left grid container which holds the checkboxes for selecting rows.
+ // This is necessary for Accessibility. Without this a screen reader cannot determine if the row
+ // is or is not currently selected.
+ return currentRowColumn.row.isSelected ? i18nService.getSafeText('search.aria.selected') : i18nService.getSafeText('search.aria.notSelected');
+ } else {
+ return grid.getCellDisplayValue(currentRowColumn.row, currentRowColumn.col);
+ }
+ }
+
+ var values = [];
+ var currentSelection = grid.api.cellNav.getCurrentSelection();
+ for (var i = 0; i < currentSelection.length; i++) {
+ var cellDisplayValue = getCellDisplayValue(currentSelection[i]) + getAppendedColumnHeaderText(currentSelection[i].col);
+ values.push(cellDisplayValue);
+ }
+ var cellText = values.toString();
+ setNotifyText(cellText);
+
+ });
+ }
+ // Only add the ngAria stuff it will be used
+ if (usesAria) {
+ addAriaLiveRegion();
+ }
+ }
+ };
+ }
+ };
+ }]);
+
+ module.directive('uiGridRenderContainer', ['$timeout', '$document', 'gridUtil', 'uiGridConstants', 'uiGridCellNavService', '$compile','uiGridCellNavConstants',
+ function ($timeout, $document, gridUtil, uiGridConstants, uiGridCellNavService, $compile, uiGridCellNavConstants) {
+ return {
+ replace: true,
+ priority: -99999, // this needs to run very last
+ require: ['^uiGrid', 'uiGridRenderContainer', '?^uiGridCellnav'],
+ scope: false,
+ compile: function () {
+ return {
+ post: function ($scope, $elm, $attrs, controllers) {
+ var uiGridCtrl = controllers[0],
+ renderContainerCtrl = controllers[1],
+ uiGridCellnavCtrl = controllers[2];
+
+ // Skip attaching cell-nav specific logic if the directive is not attached above us
+ if (!uiGridCtrl.grid.api.cellNav) { return; }
+
+ var containerId = renderContainerCtrl.containerId;
+
+ var grid = uiGridCtrl.grid;
+
+ // run each time a render container is created
+ uiGridCellNavService.decorateRenderContainers(grid);
+
+ // focusser only created for body
+ if (containerId !== 'body') {
+ return;
+ }
+
+ if (uiGridCtrl.grid.options.modifierKeysToMultiSelectCells) {
+ $elm.attr('aria-multiselectable', true);
+ }
+ else {
+ $elm.attr('aria-multiselectable', false);
+ }
+
+ // add an element with no dimensions that can be used to set focus and capture keystrokes
+ var focuser = $compile('')($scope);
+ $elm.append(focuser);
+
+ focuser.on('focus', function (evt) {
+ evt.uiGridTargetRenderContainerId = containerId;
+ var rowCol = uiGridCtrl.grid.api.cellNav.getFocusedCell();
+ if (rowCol === null) {
+ rowCol = uiGridCtrl.grid.renderContainers[containerId].cellNav.getNextRowCol(uiGridCellNavConstants.direction.DOWN, null, null);
+ if (rowCol.row && rowCol.col) {
+ uiGridCtrl.cellNav.broadcastCellNav(rowCol);
+ }
+ }
+ });
+
+ uiGridCellnavCtrl.setAriaActivedescendant = function(id) {
+ $elm.attr('aria-activedescendant', id);
+ };
+
+ uiGridCellnavCtrl.removeAriaActivedescendant = function(id) {
+ if ($elm.attr('aria-activedescendant') === id) {
+ $elm.attr('aria-activedescendant', '');
+ }
+ };
+
+
+ uiGridCtrl.focus = function () {
+ gridUtil.focus.byElement(focuser[0]);
+ // allow for first time grid focus
+ };
+
+ var viewPortKeyDownWasRaisedForRowCol = null;
+ // Bind to keydown events in the render container
+ focuser.on('keydown', function (evt) {
+ evt.uiGridTargetRenderContainerId = containerId;
+ var rowCol = uiGridCtrl.grid.api.cellNav.getFocusedCell();
+ var raiseViewPortKeyDown = uiGridCtrl.grid.options.keyDownOverrides.some(function (override) {
+ return Object.keys(override).every( function (property) {
+ return override[property] === evt[property];
+ });
+ });
+ var result = raiseViewPortKeyDown ? null : uiGridCtrl.cellNav.handleKeyDown(evt);
+ if (result === null) {
+ uiGridCtrl.grid.api.cellNav.raise.viewPortKeyDown(evt, rowCol, uiGridCtrl.cellNav.handleKeyDown);
+ viewPortKeyDownWasRaisedForRowCol = rowCol;
+ }
+ });
+ // Bind to keypress events in the render container
+ // keypress events are needed by edit function so the key press
+ // that initiated an edit is not lost
+ // must fire the event in a timeout so the editor can
+ // initialize and subscribe to the event on another event loop
+ focuser.on('keypress', function (evt) {
+ if (viewPortKeyDownWasRaisedForRowCol) {
+ $timeout(function () {
+ uiGridCtrl.grid.api.cellNav.raise.viewPortKeyPress(evt, viewPortKeyDownWasRaisedForRowCol);
+ }, 4);
+
+ viewPortKeyDownWasRaisedForRowCol = null;
+ }
+ });
+
+ $scope.$on('$destroy', function() {
+ // Remove all event handlers associated with this focuser.
+ focuser.off();
+ });
+ }
+ };
+ }
+ };
+ }]);
+
+ module.directive('uiGridViewport',
+ function () {
+ return {
+ replace: true,
+ priority: -99999, // this needs to run very last
+ require: ['^uiGrid', '^uiGridRenderContainer', '?^uiGridCellnav'],
+ scope: false,
+ compile: function () {
+ return {
+ pre: function ($scope, $elm, $attrs, uiGridCtrl) {
+ },
+ post: function ($scope, $elm, $attrs, controllers) {
+ var uiGridCtrl = controllers[0],
+ renderContainerCtrl = controllers[1];
+
+ // Skip attaching cell-nav specific logic if the directive is not attached above us
+ if (!uiGridCtrl.grid.api.cellNav) { return; }
+
+ var containerId = renderContainerCtrl.containerId;
+ // no need to process for other containers
+ if (containerId !== 'body') {
+ return;
+ }
+
+ var grid = uiGridCtrl.grid;
+
+ grid.api.core.on.scrollBegin($scope, function () {
+
+ // Skip if there's no currently-focused cell
+ var lastRowCol = uiGridCtrl.grid.api.cellNav.getFocusedCell();
+ if (lastRowCol === null) {
+ return;
+ }
+
+ // if not in my container, move on
+ // todo: worry about horiz scroll
+ if (!renderContainerCtrl.colContainer.containsColumn(lastRowCol.col)) {
+ return;
+ }
+
+ uiGridCtrl.cellNav.clearFocus();
+
+ });
+
+ grid.api.core.on.scrollEnd($scope, function (args) {
+ // Skip if there's no currently-focused cell
+ var lastRowCol = uiGridCtrl.grid.api.cellNav.getFocusedCell();
+ if (lastRowCol === null) {
+ return;
+ }
+
+ // if not in my container, move on
+ // todo: worry about horiz scroll
+ if (!renderContainerCtrl.colContainer.containsColumn(lastRowCol.col)) {
+ return;
+ }
+
+ uiGridCtrl.cellNav.broadcastCellNav(lastRowCol);
+ });
+
+ grid.api.cellNav.on.navigate($scope, function () {
+ // focus again because it can be lost
+ uiGridCtrl.focus();
+ });
+ }
+ };
+ }
+ };
+ });
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.cellNav.directive:uiGridCell
+ * @element div
+ * @restrict A
+ * @description Stacks on top of ui.grid.uiGridCell to provide cell navigation
+ */
+ module.directive('uiGridCell', ['$timeout', '$document', 'uiGridCellNavService', 'gridUtil', 'uiGridCellNavConstants', 'uiGridConstants', 'GridRowColumn',
+ function ($timeout, $document, uiGridCellNavService, gridUtil, uiGridCellNavConstants, uiGridConstants, GridRowColumn) {
+ return {
+ priority: -150, // run after default uiGridCell directive and ui.grid.edit uiGridCell
+ restrict: 'A',
+ require: ['^uiGrid', '?^uiGridCellnav'],
+ scope: false,
+ link: function ($scope, $elm, $attrs, controllers) {
+ var uiGridCtrl = controllers[0],
+ uiGridCellnavCtrl = controllers[1];
+ // Skip attaching cell-nav specific logic if the directive is not attached above us
+ if (!uiGridCtrl.grid.api.cellNav) { return; }
+
+ if (!$scope.col.colDef.allowCellFocus) {
+ return;
+ }
+
+ // Convinience local variables
+ var grid = uiGridCtrl.grid;
+ $scope.focused = false;
+
+ // Make this cell focusable but only with javascript/a mouse click
+ $elm.attr('tabindex', -1);
+
+ // When a cell is clicked, broadcast a cellNav event saying that this row+col combo is now focused
+ $elm.find('div').on('click', function (evt) {
+ uiGridCtrl.cellNav.broadcastCellNav(new GridRowColumn($scope.row, $scope.col), evt.ctrlKey || evt.metaKey, evt);
+
+ evt.stopPropagation();
+ $scope.$apply();
+ });
+
+
+ /*
+ * XXX Hack for screen readers.
+ * This allows the grid to focus using only the screen reader cursor.
+ * Since the focus event doesn't include key press information we can't use it
+ * as our primary source of the event.
+ */
+ $elm.on('mousedown', preventMouseDown);
+
+ // turn on and off for edit events
+ if (uiGridCtrl.grid.api.edit) {
+ uiGridCtrl.grid.api.edit.on.beginCellEdit($scope, function () {
+ $elm.off('mousedown', preventMouseDown);
+ });
+
+ uiGridCtrl.grid.api.edit.on.afterCellEdit($scope, function () {
+ $elm.on('mousedown', preventMouseDown);
+ });
+
+ uiGridCtrl.grid.api.edit.on.cancelCellEdit($scope, function () {
+ $elm.on('mousedown', preventMouseDown);
+ });
+ }
+
+ // In case we created a new row, and we are the new created row by ngRepeat
+ // then this cell content might have been selected previously
+ refreshCellFocus();
+
+ function preventMouseDown(evt) {
+ // Prevents the foucus event from firing if the click event is already going to fire.
+ // If both events fire it will cause bouncing behavior.
+ evt.preventDefault();
+ }
+
+ // You can only focus on elements with a tabindex value
+ $elm.on('focus', function (evt) {
+ uiGridCtrl.cellNav.broadcastCellNav(new GridRowColumn($scope.row, $scope.col), false, evt);
+ evt.stopPropagation();
+ $scope.$apply();
+ });
+
+ // This event is fired for all cells. If the cell matches, then focus is set
+ $scope.$on(uiGridCellNavConstants.CELL_NAV_EVENT, refreshCellFocus);
+
+ // Refresh cell focus when a new row id added to the grid
+ var dataChangeDereg = uiGridCtrl.grid.registerDataChangeCallback(function (grid) {
+ // Clear the focus if it's set to avoid the wrong cell getting focused during
+ // a short period of time (from now until $timeout function executed)
+ clearFocus();
+
+ $scope.$applyAsync(refreshCellFocus);
+ }, [uiGridConstants.dataChange.ROW]);
+
+ function refreshCellFocus() {
+ var isFocused = grid.cellNav.focusedCells.some(function (focusedRowCol, index) {
+ return (focusedRowCol.row === $scope.row && focusedRowCol.col === $scope.col);
+ });
+ if (isFocused) {
+ setFocused();
+ } else {
+ clearFocus();
+ }
+ }
+
+ function setFocused() {
+ if (!$scope.focused) {
+ var div = $elm.find('div');
+ div.addClass('ui-grid-cell-focus');
+ $elm.attr('aria-selected', true);
+ uiGridCellnavCtrl.setAriaActivedescendant($elm.attr('id'));
+ $scope.focused = true;
+ }
+ }
+
+ function clearFocus() {
+ if ($scope.focused) {
+ var div = $elm.find('div');
+ div.removeClass('ui-grid-cell-focus');
+ $elm.attr('aria-selected', false);
+ uiGridCellnavCtrl.removeAriaActivedescendant($elm.attr('id'));
+ $scope.focused = false;
+ }
+ }
+
+ $scope.$on('$destroy', function () {
+ dataChangeDereg();
+
+ // .off withouth paramaters removes all handlers
+ $elm.find('div').off();
+ $elm.off();
+ });
+ }
+ };
+ }]);
+})();
diff --git a/release/4.9.2/ui-grid.cellnav.min.js b/release/4.9.2/ui-grid.cellnav.min.js
new file mode 100644
index 000000000..039383f41
--- /dev/null
+++ b/release/4.9.2/ui-grid.cellnav.min.js
@@ -0,0 +1,7 @@
+/*!
+ * ui-grid - v4.9.2 - 2020-12-01
+ * Copyright (c) 2020 ; License: MIT
+ */
+
+
+!function(){"use strict";var e=angular.module("ui.grid.cellNav",["ui.grid"]);e.constant("uiGridCellNavConstants",{FEATURE_NAME:"gridCellNav",CELL_NAV_EVENT:"cellNav",direction:{LEFT:0,RIGHT:1,UP:2,DOWN:3,PG_UP:4,PG_DOWN:5},EVENT_TYPE:{KEYDOWN:0,CLICK:1,CLEAR:2}}),e.factory("uiGridCellNavFactory",["gridUtil","uiGridConstants","uiGridCellNavConstants","GridRowColumn","$q",function(e,l,o,a,i){var n=function(e,l,i,o){this.rows=e.visibleRowCache,this.columns=l.visibleColumnCache,this.leftColumns=i?i.visibleColumnCache:[],this.rightColumns=o?o.visibleColumnCache:[],this.bodyContainer=e};return n.prototype.getFocusableCols=function(){return this.leftColumns.concat(this.columns,this.rightColumns).filter(function(e){return e.colDef.allowCellFocus})},n.prototype.getFocusableRows=function(){return this.rows.filter(function(e){return!1!==e.allowCellFocus})},n.prototype.getNextRowCol=function(e,l,i){switch(e){case o.direction.LEFT:return this.getRowColLeft(l,i);case o.direction.RIGHT:return this.getRowColRight(l,i);case o.direction.UP:return this.getRowColUp(l,i);case o.direction.DOWN:return this.getRowColDown(l,i);case o.direction.PG_UP:return this.getRowColPageUp(l,i);case o.direction.PG_DOWN:return this.getRowColPageDown(l,i)}},n.prototype.initializeSelection=function(){var e=this.getFocusableCols(),l=this.getFocusableRows();return 0===e.length||0===l.length?null:new a(l[0],e[0])},n.prototype.getRowColLeft=function(e,l){var i=this.getFocusableCols(),o=this.getFocusableRows(),n=i.indexOf(l),t=o.indexOf(e);-1===n&&(n=1);var r=0===n?i.length-1:n-1;return new a(n<=r?0===t?e:o[t-1]:e,i[r])},n.prototype.getRowColRight=function(e,l){var i=this.getFocusableCols(),o=this.getFocusableRows(),n=i.indexOf(l),t=o.indexOf(e);-1===n&&(n=0);var r=n===i.length-1?0:n+1;return r<=n?t===o.length-1?new a(e,i[r]):new a(o[t+1],i[r]):new a(e,i[r])},n.prototype.getRowColDown=function(e,l){var i=this.getFocusableCols(),o=this.getFocusableRows(),n=i.indexOf(l),t=o.indexOf(e);return-1===n&&(n=0),t===o.length-1?new a(e,i[n]):new a(o[t+1],i[n])},n.prototype.getRowColPageDown=function(e,l){var i=this.getFocusableCols(),o=this.getFocusableRows(),n=i.indexOf(l),t=o.indexOf(e);-1===n&&(n=0);var r=this.bodyContainer.minRowsToRender();return t>=o.length-r?new a(o[o.length-1],i[n]):new a(o[t+r],i[n])},n.prototype.getRowColUp=function(e,l){var i=this.getFocusableCols(),o=this.getFocusableRows(),n=i.indexOf(l),t=o.indexOf(e);return-1===n&&(n=0),new a(0===t?e:o[t-1],i[n])},n.prototype.getRowColPageUp=function(e,l){var i=this.getFocusableCols(),o=this.getFocusableRows(),n=i.indexOf(l),t=o.indexOf(e);-1===n&&(n=0);var r=this.bodyContainer.minRowsToRender();return new a(t-r<0?o[0]:o[t-r],i[n])},n}]),e.service("uiGridCellNavService",["gridUtil","uiGridConstants","uiGridCellNavConstants","$q","uiGridCellNavFactory","GridRowColumn","ScrollEvent",function(e,l,i,o,n,t,r){var a={initializeGrid:function(o){o.registerColumnBuilder(a.cellNavColumnBuilder),o.cellNav={},o.cellNav.lastRowCol=null,o.cellNav.focusedCells=[],a.defaultGridOptions(o.options);var e={events:{cellNav:{navigate:function(e,l){},viewPortKeyDown:function(e,l){},viewPortKeyPress:function(e,l){}}},methods:{cellNav:{scrollToFocus:function(e,l){return a.scrollToFocus(o,e,l)},getFocusedCell:function(){return o.cellNav.lastRowCol},getCurrentSelection:function(){return o.cellNav.focusedCells},rowColSelectIndex:function(e){for(var l=-1,i=0;i
+ * .ui-grid-column-menu-button {
+ * display: block;
+ * }
+ *
+ */
+ /**
+ * @ngdoc property
+ * @name enableColumnMenus
+ * @propertyOf ui.grid.class:GridOptions.columnDef
+ * @description Override for column menus everywhere - if set to false then you get no
+ * column menus. Defaults to true.
+ *
+ */
+
+ $scope.offAllEvents();
+
+ if ($scope.sortable || $scope.colMenu) {
+ $scope.onDownEvents();
+
+ $scope.$on('$destroy', function () {
+ $scope.offAllEvents();
+ });
+ }
+ };
+
+ updateHeaderOptions();
+
+ if ($scope.col.filterContainer === 'columnMenu' && $scope.col.filterable) {
+ $rootScope.$on('menu-shown', function() {
+ $scope.$applyAsync(function () {
+ setFilter($scope.col.filterable);
+ });
+ });
+ }
+
+ // Register a data change watch that would get triggered whenever someone edits a cell or modifies column defs
+ var dataChangeDereg = $scope.grid.registerDataChangeCallback( updateHeaderOptions, [uiGridConstants.dataChange.COLUMN]);
+
+ $scope.$on( '$destroy', dataChangeDereg );
+
+ $scope.handleClick = function(event) {
+ // If the shift key is being held down, add this column to the sort
+ var add = false;
+ if (event.shiftKey) {
+ add = true;
+ }
+
+ // Sort this column then rebuild the grid's rows
+ uiGridCtrl.grid.sortColumn($scope.col, add)
+ .then(function () {
+ if (uiGridCtrl.columnMenuScope) { uiGridCtrl.columnMenuScope.hideMenu(); }
+ uiGridCtrl.grid.refresh();
+ }).catch(angular.noop);
+ };
+
+ $scope.headerCellArrowKeyDown = function(event) {
+ if (event.keyCode === 32 || event.keyCode === 13) {
+ event.preventDefault();
+ $scope.toggleMenu(event);
+ }
+ };
+
+ $scope.toggleMenu = function(event) {
+
+ event.stopPropagation();
+
+ // If the menu is already showing...
+ if (uiGridCtrl.columnMenuScope.menuShown) {
+ // ... and we're the column the menu is on...
+ if (uiGridCtrl.columnMenuScope.col === $scope.col) {
+ // ... hide it
+ uiGridCtrl.columnMenuScope.hideMenu();
+ }
+ // ... and we're NOT the column the menu is on
+ else {
+ // ... move the menu to our column
+ uiGridCtrl.columnMenuScope.showMenu($scope.col, $elm);
+ }
+ }
+ // If the menu is NOT showing
+ else {
+ // ... show it on our column
+ uiGridCtrl.columnMenuScope.showMenu($scope.col, $elm);
+ }
+ };
+ }
+ };
+ }
+ };
+ }]);
+})();
+
+(function() {
+ 'use strict';
+
+ angular.module('ui.grid').directive('uiGridHeader', ['$templateCache', '$compile', 'uiGridConstants', 'gridUtil', '$timeout', 'ScrollEvent',
+ function($templateCache, $compile, uiGridConstants, gridUtil, $timeout, ScrollEvent) {
+ var defaultTemplate = 'ui-grid/ui-grid-header',
+ emptyTemplate = 'ui-grid/ui-grid-no-header';
+
+ return {
+ restrict: 'EA',
+ replace: true,
+ require: ['^uiGrid', '^uiGridRenderContainer'],
+ scope: true,
+ compile: function() {
+ return {
+ pre: function ($scope, $elm, $attrs, controllers) {
+ var uiGridCtrl = controllers[0],
+ containerCtrl = controllers[1];
+
+ $scope.grid = uiGridCtrl.grid;
+ $scope.colContainer = containerCtrl.colContainer;
+
+ updateHeaderReferences();
+
+ var headerTemplate;
+ if (!$scope.grid.options.showHeader) {
+ headerTemplate = emptyTemplate;
+ }
+ else {
+ headerTemplate = ($scope.grid.options.headerTemplate) ? $scope.grid.options.headerTemplate : defaultTemplate;
+ }
+
+ gridUtil.getTemplate(headerTemplate)
+ .then(function (contents) {
+ var template = angular.element(contents);
+
+ var newElm = $compile(template)($scope);
+ $elm.replaceWith(newElm);
+
+ // And update $elm to be the new element
+ $elm = newElm;
+
+ updateHeaderReferences();
+
+ if (containerCtrl) {
+ // Inject a reference to the header viewport (if it exists) into the grid controller for use in the horizontal scroll handler below
+ var headerViewport = $elm[0].getElementsByClassName('ui-grid-header-viewport')[0];
+
+
+ if (headerViewport) {
+ containerCtrl.headerViewport = headerViewport;
+ angular.element(headerViewport).on('scroll', scrollHandler);
+ $scope.$on('$destroy', function () {
+ angular.element(headerViewport).off('scroll', scrollHandler);
+ });
+ }
+ }
+
+ $scope.grid.queueRefresh();
+ }).catch(angular.noop);
+
+ function updateHeaderReferences() {
+ containerCtrl.header = containerCtrl.colContainer.header = $elm;
+
+ var headerCanvases = $elm[0].getElementsByClassName('ui-grid-header-canvas');
+
+ if (headerCanvases.length > 0) {
+ containerCtrl.headerCanvas = containerCtrl.colContainer.headerCanvas = headerCanvases[0];
+ }
+ else {
+ containerCtrl.headerCanvas = null;
+ }
+ }
+
+ function scrollHandler() {
+ if (uiGridCtrl.grid.isScrollingHorizontally) {
+ return;
+ }
+ var newScrollLeft = gridUtil.normalizeScrollLeft(containerCtrl.headerViewport, uiGridCtrl.grid);
+ var horizScrollPercentage = containerCtrl.colContainer.scrollHorizontal(newScrollLeft);
+
+ var scrollEvent = new ScrollEvent(uiGridCtrl.grid, null, containerCtrl.colContainer, ScrollEvent.Sources.ViewPortScroll);
+ scrollEvent.newScrollLeft = newScrollLeft;
+ if ( horizScrollPercentage > -1 ) {
+ scrollEvent.x = { percentage: horizScrollPercentage };
+ }
+
+ uiGridCtrl.grid.scrollContainers(null, scrollEvent);
+ }
+ },
+
+ post: function ($scope, $elm, $attrs, controllers) {
+ var uiGridCtrl = controllers[0];
+ var containerCtrl = controllers[1];
+
+ // gridUtil.logDebug('ui-grid-header link');
+
+ var grid = uiGridCtrl.grid;
+
+ // Don't animate header cells
+ gridUtil.disableAnimations($elm);
+
+ function updateColumnWidths() {
+ // this styleBuilder always runs after the renderContainer, so we can rely on the column widths
+ // already being populated correctly
+
+ var columnCache = containerCtrl.colContainer.visibleColumnCache;
+
+ // Build the CSS
+ // uiGridCtrl.grid.columns.forEach(function (column) {
+ var ret = '';
+ var canvasWidth = 0;
+ columnCache.forEach(function (column) {
+ ret = ret + column.getColClassDefinition();
+ canvasWidth += column.drawnWidth;
+ });
+
+ containerCtrl.colContainer.canvasWidth = canvasWidth;
+
+ // Return the styles back to buildStyles which pops them into the `customStyles` scope variable
+ return ret;
+ }
+
+ containerCtrl.header = $elm;
+
+ var headerViewport = $elm[0].getElementsByClassName('ui-grid-header-viewport')[0];
+ if (headerViewport) {
+ containerCtrl.headerViewport = headerViewport;
+ }
+
+ // todo: remove this if by injecting gridCtrl into unit tests
+ if (uiGridCtrl) {
+ uiGridCtrl.grid.registerStyleComputation({
+ priority: 15,
+ func: updateColumnWidths
+ });
+ }
+ }
+ };
+ }
+ };
+ }]);
+})();
+
+(function() {
+
+angular.module('ui.grid')
+.service('uiGridGridMenuService', [ 'gridUtil', 'i18nService', 'uiGridConstants', function( gridUtil, i18nService, uiGridConstants ) {
+ /**
+ * @ngdoc service
+ * @name ui.grid.uiGridGridMenuService
+ *
+ * @description Methods for working with the grid menu
+ */
+
+ var service = {
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.uiGridGridMenuService
+ * @name initialize
+ * @description Sets up the gridMenu. Most importantly, sets our
+ * scope onto the grid object as grid.gridMenuScope, allowing us
+ * to operate when passed only the grid. Second most importantly,
+ * we register the 'addToGridMenu' and 'removeFromGridMenu' methods
+ * on the core api.
+ * @param {$scope} $scope the scope of this gridMenu
+ * @param {Grid} grid the grid to which this gridMenu is associated
+ */
+ initialize: function( $scope, grid ) {
+ grid.gridMenuScope = $scope;
+ $scope.grid = grid;
+ $scope.registeredMenuItems = [];
+
+ // not certain this is needed, but would be bad to create a memory leak
+ $scope.$on('$destroy', function() {
+ if ( $scope.grid && $scope.grid.gridMenuScope ) {
+ $scope.grid.gridMenuScope = null;
+ }
+ if ( $scope.grid ) {
+ $scope.grid = null;
+ }
+ if ( $scope.registeredMenuItems ) {
+ $scope.registeredMenuItems = null;
+ }
+ });
+
+ $scope.registeredMenuItems = [];
+
+ /**
+ * @ngdoc function
+ * @name addToGridMenu
+ * @methodOf ui.grid.api:PublicApi
+ * @description add items to the grid menu. Used by features
+ * to add their menu items if they are enabled, can also be used by
+ * end users to add menu items. This method has the advantage of allowing
+ * remove again, which can simplify management of which items are included
+ * in the menu when. (Noting that in most cases the shown and active functions
+ * provide a better way to handle visibility of menu items)
+ * @param {Grid} grid the grid on which we are acting
+ * @param {array} items menu items in the format as described in the tutorial, with
+ * the added note that if you want to use remove you must also specify an `id` field,
+ * which is provided when you want to remove an item. The id should be unique.
+ *
+ */
+ grid.api.registerMethod( 'core', 'addToGridMenu', service.addToGridMenu );
+
+ /**
+ * @ngdoc function
+ * @name removeFromGridMenu
+ * @methodOf ui.grid.api:PublicApi
+ * @description Remove an item from the grid menu based on a provided id. Assumes
+ * that the id is unique, removes only the last instance of that id. Does nothing if
+ * the specified id is not found
+ * @param {Grid} grid the grid on which we are acting
+ * @param {string} id the id we'd like to remove from the menu
+ *
+ */
+ grid.api.registerMethod( 'core', 'removeFromGridMenu', service.removeFromGridMenu );
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name addToGridMenu
+ * @propertyOf ui.grid.uiGridGridMenuService
+ * @description add items to the grid menu. Used by features
+ * to add their menu items if they are enabled, can also be used by
+ * end users to add menu items. This method has the advantage of allowing
+ * remove again, which can simplify management of which items are included
+ * in the menu when. (Noting that in most cases the shown and active functions
+ * provide a better way to handle visibility of menu items)
+ * @param {Grid} grid the grid on which we are acting
+ * @param {array} menuItems menu items in the format as described in the tutorial, with
+ * the added note that if you want to use remove you must also specify an `id` field,
+ * which is provided when you want to remove an item. The id should be unique.
+ *
+ */
+ addToGridMenu: function( grid, menuItems ) {
+ if ( !angular.isArray( menuItems ) ) {
+ gridUtil.logError( 'addToGridMenu: menuItems must be an array, and is not, not adding any items');
+ } else {
+ if ( grid.gridMenuScope ) {
+ grid.gridMenuScope.registeredMenuItems = grid.gridMenuScope.registeredMenuItems ? grid.gridMenuScope.registeredMenuItems : [];
+ grid.gridMenuScope.registeredMenuItems = grid.gridMenuScope.registeredMenuItems.concat( menuItems );
+ } else {
+ gridUtil.logError( 'Asked to addToGridMenu, but gridMenuScope not present. Timing issue? Please log issue with ui-grid');
+ }
+ }
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name removeFromGridMenu
+ * @methodOf ui.grid.uiGridGridMenuService
+ * @description Remove an item from the grid menu based on a provided id. Assumes
+ * that the id is unique, removes only the last instance of that id. Does nothing if
+ * the specified id is not found. If there is no gridMenuScope or registeredMenuItems
+ * then do nothing silently - the desired result is those menu items not be present and they
+ * aren't.
+ * @param {Grid} grid the grid on which we are acting
+ * @param {string} id the id we'd like to remove from the menu
+ *
+ */
+ removeFromGridMenu: function( grid, id ) {
+ var foundIndex = -1;
+
+ if ( grid && grid.gridMenuScope ) {
+ grid.gridMenuScope.registeredMenuItems.forEach( function( value, index ) {
+ if ( value.id === id ) {
+ if (foundIndex > -1) {
+ gridUtil.logError( 'removeFromGridMenu: found multiple items with the same id, removing only the last' );
+ } else {
+
+ foundIndex = index;
+ }
+ }
+ });
+ }
+
+ if ( foundIndex > -1 ) {
+ grid.gridMenuScope.registeredMenuItems.splice( foundIndex, 1 );
+ }
+ },
+
+
+ /**
+ * @ngdoc array
+ * @name gridMenuCustomItems
+ * @propertyOf ui.grid.class:GridOptions
+ * @description (optional) An array of menu items that should be added to
+ * the gridMenu. Follow the format documented in the tutorial for column
+ * menu customisation. The context provided to the action function will
+ * include context.grid. An alternative if working with dynamic menus is to use the
+ * provided api - core.addToGridMenu and core.removeFromGridMenu, which handles
+ * some of the management of items for you.
+ *
+ */
+ /**
+ * @ngdoc boolean
+ * @name gridMenuShowHideColumns
+ * @propertyOf ui.grid.class:GridOptions
+ * @description true by default, whether the grid menu should allow hide/show
+ * of columns
+ *
+ */
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.uiGridGridMenuService
+ * @name getMenuItems
+ * @description Decides the menu items to show in the menu. This is a
+ * combination of:
+ *
+ * - the default menu items that are always included,
+ * - any menu items that have been provided through the addMenuItem api. These
+ * are typically added by features within the grid
+ * - any menu items included in grid.options.gridMenuCustomItems. These can be
+ * changed dynamically, as they're always recalculated whenever we show the
+ * menu
+ * @param {$scope} $scope the scope of this gridMenu, from which we can find all
+ * the information that we need
+ * @returns {Array} an array of menu items that can be shown
+ */
+ getMenuItems: function( $scope ) {
+ var menuItems = [
+ // this is where we add any menu items we want to always include
+ ];
+
+ if ( $scope.grid.options.gridMenuCustomItems ) {
+ if ( !angular.isArray( $scope.grid.options.gridMenuCustomItems ) ) {
+ gridUtil.logError( 'gridOptions.gridMenuCustomItems must be an array, and is not');
+ } else {
+ menuItems = menuItems.concat( $scope.grid.options.gridMenuCustomItems );
+ }
+ }
+
+ var clearFilters = [{
+ title: i18nService.getSafeText('gridMenu.clearAllFilters'),
+ action: function ($event) {
+ $scope.grid.clearAllFilters();
+ },
+ shown: function() {
+ return $scope.grid.options.enableFiltering;
+ },
+ order: 100
+ }];
+ menuItems = menuItems.concat( clearFilters );
+
+ menuItems = menuItems.concat( $scope.registeredMenuItems );
+
+ if ( $scope.grid.options.gridMenuShowHideColumns !== false ) {
+ menuItems = menuItems.concat( service.showHideColumns( $scope ) );
+ }
+
+ menuItems.sort(function(a, b) {
+ return a.order - b.order;
+ });
+
+ return menuItems;
+ },
+
+
+ /**
+ * @ngdoc array
+ * @name gridMenuTitleFilter
+ * @propertyOf ui.grid.class:GridOptions
+ * @description (optional) A function that takes a title string
+ * (usually the col.displayName), and converts it into a display value. The function
+ * must return either a string or a promise.
+ *
+ * Used for internationalization of the grid menu column names - for angular-translate
+ * you can pass $translate as the function, for i18nService you can pass getSafeText as the
+ * function
+ * @example
+ *
+ * gridOptions = {
+ * gridMenuTitleFilter: $translate
+ * }
+ *
+ */
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.uiGridGridMenuService
+ * @name showHideColumns
+ * @description Adds two menu items for each of the columns in columnDefs. One
+ * menu item for hide, one menu item for show. Each is visible when appropriate
+ * (show when column is not visible, hide when column is visible). Each toggles
+ * the visible property on the columnDef using toggleColumnVisibility
+ * @param {$scope} $scope of a gridMenu, which contains a reference to the grid
+ */
+ showHideColumns: function( $scope ) {
+ var showHideColumns = [];
+ if ( !$scope.grid.options.columnDefs || $scope.grid.options.columnDefs.length === 0 || $scope.grid.columns.length === 0 ) {
+ return showHideColumns;
+ }
+
+ function isColumnVisible(colDef) {
+ return colDef.visible === true || colDef.visible === undefined;
+ }
+
+ function getColumnIcon(colDef) {
+ return isColumnVisible(colDef) ? 'ui-grid-icon-ok' : 'ui-grid-icon-cancel';
+ }
+
+ // add header for columns
+ showHideColumns.push({
+ title: i18nService.getSafeText('gridMenu.columns'),
+ order: 300,
+ templateUrl: 'ui-grid/ui-grid-menu-header-item'
+ });
+
+ $scope.grid.options.gridMenuTitleFilter = $scope.grid.options.gridMenuTitleFilter ? $scope.grid.options.gridMenuTitleFilter : function( title ) { return title; };
+
+ $scope.grid.options.columnDefs.forEach( function( colDef, index ) {
+ if ( colDef.enableHiding !== false ) {
+ // add hide menu item - shows an OK icon as we only show when column is already visible
+ var menuItem = {
+ icon: getColumnIcon(colDef),
+ action: function($event) {
+ $event.stopPropagation();
+
+ service.toggleColumnVisibility( this.context.gridCol );
+
+ if ($event.target && $event.target.firstChild) {
+ if (angular.element($event.target)[0].nodeName === 'I') {
+ $event.target.className = getColumnIcon(this.context.gridCol.colDef);
+ }
+ else {
+ $event.target.firstChild.className = getColumnIcon(this.context.gridCol.colDef);
+ }
+ }
+ },
+ shown: function() {
+ return this.context.gridCol.colDef.enableHiding !== false;
+ },
+ context: { gridCol: $scope.grid.getColumn(colDef.name || colDef.field) },
+ leaveOpen: true,
+ order: 301 + index
+ };
+ service.setMenuItemTitle( menuItem, colDef, $scope.grid );
+ showHideColumns.push( menuItem );
+ }
+ });
+ return showHideColumns;
+ },
+
+
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.uiGridGridMenuService
+ * @name setMenuItemTitle
+ * @description Handles the response from gridMenuTitleFilter, adding it directly to the menu
+ * item if it returns a string, otherwise waiting for the promise to resolve or reject then
+ * putting the result into the title
+ * @param {object} menuItem the menuItem we want to put the title on
+ * @param {object} colDef the colDef from which we can get displayName, name or field
+ * @param {Grid} grid the grid, from which we can get the options.gridMenuTitleFilter
+ *
+ */
+ setMenuItemTitle: function( menuItem, colDef, grid ) {
+ var title = grid.options.gridMenuTitleFilter( colDef.displayName || gridUtil.readableColumnName(colDef.name) || colDef.field );
+
+ if ( typeof(title) === 'string' ) {
+ menuItem.title = title;
+ } else if ( title.then ) {
+ // must be a promise
+ menuItem.title = "";
+ title.then( function( successValue ) {
+ menuItem.title = successValue;
+ }, function( errorValue ) {
+ menuItem.title = errorValue;
+ }).catch(angular.noop);
+ } else {
+ gridUtil.logError('Expected gridMenuTitleFilter to return a string or a promise, it has returned neither, bad config');
+ menuItem.title = 'badconfig';
+ }
+ },
+
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.uiGridGridMenuService
+ * @name toggleColumnVisibility
+ * @description Toggles the visibility of an individual column. Expects to be
+ * provided a context that has on it a gridColumn, which is the column that
+ * we'll operate upon. We change the visibility, and refresh the grid as appropriate
+ * @param {GridColumn} gridCol the column that we want to toggle
+ *
+ */
+ toggleColumnVisibility: function( gridCol ) {
+ gridCol.colDef.visible = !( gridCol.colDef.visible === true || gridCol.colDef.visible === undefined );
+
+ gridCol.grid.refresh();
+ gridCol.grid.api.core.notifyDataChange( uiGridConstants.dataChange.COLUMN );
+ gridCol.grid.api.core.raise.columnVisibilityChanged( gridCol );
+ }
+ };
+
+ return service;
+}])
+
+.directive('uiGridMenuButton', ['gridUtil', 'uiGridConstants', 'uiGridGridMenuService', 'i18nService',
+function (gridUtil, uiGridConstants, uiGridGridMenuService, i18nService) {
+
+ return {
+ priority: 0,
+ scope: true,
+ require: ['^uiGrid'],
+ templateUrl: 'ui-grid/ui-grid-menu-button',
+ replace: true,
+
+ link: function ($scope, $elm, $attrs, controllers) {
+ var uiGridCtrl = controllers[0];
+
+ // For the aria label
+ $scope.i18n = {
+ aria: i18nService.getSafeText('gridMenu.aria')
+ };
+
+ uiGridGridMenuService.initialize($scope, uiGridCtrl.grid);
+
+ $scope.shown = false;
+
+ $scope.toggleMenu = function () {
+ if ( $scope.shown ) {
+ $scope.$broadcast('hide-menu');
+ $scope.shown = false;
+ } else {
+ $scope.menuItems = uiGridGridMenuService.getMenuItems( $scope );
+ $scope.$broadcast('show-menu');
+ $scope.shown = true;
+ }
+ };
+
+ $scope.$on('menu-hidden', function() {
+ $scope.shown = false;
+ gridUtil.focus.bySelector($elm, '.ui-grid-icon-container');
+ });
+ }
+ };
+}]);
+})();
+
+(function() {
+
+/**
+ * @ngdoc directive
+ * @name ui.grid.directive:uiGridMenu
+ * @element style
+ * @restrict A
+ *
+ * @description
+ * Allows us to interpolate expressions in `
+ I am in a box.
+
+
+ NOTE: It is important to remember to always pass in an event object to
+ * the scrollHandler as the grid scrolling behavior will break without it.
+ * Example+ *
+ * $scope.gridOptions = {
+ * customScroller: function myScrolling(uiGridViewport, scrollHandler) {
+ * uiGridViewport.on('scroll', function myScrollingOverride(event) {
+ * // Do something here
+ *
+ * scrollHandler(event);
+ * });
+ * }
+ * };
+ *
+ * @param {object} uiGridViewport Element being scrolled. (this gets passed in by the grid).
+ * @param {function} scrollHandler Function that needs to be called when scrolling happens. (this gets passed in by the grid).
+ */
+ if (grid && grid.options && grid.options.customScroller) {
+ grid.options.customScroller($elm, scrollHandler);
+ } else {
+ $elm.on('scroll', scrollHandler);
+ }
+
+ var ignoreScroll = false;
+
+ function scrollHandler() {
+ var newScrollTop = $elm[0].scrollTop;
+ var newScrollLeft = gridUtil.normalizeScrollLeft($elm, grid);
+
+ var vertScrollPercentage = rowContainer.scrollVertical(newScrollTop);
+ var horizScrollPercentage = colContainer.scrollHorizontal(newScrollLeft);
+
+ var scrollEvent = new ScrollEvent(grid, rowContainer, colContainer, ScrollEvent.Sources.ViewPortScroll);
+ scrollEvent.newScrollLeft = newScrollLeft;
+ scrollEvent.newScrollTop = newScrollTop;
+ if ( horizScrollPercentage > -1 ) {
+ scrollEvent.x = { percentage: horizScrollPercentage };
+ }
+
+ if ( vertScrollPercentage > -1 ) {
+ scrollEvent.y = { percentage: vertScrollPercentage };
+ }
+
+ grid.scrollContainers($scope.$parent.containerId, scrollEvent);
+ }
+
+ if ($scope.$parent.bindScrollVertical) {
+ grid.addVerticalScrollSync($scope.$parent.containerId, syncVerticalScroll);
+ }
+
+ if ($scope.$parent.bindScrollHorizontal) {
+ grid.addHorizontalScrollSync($scope.$parent.containerId, syncHorizontalScroll);
+ grid.addHorizontalScrollSync($scope.$parent.containerId + 'header', syncHorizontalHeader);
+ grid.addHorizontalScrollSync($scope.$parent.containerId + 'footer', syncHorizontalFooter);
+ }
+
+ function syncVerticalScroll(scrollEvent) {
+ containerCtrl.prevScrollArgs = scrollEvent;
+ $elm[0].scrollTop = scrollEvent.getNewScrollTop(rowContainer,containerCtrl.viewport);
+ }
+
+ function syncHorizontalScroll(scrollEvent) {
+ containerCtrl.prevScrollArgs = scrollEvent;
+ var newScrollLeft = scrollEvent.getNewScrollLeft(colContainer, containerCtrl.viewport);
+
+ $elm[0].scrollLeft = gridUtil.denormalizeScrollLeft(containerCtrl.viewport,newScrollLeft, grid);
+ }
+
+ function syncHorizontalHeader(scrollEvent) {
+ var newScrollLeft = scrollEvent.getNewScrollLeft(colContainer, containerCtrl.viewport);
+
+ if (containerCtrl.headerViewport) {
+ containerCtrl.headerViewport.scrollLeft = gridUtil.denormalizeScrollLeft(containerCtrl.viewport,newScrollLeft, grid);
+ }
+ }
+
+ function syncHorizontalFooter(scrollEvent) {
+ var newScrollLeft = scrollEvent.getNewScrollLeft(colContainer, containerCtrl.viewport);
+
+ if (containerCtrl.footerViewport) {
+ containerCtrl.footerViewport.scrollLeft = gridUtil.denormalizeScrollLeft(containerCtrl.viewport,newScrollLeft, grid);
+ }
+ }
+
+ $scope.$on('$destroy', function unbindEvents() {
+ $elm.off();
+ });
+ },
+ controller: ['$scope', function ($scope) {
+ this.rowStyle = function () {
+ var rowContainer = $scope.rowContainer;
+ var colContainer = $scope.colContainer;
+
+ var styles = {};
+
+ if (rowContainer.currentTopRow !== 0) {
+ // top offset based on hidden rows count
+ var translateY = "translateY("+ (rowContainer.currentTopRow * rowContainer.grid.options.rowHeight) +"px)";
+
+ styles['transform'] = translateY;
+ styles['-webkit-transform'] = translateY;
+ styles['-ms-transform'] = translateY;
+ }
+
+ if (colContainer.currentFirstColumn !== 0) {
+ if (colContainer.grid.isRTL()) {
+ styles['margin-right'] = colContainer.columnOffset + 'px';
+ }
+ else {
+ styles['margin-left'] = colContainer.columnOffset + 'px';
+ }
+ }
+
+ return styles;
+ };
+ }]
+ };
+ }
+ ]);
+
+})();
+
+(function() {
+ angular.module('ui.grid')
+ .directive('uiGridVisible', function uiGridVisibleAction() {
+ return function($scope, $elm, $attr) {
+ $scope.$watch($attr.uiGridVisible, function(visible) {
+ $elm[visible ? 'removeClass' : 'addClass']('ui-grid-invisible');
+ });
+ };
+ });
+})();
+
+(function () {
+ 'use strict';
+
+ angular.module('ui.grid').controller('uiGridController', ['$scope', '$element', '$attrs', 'gridUtil', '$q', 'uiGridConstants',
+ 'gridClassFactory', '$parse', '$compile',
+ function ($scope, $elm, $attrs, gridUtil, $q, uiGridConstants,
+ gridClassFactory, $parse, $compile) {
+ // gridUtil.logDebug('ui-grid controller');
+ var self = this;
+ var deregFunctions = [];
+
+ self.grid = gridClassFactory.createGrid($scope.uiGrid);
+
+ // assign $scope.$parent if appScope not already assigned
+ self.grid.appScope = self.grid.appScope || $scope.$parent;
+
+ $elm.addClass('grid' + self.grid.id);
+ self.grid.rtl = gridUtil.getStyles($elm[0])['direction'] === 'rtl';
+
+
+ // angular.extend(self.grid.options, );
+
+ // all properties of grid are available on scope
+ $scope.grid = self.grid;
+
+ if ($attrs.uiGridColumns) {
+ deregFunctions.push( $attrs.$observe('uiGridColumns', function(value) {
+ self.grid.options.columnDefs = angular.isString(value) ? angular.fromJson(value) : value;
+ self.grid.buildColumns()
+ .then(function() {
+ self.grid.preCompileCellTemplates();
+
+ self.grid.refreshCanvas(true);
+ }).catch(angular.noop);
+ }) );
+ }
+
+ // prevents an error from being thrown when the array is not defined yet and fastWatch is on
+ function getSize(array) {
+ return array ? array.length : 0;
+ }
+
+ // if fastWatch is set we watch only the length and the reference, not every individual object
+ if (self.grid.options.fastWatch) {
+ self.uiGrid = $scope.uiGrid;
+ if (angular.isString($scope.uiGrid.data)) {
+ deregFunctions.push( $scope.$parent.$watch($scope.uiGrid.data, dataWatchFunction) );
+ deregFunctions.push( $scope.$parent.$watch(function() {
+ if ( self.grid.appScope[$scope.uiGrid.data] ) {
+ return self.grid.appScope[$scope.uiGrid.data].length;
+ } else {
+ return undefined;
+ }
+ }, dataWatchFunction) );
+ } else {
+ deregFunctions.push( $scope.$parent.$watch(function() { return $scope.uiGrid.data; }, dataWatchFunction) );
+ deregFunctions.push( $scope.$parent.$watch(function() { return getSize($scope.uiGrid.data); }, function() { dataWatchFunction($scope.uiGrid.data); }) );
+ }
+ deregFunctions.push( $scope.$parent.$watch(function() { return $scope.uiGrid.columnDefs; }, columnDefsWatchFunction) );
+ deregFunctions.push( $scope.$parent.$watch(function() { return getSize($scope.uiGrid.columnDefs); }, function() { columnDefsWatchFunction($scope.uiGrid.columnDefs); }) );
+ } else {
+ if (angular.isString($scope.uiGrid.data)) {
+ deregFunctions.push( $scope.$parent.$watchCollection($scope.uiGrid.data, dataWatchFunction) );
+ } else {
+ deregFunctions.push( $scope.$parent.$watchCollection(function() { return $scope.uiGrid.data; }, dataWatchFunction) );
+ }
+ deregFunctions.push( $scope.$parent.$watchCollection(function() { return $scope.uiGrid.columnDefs; }, columnDefsWatchFunction) );
+ }
+
+
+ function columnDefsWatchFunction(n, o) {
+ if (n && n !== o) {
+ self.grid.options.columnDefs = $scope.uiGrid.columnDefs;
+ self.grid.callDataChangeCallbacks(uiGridConstants.dataChange.COLUMN, {
+ orderByColumnDefs: true,
+ preCompileCellTemplates: true
+ });
+ }
+ }
+
+ var mostRecentData;
+
+ function dataWatchFunction(newData) {
+ // gridUtil.logDebug('dataWatch fired');
+ var promises = [];
+
+ if ( self.grid.options.fastWatch ) {
+ if (angular.isString($scope.uiGrid.data)) {
+ newData = self.grid.appScope.$eval($scope.uiGrid.data);
+ } else {
+ newData = $scope.uiGrid.data;
+ }
+ }
+
+ mostRecentData = newData;
+
+ if (newData) {
+ // columns length is greater than the number of row header columns, which don't count because they're created automatically
+ var hasColumns = self.grid.columns.length > (self.grid.rowHeaderColumns ? self.grid.rowHeaderColumns.length : 0);
+
+ if (
+ // If we have no columns
+ !hasColumns &&
+ // ... and we don't have a ui-grid-columns attribute, which would define columns for us
+ !$attrs.uiGridColumns &&
+ // ... and we have no pre-defined columns
+ self.grid.options.columnDefs.length === 0 &&
+ // ... but we DO have data
+ newData.length > 0
+ ) {
+ // ... then build the column definitions from the data that we have
+ self.grid.buildColumnDefsFromData(newData);
+ }
+
+ // If we haven't built columns before and either have some columns defined or some data defined
+ if (!hasColumns && (self.grid.options.columnDefs.length > 0 || newData.length > 0)) {
+ // Build the column set, then pre-compile the column cell templates
+ promises.push(self.grid.buildColumns()
+ .then(function() {
+ self.grid.preCompileCellTemplates();
+ }).catch(angular.noop));
+ }
+
+ $q.all(promises).then(function() {
+ // use most recent data, rather than the potentially outdated data passed into watcher handler
+ self.grid.modifyRows(mostRecentData)
+ .then(function () {
+ // if (self.viewport) {
+ self.grid.redrawInPlace(true);
+ // }
+
+ $scope.$evalAsync(function() {
+ self.grid.refreshCanvas(true);
+ self.grid.callDataChangeCallbacks(uiGridConstants.dataChange.ROW);
+ });
+ }).catch(angular.noop);
+ }).catch(angular.noop);
+ }
+ }
+
+ var styleWatchDereg = $scope.$watch(function () { return self.grid.styleComputations; }, function() {
+ self.grid.refreshCanvas(true);
+ });
+
+ $scope.$on('$destroy', function() {
+ deregFunctions.forEach( function( deregFn ) { deregFn(); });
+ styleWatchDereg();
+ });
+
+ self.fireEvent = function(eventName, args) {
+ args = args || {};
+
+ // Add the grid to the event arguments if it's not there
+ if (angular.isUndefined(args.grid)) {
+ args.grid = self.grid;
+ }
+
+ $scope.$broadcast(eventName, args);
+ };
+
+ self.innerCompile = function innerCompile(elm) {
+ $compile(elm)($scope);
+ };
+ }]);
+
+/**
+ * @ngdoc directive
+ * @name ui.grid.directive:uiGrid
+ * @element div
+ * @restrict EA
+ * @param {Object} uiGrid Options for the grid to use
+ *
+ * @description Create a very basic grid.
+ *
+ * @example
+
+
+
+ '
+ + ''
+ + ' ',
+ scope: {
+ side: '=uiGridPinnedContainer'
+ },
+ require: '^uiGrid',
+ compile: function compile() {
+ return {
+ post: function ($scope, $elm, $attrs, uiGridCtrl) {
+ // gridUtil.logDebug('ui-grid-pinned-container ' + $scope.side + ' link');
+
+ var grid = uiGridCtrl.grid;
+
+ var myWidth = 0;
+
+ $elm.addClass('ui-grid-pinned-container-' + $scope.side);
+
+ // Monkey-patch the viewport width function
+ if ($scope.side === 'left' || $scope.side === 'right') {
+ grid.renderContainers[$scope.side].getViewportWidth = monkeyPatchedGetViewportWidth;
+ }
+
+ function monkeyPatchedGetViewportWidth() {
+ /*jshint validthis: true */
+ var self = this;
+
+ var viewportWidth = 0;
+ self.visibleColumnCache.forEach(function (column) {
+ viewportWidth += column.drawnWidth;
+ });
+
+ var adjustment = self.getViewportAdjustment();
+
+ viewportWidth = viewportWidth + adjustment.width;
+
+ return viewportWidth;
+ }
+
+ function updateContainerWidth() {
+ if ($scope.side === 'left' || $scope.side === 'right') {
+ var cols = grid.renderContainers[$scope.side].visibleColumnCache;
+ var width = 0;
+ for (var i = 0; i < cols.length; i++) {
+ var col = cols[i];
+ width += col.drawnWidth || col.width || 0;
+ }
+
+ return width;
+ }
+ }
+
+ function updateContainerDimensions() {
+ var ret = '';
+
+ // Column containers
+ if ($scope.side === 'left' || $scope.side === 'right') {
+ myWidth = updateContainerWidth();
+
+ // gridUtil.logDebug('myWidth', myWidth);
+
+ // TODO(c0bra): Subtract sum of col widths from grid viewport width and update it
+ $elm.attr('style', null);
+
+ // var myHeight = grid.renderContainers.body.getViewportHeight(); // + grid.horizontalScrollbarHeight;
+
+ ret += '.grid' + grid.id + ' .ui-grid-pinned-container-' + $scope.side + ', .grid' + grid.id + ' .ui-grid-pinned-container-' + $scope.side + ' .ui-grid-render-container-' + $scope.side + ' .ui-grid-viewport { width: ' + myWidth + 'px; } ';
+ }
+
+ return ret;
+ }
+
+ grid.renderContainers.body.registerViewportAdjuster(function (adjustment) {
+ myWidth = updateContainerWidth();
+
+ // Subtract our own width
+ adjustment.width -= myWidth;
+ adjustment.side = $scope.side;
+
+ return adjustment;
+ });
+
+ // Register style computation to adjust for columns in `side`'s render container
+ grid.registerStyleComputation({
+ priority: 15,
+ func: updateContainerDimensions
+ });
+ }
+ };
+ }
+ };
+ }]);
+})();
+
+(function () {
+ angular.module('ui.grid').config(['$provide', function($provide) {
+ $provide.decorator('i18nService', ['$delegate', function($delegate) {
+ $delegate.add('en', {
+ headerCell: {
+ aria: {
+ defaultFilterLabel: 'Filter for column',
+ removeFilter: 'Remove Filter',
+ columnMenuButtonLabel: 'Column Menu',
+ column: 'Column'
+ },
+ priority: 'Priority:',
+ filterLabel: "Filter for column: "
+ },
+ aggregate: {
+ label: 'items'
+ },
+ groupPanel: {
+ description: 'Drag a column header here and drop it to group by that column.'
+ },
+ search: {
+ aria: {
+ selected: 'Row selected',
+ notSelected: 'Row not selected'
+ },
+ placeholder: 'Search...',
+ showingItems: 'Showing Items:',
+ selectedItems: 'Selected Items:',
+ totalItems: 'Total Items:',
+ size: 'Page Size:',
+ first: 'First Page',
+ next: 'Next Page',
+ previous: 'Previous Page',
+ last: 'Last Page'
+ },
+ menu: {
+ text: 'Choose Columns:'
+ },
+ sort: {
+ ascending: 'Sort Ascending',
+ descending: 'Sort Descending',
+ none: 'Sort None',
+ remove: 'Remove Sort'
+ },
+ column: {
+ hide: 'Hide Column'
+ },
+ aggregation: {
+ count: 'total rows: ',
+ sum: 'total: ',
+ avg: 'avg: ',
+ min: 'min: ',
+ max: 'max: '
+ },
+ pinning: {
+ pinLeft: 'Pin Left',
+ pinRight: 'Pin Right',
+ unpin: 'Unpin'
+ },
+ columnMenu: {
+ close: 'Close'
+ },
+ gridMenu: {
+ aria: {
+ buttonLabel: 'Grid Menu'
+ },
+ columns: 'Columns:',
+ importerTitle: 'Import file',
+ exporterAllAsCsv: 'Export all data as csv',
+ exporterVisibleAsCsv: 'Export visible data as csv',
+ exporterSelectedAsCsv: 'Export selected data as csv',
+ exporterAllAsPdf: 'Export all data as pdf',
+ exporterVisibleAsPdf: 'Export visible data as pdf',
+ exporterSelectedAsPdf: 'Export selected data as pdf',
+ exporterAllAsExcel: 'Export all data as excel',
+ exporterVisibleAsExcel: 'Export visible data as excel',
+ exporterSelectedAsExcel: 'Export selected data as excel',
+ clearAllFilters: 'Clear all filters'
+ },
+ importer: {
+ noHeaders: 'Column names were unable to be derived, does the file have a header?',
+ noObjects: 'Objects were not able to be derived, was there data in the file other than headers?',
+ invalidCsv: 'File was unable to be processed, is it valid CSV?',
+ invalidJson: 'File was unable to be processed, is it valid Json?',
+ jsonNotArray: 'Imported json file must contain an array, aborting.'
+ },
+ pagination: {
+ aria: {
+ pageToFirst: 'Page to first',
+ pageBack: 'Page back',
+ pageSelected: 'Selected page',
+ pageForward: 'Page forward',
+ pageToLast: 'Page to last'
+ },
+ sizes: 'items per page',
+ totalItems: 'items',
+ through: 'through',
+ of: 'of'
+ },
+ grouping: {
+ group: 'Group',
+ ungroup: 'Ungroup',
+ aggregate_count: 'Agg: Count',
+ aggregate_sum: 'Agg: Sum',
+ aggregate_max: 'Agg: Max',
+ aggregate_min: 'Agg: Min',
+ aggregate_avg: 'Agg: Avg',
+ aggregate_remove: 'Agg: Remove'
+ },
+ validate: {
+ error: 'Error:',
+ minLength: 'Value should be at least THRESHOLD characters long.',
+ maxLength: 'Value should be at most THRESHOLD characters long.',
+ required: 'A value is needed.'
+ }
+ });
+ return $delegate;
+ }]);
+ }]);
+})();
+
+(function() {
+
+angular.module('ui.grid')
+.factory('Grid', ['$q', '$compile', '$parse', 'gridUtil', 'uiGridConstants', 'GridOptions', 'GridColumn', 'GridRow', 'GridApi', 'rowSorter', 'rowSearcher', 'GridRenderContainer', '$timeout','ScrollEvent',
+ function($q, $compile, $parse, gridUtil, uiGridConstants, GridOptions, GridColumn, GridRow, GridApi, rowSorter, rowSearcher, GridRenderContainer, $timeout, ScrollEvent) {
+
+ /**
+ * @ngdoc object
+ * @name ui.grid.api:PublicApi
+ * @description Public Api for the core grid features
+ *
+ */
+
+ /**
+ * @ngdoc function
+ * @name ui.grid.class:Grid
+ * @description Grid is the main viewModel. Any properties or methods needed to maintain state are defined in
+ * this prototype. One instance of Grid is created per Grid directive instance.
+ * @param {object} options Object map of options to pass into the grid. An 'id' property is expected.
+ */
+ var Grid = function Grid(options) {
+ var self = this;
+ // Get the id out of the options, then remove it
+ if (options !== undefined && typeof(options.id) !== 'undefined' && options.id) {
+ if (!/^[_a-zA-Z0-9-]+$/.test(options.id)) {
+ throw new Error("Grid id '" + options.id + '" is invalid. It must follow CSS selector syntax rules.');
+ }
+ }
+ else {
+ throw new Error('No ID provided. An ID must be given when creating a grid.');
+ }
+
+ self.id = options.id;
+ delete options.id;
+
+ // Get default options
+ self.options = GridOptions.initialize( options );
+
+ /**
+ * @ngdoc object
+ * @name appScope
+ * @propertyOf ui.grid.class:Grid
+ * @description reference to the application scope (the parent scope of the ui-grid element). Assigned in ui-grid controller
+ * + * use gridOptions.appScopeProvider to override the default assignment of $scope.$parent with any reference + */ + self.appScope = self.options.appScopeProvider; + + self.headerHeight = self.options.headerRowHeight; + + + /** + * @ngdoc object + * @name footerHeight + * @propertyOf ui.grid.class:Grid + * @description returns the total footer height gridFooter + columnFooter + */ + self.footerHeight = self.calcFooterHeight(); + + + /** + * @ngdoc object + * @name columnFooterHeight + * @propertyOf ui.grid.class:Grid + * @description returns the total column footer height + */ + self.columnFooterHeight = self.calcColumnFooterHeight(); + + self.rtl = false; + self.gridHeight = 0; + self.gridWidth = 0; + self.columnBuilders = []; + self.rowBuilders = []; + self.rowsProcessors = []; + self.columnsProcessors = []; + self.styleComputations = []; + self.viewportAdjusters = []; + self.rowHeaderColumns = []; + self.dataChangeCallbacks = {}; + self.verticalScrollSyncCallBackFns = {}; + self.horizontalScrollSyncCallBackFns = {}; + + // self.visibleRowCache = []; + + // Set of 'render' containers for self grid, which can render sets of rows + self.renderContainers = {}; + + // Create a + self.renderContainers.body = new GridRenderContainer('body', self); + + self.cellValueGetterCache = {}; + + // Cached function to use with custom row templates + self.getRowTemplateFn = null; + + + // representation of the rows on the grid. + // these are wrapped references to the actual data rows (options.data) + self.rows = []; + + // represents the columns on the grid + self.columns = []; + + /** + * @ngdoc boolean + * @name isScrollingVertically + * @propertyOf ui.grid.class:Grid + * @description set to true when Grid is scrolling vertically. Set to false via debounced method + */ + self.isScrollingVertically = false; + + /** + * @ngdoc boolean + * @name isScrollingHorizontally + * @propertyOf ui.grid.class:Grid + * @description set to true when Grid is scrolling horizontally. Set to false via debounced method + */ + self.isScrollingHorizontally = false; + + /** + * @ngdoc property + * @name scrollDirection + * @propertyOf ui.grid.class:Grid + * @description set one of the {@link ui.grid.service:uiGridConstants#properties_scrollDirection uiGridConstants.scrollDirection} + * values (UP, DOWN, LEFT, RIGHT, NONE), which tells us which direction we are scrolling. + * Set to NONE via debounced method + */ + self.scrollDirection = uiGridConstants.scrollDirection.NONE; + + // if true, grid will not respond to any scroll events + self.disableScrolling = false; + + + function vertical (scrollEvent) { + self.isScrollingVertically = false; + self.api.core.raise.scrollEnd(scrollEvent); + self.scrollDirection = uiGridConstants.scrollDirection.NONE; + } + + var debouncedVertical = gridUtil.debounce(vertical, self.options.scrollDebounce); + var debouncedVerticalMinDelay = gridUtil.debounce(vertical, 0); + + function horizontal (scrollEvent) { + self.isScrollingHorizontally = false; + self.api.core.raise.scrollEnd(scrollEvent); + self.scrollDirection = uiGridConstants.scrollDirection.NONE; + } + + var debouncedHorizontal = gridUtil.debounce(horizontal, self.options.scrollDebounce); + var debouncedHorizontalMinDelay = gridUtil.debounce(horizontal, 0); + + + /** + * @ngdoc function + * @name flagScrollingVertically + * @methodOf ui.grid.class:Grid + * @description sets isScrollingVertically to true and sets it to false in a debounced function + */ + self.flagScrollingVertically = function(scrollEvent) { + if (!self.isScrollingVertically && !self.isScrollingHorizontally) { + self.api.core.raise.scrollBegin(scrollEvent); + } + self.isScrollingVertically = true; + if (self.options.scrollDebounce === 0 || !scrollEvent.withDelay) { + debouncedVerticalMinDelay(scrollEvent); + } + else { + debouncedVertical(scrollEvent); + } + }; + + /** + * @ngdoc function + * @name flagScrollingHorizontally + * @methodOf ui.grid.class:Grid + * @description sets isScrollingHorizontally to true and sets it to false in a debounced function + */ + self.flagScrollingHorizontally = function(scrollEvent) { + if (!self.isScrollingVertically && !self.isScrollingHorizontally) { + self.api.core.raise.scrollBegin(scrollEvent); + } + self.isScrollingHorizontally = true; + if (self.options.scrollDebounce === 0 || !scrollEvent.withDelay) { + debouncedHorizontalMinDelay(scrollEvent); + } + else { + debouncedHorizontal(scrollEvent); + } + }; + + self.scrollbarHeight = 0; + self.scrollbarWidth = 0; + if (self.options.enableHorizontalScrollbar !== uiGridConstants.scrollbars.NEVER) { + self.scrollbarHeight = gridUtil.getScrollbarWidth(); + } + + if (self.options.enableVerticalScrollbar !== uiGridConstants.scrollbars.NEVER) { + self.scrollbarWidth = gridUtil.getScrollbarWidth(); + } + + self.api = new GridApi(self); + + /** + * @ngdoc function + * @name refresh + * @methodOf ui.grid.api:PublicApi + * @description Refresh the rendered grid on screen. + * The refresh method re-runs both the columnProcessors and the + * rowProcessors, as well as calling refreshCanvas to update all + * the grid sizing. In general you should prefer to use queueGridRefresh + * instead, which is basically a debounced version of refresh. + * + * If you only want to resize the grid, not regenerate all the rows + * and columns, you should consider directly calling refreshCanvas instead. + * + * @param {boolean} [rowsAltered] Optional flag for refreshing when the number of rows has changed + */ + self.api.registerMethod( 'core', 'refresh', this.refresh ); + + /** + * @ngdoc function + * @name queueGridRefresh + * @methodOf ui.grid.api:PublicApi + * @description Request a refresh of the rendered grid on screen, if multiple + * calls to queueGridRefresh are made within a digest cycle only one will execute. + * The refresh method re-runs both the columnProcessors and the + * rowProcessors, as well as calling refreshCanvas to update all + * the grid sizing. In general you should prefer to use queueGridRefresh + * instead, which is basically a debounced version of refresh. + * + */ + self.api.registerMethod( 'core', 'queueGridRefresh', this.queueGridRefresh ); + + /** + * @ngdoc function + * @name refreshRows + * @methodOf ui.grid.api:PublicApi + * @description Runs only the rowProcessors, columns remain as they were. + * It then calls redrawInPlace and refreshCanvas, which adjust the grid sizing. + * @returns {promise} promise that is resolved when render completes? + * + */ + self.api.registerMethod( 'core', 'refreshRows', this.refreshRows ); + + /** + * @ngdoc function + * @name queueRefresh + * @methodOf ui.grid.api:PublicApi + * @description Requests execution of refreshCanvas, if multiple requests are made + * during a digest cycle only one will run. RefreshCanvas updates the grid sizing. + * @returns {promise} promise that is resolved when render completes? + * + */ + self.api.registerMethod( 'core', 'queueRefresh', this.queueRefresh ); + + /** + * @ngdoc function + * @name handleWindowResize + * @methodOf ui.grid.api:PublicApi + * @description Trigger a grid resize, normally this would be picked + * up by a watch on window size, but in some circumstances it is necessary + * to call this manually + * @returns {promise} promise that is resolved when render completes? + * + */ + self.api.registerMethod( 'core', 'handleWindowResize', this.handleWindowResize ); + + + /** + * @ngdoc function + * @name addRowHeaderColumn + * @methodOf ui.grid.api:PublicApi + * @description adds a row header column to the grid + * @param {object} column def + * @param {number} order Determines order of header column on grid. Lower order means header + * is positioned to the left of higher order headers + * + */ + self.api.registerMethod( 'core', 'addRowHeaderColumn', this.addRowHeaderColumn ); + + /** + * @ngdoc function + * @name scrollToIfNecessary + * @methodOf ui.grid.api:PublicApi + * @description Scrolls the grid to make a certain row and column combo visible, + * in the case that it is not completely visible on the screen already. + * @param {GridRow} gridRow row to make visible + * @param {GridColumn} gridCol column to make visible + * @returns {promise} a promise that is resolved when scrolling is complete + * + */ + self.api.registerMethod( 'core', 'scrollToIfNecessary', function(gridRow, gridCol) { return self.scrollToIfNecessary(gridRow, gridCol);} ); + + /** + * @ngdoc function + * @name scrollTo + * @methodOf ui.grid.api:PublicApi + * @description Scroll the grid such that the specified + * row and column is in view + * @param {object} rowEntity gridOptions.data[] array instance to make visible + * @param {object} colDef to make visible + * @returns {promise} a promise that is resolved after any scrolling is finished + */ + self.api.registerMethod( 'core', 'scrollTo', function (rowEntity, colDef) { return self.scrollTo(rowEntity, colDef);} ); + + /** + * @ngdoc function + * @name registerRowsProcessor + * @methodOf ui.grid.api:PublicApi + * @description + * Register a "rows processor" function. When the rows are updated, + * the grid calls each registered "rows processor", which has a chance + * to alter the set of rows (sorting, etc) as long as the count is not + * modified. + * + * @param {function(renderedRowsToProcess, columns )} processorFunction rows processor function, which + * is run in the context of the grid (i.e. this for the function will be the grid), and must + * return the updated rows list, which is passed to the next processor in the chain + * @param {number} priority the priority of this processor. In general we try to do them in 100s to leave room + * for other people to inject rows processors at intermediate priorities. Lower priority rowsProcessors run earlier. + * + * At present allRowsVisible is running at 50, sort manipulations running at 60-65, filter is running at 100, + * sort is at 200, grouping and treeview at 400-410, selectable rows at 500, pagination at 900 (pagination will generally want to be last) + */ + self.api.registerMethod( 'core', 'registerRowsProcessor', this.registerRowsProcessor ); + + /** + * @ngdoc function + * @name registerColumnsProcessor + * @methodOf ui.grid.api:PublicApi + * @description + * Register a "columns processor" function. When the columns are updated, + * the grid calls each registered "columns processor", which has a chance + * to alter the set of columns as long as the count is not + * modified. + * + * @param {function(renderedColumnsToProcess, rows )} processorFunction columns processor function, which + * is run in the context of the grid (i.e. this for the function will be the grid), and must + * return the updated columns list, which is passed to the next processor in the chain + * @param {number} priority the priority of this processor. In general we try to do them in 100s to leave room + * for other people to inject columns processors at intermediate priorities. Lower priority columnsProcessors run earlier. + * + * At present allRowsVisible is running at 50, filter is running at 100, sort is at 200, grouping at 400, selectable rows at 500, pagination at 900 (pagination will generally want to be last) + */ + self.api.registerMethod( 'core', 'registerColumnsProcessor', this.registerColumnsProcessor ); + + /** + * @ngdoc function + * @name sortHandleNulls + * @methodOf ui.grid.api:PublicApi + * @description A null handling method that can be used when building custom sort + * functions + * @example + *
+ * mySortFn = function(a, b) {
+ * var nulls = $scope.gridApi.core.sortHandleNulls(a, b);
+ * if ( nulls !== null ) {
+ * return nulls;
+ * } else {
+ * // your code for sorting here
+ * };
+ *
+ * @param {object} a sort value a
+ * @param {object} b sort value b
+ * @returns {number} null if there were no nulls/undefineds, otherwise returns
+ * a sort value that should be passed back from the sort function
+ *
+ */
+ self.api.registerMethod( 'core', 'sortHandleNulls', rowSorter.handleNulls );
+
+ /**
+ * @ngdoc function
+ * @name sortChanged
+ * @methodOf ui.grid.api:PublicApi
+ * @description The sort criteria on one or more columns has
+ * changed. Provides as parameters the grid and the output of
+ * getColumnSorting, which is an array of gridColumns
+ * that have sorting on them, sorted in priority order.
+ *
+ * @param {$scope} scope The scope of the controller. This is used to deregister this event when the scope is destroyed.
+ * @param {Function} callBack Will be called when the event is emited. The function passes back the grid and an array of
+ * columns with sorts on them, in priority order.
+ *
+ * @example
+ *
+ * gridApi.core.on.sortChanged( $scope, function(grid, sortColumns) {
+ * // do something
+ * });
+ *
+ */
+ self.api.registerEvent( 'core', 'sortChanged' );
+
+ /**
+ * @ngdoc function
+ * @name columnVisibilityChanged
+ * @methodOf ui.grid.api:PublicApi
+ * @description The visibility of a column has changed,
+ * the column itself is passed out as a parameter of the event.
+ *
+ * @param {$scope} scope The scope of the controller. This is used to deregister this event when the scope is destroyed.
+ * @param {Function} callBack Will be called when the event is emited. The function passes back the GridCol that has changed.
+ *
+ * @example
+ *
+ * gridApi.core.on.columnVisibilityChanged( $scope, function (column) {
+ * // do something
+ * } );
+ *
+ */
+ self.api.registerEvent( 'core', 'columnVisibilityChanged' );
+
+ /**
+ * @ngdoc method
+ * @name notifyDataChange
+ * @methodOf ui.grid.api:PublicApi
+ * @description Notify the grid that a data or config change has occurred,
+ * where that change isn't something the grid was otherwise noticing. This
+ * might be particularly relevant where you've changed values within the data
+ * and you'd like cell classes to be re-evaluated, or changed config within
+ * the columnDef and you'd like headerCellClasses to be re-evaluated.
+ * @param {string} type one of the
+ * {@link ui.grid.service:uiGridConstants#properties_dataChange uiGridConstants.dataChange}
+ * values (ALL, ROW, EDIT, COLUMN, OPTIONS), which tells us which refreshes to fire.
+ *
+ * - ALL: listeners fired on any of these events, fires listeners on all events.
+ * - ROW: fired when a row is added or removed.
+ * - EDIT: fired when the data in a cell is edited.
+ * - COLUMN: fired when the column definitions are modified.
+ * - OPTIONS: fired when the grid options are modified.
+ */
+ self.api.registerMethod( 'core', 'notifyDataChange', this.notifyDataChange );
+
+ /**
+ * @ngdoc method
+ * @name clearAllFilters
+ * @methodOf ui.grid.api:PublicApi
+ * @description Clears all filters and optionally refreshes the visible rows.
+ * @param {object} refreshRows Defaults to true.
+ * @param {object} clearConditions Defaults to false.
+ * @param {object} clearFlags Defaults to false.
+ * @returns {promise} If `refreshRows` is true, returns a promise of the rows refreshing.
+ */
+ self.api.registerMethod('core', 'clearAllFilters', this.clearAllFilters);
+
+ self.registerDataChangeCallback( self.columnRefreshCallback, [uiGridConstants.dataChange.COLUMN]);
+ self.registerDataChangeCallback( self.processRowsCallback, [uiGridConstants.dataChange.EDIT]);
+ self.registerDataChangeCallback( self.updateFooterHeightCallback, [uiGridConstants.dataChange.OPTIONS]);
+
+ self.registerStyleComputation({
+ priority: 10,
+ func: self.getFooterStyles
+ });
+ };
+
+ Grid.prototype.calcFooterHeight = function () {
+ if (!this.hasFooter()) {
+ return 0;
+ }
+
+ var height = 0;
+ if (this.options.showGridFooter) {
+ height += this.options.gridFooterHeight;
+ }
+
+ height += this.calcColumnFooterHeight();
+
+ return height;
+ };
+
+ Grid.prototype.calcColumnFooterHeight = function () {
+ var height = 0;
+
+ if (this.options.showColumnFooter) {
+ height += this.options.columnFooterHeight;
+ }
+
+ return height;
+ };
+
+ Grid.prototype.getFooterStyles = function () {
+ var style = '.grid' + this.id + ' .ui-grid-footer-aggregates-row { height: ' + this.options.columnFooterHeight + 'px; }';
+ style += ' .grid' + this.id + ' .ui-grid-footer-info { height: ' + this.options.gridFooterHeight + 'px; }';
+ return style;
+ };
+
+ Grid.prototype.hasFooter = function () {
+ return this.options.showGridFooter || this.options.showColumnFooter;
+ };
+
+ /**
+ * @ngdoc function
+ * @name isRTL
+ * @methodOf ui.grid.class:Grid
+ * @description Returns true if grid is RightToLeft
+ */
+ Grid.prototype.isRTL = function () {
+ return this.rtl;
+ };
+
+
+ /**
+ * @ngdoc function
+ * @name registerColumnBuilder
+ * @methodOf ui.grid.class:Grid
+ * @description When the build creates columns from column definitions, the columnbuilders will be called to add
+ * additional properties to the column.
+ * @param {function(colDef, col, gridOptions)} columnBuilder function to be called
+ */
+ Grid.prototype.registerColumnBuilder = function registerColumnBuilder(columnBuilder) {
+ this.columnBuilders.push(columnBuilder);
+ };
+
+ /**
+ * @ngdoc function
+ * @name buildColumnDefsFromData
+ * @methodOf ui.grid.class:Grid
+ * @description Populates columnDefs from the provided data
+ * @param {function(colDef, col, gridOptions)} rowBuilder function to be called
+ */
+ Grid.prototype.buildColumnDefsFromData = function (dataRows) {
+ this.options.columnDefs = gridUtil.getColumnsFromData(dataRows, this.options.excludeProperties);
+ };
+
+ /**
+ * @ngdoc function
+ * @name registerRowBuilder
+ * @methodOf ui.grid.class:Grid
+ * @description When the build creates rows from gridOptions.data, the rowBuilders will be called to add
+ * additional properties to the row.
+ * @param {function(row, gridOptions)} rowBuilder function to be called
+ */
+ Grid.prototype.registerRowBuilder = function registerRowBuilder(rowBuilder) {
+ this.rowBuilders.push(rowBuilder);
+ };
+
+ /**
+ * @ngdoc function
+ * @name registerDataChangeCallback
+ * @methodOf ui.grid.class:Grid
+ * @description When a data change occurs, the data change callbacks of the specified type
+ * will be called. The rules are:
+ *
+ * - when the data watch fires, that is considered a ROW change (the data watch only notices
+ * added or removed rows)
+ * - when the api is called to inform us of a change, the declared type of that change is used
+ * - when a cell edit completes, the EDIT callbacks are triggered
+ * - when the columnDef watch fires, the COLUMN callbacks are triggered
+ * - when the options watch fires, the OPTIONS callbacks are triggered
+ *
+ * For a given event:
+ * - ALL calls ROW, EDIT, COLUMN, OPTIONS and ALL callbacks
+ * - ROW calls ROW and ALL callbacks
+ * - EDIT calls EDIT and ALL callbacks
+ * - COLUMN calls COLUMN and ALL callbacks
+ * - OPTIONS calls OPTIONS and ALL callbacks
+ *
+ * @param {function(grid)} callback function to be called
+ * @param {array} types the types of data change you want to be informed of. Values from
+ * the {@link ui.grid.service:uiGridConstants#properties_dataChange uiGridConstants.dataChange}
+ * values ( ALL, EDIT, ROW, COLUMN, OPTIONS ). Optional and defaults to ALL
+ * @returns {function} deregister function - a function that can be called to deregister this callback
+ */
+ Grid.prototype.registerDataChangeCallback = function registerDataChangeCallback(callback, types, _this) {
+ var self = this,
+ uid = gridUtil.nextUid();
+
+ if ( !types ) {
+ types = [uiGridConstants.dataChange.ALL];
+ }
+ if ( !Array.isArray(types)) {
+ gridUtil.logError("Expected types to be an array or null in registerDataChangeCallback, value passed was: " + types );
+ }
+ this.dataChangeCallbacks[uid] = { callback: callback, types: types, _this: _this };
+
+ return function() {
+ delete self.dataChangeCallbacks[uid];
+ };
+ };
+
+ /**
+ * @ngdoc function
+ * @name callDataChangeCallbacks
+ * @methodOf ui.grid.class:Grid
+ * @description Calls the callbacks based on the type of data change that
+ * has occurred. Always calls the ALL callbacks, calls the ROW, EDIT, COLUMN and OPTIONS callbacks if the
+ * event type is matching, or if the type is ALL.
+ * @param {string} type the type of event that occurred - one of the
+ * {@link ui.grid.service:uiGridConstants#properties_dataChange uiGridConstants.dataChange}
+ * values (ALL, ROW, EDIT, COLUMN, OPTIONS)
+ */
+ Grid.prototype.callDataChangeCallbacks = function callDataChangeCallbacks(type, options) {
+ angular.forEach( this.dataChangeCallbacks, function( callback, uid ) {
+ if ( callback.types.indexOf( uiGridConstants.dataChange.ALL ) !== -1 ||
+ callback.types.indexOf( type ) !== -1 ||
+ type === uiGridConstants.dataChange.ALL ) {
+ if (callback._this) {
+ callback.callback.apply(callback._this, this, options);
+ }
+ else {
+ callback.callback(this, options);
+ }
+ }
+ }, this);
+ };
+
+ /**
+ * @ngdoc function
+ * @name notifyDataChange
+ * @methodOf ui.grid.class:Grid
+ * @description Notifies us that a data change has occurred, used in the public
+ * api for users to tell us when they've changed data or some other event that
+ * our watches cannot pick up
+ * @param {string} type the type of event that occurred - one of the
+ * uiGridConstants.dataChange values (ALL, ROW, EDIT, COLUMN, OPTIONS)
+ *
+ * - ALL: listeners fired on any of these events, fires listeners on all events.
+ * - ROW: fired when a row is added or removed.
+ * - EDIT: fired when the data in a cell is edited.
+ * - COLUMN: fired when the column definitions are modified.
+ * - OPTIONS: fired when the grid options are modified.
+ */
+ Grid.prototype.notifyDataChange = function notifyDataChange(type) {
+ var constants = uiGridConstants.dataChange;
+
+ if ( type === constants.ALL ||
+ type === constants.COLUMN ||
+ type === constants.EDIT ||
+ type === constants.ROW ||
+ type === constants.OPTIONS ) {
+ this.callDataChangeCallbacks( type );
+ }
+ else {
+ gridUtil.logError("Notified of a data change, but the type was not recognised, so no action taken, type was: " + type);
+ }
+ };
+
+ /**
+ * @ngdoc function
+ * @name columnRefreshCallback
+ * @methodOf ui.grid.class:Grid
+ * @description refreshes the grid when a column refresh
+ * is notified, which triggers handling of the visible flag.
+ * This is called on uiGridConstants.dataChange.COLUMN, and is
+ * registered as a dataChangeCallback in grid.js
+ * @param {object} grid The grid object.
+ * @param {object} options Any options passed into the callback.
+ */
+ Grid.prototype.columnRefreshCallback = function columnRefreshCallback(grid, options) {
+ grid.buildColumns(options);
+ grid.queueGridRefresh();
+ };
+
+ /**
+ * @ngdoc function
+ * @name processRowsCallback
+ * @methodOf ui.grid.class:Grid
+ * @description calls the row processors, specifically
+ * intended to reset the sorting when an edit is called,
+ * registered as a dataChangeCallback on uiGridConstants.dataChange.EDIT
+ * @param {object} grid The grid object.
+ */
+ Grid.prototype.processRowsCallback = function processRowsCallback( grid ) {
+ grid.queueGridRefresh();
+ };
+
+
+ /**
+ * @ngdoc function
+ * @name updateFooterHeightCallback
+ * @methodOf ui.grid.class:Grid
+ * @description recalculates the footer height,
+ * registered as a dataChangeCallback on uiGridConstants.dataChange.OPTIONS
+ * @param {object} grid The grid object.
+ */
+ Grid.prototype.updateFooterHeightCallback = function updateFooterHeightCallback( grid ) {
+ grid.footerHeight = grid.calcFooterHeight();
+ grid.columnFooterHeight = grid.calcColumnFooterHeight();
+ };
+
+
+ /**
+ * @ngdoc function
+ * @name getColumn
+ * @methodOf ui.grid.class:Grid
+ * @description returns a grid column for the column name
+ * @param {string} name column name
+ */
+ Grid.prototype.getColumn = function getColumn(name) {
+ var columns = this.columns.filter(function (column) {
+ return column.colDef.name === name;
+ });
+
+ return columns.length > 0 ? columns[0] : null;
+ };
+
+ /**
+ * @ngdoc function
+ * @name getColDef
+ * @methodOf ui.grid.class:Grid
+ * @description returns a grid colDef for the column name
+ * @param {string} name column.field
+ */
+ Grid.prototype.getColDef = function getColDef(name) {
+ var colDefs = this.options.columnDefs.filter(function (colDef) {
+ return colDef.name === name;
+ });
+ return colDefs.length > 0 ? colDefs[0] : null;
+ };
+
+ /**
+ * @ngdoc function
+ * @name assignTypes
+ * @methodOf ui.grid.class:Grid
+ * @description uses the first row of data to assign colDef.type for any types not defined.
+ */
+ /**
+ * @ngdoc property
+ * @name type
+ * @propertyOf ui.grid.class:GridOptions.columnDef
+ * @description the type of the column, used in sorting. If not provided then the
+ * grid will guess the type. Add this only if the grid guessing is not to your
+ * satisfaction. One of:
+ * - 'string'
+ * - 'boolean'
+ * - 'number'
+ * - 'date'
+ * - 'object'
+ * - 'numberStr'
+ * Note that if you choose date, your dates should be in a javascript date type
+ *
+ */
+ Grid.prototype.assignTypes = function() {
+ var self = this;
+
+ self.options.columnDefs.forEach(function (colDef, index) {
+ // Assign colDef type if not specified
+ if (!colDef.type) {
+ var col = new GridColumn(colDef, index, self);
+ var firstRow = self.rows.length > 0 ? self.rows[0] : null;
+ if (firstRow) {
+ colDef.type = gridUtil.guessType(self.getCellValue(firstRow, col));
+ }
+ else {
+ colDef.type = 'string';
+ }
+ }
+ });
+ };
+
+
+ /**
+ * @ngdoc function
+ * @name isRowHeaderColumn
+ * @methodOf ui.grid.class:Grid
+ * @description returns true if the column is a row Header
+ * @param {object} column column
+ */
+ Grid.prototype.isRowHeaderColumn = function isRowHeaderColumn(column) {
+ return this.rowHeaderColumns.indexOf(column) !== -1;
+ };
+
+ /**
+ * @ngdoc function
+ * @name addRowHeaderColumn
+ * @methodOf ui.grid.class:Grid
+ * @description adds a row header column to the grid
+ * @param {object} colDef Column definition object.
+ * @param {float} order Number that indicates where the column should be placed in the grid.
+ * @param {boolean} stopColumnBuild Prevents the buildColumn callback from being triggered. This is useful to improve
+ * performance of the grid during initial load.
+ */
+ Grid.prototype.addRowHeaderColumn = function addRowHeaderColumn(colDef, order, stopColumnBuild) {
+ var self = this;
+
+ // default order
+ if (order === undefined) {
+ order = 0;
+ }
+
+ var rowHeaderCol = new GridColumn(colDef, gridUtil.nextUid(), self);
+ rowHeaderCol.isRowHeader = true;
+ if (self.isRTL()) {
+ self.createRightContainer();
+ rowHeaderCol.renderContainer = 'right';
+ }
+ else {
+ self.createLeftContainer();
+ rowHeaderCol.renderContainer = 'left';
+ }
+
+ // relies on the default column builder being first in array, as it is instantiated
+ // as part of grid creation
+ self.columnBuilders[0](colDef,rowHeaderCol,self.options)
+ .then(function() {
+ rowHeaderCol.enableFiltering = false;
+ rowHeaderCol.enableSorting = false;
+ rowHeaderCol.enableHiding = false;
+ rowHeaderCol.headerPriority = order;
+ self.rowHeaderColumns.push(rowHeaderCol);
+ self.rowHeaderColumns = self.rowHeaderColumns.sort(function (a, b) {
+ return a.headerPriority - b.headerPriority;
+ });
+
+ if (!stopColumnBuild) {
+ self.buildColumns()
+ .then(function() {
+ self.preCompileCellTemplates();
+ self.queueGridRefresh();
+ }).catch(angular.noop);
+ }
+ }).catch(angular.noop);
+ };
+
+ /**
+ * @ngdoc function
+ * @name getOnlyDataColumns
+ * @methodOf ui.grid.class:Grid
+ * @description returns all columns except for rowHeader columns
+ */
+ Grid.prototype.getOnlyDataColumns = function getOnlyDataColumns() {
+ var self = this,
+ cols = [];
+
+ self.columns.forEach(function (col) {
+ if (self.rowHeaderColumns.indexOf(col) === -1) {
+ cols.push(col);
+ }
+ });
+ return cols;
+ };
+
+ /**
+ * @ngdoc function
+ * @name buildColumns
+ * @methodOf ui.grid.class:Grid
+ * @description creates GridColumn objects from the columnDefinition. Calls each registered
+ * columnBuilder to further process the column
+ * @param {object} opts An object contains options to use when building columns
+ *
+ * * **orderByColumnDefs**: defaults to **false**. When true, `buildColumns` will reorder existing columns according to the order within the column definitions.
+ *
+ * @returns {Promise} a promise to load any needed column resources
+ */
+ Grid.prototype.buildColumns = function buildColumns(opts) {
+ var options = {
+ orderByColumnDefs: false
+ };
+
+ angular.extend(options, opts);
+
+ // gridUtil.logDebug('buildColumns');
+ var self = this;
+ var builderPromises = [];
+ var headerOffset = self.rowHeaderColumns.length;
+ var i;
+
+ // Remove any columns for which a columnDef cannot be found
+ // Deliberately don't use forEach, as it doesn't like splice being called in the middle
+ // Also don't cache columns.length, as it will change during this operation
+ for (i = 0; i < self.columns.length; i++) {
+ if (!self.getColDef(self.columns[i].name)) {
+ self.columns.splice(i, 1);
+ i--;
+ }
+ }
+
+ // add row header columns to the grid columns array _after_ columns without columnDefs have been removed
+ // rowHeaderColumns is ordered by priority so insert in reverse
+ for (var j = self.rowHeaderColumns.length - 1; j >= 0; j--) {
+ self.columns.unshift(self.rowHeaderColumns[j]);
+ }
+
+ // look at each column def, and update column properties to match. If the column def
+ // doesn't have a column, then splice in a new gridCol
+ self.options.columnDefs.forEach(function (colDef, index) {
+ self.preprocessColDef(colDef);
+ var col = self.getColumn(colDef.name);
+
+ if (!col) {
+ col = new GridColumn(colDef, gridUtil.nextUid(), self);
+ self.columns.splice(index + headerOffset, 0, col);
+ }
+ else {
+ // tell updateColumnDef that the column was pre-existing
+ col.updateColumnDef(colDef, false);
+ }
+
+ self.columnBuilders.forEach(function (builder) {
+ builderPromises.push(builder.call(self, colDef, col, self.options));
+ });
+ });
+
+ /*** Reorder columns if necessary ***/
+ if (!!options.orderByColumnDefs) {
+ // Create a shallow copy of the columns as a cache
+ var columnCache = self.columns.slice(0);
+
+ // We need to allow for the "row headers" when mapping from the column defs array to the columns array
+ // If we have a row header in columns[0] and don't account for it we'll overwrite it with the column in columnDefs[0]
+
+ // Go through all the column defs, use the shorter of columns length and colDefs.length because if a user has given two columns the same name then
+ // columns will be shorter than columnDefs. In this situation we'll avoid an error, but the user will still get an unexpected result
+ var len = Math.min(self.options.columnDefs.length, self.columns.length);
+ for (i = 0; i < len; i++) {
+ // If the column at this index has a different name than the column at the same index in the column defs...
+ if (self.columns[i + headerOffset].name !== self.options.columnDefs[i].name) {
+ // Replace the one in the cache with the appropriate column
+ columnCache[i + headerOffset] = self.getColumn(self.options.columnDefs[i].name);
+ }
+ else {
+ // Otherwise just copy over the one from the initial columns
+ columnCache[i + headerOffset] = self.columns[i + headerOffset];
+ }
+ }
+
+ // Empty out the columns array, non-destructively
+ self.columns.length = 0;
+
+ // And splice in the updated, ordered columns from the cache
+ Array.prototype.splice.apply(self.columns, [0, 0].concat(columnCache));
+ }
+
+ return $q.all(builderPromises).then(function() {
+ if (self.rows.length > 0) {
+ self.assignTypes();
+ }
+ if (options.preCompileCellTemplates) {
+ self.preCompileCellTemplates();
+ }
+ }).catch(angular.noop);
+ };
+
+ Grid.prototype.preCompileCellTemplate = function(col) {
+ var self = this;
+ var html = col.cellTemplate.replace(uiGridConstants.MODEL_COL_FIELD, self.getQualifiedColField(col));
+ html = html.replace(uiGridConstants.COL_FIELD, 'grid.getCellValue(row, col)');
+
+ col.compiledElementFn = $compile(html);
+
+ if (col.compiledElementFnDefer) {
+ col.compiledElementFnDefer.resolve(col.compiledElementFn);
+ }
+ };
+
+/**
+ * @ngdoc function
+ * @name preCompileCellTemplates
+ * @methodOf ui.grid.class:Grid
+ * @description precompiles all cell templates
+ */
+ Grid.prototype.preCompileCellTemplates = function() {
+ var self = this;
+ self.columns.forEach(function (col) {
+ if ( col.cellTemplate ) {
+ self.preCompileCellTemplate( col );
+ } else if ( col.cellTemplatePromise ) {
+ col.cellTemplatePromise.then( function() {
+ self.preCompileCellTemplate( col );
+ }).catch(angular.noop);
+ }
+ });
+ };
+
+ /**
+ * @ngdoc function
+ * @name getGridQualifiedColField
+ * @methodOf ui.grid.class:Grid
+ * @description Returns the $parse-able accessor for a column within its $scope
+ * @param {GridColumn} col col object
+ */
+ Grid.prototype.getQualifiedColField = function (col) {
+ var base = 'row.entity';
+ if ( col.field === uiGridConstants.ENTITY_BINDING ) {
+ return base;
+ }
+ return gridUtil.preEval(base + '.' + col.field);
+ };
+
+ /**
+ * @ngdoc function
+ * @name createLeftContainer
+ * @methodOf ui.grid.class:Grid
+ * @description creates the left render container if it doesn't already exist
+ */
+ Grid.prototype.createLeftContainer = function() {
+ if (!this.hasLeftContainer()) {
+ this.renderContainers.left = new GridRenderContainer('left', this, { disableColumnOffset: true });
+ }
+ };
+
+ /**
+ * @ngdoc function
+ * @name createRightContainer
+ * @methodOf ui.grid.class:Grid
+ * @description creates the right render container if it doesn't already exist
+ */
+ Grid.prototype.createRightContainer = function() {
+ if (!this.hasRightContainer()) {
+ this.renderContainers.right = new GridRenderContainer('right', this, { disableColumnOffset: true });
+ }
+ };
+
+ /**
+ * @ngdoc function
+ * @name hasLeftContainer
+ * @methodOf ui.grid.class:Grid
+ * @description returns true if leftContainer exists
+ */
+ Grid.prototype.hasLeftContainer = function() {
+ return this.renderContainers.left !== undefined;
+ };
+
+ /**
+ * @ngdoc function
+ * @name hasRightContainer
+ * @methodOf ui.grid.class:Grid
+ * @description returns true if rightContainer exists
+ */
+ Grid.prototype.hasRightContainer = function() {
+ return this.renderContainers.right !== undefined;
+ };
+
+
+ /**
+ * undocumented function
+ * @name preprocessColDef
+ * @methodOf ui.grid.class:Grid
+ * @description defaults the name property from field to maintain backwards compatibility with 2.x
+ * validates that name or field is present
+ */
+ Grid.prototype.preprocessColDef = function preprocessColDef(colDef) {
+ var self = this;
+
+ if (!colDef.field && !colDef.name) {
+ throw new Error('colDef.name or colDef.field property is required');
+ }
+
+ // maintain backwards compatibility with 2.x
+ // field was required in 2.x. now name is required
+ if (colDef.name === undefined && colDef.field !== undefined) {
+ // See if the column name already exists:
+ var newName = colDef.field,
+ counter = 2;
+ while (self.getColumn(newName)) {
+ newName = colDef.field + counter.toString();
+ counter++;
+ }
+ colDef.name = newName;
+ }
+ };
+
+ // Return a list of items that exist in the `n` array but not the `o` array. Uses optional property accessors passed as third & fourth parameters
+ Grid.prototype.newInN = function newInN(o, n, oAccessor, nAccessor) {
+ var self = this;
+
+ var t = [];
+ for (var i = 0; i < n.length; i++) {
+ var nV = nAccessor ? n[i][nAccessor] : n[i];
+
+ var found = false;
+ for (var j = 0; j < o.length; j++) {
+ var oV = oAccessor ? o[j][oAccessor] : o[j];
+ if (self.options.rowEquality(nV, oV)) {
+ found = true;
+ break;
+ }
+ }
+ if (!found) {
+ t.push(nV);
+ }
+ }
+
+ return t;
+ };
+
+ /**
+ * @ngdoc function
+ * @name getRow
+ * @methodOf ui.grid.class:Grid
+ * @description returns the GridRow that contains the rowEntity
+ * @param {object} rowEntity the gridOptions.data array element instance
+ * @param {array} lookInRows [optional] the rows to look in - if not provided then
+ * looks in grid.rows
+ */
+ Grid.prototype.getRow = function getRow(rowEntity, lookInRows) {
+ var self = this;
+
+ lookInRows = typeof(lookInRows) === 'undefined' ? self.rows : lookInRows;
+
+ var rows = lookInRows.filter(function (row) {
+ return self.options.rowEquality(row.entity, rowEntity);
+ });
+ return rows.length > 0 ? rows[0] : null;
+ };
+
+
+ /**
+ * @ngdoc function
+ * @name modifyRows
+ * @methodOf ui.grid.class:Grid
+ * @description creates or removes GridRow objects from the newRawData array. Calls each registered
+ * rowBuilder to further process the row
+ * @param {array} newRawData Modified set of data
+ *
+ * This method aims to achieve three things:
+ * 1. the resulting rows array is in the same order as the newRawData, we'll call
+ * rowsProcessors immediately after to sort the data anyway
+ * 2. if we have row hashing available, we try to use the rowHash to find the row
+ * 3. no memory leaks - rows that are no longer in newRawData need to be garbage collected
+ *
+ * The basic logic flow makes use of the newRawData, oldRows and oldHash, and creates
+ * the newRows and newHash
+ *
+ * ```
+ * newRawData.forEach newEntity
+ * if (hashing enabled)
+ * check oldHash for newEntity
+ * else
+ * look for old row directly in oldRows
+ * if !oldRowFound // must be a new row
+ * create newRow
+ * append to the newRows and add to newHash
+ * run the processors
+ * ```
+ *
+ * Rows are identified using the hashKey if configured. If not configured, then rows
+ * are identified using the gridOptions.rowEquality function
+ *
+ * This method is useful when trying to select rows immediately after loading data without
+ * using a $timeout/$interval, e.g.:
+ *
+ * $scope.gridOptions.data = someData;
+ * $scope.gridApi.grid.modifyRows($scope.gridOptions.data);
+ * $scope.gridApi.selection.selectRow($scope.gridOptions.data[0]);
+ *
+ * OR to persist row selection after data update (e.g. rows selected, new data loaded, want
+ * originally selected rows to be re-selected))
+ */
+ Grid.prototype.modifyRows = function modifyRows(newRawData) {
+ var self = this;
+ var oldRows = self.rows.slice(0);
+ var oldRowHash = self.rowHashMap || self.createRowHashMap();
+ var allRowsSelected = true;
+ self.rowHashMap = self.createRowHashMap();
+ self.rows.length = 0;
+
+ newRawData.forEach( function( newEntity, i ) {
+ var newRow, oldRow;
+
+ if ( self.options.enableRowHashing ) {
+ // if hashing is enabled, then this row will be in the hash if we already know about it
+ oldRow = oldRowHash.get( newEntity );
+ } else {
+ // otherwise, manually search the oldRows to see if we can find this row
+ oldRow = self.getRow(newEntity, oldRows);
+ }
+
+ // update newRow to have an entity
+ if ( oldRow ) {
+ newRow = oldRow;
+ newRow.entity = newEntity;
+ }
+
+ // if we didn't find the row, it must be new, so create it
+ if ( !newRow ) {
+ newRow = self.processRowBuilders(new GridRow(newEntity, i, self));
+ }
+
+ self.rows.push( newRow );
+ self.rowHashMap.put( newEntity, newRow );
+ if (!newRow.isSelected) {
+ allRowsSelected = false;
+ }
+ });
+
+ if (self.selection && self.rows.length) {
+ self.selection.selectAll = allRowsSelected;
+ }
+
+ self.assignTypes();
+
+ var p1 = $q.when(self.processRowsProcessors(self.rows))
+ .then(function (renderableRows) {
+ return self.setVisibleRows(renderableRows);
+ }).catch(angular.noop);
+
+ var p2 = $q.when(self.processColumnsProcessors(self.columns))
+ .then(function (renderableColumns) {
+ return self.setVisibleColumns(renderableColumns);
+ }).catch(angular.noop);
+
+ return $q.all([p1, p2]);
+ };
+
+
+ /**
+ * Private Undocumented Method
+ * @name addRows
+ * @methodOf ui.grid.class:Grid
+ * @description adds the newRawData array of rows to the grid and calls all registered
+ * rowBuilders. this keyword will reference the grid
+ */
+ Grid.prototype.addRows = function addRows(newRawData) {
+ var self = this,
+ existingRowCount = self.rows.length;
+
+ for (var i = 0; i < newRawData.length; i++) {
+ var newRow = self.processRowBuilders(new GridRow(newRawData[i], i + existingRowCount, self));
+
+ if (self.options.enableRowHashing) {
+ var found = self.rowHashMap.get(newRow.entity);
+ if (found) {
+ found.row = newRow;
+ }
+ }
+
+ self.rows.push(newRow);
+ }
+ };
+
+ /**
+ * @ngdoc function
+ * @name processRowBuilders
+ * @methodOf ui.grid.class:Grid
+ * @description processes all RowBuilders for the gridRow
+ * @param {GridRow} gridRow reference to gridRow
+ * @returns {GridRow} the gridRow with all additional behavior added
+ */
+ Grid.prototype.processRowBuilders = function processRowBuilders(gridRow) {
+ var self = this;
+
+ self.rowBuilders.forEach(function (builder) {
+ builder.call(self, gridRow, self.options);
+ });
+
+ return gridRow;
+ };
+
+ /**
+ * @ngdoc function
+ * @name registerStyleComputation
+ * @methodOf ui.grid.class:Grid
+ * @description registered a styleComputation function
+ *
+ * If the function returns a value it will be appended into the grid's `"
+ );
+
+
+ $templateCache.put('ui-grid/uiGridCell',
+ " {{COL_FIELD CUSTOM_FILTERS}} "
+ );
+
+
+ $templateCache.put('ui-grid/uiGridColumnMenu',
+ ""
+ );
+
+
+ $templateCache.put('ui-grid/uiGridFooterCell',
+ " {{ col.getAggregationText() + ( col.getAggregationValue() CUSTOM_FILTERS ) }} {{ col.displayName CUSTOM_FILTERS }} {{col.sort.priority + 1}} ')[0],r="reverse";return document.body.appendChild(t),0 \x3c!-- tfooter --\x3e '),e.put("ui-grid/ui-grid-grid-footer",'{{\'search.totalItems\' | t}} {{grid.rows.length}} ({{"search.showingItems" | t}} {{grid.renderContainers.body.visibleRowCache.length}}) '),e.put("ui-grid/ui-grid-header",'\x3c!-- theader --\x3e '),e.put("ui-grid/ui-grid-menu-button",'\x3c!-- TODO (c0bra): add "scoped" attr here, eventually? --\x3e '),e.put("ui-grid/uiGridCell",'{{COL_FIELD CUSTOM_FILTERS}} '),e.put("ui-grid/uiGridColumnMenu",'\x3c!-- \n --\x3e\n \n
\n \n {{ col.getAggregationText() + ( col.getAggregationValue() CUSTOM_FILTERS ) }} {{ col.displayName CUSTOM_FILTERS }} {{col.sort.priority + 1}} \x3c!-- All of these dom elements are replaced in place --\x3e "),e.put("ui-grid/uiGridViewport",'\x3c!-- tbody --\x3e ')}]);
\ No newline at end of file
diff --git a/release/4.9.2/ui-grid.css b/release/4.9.2/ui-grid.css
new file mode 100644
index 000000000..2c8381cff
--- /dev/null
+++ b/release/4.9.2/ui-grid.css
@@ -0,0 +1,1413 @@
+/*!
+ * ui-grid - v4.9.2 - 2020-12-01
+ * Copyright (c) 2020 ; License: MIT
+ */
+.ui-grid {
+ border: 1px solid #d4d4d4;
+ box-sizing: content-box;
+ -webkit-border-radius: 0px;
+ -moz-border-radius: 0px;
+ border-radius: 0px;
+ -webkit-transform: translateZ(0);
+ -moz-transform: translateZ(0);
+ -o-transform: translateZ(0);
+ -ms-transform: translateZ(0);
+ transform: translateZ(0);
+}
+.ui-grid-vertical-bar {
+ position: absolute;
+ right: 0;
+ width: 0;
+}
+.ui-grid-header-cell:not(:last-child) .ui-grid-vertical-bar,
+.ui-grid-cell:not(:last-child) .ui-grid-vertical-bar {
+ width: 1px;
+}
+.ui-grid-scrollbar-placeholder {
+ background-color: transparent;
+}
+.ui-grid-header-cell:not(:last-child) .ui-grid-vertical-bar {
+ background-color: #d4d4d4;
+}
+.ui-grid-cell:not(:last-child) .ui-grid-vertical-bar {
+ background-color: #d4d4d4;
+}
+.ui-grid-header-cell:last-child .ui-grid-vertical-bar {
+ right: -1px;
+ width: 1px;
+ background-color: #d4d4d4;
+}
+.ui-grid-clearfix:before,
+.ui-grid-clearfix:after {
+ content: "";
+ display: table;
+}
+.ui-grid-clearfix:after {
+ clear: both;
+}
+.ui-grid-invisible {
+ visibility: hidden;
+}
+.ui-grid-contents-wrapper {
+ position: relative;
+ height: 100%;
+ width: 100%;
+}
+.ui-grid-sr-only {
+ position: absolute;
+ width: 1px;
+ height: 1px;
+ margin: -1px;
+ padding: 0;
+ overflow: hidden;
+ clip: rect(0, 0, 0, 0);
+ border: 0;
+}
+.ui-grid-icon-button {
+ background-color: transparent;
+ border: none;
+ padding: 0;
+}
+.clickable {
+ cursor: pointer;
+}
+.ui-grid-top-panel-background {
+ background-color: #f3f3f3;
+}
+.ui-grid-header {
+ border-bottom: 1px solid #d4d4d4;
+ box-sizing: border-box;
+}
+.ui-grid-top-panel {
+ position: relative;
+ overflow: hidden;
+ font-weight: bold;
+ background-color: #f3f3f3;
+ -webkit-border-top-right-radius: -1px;
+ -webkit-border-bottom-right-radius: 0;
+ -webkit-border-bottom-left-radius: 0;
+ -webkit-border-top-left-radius: -1px;
+ -moz-border-radius-topright: -1px;
+ -moz-border-radius-bottomright: 0;
+ -moz-border-radius-bottomleft: 0;
+ -moz-border-radius-topleft: -1px;
+ border-top-right-radius: -1px;
+ border-bottom-right-radius: 0;
+ border-bottom-left-radius: 0;
+ border-top-left-radius: -1px;
+ -moz-background-clip: padding-box;
+ -webkit-background-clip: padding-box;
+ background-clip: padding-box;
+}
+.ui-grid-header-viewport {
+ overflow: hidden;
+}
+.ui-grid-header-canvas:before,
+.ui-grid-header-canvas:after {
+ content: "";
+ display: -ms-flexbox;
+ display: flex;
+ line-height: 0;
+}
+.ui-grid-header-canvas:after {
+ clear: both;
+}
+.ui-grid-header-cell-wrapper {
+ position: relative;
+ display: -ms-flexbox;
+ display: flex;
+ box-sizing: border-box;
+ height: 100%;
+ width: 100%;
+}
+.ui-grid-header-cell-row {
+ display: -ms-flexbox;
+ display: flex;
+ -ms-flex-direction: row;
+ flex-direction: row;
+ -ms-flex-wrap: wrap;
+ flex-wrap: wrap;
+}
+.ui-grid-header-cell {
+ position: relative;
+ box-sizing: border-box;
+ background-color: inherit;
+ border-right: 1px solid;
+ border-color: #d4d4d4;
+ -webkit-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+ width: 0;
+}
+.ui-grid-header-cell:last-child {
+ border-right: 0;
+}
+.ui-grid-header-cell .sortable {
+ cursor: pointer;
+}
+.ui-grid-header-cell .ui-grid-sort-priority-number {
+ margin-left: -8px;
+}
+/* Fixes IE word-wrap if needed on header cells */
+.ui-grid-header-cell > div {
+ -ms-flex-basis: 100%;
+ flex-basis: 100%;
+}
+.ui-grid-header .ui-grid-vertical-bar {
+ top: 0;
+ bottom: 0;
+}
+.ui-grid-column-menu-button {
+ position: absolute;
+ right: 1px;
+ top: 0;
+}
+.ui-grid-column-menu-button .ui-grid-icon-angle-down {
+ vertical-align: sub;
+}
+.ui-grid-header-cell-last-col .ui-grid-cell-contents,
+.ui-grid-header-cell-last-col .ui-grid-filter-container,
+.ui-grid-header-cell-last-col .ui-grid-column-menu-button,
+.ui-grid-header-cell-last-col + .ui-grid-column-resizer.right {
+ margin-right: 13px;
+}
+.ui-grid-render-container-right .ui-grid-header-cell-last-col .ui-grid-cell-contents,
+.ui-grid-render-container-right .ui-grid-header-cell-last-col .ui-grid-filter-container,
+.ui-grid-render-container-right .ui-grid-header-cell-last-col .ui-grid-column-menu-button,
+.ui-grid-render-container-right .ui-grid-header-cell-last-col + .ui-grid-column-resizer.right {
+ margin-right: 28px;
+}
+.ui-grid-column-menu {
+ position: absolute;
+}
+/* Slide up/down animations */
+.ui-grid-column-menu .ui-grid-menu .ui-grid-menu-mid.ng-hide-add,
+.ui-grid-column-menu .ui-grid-menu .ui-grid-menu-mid.ng-hide-remove {
+ -webkit-transition: all 0.04s linear;
+ -moz-transition: all 0.04s linear;
+ -o-transition: all 0.04s linear;
+ transition: all 0.04s linear;
+ display: block !important;
+}
+.ui-grid-column-menu .ui-grid-menu .ui-grid-menu-mid.ng-hide-add.ng-hide-add-active,
+.ui-grid-column-menu .ui-grid-menu .ui-grid-menu-mid.ng-hide-remove {
+ -webkit-transform: translateY(-100%);
+ -moz-transform: translateY(-100%);
+ -o-transform: translateY(-100%);
+ -ms-transform: translateY(-100%);
+ transform: translateY(-100%);
+}
+.ui-grid-column-menu .ui-grid-menu .ui-grid-menu-mid.ng-hide-add,
+.ui-grid-column-menu .ui-grid-menu .ui-grid-menu-mid.ng-hide-remove.ng-hide-remove-active {
+ -webkit-transform: translateY(0);
+ -moz-transform: translateY(0);
+ -o-transform: translateY(0);
+ -ms-transform: translateY(0);
+ transform: translateY(0);
+}
+/* Slide up/down animations */
+.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid.ng-hide-add,
+.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid.ng-hide-remove {
+ -webkit-transition: all 0.04s linear;
+ -moz-transition: all 0.04s linear;
+ -o-transition: all 0.04s linear;
+ transition: all 0.04s linear;
+ display: block !important;
+}
+.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid.ng-hide-add.ng-hide-add-active,
+.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid.ng-hide-remove {
+ -webkit-transform: translateY(-100%);
+ -moz-transform: translateY(-100%);
+ -o-transform: translateY(-100%);
+ -ms-transform: translateY(-100%);
+ transform: translateY(-100%);
+}
+.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid.ng-hide-add,
+.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid.ng-hide-remove.ng-hide-remove-active {
+ -webkit-transform: translateY(0);
+ -moz-transform: translateY(0);
+ -o-transform: translateY(0);
+ -ms-transform: translateY(0);
+ transform: translateY(0);
+}
+.ui-grid-filter-container {
+ padding: 4px 10px;
+ position: relative;
+}
+.ui-grid-filter-container .ui-grid-filter-button {
+ position: absolute;
+ top: 0;
+ bottom: 0;
+ right: 0;
+}
+.ui-grid-filter-container .ui-grid-filter-button [class^="ui-grid-icon"] {
+ position: absolute;
+ top: 50%;
+ line-height: 32px;
+ margin-top: -16px;
+ right: 10px;
+ opacity: 0.66;
+}
+.ui-grid-filter-container .ui-grid-filter-button [class^="ui-grid-icon"]:hover {
+ opacity: 1;
+}
+.ui-grid-filter-container .ui-grid-filter-button-select {
+ position: absolute;
+ top: 0;
+ bottom: 0;
+ right: 0;
+}
+.ui-grid-filter-container .ui-grid-filter-button-select [class^="ui-grid-icon"] {
+ position: absolute;
+ top: 50%;
+ line-height: 32px;
+ margin-top: -16px;
+ right: 0px;
+ opacity: 0.66;
+}
+.ui-grid-filter-container .ui-grid-filter-button-select [class^="ui-grid-icon"]:hover {
+ opacity: 1;
+}
+input[type="text"].ui-grid-filter-input {
+ box-sizing: border-box;
+ padding: 0 18px 0 0;
+ margin: 0;
+ width: 100%;
+ border: 1px solid #d4d4d4;
+ -webkit-border-top-right-radius: 0px;
+ -webkit-border-bottom-right-radius: 0;
+ -webkit-border-bottom-left-radius: 0;
+ -webkit-border-top-left-radius: 0;
+ -moz-border-radius-topright: 0px;
+ -moz-border-radius-bottomright: 0;
+ -moz-border-radius-bottomleft: 0;
+ -moz-border-radius-topleft: 0;
+ border-top-right-radius: 0px;
+ border-bottom-right-radius: 0;
+ border-bottom-left-radius: 0;
+ border-top-left-radius: 0;
+ -moz-background-clip: padding-box;
+ -webkit-background-clip: padding-box;
+ background-clip: padding-box;
+}
+input[type="text"].ui-grid-filter-input:hover {
+ border: 1px solid #d4d4d4;
+}
+select.ui-grid-filter-select {
+ padding: 0;
+ margin: 0;
+ border: 0;
+ width: 90%;
+ border: 1px solid #d4d4d4;
+ -webkit-border-top-right-radius: 0px;
+ -webkit-border-bottom-right-radius: 0;
+ -webkit-border-bottom-left-radius: 0;
+ -webkit-border-top-left-radius: 0;
+ -moz-border-radius-topright: 0px;
+ -moz-border-radius-bottomright: 0;
+ -moz-border-radius-bottomleft: 0;
+ -moz-border-radius-topleft: 0;
+ border-top-right-radius: 0px;
+ border-bottom-right-radius: 0;
+ border-bottom-left-radius: 0;
+ border-top-left-radius: 0;
+ -moz-background-clip: padding-box;
+ -webkit-background-clip: padding-box;
+ background-clip: padding-box;
+}
+select.ui-grid-filter-select:hover {
+ border: 1px solid #d4d4d4;
+}
+.ui-grid-filter-cancel-button-hidden select.ui-grid-filter-select {
+ width: 100%;
+}
+.ui-grid-render-container {
+ position: inherit;
+ -webkit-border-top-right-radius: 0;
+ -webkit-border-bottom-right-radius: 0px;
+ -webkit-border-bottom-left-radius: 0px;
+ -webkit-border-top-left-radius: 0;
+ -moz-border-radius-topright: 0;
+ -moz-border-radius-bottomright: 0px;
+ -moz-border-radius-bottomleft: 0px;
+ -moz-border-radius-topleft: 0;
+ border-top-right-radius: 0;
+ border-bottom-right-radius: 0px;
+ border-bottom-left-radius: 0px;
+ border-top-left-radius: 0;
+ -moz-background-clip: padding-box;
+ -webkit-background-clip: padding-box;
+ background-clip: padding-box;
+}
+.ui-grid-render-container:focus {
+ outline: none;
+}
+.ui-grid-viewport {
+ min-height: 20px;
+ position: relative;
+ overflow-y: scroll;
+ -webkit-overflow-scrolling: touch;
+}
+.ui-grid-viewport:focus {
+ outline: none !important;
+}
+.ui-grid-canvas {
+ position: relative;
+ padding-top: 1px;
+}
+.ui-grid-row {
+ clear: both;
+}
+.ui-grid-row:nth-child(odd) .ui-grid-cell {
+ background-color: #fdfdfd;
+}
+.ui-grid-row:nth-child(even) .ui-grid-cell {
+ background-color: #f3f3f3;
+}
+.ui-grid-row:last-child .ui-grid-cell {
+ border-bottom-color: #d4d4d4;
+ border-bottom-style: solid;
+}
+.ui-grid-row:hover > [ui-grid-row] > .ui-grid-cell:hover .ui-grid-cell,
+.ui-grid-row:nth-child(odd):hover .ui-grid-cell,
+.ui-grid-row:nth-child(even):hover .ui-grid-cell {
+ background-color: #d5eaee;
+}
+.ui-grid-no-row-overlay {
+ position: absolute;
+ top: 0;
+ bottom: 0;
+ left: 0;
+ right: 0;
+ margin: 10%;
+ background-color: #f3f3f3;
+ -webkit-border-top-right-radius: 0px;
+ -webkit-border-bottom-right-radius: 0;
+ -webkit-border-bottom-left-radius: 0;
+ -webkit-border-top-left-radius: 0;
+ -moz-border-radius-topright: 0px;
+ -moz-border-radius-bottomright: 0;
+ -moz-border-radius-bottomleft: 0;
+ -moz-border-radius-topleft: 0;
+ border-top-right-radius: 0px;
+ border-bottom-right-radius: 0;
+ border-bottom-left-radius: 0;
+ border-top-left-radius: 0;
+ -moz-background-clip: padding-box;
+ -webkit-background-clip: padding-box;
+ background-clip: padding-box;
+ border: 1px solid #d4d4d4;
+ font-size: 2em;
+ text-align: center;
+}
+.ui-grid-no-row-overlay > * {
+ position: absolute;
+ display: table;
+ margin: auto 0;
+ width: 100%;
+ top: 0;
+ bottom: 0;
+ left: 0;
+ right: 0;
+ opacity: 0.66;
+}
+.ui-grid-cell {
+ overflow: hidden;
+ float: left;
+ background-color: inherit;
+ border-right: 1px solid;
+ border-color: #d4d4d4;
+ box-sizing: border-box;
+}
+.ui-grid-cell:last-child {
+ border-right: 0;
+}
+.ui-grid-cell-contents {
+ padding: 5px;
+ -moz-box-sizing: border-box;
+ -webkit-box-sizing: border-box;
+ box-sizing: border-box;
+ white-space: nowrap;
+ -ms-text-overflow: ellipsis;
+ -o-text-overflow: ellipsis;
+ text-overflow: ellipsis;
+ overflow: hidden;
+ height: 100%;
+}
+.ui-grid-cell-contents-hidden {
+ visibility: hidden;
+ width: 0;
+ height: 0;
+ display: none;
+}
+.ui-grid-row .ui-grid-cell.ui-grid-row-header-cell {
+ background-color: #F0F0EE;
+ border-bottom: solid 1px #d4d4d4;
+}
+.ui-grid-cell-empty {
+ display: inline-block;
+ width: 10px;
+ height: 10px;
+}
+.ui-grid-footer-info {
+ padding: 5px 10px;
+}
+.ui-grid-footer-panel-background {
+ background-color: #f3f3f3;
+}
+.ui-grid-footer-panel {
+ position: relative;
+ border-bottom: 1px solid #d4d4d4;
+ border-top: 1px solid #d4d4d4;
+ overflow: hidden;
+ font-weight: bold;
+ background-color: #f3f3f3;
+ -webkit-border-top-right-radius: -1px;
+ -webkit-border-bottom-right-radius: 0;
+ -webkit-border-bottom-left-radius: 0;
+ -webkit-border-top-left-radius: -1px;
+ -moz-border-radius-topright: -1px;
+ -moz-border-radius-bottomright: 0;
+ -moz-border-radius-bottomleft: 0;
+ -moz-border-radius-topleft: -1px;
+ border-top-right-radius: -1px;
+ border-bottom-right-radius: 0;
+ border-bottom-left-radius: 0;
+ border-top-left-radius: -1px;
+ -moz-background-clip: padding-box;
+ -webkit-background-clip: padding-box;
+ background-clip: padding-box;
+}
+.ui-grid-grid-footer {
+ float: left;
+ width: 100%;
+}
+.ui-grid-footer-viewport,
+.ui-grid-footer-canvas {
+ height: 100%;
+}
+.ui-grid-footer-viewport {
+ overflow: hidden;
+}
+.ui-grid-footer-canvas {
+ position: relative;
+}
+.ui-grid-footer-canvas:before,
+.ui-grid-footer-canvas:after {
+ content: "";
+ display: table;
+ line-height: 0;
+}
+.ui-grid-footer-canvas:after {
+ clear: both;
+}
+.ui-grid-footer-cell-wrapper {
+ position: relative;
+ display: table;
+ box-sizing: border-box;
+ height: 100%;
+}
+.ui-grid-footer-cell-row {
+ display: table-row;
+}
+.ui-grid-footer-cell {
+ overflow: hidden;
+ background-color: inherit;
+ border-right: 1px solid;
+ border-color: #d4d4d4;
+ box-sizing: border-box;
+ display: table-cell;
+}
+.ui-grid-footer-cell:last-child {
+ border-right: 0;
+}
+.ui-grid-menu-button {
+ z-index: 2;
+ position: absolute;
+ right: 0;
+ top: 0;
+ background: #f3f3f3;
+ border: 0;
+ border-left: 1px solid #d4d4d4;
+ border-bottom: 1px solid #d4d4d4;
+ cursor: pointer;
+ height: 32px;
+ font-weight: normal;
+}
+.ui-grid-menu-button .ui-grid-icon-container {
+ margin-top: 5px;
+ margin-left: 2px;
+}
+.ui-grid-menu-button .ui-grid-menu {
+ right: 0;
+}
+.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid {
+ overflow: scroll;
+}
+.ui-grid-menu {
+ overflow: hidden;
+ max-width: 320px;
+ z-index: 2;
+ position: absolute;
+ right: 100%;
+ padding: 0 10px 20px 10px;
+ cursor: pointer;
+ box-sizing: border-box;
+}
+.ui-grid-menu-item {
+ width: 100%;
+ overflow: hidden;
+ text-overflow: ellipsis;
+ white-space: nowrap;
+}
+.ui-grid-menu .ui-grid-menu-inner {
+ background: #fff;
+ border: 1px solid #d4d4d4;
+ position: relative;
+ white-space: nowrap;
+ -webkit-border-radius: 0px;
+ -moz-border-radius: 0px;
+ border-radius: 0px;
+}
+.ui-grid-menu .ui-grid-menu-inner ul {
+ margin: 0;
+ padding: 0;
+ list-style-type: none;
+}
+.ui-grid-menu .ui-grid-menu-inner ul li {
+ padding: 0;
+}
+.ui-grid-menu .ui-grid-menu-inner ul li .ui-grid-menu-item {
+ color: #000;
+ min-width: 100%;
+ padding: 8px;
+ text-align: left;
+ background: transparent;
+ border: none;
+ cursor: default;
+}
+.ui-grid-menu .ui-grid-menu-inner ul li button.ui-grid-menu-item {
+ cursor: pointer;
+}
+.ui-grid-menu .ui-grid-menu-inner ul li button.ui-grid-menu-item:hover,
+.ui-grid-menu .ui-grid-menu-inner ul li button.ui-grid-menu-item:focus {
+ background-color: #b3c4c7;
+}
+.ui-grid-menu .ui-grid-menu-inner ul li button.ui-grid-menu-item.ui-grid-menu-item-active {
+ background-color: #9cb2b6;
+}
+.ui-grid-menu .ui-grid-menu-inner ul li:not(:last-child) > .ui-grid-menu-item {
+ border-bottom: 1px solid #d4d4d4;
+}
+.ui-grid-sortarrow {
+ right: 5px;
+ position: absolute;
+ width: 20px;
+ top: 0;
+ bottom: 0;
+ background-position: center;
+}
+.ui-grid-sortarrow.down {
+ -webkit-transform: rotate(180deg);
+ -moz-transform: rotate(180deg);
+ -o-transform: rotate(180deg);
+ -ms-transform: rotate(180deg);
+ transform: rotate(180deg);
+}
+@font-face {
+ font-family: 'ui-grid';
+ src: url('fonts/ui-grid.eot');
+ src: url('fonts/ui-grid.eot#iefix') format('embedded-opentype'), url('fonts/ui-grid.woff') format('woff'), url('fonts/ui-grid.ttf') format('truetype'), url('fonts/ui-grid.svg?#ui-grid') format('svg');
+ font-weight: normal;
+ font-style: normal;
+}
+/* Chrome hack: SVG is rendered more smooth in Windozze. 100% magic, uncomment if you need it. */
+/* Note, that will break hinting! In other OS-es font will be not as sharp as it could be */
+/*
+@media screen and (-webkit-min-device-pixel-ratio:0) {
+ @font-face {
+ font-family: 'ui-grid';
+ src: url('@{font-path}ui-grid.svg?12312827#ui-grid') format('svg');
+ }
+}
+*/
+[class^="ui-grid-icon"]:before,
+[class*=" ui-grid-icon"]:before {
+ font-family: "ui-grid";
+ font-style: normal;
+ font-weight: normal;
+ speak: none;
+ display: inline-block;
+ text-decoration: inherit;
+ width: 1em;
+ margin-right: 0.2em;
+ text-align: center;
+ /* opacity: .8; */
+ /* For safety - reset parent styles, that can break glyph codes*/
+ font-variant: normal;
+ text-transform: none;
+ /* fix buttons height, for twitter bootstrap */
+ line-height: 1em;
+ /* Animation center compensation - margins should be symmetric */
+ /* remove if not needed */
+ margin-left: 0.2em;
+ /* you can be more comfortable with increased icons size */
+ /* font-size: 120%; */
+ /* Uncomment for 3D effect */
+ /* text-shadow: 1px 1px 1px rgba(127, 127, 127, 0.3); */
+}
+.ui-grid-icon-blank::before {
+ width: 1em;
+ content: ' ';
+}
+.ui-grid-icon-plus-squared:before {
+ content: '\c350';
+}
+.ui-grid-icon-minus-squared:before {
+ content: '\c351';
+}
+.ui-grid-icon-search:before {
+ content: '\c352';
+}
+.ui-grid-icon-cancel:before {
+ content: '\c353';
+}
+.ui-grid-icon-info-circled:before {
+ content: '\c354';
+}
+.ui-grid-icon-lock:before {
+ content: '\c355';
+}
+.ui-grid-icon-lock-open:before {
+ content: '\c356';
+}
+.ui-grid-icon-pencil:before {
+ content: '\c357';
+}
+.ui-grid-icon-down-dir:before {
+ content: '\c358';
+}
+.ui-grid-icon-up-dir:before {
+ content: '\c359';
+}
+.ui-grid-icon-left-dir:before {
+ content: '\c35a';
+}
+.ui-grid-icon-right-dir:before {
+ content: '\c35b';
+}
+.ui-grid-icon-left-open:before {
+ content: '\c35c';
+}
+.ui-grid-icon-right-open:before {
+ content: '\c35d';
+}
+.ui-grid-icon-angle-down:before {
+ content: '\c35e';
+}
+.ui-grid-icon-filter:before {
+ content: '\c35f';
+}
+.ui-grid-icon-sort-alt-up:before {
+ content: '\c360';
+}
+.ui-grid-icon-sort-alt-down:before {
+ content: '\c361';
+}
+.ui-grid-icon-ok:before {
+ content: '\c362';
+}
+.ui-grid-icon-menu:before {
+ content: '\c363';
+}
+.ui-grid-icon-indent-left:before {
+ content: '\e800';
+}
+.ui-grid-icon-indent-right:before {
+ content: '\e801';
+}
+.ui-grid-icon-spin5:before {
+ content: '\ea61';
+}
+/*
+* RTL Styles
+*/
+.ui-grid[dir=rtl] .ui-grid-header-cell,
+.ui-grid[dir=rtl] .ui-grid-footer-cell,
+.ui-grid[dir=rtl] .ui-grid-cell {
+ float: right !important;
+}
+.ui-grid[dir=rtl] .ui-grid-column-menu-button {
+ position: absolute;
+ left: 1px;
+ top: 0;
+ right: inherit;
+}
+.ui-grid[dir=rtl] .ui-grid-cell:first-child,
+.ui-grid[dir=rtl] .ui-grid-header-cell:first-child,
+.ui-grid[dir=rtl] .ui-grid-footer-cell:first-child {
+ border-right: 0;
+}
+.ui-grid[dir=rtl] .ui-grid-cell:last-child,
+.ui-grid[dir=rtl] .ui-grid-header-cell:last-child {
+ border-right: 1px solid #d4d4d4;
+ border-left: 0;
+}
+.ui-grid[dir=rtl] .ui-grid-header-cell:first-child .ui-grid-vertical-bar,
+.ui-grid[dir=rtl] .ui-grid-footer-cell:first-child .ui-grid-vertical-bar,
+.ui-grid[dir=rtl] .ui-grid-cell:first-child .ui-grid-vertical-bar {
+ width: 0;
+}
+.ui-grid[dir=rtl] .ui-grid-menu-button {
+ z-index: 2;
+ position: absolute;
+ left: 0;
+ right: auto;
+ background: #f3f3f3;
+ border: 1px solid #d4d4d4;
+ cursor: pointer;
+ min-height: 27px;
+ font-weight: normal;
+}
+.ui-grid[dir=rtl] .ui-grid-menu-button .ui-grid-menu {
+ left: 0;
+ right: auto;
+}
+.ui-grid[dir=rtl] .ui-grid-filter-container .ui-grid-filter-button {
+ right: initial;
+ left: 0;
+}
+.ui-grid[dir=rtl] .ui-grid-filter-container .ui-grid-filter-button [class^="ui-grid-icon"] {
+ right: initial;
+ left: 10px;
+}
+/*
+ Animation example, for spinners
+*/
+.ui-grid-animate-spin {
+ -moz-animation: ui-grid-spin 2s infinite linear;
+ -o-animation: ui-grid-spin 2s infinite linear;
+ -webkit-animation: ui-grid-spin 2s infinite linear;
+ animation: ui-grid-spin 2s infinite linear;
+ display: inline-block;
+}
+@-moz-keyframes ui-grid-spin {
+ 0% {
+ -moz-transform: rotate(0deg);
+ -o-transform: rotate(0deg);
+ -webkit-transform: rotate(0deg);
+ transform: rotate(0deg);
+ }
+ 100% {
+ -moz-transform: rotate(359deg);
+ -o-transform: rotate(359deg);
+ -webkit-transform: rotate(359deg);
+ transform: rotate(359deg);
+ }
+}
+@-webkit-keyframes ui-grid-spin {
+ 0% {
+ -moz-transform: rotate(0deg);
+ -o-transform: rotate(0deg);
+ -webkit-transform: rotate(0deg);
+ transform: rotate(0deg);
+ }
+ 100% {
+ -moz-transform: rotate(359deg);
+ -o-transform: rotate(359deg);
+ -webkit-transform: rotate(359deg);
+ transform: rotate(359deg);
+ }
+}
+@-o-keyframes ui-grid-spin {
+ 0% {
+ -moz-transform: rotate(0deg);
+ -o-transform: rotate(0deg);
+ -webkit-transform: rotate(0deg);
+ transform: rotate(0deg);
+ }
+ 100% {
+ -moz-transform: rotate(359deg);
+ -o-transform: rotate(359deg);
+ -webkit-transform: rotate(359deg);
+ transform: rotate(359deg);
+ }
+}
+@-ms-keyframes ui-grid-spin {
+ 0% {
+ -moz-transform: rotate(0deg);
+ -o-transform: rotate(0deg);
+ -webkit-transform: rotate(0deg);
+ transform: rotate(0deg);
+ }
+ 100% {
+ -moz-transform: rotate(359deg);
+ -o-transform: rotate(359deg);
+ -webkit-transform: rotate(359deg);
+ transform: rotate(359deg);
+ }
+}
+@keyframes ui-grid-spin {
+ 0% {
+ -moz-transform: rotate(0deg);
+ -o-transform: rotate(0deg);
+ -webkit-transform: rotate(0deg);
+ transform: rotate(0deg);
+ }
+ 100% {
+ -moz-transform: rotate(359deg);
+ -o-transform: rotate(359deg);
+ -webkit-transform: rotate(359deg);
+ transform: rotate(359deg);
+ }
+}
+
+.ui-grid-cell-focus {
+ outline: 0;
+ background-color: #b3c4c7;
+}
+.ui-grid-focuser {
+ position: absolute;
+ left: 0;
+ top: 0;
+ z-index: -1;
+ width: 100%;
+ height: 100%;
+}
+.ui-grid-focuser:focus {
+ border-color: #66afe9;
+ outline: 0;
+ -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 8px rgba(102, 175, 233, 0.6);
+ box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 8px rgba(102, 175, 233, 0.6);
+}
+.ui-grid-offscreen {
+ display: block;
+ position: absolute;
+ left: -10000px;
+ top: -10000px;
+ clip: rect(0px, 0px, 0px, 0px);
+}
+
+.ui-grid-cell input {
+ border-radius: inherit;
+ padding: 0;
+ width: 100%;
+ color: inherit;
+ height: auto;
+ font: inherit;
+ outline: none;
+}
+.ui-grid-cell input:focus {
+ color: inherit;
+ outline: none;
+}
+.ui-grid-cell input[type="checkbox"] {
+ margin: 9px 0 0 6px;
+ width: auto;
+}
+.ui-grid-cell input.ng-invalid {
+ border: 1px solid #fc8f8f;
+}
+.ui-grid-cell input.ng-valid {
+ border: 1px solid #d4d4d4;
+}
+
+.ui-grid-viewport .ui-grid-empty-base-layer-container {
+ position: absolute;
+ overflow: hidden;
+ pointer-events: none;
+ z-index: -1;
+}
+
+.expandableRow .ui-grid-row:nth-child(odd) .ui-grid-cell {
+ background-color: #fdfdfd;
+}
+.expandableRow .ui-grid-row:nth-child(even) .ui-grid-cell {
+ background-color: #f3f3f3;
+}
+.ui-grid-cell.ui-grid-disable-selection.ui-grid-row-header-cell {
+ pointer-events: none;
+}
+.ui-grid-expandable-buttons-cell i {
+ pointer-events: all;
+}
+.scrollFiller {
+ float: left;
+ border: 1px solid #d4d4d4;
+}
+
+
+.ui-grid-tree-header-row {
+ font-weight: bold !important;
+}
+
+
+.movingColumn {
+ position: absolute;
+ top: 0;
+ border: 1px solid #d4d4d4;
+ box-shadow: inset 0 0 14px rgba(0, 0, 0, 0.2);
+}
+.movingColumn .ui-grid-icon-angle-down {
+ display: none;
+}
+
+/* This file contains variable declarations (do not remove this line) */
+/*-- VARIABLES (DO NOT REMOVE THESE COMMENTS) --*/
+/**
+* @section Grid styles
+*/
+/**
+* @section Header styles
+*/
+/** @description Colors for header gradient */
+/**
+* @section Grid body styles
+*/
+/** @description Colors used for row alternation */
+/**
+* @section Grid Menu colors
+*/
+/**
+* @section Sort arrow colors
+*/
+/**
+* @section Scrollbar styles
+*/
+/**
+* @section font library path
+*/
+/*-- END VARIABLES (DO NOT REMOVE THESE COMMENTS) --*/
+/*---------------------------------------------------
+ LESS Elements 0.9
+ ---------------------------------------------------
+ A set of useful LESS mixins
+ More info at: http://lesselements.com
+ ---------------------------------------------------*/
+.ui-grid-pager-panel {
+ display: flex;
+ justify-content: space-between;
+ align-items: center;
+ position: absolute;
+ left: 0;
+ bottom: 0;
+ width: 100%;
+ padding-top: 3px;
+ padding-bottom: 3px;
+ box-sizing: content-box;
+}
+.ui-grid-pager-container {
+ float: left;
+}
+.ui-grid-pager-control {
+ padding: 5px 0;
+ display: flex;
+ flex-flow: row nowrap;
+ align-items: center;
+ margin-right: 10px;
+ margin-left: 10px;
+ min-width: 135px;
+ float: left;
+}
+.ui-grid-pager-control button,
+.ui-grid-pager-control span,
+.ui-grid-pager-control input {
+ margin-right: 4px;
+}
+.ui-grid-pager-control button {
+ height: 25px;
+ min-width: 26px;
+ display: inline-block;
+ margin-bottom: 0;
+ font-weight: normal;
+ text-align: center;
+ vertical-align: middle;
+ touch-action: manipulation;
+ cursor: pointer;
+ background: #f3f3f3;
+ border: 1px solid #ccc;
+ white-space: nowrap;
+ padding: 6px 12px;
+ font-size: 14px;
+ line-height: 1.42857143;
+ border-radius: 4px;
+ -webkit-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+ color: #eee;
+}
+.ui-grid-pager-control button:hover {
+ border-color: #adadad;
+ text-decoration: none;
+}
+.ui-grid-pager-control button:focus {
+ border-color: #8c8c8c;
+ text-decoration: none;
+ outline: 5px auto -webkit-focus-ring-color;
+ outline-offset: -2px;
+}
+.ui-grid-pager-control button:active {
+ border-color: #adadad;
+ outline: 0;
+ -webkit-box-shadow: inset 0 3px 5px rgba(0, 0, 0, 0.125);
+ box-shadow: inset 0 3px 5px rgba(0, 0, 0, 0.125);
+}
+.ui-grid-pager-control button:active:focus {
+ outline: 5px auto -webkit-focus-ring-color;
+ outline-offset: -2px;
+}
+.ui-grid-pager-control button:active:hover,
+.ui-grid-pager-control button:active:focus {
+ background-color: #c8c8c8;
+ border-color: #8c8c8c;
+}
+.ui-grid-pager-control button:hover,
+.ui-grid-pager-control button:focus,
+.ui-grid-pager-control button:active {
+ color: #eee;
+ background: #dadada;
+}
+.ui-grid-pager-control button[disabled] {
+ cursor: not-allowed;
+ opacity: 0.65;
+ filter: alpha(opacity=65);
+ -webkit-box-shadow: none;
+ box-shadow: none;
+}
+.ui-grid-pager-control button[disabled]:hover,
+.ui-grid-pager-control button[disabled]:focus {
+ background-color: #f3f3f3;
+ border-color: #ccc;
+}
+.ui-grid-pager-control input {
+ display: inline;
+ height: 26px;
+ width: 50px;
+ vertical-align: top;
+ color: #555555;
+ background: #fff;
+ border: 1px solid #ccc;
+ -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075);
+ box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075);
+ -webkit-transition: border-color ease-in-out 0.15s, box-shadow ease-in-out 0.15s;
+ -o-transition: border-color ease-in-out 0.15s, box-shadow ease-in-out 0.15s;
+ transition: border-color ease-in-out 0.15s, box-shadow ease-in-out 0.15s;
+ padding: 5px 10px;
+ font-size: 12px;
+ line-height: 1.5;
+ border-radius: 3px;
+}
+.ui-grid-pager-control input:focus {
+ border-color: #66afe9;
+ outline: 0;
+ -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 8px rgba(102, 175, 233, 0.6);
+ box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 8px rgba(102, 175, 233, 0.6);
+}
+.ui-grid-pager-control input[disabled],
+.ui-grid-pager-control input[readonly],
+.ui-grid-pager-control input::-moz-placeholder {
+ opacity: 1;
+}
+.ui-grid-pager-control input::-moz-placeholder,
+.ui-grid-pager-control input:-ms-input-placeholder,
+.ui-grid-pager-control input::-webkit-input-placeholder {
+ color: #999;
+}
+.ui-grid-pager-control input::-ms-expand {
+ border: 0;
+ background-color: transparent;
+}
+.ui-grid-pager-control input[disabled],
+.ui-grid-pager-control input[readonly] {
+ background-color: #eeeeee;
+}
+.ui-grid-pager-control input[disabled] {
+ cursor: not-allowed;
+}
+.ui-grid-pager-control .ui-grid-pager-max-pages-number {
+ vertical-align: bottom;
+}
+.ui-grid-pager-control .ui-grid-pager-max-pages-number > * {
+ vertical-align: bottom;
+}
+.ui-grid-pager-control .ui-grid-pager-max-pages-number abbr {
+ border-bottom: none;
+ text-decoration: none;
+}
+.ui-grid-pager-control .first-bar {
+ width: 10px;
+ border-left: 2px solid #4d4d4d;
+ margin-top: -6px;
+ height: 12px;
+ margin-left: -3px;
+}
+.ui-grid-pager-control .first-bar-rtl {
+ width: 10px;
+ border-left: 2px solid #4d4d4d;
+ margin-top: -6px;
+ height: 12px;
+ margin-right: -7px;
+}
+.ui-grid-pager-control .first-triangle {
+ width: 0;
+ height: 0;
+ border-style: solid;
+ border-width: 5px 8.7px 5px 0;
+ border-color: transparent #4d4d4d transparent transparent;
+ margin-left: 2px;
+}
+.ui-grid-pager-control .next-triangle {
+ margin-left: 1px;
+}
+.ui-grid-pager-control .prev-triangle {
+ margin-left: 0;
+}
+.ui-grid-pager-control .last-triangle {
+ width: 0;
+ height: 0;
+ border-style: solid;
+ border-width: 5px 0 5px 8.7px;
+ border-color: transparent transparent transparent #4d4d4d;
+ margin-left: -1px;
+}
+.ui-grid-pager-control .last-bar {
+ width: 10px;
+ border-left: 2px solid #4d4d4d;
+ margin-top: -6px;
+ height: 12px;
+ margin-left: 1px;
+}
+.ui-grid-pager-control .last-bar-rtl {
+ width: 10px;
+ border-left: 2px solid #4d4d4d;
+ margin-top: -6px;
+ height: 12px;
+ margin-right: -11px;
+}
+.ui-grid-pager-row-count-picker {
+ float: left;
+ padding: 5px 10px;
+}
+.ui-grid-pager-row-count-picker select {
+ color: #555555;
+ background: #fff;
+ border: 1px solid #ccc;
+ -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075);
+ box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075);
+ -webkit-transition: border-color ease-in-out 0.15s, box-shadow ease-in-out 0.15s;
+ -o-transition: border-color ease-in-out 0.15s, box-shadow ease-in-out 0.15s;
+ transition: border-color ease-in-out 0.15s, box-shadow ease-in-out 0.15s;
+ padding: 5px 10px;
+ font-size: 12px;
+ line-height: 1.5;
+ border-radius: 3px;
+ height: 25px;
+ width: 67px;
+ display: inline;
+ vertical-align: middle;
+}
+.ui-grid-pager-row-count-picker select:focus {
+ border-color: #66afe9;
+ outline: 0;
+ -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 8px rgba(102, 175, 233, 0.6);
+ box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 8px rgba(102, 175, 233, 0.6);
+}
+.ui-grid-pager-row-count-picker select[disabled],
+.ui-grid-pager-row-count-picker select[readonly],
+.ui-grid-pager-row-count-picker select::-moz-placeholder {
+ opacity: 1;
+}
+.ui-grid-pager-row-count-picker select::-moz-placeholder,
+.ui-grid-pager-row-count-picker select:-ms-input-placeholder,
+.ui-grid-pager-row-count-picker select::-webkit-input-placeholder {
+ color: #999;
+}
+.ui-grid-pager-row-count-picker select::-ms-expand {
+ border: 0;
+ background-color: transparent;
+}
+.ui-grid-pager-row-count-picker select[disabled],
+.ui-grid-pager-row-count-picker select[readonly] {
+ background-color: #eeeeee;
+}
+.ui-grid-pager-row-count-picker select[disabled] {
+ cursor: not-allowed;
+}
+.ui-grid-pager-row-count-picker .ui-grid-pager-row-count-label {
+ margin-top: 3px;
+}
+.ui-grid-pager-count-container {
+ float: right;
+ margin-top: 4px;
+ min-width: 50px;
+}
+.ui-grid-pager-count-container .ui-grid-pager-count {
+ margin-right: 10px;
+ margin-left: 10px;
+ float: right;
+}
+.ui-grid-pager-count-container .ui-grid-pager-count abbr {
+ border-bottom: none;
+ text-decoration: none;
+}
+
+.ui-grid-pinned-container {
+ position: absolute;
+ display: inline;
+ top: 0;
+}
+.ui-grid-pinned-container.ui-grid-pinned-container-left {
+ float: left;
+ left: 0;
+}
+.ui-grid-pinned-container.ui-grid-pinned-container-right {
+ float: right;
+ right: 0;
+}
+.ui-grid-pinned-container.ui-grid-pinned-container-left .ui-grid-header-cell:last-child {
+ box-sizing: border-box;
+ border-right: 1px solid;
+ border-width: 1px;
+ border-right-color: #aeaeae;
+}
+.ui-grid-pinned-container.ui-grid-pinned-container-left .ui-grid-cell:last-child {
+ box-sizing: border-box;
+ border-right: 1px solid;
+ border-width: 1px;
+ border-right-color: #aeaeae;
+}
+.ui-grid-pinned-container.ui-grid-pinned-container-left .ui-grid-header-cell:not(:last-child) .ui-grid-vertical-bar,
+.ui-grid-pinned-container .ui-grid-cell:not(:last-child) .ui-grid-vertical-bar {
+ width: 1px;
+}
+.ui-grid-pinned-container.ui-grid-pinned-container-left .ui-grid-header-cell:not(:last-child) .ui-grid-vertical-bar {
+ background-color: #d4d4d4;
+}
+.ui-grid-pinned-container.ui-grid-pinned-container-left .ui-grid-cell:not(:last-child) .ui-grid-vertical-bar {
+ background-color: #aeaeae;
+}
+.ui-grid-pinned-container.ui-grid-pinned-container-left .ui-grid-header-cell:last-child .ui-grid-vertical-bar {
+ right: -1px;
+ width: 1px;
+ background-color: #aeaeae;
+}
+.ui-grid-pinned-container.ui-grid-pinned-container-right .ui-grid-header-cell:first-child {
+ box-sizing: border-box;
+ border-left: 1px solid;
+ border-width: 1px;
+ border-left-color: #aeaeae;
+}
+.ui-grid-pinned-container.ui-grid-pinned-container-right .ui-grid-cell:first-child {
+ box-sizing: border-box;
+ border-left: 1px solid;
+ border-width: 1px;
+ border-left-color: #aeaeae;
+}
+.ui-grid-pinned-container.ui-grid-pinned-container-right .ui-grid-header-cell:not(:first-child) .ui-grid-vertical-bar,
+.ui-grid-pinned-container .ui-grid-cell:not(:first-child) .ui-grid-vertical-bar {
+ width: 1px;
+}
+.ui-grid-pinned-container.ui-grid-pinned-container-right .ui-grid-header-cell:not(:first-child) .ui-grid-vertical-bar {
+ background-color: #d4d4d4;
+}
+.ui-grid-pinned-container.ui-grid-pinned-container-right .ui-grid-cell:not(:last-child) .ui-grid-vertical-bar {
+ background-color: #aeaeae;
+}
+.ui-grid-pinned-container.ui-grid-pinned-container-first .ui-grid-header-cell:first-child .ui-grid-vertical-bar {
+ left: -1px;
+ width: 1px;
+ background-color: #aeaeae;
+}
+
+.ui-grid-column-resizer {
+ top: 0;
+ bottom: 0;
+ width: 5px;
+ position: absolute;
+ cursor: col-resize;
+}
+.ui-grid-column-resizer.left {
+ left: 0;
+}
+.ui-grid-column-resizer.right {
+ right: 0;
+}
+.ui-grid-header-cell:last-child .ui-grid-column-resizer.right {
+ border-right: 1px solid #d4d4d4;
+}
+.ui-grid[dir=rtl] .ui-grid-header-cell:last-child .ui-grid-column-resizer.right {
+ border-right: 0;
+}
+.ui-grid[dir=rtl] .ui-grid-header-cell:last-child .ui-grid-column-resizer.left {
+ border-left: 1px solid #d4d4d4;
+}
+.ui-grid.column-resizing {
+ cursor: col-resize;
+ -webkit-touch-callout: none;
+ -webkit-user-select: none;
+ -khtml-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+}
+.ui-grid.column-resizing .ui-grid-resize-overlay {
+ position: absolute;
+ top: 0;
+ height: 100%;
+ width: 1px;
+ background-color: #aeaeae;
+}
+
+.ui-grid-row-saving .ui-grid-cell {
+ color: #848484 !important;
+}
+.ui-grid-row-dirty .ui-grid-cell {
+ color: #610B38;
+}
+.ui-grid-row-error .ui-grid-cell {
+ color: #FF0000 !important;
+}
+
+.ui-grid-row.ui-grid-row-selected > [ui-grid-row] > .ui-grid-cell {
+ background-color: #C9DDE1;
+}
+.ui-grid-disable-selection {
+ -webkit-touch-callout: none;
+ -webkit-user-select: none;
+ -khtml-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+ cursor: default;
+}
+.ui-grid-selection-row-header-buttons {
+ display: flex;
+ align-items: center;
+ height: 100%;
+ cursor: pointer;
+}
+.ui-grid-selection-row-header-buttons::before {
+ opacity: 0.1;
+}
+.ui-grid-selection-row-header-buttons.ui-grid-row-selected::before,
+.ui-grid-selection-row-header-buttons.ui-grid-all-selected::before {
+ opacity: 1;
+}
+
+.ui-grid-tree-row-header-buttons.ui-grid-tree-header {
+ cursor: pointer;
+ opacity: 1;
+}
+
+.ui-grid-tree-header-row {
+ font-weight: bold !important;
+}
+.ui-grid-tree-header-row .ui-grid-cell.ui-grid-disable-selection.ui-grid-row-header-cell {
+ pointer-events: all;
+}
+
+.ui-grid-cell-contents.invalid {
+ border: 1px solid #fc8f8f;
+}
diff --git a/release/4.9.2/ui-grid.edit.js b/release/4.9.2/ui-grid.edit.js
new file mode 100644
index 000000000..59383d962
--- /dev/null
+++ b/release/4.9.2/ui-grid.edit.js
@@ -0,0 +1,1324 @@
+/*!
+ * ui-grid - v4.9.2 - 2020-12-01
+ * Copyright (c) 2020 ; License: MIT
+ */
+
+(function () {
+ 'use strict';
+
+ /**
+ * @ngdoc overview
+ * @name ui.grid.edit
+ * @description
+ *
+ * # ui.grid.edit
+ *
+ * Stable This feature is stable. There should no longer be breaking api changes without a deprecation warning.
+ *
+ * This module provides cell editing capability to ui.grid. The goal was to emulate keying data in a spreadsheet via
+ * a keyboard.
+ * + * + * To really get the full spreadsheet-like data entry, the ui.grid.cellNav module should be used. This will allow the + * user to key data and then tab, arrow, or enter to the cells beside or below. + * + * + */ + + var module = angular.module('ui.grid.edit', ['ui.grid']); + + /** + * @ngdoc object + * @name ui.grid.edit.constant:uiGridEditConstants + * + * @description constants available in edit module + */ + module.constant('uiGridEditConstants', { + EDITABLE_CELL_TEMPLATE: /EDITABLE_CELL_TEMPLATE/g, + // must be lowercase because template bulder converts to lower + EDITABLE_CELL_DIRECTIVE: /editable_cell_directive/g, + events: { + BEGIN_CELL_EDIT: 'uiGridEventBeginCellEdit', + END_CELL_EDIT: 'uiGridEventEndCellEdit', + CANCEL_CELL_EDIT: 'uiGridEventCancelCellEdit' + } + }); + + /** + * @ngdoc service + * @name ui.grid.edit.service:uiGridEditService + * + * @description Services for editing features + */ + module.service('uiGridEditService', ['$q', 'uiGridConstants', 'gridUtil', + function ($q, uiGridConstants, gridUtil) { + + var service = { + + initializeGrid: function (grid) { + + service.defaultGridOptions(grid.options); + + grid.registerColumnBuilder(service.editColumnBuilder); + grid.edit = {}; + + /** + * @ngdoc object + * @name ui.grid.edit.api:PublicApi + * + * @description Public Api for edit feature + */ + var publicApi = { + events: { + edit: { + /** + * @ngdoc event + * @name afterCellEdit + * @eventOf ui.grid.edit.api:PublicApi + * @description raised when cell editing is complete + *
+ * gridApi.edit.on.afterCellEdit(scope,function(rowEntity, colDef) {})
+ *
+ * @param {object} rowEntity the options.data element that was edited
+ * @param {object} colDef the column that was edited
+ * @param {object} newValue new value
+ * @param {object} oldValue old value
+ */
+ afterCellEdit: function (rowEntity, colDef, newValue, oldValue) {
+ },
+ /**
+ * @ngdoc event
+ * @name beginCellEdit
+ * @eventOf ui.grid.edit.api:PublicApi
+ * @description raised when cell editing starts on a cell
+ *
+ * gridApi.edit.on.beginCellEdit(scope,function(rowEntity, colDef) {})
+ *
+ * @param {object} rowEntity the options.data element that was edited
+ * @param {object} colDef the column that was edited
+ * @param {object} triggerEvent the event that triggered the edit. Useful to prevent losing keystrokes on some
+ * complex editors
+ */
+ beginCellEdit: function (rowEntity, colDef, triggerEvent) {
+ },
+ /**
+ * @ngdoc event
+ * @name cancelCellEdit
+ * @eventOf ui.grid.edit.api:PublicApi
+ * @description raised when cell editing is cancelled on a cell
+ *
+ * gridApi.edit.on.cancelCellEdit(scope,function(rowEntity, colDef) {})
+ *
+ * @param {object} rowEntity the options.data element that was edited
+ * @param {object} colDef the column that was edited
+ */
+ cancelCellEdit: function (rowEntity, colDef) {
+ }
+ }
+ },
+ methods: {
+ edit: { }
+ }
+ };
+
+ grid.api.registerEventsFromObject(publicApi.events);
+ // grid.api.registerMethodsFromObject(publicApi.methods);
+ },
+
+ defaultGridOptions: function (gridOptions) {
+
+ /**
+ * @ngdoc object
+ * @name ui.grid.edit.api:GridOptions
+ *
+ * @description Options for configuring the edit feature, these are available to be
+ * set using the ui-grid {@link ui.grid.class:GridOptions gridOptions}
+ */
+
+ /**
+ * @ngdoc object
+ * @name enableCellEdit
+ * @propertyOf ui.grid.edit.api:GridOptions
+ * @description If defined, sets the default value for the editable flag on each individual colDefs
+ * if their individual enableCellEdit configuration is not defined. Defaults to undefined.
+ */
+
+ /**
+ * @ngdoc object
+ * @name cellEditableCondition
+ * @propertyOf ui.grid.edit.api:GridOptions
+ * @description If specified, either a value or function to be used by all columns before editing.
+ * If false, then editing of cell is not allowed.
+ * @example
+ *
+ * function($scope, triggerEvent) {
+ * //use $scope.row.entity, $scope.col.colDef and triggerEvent to determine if editing is allowed
+ * return true;
+ * }
+ *
+ */
+ gridOptions.cellEditableCondition = gridOptions.cellEditableCondition === undefined ? true : gridOptions.cellEditableCondition;
+
+ /**
+ * @ngdoc object
+ * @name editableCellTemplate
+ * @propertyOf ui.grid.edit.api:GridOptions
+ * @description If specified, cellTemplate to use as the editor for all columns.
+ * defaults to 'ui-grid/cellTextEditor' + */ + + /** + * @ngdoc object + * @name enableCellEditOnFocus + * @propertyOf ui.grid.edit.api:GridOptions + * @description If true, then editor is invoked as soon as cell receives focus. Default false. + * _requires cellNav feature and the edit feature to be enabled_ + */ + // enableCellEditOnFocus can only be used if cellnav module is used + gridOptions.enableCellEditOnFocus = gridOptions.enableCellEditOnFocus === undefined ? false : gridOptions.enableCellEditOnFocus; + }, + + /** + * @ngdoc service + * @name editColumnBuilder + * @methodOf ui.grid.edit.service:uiGridEditService + * @description columnBuilder function that adds edit properties to grid column + * @returns {promise} promise that will load any needed templates when resolved + */ + editColumnBuilder: function (colDef, col, gridOptions) { + + var promises = []; + + /** + * @ngdoc object + * @name ui.grid.edit.api:ColumnDef + * + * @description Column Definition for edit feature, these are available to be + * set using the ui-grid {@link ui.grid.class:GridOptions.columnDef gridOptions.columnDefs} + */ + + /** + * @ngdoc object + * @name enableCellEdit + * @propertyOf ui.grid.edit.api:ColumnDef + * @description enable editing on column + */ + colDef.enableCellEdit = colDef.enableCellEdit === undefined ? (gridOptions.enableCellEdit === undefined ? + (colDef.type !== 'object') : gridOptions.enableCellEdit) : colDef.enableCellEdit; + + /** + * @ngdoc object + * @name cellEditableCondition + * @propertyOf ui.grid.edit.api:ColumnDef + * @description If specified, either a value or function evaluated before editing cell. If falsy, then editing of cell is not allowed. + * @example + *
+ * function($scope, triggerEvent) {
+ * //use $scope.row.entity, $scope.col.colDef and triggerEvent to determine if editing is allowed
+ * return true;
+ * }
+ *
+ */
+ colDef.cellEditableCondition = colDef.cellEditableCondition === undefined ? gridOptions.cellEditableCondition : colDef.cellEditableCondition;
+
+ /**
+ * @ngdoc object
+ * @name editableCellTemplate
+ * @propertyOf ui.grid.edit.api:ColumnDef
+ * @description cell template to be used when editing this column. Can be Url or text template
+ * Defaults to gridOptions.editableCellTemplate + */ + if (colDef.enableCellEdit) { + colDef.editableCellTemplate = colDef.editableCellTemplate || gridOptions.editableCellTemplate || 'ui-grid/cellEditor'; + + promises.push(gridUtil.getTemplate(colDef.editableCellTemplate) + .then( + function (template) { + col.editableCellTemplate = template; + }, + function (res) { + // Todo handle response error here? + throw new Error("Couldn't fetch/use colDef.editableCellTemplate '" + colDef.editableCellTemplate + "'"); + })); + } + + /** + * @ngdoc object + * @name enableCellEditOnFocus + * @propertyOf ui.grid.edit.api:ColumnDef + * @requires ui.grid.cellNav + * @description If true, then editor is invoked as soon as cell receives focus. Default false. + * _requires both the cellNav feature and the edit feature to be enabled_ + */ + // enableCellEditOnFocus can only be used if cellnav module is used + colDef.enableCellEditOnFocus = colDef.enableCellEditOnFocus === undefined ? gridOptions.enableCellEditOnFocus : colDef.enableCellEditOnFocus; + + + /** + * @ngdoc string + * @name editModelField + * @propertyOf ui.grid.edit.api:ColumnDef + * @description a bindable string value that is used when binding to edit controls instead of colDef.field + * example: You have a complex property on and object like state:{abbrev: 'MS',name: 'Mississippi'}. The + * grid should display state.name in the cell and sort/filter based on the state.name property but the editor + * requires the full state object. + * colDef.field = 'state.name' + * colDef.editModelField = 'state' + */ + // colDef.editModelField + + return $q.all(promises); + }, + + /** + * @ngdoc service + * @name isStartEditKey + * @methodOf ui.grid.edit.service:uiGridEditService + * @description Determines if a keypress should start editing. Decorate this service to override with your + * own key events. See service decorator in angular docs. + * @param {Event} evt keydown event + * @returns {boolean} true if an edit should start + */ + isStartEditKey: function (evt) { + return !(evt.metaKey || + evt.keyCode === uiGridConstants.keymap.ESC || + evt.keyCode === uiGridConstants.keymap.SHIFT || + evt.keyCode === uiGridConstants.keymap.CTRL || + evt.keyCode === uiGridConstants.keymap.ALT || + evt.keyCode === uiGridConstants.keymap.WIN || + evt.keyCode === uiGridConstants.keymap.CAPSLOCK || + + evt.keyCode === uiGridConstants.keymap.LEFT || + (evt.keyCode === uiGridConstants.keymap.TAB && evt.shiftKey) || + + evt.keyCode === uiGridConstants.keymap.RIGHT || + evt.keyCode === uiGridConstants.keymap.TAB || + + evt.keyCode === uiGridConstants.keymap.UP || + (evt.keyCode === uiGridConstants.keymap.ENTER && evt.shiftKey) || + + evt.keyCode === uiGridConstants.keymap.DOWN || + evt.keyCode === uiGridConstants.keymap.ENTER); + } + }; + + return service; + + }]); + + /** + * @ngdoc directive + * @name ui.grid.edit.directive:uiGridEdit + * @element div + * @restrict A + * + * @description Adds editing features to the ui-grid directive. + * + * @example +
+
+
+
+ * $scope.gridOptions = {
+ * columnDefs: [
+ * {name: 'status', editableCellTemplate: 'ui-grid/dropdownEditor',
+ * editDropdownOptionsArray: [{code: 1, status: 'active'}, {code: 2, status: 'inactive'}],
+ * editDropdownIdLabel: 'code', editDropdownValueLabel: 'status' }
+ * ],
+ *
+ *
+ */
+ /**
+ * @ngdoc property
+ * @name editDropdownRowEntityOptionsArrayPath
+ * @propertyOf ui.grid.edit.api:ColumnDef
+ * @description a path to a property on row.entity containing an
+ * array of values in the format
+ * [ {id: xxx, value: xxx} ], which will be used to populate
+ * the edit dropdown. This can be used when the dropdown values are dependent on
+ * the backing row entity.
+ * If this property is set then editDropdownOptionsArray will be ignored.
+ * @example
+ *
+ * $scope.gridOptions = {
+ * columnDefs: [
+ * {name: 'status', editableCellTemplate: 'ui-grid/dropdownEditor',
+ * editDropdownRowEntityOptionsArrayPath: 'foo.bars[0].baz',
+ * editDropdownIdLabel: 'code', editDropdownValueLabel: 'status' }
+ * ],
+ *
+ *
+ */
+ /**
+ * @ngdoc service
+ * @name editDropdownOptionsFunction
+ * @methodOf ui.grid.edit.api:ColumnDef
+ * @description a function returning an array of values in the format
+ * [ {id: xxx, value: xxx} ], which will be used to populate
+ * the edit dropdown. This can be used when the dropdown values are dependent on
+ * the backing row entity with some kind of algorithm.
+ * If this property is set then both editDropdownOptionsArray and
+ * editDropdownRowEntityOptionsArrayPath will be ignored.
+ * @param {object} rowEntity the options.data element that the returned array refers to
+ * @param {object} colDef the column that implements this dropdown
+ * @returns {object} an array of values in the format
+ * [ {id: xxx, value: xxx} ] used to populate the edit dropdown
+ * @example
+ *
+ * $scope.gridOptions = {
+ * columnDefs: [
+ * {name: 'status', editableCellTemplate: 'ui-grid/dropdownEditor',
+ * editDropdownOptionsFunction: function(rowEntity, colDef) {
+ * if (rowEntity.foo === 'bar') {
+ * return [{id: 'bar1', value: 'BAR 1'},
+ * {id: 'bar2', value: 'BAR 2'},
+ * {id: 'bar3', value: 'BAR 3'}];
+ * } else {
+ * return [{id: 'foo1', value: 'FOO 1'},
+ * {id: 'foo2', value: 'FOO 2'}];
+ * }
+ * },
+ * editDropdownIdLabel: 'code', editDropdownValueLabel: 'status' }
+ * ],
+ *
+ *
+ */
+ /**
+ * @ngdoc property
+ * @name editDropdownValueLabel
+ * @propertyOf ui.grid.edit.api:ColumnDef
+ * @description the label for the "value" field
+ * in the editDropdownOptionsArray. Defaults
+ * to 'value'
+ * @example
+ *
+ * $scope.gridOptions = {
+ * columnDefs: [
+ * {name: 'status', editableCellTemplate: 'ui-grid/dropdownEditor',
+ * editDropdownOptionsArray: [{code: 1, status: 'active'}, {code: 2, status: 'inactive'}],
+ * editDropdownIdLabel: 'code', editDropdownValueLabel: 'status' }
+ * ],
+ *
+ *
+ */
+ /**
+ * @ngdoc property
+ * @name editDropdownFilter
+ * @propertyOf ui.grid.edit.api:ColumnDef
+ * @description A filter that you would like to apply to the values in the options list
+ * of the dropdown. For example if you were using angular-translate you might set this
+ * to `'translate'`
+ * @example
+ *
+ * $scope.gridOptions = {
+ * columnDefs: [
+ * {name: 'status', editableCellTemplate: 'ui-grid/dropdownEditor',
+ * editDropdownOptionsArray: [{code: 1, status: 'active'}, {code: 2, status: 'inactive'}],
+ * editDropdownIdLabel: 'code', editDropdownValueLabel: 'status', editDropdownFilter: 'translate' }
+ * ],
+ *
+ *
+ */
+ function beginEditAfterScroll(triggerEvent) {
+ // If we are already editing, then just skip this so we don't try editing twice...
+ if (inEdit) {
+ return;
+ }
+
+ if (!shouldEdit($scope.col, $scope.row, triggerEvent)) {
+ return;
+ }
+
+ var modelField = $scope.row.getQualifiedColField($scope.col);
+ if ($scope.col.colDef.editModelField) {
+ modelField = gridUtil.preEval('row.entity.' + $scope.col.colDef.editModelField);
+ }
+
+ cellModel = $parse(modelField);
+
+ // get original value from the cell
+ origCellValue = cellModel($scope);
+
+ html = $scope.col.editableCellTemplate;
+ html = html.replace(uiGridConstants.MODEL_COL_FIELD, modelField);
+ html = html.replace(uiGridConstants.COL_FIELD, 'grid.getCellValue(row, col)');
+
+ var optionFilter = $scope.col.colDef.editDropdownFilter ? '|' + $scope.col.colDef.editDropdownFilter : '';
+ html = html.replace(uiGridConstants.CUSTOM_FILTERS, optionFilter);
+
+ var inputType = 'text';
+ switch ($scope.col.colDef.type) {
+ case 'boolean':
+ inputType = 'checkbox';
+ break;
+ case 'number':
+ inputType = 'number';
+ break;
+ case 'date':
+ inputType = 'date';
+ break;
+ }
+ html = html.replace('INPUT_TYPE', inputType);
+
+ // In order to fill dropdown options we use:
+ // - A function/promise or
+ // - An array inside of row entity if no function exists or
+ // - A single array for the whole column if none of the previous exists.
+ var editDropdownOptionsFunction = $scope.col.colDef.editDropdownOptionsFunction;
+ if (editDropdownOptionsFunction) {
+ $q.when(editDropdownOptionsFunction($scope.row.entity, $scope.col.colDef))
+ .then(function(result) {
+ $scope.editDropdownOptionsArray = result;
+ });
+ } else {
+ var editDropdownRowEntityOptionsArrayPath = $scope.col.colDef.editDropdownRowEntityOptionsArrayPath;
+ if (editDropdownRowEntityOptionsArrayPath) {
+ $scope.editDropdownOptionsArray = resolveObjectFromPath($scope.row.entity, editDropdownRowEntityOptionsArrayPath);
+ }
+ else {
+ $scope.editDropdownOptionsArray = $scope.col.colDef.editDropdownOptionsArray;
+ }
+ }
+ $scope.editDropdownIdLabel = $scope.col.colDef.editDropdownIdLabel ? $scope.col.colDef.editDropdownIdLabel : 'id';
+ $scope.editDropdownValueLabel = $scope.col.colDef.editDropdownValueLabel ? $scope.col.colDef.editDropdownValueLabel : 'value';
+
+ var createEditor = function() {
+ inEdit = true;
+ cancelBeginEditEvents();
+ var cellElement = angular.element(html);
+ $elm.append(cellElement);
+ editCellScope = $scope.$new();
+ $compile(cellElement)(editCellScope);
+ var gridCellContentsEl = angular.element($elm.children()[0]);
+ gridCellContentsEl.addClass('ui-grid-cell-contents-hidden');
+ };
+ if (!$rootScope.$$phase) {
+ $scope.$apply(createEditor);
+ } else {
+ createEditor();
+ }
+
+ // stop editing when grid is scrolled
+ var deregOnGridScroll = $scope.col.grid.api.core.on.scrollBegin($scope, function () {
+ if ($scope.grid.disableScrolling) {
+ return;
+ }
+ endEdit();
+ $scope.grid.api.edit.raise.afterCellEdit($scope.row.entity, $scope.col.colDef, cellModel($scope), origCellValue);
+ deregOnGridScroll();
+ deregOnEndCellEdit();
+ deregOnCancelCellEdit();
+ });
+
+ // end editing
+ var deregOnEndCellEdit = $scope.$on(uiGridEditConstants.events.END_CELL_EDIT, function () {
+ endEdit();
+ $scope.grid.api.edit.raise.afterCellEdit($scope.row.entity, $scope.col.colDef, cellModel($scope), origCellValue);
+ deregOnEndCellEdit();
+ deregOnGridScroll();
+ deregOnCancelCellEdit();
+ });
+
+ // cancel editing
+ var deregOnCancelCellEdit = $scope.$on(uiGridEditConstants.events.CANCEL_CELL_EDIT, function () {
+ cancelEdit();
+ deregOnCancelCellEdit();
+ deregOnGridScroll();
+ deregOnEndCellEdit();
+ });
+
+ $scope.$broadcast(uiGridEditConstants.events.BEGIN_CELL_EDIT, triggerEvent);
+ $timeout(function () {
+ // execute in a timeout to give any complex editor templates a cycle to completely render
+ $scope.grid.api.edit.raise.beginCellEdit($scope.row.entity, $scope.col.colDef, triggerEvent);
+ });
+ }
+
+ function endEdit() {
+ $scope.grid.disableScrolling = false;
+ if (!inEdit) {
+ return;
+ }
+
+ // sometimes the events can't keep up with the keyboard and grid focus is lost, so always focus
+ // back to grid here. The focus call needs to be before the $destroy and removal of the control,
+ // otherwise ng-model-options of UpdateOn: 'blur' will not work.
+ if (uiGridCtrl && uiGridCtrl.grid.api.cellNav) {
+ uiGridCtrl.focus();
+ }
+
+ var gridCellContentsEl = angular.element($elm.children()[0]);
+ // remove edit element
+ editCellScope.$destroy();
+ var children = $elm.children();
+ for (var i = 1; i < children.length; i++) {
+ angular.element(children[i]).remove();
+ }
+ gridCellContentsEl.removeClass('ui-grid-cell-contents-hidden');
+ inEdit = false;
+ registerBeginEditEvents();
+ $scope.grid.api.core.notifyDataChange( uiGridConstants.dataChange.EDIT );
+ }
+
+ function cancelEdit() {
+ $scope.grid.disableScrolling = false;
+ if (!inEdit) {
+ return;
+ }
+ cellModel.assign($scope, origCellValue);
+ $scope.$apply();
+
+ $scope.grid.api.edit.raise.cancelCellEdit($scope.row.entity, $scope.col.colDef);
+ endEdit();
+ }
+
+ // resolves a string path against the given object
+ // shamelessly borrowed from
+ // http://stackoverflow.com/questions/6491463/accessing-nested-javascript-objects-with-string-key
+ function resolveObjectFromPath(object, path) {
+ path = path.replace(/\[(\w+)\]/g, '.$1'); // convert indexes to properties
+ path = path.replace(/^\./, ''); // strip a leading dot
+ var a = path.split('.');
+ while (a.length) {
+ var n = a.shift();
+ if (n in object) {
+ object = object[n];
+ } else {
+ return;
+ }
+ }
+ return object;
+ }
+ }
+ };
+ }]);
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.edit.directive:uiGridEditor
+ * @element div
+ * @restrict A
+ *
+ * @description input editor directive for editable fields.
+ * Provides EndEdit and CancelEdit events
+ *
+ * Events that end editing:
+ * blur and enter keydown
+ *
+ * Events that cancel editing:
+ * - Esc keydown
+ *
+ */
+ module.directive('uiGridEditor',
+ ['gridUtil', 'uiGridConstants', 'uiGridEditConstants','$timeout', 'uiGridEditService',
+ function (gridUtil, uiGridConstants, uiGridEditConstants, $timeout, uiGridEditService) {
+ return {
+ scope: true,
+ require: ['?^uiGrid', '?^uiGridRenderContainer', 'ngModel'],
+ compile: function () {
+ return {
+ pre: function ($scope, $elm, $attrs) {
+
+ },
+ post: function ($scope, $elm, $attrs, controllers) {
+ var uiGridCtrl, renderContainerCtrl, ngModel;
+ if (controllers[0]) { uiGridCtrl = controllers[0]; }
+ if (controllers[1]) { renderContainerCtrl = controllers[1]; }
+ if (controllers[2]) { ngModel = controllers[2]; }
+
+ // set focus at start of edit
+ $scope.$on(uiGridEditConstants.events.BEGIN_CELL_EDIT, function () {
+ // must be in a timeout since it requires a new digest cycle
+ $timeout(function () {
+ $elm[0].focus();
+ // only select text if it is not being replaced below in the cellNav viewPortKeyPress
+ if ($elm[0].select && ($scope.col.colDef.enableCellEditOnFocus || !(uiGridCtrl && uiGridCtrl.grid.api.cellNav))) {
+ $elm[0].select();
+ }
+ else {
+ // some browsers (Chrome) stupidly, imo, support the w3 standard that number, email, ...
+ // fields should not allow setSelectionRange. We ignore the error for those browsers
+ // https://www.w3.org/Bugs/Public/show_bug.cgi?id=24796
+ try {
+ $elm[0].setSelectionRange($elm[0].value.length, $elm[0].value.length);
+ }
+ catch (ex) {
+ // ignore
+ }
+ }
+ });
+
+ // set the keystroke that started the edit event
+ // we must do this because the BeginEdit is done in a different event loop than the intitial
+ // keydown event
+ // fire this event for the keypress that is received
+ if (uiGridCtrl && uiGridCtrl.grid.api.cellNav) {
+ var viewPortKeyDownUnregister = uiGridCtrl.grid.api.cellNav.on.viewPortKeyPress($scope, function (evt, rowCol) {
+ if (uiGridEditService.isStartEditKey(evt)) {
+ var code = typeof evt.which === 'number' ? evt.which : evt.keyCode;
+ if (code > 0) {
+ ngModel.$setViewValue(String.fromCharCode(code), evt);
+ ngModel.$render();
+ }
+ }
+ viewPortKeyDownUnregister();
+ });
+ }
+
+ // macOS will blur the checkbox when clicked in Safari and Firefox,
+ // to get around this, we disable the blur handler on mousedown,
+ // and then focus the checkbox and re-enable the blur handler after $timeout
+ $elm.on('mousedown', function(evt) {
+ if ($elm[0].type === 'checkbox') {
+ $elm.off('blur', $scope.stopEdit);
+ $timeout(function() {
+ $elm[0].focus();
+ $elm.on('blur', $scope.stopEdit);
+ });
+ }
+ });
+
+ if ($elm[0]) {
+ $elm[0].focus();
+ }
+ $elm.on('blur', $scope.stopEdit);
+ });
+
+
+ $scope.deepEdit = false;
+
+ $scope.stopEdit = function (evt) {
+ if ($scope.inputForm && !$scope.inputForm.$valid) {
+ evt.stopPropagation();
+ $scope.$emit(uiGridEditConstants.events.CANCEL_CELL_EDIT);
+ }
+ else {
+ $scope.$emit(uiGridEditConstants.events.END_CELL_EDIT);
+ }
+ $scope.deepEdit = false;
+ };
+
+
+ $elm.on('click', function (evt) {
+ if ($elm[0].type !== 'checkbox') {
+ $scope.deepEdit = true;
+ $scope.$applyAsync(function () {
+ $scope.grid.disableScrolling = true;
+ });
+ }
+ });
+
+ $elm.on('keydown', function (evt) {
+ switch (evt.keyCode) {
+ case uiGridConstants.keymap.ESC:
+ evt.stopPropagation();
+ $scope.$emit(uiGridEditConstants.events.CANCEL_CELL_EDIT);
+ break;
+ }
+
+ if ($scope.deepEdit &&
+ (evt.keyCode === uiGridConstants.keymap.LEFT ||
+ evt.keyCode === uiGridConstants.keymap.RIGHT ||
+ evt.keyCode === uiGridConstants.keymap.UP ||
+ evt.keyCode === uiGridConstants.keymap.DOWN)) {
+ evt.stopPropagation();
+ }
+ // Pass the keydown event off to the cellNav service, if it exists
+ else if (uiGridCtrl && uiGridCtrl.grid.api.cellNav) {
+ evt.uiGridTargetRenderContainerId = renderContainerCtrl.containerId;
+ if (uiGridCtrl.cellNav.handleKeyDown(evt) !== null) {
+ $scope.stopEdit(evt);
+ }
+ }
+ else {
+ // handle enter and tab for editing not using cellNav
+ switch (evt.keyCode) {
+ case uiGridConstants.keymap.ENTER: // Enter (Leave Field)
+ case uiGridConstants.keymap.TAB:
+ evt.stopPropagation();
+ evt.preventDefault();
+ $scope.stopEdit(evt);
+ break;
+ }
+ }
+
+ return true;
+ });
+
+ $scope.$on('$destroy', function unbindEvents() {
+ // unbind all jquery events in order to avoid memory leaks
+ $elm.off();
+ });
+ }
+ };
+ }
+ };
+ }]);
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.edit.directive:input
+ * @element input
+ * @restrict E
+ *
+ * @description directive to provide binding between input[date] value and ng-model for angular 1.2
+ * It is similar to input[date] directive of angular 1.3
+ *
+ * Supported date format for input is 'yyyy-MM-dd'
+ * The directive will set the $valid property of input element and the enclosing form to false if
+ * model is invalid date or value of input is entered wrong.
+ *
+ */
+ module.directive('uiGridEditor', ['$filter', function ($filter) {
+ function parseDateString(dateString) {
+ if (typeof(dateString) === 'undefined' || dateString === '') {
+ return null;
+ }
+ var parts = dateString.split('-');
+ if (parts.length !== 3) {
+ return null;
+ }
+ var year = parseInt(parts[0], 10);
+ var month = parseInt(parts[1], 10);
+ var day = parseInt(parts[2], 10);
+
+ if (month < 1 || year < 1 || day < 1) {
+ return null;
+ }
+ return new Date(year, (month - 1), day);
+ }
+ return {
+ priority: -100, // run after default uiGridEditor directive
+ require: '?ngModel',
+ link: function (scope, element, attrs, ngModel) {
+ if (angular.version.minor === 2 && attrs.type && attrs.type === 'date' && ngModel) {
+ ngModel.$formatters.push(function (modelValue) {
+ ngModel.$setValidity(null,(!modelValue || !isNaN(modelValue.getTime())));
+ return $filter('date')(modelValue, 'yyyy-MM-dd');
+ });
+
+ ngModel.$parsers.push(function (viewValue) {
+ if (viewValue && viewValue.length > 0) {
+ var dateValue = parseDateString(viewValue);
+ ngModel.$setValidity(null, (dateValue && !isNaN(dateValue.getTime())));
+ return dateValue;
+ }
+ else {
+ ngModel.$setValidity(null, true);
+ return null;
+ }
+ });
+ }
+ }
+ };
+ }]);
+
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.edit.directive:uiGridEditDropdown
+ * @element div
+ * @restrict A
+ *
+ * @description dropdown editor for editable fields.
+ * Provides EndEdit and CancelEdit events
+ *
+ * Events that end editing:
+ * blur and enter keydown, and any left/right nav
+ *
+ * Events that cancel editing:
+ * - Esc keydown
+ *
+ */
+ module.directive('uiGridEditDropdown',
+ ['uiGridConstants', 'uiGridEditConstants', '$timeout',
+ function (uiGridConstants, uiGridEditConstants, $timeout) {
+ return {
+ require: ['?^uiGrid', '?^uiGridRenderContainer'],
+ scope: true,
+ compile: function () {
+ return {
+ pre: function ($scope, $elm, $attrs) {
+
+ },
+ post: function ($scope, $elm, $attrs, controllers) {
+ var uiGridCtrl = controllers[0];
+ var renderContainerCtrl = controllers[1];
+
+ // set focus at start of edit
+ $scope.$on(uiGridEditConstants.events.BEGIN_CELL_EDIT, function () {
+ $timeout(function() {
+ $elm[0].focus();
+ });
+
+ $elm[0].style.width = ($elm[0].parentElement.offsetWidth - 1) + 'px';
+ $elm.on('blur', function (evt) {
+ $scope.stopEdit(evt);
+ });
+ });
+
+
+ $scope.stopEdit = function (evt) {
+ // no need to validate a dropdown - invalid values shouldn't be
+ // available in the list
+ $scope.$emit(uiGridEditConstants.events.END_CELL_EDIT);
+ };
+
+ $elm.on('keydown', function (evt) {
+ switch (evt.keyCode) {
+ case uiGridConstants.keymap.ESC:
+ evt.stopPropagation();
+ $scope.$emit(uiGridEditConstants.events.CANCEL_CELL_EDIT);
+ break;
+ }
+ if (uiGridCtrl && uiGridCtrl.grid.api.cellNav) {
+ evt.uiGridTargetRenderContainerId = renderContainerCtrl.containerId;
+ if (uiGridCtrl.cellNav.handleKeyDown(evt) !== null) {
+ $scope.stopEdit(evt);
+ }
+ }
+ else {
+ // handle enter and tab for editing not using cellNav
+ switch (evt.keyCode) {
+ case uiGridConstants.keymap.ENTER: // Enter (Leave Field)
+ case uiGridConstants.keymap.TAB:
+ evt.stopPropagation();
+ evt.preventDefault();
+ $scope.stopEdit(evt);
+ break;
+ }
+ }
+ return true;
+ });
+
+ $scope.$on('$destroy', function unbindEvents() {
+ // unbind jquery events to prevent memory leaks
+ $elm.off();
+ });
+ }
+ };
+ }
+ };
+ }]);
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.edit.directive:uiGridEditFileChooser
+ * @element div
+ * @restrict A
+ *
+ * @description input editor directive for editable fields.
+ * Provides EndEdit and CancelEdit events
+ *
+ * Events that end editing:
+ * blur and enter keydown
+ *
+ * Events that cancel editing:
+ * - Esc keydown
+ *
+ */
+ module.directive('uiGridEditFileChooser',
+ ['gridUtil', 'uiGridConstants', 'uiGridEditConstants',
+ function (gridUtil, uiGridConstants, uiGridEditConstants) {
+ return {
+ scope: true,
+ require: ['?^uiGrid', '?^uiGridRenderContainer'],
+ compile: function () {
+ return {
+ pre: function ($scope, $elm, $attrs) {
+
+ },
+ post: function ($scope, $elm) {
+ function handleFileSelect(event) {
+ var target = event.srcElement || event.target;
+
+ if (target && target.files && target.files.length > 0) {
+ /**
+ * @ngdoc property
+ * @name editFileChooserCallback
+ * @propertyOf ui.grid.edit.api:ColumnDef
+ * @description A function that should be called when any files have been chosen
+ * by the user. You should use this to process the files appropriately for your
+ * application.
+ *
+ * It passes the gridCol, the gridRow (from which you can get gridRow.entity),
+ * and the files. The files are in the format as returned from the file chooser,
+ * an array of files, with each having useful information such as:
+ * - `files[0].lastModifiedDate`
+ * - `files[0].name`
+ * - `files[0].size` (appears to be in bytes)
+ * - `files[0].type` (MIME type by the looks)
+ *
+ * Typically you would do something with these files - most commonly you would
+ * use the filename or read the file itself in. The example function does both.
+ *
+ * @example
+ *
+ * editFileChooserCallBack: function(gridRow, gridCol, files ) {
+ * // ignore all but the first file, it can only choose one anyway
+ * // set the filename into this column
+ * gridRow.entity.filename = file[0].name;
+ *
+ * // read the file and set it into a hidden column, which we may do stuff with later
+ * var setFile = function(fileContent) {
+ * gridRow.entity.file = fileContent.currentTarget.result;
+ * };
+ * var reader = new FileReader();
+ * reader.onload = setFile;
+ * reader.readAsText( files[0] );
+ * }
+ *
+ */
+ if ( typeof($scope.col.colDef.editFileChooserCallback) === 'function' ) {
+ $scope.col.colDef.editFileChooserCallback($scope.row, $scope.col, target.files);
+ } else {
+ gridUtil.logError('You need to set colDef.editFileChooserCallback to use the file chooser');
+ }
+
+ target.form.reset();
+ $scope.$emit(uiGridEditConstants.events.END_CELL_EDIT);
+ } else {
+ $scope.$emit(uiGridEditConstants.events.CANCEL_CELL_EDIT);
+ }
+ $elm[0].removeEventListener('change', handleFileSelect, false);
+ }
+
+ $elm[0].addEventListener('change', handleFileSelect, false);
+
+ $scope.$on(uiGridEditConstants.events.BEGIN_CELL_EDIT, function () {
+ $elm[0].focus();
+ $elm[0].select();
+
+ $elm.on('blur', function () {
+ $scope.$emit(uiGridEditConstants.events.END_CELL_EDIT);
+ $elm.off();
+ });
+ });
+ }
+ };
+ }
+ };
+ }]);
+})();
+
+angular.module('ui.grid.edit').run(['$templateCache', function($templateCache) {
+ 'use strict';
+
+ $templateCache.put('ui-grid/cellEditor',
+ ""
+ );
+
+
+ $templateCache.put('ui-grid/dropdownEditor',
+ ""
+ );
+
+
+ $templateCache.put('ui-grid/fileChooserEditor',
+ ""
+ );
+
+}]);
diff --git a/release/4.9.2/ui-grid.edit.min.js b/release/4.9.2/ui-grid.edit.min.js
new file mode 100644
index 000000000..7ebac9fab
--- /dev/null
+++ b/release/4.9.2/ui-grid.edit.min.js
@@ -0,0 +1,7 @@
+/*!
+ * ui-grid - v4.9.2 - 2020-12-01
+ * Copyright (c) 2020 ; License: MIT
+ */
+
+
+!function(){"use strict";var e=angular.module("ui.grid.edit",["ui.grid"]);e.constant("uiGridEditConstants",{EDITABLE_CELL_TEMPLATE:/EDITABLE_CELL_TEMPLATE/g,EDITABLE_CELL_DIRECTIVE:/editable_cell_directive/g,events:{BEGIN_CELL_EDIT:"uiGridEventBeginCellEdit",END_CELL_EDIT:"uiGridEventEndCellEdit",CANCEL_CELL_EDIT:"uiGridEventCancelCellEdit"}}),e.service("uiGridEditService",["$q","uiGridConstants","gridUtil",function(o,i,l){var t={initializeGrid:function(e){t.defaultGridOptions(e.options),e.registerColumnBuilder(t.editColumnBuilder),e.edit={};e.api.registerEventsFromObject({edit:{afterCellEdit:function(e,i,t,n){},beginCellEdit:function(e,i,t){},cancelCellEdit:function(e,i){}}})},defaultGridOptions:function(e){e.cellEditableCondition=void 0===e.cellEditableCondition||e.cellEditableCondition,e.enableCellEditOnFocus=void 0!==e.enableCellEditOnFocus&&e.enableCellEditOnFocus},editColumnBuilder:function(i,t,e){var n=[];return i.enableCellEdit=void 0===i.enableCellEdit?void 0===e.enableCellEdit?"object"!==i.type:e.enableCellEdit:i.enableCellEdit,i.cellEditableCondition=void 0===i.cellEditableCondition?e.cellEditableCondition:i.cellEditableCondition,i.enableCellEdit&&(i.editableCellTemplate=i.editableCellTemplate||e.editableCellTemplate||"ui-grid/cellEditor",n.push(l.getTemplate(i.editableCellTemplate).then(function(e){t.editableCellTemplate=e},function(e){throw new Error("Couldn't fetch/use colDef.editableCellTemplate '"+i.editableCellTemplate+"'")}))),i.enableCellEditOnFocus=void 0===i.enableCellEditOnFocus?e.enableCellEditOnFocus:i.enableCellEditOnFocus,o.all(n)},isStartEditKey:function(e){return!(e.metaKey||e.keyCode===i.keymap.ESC||e.keyCode===i.keymap.SHIFT||e.keyCode===i.keymap.CTRL||e.keyCode===i.keymap.ALT||e.keyCode===i.keymap.WIN||e.keyCode===i.keymap.CAPSLOCK||e.keyCode===i.keymap.LEFT||e.keyCode===i.keymap.TAB&&e.shiftKey||e.keyCode===i.keymap.RIGHT||e.keyCode===i.keymap.TAB||e.keyCode===i.keymap.UP||e.keyCode===i.keymap.ENTER&&e.shiftKey||e.keyCode===i.keymap.DOWN||e.keyCode===i.keymap.ENTER)}};return t}]),e.directive("uiGridEdit",["gridUtil","uiGridEditService",function(e,o){return{replace:!0,priority:0,require:"^uiGrid",scope:!1,compile:function(){return{pre:function(e,i,t,n){o.initializeGrid(n.grid)},post:function(e,i,t,n){}}}}}]),e.directive("uiGridViewport",["uiGridEditConstants",function(l){return{replace:!0,priority:-99998,require:["^uiGrid","^uiGridRenderContainer"],scope:!1,compile:function(){return{post:function(e,i,t,n){var o=n[0];o.grid.api.edit&&o.grid.api.cellNav&&("body"===n[1].containerId&&(e.$on(l.events.CANCEL_CELL_EDIT,function(){o.focus()}),e.$on(l.events.END_CELL_EDIT,function(){o.focus()})))}}}}}]),e.directive("uiGridCell",["$compile","$injector","$timeout","uiGridConstants","uiGridEditConstants","gridUtil","$parse","uiGridEditService","$rootScope","$q",function(b,e,h,T,k,w,_,f,I,G){if(e.has("uiGridCellNavService"))e.get("uiGridCellNavService");return{priority:-100,restrict:"A",scope:!1,require:"?^uiGrid",link:function(E,p,e,n){var C,v,g,i,y,m=!1;if(E.col.colDef.enableCellEdit){var t=function(){},o=function(){},l=function(){E.col.colDef.enableCellEdit&&!1!==E.row.enableCellEdit?E.beginEditEventsWired||d():E.beginEditEventsWired&&D()};l();var r=E.$watch("row",function(e,i){e!==i&&l()});E.$on("$destroy",function(){r(),p.off()})}function d(){p.on("dblclick",s),p.on("touchstart",c),n&&n.grid.api.cellNav&&(o=n.grid.api.cellNav.on.viewPortKeyDown(E,function(e,i){null!==i&&(i.row!==E.row||i.col!==E.col||E.col.colDef.enableCellEditOnFocus||u(e))}),t=n.grid.api.cellNav.on.navigate(E,function(e,i,t){E.col.colDef.enableCellEditOnFocus&&(e.row!==E.row||e.col!==E.col||null!==t&&(!t||"click"!==t.type&&"keydown"!==t.type)||h(function(){s(t)}))})),E.beginEditEventsWired=!0}function c(e){void 0!==e.originalEvent&&void 0!==e.originalEvent&&(e=e.originalEvent),p.on("touchend",a),(i=h(function(){},500)).then(function(){setTimeout(s,0),p.off("touchend",a)}).catch(angular.noop)}function a(){h.cancel(i),p.off("touchend",a)}function D(){p.off("dblclick",s),p.off("keydown",u),p.off("touchstart",c),t(),o(),E.beginEditEventsWired=!1}function u(e){f.isStartEditKey(e)&&s(e)}function s(e){E.grid.api.core.scrollToIfNecessary(E.row,E.col).then(function(){!function(e){if(m)return;if(i=E.col,t=E.row,n=e,t.isSaving||(angular.isFunction(i.colDef.cellEditableCondition)?!i.colDef.cellEditableCondition(E,n):!i.colDef.cellEditableCondition))return;var i,t,n;var o=E.row.getQualifiedColField(E.col);E.col.colDef.editModelField&&(o=w.preEval("row.entity."+E.col.colDef.editModelField));g=_(o),v=g(E),C=(C=(C=E.col.editableCellTemplate).replace(T.MODEL_COL_FIELD,o)).replace(T.COL_FIELD,"grid.getCellValue(row, col)");var l=E.col.colDef.editDropdownFilter?"|"+E.col.colDef.editDropdownFilter:"";C=C.replace(T.CUSTOM_FILTERS,l);var r="text";switch(E.col.colDef.type){case"boolean":r="checkbox";break;case"number":r="number";break;case"date":r="date"}C=C.replace("INPUT_TYPE",r);var d=E.col.colDef.editDropdownOptionsFunction;if(d)G.when(d(E.row.entity,E.col.colDef)).then(function(e){E.editDropdownOptionsArray=e});else{var c=E.col.colDef.editDropdownRowEntityOptionsArrayPath;E.editDropdownOptionsArray=c?function(e,i){var t=(i=(i=i.replace(/\[(\w+)\]/g,".$1")).replace(/^\./,"")).split(".");for(;t.length;){var n=t.shift();if(!(n in e))return;e=e[n]}return e}(E.row.entity,c):E.col.colDef.editDropdownOptionsArray}E.editDropdownIdLabel=E.col.colDef.editDropdownIdLabel?E.col.colDef.editDropdownIdLabel:"id",E.editDropdownValueLabel=E.col.colDef.editDropdownValueLabel?E.col.colDef.editDropdownValueLabel:"value";var a=function(){m=!0,D();var e=angular.element(C);p.append(e),y=E.$new(),b(e)(y);var i=angular.element(p.children()[0]);i.addClass("ui-grid-cell-contents-hidden")};I.$$phase?a():E.$apply(a);var u=E.col.grid.api.core.on.scrollBegin(E,function(){E.grid.disableScrolling||(L(),E.grid.api.edit.raise.afterCellEdit(E.row.entity,E.col.colDef,g(E),v),u(),s(),f())}),s=E.$on(k.events.END_CELL_EDIT,function(){L(),E.grid.api.edit.raise.afterCellEdit(E.row.entity,E.col.colDef,g(E),v),s(),u(),f()}),f=E.$on(k.events.CANCEL_CELL_EDIT,function(){!function(){if(E.grid.disableScrolling=!1,!m)return;g.assign(E,v),E.$apply(),E.grid.api.edit.raise.cancelCellEdit(E.row.entity,E.col.colDef),L()}(),f(),u(),s()});E.$broadcast(k.events.BEGIN_CELL_EDIT,e),h(function(){E.grid.api.edit.raise.beginCellEdit(E.row.entity,E.col.colDef,e)})}(e)})}function L(){if(E.grid.disableScrolling=!1,m){n&&n.grid.api.cellNav&&n.focus();var e=angular.element(p.children()[0]);y.$destroy();for(var i=p.children(),t=1;tAlpha This feature is in development. There will almost certainly be breaking api changes, or there are major outstanding bugs.
+ *
+ * This module provides the ability to have the background of the ui-grid be empty rows, this would be displayed in the case were
+ * the grid height is greater then the amount of rows displayed.
+ *
+ *
+ */
+ var module = angular.module('ui.grid.emptyBaseLayer', ['ui.grid']);
+
+
+ /**
+ * @ngdoc service
+ * @name ui.grid.emptyBaseLayer.service:uiGridBaseLayerService
+ *
+ * @description Services for the empty base layer grid
+ */
+ module.service('uiGridBaseLayerService', ['gridUtil', '$compile', function (gridUtil, $compile) {
+ return {
+ initializeGrid: function (grid, disableEmptyBaseLayer) {
+
+ /**
+ * @ngdoc object
+ * @name ui.grid.emptyBaseLayer.api:GridOptions
+ *
+ * @description GridOptions for emptyBaseLayer feature, these are available to be
+ * set using the ui-grid {@link ui.grid.class:GridOptions gridOptions}
+ */
+ grid.baseLayer = {
+ emptyRows: []
+ };
+
+ /**
+ * @ngdoc object
+ * @name enableEmptyGridBaseLayer
+ * @propertyOf ui.grid.emptyBaseLayer.api:GridOptions
+ * @description Enable empty base layer, which shows empty rows as background on the entire grid
+ * Defaults to true, if the directive is used. + * Set to false either by setting this attribute or passing false to the directive. + */ + // default option to true unless it was explicitly set to false + if (grid.options.enableEmptyGridBaseLayer !== false) { + grid.options.enableEmptyGridBaseLayer = !disableEmptyBaseLayer; + } + }, + + setNumberOfEmptyRows: function(viewportHeight, grid) { + var rowHeight = grid.options.rowHeight, + rows = Math.ceil(viewportHeight / rowHeight); + + if (rows > 0) { + grid.baseLayer.emptyRows = []; + for (var i = 0; i < rows; i++) { + grid.baseLayer.emptyRows.push({}); + } + } + } + }; + }]); + + /** + * @ngdoc object + * @name ui.grid.emptyBaseLayer.directive:uiGridEmptyBaseLayer + * @description Shows empty rows in the background of the ui-grid, these span + * the full height of the ui-grid, so that there won't be blank space below the shown rows. + * @example + * + * + *+ * Or you can enable/disable it dynamically by passing in true or false. It doesn't + * the value, so it would only be set on initial render. + * + * + *+ */ + module.directive('uiGridEmptyBaseLayer', ['gridUtil', 'uiGridBaseLayerService', + '$parse', + function (gridUtil, uiGridBaseLayerService, $parse) { + return { + require: '^uiGrid', + scope: false, + compile: function () { + return { + pre: function ($scope, $elm, $attrs, uiGridCtrl) { + var disableEmptyBaseLayer = $parse($attrs.uiGridEmptyBaseLayer)($scope) === false; + + uiGridBaseLayerService.initializeGrid(uiGridCtrl.grid, disableEmptyBaseLayer); + }, + post: function ($scope, $elm, $attrs, uiGridCtrl) { + if (!uiGridCtrl.grid.options.enableEmptyGridBaseLayer) { + return; + } + + var renderBodyContainer = uiGridCtrl.grid.renderContainers.body, + viewportHeight = renderBodyContainer.getViewportHeight(); + + function heightHasChanged() { + var newViewPortHeight = renderBodyContainer.getViewportHeight(); + + if (newViewPortHeight !== viewportHeight) { + viewportHeight = newViewPortHeight; + return true; + } + return false; + } + + function getEmptyBaseLayerCss(viewportHeight) { + // Set ui-grid-empty-base-layer height + return '.grid' + uiGridCtrl.grid.id + + ' .ui-grid-render-container ' + + '.ui-grid-empty-base-layer-container.ui-grid-canvas ' + + '{ height: ' + viewportHeight + 'px; }'; + } + + uiGridCtrl.grid.registerStyleComputation({ + func: function() { + if (heightHasChanged()) { + uiGridBaseLayerService.setNumberOfEmptyRows(viewportHeight, uiGridCtrl.grid); + } + return getEmptyBaseLayerCss(viewportHeight); + } + }); + } + }; + } + }; + }]); + + /** + * @ngdoc directive + * @name ui.grid.emptyBaseLayer.directive:uiGridViewport + * @description stacks on the uiGridViewport directive to append the empty grid base layer html elements to the + * default gridRow template + */ + module.directive('uiGridViewport', + ['$compile', 'gridUtil', '$templateCache', + function ($compile, gridUtil, $templateCache) { + return { + priority: -200, + scope: false, + compile: function ($elm) { + var emptyBaseLayerContainer = $templateCache.get('ui-grid/emptyBaseLayerContainer'); + $elm.prepend(emptyBaseLayerContainer); + return { + pre: function ($scope, $elm, $attrs, controllers) { + }, + post: function ($scope, $elm, $attrs, controllers) { + } + }; + } + }; + }]); + +})(); + +angular.module('ui.grid.emptyBaseLayer').run(['$templateCache', function($templateCache) { + 'use strict'; + + $templateCache.put('ui-grid/emptyBaseLayerContainer', + " Alpha This feature is in development. There will almost certainly be breaking api changes, or there are major outstanding bugs.
+ *
+ * This module provides the ability to create subgrids with the ability to expand a row
+ * to show the subgrid.
+ *
+ *
+ */
+ var module = angular.module('ui.grid.expandable', ['ui.grid']);
+
+ /**
+ * @ngdoc service
+ * @name ui.grid.expandable.service:uiGridExpandableService
+ *
+ * @description Services for the expandable grid
+ */
+ module.service('uiGridExpandableService', ['gridUtil', function (gridUtil) {
+ var service = {
+ initializeGrid: function (grid) {
+
+ grid.expandable = {};
+ grid.expandable.expandedAll = false;
+
+ /**
+ * @ngdoc boolean
+ * @name enableOnDblClickExpand
+ * @propertyOf ui.grid.expandable.api:GridOptions
+ * @description Defaults to true.
+ * @example
+ *
+ * $scope.gridOptions = {
+ * onDblClickExpand: false
+ * }
+ *
+ */
+ grid.options.enableOnDblClickExpand = grid.options.enableOnDblClickExpand !== false;
+ /**
+ * @ngdoc boolean
+ * @name enableExpandable
+ * @propertyOf ui.grid.expandable.api:GridOptions
+ * @description Whether or not to use expandable feature, allows you to turn off expandable on specific grids
+ * within your application, or in specific modes on _this_ grid. Defaults to true.
+ * @example
+ *
+ * $scope.gridOptions = {
+ * enableExpandable: false
+ * }
+ *
+ */
+ grid.options.enableExpandable = grid.options.enableExpandable !== false;
+
+ /**
+ * @ngdoc object
+ * @name showExpandAllButton
+ * @propertyOf ui.grid.expandable.api:GridOptions
+ * @description Whether or not to display the expand all button, allows you to hide expand all button on specific grids
+ * within your application, or in specific modes on _this_ grid. Defaults to true.
+ * @example
+ *
+ * $scope.gridOptions = {
+ * showExpandAllButton: false
+ * }
+ *
+ */
+ grid.options.showExpandAllButton = grid.options.showExpandAllButton !== false;
+
+ /**
+ * @ngdoc object
+ * @name expandableRowHeight
+ * @propertyOf ui.grid.expandable.api:GridOptions
+ * @description Height in pixels of the expanded subgrid. Defaults to
+ * 150
+ * @example
+ *
+ * $scope.gridOptions = {
+ * expandableRowHeight: 150
+ * }
+ *
+ */
+ grid.options.expandableRowHeight = grid.options.expandableRowHeight || 150;
+
+ /**
+ * @ngdoc object
+ * @name expandableRowHeaderWidth
+ * @propertyOf ui.grid.expandable.api:GridOptions
+ * @description Width in pixels of the expandable column. Defaults to 40
+ * @example
+ *
+ * $scope.gridOptions = {
+ * expandableRowHeaderWidth: 40
+ * }
+ *
+ */
+ grid.options.expandableRowHeaderWidth = grid.options.expandableRowHeaderWidth || 40;
+
+ /**
+ * @ngdoc object
+ * @name expandableRowTemplate
+ * @propertyOf ui.grid.expandable.api:GridOptions
+ * @description Mandatory. The template for your expanded row
+ * @example
+ *
+ * $scope.gridOptions = {
+ * expandableRowTemplate: 'expandableRowTemplate.html'
+ * }
+ *
+ */
+ if ( grid.options.enableExpandable && !grid.options.expandableRowTemplate ) {
+ gridUtil.logError( 'You have not set the expandableRowTemplate, disabling expandable module' );
+ grid.options.enableExpandable = false;
+ }
+
+ /**
+ * @ngdoc object
+ * @name ui.grid.expandable.api:PublicApi
+ *
+ * @description Public Api for expandable feature
+ */
+ /**
+ * @ngdoc object
+ * @name ui.grid.expandable.api:GridRow
+ *
+ * @description Additional properties added to GridRow when using the expandable module
+ */
+ /**
+ * @ngdoc object
+ * @name ui.grid.expandable.api:GridOptions
+ *
+ * @description Options for configuring the expandable feature, these are available to be
+ * set using the ui-grid {@link ui.grid.class:GridOptions gridOptions}
+ */
+ var publicApi = {
+ events: {
+ expandable: {
+ /**
+ * @ngdoc event
+ * @name rowExpandedBeforeStateChanged
+ * @eventOf ui.grid.expandable.api:PublicApi
+ * @description raised when row is expanding or collapsing
+ *
+ * gridApi.expandable.on.rowExpandedBeforeStateChanged(scope,function(row, event) {})
+ *
+ * @param {scope} scope the application scope
+ * @param {GridRow} row the row that was expanded
+ * @param {Event} evt object if raised from an event
+ */
+ rowExpandedBeforeStateChanged: function(scope, row, evt) {},
+
+ /**
+ * @ngdoc event
+ * @name rowExpandedStateChanged
+ * @eventOf ui.grid.expandable.api:PublicApi
+ * @description raised when row expanded or collapsed
+ *
+ * gridApi.expandable.on.rowExpandedStateChanged(scope,function(row, event) {})
+ *
+ * @param {scope} scope the application scope
+ * @param {GridRow} row the row that was expanded
+ * @param {Event} evt object if raised from an event
+ */
+ rowExpandedStateChanged: function (scope, row, evt) {},
+
+ /**
+ * @ngdoc event
+ * @name rowExpandedRendered
+ * @eventOf ui.grid.expandable.api:PublicApi
+ * @description raised when expanded row is rendered
+ *
+ * gridApi.expandable.on.rowExpandedRendered(scope,function(row, event) {})
+ *
+ * @param {scope} scope the application scope
+ * @param {GridRow} row the row that was expanded
+ * @param {Event} evt object if raised from an event
+ */
+ rowExpandedRendered: function (scope, row, evt) {}
+ }
+ },
+
+ methods: {
+ expandable: {
+ /**
+ * @ngdoc method
+ * @name toggleRowExpansion
+ * @methodOf ui.grid.expandable.api:PublicApi
+ * @description Toggle a specific row
+ * + * gridApi.expandable.toggleRowExpansion(rowEntity, event); + *+ * @param {object} rowEntity the data entity for the row you want to expand + * @param {Event} [e] event (if exist) + */ + toggleRowExpansion: function (rowEntity, e) { + var row = grid.getRow(rowEntity); + + if (row !== null) { + service.toggleRowExpansion(grid, row, e); + } + }, + + /** + * @ngdoc method + * @name expandAllRows + * @methodOf ui.grid.expandable.api:PublicApi + * @description Expand all subgrids. + * + * gridApi.expandable.expandAllRows(); + *+ */ + expandAllRows: function() { + service.expandAllRows(grid); + }, + + /** + * @ngdoc method + * @name collapseAllRows + * @methodOf ui.grid.expandable.api:PublicApi + * @description Collapse all subgrids. + * + * gridApi.expandable.collapseAllRows(); + *+ */ + collapseAllRows: function() { + service.collapseAllRows(grid); + }, + + /** + * @ngdoc method + * @name toggleAllRows + * @methodOf ui.grid.expandable.api:PublicApi + * @description Toggle all subgrids. + * + * gridApi.expandable.toggleAllRows(); + *+ */ + toggleAllRows: function() { + service.toggleAllRows(grid); + }, + /** + * @ngdoc function + * @name expandRow + * @methodOf ui.grid.expandable.api:PublicApi + * @description Expand the data row + * @param {object} rowEntity gridOptions.data[] array instance + */ + expandRow: function (rowEntity) { + var row = grid.getRow(rowEntity); + + if (row !== null && !row.isExpanded) { + service.toggleRowExpansion(grid, row); + } + }, + /** + * @ngdoc function + * @name collapseRow + * @methodOf ui.grid.expandable.api:PublicApi + * @description Collapse the data row + * @param {object} rowEntity gridOptions.data[] array instance + */ + collapseRow: function (rowEntity) { + var row = grid.getRow(rowEntity); + + if (row !== null && row.isExpanded) { + service.toggleRowExpansion(grid, row); + } + }, + /** + * @ngdoc function + * @name getExpandedRows + * @methodOf ui.grid.expandable.api:PublicApi + * @description returns all expandedRow's entity references + */ + getExpandedRows: function () { + return service.getExpandedRows(grid).map(function (gridRow) { + return gridRow.entity; + }); + } + } + } + }; + grid.api.registerEventsFromObject(publicApi.events); + grid.api.registerMethodsFromObject(publicApi.methods); + }, + + /** + * + * @param grid + * @param row + * @param {Event} [e] event (if exist) + */ + toggleRowExpansion: function (grid, row, e) { + // trigger the "before change" event. Can change row height dynamically this way. + grid.api.expandable.raise.rowExpandedBeforeStateChanged(row); + /** + * @ngdoc object + * @name isExpanded + * @propertyOf ui.grid.expandable.api:GridRow + * @description Whether or not the row is currently expanded. + * @example + *
+ * $scope.api.expandable.on.rowExpandedStateChanged($scope, function (row) {
+ * if (row.isExpanded) {
+ * //...
+ * }
+ * });
+ *
+ */
+ row.isExpanded = !row.isExpanded;
+ if (angular.isUndefined(row.expandedRowHeight)) {
+ row.expandedRowHeight = grid.options.expandableRowHeight;
+ }
+
+ if (row.isExpanded) {
+ row.height = row.grid.options.rowHeight + row.expandedRowHeight;
+ grid.expandable.expandedAll = service.getExpandedRows(grid).length === grid.rows.length;
+ }
+ else {
+ row.height = row.grid.options.rowHeight;
+ grid.expandable.expandedAll = false;
+ }
+ grid.api.expandable.raise.rowExpandedStateChanged(row, e);
+
+ // fire event on render complete
+ function _tWatcher() {
+ if (row.expandedRendered) {
+ grid.api.expandable.raise.rowExpandedRendered(row, e);
+ }
+ else {
+ window.setTimeout(_tWatcher, 1e2);
+ }
+ }
+ _tWatcher();
+ },
+
+ expandAllRows: function(grid) {
+ grid.renderContainers.body.visibleRowCache.forEach( function(row) {
+ if (!row.isExpanded && !(row.entity.subGridOptions && row.entity.subGridOptions.disableRowExpandable)) {
+ service.toggleRowExpansion(grid, row);
+ }
+ });
+ grid.expandable.expandedAll = true;
+ grid.queueGridRefresh();
+ },
+
+ collapseAllRows: function(grid) {
+ grid.renderContainers.body.visibleRowCache.forEach( function(row) {
+ if (row.isExpanded) {
+ service.toggleRowExpansion(grid, row);
+ }
+ });
+ grid.expandable.expandedAll = false;
+ grid.queueGridRefresh();
+ },
+
+ toggleAllRows: function(grid) {
+ if (grid.expandable.expandedAll) {
+ service.collapseAllRows(grid);
+ }
+ else {
+ service.expandAllRows(grid);
+ }
+ },
+
+ getExpandedRows: function (grid) {
+ return grid.rows.filter(function (row) {
+ return row.isExpanded;
+ });
+ }
+ };
+ return service;
+ }]);
+
+ /**
+ * @ngdoc object
+ * @name enableExpandableRowHeader
+ * @propertyOf ui.grid.expandable.api:GridOptions
+ * @description Show a rowHeader to provide the expandable buttons. If set to false then implies
+ * you're going to use a custom method for expanding and collapsing the subgrids. Defaults to true.
+ * @example
+ *
+ * $scope.gridOptions = {
+ * enableExpandableRowHeader: false
+ * }
+ *
+ */
+
+ module.directive('uiGridExpandable', ['uiGridExpandableService', '$templateCache',
+ function (uiGridExpandableService, $templateCache) {
+ return {
+ replace: true,
+ priority: 0,
+ require: '^uiGrid',
+ scope: false,
+ compile: function () {
+ return {
+ pre: function ($scope, $elm, $attrs, uiGridCtrl) {
+ uiGridExpandableService.initializeGrid(uiGridCtrl.grid);
+
+ if (!uiGridCtrl.grid.options.enableExpandable) {
+ return;
+ }
+
+ if (uiGridCtrl.grid.options.enableExpandableRowHeader !== false ) {
+ var expandableRowHeaderColDef = {
+ name: 'expandableButtons',
+ displayName: '',
+ exporterSuppressExport: true,
+ enableColumnResizing: false,
+ enableColumnMenu: false,
+ width: uiGridCtrl.grid.options.expandableRowHeaderWidth || 30
+ };
+
+ expandableRowHeaderColDef.cellTemplate = $templateCache.get('ui-grid/expandableRowHeader');
+ expandableRowHeaderColDef.headerCellTemplate = $templateCache.get('ui-grid/expandableTopRowHeader');
+ uiGridCtrl.grid.addRowHeaderColumn(expandableRowHeaderColDef, -90);
+ }
+ },
+ post: function ($scope, $elm, $attrs, uiGridCtrl) {}
+ };
+ }
+ };
+ }]);
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.expandable.directive:uiGrid
+ * @description stacks on the uiGrid directive to register child grid with parent row when child is created
+ */
+ module.directive('uiGrid',
+ function () {
+ return {
+ replace: true,
+ priority: 599,
+ require: '^uiGrid',
+ scope: false,
+ compile: function () {
+ return {
+ pre: function ($scope, $elm, $attrs, uiGridCtrl) {
+
+ uiGridCtrl.grid.api.core.on.renderingComplete($scope, function() {
+ // if a parent grid row is on the scope, then add the parentRow property to this childGrid
+ if ($scope.row && $scope.row.grid && $scope.row.grid.options
+ && $scope.row.grid.options.enableExpandable) {
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.expandable.class:Grid
+ * @description Additional Grid properties added by expandable module
+ */
+
+ /**
+ * @ngdoc object
+ * @name parentRow
+ * @propertyOf ui.grid.expandable.class:Grid
+ * @description reference to the expanded parent row that owns this grid
+ */
+ uiGridCtrl.grid.parentRow = $scope.row;
+
+ // todo: adjust height on parent row when child grid height changes. we need some sort of gridHeightChanged event
+ // uiGridCtrl.grid.core.on.canvasHeightChanged($scope, function(oldHeight, newHeight) {
+ // uiGridCtrl.grid.parentRow = newHeight;
+ // });
+ }
+ });
+ },
+ post: function ($scope, $elm, $attrs, uiGridCtrl) {}
+ };
+ }
+ };
+ });
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.expandable.directive:uiGridExpandableRow
+ * @description directive to render the Row template on Expand
+ */
+ module.directive('uiGridExpandableRow',
+ ['uiGridExpandableService', '$compile', 'uiGridConstants','gridUtil',
+ function (uiGridExpandableService, $compile, uiGridConstants, gridUtil) {
+
+ return {
+ replace: false,
+ priority: 0,
+ scope: false,
+ compile: function () {
+ return {
+ pre: function ($scope, $elm) {
+ gridUtil.getTemplate($scope.grid.options.expandableRowTemplate).then(
+ function (template) {
+ if ($scope.grid.options.expandableRowScope) {
+ /**
+ * @ngdoc object
+ * @name expandableRowScope
+ * @propertyOf ui.grid.expandable.api:GridOptions
+ * @description Variables of object expandableScope will be available in the scope of the expanded subgrid
+ * @example
+ *
+ * $scope.gridOptions = {
+ * expandableRowScope: expandableScope
+ * }
+ *
+ */
+ var expandableRowScope = $scope.grid.options.expandableRowScope;
+
+ for (var property in expandableRowScope) {
+ if (expandableRowScope.hasOwnProperty(property)) {
+ $scope[property] = expandableRowScope[property];
+ }
+ }
+ }
+ var expandedRowElement = angular.element(template);
+
+ expandedRowElement = $compile(expandedRowElement)($scope);
+ $elm.append(expandedRowElement);
+ $scope.row.element = $elm;
+ $scope.row.expandedRendered = true;
+ });
+ },
+
+ post: function ($scope, $elm) {
+ $scope.row.element = $elm;
+ $scope.$on('$destroy', function() {
+ $scope.row.expandedRendered = false;
+ });
+ }
+ };
+ }
+ };
+ }]);
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.expandable.directive:uiGridRow
+ * @description stacks on the uiGridRow directive to add support for expandable rows
+ */
+ module.directive('uiGridRow',
+ function () {
+ return {
+ priority: -200,
+ scope: false,
+ compile: function () {
+ return {
+ pre: function ($scope, $elm) {
+ if (!$scope.grid.options.enableExpandable) {
+ return;
+ }
+
+ $scope.expandableRow = {};
+
+ $scope.expandableRow.shouldRenderExpand = function () {
+ return $scope.colContainer.name === 'body'
+ && $scope.grid.options.enableExpandable !== false
+ && $scope.row.isExpanded
+ && (!$scope.grid.isScrollingVertically || $scope.row.expandedRendered);
+ };
+
+ $scope.expandableRow.shouldRenderFiller = function () {
+ return $scope.row.isExpanded
+ && (
+ $scope.colContainer.name !== 'body'
+ || ($scope.grid.isScrollingVertically && !$scope.row.expandedRendered));
+ };
+
+ if ($scope.grid.options.enableOnDblClickExpand) {
+ $elm.on('dblclick', function (event) {
+ // if necessary, it is possible for everyone to stop the processing of a single click OR
+ // Inside the Config in the output agent to enter a line:
+ // event.stopPropagation()
+ $scope.grid.api.expandable.toggleRowExpansion($scope.row.entity, event);
+ });
+ }
+ },
+ post: function ($scope, $elm, $attrs, controllers) {}
+ };
+ }
+ };
+ });
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.expandable.directive:uiGridViewport
+ * @description stacks on the uiGridViewport directive to append the expandable row html elements to the
+ * default gridRow template
+ */
+ module.directive('uiGridViewport',
+ ['$compile', 'gridUtil', '$templateCache',
+ function ($compile, gridUtil, $templateCache) {
+ return {
+ priority: -200,
+ scope: false,
+ compile: function ($elm) {
+
+ // todo: this adds ng-if watchers to each row even if the grid is not using expandable directive
+ // or options.enableExpandable == false
+ // The alternative is to compile the template and append to each row in a uiGridRow directive
+
+ var rowRepeatDiv = angular.element($elm.children().children()[0]),
+ expandedRowFillerElement = $templateCache.get('ui-grid/expandableScrollFiller'),
+ expandedRowElement = $templateCache.get('ui-grid/expandableRow');
+
+ rowRepeatDiv.append(expandedRowElement);
+ rowRepeatDiv.append(expandedRowFillerElement);
+ return {
+ pre: function ($scope, $elm, $attrs, controllers) {
+ },
+ post: function ($scope, $elm, $attrs, controllers) {
+ }
+ };
+ }
+ };
+ }]);
+
+})();
+
+angular.module('ui.grid.expandable').run(['$templateCache', function($templateCache) {
+ 'use strict';
+
+ $templateCache.put('ui-grid/expandableRow',
+ ""
+ );
+
+
+ $templateCache.put('ui-grid/expandableRowHeader',
+ "Stable This feature is stable. There should no longer be breaking api changes without a deprecation warning.
+ *
+ * This module provides the ability to export data from the grid.
+ *
+ * Data can be exported in a range of formats, and all data, visible
+ * data, or selected rows can be exported, with all columns or visible
+ * columns.
+ *
+ * No UI is provided, the caller should provide their own UI/buttons
+ * as appropriate, or enable the gridMenu
+ *
+ * + * + * + * + */ + + var module = angular.module('ui.grid.exporter', ['ui.grid']); + + /** + * @ngdoc object + * @name ui.grid.exporter.constant:uiGridExporterConstants + * + * @description constants available in exporter module + */ + /** + * @ngdoc property + * @propertyOf ui.grid.exporter.constant:uiGridExporterConstants + * @name ALL + * @description export all data, including data not visible. Can + * be set for either rowTypes or colTypes + */ + /** + * @ngdoc property + * @propertyOf ui.grid.exporter.constant:uiGridExporterConstants + * @name VISIBLE + * @description export only visible data, including data not visible. Can + * be set for either rowTypes or colTypes + */ + /** + * @ngdoc property + * @propertyOf ui.grid.exporter.constant:uiGridExporterConstants + * @name SELECTED + * @description export all data, including data not visible. Can + * be set only for rowTypes, selection of only some columns is + * not supported + */ + module.constant('uiGridExporterConstants', { + featureName: 'exporter', + rowHeaderColName: 'treeBaseRowHeaderCol', + selectionRowHeaderColName: 'selectionRowHeaderCol', + ALL: 'all', + VISIBLE: 'visible', + SELECTED: 'selected', + CSV_CONTENT: 'CSV_CONTENT', + BUTTON_LABEL: 'BUTTON_LABEL', + FILE_NAME: 'FILE_NAME' + }); + + /** + * @ngdoc service + * @name ui.grid.exporter.service:uiGridExporterService + * + * @description Services for exporter feature + */ + module.service('uiGridExporterService', ['$filter', '$q', 'uiGridExporterConstants', 'gridUtil', '$compile', '$interval', 'i18nService', + function ($filter, $q, uiGridExporterConstants, gridUtil, $compile, $interval, i18nService) { + var service = { + + delay: 100, + + initializeGrid: function (grid) { + + // add feature namespace and any properties to grid for needed state + grid.exporter = {}; + this.defaultGridOptions(grid.options); + + /** + * @ngdoc object + * @name ui.grid.exporter.api:PublicApi + * + * @description Public Api for exporter feature + */ + var publicApi = { + events: { + exporter: { + } + }, + methods: { + exporter: { + /** + * @ngdoc function + * @name csvExport + * @methodOf ui.grid.exporter.api:PublicApi + * @description Exports rows from the grid in csv format, + * the data exported is selected based on the provided options + * @param {string} rowTypes which rows to export, valid values are + * uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE, + * uiGridExporterConstants.SELECTED + * @param {string} colTypes which columns to export, valid values are + * uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE + */ + csvExport: function (rowTypes, colTypes) { + service.csvExport(grid, rowTypes, colTypes); + }, + /** + * @ngdoc function + * @name pdfExport + * @methodOf ui.grid.exporter.api:PublicApi + * @description Exports rows from the grid in pdf format, + * the data exported is selected based on the provided options + * Note that this function has a dependency on pdfMake, all + * going well this has been installed for you. + * The resulting pdf opens in a new browser window. + * @param {string} rowTypes which rows to export, valid values are + * uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE, + * uiGridExporterConstants.SELECTED + * @param {string} colTypes which columns to export, valid values are + * uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE + */ + pdfExport: function (rowTypes, colTypes) { + service.pdfExport(grid, rowTypes, colTypes); + }, + /** + * @ngdoc function + * @name excelExport + * @methodOf ui.grid.exporter.api:PublicApi + * @description Exports rows from the grid in excel format, + * the data exported is selected based on the provided options + * @param {string} rowTypes which rows to export, valid values are + * uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE, + * uiGridExporterConstants.SELECTED + * @param {string} colTypes which columns to export, valid values are + * uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE + */ + excelExport: function (rowTypes, colTypes) { + service.excelExport(grid, rowTypes, colTypes); + } + } + } + }; + + grid.api.registerEventsFromObject(publicApi.events); + + grid.api.registerMethodsFromObject(publicApi.methods); + + if (grid.api.core.addToGridMenu) { + service.addToMenu( grid ); + } else { + // order of registration is not guaranteed, register in a little while + $interval( function() { + if (grid.api.core.addToGridMenu) { + service.addToMenu( grid ); + } + }, this.delay, 1); + } + + }, + + defaultGridOptions: function (gridOptions) { + // default option to true unless it was explicitly set to false + /** + * @ngdoc object + * @name ui.grid.exporter.api:GridOptions + * + * @description GridOptions for exporter feature, these are available to be + * set using the ui-grid {@link ui.grid.class:GridOptions gridOptions} + */ + /** + * @ngdoc object + * @name ui.grid.exporter.api:ColumnDef + * @description ColumnDef settings for exporter + */ + /** + * @ngdoc object + * @name exporterSuppressMenu + * @propertyOf ui.grid.exporter.api:GridOptions + * @description Don't show the export menu button, implying the user + * will roll their own UI for calling the exporter + * Defaults to false + */ + gridOptions.exporterSuppressMenu = gridOptions.exporterSuppressMenu === true; + /** + * @ngdoc object + * @name exporterMenuLabel + * @propertyOf ui.grid.exporter.api:GridOptions + * @description The text to show on the exporter menu button + * link + * Defaults to 'Export' + */ + gridOptions.exporterMenuLabel = gridOptions.exporterMenuLabel ? gridOptions.exporterMenuLabel : 'Export'; + /** + * @ngdoc object + * @name exporterSuppressColumns + * @propertyOf ui.grid.exporter.api:GridOptions + * @description Columns that should not be exported. The selectionRowHeader is already automatically + * suppressed, but if you had a button column or some other "system" column that shouldn't be shown in the + * output then add it in this list. You should provide an array of column names. + * Defaults to: [] + * + * gridOptions.exporterSuppressColumns = [ 'buttons' ]; + *+ */ + gridOptions.exporterSuppressColumns = gridOptions.exporterSuppressColumns ? gridOptions.exporterSuppressColumns : []; + /** + * @ngdoc object + * @name exporterCsvColumnSeparator + * @propertyOf ui.grid.exporter.api:GridOptions + * @description The character to use as column separator + * link + * Defaults to ',' + */ + gridOptions.exporterCsvColumnSeparator = gridOptions.exporterCsvColumnSeparator ? gridOptions.exporterCsvColumnSeparator : ','; + /** + * @ngdoc object + * @name exporterCsvFilename + * @propertyOf ui.grid.exporter.api:GridOptions + * @description The default filename to use when saving the downloaded csv. + * This will only work in some browsers. + * Defaults to 'download.csv' + */ + gridOptions.exporterCsvFilename = gridOptions.exporterCsvFilename ? gridOptions.exporterCsvFilename : 'download.csv'; + /** + * @ngdoc object + * @name exporterPdfFilename + * @propertyOf ui.grid.exporter.api:GridOptions + * @description The default filename to use when saving the downloaded pdf, only used in IE (other browsers open pdfs in a new window) + * Defaults to 'download.pdf' + */ + gridOptions.exporterPdfFilename = gridOptions.exporterPdfFilename ? gridOptions.exporterPdfFilename : 'download.pdf'; + /** + * @ngdoc object + * @name exporterExcelFilename + * @propertyOf ui.grid.exporter.api:GridOptions + * @description The default filename to use when saving the downloaded excel, only used in IE (other browsers open excels in a new window) + * Defaults to 'download.xlsx' + */ + gridOptions.exporterExcelFilename = gridOptions.exporterExcelFilename ? gridOptions.exporterExcelFilename : 'download.xlsx'; + + /** + * @ngdoc object + * @name exporterExcelSheetName + * @propertyOf ui.grid.exporter.api:GridOptions + * @description The default sheetname to use when saving the downloaded to excel + * Defaults to 'Sheet1' + */ + gridOptions.exporterExcelSheetName = gridOptions.exporterExcelSheetName ? gridOptions.exporterExcelSheetName : 'Sheet1'; + + /** + * @ngdoc object + * @name exporterOlderExcelCompatibility + * @propertyOf ui.grid.exporter.api:GridOptions + * @description Some versions of excel don't like the utf-16 BOM on the front, and it comes + * through as  in the first column header. Setting this option to false will suppress this, at the + * expense of proper utf-16 handling in applications that do recognise the BOM + * Defaults to false + */ + gridOptions.exporterOlderExcelCompatibility = gridOptions.exporterOlderExcelCompatibility === true; + /** + * @ngdoc object + * @name exporterIsExcelCompatible + * @propertyOf ui.grid.exporter.api:GridOptions + * @description Separator header, used to set a custom column separator in a csv file, only works on MS Excel. + * Used it on other programs will make csv content display unproperly. Setting this option to false won't add this header. + * Defaults to false + */ + gridOptions.exporterIsExcelCompatible = gridOptions.exporterIsExcelCompatible === true; + /** + * @ngdoc object + * @name exporterMenuItemOrder + * @propertyOf ui.grid.exporter.api:GridOptions + * @description An option to determine the starting point for the menu items created by the exporter + * Defaults to 200 + */ + gridOptions.exporterMenuItemOrder = gridOptions.exporterMenuItemOrder ? gridOptions.exporterMenuItemOrder : 200; + /** + * @ngdoc object + * @name exporterPdfDefaultStyle + * @propertyOf ui.grid.exporter.api:GridOptions + * @description The default style in pdfMake format + * Defaults to: + *
+ * {
+ * fontSize: 11
+ * }
+ *
+ */
+ gridOptions.exporterPdfDefaultStyle = gridOptions.exporterPdfDefaultStyle ? gridOptions.exporterPdfDefaultStyle : { fontSize: 11 };
+ /**
+ * @ngdoc object
+ * @name exporterPdfTableStyle
+ * @propertyOf ui.grid.exporter.api:GridOptions
+ * @description The table style in pdfMake format
+ * Defaults to: + *
+ * {
+ * margin: [0, 5, 0, 15]
+ * }
+ *
+ */
+ gridOptions.exporterPdfTableStyle = gridOptions.exporterPdfTableStyle ? gridOptions.exporterPdfTableStyle : { margin: [0, 5, 0, 15] };
+ /**
+ * @ngdoc object
+ * @name exporterPdfTableHeaderStyle
+ * @propertyOf ui.grid.exporter.api:GridOptions
+ * @description The tableHeader style in pdfMake format
+ * Defaults to: + *
+ * {
+ * bold: true,
+ * fontSize: 12,
+ * color: 'black'
+ * }
+ *
+ */
+ gridOptions.exporterPdfTableHeaderStyle = gridOptions.exporterPdfTableHeaderStyle ? gridOptions.exporterPdfTableHeaderStyle : { bold: true, fontSize: 12, color: 'black' };
+ /**
+ * @ngdoc object
+ * @name exporterPdfHeader
+ * @propertyOf ui.grid.exporter.api:GridOptions
+ * @description The header section for pdf exports. Can be
+ * simple text:
+ * + * gridOptions.exporterPdfHeader = 'My Header'; + *+ * Can be a more complex object in pdfMake format: + *
+ * gridOptions.exporterPdfHeader = {
+ * columns: [
+ * 'Left part',
+ * { text: 'Right part', alignment: 'right' }
+ * ]
+ * };
+ *
+ * Or can be a function, allowing page numbers and the like
+ *
+ * gridOptions.exporterPdfHeader: function(currentPage, pageCount) { return currentPage.toString() + ' of ' + pageCount; };
+ *
+ */
+ gridOptions.exporterPdfHeader = gridOptions.exporterPdfHeader ? gridOptions.exporterPdfHeader : null;
+ /**
+ * @ngdoc object
+ * @name exporterPdfFooter
+ * @propertyOf ui.grid.exporter.api:GridOptions
+ * @description The header section for pdf exports. Can be
+ * simple text:
+ * + * gridOptions.exporterPdfFooter = 'My Footer'; + *+ * Can be a more complex object in pdfMake format: + *
+ * gridOptions.exporterPdfFooter = {
+ * columns: [
+ * 'Left part',
+ * { text: 'Right part', alignment: 'right' }
+ * ]
+ * };
+ *
+ * Or can be a function, allowing page numbers and the like
+ *
+ * gridOptions.exporterPdfFooter: function(currentPage, pageCount) { return currentPage.toString() + ' of ' + pageCount; };
+ *
+ */
+ gridOptions.exporterPdfFooter = gridOptions.exporterPdfFooter ? gridOptions.exporterPdfFooter : null;
+ /**
+ * @ngdoc object
+ * @name exporterPdfOrientation
+ * @propertyOf ui.grid.exporter.api:GridOptions
+ * @description The orientation, should be a valid pdfMake value,
+ * 'landscape' or 'portrait'
+ * Defaults to landscape + */ + gridOptions.exporterPdfOrientation = gridOptions.exporterPdfOrientation ? gridOptions.exporterPdfOrientation : 'landscape'; + /** + * @ngdoc object + * @name exporterPdfPageSize + * @propertyOf ui.grid.exporter.api:GridOptions + * @description The orientation, should be a valid pdfMake + * paper size, usually 'A4' or 'LETTER' + * {@link https://github.com/bpampuch/pdfmake/blob/master/src/standardPageSizes.js pdfMake page sizes} + * Defaults to A4 + */ + gridOptions.exporterPdfPageSize = gridOptions.exporterPdfPageSize ? gridOptions.exporterPdfPageSize : 'A4'; + /** + * @ngdoc object + * @name exporterPdfMaxGridWidth + * @propertyOf ui.grid.exporter.api:GridOptions + * @description The maxium grid width - the current grid width + * will be scaled to match this, with any fixed width columns + * being adjusted accordingly. + * Defaults to 720 (for A4 landscape), use 670 for LETTER + */ + gridOptions.exporterPdfMaxGridWidth = gridOptions.exporterPdfMaxGridWidth ? gridOptions.exporterPdfMaxGridWidth : 720; + /** + * @ngdoc object + * @name exporterPdfTableLayout + * @propertyOf ui.grid.exporter.api:GridOptions + * @description A tableLayout in pdfMake format, + * controls gridlines and the like. We use the default + * layout usually. + * Defaults to null, which means no layout + */ + + /** + * @ngdoc object + * @name exporterMenuAllData + * @propertyOf ui.grid.exporter.api:GridOptions + * @description Add export all data as cvs/pdf menu items to the ui-grid grid menu, if it's present. Defaults to true. + */ + gridOptions.exporterMenuAllData = gridOptions.exporterMenuAllData !== undefined ? gridOptions.exporterMenuAllData : true; + + /** + * @ngdoc object + * @name exporterMenuVisibleData + * @propertyOf ui.grid.exporter.api:GridOptions + * @description Add export visible data as cvs/pdf menu items to the ui-grid grid menu, if it's present. Defaults to true. + */ + gridOptions.exporterMenuVisibleData = gridOptions.exporterMenuVisibleData !== undefined ? gridOptions.exporterMenuVisibleData : true; + + /** + * @ngdoc object + * @name exporterMenuSelectedData + * @propertyOf ui.grid.exporter.api:GridOptions + * @description Add export selected data as cvs/pdf menu items to the ui-grid grid menu, if it's present. Defaults to true. + */ + gridOptions.exporterMenuSelectedData = gridOptions.exporterMenuSelectedData !== undefined ? gridOptions.exporterMenuSelectedData : true; + + /** + * @ngdoc object + * @name exporterMenuCsv + * @propertyOf ui.grid.exporter.api:GridOptions + * @description Add csv export menu items to the ui-grid grid menu, if it's present. Defaults to true. + */ + gridOptions.exporterMenuCsv = gridOptions.exporterMenuCsv !== undefined ? gridOptions.exporterMenuCsv : true; + + /** + * @ngdoc object + * @name exporterMenuPdf + * @propertyOf ui.grid.exporter.api:GridOptions + * @description Add pdf export menu items to the ui-grid grid menu, if it's present. Defaults to true. + */ + gridOptions.exporterMenuPdf = gridOptions.exporterMenuPdf !== undefined ? gridOptions.exporterMenuPdf : true; + + /** + * @ngdoc object + * @name exporterMenuExcel + * @propertyOf ui.grid.exporter.api:GridOptions + * @description Add excel export menu items to the ui-grid grid menu, if it's present. Defaults to true. + */ + gridOptions.exporterMenuExcel = gridOptions.exporterMenuExcel !== undefined ? gridOptions.exporterMenuExcel : true; + + /** + * @ngdoc object + * @name exporterPdfCustomFormatter + * @propertyOf ui.grid.exporter.api:GridOptions + * @description A custom callback routine that changes the pdf document, adding any + * custom styling or content that is supported by pdfMake. Takes in the complete docDefinition, and + * must return an updated docDefinition ready for pdfMake. + * @example + * In this example we add a style to the style array, so that we can use it in our + * footer definition. + *
+ * gridOptions.exporterPdfCustomFormatter = function ( docDefinition ) {
+ * docDefinition.styles.footerStyle = { bold: true, fontSize: 10 };
+ * return docDefinition;
+ * }
+ *
+ * gridOptions.exporterPdfFooter = { text: 'My footer', style: 'footerStyle' }
+ *
+ */
+ gridOptions.exporterPdfCustomFormatter = ( gridOptions.exporterPdfCustomFormatter && typeof( gridOptions.exporterPdfCustomFormatter ) === 'function' ) ? gridOptions.exporterPdfCustomFormatter : function ( docDef ) { return docDef; };
+
+ /**
+ * @ngdoc object
+ * @name exporterHeaderFilterUseName
+ * @propertyOf ui.grid.exporter.api:GridOptions
+ * @description Defaults to false, which leads to `displayName` being passed into the headerFilter.
+ * If set to true, then will pass `name` instead.
+ *
+ *
+ * @example
+ * + * gridOptions.exporterHeaderFilterUseName = true; + *+ */ + gridOptions.exporterHeaderFilterUseName = gridOptions.exporterHeaderFilterUseName === true; + + /** + * @ngdoc object + * @name exporterHeaderFilter + * @propertyOf ui.grid.exporter.api:GridOptions + * @description A function to apply to the header displayNames before exporting. Useful for internationalisation, + * for example if you were using angular-translate you'd set this to `$translate.instant`. Note that this + * call must be synchronous, it cannot be a call that returns a promise. + * + * Behaviour can be changed to pass in `name` instead of `displayName` through use of `exporterHeaderFilterUseName: true`. + * + * @example + *
+ * gridOptions.exporterHeaderFilter = function( displayName ) { return 'col: ' + name; };
+ *
+ * OR
+ * + * gridOptions.exporterHeaderFilter = $translate.instant; + *+ */ + + /** + * @ngdoc function + * @name exporterFieldCallback + * @propertyOf ui.grid.exporter.api:GridOptions + * @description A function to call for each field before exporting it. Allows + * massaging of raw data into a display format, for example if you have applied + * filters to convert codes into decodes, or you require + * a specific date format in the exported content. + * + * The method is called once for each field exported, and provides the grid, the + * gridCol and the GridRow for you to use as context in massaging the data. + * + * @param {Grid} grid provides the grid in case you have need of it + * @param {GridRow} row the row from which the data comes + * @param {GridColumn} col the column from which the data comes + * @param {object} value the value for your massaging + * @returns {object} you must return the massaged value ready for exporting + * + * @example + *
+ * gridOptions.exporterFieldCallback = function ( grid, row, col, value ) {
+ * if ( col.name === 'status' ) {
+ * value = decodeStatus( value );
+ * }
+ * return value;
+ * }
+ *
+ */
+ gridOptions.exporterFieldCallback = gridOptions.exporterFieldCallback ? gridOptions.exporterFieldCallback : defaultExporterFieldCallback;
+
+ /**
+ * @ngdoc function
+ * @name exporterFieldFormatCallback
+ * @propertyOf ui.grid.exporter.api:GridOptions
+ * @description A function to call for each field before exporting it. Allows
+ * general object to be return to modify the format of a cell in the case of
+ * excel exports
+ *
+ * The method is called once for each field exported, and provides the grid, the
+ * gridCol and the GridRow for you to use as context in massaging the data.
+ *
+ * @param {Grid} grid provides the grid in case you have need of it
+ * @param {GridRow} row the row from which the data comes
+ * @param {GridColumn} col the column from which the data comes
+ * @param {object} value the value for your massaging
+ * @returns {object} you must return the massaged value ready for exporting
+ *
+ * @example
+ *
+ * gridOptions.exporterFieldCallback = function ( grid, row, col, value ) {
+ * if ( col.name === 'status' ) {
+ * value = decodeStatus( value );
+ * }
+ * return value;
+ * }
+ *
+ */
+ gridOptions.exporterFieldFormatCallback = gridOptions.exporterFieldFormatCallback ? gridOptions.exporterFieldFormatCallback : function( grid, row, col, value ) { return null; };
+
+ /**
+ * @ngdoc function
+ * @name exporterExcelCustomFormatters
+ * @propertyOf ui.grid.exporter.api:GridOptions
+ * @description A function to call to setup formatters and store on docDefinition.
+ *
+ * The method is called at the start and can setup all the formatters to export to excel
+ *
+ * @param {Grid} grid provides the grid in case you have need of it
+ * @param {Workbook} row the row from which the data comes
+ * @param {docDefinition} The docDefinition that will have styles as a object to store formatters
+ * @returns {docDefinition} Updated docDefinition with formatter styles
+ *
+ * @example
+ *
+ * gridOptions.exporterExcelCustomFormatters = function(grid, workbook, docDefinition) {
+ * const formatters = {};
+ * const stylesheet = workbook.getStyleSheet();
+ * const headerFormatDefn = {
+ * 'font': { 'size': 11, 'fontName': 'Calibri', 'bold': true },
+ * 'alignment': { 'wrapText': false }
+ * };
+ *
+ * formatters['header'] = headerFormatter;
+ * Object.assign(docDefinition.styles , formatters);
+ * grid.docDefinition = docDefinition;
+ * return docDefinition;
+ * }
+ *
+ */
+ gridOptions.exporterExcelCustomFormatters = gridOptions.exporterExcelCustomFormatters ? gridOptions.exporterExcelCustomFormatters : function( grid, workbook, docDefinition ) { return docDefinition; };
+
+ /**
+ * @ngdoc function
+ * @name exporterExcelHeader
+ * @propertyOf ui.grid.exporter.api:GridOptions
+ * @description A function to write formatted header data to sheet.
+ *
+ * The method is called to provide custom header building for Excel. This data comes before the grid header
+ *
+ * @param {grid} grid provides the grid in case you have need of it
+ * @param {Workbook} row the row from which the data comes
+ * @param {Sheet} the sheet to insert data
+ * @param {docDefinition} The docDefinition that will have styles as a object to store formatters
+ * @returns {docDefinition} Updated docDefinition with formatter styles
+ *
+ * @example
+ *
+ * gridOptions.exporterExcelCustomFormatters = function (grid, workbook, sheet, docDefinition) {
+ * const headerFormatter = docDefinition.styles['header'];
+ * let cols = [];
+ * // push data in A1 cell with metadata formatter
+ * cols.push({ value: 'Summary Report', metadata: {style: headerFormatter.id} });
+ * sheet.data.push(cols);
+ * }
+ *
+ */
+ gridOptions.exporterExcelHeader = gridOptions.exporterExcelHeader ? gridOptions.exporterExcelHeader : function( grid, workbook, sheet, docDefinition ) { return null; };
+
+
+ /**
+ * @ngdoc object
+ * @name exporterColumnScaleFactor
+ * @propertyOf ui.grid.exporter.api:GridOptions
+ * @description A scaling factor to divide the drawnwidth of a column to convert to target excel column
+ * format size
+ * @example
+ * In this example we add a number to divide the drawnwidth of a column to get the excel width.
+ * Defaults to 3.5 + */ + gridOptions.exporterColumnScaleFactor = gridOptions.exporterColumnScaleFactor ? gridOptions.exporterColumnScaleFactor : 3.5; + + /** + * @ngdoc object + * @name exporterFieldApplyFilters + * @propertyOf ui.grid.exporter.api:GridOptions + * @description Defaults to false, which leads to filters being evaluated on export * + * + * @example + * + * gridOptions.exporterFieldApplyFilters = true; + *+ */ + gridOptions.exporterFieldApplyFilters = gridOptions.exporterFieldApplyFilters === true; + + /** + * @ngdoc function + * @name exporterAllDataFn + * @propertyOf ui.grid.exporter.api:GridOptions + * @description This promise is needed when exporting all rows, + * and the data need to be provided by server side. Default is null. + * @returns {Promise} a promise to load all data from server + * + * @example + *
+ * gridOptions.exporterAllDataFn = function () {
+ * return $http.get('/data/100.json')
+ * }
+ *
+ */
+ gridOptions.exporterAllDataFn = gridOptions.exporterAllDataFn ? gridOptions.exporterAllDataFn : null;
+
+ /**
+ * @ngdoc function
+ * @name exporterAllDataPromise
+ * @propertyOf ui.grid.exporter.api:GridOptions
+ * @description DEPRECATED - exporterAllDataFn used to be
+ * called this, but it wasn't a promise, it was a function that returned
+ * a promise. Deprecated, but supported for backward compatibility, use
+ * exporterAllDataFn instead.
+ * @returns {Promise} a promise to load all data from server
+ *
+ * @example
+ *
+ * gridOptions.exporterAllDataFn = function () {
+ * return $http.get('/data/100.json')
+ * }
+ *
+ */
+ if ( gridOptions.exporterAllDataFn === null && gridOptions.exporterAllDataPromise ) {
+ gridOptions.exporterAllDataFn = gridOptions.exporterAllDataPromise;
+ }
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name addToMenu
+ * @methodOf ui.grid.exporter.service:uiGridExporterService
+ * @description Adds export items to the grid menu,
+ * allowing the user to select export options
+ * @param {Grid} grid the grid from which data should be exported
+ */
+ addToMenu: function ( grid ) {
+ grid.api.core.addToGridMenu( grid, [
+ {
+ title: i18nService.getSafeText('gridMenu.exporterAllAsCsv'),
+ action: function () {
+ grid.api.exporter.csvExport( uiGridExporterConstants.ALL, uiGridExporterConstants.ALL );
+ },
+ shown: function() {
+ return grid.options.exporterMenuCsv && grid.options.exporterMenuAllData;
+ },
+ order: grid.options.exporterMenuItemOrder
+ },
+ {
+ title: i18nService.getSafeText('gridMenu.exporterVisibleAsCsv'),
+ action: function () {
+ grid.api.exporter.csvExport( uiGridExporterConstants.VISIBLE, uiGridExporterConstants.VISIBLE );
+ },
+ shown: function() {
+ return grid.options.exporterMenuCsv && grid.options.exporterMenuVisibleData;
+ },
+ order: grid.options.exporterMenuItemOrder + 1
+ },
+ {
+ title: i18nService.getSafeText('gridMenu.exporterSelectedAsCsv'),
+ action: function () {
+ grid.api.exporter.csvExport( uiGridExporterConstants.SELECTED, uiGridExporterConstants.VISIBLE );
+ },
+ shown: function() {
+ return grid.options.exporterMenuCsv && grid.options.exporterMenuSelectedData &&
+ ( grid.api.selection && grid.api.selection.getSelectedRows().length > 0 );
+ },
+ order: grid.options.exporterMenuItemOrder + 2
+ },
+ {
+ title: i18nService.getSafeText('gridMenu.exporterAllAsPdf'),
+ action: function () {
+ grid.api.exporter.pdfExport( uiGridExporterConstants.ALL, uiGridExporterConstants.ALL );
+ },
+ shown: function() {
+ return grid.options.exporterMenuPdf && grid.options.exporterMenuAllData;
+ },
+ order: grid.options.exporterMenuItemOrder + 3
+ },
+ {
+ title: i18nService.getSafeText('gridMenu.exporterVisibleAsPdf'),
+ action: function () {
+ grid.api.exporter.pdfExport( uiGridExporterConstants.VISIBLE, uiGridExporterConstants.VISIBLE );
+ },
+ shown: function() {
+ return grid.options.exporterMenuPdf && grid.options.exporterMenuVisibleData;
+ },
+ order: grid.options.exporterMenuItemOrder + 4
+ },
+ {
+ title: i18nService.getSafeText('gridMenu.exporterSelectedAsPdf'),
+ action: function () {
+ grid.api.exporter.pdfExport( uiGridExporterConstants.SELECTED, uiGridExporterConstants.VISIBLE );
+ },
+ shown: function() {
+ return grid.options.exporterMenuPdf && grid.options.exporterMenuSelectedData &&
+ ( grid.api.selection && grid.api.selection.getSelectedRows().length > 0 );
+ },
+ order: grid.options.exporterMenuItemOrder + 5
+ },
+ {
+ title: i18nService.getSafeText('gridMenu.exporterAllAsExcel'),
+ action: function () {
+ grid.api.exporter.excelExport( uiGridExporterConstants.ALL, uiGridExporterConstants.ALL );
+ },
+ shown: function() {
+ return grid.options.exporterMenuExcel && grid.options.exporterMenuAllData;
+ },
+ order: grid.options.exporterMenuItemOrder + 6
+ },
+ {
+ title: i18nService.getSafeText('gridMenu.exporterVisibleAsExcel'),
+ action: function () {
+ grid.api.exporter.excelExport( uiGridExporterConstants.VISIBLE, uiGridExporterConstants.VISIBLE );
+ },
+ shown: function() {
+ return grid.options.exporterMenuExcel && grid.options.exporterMenuVisibleData;
+ },
+ order: grid.options.exporterMenuItemOrder + 7
+ },
+ {
+ title: i18nService.getSafeText('gridMenu.exporterSelectedAsExcel'),
+ action: function () {
+ grid.api.exporter.excelExport( uiGridExporterConstants.SELECTED, uiGridExporterConstants.VISIBLE );
+ },
+ shown: function() {
+ return grid.options.exporterMenuExcel && grid.options.exporterMenuSelectedData &&
+ ( grid.api.selection && grid.api.selection.getSelectedRows().length > 0 );
+ },
+ order: grid.options.exporterMenuItemOrder + 8
+ }
+ ]);
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name csvExport
+ * @methodOf ui.grid.exporter.service:uiGridExporterService
+ * @description Exports rows from the grid in csv format,
+ * the data exported is selected based on the provided options
+ * @param {Grid} grid the grid from which data should be exported
+ * @param {string} rowTypes which rows to export, valid values are
+ * uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE,
+ * uiGridExporterConstants.SELECTED
+ * @param {string} colTypes which columns to export, valid values are
+ * uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE,
+ * uiGridExporterConstants.SELECTED
+ */
+ csvExport: function (grid, rowTypes, colTypes) {
+ var self = this;
+ this.loadAllDataIfNeeded(grid, rowTypes, colTypes).then(function() {
+ var exportColumnHeaders = grid.options.showHeader ? self.getColumnHeaders(grid, colTypes) : [];
+ var exportData = self.getData(grid, rowTypes, colTypes);
+ var csvContent = self.formatAsCsv(exportColumnHeaders, exportData, grid.options.exporterCsvColumnSeparator);
+
+ self.downloadFile (grid.options.exporterCsvFilename, csvContent, grid.options.exporterCsvColumnSeparator, grid.options.exporterOlderExcelCompatibility, grid.options.exporterIsExcelCompatible);
+ });
+ },
+
+ /**
+ * @ngdoc function
+ * @name loadAllDataIfNeeded
+ * @methodOf ui.grid.exporter.service:uiGridExporterService
+ * @description When using server side pagination, use exporterAllDataFn to
+ * load all data before continuing processing.
+ * When using client side pagination, return a resolved promise so processing
+ * continues immediately
+ * @param {Grid} grid the grid from which data should be exported
+ * @param {string} rowTypes which rows to export, valid values are
+ * uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE,
+ * uiGridExporterConstants.SELECTED
+ * @param {string} colTypes which columns to export, valid values are
+ * uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE,
+ * uiGridExporterConstants.SELECTED
+ */
+ loadAllDataIfNeeded: function (grid, rowTypes, colTypes) {
+ if ( rowTypes === uiGridExporterConstants.ALL && grid.rows.length !== grid.options.totalItems && grid.options.exporterAllDataFn) {
+ return grid.options.exporterAllDataFn()
+ .then(function(allData) {
+ grid.modifyRows(allData);
+ });
+ } else {
+ var deferred = $q.defer();
+ deferred.resolve();
+ return deferred.promise;
+ }
+ },
+
+ /**
+ * @ngdoc property
+ * @propertyOf ui.grid.exporter.api:ColumnDef
+ * @name exporterSuppressExport
+ * @description Suppresses export for this column. Used by selection and expandable.
+ */
+
+ /**
+ * @ngdoc function
+ * @name getColumnHeaders
+ * @methodOf ui.grid.exporter.service:uiGridExporterService
+ * @description Gets the column headers from the grid to use
+ * as a title row for the exported file, all headers have
+ * headerCellFilters applied as appropriate.
+ *
+ * Column headers are an array of objects, each object has
+ * name, displayName, width and align attributes. Only name is
+ * used for csv, all attributes are used for pdf.
+ *
+ * @param {Grid} grid the grid from which data should be exported
+ * @param {string} colTypes which columns to export, valid values are
+ * uiGridExporterConstants.ALL, uiGridExporterConstants.VISIBLE,
+ * uiGridExporterConstants.SELECTED
+ */
+ getColumnHeaders: function (grid, colTypes) {
+ var headers = [],
+ columns;
+
+ if ( colTypes === uiGridExporterConstants.ALL ) {
+ columns = grid.columns;
+ } else {
+ var leftColumns = grid.renderContainers.left ? grid.renderContainers.left.visibleColumnCache.filter( function( column ) { return column.visible; } ) : [],
+ bodyColumns = grid.renderContainers.body ? grid.renderContainers.body.visibleColumnCache.filter( function( column ) { return column.visible; } ) : [],
+ rightColumns = grid.renderContainers.right ? grid.renderContainers.right.visibleColumnCache.filter( function( column ) { return column.visible; } ) : [];
+
+ columns = leftColumns.concat(bodyColumns, rightColumns);
+ }
+
+ columns.forEach( function( gridCol ) {
+ // $$hashKey check since when grouping and sorting pragmatically this ends up in export. Filtering it out
+ if ( gridCol.colDef.exporterSuppressExport !== true && gridCol.field !== '$$hashKey' &&
+ grid.options.exporterSuppressColumns.indexOf( gridCol.name ) === -1 ) {
+ var headerEntry = {
+ name: gridCol.field,
+ displayName: getDisplayName(grid, gridCol),
+ width: gridCol.drawnWidth ? gridCol.drawnWidth : gridCol.width,
+ align: gridCol.colDef.align ? gridCol.colDef.align : (gridCol.colDef.type === 'number' ? 'right' : 'left')
+ };
+
+ headers.push(headerEntry);
+ }
+ });
+
+ return headers;
+ },
+
+ /**
+ * @ngdoc property
+ * @propertyOf ui.grid.exporter.api:ColumnDef
+ * @name exporterPdfAlign
+ * @description the alignment you'd like for this specific column when
+ * exported into a pdf. Can be 'left', 'right', 'center' or any other
+ * valid pdfMake alignment option.
+ */
+
+ /**
+ * @ngdoc object
+ * @name ui.grid.exporter.api:GridRow
+ * @description GridRow settings for exporter
+ */
+
+ /**
+ * @ngdoc object
+ * @name exporterEnableExporting
+ * @propertyOf ui.grid.exporter.api:GridRow
+ * @description If set to false, then don't export this row, notwithstanding visible or
+ * other settings
+ * Defaults to true + */ + + /** + * @ngdoc function + * @name getRowsFromNode + * @methodOf ui.grid.exporter.service:uiGridExporterService + * @description Gets rows from a node. If the node is grouped it will + * recurse down into the children to get to the raw data element + * which is a row without children (a leaf). + * @param {Node} aNode the tree node on the grid + * @returns {Array} an array with all child nodes from aNode + */ + getRowsFromNode: function(aNode) { + var rows = []; + + // Push parent node if it is not undefined and has values other than 'children' + var nodeKeys = aNode ? Object.keys(aNode) : ['children']; + if (nodeKeys.length > 1 || nodeKeys[0] != 'children') { + rows.push(aNode); + } + + if (aNode && aNode.children && aNode.children.length > 0) { + for (var i = 0; i < aNode.children.length; i++) { + rows = rows.concat(this.getRowsFromNode(aNode.children[i])); + } + } + return rows; + }, + /** + * @ngdoc function + * @name getDataSorted + * @methodOf ui.grid.exporter.service:uiGridExporterService + * @description Gets rows from a node. If the node is grouped it will + * recurse down into the children to get to the raw data element + * which is a row without children (a leaf). If the grid is not + * grouped this will return just the raw rows + * @param {Grid} grid the grid from which data should be exported + * @returns {Array} an array of leaf nodes + */ + getDataSorted: function (grid) { + if (!grid.treeBase || grid.treeBase.numberLevels === 0) { + return grid.rows; + } + var rows = []; + + for (var i = 0; i< grid.treeBase.tree.length; i++) { + var nodeRows = this.getRowsFromNode(grid.treeBase.tree[i]); + + for (var j = 0; j
+
+
+ Beta This feature is ready for testing, but it either hasn't seen a lot of use or has some known bugs.
+ *
+ * This module provides grouping of rows based on the data in them, similar
+ * in concept to excel grouping. You can group multiple columns, resulting in
+ * nested grouping.
+ *
+ * In concept this feature is similar to sorting + grid footer/aggregation, it
+ * sorts the data based on the grouped columns, then creates group rows that
+ * reflect a break in the data. Each of those group rows can have aggregations for
+ * the data within that group.
+ *
+ * This feature leverages treeBase to provide the tree functionality itself,
+ * the key thing this feature does therefore is to set treeLevels on the rows
+ * and insert the group headers.
+ *
+ * Design information:
+ * -------------------
+ *
+ * Each column will get new menu items - group by, and aggregate by. Group by
+ * will cause this column to be sorted (if not already), and will move this column
+ * to the front of the sorted columns (i.e. grouped columns take precedence over
+ * sorted columns). It will respect the sort order already set if there is one,
+ * and it will allow the sorting logic to change that sort order, it just forces
+ * the column to the front of the sorting. You can group by multiple columns, the
+ * logic will add this column to the sorting after any already grouped columns.
+ *
+ * Once a grouping is defined, grouping logic is added to the rowsProcessors. This
+ * will process the rows, identifying a break in the data value, and inserting a grouping row.
+ * Grouping rows have specific attributes on them:
+ *
+ * - internalRow = true: tells us that this isn't a real row, so we can ignore it
+ * from any processing that it looking at core data rows. This is used by the core
+ * logic (or will be one day), as it's not grouping specific
+ * - groupHeader = true: tells us this is a groupHeader. This is used by the grouping logic
+ * to know if this is a groupHeader row or not
+ *
+ * Since the logic is baked into the rowsProcessors, it should get triggered whenever
+ * row order or filtering or anything like that is changed. In order to avoid the row instantiation
+ * time, and to preserve state across invocations, we hold a cache of the rows that we created
+ * last time, and we use them again this time if we can.
+ *
+ * By default rows are collapsed, which means all data rows have their visible property
+ * set to false, and only level 0 group rows are set to visible.
+ *
+ * + * + * + * + */ + + var module = angular.module('ui.grid.grouping', ['ui.grid', 'ui.grid.treeBase']); + + /** + * @ngdoc object + * @name ui.grid.grouping.constant:uiGridGroupingConstants + * + * @description constants available in grouping module, this includes + * all the constants declared in the treeBase module (these are manually copied + * as there isn't an easy way to include constants in another constants file, and + * we don't want to make users include treeBase) + * + */ + module.constant('uiGridGroupingConstants', { + featureName: "grouping", + rowHeaderColName: 'treeBaseRowHeaderCol', + EXPANDED: 'expanded', + COLLAPSED: 'collapsed', + aggregation: { + COUNT: 'count', + SUM: 'sum', + MAX: 'max', + MIN: 'min', + AVG: 'avg' + } + }); + + /** + * @ngdoc service + * @name ui.grid.grouping.service:uiGridGroupingService + * + * @description Services for grouping features + */ + module.service('uiGridGroupingService', ['$q', 'uiGridGroupingConstants', 'gridUtil', 'rowSorter', 'GridRow', 'gridClassFactory', 'i18nService', 'uiGridConstants', 'uiGridTreeBaseService', + function ($q, uiGridGroupingConstants, gridUtil, rowSorter, GridRow, gridClassFactory, i18nService, uiGridConstants, uiGridTreeBaseService) { + var service = { + initializeGrid: function (grid, $scope) { + uiGridTreeBaseService.initializeGrid( grid, $scope ); + + // add feature namespace and any properties to grid for needed + /** + * @ngdoc object + * @name ui.grid.grouping.grid:grouping + * + * @description Grid properties and functions added for grouping + */ + grid.grouping = {}; + + /** + * @ngdoc property + * @propertyOf ui.grid.grouping.grid:grouping + * @name groupHeaderCache + * + * @description Cache that holds the group header rows we created last time, we'll + * reuse these next time, not least because they hold our expanded states. + * + * We need to take care with these that they don't become a memory leak, we + * create a new cache each time using the values from the old cache. This works + * so long as we're creating group rows for invisible rows as well. + * + * The cache is a nested hash, indexed on the value we grouped by. So if we + * grouped by gender then age, we'd maybe have something like: + * ``` + * { + * male: { + * row:
+ * gridApi.grouping.on.aggregationChanged(scope,function(col) {})
+ *
+ * @param {GridColumn} col the column on which aggregation changed. The aggregation
+ * type is available as `col.treeAggregation.type`
+ */
+ aggregationChanged: {},
+ /**
+ * @ngdoc event
+ * @eventOf ui.grid.grouping.api:PublicApi
+ * @name groupingChanged
+ * @description raised whenever the grouped columns changes
+ *
+ *
+ * gridApi.grouping.on.groupingChanged(scope,function(col) {})
+ *
+ * @param {GridColumn} col the column on which grouping changed. The new grouping is
+ * available as `col.grouping`
+ */
+ groupingChanged: {}
+ }
+ },
+ methods: {
+ grouping: {
+ /**
+ * @ngdoc function
+ * @name getGrouping
+ * @methodOf ui.grid.grouping.api:PublicApi
+ * @description Get the grouping configuration for this grid,
+ * used by the saveState feature. Adds expandedState to the information
+ * provided by the internal getGrouping, and removes any aggregations that have a source
+ * of grouping (i.e. will be automatically reapplied when we regroup the column)
+ * Returned grouping is an object
+ * `{ grouping: groupArray, treeAggregations: aggregateArray, expandedState: hash }`
+ * where grouping contains an array of objects:
+ * `{ field: column.field, colName: column.name, groupPriority: column.grouping.groupPriority }`
+ * and aggregations contains an array of objects:
+ * `{ field: column.field, colName: column.name, aggregation: column.grouping.aggregation }`
+ * and expandedState is a hash of the currently expanded nodes
+ *
+ * The groupArray will be sorted by groupPriority.
+ *
+ * @param {boolean} getExpanded whether or not to return the expanded state
+ * @returns {object} grouping configuration
+ */
+ getGrouping: function ( getExpanded ) {
+ var grouping = service.getGrouping(grid);
+
+ grouping.grouping.forEach( function( group ) {
+ group.colName = group.col.name;
+ delete group.col;
+ });
+
+ grouping.aggregations.forEach( function( aggregation ) {
+ aggregation.colName = aggregation.col.name;
+ delete aggregation.col;
+ });
+
+ grouping.aggregations = grouping.aggregations.filter( function( aggregation ) {
+ return !aggregation.aggregation.source || aggregation.aggregation.source !== 'grouping';
+ });
+
+ if ( getExpanded ) {
+ grouping.rowExpandedStates = service.getRowExpandedStates( grid.grouping.groupingHeaderCache );
+ }
+
+ return grouping;
+ },
+
+ /**
+ * @ngdoc function
+ * @name setGrouping
+ * @methodOf ui.grid.grouping.api:PublicApi
+ * @description Set the grouping configuration for this grid,
+ * used by the saveState feature, but can also be used by any
+ * user to specify a combined grouping and aggregation configuration
+ * @param {object} config the config you want to apply, in the format
+ * provided out by getGrouping
+ */
+ setGrouping: function ( config ) {
+ service.setGrouping(grid, config);
+ },
+
+ /**
+ * @ngdoc function
+ * @name groupColumn
+ * @methodOf ui.grid.grouping.api:PublicApi
+ * @description Adds this column to the existing grouping, at the end of the priority order.
+ * If the column doesn't have a sort, adds one, by default ASC
+ *
+ * This column will move to the left of any non-group columns, the
+ * move is handled in a columnProcessor, so gets called as part of refresh
+ *
+ * @param {string} columnName the name of the column we want to group
+ */
+ groupColumn: function(columnName) {
+ var column = grid.getColumn(columnName);
+
+ service.groupColumn(grid, column);
+ },
+
+ /**
+ * @ngdoc function
+ * @name ungroupColumn
+ * @methodOf ui.grid.grouping.api:PublicApi
+ * @description Removes the groupPriority from this column. If the
+ * column was previously aggregated the aggregation will come back.
+ * The sort will remain.
+ *
+ * This column will move to the right of any other group columns, the
+ * move is handled in a columnProcessor, so gets called as part of refresh
+ *
+ * @param {string} columnName the name of the column we want to ungroup
+ */
+ ungroupColumn: function(columnName) {
+ var column = grid.getColumn(columnName);
+
+ service.ungroupColumn(grid, column);
+ },
+
+ /**
+ * @ngdoc function
+ * @name clearGrouping
+ * @methodOf ui.grid.grouping.api:PublicApi
+ * @description Clear any grouped columns and any aggregations. Doesn't remove sorting,
+ * as we don't know whether that sorting was added by grouping or was there beforehand
+ *
+ */
+ clearGrouping: function() {
+ service.clearGrouping(grid);
+ },
+
+ /**
+ * @ngdoc function
+ * @name aggregateColumn
+ * @methodOf ui.grid.grouping.api:PublicApi
+ * @description Sets the aggregation type on a column, if the
+ * column is currently grouped then it removes the grouping first.
+ * If the aggregationDef is null then will result in the aggregation
+ * being removed
+ *
+ * @param {string} columnName the column we want to aggregate
+ * @param {string|function} aggregationDef one of the recognised types
+ * from uiGridGroupingConstants or a custom aggregation function.
+ * @param {string} aggregationLabel (optional) The label to use for this aggregation.
+ */
+ aggregateColumn: function(columnName, aggregationDef, aggregationLabel) {
+ var column = grid.getColumn(columnName);
+
+ service.aggregateColumn(grid, column, aggregationDef, aggregationLabel);
+ }
+ }
+ }
+ };
+
+ grid.api.registerEventsFromObject(publicApi.events);
+
+ grid.api.registerMethodsFromObject(publicApi.methods);
+
+ grid.api.core.on.sortChanged($scope, service.tidyPriorities);
+ },
+
+ defaultGridOptions: function (gridOptions) {
+ // default option to true unless it was explicitly set to false
+ /**
+ * @ngdoc object
+ * @name ui.grid.grouping.api:GridOptions
+ *
+ * @description GridOptions for grouping feature, these are available to be
+ * set using the ui-grid {@link ui.grid.class:GridOptions gridOptions}
+ */
+
+ /**
+ * @ngdoc object
+ * @name enableGrouping
+ * @propertyOf ui.grid.grouping.api:GridOptions
+ * @description Enable row grouping for entire grid.
+ * Defaults to true + */ + gridOptions.enableGrouping = gridOptions.enableGrouping !== false; + + /** + * @ngdoc object + * @name groupingShowCounts + * @propertyOf ui.grid.grouping.api:GridOptions + * @description shows counts on the groupHeader rows. Not that if you are using a cellFilter or a + * sortingAlgorithm which relies on a specific format or data type, showing counts may cause that + * to break, since the group header rows will always be a string with groupingShowCounts enabled. + * Defaults to true except on columns of types 'date' and 'object' + */ + gridOptions.groupingShowCounts = gridOptions.groupingShowCounts !== false; + + /** + * @ngdoc object + * @name groupingNullLabel + * @propertyOf ui.grid.grouping.api:GridOptions + * @description The string to use for the grouping header row label on rows which contain a null or undefined value in the grouped column. + * Defaults to "Null" + */ + gridOptions.groupingNullLabel = typeof(gridOptions.groupingNullLabel) === 'undefined' ? 'Null' : gridOptions.groupingNullLabel; + + /** + * @ngdoc object + * @name enableGroupHeaderSelection + * @propertyOf ui.grid.grouping.api:GridOptions + * @description Allows group header rows to be selected. + * Defaults to false + */ + gridOptions.enableGroupHeaderSelection = gridOptions.enableGroupHeaderSelection === true; + }, + + + /** + * @ngdoc function + * @name groupingColumnBuilder + * @methodOf ui.grid.grouping.service:uiGridGroupingService + * @description Sets the grouping defaults based on the columnDefs + * + * @param {object} colDef columnDef we're basing on + * @param {GridColumn} col the column we're to update + * @param {object} gridOptions the options we should use + * @returns {promise} promise for the builder - actually we do it all inline so it's immediately resolved + */ + groupingColumnBuilder: function (colDef, col, gridOptions) { + /** + * @ngdoc object + * @name ui.grid.grouping.api:ColumnDef + * + * @description ColumnDef for grouping feature, these are available to be + * set using the ui-grid {@link ui.grid.class:GridOptions.columnDef gridOptions.columnDefs} + */ + + /** + * @ngdoc object + * @name enableGrouping + * @propertyOf ui.grid.grouping.api:ColumnDef + * @description Enable grouping on this column + * Defaults to true. + */ + if (colDef.enableGrouping === false) { + return; + } + + /** + * @ngdoc object + * @name grouping + * @propertyOf ui.grid.grouping.api:ColumnDef + * @description Set the grouping for a column. Format is: + * ``` + * { + * groupPriority: Defaults to undefined. + */ + + if ( typeof(col.grouping) === 'undefined' && typeof(colDef.grouping) !== 'undefined') { + col.grouping = angular.copy(colDef.grouping); + if ( typeof(col.grouping.groupPriority) !== 'undefined' && col.grouping.groupPriority > -1 ) { + col.treeAggregationFn = uiGridTreeBaseService.nativeAggregations()[uiGridGroupingConstants.aggregation.COUNT].aggregationFn; + col.treeAggregationFinalizerFn = service.groupedFinalizerFn; + } + } else if (typeof(col.grouping) === 'undefined') { + col.grouping = {}; + } + + if (typeof(col.grouping) !== 'undefined' && typeof(col.grouping.groupPriority) !== 'undefined' && col.grouping.groupPriority >= 0) { + col.suppressRemoveSort = true; + } + + var groupColumn = { + name: 'ui.grid.grouping.group', + title: i18nService.get().grouping.group, + icon: 'ui-grid-icon-indent-right', + shown: function () { + return typeof(this.context.col.grouping) === 'undefined' || + typeof(this.context.col.grouping.groupPriority) === 'undefined' || + this.context.col.grouping.groupPriority < 0; + }, + action: function () { + service.groupColumn( this.context.col.grid, this.context.col ); + } + }; + + var ungroupColumn = { + name: 'ui.grid.grouping.ungroup', + title: i18nService.get().grouping.ungroup, + icon: 'ui-grid-icon-indent-left', + shown: function () { + return typeof(this.context.col.grouping) !== 'undefined' && + typeof(this.context.col.grouping.groupPriority) !== 'undefined' && + this.context.col.grouping.groupPriority >= 0; + }, + action: function () { + service.ungroupColumn( this.context.col.grid, this.context.col ); + } + }; + + var aggregateRemove = { + name: 'ui.grid.grouping.aggregateRemove', + title: i18nService.get().grouping.aggregate_remove, + shown: function () { + return typeof(this.context.col.treeAggregationFn) !== 'undefined'; + }, + action: function () { + service.aggregateColumn( this.context.col.grid, this.context.col, null); + } + }; + + // generic adder for the aggregation menus, which follow a pattern + var addAggregationMenu = function(type, title) { + title = title || i18nService.get().grouping['aggregate_' + type] || type; + var menuItem = { + name: 'ui.grid.grouping.aggregate' + type, + title: title, + shown: function () { + return typeof(this.context.col.treeAggregation) === 'undefined' || + typeof(this.context.col.treeAggregation.type) === 'undefined' || + this.context.col.treeAggregation.type !== type; + }, + action: function () { + service.aggregateColumn( this.context.col.grid, this.context.col, type); + } + }; + + if (!gridUtil.arrayContainsObjectWithProperty(col.menuItems, 'name', 'ui.grid.grouping.aggregate' + type)) { + col.menuItems.push(menuItem); + } + }; + + /** + * @ngdoc object + * @name groupingShowGroupingMenu + * @propertyOf ui.grid.grouping.api:ColumnDef + * @description Show the grouping (group and ungroup items) menu on this column + * Defaults to true. + */ + if ( col.colDef.groupingShowGroupingMenu !== false ) { + if (!gridUtil.arrayContainsObjectWithProperty(col.menuItems, 'name', 'ui.grid.grouping.group')) { + col.menuItems.push(groupColumn); + } + + if (!gridUtil.arrayContainsObjectWithProperty(col.menuItems, 'name', 'ui.grid.grouping.ungroup')) { + col.menuItems.push(ungroupColumn); + } + } + + + /** + * @ngdoc object + * @name groupingShowAggregationMenu + * @propertyOf ui.grid.grouping.api:ColumnDef + * @description Show the aggregation menu on this column + * Defaults to true. + */ + if ( col.colDef.groupingShowAggregationMenu !== false ) { + angular.forEach(uiGridTreeBaseService.nativeAggregations(), function(aggregationDef, name) { + addAggregationMenu(name); + }); + angular.forEach(gridOptions.treeCustomAggregations, function(aggregationDef, name) { + addAggregationMenu(name, aggregationDef.menuTitle); + }); + + if (!gridUtil.arrayContainsObjectWithProperty(col.menuItems, 'name', 'ui.grid.grouping.aggregateRemove')) { + col.menuItems.push(aggregateRemove); + } + } + }, + + + + + /** + * @ngdoc function + * @name groupingColumnProcessor + * @methodOf ui.grid.grouping.service:uiGridGroupingService + * @description Moves the columns around based on which are grouped + * + * @param {array} columns the columns to consider rendering + * @param {array} rows the grid rows, which we don't use but are passed to us + * @returns {array} updated columns array + */ + groupingColumnProcessor: function( columns, rows ) { + columns = service.moveGroupColumns(this, columns, rows); + return columns; + }, + + /** + * @ngdoc function + * @name groupedFinalizerFn + * @methodOf ui.grid.grouping.service:uiGridGroupingService + * @description Used on group columns to display the rendered value and optionally + * display the count of rows. + * + * @param {aggregation} aggregation The aggregation entity for a grouped column + */ + groupedFinalizerFn: function( aggregation ) { + var col = this; + + if ( typeof(aggregation.groupVal) !== 'undefined') { + aggregation.rendered = aggregation.groupVal; + if ( col.grid.options.groupingShowCounts && col.colDef.type !== 'date' && col.colDef.type !== 'object' ) { + aggregation.rendered += (' (' + aggregation.value + ')'); + } + } else { + aggregation.rendered = null; + } + }, + + /** + * @ngdoc function + * @name moveGroupColumns + * @methodOf ui.grid.grouping.service:uiGridGroupingService + * @description Moves the column order so that the grouped columns are lined up + * to the left (well, unless you're RTL, then it's the right). By doing this in + * the columnsProcessor, we make it transient - when the column is ungrouped it'll + * go back to where it was. + * + * Does nothing if the option `moveGroupColumns` is set to false. + * + * @param {Grid} grid grid object + * @param {array} columns the columns that we should process/move + * @returns {array} updated columns + */ + moveGroupColumns: function( grid, columns ) { + if ( grid.options.moveGroupColumns === false) { + return columns; + } + + columns.forEach(function(column, index) { + // position used to make stable sort in moveGroupColumns + column.groupingPosition = index; + }); + + columns.sort(function(a, b) { + var a_group, b_group; + + if (a.isRowHeader) { + a_group = a.headerPriority; + } + else if ( typeof(a.grouping) === 'undefined' || typeof(a.grouping.groupPriority) === 'undefined' || a.grouping.groupPriority < 0) { + a_group = null; + } + else { + a_group = a.grouping.groupPriority; + } + + if (b.isRowHeader) { + b_group = b.headerPriority; + } + else if ( typeof(b.grouping) === 'undefined' || typeof(b.grouping.groupPriority) === 'undefined' || b.grouping.groupPriority < 0) { + b_group = null; + } + else { + b_group = b.grouping.groupPriority; + } + + // groups get sorted to the top + if ( a_group !== null && b_group === null) { return -1; } + if ( b_group !== null && a_group === null) { return 1; } + if ( a_group !== null && b_group !== null) {return a_group - b_group; } + + return a.groupingPosition - b.groupingPosition; + }); + + columns.forEach( function(column) { + delete column.groupingPosition; + }); + + return columns; + }, + + + /** + * @ngdoc function + * @name groupColumn + * @methodOf ui.grid.grouping.service:uiGridGroupingService + * @description Adds this column to the existing grouping, at the end of the priority order. + * If the column doesn't have a sort, adds one, by default ASC + * + * This column will move to the left of any non-group columns, the + * move is handled in a columnProcessor, so gets called as part of refresh + * + * @param {Grid} grid grid object + * @param {GridColumn} column the column we want to group + */ + groupColumn: function( grid, column) { + if ( typeof(column.grouping) === 'undefined' ) { + column.grouping = {}; + } + + // set the group priority to the next number in the hierarchy + var existingGrouping = service.getGrouping( grid ); + column.grouping.groupPriority = existingGrouping.grouping.length; + + // save sort in order to restore it when column is ungrouped + column.previousSort = angular.copy(column.sort); + + // add sort if not present + if ( !column.sort ) { + column.sort = { direction: uiGridConstants.ASC }; + } else if ( typeof(column.sort.direction) === 'undefined' || column.sort.direction === null ) { + column.sort.direction = uiGridConstants.ASC; + } + + column.treeAggregation = { type: uiGridGroupingConstants.aggregation.COUNT, source: 'grouping' }; + + if ( column.colDef && angular.isFunction(column.colDef.customTreeAggregationFn) ) { + column.treeAggregationFn = column.colDef.customTreeAggregationFn; + } else { + column.treeAggregationFn = uiGridTreeBaseService.nativeAggregations()[uiGridGroupingConstants.aggregation.COUNT].aggregationFn; + } + + column.treeAggregationFinalizerFn = service.groupedFinalizerFn; + + grid.api.grouping.raise.groupingChanged(column); + // This indirectly calls service.tidyPriorities( grid ); + grid.api.core.raise.sortChanged(grid, grid.getColumnSorting()); + + grid.queueGridRefresh(); + }, + + + /** + * @ngdoc function + * @name ungroupColumn + * @methodOf ui.grid.grouping.service:uiGridGroupingService + * @description Removes the groupPriority from this column. If the + * column was previously aggregated the aggregation will come back. + * The sort will remain. + * + * This column will move to the right of any other group columns, the + * move is handled in a columnProcessor, so gets called as part of refresh + * + * @param {Grid} grid grid object + * @param {GridColumn} column the column we want to ungroup + */ + ungroupColumn: function( grid, column) { + if ( typeof(column.grouping) === 'undefined' ) { + return; + } + + delete column.grouping.groupPriority; + delete column.treeAggregation; + delete column.customTreeAggregationFinalizer; + + if (column.previousSort) { + column.sort = column.previousSort; + delete column.previousSort; + } + + service.tidyPriorities( grid ); + + grid.api.grouping.raise.groupingChanged(column); + grid.api.core.raise.sortChanged(grid, grid.getColumnSorting()); + + grid.queueGridRefresh(); + }, + + /** + * @ngdoc function + * @name aggregateColumn + * @methodOf ui.grid.grouping.service:uiGridGroupingService + * @description Sets the aggregation type on a column, if the + * column is currently grouped then it removes the grouping first. + * + * @param {Grid} grid grid object + * @param {GridColumn} column the column we want to aggregate + * @param {string} aggregationType of the recognised types from uiGridGroupingConstants or one of the custom aggregations from gridOptions + * @param {string} aggregationLabel to be used instead of the default label. If empty string is passed, label is omitted + */ + aggregateColumn: function( grid, column, aggregationType, aggregationLabel ) { + if (typeof(column.grouping) !== 'undefined' && typeof(column.grouping.groupPriority) !== 'undefined' && column.grouping.groupPriority >= 0) { + service.ungroupColumn( grid, column ); + } + + var aggregationDef = {}; + + if ( typeof(grid.options.treeCustomAggregations[aggregationType]) !== 'undefined' ) { + aggregationDef = grid.options.treeCustomAggregations[aggregationType]; + } else if ( typeof(uiGridTreeBaseService.nativeAggregations()[aggregationType]) !== 'undefined' ) { + aggregationDef = uiGridTreeBaseService.nativeAggregations()[aggregationType]; + } + + column.treeAggregation = { + type: aggregationType, + label: ( typeof aggregationLabel === 'string') ? + aggregationLabel : + i18nService.get().aggregation[aggregationDef.label] || aggregationDef.label + }; + column.treeAggregationFn = aggregationDef.aggregationFn; + column.treeAggregationFinalizerFn = aggregationDef.finalizerFn; + + grid.api.grouping.raise.aggregationChanged(column); + + grid.queueGridRefresh(); + }, + + + /** + * @ngdoc function + * @name setGrouping + * @methodOf ui.grid.grouping.service:uiGridGroupingService + * @description Set the grouping based on a config object, used by the save state feature + * (more specifically, by the restore function in that feature ) + * + * @param {Grid} grid grid object + * @param {object} config the config we want to set, same format as that returned by getGrouping + */ + setGrouping: function ( grid, config ) { + if ( typeof(config) === 'undefined' ) { + return; + } + + // first remove any existing grouping + service.clearGrouping(grid); + + if ( config.grouping && config.grouping.length && config.grouping.length > 0 ) { + config.grouping.forEach( function( group ) { + var col = grid.getColumn(group.colName); + + if ( col ) { + service.groupColumn( grid, col ); + } + }); + } + + if ( config.aggregations && config.aggregations.length ) { + config.aggregations.forEach( function( aggregation ) { + var col = grid.getColumn(aggregation.colName); + + if ( col ) { + service.aggregateColumn( grid, col, aggregation.aggregation.type ); + } + }); + } + + if ( config.rowExpandedStates ) { + service.applyRowExpandedStates( grid.grouping.groupingHeaderCache, config.rowExpandedStates ); + } + }, + + + /** + * @ngdoc function + * @name clearGrouping + * @methodOf ui.grid.grouping.service:uiGridGroupingService + * @description Clear any grouped columns and any aggregations. Doesn't remove sorting, + * as we don't know whether that sorting was added by grouping or was there beforehand + * + * @param {Grid} grid grid object + */ + clearGrouping: function( grid ) { + var currentGrouping = service.getGrouping(grid); + + if ( currentGrouping.grouping.length > 0 ) { + currentGrouping.grouping.forEach( function( group ) { + if (!group.col) { + // should have a group.colName if there's no col + group.col = grid.getColumn(group.colName); + } + service.ungroupColumn(grid, group.col); + }); + } + + if ( currentGrouping.aggregations.length > 0 ) { + currentGrouping.aggregations.forEach( function( aggregation ) { + if (!aggregation.col) { + // should have a group.colName if there's no col + aggregation.col = grid.getColumn(aggregation.colName); + } + service.aggregateColumn(grid, aggregation.col, null); + }); + } + }, + + + /** + * @ngdoc function + * @name tidyPriorities + * @methodOf ui.grid.grouping.service:uiGridGroupingService + * @description Renumbers groupPriority and sortPriority such that + * groupPriority is contiguous, and sortPriority either matches + * groupPriority (for group columns), and otherwise is contiguous and + * higher than groupPriority. + * + * @param {Grid} grid grid object + */ + tidyPriorities: function( grid ) { + // if we're called from sortChanged, grid is in this, not passed as param, the param can be a column or undefined + if ( ( typeof(grid) === 'undefined' || typeof(grid.grid) !== 'undefined' ) && typeof(this.grid) !== 'undefined' ) { + grid = this.grid; + } + + var groupArray = [], + sortArray = []; + + grid.columns.forEach( function(column, index) { + if ( typeof(column.grouping) !== 'undefined' && typeof(column.grouping.groupPriority) !== 'undefined' && column.grouping.groupPriority >= 0) { + groupArray.push(column); + } + else if ( typeof(column.sort) !== 'undefined' && typeof(column.sort.priority) !== 'undefined' && column.sort.priority >= 0) { + sortArray.push(column); + } + }); + + groupArray.sort(function(a, b) { return a.grouping.groupPriority - b.grouping.groupPriority; }); + groupArray.forEach( function(column, index) { + column.grouping.groupPriority = index; + column.suppressRemoveSort = true; + if ( typeof(column.sort) === 'undefined') { + column.sort = {}; + } + column.sort.priority = index; + }); + + var i = groupArray.length; + + sortArray.sort(function(a, b) { return a.sort.priority - b.sort.priority; }); + sortArray.forEach(function(column) { + column.sort.priority = i; + column.suppressRemoveSort = column.colDef.suppressRemoveSort; + i++; + }); + }, + + /** + * @ngdoc function + * @name groupRows + * @methodOf ui.grid.grouping.service:uiGridGroupingService + * @description The rowProcessor that creates the groupHeaders (i.e. does + * the actual grouping). + * + * Assumes it is always called after the sorting processor, guaranteed by the priority setting + * + * Processes all the rows in order, inserting a groupHeader row whenever there is a change + * in value of a grouped row, based on the sortAlgorithm used for the column. The group header row + * is looked up in the groupHeaderCache, and used from there if there is one. The entity is reset + * to {} if one is found. + * + * As it processes it maintains a `processingState` array. This records, for each level of grouping we're + * working with, the following information: + * ``` + * { + * fieldName: name, + * col: col, + * initialised: boolean, + * currentValue: value, + * currentRow: gridRow, + * } + * ``` + * We look for changes in the currentValue at any of the levels. Where we find a change we: + * + * - create a new groupHeader row in the array + * + * @param {array} renderableRows the rows we want to process, usually the output from the previous rowProcessor + * @returns {array} the updated rows, including our new group rows + */ + groupRows: function( renderableRows ) { + if (renderableRows.length === 0) { + return renderableRows; + } + + var grid = this; + grid.grouping.oldGroupingHeaderCache = grid.grouping.groupingHeaderCache || {}; + grid.grouping.groupingHeaderCache = {}; + + var processingState = service.initialiseProcessingState( grid ); + + // processes each of the fields we are grouping by, checks if the value has changed and inserts a groupHeader + // Broken out as shouldn't create functions in a loop. + var updateProcessingState = function( groupFieldState, stateIndex ) { + var fieldValue = grid.getCellValue(row, groupFieldState.col); + + // look for change of value - and insert a header + if ( !groupFieldState.initialised || rowSorter.getSortFn(grid, groupFieldState.col, renderableRows)(fieldValue, groupFieldState.currentValue) !== 0 ) { + service.insertGroupHeader( grid, renderableRows, i, processingState, stateIndex ); + i++; + } + }; + + // use a for loop because it's tolerant of the array length changing whilst we go - we can + // manipulate the iterator when we insert groupHeader rows + for (var i = 0; i < renderableRows.length; i++ ) { + var row = renderableRows[i]; + + if ( row.visible ) { + processingState.forEach( updateProcessingState ); + } + } + + delete grid.grouping.oldGroupingHeaderCache; + return renderableRows; + }, + + + /** + * @ngdoc function + * @name initialiseProcessingState + * @methodOf ui.grid.grouping.service:uiGridGroupingService + * @description Creates the processing state array that is used + * for groupRows. + * + * @param {Grid} grid grid object + * @returns {array} an array in the format described in the groupRows method, + * initialised with blank values + */ + initialiseProcessingState: function( grid ) { + var processingState = []; + var columnSettings = service.getGrouping( grid ); + + columnSettings.grouping.forEach( function( groupItem, index) { + processingState.push({ + fieldName: groupItem.field, + col: groupItem.col, + initialised: false, + currentValue: null, + currentRow: null + }); + }); + + return processingState; + }, + + + /** + * @ngdoc function + * @name getGrouping + * @methodOf ui.grid.grouping.service:uiGridGroupingService + * @description Get the grouping settings from the columns. As a side effect + * this always renumbers the grouping starting at 0 + * @param {Grid} grid grid object + * @returns {array} an array of the group fields, in order of priority + */ + getGrouping: function( grid ) { + var groupArray = [], + aggregateArray = []; + + // get all the grouping + grid.columns.forEach(function(column) { + if ( column.grouping ) { + if ( typeof(column.grouping.groupPriority) !== 'undefined' && column.grouping.groupPriority >= 0) { + groupArray.push({ field: column.field, col: column, groupPriority: column.grouping.groupPriority, grouping: column.grouping }); + } + } + if ( column.treeAggregation && column.treeAggregation.type ) { + aggregateArray.push({ field: column.field, col: column, aggregation: column.treeAggregation }); + } + }); + + // sort grouping into priority order + groupArray.sort( function(a, b) { + return a.groupPriority - b.groupPriority; + }); + + // renumber the priority in case it was somewhat messed up, then remove the grouping reference + groupArray.forEach( function( group, index) { + group.grouping.groupPriority = index; + group.groupPriority = index; + delete group.grouping; + }); + + return { grouping: groupArray, aggregations: aggregateArray }; + }, + + + /** + * @ngdoc function + * @name insertGroupHeader + * @methodOf ui.grid.grouping.service:uiGridGroupingService + * @description Create a group header row, and link it to the various configuration + * items that we use. + * + * Look for the row in the oldGroupingHeaderCache, write the row into the new groupingHeaderCache. + * + * @param {Grid} grid grid object + * @param {array} renderableRows the rows that we are processing + * @param {number} rowIndex the row we were up to processing + * @param {array} processingState the current processing state + * @param {number} stateIndex the processing state item that we were on when we triggered a new group header - + * i.e. the column that we want to create a header for + */ + insertGroupHeader: function( grid, renderableRows, rowIndex, processingState, stateIndex ) { + // set the value that caused the end of a group into the header row and the processing state + var col = processingState[stateIndex].col, + newValue = grid.getCellValue(renderableRows[rowIndex], col), + newDisplayValue = newValue; + + if ( typeof(newValue) === 'undefined' || newValue === null ) { + newDisplayValue = grid.options.groupingNullLabel; + } + + function getKeyAsValueForCacheMap(key) { + return angular.isObject(key) ? JSON.stringify(key) : key; + } + + var cacheItem = grid.grouping.oldGroupingHeaderCache; + + for ( var i = 0; i < stateIndex; i++ ) { + if ( cacheItem && cacheItem[getKeyAsValueForCacheMap(processingState[i].currentValue)] ) { + cacheItem = cacheItem[getKeyAsValueForCacheMap(processingState[i].currentValue)].children; + } + } + + var headerRow; + + if ( cacheItem && cacheItem[getKeyAsValueForCacheMap(newValue)]) { + headerRow = cacheItem[getKeyAsValueForCacheMap(newValue)].row; + headerRow.entity = {}; + } else { + headerRow = new GridRow( {}, null, grid ); + gridClassFactory.rowTemplateAssigner.call(grid, headerRow); + } + + headerRow.entity['$$' + processingState[stateIndex].col.uid] = { groupVal: newDisplayValue }; + headerRow.treeLevel = stateIndex; + headerRow.groupHeader = true; + headerRow.internalRow = true; + headerRow.enableCellEdit = false; + headerRow.enableSelection = grid.options.enableGroupHeaderSelection; + processingState[stateIndex].initialised = true; + processingState[stateIndex].currentValue = newValue; + processingState[stateIndex].currentRow = headerRow; + + // set all processing states below this one to not be initialised - change of this state + // means all those need to start again + service.finaliseProcessingState( processingState, stateIndex + 1); + + // insert our new header row + renderableRows.splice(rowIndex, 0, headerRow); + + // add our new header row to the cache + cacheItem = grid.grouping.groupingHeaderCache; + for ( i = 0; i < stateIndex; i++ ) { + cacheItem = cacheItem[getKeyAsValueForCacheMap(processingState[i].currentValue)].children; + } + cacheItem[getKeyAsValueForCacheMap(newValue)] = { row: headerRow, children: {} }; + }, + + + /** + * @ngdoc function + * @name finaliseProcessingState + * @methodOf ui.grid.grouping.service:uiGridGroupingService + * @description Set all processing states lower than the one that had a break in value to + * no longer be initialised. Render the counts into the entity ready for display. + * + * @param {array} processingState the current processing state + * @param {number} stateIndex the processing state item that we were on when we triggered a new group header, all + * processing states after this need to be finalised + */ + finaliseProcessingState: function( processingState, stateIndex ) { + for ( var i = stateIndex; i < processingState.length; i++) { + processingState[i].initialised = false; + processingState[i].currentRow = null; + processingState[i].currentValue = null; + } + }, + + + /** + * @ngdoc function + * @name getRowExpandedStates + * @methodOf ui.grid.grouping.service:uiGridGroupingService + * @description Extract the groupHeaderCache hash, pulling out only the states. + * + * The example below shows a grid that is grouped by gender then age + * + *
+ * {
+ * male: {
+ * state: 'expanded',
+ * children: {
+ * 22: { state: 'expanded' },
+ * 30: { state: 'collapsed' }
+ * }
+ * },
+ * female: {
+ * state: 'expanded',
+ * children: {
+ * 28: { state: 'expanded' },
+ * 55: { state: 'collapsed' }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param {object} treeChildren The tree children elements object
+ * @returns {object} the expanded states as an object
+ */
+ getRowExpandedStates: function(treeChildren) {
+ if ( typeof(treeChildren) === 'undefined' ) {
+ return {};
+ }
+
+ var newChildren = {};
+
+ angular.forEach( treeChildren, function( value, key ) {
+ newChildren[key] = { state: value.row.treeNode.state };
+ if ( value.children ) {
+ newChildren[key].children = service.getRowExpandedStates( value.children );
+ } else {
+ newChildren[key].children = {};
+ }
+ });
+
+ return newChildren;
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name applyRowExpandedStates
+ * @methodOf ui.grid.grouping.service:uiGridGroupingService
+ * @description Take a hash in the format as created by getRowExpandedStates,
+ * and apply it to the grid.grouping.groupHeaderCache.
+ *
+ * Takes a treeSubset, and applies to a treeSubset - so can be called
+ * recursively.
+ *
+ * @param {object} currentNode can be grid.grouping.groupHeaderCache, or any of
+ * the children of that hash
+ * @param {object} expandedStates can be the full expanded states, or children
+ * of that expanded states (which hopefully matches the subset of the groupHeaderCache)
+ */
+ applyRowExpandedStates: function( currentNode, expandedStates ) {
+ if ( typeof(expandedStates) === 'undefined' ) {
+ return;
+ }
+
+ angular.forEach(expandedStates, function( value, key ) {
+ if ( currentNode[key] ) {
+ currentNode[key].row.treeNode.state = value.state;
+
+ if (value.children && currentNode[key].children) {
+ service.applyRowExpandedStates( currentNode[key].children, value.children );
+ }
+ }
+ });
+ }
+
+
+ };
+
+ return service;
+
+ }]);
+
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.grouping.directive:uiGridGrouping
+ * @element div
+ * @restrict A
+ *
+ * @description Adds grouping features to grid
+ *
+ * @example
+
+
+
+
+ * gridOptions.importerProcessHeaders: function( grid, headerArray ) {
+ * var myHeaderColumns = [];
+ * var thisCol;
+ * headerArray.forEach( function( value, index ) {
+ * thisCol = mySpecialLookupFunction( value );
+ * myHeaderColumns.push( thisCol.name );
+ * });
+ *
+ * return myHeaderCols;
+ * })
+ *
+ * @param {Grid} grid the grid we're importing into
+ * @param {array} headerArray an array of the text from the first row of the csv file,
+ * which you need to match to column.names
+ * @returns {array} array of matching column names, in the same order as the headerArray
+ *
+ */
+ gridOptions.importerProcessHeaders = gridOptions.importerProcessHeaders || service.processHeaders;
+
+ /**
+ * @ngdoc method
+ * @name importerHeaderFilter
+ * @methodOf ui.grid.importer.api:GridOptions
+ * @description A callback function that will filter (usually translate) a single
+ * header. Used when you want to match the passed in column names to the column
+ * displayName after the header filter.
+ *
+ * Your callback routine needs to return the filtered header value.
+ *
+ * gridOptions.importerHeaderFilter: function( displayName ) {
+ * return $translate.instant( displayName );
+ * })
+ *
+ *
+ * or:
+ * + * gridOptions.importerHeaderFilter: $translate.instant + *+ * @param {string} displayName the displayName that we'd like to translate + * @returns {string} the translated name + * + */ + gridOptions.importerHeaderFilter = gridOptions.importerHeaderFilter || function( displayName ) { return displayName; }; + + /** + * @ngdoc method + * @name importerErrorCallback + * @methodOf ui.grid.importer.api:GridOptions + * @description A callback function that provides custom error handling, rather + * than the standard grid behaviour of an alert box and a console message. You + * might use this to internationalise the console log messages, or to write to a + * custom logging routine that returned errors to the server. + * + *
+ * gridOptions.importerErrorCallback: function( grid, errorKey, consoleMessage, context ) {
+ * myUserDisplayRoutine( errorKey );
+ * myLoggingRoutine( consoleMessage, context );
+ * })
+ *
+ * @param {Grid} grid the grid we're importing into, may be useful if you're positioning messages
+ * in some way
+ * @param {string} errorKey one of the i18n keys the importer can return - importer.noHeaders,
+ * importer.noObjects, importer.invalidCsv, importer.invalidJson, importer.jsonNotArray
+ * @param {string} consoleMessage the English console message that importer would have written
+ * @param {object} context the context data that importer would have appended to that console message,
+ * often the file content itself or the element that is in error
+ *
+ */
+ if ( !gridOptions.importerErrorCallback || typeof(gridOptions.importerErrorCallback) !== 'function' ) {
+ delete gridOptions.importerErrorCallback;
+ }
+
+ /**
+ * @ngdoc method
+ * @name importerDataAddCallback
+ * @methodOf ui.grid.importer.api:GridOptions
+ * @description A mandatory callback function that adds data to the source data array. The grid
+ * generally doesn't add rows to the source data array, it is tidier to handle this through a user
+ * callback.
+ *
+ *
+ * gridOptions.importerDataAddCallback: function( grid, newObjects ) {
+ * $scope.myData = $scope.myData.concat( newObjects );
+ * })
+ *
+ * @param {Grid} grid the grid we're importing into, may be useful in some way
+ * @param {array} newObjects an array of new objects that you should add to your data
+ *
+ */
+ if ( gridOptions.enableImporter === true && !gridOptions.importerDataAddCallback ) {
+ gridUtil.logError("You have not set an importerDataAddCallback, importer is disabled");
+ gridOptions.enableImporter = false;
+ }
+
+ /**
+ * @ngdoc object
+ * @name importerNewObject
+ * @propertyOf ui.grid.importer.api:GridOptions
+ * @description An object on which we call `new` to create each new row before inserting it into
+ * the data array. Typically this would be a $resource entity, which means that if you're using
+ * the rowEdit feature, you can directly call save on this entity when the save event is triggered.
+ *
+ * Defaults to a vanilla javascript object
+ *
+ * @example
+ * + * gridOptions.importerNewObject = MyRes; + *+ * + */ + + /** + * @ngdoc property + * @propertyOf ui.grid.importer.api:GridOptions + * @name importerShowMenu + * @description Whether or not to show an item in the grid menu. Defaults to true. + * + */ + gridOptions.importerShowMenu = gridOptions.importerShowMenu !== false; + + /** + * @ngdoc method + * @methodOf ui.grid.importer.api:GridOptions + * @name importerObjectCallback + * @description A callback that massages the data for each object. For example, + * you might have data stored as a code value, but display the decode. This callback + * can be used to change the decoded value back into a code. Defaults to doing nothing. + * @param {Grid} grid in case you need it + * @param {object} newObject the new object as importer has created it, modify it + * then return the modified version + * @returns {object} the modified object + * @example + *
+ * gridOptions.importerObjectCallback = function ( grid, newObject ) {
+ * switch newObject.status {
+ * case 'Active':
+ * newObject.status = 1;
+ * break;
+ * case 'Inactive':
+ * newObject.status = 2;
+ * break;
+ * }
+ * return newObject;
+ * };
+ *
+ */
+ gridOptions.importerObjectCallback = gridOptions.importerObjectCallback || function( grid, newObject ) { return newObject; };
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name addToMenu
+ * @methodOf ui.grid.importer.service:uiGridImporterService
+ * @description Adds import menu item to the grid menu,
+ * allowing the user to request import of a file
+ * @param {Grid} grid the grid into which data should be imported
+ */
+ addToMenu: function ( grid ) {
+ grid.api.core.addToGridMenu( grid, [
+ {
+ title: i18nService.getSafeText('gridMenu.importerTitle'),
+ order: 150
+ },
+ {
+ templateUrl: 'ui-grid/importerMenuItemContainer',
+ action: function () {
+ this.grid.api.importer.importAFile( grid );
+ },
+ order: 151
+ }
+ ]);
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name importThisFile
+ * @methodOf ui.grid.importer.service:uiGridImporterService
+ * @description Imports the provided file into the grid using the file object
+ * provided. Bypasses the grid menu
+ * @param {Grid} grid the grid we're importing into
+ * @param {File} fileObject the file we want to import, as returned from the File
+ * javascript object
+ */
+ importThisFile: function ( grid, fileObject ) {
+ if (!fileObject) {
+ gridUtil.logError( 'No file object provided to importThisFile, should be impossible, aborting');
+ return;
+ }
+
+ var reader = new FileReader();
+
+ switch ( fileObject.type ) {
+ case 'application/json':
+ reader.onload = service.importJsonClosure( grid );
+ break;
+ default:
+ reader.onload = service.importCsvClosure( grid );
+ break;
+ }
+
+ reader.readAsText( fileObject );
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name importJson
+ * @methodOf ui.grid.importer.service:uiGridImporterService
+ * @description Creates a function that imports a json file into the grid.
+ * The json data is imported into new objects of type `gridOptions.importerNewObject`,
+ * and if the rowEdit feature is enabled the rows are marked as dirty
+ * @param {Grid} grid the grid we want to import into
+ * @return {function} Function that receives the file that we want to import, as
+ * a FileObject as an argument
+ */
+ importJsonClosure: function( grid ) {
+ return function( importFile ) {
+ var newObjects = [],
+ newObject,
+ importArray = service.parseJson( grid, importFile );
+
+ if (importArray === null) {
+ return;
+ }
+ importArray.forEach( function( value ) {
+ newObject = service.newObject( grid );
+ angular.extend( newObject, value );
+ newObject = grid.options.importerObjectCallback( grid, newObject );
+ newObjects.push( newObject );
+ });
+
+ service.addObjects( grid, newObjects );
+ };
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name parseJson
+ * @methodOf ui.grid.importer.service:uiGridImporterService
+ * @description Parses a json file, returns the parsed data.
+ * Displays an error if file doesn't parse
+ * @param {Grid} grid the grid that we want to import into
+ * @param {FileObject} importFile the file that we want to import, as
+ * a FileObject
+ * @returns {array} array of objects from the imported json
+ */
+ parseJson: function( grid, importFile ) {
+ var loadedObjects;
+
+ try {
+ loadedObjects = JSON.parse( importFile.target.result );
+ } catch (e) {
+ service.alertError( grid, 'importer.invalidJson', 'File could not be processed, is it valid json? Content was: ', importFile.target.result );
+ return;
+ }
+
+ if ( !Array.isArray( loadedObjects ) ) {
+ service.alertError( grid, 'importer.jsonNotarray', 'Import failed, file is not an array, file was: ', importFile.target.result );
+ return [];
+ } else {
+ return loadedObjects;
+ }
+ },
+
+
+
+ /**
+ * @ngdoc function
+ * @name importCsvClosure
+ * @methodOf ui.grid.importer.service:uiGridImporterService
+ * @description Creates a function that imports a csv file into the grid
+ * (allowing it to be used in the reader.onload event)
+ * @param {Grid} grid the grid that we want to import into
+ * @return {function} Function that receives the file that we want to import, as
+ * a file object
+ */
+ importCsvClosure: function( grid ) {
+ return function( importFile ) {
+ var importArray = service.parseCsv( importFile );
+
+ if ( !importArray || importArray.length < 1 ) {
+ service.alertError( grid, 'importer.invalidCsv', 'File could not be processed, is it valid csv? Content was: ', importFile.target.result );
+ return;
+ }
+
+ var newObjects = service.createCsvObjects( grid, importArray );
+
+ if ( !newObjects || newObjects.length === 0 ) {
+ service.alertError( grid, 'importer.noObjects', 'Objects were not able to be derived, content was: ', importFile.target.result );
+ return;
+ }
+
+ service.addObjects( grid, newObjects );
+ };
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name parseCsv
+ * @methodOf ui.grid.importer.service:uiGridImporterService
+ * @description Parses a csv file into an array of arrays, with the first
+ * array being the headers, and the remaining arrays being the data.
+ * The logic for this comes from https://github.com/thetalecrafter/excel.js/blob/master/src/csv.js,
+ * which is noted as being under the MIT license. The code is modified to pass the jscs yoda condition
+ * checker
+ * @param {FileObject} importFile the file that we want to import, as a
+ * file object
+ */
+ parseCsv: function( importFile ) {
+ var csv = importFile.target.result;
+
+ // use the CSV-JS library to parse
+ return CSV.parse(csv);
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name createCsvObjects
+ * @methodOf ui.grid.importer.service:uiGridImporterService
+ * @description Converts an array of arrays (representing the csv file)
+ * into a set of objects. Uses the provided `gridOptions.importerNewObject`
+ * to create the objects, and maps the header row into the individual columns
+ * using either `gridOptions.importerProcessHeaders`, or by using a native method
+ * of matching to either the displayName, column name or column field of
+ * the columns in the column defs. The resulting objects will have attributes
+ * that are named based on the column.field or column.name, in that order.
+ * @param {Grid} grid the grid that we want to import into
+ * @param {Array} importArray the data that we want to import, as an array
+ */
+ createCsvObjects: function( grid, importArray ) {
+ // pull off header row and turn into headers
+ var headerMapping = grid.options.importerProcessHeaders( grid, importArray.shift() );
+
+ if ( !headerMapping || headerMapping.length === 0 ) {
+ service.alertError( grid, 'importer.noHeaders', 'Column names could not be derived, content was: ', importArray );
+ return [];
+ }
+
+ var newObjects = [],
+ newObject;
+
+ importArray.forEach( function( row ) {
+ newObject = service.newObject( grid );
+ if ( row !== null ) {
+ row.forEach( function( field, index ) {
+ if ( headerMapping[index] !== null ) {
+ newObject[ headerMapping[index] ] = field;
+ }
+ });
+ }
+ newObject = grid.options.importerObjectCallback( grid, newObject );
+ newObjects.push( newObject );
+ });
+
+ return newObjects;
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name processHeaders
+ * @methodOf ui.grid.importer.service:uiGridImporterService
+ * @description Determines the columns that the header row from
+ * a csv (or other) file represents.
+ * @param {Grid} grid the grid we're importing into
+ * @param {array} headerRow the header row that we wish to match against
+ * the column definitions
+ * @returns {array} an array of the attribute names that should be used
+ * for that column, based on matching the headers or creating the headers
+ *
+ */
+ processHeaders: function( grid, headerRow ) {
+ var headers = [];
+
+ if ( !grid.options.columnDefs || grid.options.columnDefs.length === 0 ) {
+ // we are going to create new columnDefs for all these columns, so just remove
+ // spaces from the names to create fields
+ headerRow.forEach( function( value ) {
+ headers.push( value.replace( /[^0-9a-zA-Z\-_]/g, '_' ) );
+ });
+ return headers;
+ }
+ else {
+ var lookupHash = service.flattenColumnDefs( grid, grid.options.columnDefs );
+ headerRow.forEach( function( value ) {
+ if ( lookupHash[value] ) {
+ headers.push( lookupHash[value] );
+ }
+ else if ( lookupHash[ value.toLowerCase() ] ) {
+ headers.push( lookupHash[ value.toLowerCase() ] );
+ }
+ else {
+ headers.push( null );
+ }
+ });
+ return headers;
+ }
+ },
+
+
+ /**
+ * @name flattenColumnDefs
+ * @methodOf ui.grid.importer.service:uiGridImporterService
+ * @description Runs through the column defs and creates a hash of
+ * the displayName, name and field, and of each of those values forced to lower case,
+ * with each pointing to the field or name
+ * (whichever is present). Used to lookup column headers and decide what
+ * attribute name to give to the resulting field.
+ * @param {Grid} grid the grid we're importing into
+ * @param {array} columnDefs the columnDefs that we should flatten
+ * @returns {hash} the flattened version of the column def information, allowing
+ * us to look up a value by `flattenedHash[ headerValue ]`
+ */
+ flattenColumnDefs: function( grid, columnDefs ) {
+ var flattenedHash = {};
+
+ columnDefs.forEach( function( columnDef) {
+ if ( columnDef.name ) {
+ flattenedHash[ columnDef.name ] = columnDef.field || columnDef.name;
+ flattenedHash[ columnDef.name.toLowerCase() ] = columnDef.field || columnDef.name;
+ }
+
+ if ( columnDef.field ) {
+ flattenedHash[ columnDef.field ] = columnDef.field || columnDef.name;
+ flattenedHash[ columnDef.field.toLowerCase() ] = columnDef.field || columnDef.name;
+ }
+
+ if ( columnDef.displayName ) {
+ flattenedHash[ columnDef.displayName ] = columnDef.field || columnDef.name;
+ flattenedHash[ columnDef.displayName.toLowerCase() ] = columnDef.field || columnDef.name;
+ }
+
+ if ( columnDef.displayName && grid.options.importerHeaderFilter ) {
+ flattenedHash[ grid.options.importerHeaderFilter(columnDef.displayName) ] = columnDef.field || columnDef.name;
+ flattenedHash[ grid.options.importerHeaderFilter(columnDef.displayName).toLowerCase() ] = columnDef.field || columnDef.name;
+ }
+ });
+
+ return flattenedHash;
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name addObjects
+ * @methodOf ui.grid.importer.service:uiGridImporterService
+ * @description Inserts our new objects into the grid data, and
+ * sets the rows to dirty if the rowEdit feature is being used
+ *
+ * Does this by registering a watch on dataChanges, which essentially
+ * is waiting on the result of the grid data watch, and downstream processing.
+ *
+ * When the callback is called, it deregisters itself - we don't want to run
+ * again next time data is added.
+ *
+ * If we never get called, we deregister on destroy.
+ *
+ * @param {Grid} grid the grid we're importing into
+ * @param {array} newObjects the objects we want to insert into the grid data
+ * @returns {object} the new object
+ */
+ addObjects: function( grid, newObjects ) {
+ if ( grid.api.rowEdit ) {
+ var dataChangeDereg = grid.registerDataChangeCallback( function() {
+ grid.api.rowEdit.setRowsDirty( newObjects );
+ dataChangeDereg();
+ }, [uiGridConstants.dataChange.ROW] );
+
+ grid.importer.$scope.$on( '$destroy', dataChangeDereg );
+ }
+
+ grid.importer.$scope.$apply( grid.options.importerDataAddCallback( grid, newObjects ) );
+
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name newObject
+ * @methodOf ui.grid.importer.service:uiGridImporterService
+ * @description Makes a new object based on `gridOptions.importerNewObject`,
+ * or based on an empty object if not present
+ * @param {Grid} grid the grid we're importing into
+ * @returns {object} the new object
+ */
+ newObject: function( grid ) {
+ if ( typeof(grid.options) !== "undefined" && typeof(grid.options.importerNewObject) !== "undefined" ) {
+ return new grid.options.importerNewObject();
+ }
+ else {
+ return {};
+ }
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name alertError
+ * @methodOf ui.grid.importer.service:uiGridImporterService
+ * @description Provides an internationalised user alert for the failure,
+ * and logs a console message including diagnostic content.
+ * Optionally, if the the `gridOptions.importerErrorCallback` routine
+ * is defined, then calls that instead, allowing user specified error routines
+ * @param {Grid} grid the grid we're importing into
+ * @param {array} headerRow the header row that we wish to match against
+ * the column definitions
+ */
+ alertError: function( grid, alertI18nToken, consoleMessage, context ) {
+ if ( grid.options.importerErrorCallback ) {
+ grid.options.importerErrorCallback( grid, alertI18nToken, consoleMessage, context );
+ }
+ else {
+ $window.alert(i18nService.getSafeText( alertI18nToken ));
+ gridUtil.logError(consoleMessage + context );
+ }
+ }
+ };
+
+ return service;
+
+ }
+ ]);
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.importer.directive:uiGridImporter
+ * @element div
+ * @restrict A
+ *
+ * @description Adds importer features to grid
+ *
+ */
+ module.directive('uiGridImporter', ['uiGridImporterConstants', 'uiGridImporterService', 'gridUtil', '$compile',
+ function (uiGridImporterConstants, uiGridImporterService, gridUtil, $compile) {
+ return {
+ replace: true,
+ priority: 0,
+ require: '^uiGrid',
+ scope: false,
+ link: function ($scope, $elm, $attrs, uiGridCtrl) {
+ uiGridImporterService.initializeGrid($scope, uiGridCtrl.grid);
+ }
+ };
+ }
+ ]);
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.importer.directive:uiGridImporterMenuItem
+ * @element div
+ * @restrict A
+ *
+ * @description Handles the processing from the importer menu item - once a file is
+ * selected
+ *
+ */
+ module.directive('uiGridImporterMenuItem', ['uiGridImporterConstants', 'uiGridImporterService', 'gridUtil', '$compile',
+ function (uiGridImporterConstants, uiGridImporterService, gridUtil, $compile) {
+ return {
+ replace: true,
+ priority: 0,
+ require: '?^uiGrid',
+ scope: false,
+ templateUrl: 'ui-grid/importerMenuItem',
+ link: function ($scope, $elm, $attrs, uiGridCtrl) {
+ var grid;
+
+ function handleFileSelect(event) {
+ var target = event.srcElement || event.target;
+
+ if (target && target.files && target.files.length === 1) {
+ var fileObject = target.files[0];
+
+ // Define grid if the uiGrid controller is present
+ if (typeof(uiGridCtrl) !== 'undefined' && uiGridCtrl) {
+ grid = uiGridCtrl.grid;
+
+ uiGridImporterService.importThisFile( grid, fileObject );
+ target.form.reset();
+ }
+ else {
+ gridUtil.logError('Could not import file because UI Grid was not found.');
+ }
+ }
+ }
+
+ var fileChooser = $elm[0].querySelectorAll('.ui-grid-importer-file-chooser');
+
+ if ( fileChooser.length !== 1 ) {
+ gridUtil.logError('Found > 1 or < 1 file choosers within the menu item, error, cannot continue');
+ }
+ else {
+ fileChooser[0].addEventListener('change', handleFileSelect, false);
+ }
+ }
+ };
+ }
+ ]);
+})();
+
+angular.module('ui.grid.importer').run(['$templateCache', function($templateCache) {
+ 'use strict';
+
+ $templateCache.put('ui-grid/importerMenuItem',
+ ""
+ );
+
+
+ $templateCache.put('ui-grid/importerMenuItemContainer',
+ ""
+ );
+
+}]);
diff --git a/release/4.9.2/ui-grid.importer.min.js b/release/4.9.2/ui-grid.importer.min.js
new file mode 100644
index 000000000..d47b30d87
--- /dev/null
+++ b/release/4.9.2/ui-grid.importer.min.js
@@ -0,0 +1,7 @@
+/*!
+ * ui-grid - v4.9.2 - 2020-12-01
+ * Copyright (c) 2020 ; License: MIT
+ */
+
+
+!function(){"use strict";var e=angular.module("ui.grid.importer",["ui.grid"]);e.constant("uiGridImporterConstants",{featureName:"importer"}),e.service("uiGridImporterService",["$q","uiGridConstants","uiGridImporterConstants","gridUtil","$compile","$interval","i18nService","$window",function(e,i,r,o,t,n,a,s){var l={initializeGrid:function(e,r){r.importer={$scope:e},this.defaultGridOptions(r.options);var t={events:{importer:{}},methods:{importer:{importFile:function(e){l.importThisFile(r,e)}}}};r.api.registerEventsFromObject(t.events),r.api.registerMethodsFromObject(t.methods),r.options.enableImporter&&r.options.importerShowMenu&&(r.api.core.addToGridMenu?l.addToMenu(r):n(function(){r.api.core.addToGridMenu&&l.addToMenu(r)},100,1))},defaultGridOptions:function(e){e.enableImporter||void 0===e.enableImporter?s.hasOwnProperty("File")&&s.hasOwnProperty("FileReader")&&s.hasOwnProperty("FileList")&&s.hasOwnProperty("Blob")?e.enableImporter=!0:(o.logError("The File APIs are not fully supported in this browser, grid importer cannot be used."),e.enableImporter=!1):e.enableImporter=!1,e.importerProcessHeaders=e.importerProcessHeaders||l.processHeaders,e.importerHeaderFilter=e.importerHeaderFilter||function(e){return e},e.importerErrorCallback&&"function"==typeof e.importerErrorCallback||delete e.importerErrorCallback,!0!==e.enableImporter||e.importerDataAddCallback||(o.logError("You have not set an importerDataAddCallback, importer is disabled"),e.enableImporter=!1),e.importerShowMenu=!1!==e.importerShowMenu,e.importerObjectCallback=e.importerObjectCallback||function(e,r){return r}},addToMenu:function(e){e.api.core.addToGridMenu(e,[{title:a.getSafeText("gridMenu.importerTitle"),order:150},{templateUrl:"ui-grid/importerMenuItemContainer",action:function(){this.grid.api.importer.importAFile(e)},order:151}])},importThisFile:function(e,r){if(r){var t=new FileReader;switch(r.type){case"application/json":t.onload=l.importJsonClosure(e);break;default:t.onload=l.importCsvClosure(e)}t.readAsText(r)}else o.logError("No file object provided to importThisFile, should be impossible, aborting")},importJsonClosure:function(o){return function(e){var r,t=[],i=l.parseJson(o,e);null!==i&&(i.forEach(function(e){r=l.newObject(o),angular.extend(r,e),r=o.options.importerObjectCallback(o,r),t.push(r)}),l.addObjects(o,t))}},parseJson:function(r,t){var e;try{e=JSON.parse(t.target.result)}catch(e){return void l.alertError(r,"importer.invalidJson","File could not be processed, is it valid json? Content was: ",t.target.result)}return Array.isArray(e)?e:(l.alertError(r,"importer.jsonNotarray","Import failed, file is not an array, file was: ",t.target.result),[])},importCsvClosure:function(i){return function(e){var r=l.parseCsv(e);if(!r||r.length<1)l.alertError(i,"importer.invalidCsv","File could not be processed, is it valid csv? Content was: ",e.target.result);else{var t=l.createCsvObjects(i,r);t&&0!==t.length?l.addObjects(i,t):l.alertError(i,"importer.noObjects","Objects were not able to be derived, content was: ",e.target.result)}}},parseCsv:function(e){var r=e.target.result;return CSV.parse(r)},createCsvObjects:function(r,e){var t=r.options.importerProcessHeaders(r,e.shift());if(!t||0===t.length)return l.alertError(r,"importer.noHeaders","Column names could not be derived, content was: ",e),[];var i,o=[];return e.forEach(function(e){i=l.newObject(r),null!==e&&e.forEach(function(e,r){null!==t[r]&&(i[t[r]]=e)}),i=r.options.importerObjectCallback(r,i),o.push(i)}),o},processHeaders:function(e,r){var t=[];if(e.options.columnDefs&&0!==e.options.columnDefs.length){var i=l.flattenColumnDefs(e,e.options.columnDefs);return r.forEach(function(e){i[e]?t.push(i[e]):i[e.toLowerCase()]?t.push(i[e.toLowerCase()]):t.push(null)}),t}return r.forEach(function(e){t.push(e.replace(/[^0-9a-zA-Z\-_]/g,"_"))}),t},flattenColumnDefs:function(r,e){var t={};return e.forEach(function(e){e.name&&(t[e.name]=e.field||e.name,t[e.name.toLowerCase()]=e.field||e.name),e.field&&(t[e.field]=e.field||e.name,t[e.field.toLowerCase()]=e.field||e.name),e.displayName&&(t[e.displayName]=e.field||e.name,t[e.displayName.toLowerCase()]=e.field||e.name),e.displayName&&r.options.importerHeaderFilter&&(t[r.options.importerHeaderFilter(e.displayName)]=e.field||e.name,t[r.options.importerHeaderFilter(e.displayName).toLowerCase()]=e.field||e.name)}),t},addObjects:function(e,r){if(e.api.rowEdit){var t=e.registerDataChangeCallback(function(){e.api.rowEdit.setRowsDirty(r),t()},[i.dataChange.ROW]);e.importer.$scope.$on("$destroy",t)}e.importer.$scope.$apply(e.options.importerDataAddCallback(e,r))},newObject:function(e){return void 0!==e.options&&void 0!==e.options.importerNewObject?new e.options.importerNewObject:{}},alertError:function(e,r,t,i){e.options.importerErrorCallback?e.options.importerErrorCallback(e,r,t,i):(s.alert(a.getSafeText(r)),o.logError(t+i))}};return l}]),e.directive("uiGridImporter",["uiGridImporterConstants","uiGridImporterService","gridUtil","$compile",function(e,o,r,t){return{replace:!0,priority:0,require:"^uiGrid",scope:!1,link:function(e,r,t,i){o.initializeGrid(e,i.grid)}}}]),e.directive("uiGridImporterMenuItem",["uiGridImporterConstants","uiGridImporterService","gridUtil","$compile",function(e,a,s,r){return{replace:!0,priority:0,require:"?^uiGrid",scope:!1,templateUrl:"ui-grid/importerMenuItem",link:function(e,r,t,i){var o;var n=r[0].querySelectorAll(".ui-grid-importer-file-chooser");1!==n.length?s.logError("Found > 1 or < 1 file choosers within the menu item, error, cannot continue"):n[0].addEventListener("change",function(e){var r=e.srcElement||e.target;if(r&&r.files&&1===r.files.length){var t=r.files[0];void 0!==i&&i?(o=i.grid,a.importThisFile(o,t),r.form.reset()):s.logError("Could not import file because UI Grid was not found.")}},!1)}}}])}(),angular.module("ui.grid.importer").run(["$templateCache",function(e){"use strict";e.put("ui-grid/importerMenuItem",''),e.put("ui-grid/importerMenuItemContainer","")}]);
\ No newline at end of file
diff --git a/release/4.9.2/ui-grid.infinite-scroll.js b/release/4.9.2/ui-grid.infinite-scroll.js
new file mode 100644
index 000000000..6dfba39e4
--- /dev/null
+++ b/release/4.9.2/ui-grid.infinite-scroll.js
@@ -0,0 +1,548 @@
+/*!
+ * ui-grid - v4.9.2 - 2020-12-01
+ * Copyright (c) 2020 ; License: MIT
+ */
+
+(function() {
+ 'use strict';
+ /**
+ * @ngdoc overview
+ * @name ui.grid.infiniteScroll
+ *
+ * @description
+ *
+ * #ui.grid.infiniteScroll
+ *
+ * Beta This feature is ready for testing, but it either hasn't seen a lot of use or has some known bugs.
+ *
+ * This module provides infinite scroll functionality to ui-grid
+ *
+ */
+ var module = angular.module('ui.grid.infiniteScroll', ['ui.grid']);
+ /**
+ * @ngdoc service
+ * @name ui.grid.infiniteScroll.service:uiGridInfiniteScrollService
+ *
+ * @description Service for infinite scroll features
+ */
+ module.service('uiGridInfiniteScrollService', ['gridUtil', '$compile', '$rootScope', 'uiGridConstants', 'ScrollEvent', '$q', function (gridUtil, $compile, $rootScope, uiGridConstants, ScrollEvent, $q) {
+ var service = {
+
+ /**
+ * @ngdoc function
+ * @name initializeGrid
+ * @methodOf ui.grid.infiniteScroll.service:uiGridInfiniteScrollService
+ * @description This method register events and methods into grid public API
+ */
+
+ initializeGrid: function(grid, $scope) {
+ service.defaultGridOptions(grid.options);
+
+ if (!grid.options.enableInfiniteScroll) {
+ return;
+ }
+
+ grid.infiniteScroll = { dataLoading: false };
+ service.setScrollDirections( grid, grid.options.infiniteScrollUp, grid.options.infiniteScrollDown );
+ grid.api.core.on.scrollEnd($scope, service.handleScroll);
+
+ /**
+ * @ngdoc object
+ * @name ui.grid.infiniteScroll.api:PublicAPI
+ *
+ * @description Public API for infinite scroll feature
+ */
+ var publicApi = {
+ events: {
+ infiniteScroll: {
+
+ /**
+ * @ngdoc event
+ * @name needLoadMoreData
+ * @eventOf ui.grid.infiniteScroll.api:PublicAPI
+ * @description This event fires when scroll reaches bottom percentage of grid
+ * and needs to load data
+ */
+
+ needLoadMoreData: function ($scope, fn) {
+ },
+
+ /**
+ * @ngdoc event
+ * @name needLoadMoreDataTop
+ * @eventOf ui.grid.infiniteScroll.api:PublicAPI
+ * @description This event fires when scroll reaches top percentage of grid
+ * and needs to load data
+ */
+
+ needLoadMoreDataTop: function ($scope, fn) {
+ }
+ }
+ },
+ methods: {
+ infiniteScroll: {
+
+ /**
+ * @ngdoc function
+ * @name dataLoaded
+ * @methodOf ui.grid.infiniteScroll.api:PublicAPI
+ * @description Call this function when you have loaded the additional data
+ * requested. You should set scrollUp and scrollDown to indicate
+ * whether there are still more pages in each direction.
+ *
+ * If you call dataLoaded without first calling `saveScrollPercentage` then we will
+ * scroll the user to the start of the newly loaded data, which usually gives a smooth scroll
+ * experience, but can give a jumpy experience with large `infiniteScrollRowsFromEnd` values, and
+ * on variable speed internet connections. Using `saveScrollPercentage` as demonstrated in the tutorial
+ * should give a smoother scrolling experience for users.
+ *
+ * See infinite_scroll tutorial for example of usage
+ * @param {boolean} scrollUp if set to false flags that there are no more pages upwards, so don't fire
+ * any more infinite scroll events upward
+ * @param {boolean} scrollDown if set to false flags that there are no more pages downwards, so don't
+ * fire any more infinite scroll events downward
+ * @returns {promise} a promise that is resolved when the grid scrolling is fully adjusted. If you're
+ * planning to remove pages, you should wait on this promise first, or you'll break the scroll positioning
+ */
+ dataLoaded: function( scrollUp, scrollDown ) {
+ service.setScrollDirections(grid, scrollUp, scrollDown);
+
+ return service.adjustScroll(grid).then(function() {
+ grid.infiniteScroll.dataLoading = false;
+ });
+ },
+
+ /**
+ * @ngdoc function
+ * @name resetScroll
+ * @methodOf ui.grid.infiniteScroll.api:PublicAPI
+ * @description Call this function when you have taken some action that makes the current
+ * scroll position invalid. For example, if you're using external sorting and you've resorted
+ * then you might reset the scroll, or if you've otherwise substantially changed the data, perhaps
+ * you've reused an existing grid for a new data set
+ *
+ * You must tell us whether there is data upwards or downwards after the reset
+ *
+ * @param {boolean} scrollUp flag that there are pages upwards, fire
+ * infinite scroll events upward
+ * @param {boolean} scrollDown flag that there are pages downwards, so
+ * fire infinite scroll events downward
+ */
+ resetScroll: function( scrollUp, scrollDown ) {
+ service.setScrollDirections( grid, scrollUp, scrollDown);
+
+ service.adjustInfiniteScrollPosition(grid, 0);
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name saveScrollPercentage
+ * @methodOf ui.grid.infiniteScroll.api:PublicAPI
+ * @description Saves the scroll percentage and number of visible rows before you adjust the data,
+ * used if you're subsequently going to call `dataRemovedTop` or `dataRemovedBottom`
+ */
+ saveScrollPercentage: function() {
+ grid.infiniteScroll.prevScrollTop = grid.renderContainers.body.prevScrollTop;
+ grid.infiniteScroll.previousVisibleRows = grid.getVisibleRowCount();
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name dataRemovedTop
+ * @methodOf ui.grid.infiniteScroll.api:PublicAPI
+ * @description Adjusts the scroll position after you've removed data at the top
+ * @param {boolean} scrollUp flag that there are pages upwards, fire
+ * infinite scroll events upward
+ * @param {boolean} scrollDown flag that there are pages downwards, so
+ * fire infinite scroll events downward
+ */
+ dataRemovedTop: function( scrollUp, scrollDown ) {
+ service.dataRemovedTop( grid, scrollUp, scrollDown );
+ },
+
+ /**
+ * @ngdoc function
+ * @name dataRemovedBottom
+ * @methodOf ui.grid.infiniteScroll.api:PublicAPI
+ * @description Adjusts the scroll position after you've removed data at the bottom
+ * @param {boolean} scrollUp flag that there are pages upwards, fire
+ * infinite scroll events upward
+ * @param {boolean} scrollDown flag that there are pages downwards, so
+ * fire infinite scroll events downward
+ */
+ dataRemovedBottom: function( scrollUp, scrollDown ) {
+ service.dataRemovedBottom( grid, scrollUp, scrollDown );
+ },
+
+ /**
+ * @ngdoc function
+ * @name setScrollDirections
+ * @methodOf ui.grid.infiniteScroll.service:uiGridInfiniteScrollService
+ * @description Sets the scrollUp and scrollDown flags, handling nulls and undefined,
+ * and also sets the grid.suppressParentScroll
+ * @param {boolean} scrollUp whether there are pages available up - defaults to false
+ * @param {boolean} scrollDown whether there are pages available down - defaults to true
+ */
+ setScrollDirections: function ( scrollUp, scrollDown ) {
+ service.setScrollDirections( grid, scrollUp, scrollDown );
+ }
+
+ }
+ }
+ };
+ grid.api.registerEventsFromObject(publicApi.events);
+ grid.api.registerMethodsFromObject(publicApi.methods);
+ },
+
+
+ defaultGridOptions: function (gridOptions) {
+ // default option to true unless it was explicitly set to false
+ /**
+ * @ngdoc object
+ * @name ui.grid.infiniteScroll.api:GridOptions
+ *
+ * @description GridOptions for infinite scroll feature, these are available to be
+ * set using the ui-grid {@link ui.grid.class:GridOptions gridOptions}
+ */
+
+ /**
+ * @ngdoc object
+ * @name enableInfiniteScroll
+ * @propertyOf ui.grid.infiniteScroll.api:GridOptions
+ * @description Enable infinite scrolling for this grid
+ * Defaults to true + */ + gridOptions.enableInfiniteScroll = gridOptions.enableInfiniteScroll !== false; + + /** + * @ngdoc property + * @name infiniteScrollRowsFromEnd + * @propertyOf ui.grid.class:GridOptions + * @description This setting controls how close to the end of the dataset a user gets before + * more data is requested by the infinite scroll, whether scrolling up or down. This allows you to + * 'prefetch' rows before the user actually runs out of scrolling. + * + * Note that if you set this value too high it may give jumpy scrolling behaviour, if you're getting + * this behaviour you could use the `saveScrollPercentageMethod` right before loading your data, and we'll + * preserve that scroll position + * + * Defaults to 20 + */ + gridOptions.infiniteScrollRowsFromEnd = gridOptions.infiniteScrollRowsFromEnd || 20; + + /** + * @ngdoc property + * @name infiniteScrollUp + * @propertyOf ui.grid.class:GridOptions + * @description Whether you allow infinite scroll up, implying that the first page of data + * you have displayed is in the middle of your data set. If set to true then we trigger the + * needMoreDataTop event when the user hits the top of the scrollbar. + * Defaults to false + */ + gridOptions.infiniteScrollUp = gridOptions.infiniteScrollUp === true; + + /** + * @ngdoc property + * @name infiniteScrollDown + * @propertyOf ui.grid.class:GridOptions + * @description Whether you allow infinite scroll down, implying that the first page of data + * you have displayed is in the middle of your data set. If set to true then we trigger the + * needMoreData event when the user hits the bottom of the scrollbar. + * Defaults to true + */ + gridOptions.infiniteScrollDown = gridOptions.infiniteScrollDown !== false; + }, + + + /** + * @ngdoc function + * @name setScrollDirections + * @methodOf ui.grid.infiniteScroll.service:uiGridInfiniteScrollService + * @description Sets the scrollUp and scrollDown flags, handling nulls and undefined, + * and also sets the grid.suppressParentScroll + * @param {grid} grid the grid we're operating on + * @param {boolean} scrollUp whether there are pages available up - defaults to false + * @param {boolean} scrollDown whether there are pages available down - defaults to true + */ + setScrollDirections: function ( grid, scrollUp, scrollDown ) { + grid.infiniteScroll.scrollUp = ( scrollUp === true ); + grid.suppressParentScrollUp = ( scrollUp === true ); + + grid.infiniteScroll.scrollDown = ( scrollDown !== false); + grid.suppressParentScrollDown = ( scrollDown !== false); + }, + + + /** + * @ngdoc function + * @name handleScroll + * @methodOf ui.grid.infiniteScroll.service:uiGridInfiniteScrollService + * @description Called whenever the grid scrolls, determines whether the scroll should + * trigger an infinite scroll request for more data + * @param {object} args the args from the event + */ + handleScroll: function (args) { + // don't request data if already waiting for data, or if source is coming from ui.grid.adjustInfiniteScrollPosition() function + if ( args.grid.infiniteScroll && args.grid.infiniteScroll.dataLoading || args.source === 'ui.grid.adjustInfiniteScrollPosition' ) { + return; + } + + if (args.y) { + + // If the user is scrolling very quickly all the way to the top/bottom, the scroll handler can get confused + // about the direction. First we check if they've gone all the way, and data always is loaded in this case. + if (args.y.percentage === 0) { + args.grid.scrollDirection = uiGridConstants.scrollDirection.UP; + service.loadData(args.grid); + } + else if (args.y.percentage === 1) { + args.grid.scrollDirection = uiGridConstants.scrollDirection.DOWN; + service.loadData(args.grid); + } + else { // Scroll position is somewhere in between top/bottom, so determine whether it's far enough to load more data. + var percentage, + targetPercentage = args.grid.options.infiniteScrollRowsFromEnd / args.grid.renderContainers.body.visibleRowCache.length; + + if (args.grid.scrollDirection === uiGridConstants.scrollDirection.UP ) { + percentage = args.y.percentage; + if (percentage <= targetPercentage) { + service.loadData(args.grid); + } + } + else if (args.grid.scrollDirection === uiGridConstants.scrollDirection.DOWN) { + percentage = 1 - args.y.percentage; + if (percentage <= targetPercentage) { + service.loadData(args.grid); + } + } + } + } + }, + + + /** + * @ngdoc function + * @name loadData + * @methodOf ui.grid.infiniteScroll.service:uiGridInfiniteScrollService + * @description This function fires 'needLoadMoreData' or 'needLoadMoreDataTop' event based on scrollDirection + * and whether there are more pages upwards or downwards. It also stores the number of rows that we had previously, + * and clears out any saved scroll position so that we know whether or not the user calls `saveScrollPercentage` + * @param {Grid} grid the grid we're working on + */ + loadData: function (grid) { + // save number of currently visible rows to calculate new scroll position later - we know that we want + // to be at approximately the row we're currently at + grid.infiniteScroll.previousVisibleRows = grid.renderContainers.body.visibleRowCache.length; + grid.infiniteScroll.direction = grid.scrollDirection; + delete grid.infiniteScroll.prevScrollTop; + + if (grid.scrollDirection === uiGridConstants.scrollDirection.UP && grid.infiniteScroll.scrollUp ) { + grid.infiniteScroll.dataLoading = true; + grid.api.infiniteScroll.raise.needLoadMoreDataTop(); + } + else if (grid.scrollDirection === uiGridConstants.scrollDirection.DOWN && grid.infiniteScroll.scrollDown ) { + grid.infiniteScroll.dataLoading = true; + grid.api.infiniteScroll.raise.needLoadMoreData(); + } + }, + + + /** + * @ngdoc function + * @name adjustScroll + * @methodOf ui.grid.infiniteScroll.service:uiGridInfiniteScrollService + * @description Once we are informed that data has been loaded, adjust the scroll position to account for that + * addition and to make things look clean. + * + * If we're scrolling up we scroll to the first row of the old data set - + * so we're assuming that you would have gotten to the top of the grid (from the 20% need more data trigger) by + * the time the data comes back. If we're scrolling down we scroll to the last row of the old data set - so we're + * assuming that you would have gotten to the bottom of the grid (from the 80% need more data trigger) by the time + * the data comes back. + * + * Neither of these are good assumptions, but making this a smoother experience really requires + * that trigger to not be a percentage, and to be much closer to the end of the data (say, 5 rows off the end). Even then + * it'd be better still to actually run into the end. But if the data takes a while to come back, they may have scrolled + * somewhere else in the mean-time, in which case they'll get a jump back to the new data. Anyway, this will do for + * now, until someone wants to do better. + * @param {Grid} grid the grid we're working on + * @returns {promise} a promise that is resolved when scrolling has finished + */ + adjustScroll: function(grid) { + var promise = $q.defer(); + $rootScope.$applyAsync(function () { + var viewportHeight, rowHeight, newVisibleRows, oldTop, newTop; + + viewportHeight = grid.getViewportHeight() + grid.headerHeight - grid.renderContainers.body.headerHeight - grid.scrollbarHeight; + rowHeight = grid.options.rowHeight; + + if ( grid.infiniteScroll.direction === undefined ) { + // called from initialize, tweak our scroll up a little + service.adjustInfiniteScrollPosition(grid, 0); + } + + newVisibleRows = grid.getVisibleRowCount(); + + // in case not enough data is loaded to enable scroller - load more data + var canvasHeight = rowHeight * newVisibleRows; + if (grid.infiniteScroll.scrollDown && (viewportHeight > canvasHeight)) { + grid.api.infiniteScroll.raise.needLoadMoreData(); + } + + if ( grid.infiniteScroll.direction === uiGridConstants.scrollDirection.UP ) { + oldTop = grid.infiniteScroll.prevScrollTop || 0; + newTop = oldTop + (newVisibleRows - grid.infiniteScroll.previousVisibleRows)*rowHeight; + service.adjustInfiniteScrollPosition(grid, newTop); + $rootScope.$applyAsync( function() { + promise.resolve(); + }); + } + + if ( grid.infiniteScroll.direction === uiGridConstants.scrollDirection.DOWN ) { + newTop = grid.infiniteScroll.prevScrollTop || (grid.infiniteScroll.previousVisibleRows*rowHeight - viewportHeight); + service.adjustInfiniteScrollPosition(grid, newTop); + $rootScope.$applyAsync( function() { + promise.resolve(); + }); + } + }, 0); + + return promise.promise; + }, + + + /** + * @ngdoc function + * @name adjustInfiniteScrollPosition + * @methodOf ui.grid.infiniteScroll.service:uiGridInfiniteScrollService + * @description This function fires 'needLoadMoreData' or 'needLoadMoreDataTop' event based on scrollDirection + * @param {Grid} grid the grid we're working on + * @param {number} scrollTop the position through the grid that we want to scroll to + */ + adjustInfiniteScrollPosition: function (grid, scrollTop) { + var scrollEvent = new ScrollEvent(grid, null, null, 'ui.grid.adjustInfiniteScrollPosition'), + visibleRows = grid.getVisibleRowCount(), + viewportHeight = grid.getViewportHeight() + grid.headerHeight - grid.renderContainers.body.headerHeight - grid.scrollbarHeight, + rowHeight = grid.options.rowHeight, + scrollHeight = visibleRows*rowHeight-viewportHeight; + + // for infinite scroll, if there are pages upwards then never allow it to be at the zero position so the up button can be active + if (scrollTop === 0 && grid.infiniteScroll.scrollUp) { + // using pixels results in a relative scroll, hence we have to use percentage + scrollEvent.y = {pixels: 1}; + } + else { + scrollEvent.y = {percentage: scrollTop/scrollHeight}; + } + grid.scrollContainers('', scrollEvent); + }, + + + /** + * @ngdoc function + * @name dataRemovedTop + * @methodOf ui.grid.infiniteScroll.api:PublicAPI + * @description Adjusts the scroll position after you've removed data at the top. You should + * have called `saveScrollPercentage` before you remove the data, and if you're doing this in + * response to a `needMoreData` you should wait until the promise from `loadData` has resolved + * before you start removing data + * @param {Grid} grid the grid we're working on + * @param {boolean} scrollUp flag that there are pages upwards, fire + * infinite scroll events upward + * @param {boolean} scrollDown flag that there are pages downwards, so + * fire infinite scroll events downward + */ + dataRemovedTop: function( grid, scrollUp, scrollDown ) { + var newVisibleRows, oldTop, newTop, rowHeight; + service.setScrollDirections( grid, scrollUp, scrollDown ); + + newVisibleRows = grid.renderContainers.body.visibleRowCache.length; + oldTop = grid.infiniteScroll.prevScrollTop; + rowHeight = grid.options.rowHeight; + + // since we removed from the top, our new scroll row will be the old scroll row less the number + // of rows removed + newTop = oldTop - ( grid.infiniteScroll.previousVisibleRows - newVisibleRows )*rowHeight; + + service.adjustInfiniteScrollPosition( grid, newTop ); + }, + + /** + * @ngdoc function + * @name dataRemovedBottom + * @methodOf ui.grid.infiniteScroll.api:PublicAPI + * @description Adjusts the scroll position after you've removed data at the bottom. You should + * have called `saveScrollPercentage` before you remove the data, and if you're doing this in + * response to a `needMoreData` you should wait until the promise from `loadData` has resolved + * before you start removing data + * @param {Grid} grid the grid we're working on + * @param {boolean} scrollUp flag that there are pages upwards, fire + * infinite scroll events upward + * @param {boolean} scrollDown flag that there are pages downwards, so + * fire infinite scroll events downward + */ + dataRemovedBottom: function( grid, scrollUp, scrollDown ) { + var newTop; + + service.setScrollDirections( grid, scrollUp, scrollDown ); + + newTop = grid.infiniteScroll.prevScrollTop; + + service.adjustInfiniteScrollPosition( grid, newTop ); + } + }; + return service; + }]); + /** + * @ngdoc directive + * @name ui.grid.infiniteScroll.directive:uiGridInfiniteScroll + * @element div + * @restrict A + * + * @description Adds infinite scroll features to grid + * + * @example +
+
+
+ Stable This feature is stable. There should no longer be breaking api changes without a deprecation warning.
+
+ This module provides cell navigation functionality to UI-Grid.
+ */
+ var module = angular.module('ui.grid.cellNav', ['ui.grid']);
+
+ /**
+ * @ngdoc object
+ * @name ui.grid.cellNav.constant:uiGridCellNavConstants
+ *
+ * @description constants available in cellNav
+ */
+ module.constant('uiGridCellNavConstants', {
+ FEATURE_NAME: 'gridCellNav',
+ CELL_NAV_EVENT: 'cellNav',
+ direction: {LEFT: 0, RIGHT: 1, UP: 2, DOWN: 3, PG_UP: 4, PG_DOWN: 5},
+ EVENT_TYPE: {
+ KEYDOWN: 0,
+ CLICK: 1,
+ CLEAR: 2
+ }
+ });
+
+
+ module.factory('uiGridCellNavFactory', ['gridUtil', 'uiGridConstants', 'uiGridCellNavConstants', 'GridRowColumn', '$q',
+ function (gridUtil, uiGridConstants, uiGridCellNavConstants, GridRowColumn, $q) {
+ /**
+ * @ngdoc object
+ * @name ui.grid.cellNav.object:CellNav
+ * @description returns a CellNav prototype function
+ * @param {object} rowContainer container for rows
+ * @param {object} colContainer parent column container
+ * @param {object} leftColContainer column container to the left of parent
+ * @param {object} rightColContainer column container to the right of parent
+ */
+ var UiGridCellNav = function UiGridCellNav(rowContainer, colContainer, leftColContainer, rightColContainer) {
+ this.rows = rowContainer.visibleRowCache;
+ this.columns = colContainer.visibleColumnCache;
+ this.leftColumns = leftColContainer ? leftColContainer.visibleColumnCache : [];
+ this.rightColumns = rightColContainer ? rightColContainer.visibleColumnCache : [];
+ this.bodyContainer = rowContainer;
+ };
+
+ /** returns focusable columns of all containers */
+ UiGridCellNav.prototype.getFocusableCols = function () {
+ var allColumns = this.leftColumns.concat(this.columns, this.rightColumns);
+
+ return allColumns.filter(function (col) {
+ return col.colDef.allowCellFocus;
+ });
+ };
+
+ /**
+ * @ngdoc object
+ * @name ui.grid.cellNav.api:GridRow
+ *
+ * @description GridRow settings for cellNav feature, these are available to be
+ * set only internally (for example, by other features)
+ */
+
+ /**
+ * @ngdoc object
+ * @name allowCellFocus
+ * @propertyOf ui.grid.cellNav.api:GridRow
+ * @description Enable focus on a cell within this row. If set to false then no cells
+ * in this row can be focused - group header rows as an example would set this to false.
+ * Defaults to true + */ + /** returns focusable rows */ + UiGridCellNav.prototype.getFocusableRows = function () { + return this.rows.filter(function(row) { + return row.allowCellFocus !== false; + }); + }; + + UiGridCellNav.prototype.getNextRowCol = function (direction, curRow, curCol) { + switch (direction) { + case uiGridCellNavConstants.direction.LEFT: + return this.getRowColLeft(curRow, curCol); + case uiGridCellNavConstants.direction.RIGHT: + return this.getRowColRight(curRow, curCol); + case uiGridCellNavConstants.direction.UP: + return this.getRowColUp(curRow, curCol); + case uiGridCellNavConstants.direction.DOWN: + return this.getRowColDown(curRow, curCol); + case uiGridCellNavConstants.direction.PG_UP: + return this.getRowColPageUp(curRow, curCol); + case uiGridCellNavConstants.direction.PG_DOWN: + return this.getRowColPageDown(curRow, curCol); + } + }; + + UiGridCellNav.prototype.initializeSelection = function () { + var focusableCols = this.getFocusableCols(); + var focusableRows = this.getFocusableRows(); + if (focusableCols.length === 0 || focusableRows.length === 0) { + return null; + } + + return new GridRowColumn(focusableRows[0], focusableCols[0]); // return same row + }; + + UiGridCellNav.prototype.getRowColLeft = function (curRow, curCol) { + var focusableCols = this.getFocusableCols(); + var focusableRows = this.getFocusableRows(); + var curColIndex = focusableCols.indexOf(curCol); + var curRowIndex = focusableRows.indexOf(curRow); + + // could not find column in focusable Columns so set it to 1 + if (curColIndex === -1) { + curColIndex = 1; + } + + var nextColIndex = curColIndex === 0 ? focusableCols.length - 1 : curColIndex - 1; + + // get column to left + if (nextColIndex >= curColIndex) { + // On the first row + // if (curRowIndex === 0 && curColIndex === 0) { + // return null; + // } + if (curRowIndex === 0) { + return new GridRowColumn(curRow, focusableCols[nextColIndex]); // return same row + } + else { + // up one row and far right column + return new GridRowColumn(focusableRows[curRowIndex - 1], focusableCols[nextColIndex]); + } + } + else { + return new GridRowColumn(curRow, focusableCols[nextColIndex]); + } + }; + + + + UiGridCellNav.prototype.getRowColRight = function (curRow, curCol) { + var focusableCols = this.getFocusableCols(); + var focusableRows = this.getFocusableRows(); + var curColIndex = focusableCols.indexOf(curCol); + var curRowIndex = focusableRows.indexOf(curRow); + + // could not find column in focusable Columns so set it to 0 + if (curColIndex === -1) { + curColIndex = 0; + } + var nextColIndex = curColIndex === focusableCols.length - 1 ? 0 : curColIndex + 1; + + if (nextColIndex <= curColIndex) { + if (curRowIndex === focusableRows.length - 1) { + return new GridRowColumn(curRow, focusableCols[nextColIndex]); // return same row + } + else { + // down one row and far left column + return new GridRowColumn(focusableRows[curRowIndex + 1], focusableCols[nextColIndex]); + } + } + else { + return new GridRowColumn(curRow, focusableCols[nextColIndex]); + } + }; + + UiGridCellNav.prototype.getRowColDown = function (curRow, curCol) { + var focusableCols = this.getFocusableCols(); + var focusableRows = this.getFocusableRows(); + var curColIndex = focusableCols.indexOf(curCol); + var curRowIndex = focusableRows.indexOf(curRow); + + // could not find column in focusable Columns so set it to 0 + if (curColIndex === -1) { + curColIndex = 0; + } + + if (curRowIndex === focusableRows.length - 1) { + return new GridRowColumn(curRow, focusableCols[curColIndex]); // return same row + } + else { + // down one row + return new GridRowColumn(focusableRows[curRowIndex + 1], focusableCols[curColIndex]); + } + }; + + UiGridCellNav.prototype.getRowColPageDown = function (curRow, curCol) { + var focusableCols = this.getFocusableCols(); + var focusableRows = this.getFocusableRows(); + var curColIndex = focusableCols.indexOf(curCol); + var curRowIndex = focusableRows.indexOf(curRow); + + // could not find column in focusable Columns so set it to 0 + if (curColIndex === -1) { + curColIndex = 0; + } + + var pageSize = this.bodyContainer.minRowsToRender(); + if (curRowIndex >= focusableRows.length - pageSize) { + return new GridRowColumn(focusableRows[focusableRows.length - 1], focusableCols[curColIndex]); // return last row + } + else { + // down one page + return new GridRowColumn(focusableRows[curRowIndex + pageSize], focusableCols[curColIndex]); + } + }; + + UiGridCellNav.prototype.getRowColUp = function (curRow, curCol) { + var focusableCols = this.getFocusableCols(); + var focusableRows = this.getFocusableRows(); + var curColIndex = focusableCols.indexOf(curCol); + var curRowIndex = focusableRows.indexOf(curRow); + + // could not find column in focusable Columns so set it to 0 + if (curColIndex === -1) { + curColIndex = 0; + } + + if (curRowIndex === 0) { + return new GridRowColumn(curRow, focusableCols[curColIndex]); // return same row + } + else { + // up one row + return new GridRowColumn(focusableRows[curRowIndex - 1], focusableCols[curColIndex]); + } + }; + + UiGridCellNav.prototype.getRowColPageUp = function (curRow, curCol) { + var focusableCols = this.getFocusableCols(); + var focusableRows = this.getFocusableRows(); + var curColIndex = focusableCols.indexOf(curCol); + var curRowIndex = focusableRows.indexOf(curRow); + + // could not find column in focusable Columns so set it to 0 + if (curColIndex === -1) { + curColIndex = 0; + } + + var pageSize = this.bodyContainer.minRowsToRender(); + if (curRowIndex - pageSize < 0) { + return new GridRowColumn(focusableRows[0], focusableCols[curColIndex]); // return first row + } + else { + // up one page + return new GridRowColumn(focusableRows[curRowIndex - pageSize], focusableCols[curColIndex]); + } + }; + return UiGridCellNav; + }]); + + /** + * @ngdoc service + * @name ui.grid.cellNav.service:uiGridCellNavService + * + * @description Services for cell navigation features. If you don't like the key maps we use, + * or the direction cells navigation, override with a service decorator (see angular docs) + */ + module.service('uiGridCellNavService', ['gridUtil', 'uiGridConstants', 'uiGridCellNavConstants', '$q', 'uiGridCellNavFactory', 'GridRowColumn', 'ScrollEvent', + function (gridUtil, uiGridConstants, uiGridCellNavConstants, $q, UiGridCellNav, GridRowColumn, ScrollEvent) { + + var service = { + + initializeGrid: function (grid) { + grid.registerColumnBuilder(service.cellNavColumnBuilder); + + + /** + * @ngdoc object + * @name ui.grid.cellNav.Grid:cellNav + * @description cellNav properties added to grid class + */ + grid.cellNav = {}; + grid.cellNav.lastRowCol = null; + grid.cellNav.focusedCells = []; + + service.defaultGridOptions(grid.options); + + /** + * @ngdoc object + * @name ui.grid.cellNav.api:PublicApi + * + * @description Public Api for cellNav feature + */ + var publicApi = { + events: { + cellNav: { + /** + * @ngdoc event + * @name navigate + * @eventOf ui.grid.cellNav.api:PublicApi + * @description raised when the active cell is changed + *
+ * gridApi.cellNav.on.navigate(scope,function(newRowcol, oldRowCol) {})
+ *
+ * @param {object} newRowCol new position
+ * @param {object} oldRowCol old position
+ */
+ navigate: function (newRowCol, oldRowCol) {},
+ /**
+ * @ngdoc event
+ * @name viewPortKeyDown
+ * @eventOf ui.grid.cellNav.api:PublicApi
+ * @description is raised when the viewPort receives a keyDown event. Cells never get focus in uiGrid
+ * due to the difficulties of setting focus on a cell that is not visible in the viewport. Use this
+ * event whenever you need a keydown event on a cell
+ * + * @param {object} event keydown event + * @param {object} rowCol current rowCol position + */ + viewPortKeyDown: function (event, rowCol) {}, + + /** + * @ngdoc event + * @name viewPortKeyPress + * @eventOf ui.grid.cellNav.api:PublicApi + * @description is raised when the viewPort receives a keyPress event. Cells never get focus in uiGrid + * due to the difficulties of setting focus on a cell that is not visible in the viewport. Use this + * event whenever you need a keypress event on a cell + * + * @param {object} event keypress event + * @param {object} rowCol current rowCol position + */ + viewPortKeyPress: function (event, rowCol) {} + } + }, + methods: { + cellNav: { + /** + * @ngdoc function + * @name scrollToFocus + * @methodOf ui.grid.cellNav.api:PublicApi + * @description brings the specified row and column into view, and sets focus + * to that cell + * @param {object} rowEntity gridOptions.data[] array instance to make visible and set focus + * @param {object} colDef to make visible and set focus + * @returns {promise} a promise that is resolved after any scrolling is finished + */ + scrollToFocus: function (rowEntity, colDef) { + return service.scrollToFocus(grid, rowEntity, colDef); + }, + + /** + * @ngdoc function + * @name getFocusedCell + * @methodOf ui.grid.cellNav.api:PublicApi + * @description returns the current (or last if Grid does not have focus) focused row and column + * value is null if no selection has occurred + */ + getFocusedCell: function () { + return grid.cellNav.lastRowCol; + }, + + /** + * @ngdoc function + * @name getCurrentSelection + * @methodOf ui.grid.cellNav.api:PublicApi + * @description returns an array containing the current selection + * array is empty if no selection has occurred + */ + getCurrentSelection: function () { + return grid.cellNav.focusedCells; + }, + + /** + * @ngdoc function + * @name rowColSelectIndex + * @methodOf ui.grid.cellNav.api:PublicApi + * @description returns the index in the order in which the GridRowColumn was selected, returns -1 if the GridRowColumn + * isn't selected + * @param {object} rowCol the rowCol to evaluate + */ + rowColSelectIndex: function (rowCol) { + // return gridUtil.arrayContainsObjectWithProperty(grid.cellNav.focusedCells, 'col.uid', rowCol.col.uid) && + var index = -1; + for (var i = 0; i < grid.cellNav.focusedCells.length; i++) { + if (grid.cellNav.focusedCells[i].col.uid === rowCol.col.uid && + grid.cellNav.focusedCells[i].row.uid === rowCol.row.uid) { + index = i; + break; + } + } + return index; + } + } + } + }; + + grid.api.registerEventsFromObject(publicApi.events); + + grid.api.registerMethodsFromObject(publicApi.methods); + }, + + defaultGridOptions: function (gridOptions) { + /** + * @ngdoc object + * @name ui.grid.cellNav.api:GridOptions + * + * @description GridOptions for cellNav feature, these are available to be + * set using the ui-grid {@link ui.grid.class:GridOptions gridOptions} + */ + + /** + * @ngdoc object + * @name modifierKeysToMultiSelectCells + * @propertyOf ui.grid.cellNav.api:GridOptions + * @description Enable multiple cell selection only when using the ctrlKey or shiftKey. + * Defaults to false + */ + gridOptions.modifierKeysToMultiSelectCells = gridOptions.modifierKeysToMultiSelectCells === true; + + /** + * @ngdoc array + * @name keyDownOverrides + * @propertyOf ui.grid.cellNav.api:GridOptions + * @description An array of event objects to override on keydown. If an event is overridden, the viewPortKeyDown event will + * be raised with the overridden events, allowing custom keydown behavior. + * Defaults to [] + */ + gridOptions.keyDownOverrides = gridOptions.keyDownOverrides || []; + + }, + + /** + * @ngdoc service + * @name decorateRenderContainers + * @methodOf ui.grid.cellNav.service:uiGridCellNavService + * @description decorates grid renderContainers with cellNav functions + */ + decorateRenderContainers: function (grid) { + + var rightContainer = grid.hasRightContainer() ? grid.renderContainers.right : null; + var leftContainer = grid.hasLeftContainer() ? grid.renderContainers.left : null; + + if (leftContainer !== null) { + grid.renderContainers.left.cellNav = new UiGridCellNav(grid.renderContainers.body, leftContainer, rightContainer, grid.renderContainers.body); + } + if (rightContainer !== null) { + grid.renderContainers.right.cellNav = new UiGridCellNav(grid.renderContainers.body, rightContainer, grid.renderContainers.body, leftContainer); + } + + grid.renderContainers.body.cellNav = new UiGridCellNav(grid.renderContainers.body, grid.renderContainers.body, leftContainer, rightContainer); + }, + + /** + * @ngdoc service + * @name getDirection + * @methodOf ui.grid.cellNav.service:uiGridCellNavService + * @description determines which direction to for a given keyDown event + * @returns {uiGridCellNavConstants.direction} direction + */ + getDirection: function (evt) { + if (evt.keyCode === uiGridConstants.keymap.LEFT || + (evt.keyCode === uiGridConstants.keymap.TAB && evt.shiftKey)) { + return uiGridCellNavConstants.direction.LEFT; + } + if (evt.keyCode === uiGridConstants.keymap.RIGHT || + evt.keyCode === uiGridConstants.keymap.TAB) { + return uiGridCellNavConstants.direction.RIGHT; + } + + if (evt.keyCode === uiGridConstants.keymap.UP || + (evt.keyCode === uiGridConstants.keymap.ENTER && evt.shiftKey) ) { + return uiGridCellNavConstants.direction.UP; + } + + if (evt.keyCode === uiGridConstants.keymap.PG_UP) { + return uiGridCellNavConstants.direction.PG_UP; + } + + if (evt.keyCode === uiGridConstants.keymap.DOWN || + evt.keyCode === uiGridConstants.keymap.ENTER && !(evt.ctrlKey || evt.altKey)) { + return uiGridCellNavConstants.direction.DOWN; + } + + if (evt.keyCode === uiGridConstants.keymap.PG_DOWN) { + return uiGridCellNavConstants.direction.PG_DOWN; + } + + return null; + }, + + /** + * @ngdoc service + * @name cellNavColumnBuilder + * @methodOf ui.grid.cellNav.service:uiGridCellNavService + * @description columnBuilder function that adds cell navigation properties to grid column + * @returns {promise} promise that will load any needed templates when resolved + */ + cellNavColumnBuilder: function (colDef, col, gridOptions) { + var promises = []; + + /** + * @ngdoc object + * @name ui.grid.cellNav.api:ColumnDef + * + * @description Column Definitions for cellNav feature, these are available to be + * set using the ui-grid {@link ui.grid.class:GridOptions.columnDef gridOptions.columnDefs} + */ + + /** + * @ngdoc object + * @name allowCellFocus + * @propertyOf ui.grid.cellNav.api:ColumnDef + * @description Enable focus on a cell within this column. + * Defaults to true + */ + colDef.allowCellFocus = colDef.allowCellFocus === undefined ? true : colDef.allowCellFocus; + + return $q.all(promises); + }, + + /** + * @ngdoc method + * @methodOf ui.grid.cellNav.service:uiGridCellNavService + * @name scrollToFocus + * @description Scroll the grid such that the specified + * row and column is in view, and set focus to the cell in that row and column + * @param {Grid} grid the grid you'd like to act upon, usually available + * from gridApi.grid + * @param {object} rowEntity gridOptions.data[] array instance to make visible and set focus to + * @param {object} colDef to make visible and set focus to + * @returns {promise} a promise that is resolved after any scrolling is finished + */ + scrollToFocus: function (grid, rowEntity, colDef) { + var gridRow = null, gridCol = null; + + if (typeof(rowEntity) !== 'undefined' && rowEntity !== null) { + gridRow = grid.getRow(rowEntity); + } + + if (typeof(colDef) !== 'undefined' && colDef !== null) { + gridCol = grid.getColumn(colDef.name ? colDef.name : colDef.field); + } + return grid.api.core.scrollToIfNecessary(gridRow, gridCol).then(function () { + var rowCol = { row: gridRow, col: gridCol }; + + // Broadcast the navigation + if (gridRow !== null && gridCol !== null) { + grid.cellNav.broadcastCellNav(rowCol, null, null); + } + }); + }, + + + /** + * @ngdoc method + * @methodOf ui.grid.cellNav.service:uiGridCellNavService + * @name getLeftWidth + * @description Get the current drawn width of the columns in the + * grid up to the numbered column, and add an apportionment for the + * column that we're on. So if we are on column 0, we want to scroll + * 0% (i.e. exclude this column from calc). If we're on the last column + * we want to scroll to 100% (i.e. include this column in the calc). So + * we include (thisColIndex / totalNumberCols) % of this column width + * @param {Grid} grid the grid you'd like to act upon, usually available + * from gridApi.grid + * @param {GridColumn} upToCol the column to total up to and including + */ + getLeftWidth: function (grid, upToCol) { + var width = 0; + + if (!upToCol) { + return width; + } + + var lastIndex = grid.renderContainers.body.visibleColumnCache.indexOf( upToCol ); + + // total column widths up-to but not including the passed in column + grid.renderContainers.body.visibleColumnCache.forEach( function( col, index ) { + if ( index < lastIndex ) { + width += col.drawnWidth; + } + }); + + // pro-rata the final column based on % of total columns. + var percentage = lastIndex === 0 ? 0 : (lastIndex + 1) / grid.renderContainers.body.visibleColumnCache.length; + width += upToCol.drawnWidth * percentage; + + return width; + } + }; + + return service; + }]); + + /** + * @ngdoc directive + * @name ui.grid.cellNav.directive:uiCellNav + * @element div + * @restrict EA + * + * @description Adds cell navigation features to the grid columns + * + * @example +
+
+
+ ' +
+ ' ' +
+ ' ';
+
+ var ariaNotifier = $compile(ariaNotifierDomElt)($scope);
+ $elm.prepend(ariaNotifier);
+ $scope.$on(uiGridCellNavConstants.CELL_NAV_EVENT, function (evt, rowCol, modifierDown, originEvt) {
+ /*
+ * If the cell nav event was because of a focus event then we don't want to
+ * change the notifier text.
+ * Reasoning: Voice Over fires a focus events when moving arround the grid.
+ * If the screen reader is handing the grid nav properly then we don't need to
+ * use the alert to notify the user of the movement.
+ * In all other cases we do want a notification event.
+ */
+ if (originEvt && originEvt.type === 'focus') {return;}
+
+ function setNotifyText(text) {
+ if (text === ariaNotifier.text().trim()) {return;}
+ ariaNotifier[0].style.clip = 'rect(0px,0px,0px,0px)';
+ /*
+ * This is how google docs handles clearing the div. Seems to work better than setting the text of the div to ''
+ */
+ ariaNotifier[0].innerHTML = "";
+ ariaNotifier[0].style.visibility = 'hidden';
+ ariaNotifier[0].style.visibility = 'visible';
+ if (text !== '') {
+ ariaNotifier[0].style.clip = 'auto';
+ /*
+ * The space after the text is something that google docs does.
+ */
+ ariaNotifier[0].appendChild(document.createTextNode(text + " "));
+ ariaNotifier[0].style.visibility = 'hidden';
+ ariaNotifier[0].style.visibility = 'visible';
+ }
+ }
+
+ function getAppendedColumnHeaderText(col) {
+ return ', ' + i18nService.getSafeText('headerCell.aria.column') + ' ' + col.displayName;
+ }
+
+ function getCellDisplayValue(currentRowColumn) {
+ if (currentRowColumn.col.field === 'selectionRowHeaderCol') {
+ // This is the case when the 'selection' feature is used in the grid and the user has moved
+ // to or inside of the left grid container which holds the checkboxes for selecting rows.
+ // This is necessary for Accessibility. Without this a screen reader cannot determine if the row
+ // is or is not currently selected.
+ return currentRowColumn.row.isSelected ? i18nService.getSafeText('search.aria.selected') : i18nService.getSafeText('search.aria.notSelected');
+ } else {
+ return grid.getCellDisplayValue(currentRowColumn.row, currentRowColumn.col);
+ }
+ }
+
+ var values = [];
+ var currentSelection = grid.api.cellNav.getCurrentSelection();
+ for (var i = 0; i < currentSelection.length; i++) {
+ var cellDisplayValue = getCellDisplayValue(currentSelection[i]) + getAppendedColumnHeaderText(currentSelection[i].col);
+ values.push(cellDisplayValue);
+ }
+ var cellText = values.toString();
+ setNotifyText(cellText);
+
+ });
+ }
+ // Only add the ngAria stuff it will be used
+ if (usesAria) {
+ addAriaLiveRegion();
+ }
+ }
+ };
+ }
+ };
+ }]);
+
+ module.directive('uiGridRenderContainer', ['$timeout', '$document', 'gridUtil', 'uiGridConstants', 'uiGridCellNavService', '$compile','uiGridCellNavConstants',
+ function ($timeout, $document, gridUtil, uiGridConstants, uiGridCellNavService, $compile, uiGridCellNavConstants) {
+ return {
+ replace: true,
+ priority: -99999, // this needs to run very last
+ require: ['^uiGrid', 'uiGridRenderContainer', '?^uiGridCellnav'],
+ scope: false,
+ compile: function () {
+ return {
+ post: function ($scope, $elm, $attrs, controllers) {
+ var uiGridCtrl = controllers[0],
+ renderContainerCtrl = controllers[1],
+ uiGridCellnavCtrl = controllers[2];
+
+ // Skip attaching cell-nav specific logic if the directive is not attached above us
+ if (!uiGridCtrl.grid.api.cellNav) { return; }
+
+ var containerId = renderContainerCtrl.containerId;
+
+ var grid = uiGridCtrl.grid;
+
+ // run each time a render container is created
+ uiGridCellNavService.decorateRenderContainers(grid);
+
+ // focusser only created for body
+ if (containerId !== 'body') {
+ return;
+ }
+
+ if (uiGridCtrl.grid.options.modifierKeysToMultiSelectCells) {
+ $elm.attr('aria-multiselectable', true);
+ }
+ else {
+ $elm.attr('aria-multiselectable', false);
+ }
+
+ // add an element with no dimensions that can be used to set focus and capture keystrokes
+ var focuser = $compile('')($scope);
+ $elm.append(focuser);
+
+ focuser.on('focus', function (evt) {
+ evt.uiGridTargetRenderContainerId = containerId;
+ var rowCol = uiGridCtrl.grid.api.cellNav.getFocusedCell();
+ if (rowCol === null) {
+ rowCol = uiGridCtrl.grid.renderContainers[containerId].cellNav.getNextRowCol(uiGridCellNavConstants.direction.DOWN, null, null);
+ if (rowCol.row && rowCol.col) {
+ uiGridCtrl.cellNav.broadcastCellNav(rowCol);
+ }
+ }
+ });
+
+ uiGridCellnavCtrl.setAriaActivedescendant = function(id) {
+ $elm.attr('aria-activedescendant', id);
+ };
+
+ uiGridCellnavCtrl.removeAriaActivedescendant = function(id) {
+ if ($elm.attr('aria-activedescendant') === id) {
+ $elm.attr('aria-activedescendant', '');
+ }
+ };
+
+
+ uiGridCtrl.focus = function () {
+ gridUtil.focus.byElement(focuser[0]);
+ // allow for first time grid focus
+ };
+
+ var viewPortKeyDownWasRaisedForRowCol = null;
+ // Bind to keydown events in the render container
+ focuser.on('keydown', function (evt) {
+ evt.uiGridTargetRenderContainerId = containerId;
+ var rowCol = uiGridCtrl.grid.api.cellNav.getFocusedCell();
+ var raiseViewPortKeyDown = uiGridCtrl.grid.options.keyDownOverrides.some(function (override) {
+ return Object.keys(override).every( function (property) {
+ return override[property] === evt[property];
+ });
+ });
+ var result = raiseViewPortKeyDown ? null : uiGridCtrl.cellNav.handleKeyDown(evt);
+ if (result === null) {
+ uiGridCtrl.grid.api.cellNav.raise.viewPortKeyDown(evt, rowCol, uiGridCtrl.cellNav.handleKeyDown);
+ viewPortKeyDownWasRaisedForRowCol = rowCol;
+ }
+ });
+ // Bind to keypress events in the render container
+ // keypress events are needed by edit function so the key press
+ // that initiated an edit is not lost
+ // must fire the event in a timeout so the editor can
+ // initialize and subscribe to the event on another event loop
+ focuser.on('keypress', function (evt) {
+ if (viewPortKeyDownWasRaisedForRowCol) {
+ $timeout(function () {
+ uiGridCtrl.grid.api.cellNav.raise.viewPortKeyPress(evt, viewPortKeyDownWasRaisedForRowCol);
+ }, 4);
+
+ viewPortKeyDownWasRaisedForRowCol = null;
+ }
+ });
+
+ $scope.$on('$destroy', function() {
+ // Remove all event handlers associated with this focuser.
+ focuser.off();
+ });
+ }
+ };
+ }
+ };
+ }]);
+
+ module.directive('uiGridViewport',
+ function () {
+ return {
+ replace: true,
+ priority: -99999, // this needs to run very last
+ require: ['^uiGrid', '^uiGridRenderContainer', '?^uiGridCellnav'],
+ scope: false,
+ compile: function () {
+ return {
+ pre: function ($scope, $elm, $attrs, uiGridCtrl) {
+ },
+ post: function ($scope, $elm, $attrs, controllers) {
+ var uiGridCtrl = controllers[0],
+ renderContainerCtrl = controllers[1];
+
+ // Skip attaching cell-nav specific logic if the directive is not attached above us
+ if (!uiGridCtrl.grid.api.cellNav) { return; }
+
+ var containerId = renderContainerCtrl.containerId;
+ // no need to process for other containers
+ if (containerId !== 'body') {
+ return;
+ }
+
+ var grid = uiGridCtrl.grid;
+
+ grid.api.core.on.scrollBegin($scope, function () {
+
+ // Skip if there's no currently-focused cell
+ var lastRowCol = uiGridCtrl.grid.api.cellNav.getFocusedCell();
+ if (lastRowCol === null) {
+ return;
+ }
+
+ // if not in my container, move on
+ // todo: worry about horiz scroll
+ if (!renderContainerCtrl.colContainer.containsColumn(lastRowCol.col)) {
+ return;
+ }
+
+ uiGridCtrl.cellNav.clearFocus();
+
+ });
+
+ grid.api.core.on.scrollEnd($scope, function (args) {
+ // Skip if there's no currently-focused cell
+ var lastRowCol = uiGridCtrl.grid.api.cellNav.getFocusedCell();
+ if (lastRowCol === null) {
+ return;
+ }
+
+ // if not in my container, move on
+ // todo: worry about horiz scroll
+ if (!renderContainerCtrl.colContainer.containsColumn(lastRowCol.col)) {
+ return;
+ }
+
+ uiGridCtrl.cellNav.broadcastCellNav(lastRowCol);
+ });
+
+ grid.api.cellNav.on.navigate($scope, function () {
+ // focus again because it can be lost
+ uiGridCtrl.focus();
+ });
+ }
+ };
+ }
+ };
+ });
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.cellNav.directive:uiGridCell
+ * @element div
+ * @restrict A
+ * @description Stacks on top of ui.grid.uiGridCell to provide cell navigation
+ */
+ module.directive('uiGridCell', ['$timeout', '$document', 'uiGridCellNavService', 'gridUtil', 'uiGridCellNavConstants', 'uiGridConstants', 'GridRowColumn',
+ function ($timeout, $document, uiGridCellNavService, gridUtil, uiGridCellNavConstants, uiGridConstants, GridRowColumn) {
+ return {
+ priority: -150, // run after default uiGridCell directive and ui.grid.edit uiGridCell
+ restrict: 'A',
+ require: ['^uiGrid', '?^uiGridCellnav'],
+ scope: false,
+ link: function ($scope, $elm, $attrs, controllers) {
+ var uiGridCtrl = controllers[0],
+ uiGridCellnavCtrl = controllers[1];
+ // Skip attaching cell-nav specific logic if the directive is not attached above us
+ if (!uiGridCtrl.grid.api.cellNav) { return; }
+
+ if (!$scope.col.colDef.allowCellFocus) {
+ return;
+ }
+
+ // Convinience local variables
+ var grid = uiGridCtrl.grid;
+ $scope.focused = false;
+
+ // Make this cell focusable but only with javascript/a mouse click
+ $elm.attr('tabindex', -1);
+
+ // When a cell is clicked, broadcast a cellNav event saying that this row+col combo is now focused
+ $elm.find('div').on('click', function (evt) {
+ uiGridCtrl.cellNav.broadcastCellNav(new GridRowColumn($scope.row, $scope.col), evt.ctrlKey || evt.metaKey, evt);
+
+ evt.stopPropagation();
+ $scope.$apply();
+ });
+
+
+ /*
+ * XXX Hack for screen readers.
+ * This allows the grid to focus using only the screen reader cursor.
+ * Since the focus event doesn't include key press information we can't use it
+ * as our primary source of the event.
+ */
+ $elm.on('mousedown', preventMouseDown);
+
+ // turn on and off for edit events
+ if (uiGridCtrl.grid.api.edit) {
+ uiGridCtrl.grid.api.edit.on.beginCellEdit($scope, function () {
+ $elm.off('mousedown', preventMouseDown);
+ });
+
+ uiGridCtrl.grid.api.edit.on.afterCellEdit($scope, function () {
+ $elm.on('mousedown', preventMouseDown);
+ });
+
+ uiGridCtrl.grid.api.edit.on.cancelCellEdit($scope, function () {
+ $elm.on('mousedown', preventMouseDown);
+ });
+ }
+
+ // In case we created a new row, and we are the new created row by ngRepeat
+ // then this cell content might have been selected previously
+ refreshCellFocus();
+
+ function preventMouseDown(evt) {
+ // Prevents the foucus event from firing if the click event is already going to fire.
+ // If both events fire it will cause bouncing behavior.
+ evt.preventDefault();
+ }
+
+ // You can only focus on elements with a tabindex value
+ $elm.on('focus', function (evt) {
+ uiGridCtrl.cellNav.broadcastCellNav(new GridRowColumn($scope.row, $scope.col), false, evt);
+ evt.stopPropagation();
+ $scope.$apply();
+ });
+
+ // This event is fired for all cells. If the cell matches, then focus is set
+ $scope.$on(uiGridCellNavConstants.CELL_NAV_EVENT, refreshCellFocus);
+
+ // Refresh cell focus when a new row id added to the grid
+ var dataChangeDereg = uiGridCtrl.grid.registerDataChangeCallback(function (grid) {
+ // Clear the focus if it's set to avoid the wrong cell getting focused during
+ // a short period of time (from now until $timeout function executed)
+ clearFocus();
+
+ $scope.$applyAsync(refreshCellFocus);
+ }, [uiGridConstants.dataChange.ROW]);
+
+ function refreshCellFocus() {
+ var isFocused = grid.cellNav.focusedCells.some(function (focusedRowCol, index) {
+ return (focusedRowCol.row === $scope.row && focusedRowCol.col === $scope.col);
+ });
+ if (isFocused) {
+ setFocused();
+ } else {
+ clearFocus();
+ }
+ }
+
+ function setFocused() {
+ if (!$scope.focused) {
+ var div = $elm.find('div');
+ div.addClass('ui-grid-cell-focus');
+ $elm.attr('aria-selected', true);
+ uiGridCellnavCtrl.setAriaActivedescendant($elm.attr('id'));
+ $scope.focused = true;
+ }
+ }
+
+ function clearFocus() {
+ if ($scope.focused) {
+ var div = $elm.find('div');
+ div.removeClass('ui-grid-cell-focus');
+ $elm.attr('aria-selected', false);
+ uiGridCellnavCtrl.removeAriaActivedescendant($elm.attr('id'));
+ $scope.focused = false;
+ }
+ }
+
+ $scope.$on('$destroy', function () {
+ dataChangeDereg();
+
+ // .off withouth paramaters removes all handlers
+ $elm.find('div').off();
+ $elm.off();
+ });
+ }
+ };
+ }]);
+})();
+
+(function () {
+ 'use strict';
+
+ /**
+ * @ngdoc object
+ * @name ui.grid.service:uiGridConstants
+ * @description Constants for use across many grid features
+ *
+ */
+
+
+ angular.module('ui.grid').constant('uiGridConstants', {
+ LOG_DEBUG_MESSAGES: true,
+ LOG_WARN_MESSAGES: true,
+ LOG_ERROR_MESSAGES: true,
+ CUSTOM_FILTERS: /CUSTOM_FILTERS/g,
+ COL_FIELD: /COL_FIELD/g,
+ MODEL_COL_FIELD: /MODEL_COL_FIELD/g,
+ TOOLTIP: /title=\"TOOLTIP\"/g,
+ DISPLAY_CELL_TEMPLATE: /DISPLAY_CELL_TEMPLATE/g,
+ TEMPLATE_REGEXP: /<.+>/,
+ FUNC_REGEXP: /(\([^)]*\))?$/,
+ DOT_REGEXP: /\./g,
+ APOS_REGEXP: /'/g,
+ BRACKET_REGEXP: /^(.*)((?:\s*\[\s*\d+\s*\]\s*)|(?:\s*\[\s*"(?:[^"\\]|\\.)*"\s*\]\s*)|(?:\s*\[\s*'(?:[^'\\]|\\.)*'\s*\]\s*))(.*)$/,
+ COL_CLASS_PREFIX: 'ui-grid-col',
+ ENTITY_BINDING: '$$this',
+ events: {
+ GRID_SCROLL: 'uiGridScroll',
+ COLUMN_MENU_SHOWN: 'uiGridColMenuShown',
+ ITEM_DRAGGING: 'uiGridItemDragStart', // For any item being dragged
+ COLUMN_HEADER_CLICK: 'uiGridColumnHeaderClick'
+ },
+ // copied from http://www.lsauer.com/2011/08/javascript-keymap-keycodes-in-json.html
+ keymap: {
+ TAB: 9,
+ STRG: 17,
+ CAPSLOCK: 20,
+ CTRL: 17,
+ CTRLRIGHT: 18,
+ CTRLR: 18,
+ SHIFT: 16,
+ RETURN: 13,
+ ENTER: 13,
+ BACKSPACE: 8,
+ BCKSP: 8,
+ ALT: 18,
+ ALTR: 17,
+ ALTRIGHT: 17,
+ SPACE: 32,
+ WIN: 91,
+ MAC: 91,
+ FN: null,
+ PG_UP: 33,
+ PG_DOWN: 34,
+ UP: 38,
+ DOWN: 40,
+ LEFT: 37,
+ RIGHT: 39,
+ ESC: 27,
+ DEL: 46,
+ F1: 112,
+ F2: 113,
+ F3: 114,
+ F4: 115,
+ F5: 116,
+ F6: 117,
+ F7: 118,
+ F8: 119,
+ F9: 120,
+ F10: 121,
+ F11: 122,
+ F12: 123
+ },
+ /**
+ * @ngdoc object
+ * @name ASC
+ * @propertyOf ui.grid.service:uiGridConstants
+ * @description Used in {@link ui.grid.class:GridOptions.columnDef#properties_sort columnDef.sort} and
+ * {@link ui.grid.class:GridOptions.columnDef#properties_sortDirectionCycle columnDef.sortDirectionCycle}
+ * to configure the sorting direction of the column
+ */
+ ASC: 'asc',
+ /**
+ * @ngdoc object
+ * @name DESC
+ * @propertyOf ui.grid.service:uiGridConstants
+ * @description Used in {@link ui.grid.class:GridOptions.columnDef#properties_sort columnDef.sort} and
+ * {@link ui.grid.class:GridOptions.columnDef#properties_sortDirectionCycle columnDef.sortDirectionCycle}
+ * to configure the sorting direction of the column
+ */
+ DESC: 'desc',
+
+
+ /**
+ * @ngdoc object
+ * @name filter
+ * @propertyOf ui.grid.service:uiGridConstants
+ * @description Used in {@link ui.grid.class:GridOptions.columnDef#properties_filter columnDef.filter}
+ * to configure filtering on the column
+ *
+ * `SELECT` and `INPUT` are used with the `type` property of the filter, the rest are used to specify
+ * one of the built-in conditions.
+ *
+ * Available `condition` options are:
+ * - `uiGridConstants.filter.STARTS_WITH`
+ * - `uiGridConstants.filter.ENDS_WITH`
+ * - `uiGridConstants.filter.CONTAINS`
+ * - `uiGridConstants.filter.GREATER_THAN`
+ * - `uiGridConstants.filter.GREATER_THAN_OR_EQUAL`
+ * - `uiGridConstants.filter.LESS_THAN`
+ * - `uiGridConstants.filter.LESS_THAN_OR_EQUAL`
+ * - `uiGridConstants.filter.NOT_EQUAL`
+ *
+ *
+ * Available `type` options are:
+ * - `uiGridConstants.filter.SELECT` - use a dropdown box for the cell header filter field
+ * - `uiGridConstants.filter.INPUT` - use a text box for the cell header filter field
+ */
+ filter: {
+ STARTS_WITH: 2,
+ ENDS_WITH: 4,
+ EXACT: 8,
+ CONTAINS: 16,
+ GREATER_THAN: 32,
+ GREATER_THAN_OR_EQUAL: 64,
+ LESS_THAN: 128,
+ LESS_THAN_OR_EQUAL: 256,
+ NOT_EQUAL: 512,
+ SELECT: 'select',
+ INPUT: 'input'
+ },
+
+ /**
+ * @ngdoc object
+ * @name aggregationTypes
+ * @propertyOf ui.grid.service:uiGridConstants
+ * @description Used in {@link ui.grid.class:GridOptions.columnDef#properties_aggregationType columnDef.aggregationType}
+ * to specify the type of built-in aggregation the column should use.
+ *
+ * Available options are:
+ * - `uiGridConstants.aggregationTypes.sum` - add the values in this column to produce the aggregated value
+ * - `uiGridConstants.aggregationTypes.count` - count the number of rows to produce the aggregated value
+ * - `uiGridConstants.aggregationTypes.avg` - average the values in this column to produce the aggregated value
+ * - `uiGridConstants.aggregationTypes.min` - use the minimum value in this column as the aggregated value
+ * - `uiGridConstants.aggregationTypes.max` - use the maximum value in this column as the aggregated value
+ */
+ aggregationTypes: {
+ sum: 2,
+ count: 4,
+ avg: 8,
+ min: 16,
+ max: 32
+ },
+
+ /**
+ * @ngdoc array
+ * @name CURRENCY_SYMBOLS
+ * @propertyOf ui.grid.service:uiGridConstants
+ * @description A list of all presently circulating currency symbols that was copied from
+ * https://en.wikipedia.org/wiki/Currency_symbol#List_of_presently-circulating_currency_symbols
+ *
+ * Can be used on {@link ui.grid.class:rowSorter} to create a number string regex that ignores currency symbols.
+ */
+ CURRENCY_SYMBOLS: ['¤', '؋', 'Ar', 'Ƀ', '฿', 'B/.', 'Br', 'Bs.', 'Bs.F.', 'GH₵', '¢', 'c', 'Ch.', '₡', 'C$', 'D', 'ден',
+ 'دج', '.د.ب', 'د.ع', 'JD', 'د.ك', 'ل.د', 'дин', 'د.ت', 'د.م.', 'د.إ', 'Db', '$', '₫', 'Esc', '€', 'ƒ', 'Ft', 'FBu',
+ 'FCFA', 'CFA', 'Fr', 'FRw', 'G', 'gr', '₲', 'h', '₴', '₭', 'Kč', 'kr', 'kn', 'MK', 'ZK', 'Kz', 'K', 'L', 'Le', 'лв',
+ 'E', 'lp', 'M', 'KM', 'MT', '₥', 'Nfk', '₦', 'Nu.', 'UM', 'T$', 'MOP$', '₱', 'Pt.', '£', 'ج.م.', 'LL', 'LS', 'P', 'Q',
+ 'q', 'R', 'R$', 'ر.ع.', 'ر.ق', 'ر.س', '៛', 'RM', 'p', 'Rf.', '₹', '₨', 'SRe', 'Rp', '₪', 'Ksh', 'Sh.So.', 'USh', 'S/',
+ 'SDR', 'сом', '৳ ', 'WS$', '₮', 'VT', '₩', '¥', 'zł'],
+
+ /**
+ * @ngdoc object
+ * @name scrollDirection
+ * @propertyOf ui.grid.service:uiGridConstants
+ * @description Set on {@link ui.grid.class:Grid#properties_scrollDirection Grid.scrollDirection},
+ * to indicate the direction the grid is currently scrolling in
+ *
+ * Available options are:
+ * - `uiGridConstants.scrollDirection.UP` - set when the grid is scrolling up
+ * - `uiGridConstants.scrollDirection.DOWN` - set when the grid is scrolling down
+ * - `uiGridConstants.scrollDirection.LEFT` - set when the grid is scrolling left
+ * - `uiGridConstants.scrollDirection.RIGHT` - set when the grid is scrolling right
+ * - `uiGridConstants.scrollDirection.NONE` - set when the grid is not scrolling, this is the default
+ */
+ scrollDirection: {
+ UP: 'up',
+ DOWN: 'down',
+ LEFT: 'left',
+ RIGHT: 'right',
+ NONE: 'none'
+
+ },
+
+ /**
+ * @ngdoc object
+ * @name dataChange
+ * @propertyOf ui.grid.service:uiGridConstants
+ * @description Used with {@link ui.grid.api:PublicApi#methods_notifyDataChange PublicApi.notifyDataChange},
+ * {@link ui.grid.class:Grid#methods_callDataChangeCallbacks Grid.callDataChangeCallbacks},
+ * and {@link ui.grid.class:Grid#methods_registerDataChangeCallback Grid.registerDataChangeCallback}
+ * to specify the type of the event(s).
+ *
+ * Available options are:
+ * - `uiGridConstants.dataChange.ALL` - listeners fired on any of these events, fires listeners on all events.
+ * - `uiGridConstants.dataChange.EDIT` - fired when the data in a cell is edited
+ * - `uiGridConstants.dataChange.ROW` - fired when a row is added or removed
+ * - `uiGridConstants.dataChange.COLUMN` - fired when the column definitions are modified
+ * - `uiGridConstants.dataChange.OPTIONS` - fired when the grid options are modified
+ */
+ dataChange: {
+ ALL: 'all',
+ EDIT: 'edit',
+ ROW: 'row',
+ COLUMN: 'column',
+ OPTIONS: 'options'
+ },
+
+ /**
+ * @ngdoc object
+ * @name scrollbars
+ * @propertyOf ui.grid.service:uiGridConstants
+ * @description Used with {@link ui.grid.class:GridOptions#properties_enableHorizontalScrollbar GridOptions.enableHorizontalScrollbar}
+ * and {@link ui.grid.class:GridOptions#properties_enableVerticalScrollbar GridOptions.enableVerticalScrollbar}
+ * to specify the scrollbar policy for that direction.
+ *
+ * Available options are:
+ * - `uiGridConstants.scrollbars.NEVER` - never show scrollbars in this direction
+ * - `uiGridConstants.scrollbars.ALWAYS` - always show scrollbars in this direction
+ * - `uiGridConstants.scrollbars.WHEN_NEEDED` - shows scrollbars in this direction when needed
+ */
+
+ scrollbars: {
+ NEVER: 0,
+ ALWAYS: 1,
+ WHEN_NEEDED: 2
+ }
+ });
+
+})();
+
+angular.module('ui.grid').directive('uiGridCell', ['$compile', '$parse', 'gridUtil', 'uiGridConstants', function ($compile, $parse, gridUtil, uiGridConstants) {
+ return {
+ priority: 0,
+ scope: false,
+ require: '?^uiGrid',
+ compile: function() {
+ return {
+ pre: function($scope, $elm, $attrs, uiGridCtrl) {
+ function compileTemplate() {
+ var compiledElementFn = $scope.col.compiledElementFn;
+
+ compiledElementFn($scope, function(clonedElement, scope) {
+ $elm.append(clonedElement);
+ });
+ }
+
+ // If the grid controller is present, use it to get the compiled cell template function
+ if (uiGridCtrl && $scope.col.compiledElementFn) {
+ compileTemplate();
+ }
+
+ // No controller, compile the element manually (for unit tests)
+ else {
+ if ( uiGridCtrl && !$scope.col.compiledElementFn ) {
+ $scope.col.getCompiledElementFn()
+ .then(function (compiledElementFn) {
+ compiledElementFn($scope, function(clonedElement, scope) {
+ $elm.append(clonedElement);
+ });
+ }).catch(angular.noop);
+ }
+ else {
+ var html = $scope.col.cellTemplate
+ .replace(uiGridConstants.MODEL_COL_FIELD, 'row.entity.' + gridUtil.preEval($scope.col.field))
+ .replace(uiGridConstants.COL_FIELD, 'grid.getCellValue(row, col)');
+
+ var cellElement = $compile(html)($scope);
+ $elm.append(cellElement);
+ }
+ }
+ },
+ post: function($scope, $elm) {
+ var initColClass = $scope.col.getColClass(false),
+ classAdded;
+
+ $elm.addClass(initColClass);
+
+ function updateClass( grid ) {
+ var contents = $elm;
+
+ if ( classAdded ) {
+ contents.removeClass( classAdded );
+ classAdded = null;
+ }
+
+ if (angular.isFunction($scope.col.cellClass)) {
+ classAdded = $scope.col.cellClass($scope.grid, $scope.row, $scope.col, $scope.rowRenderIndex, $scope.colRenderIndex);
+ }
+ else {
+ classAdded = $scope.col.cellClass;
+ }
+ contents.addClass(classAdded);
+ }
+
+ if ($scope.col.cellClass) {
+ updateClass();
+ }
+
+ // Register a data change watch that would get triggered whenever someone edits a cell or modifies column defs
+ var dataChangeDereg = $scope.grid.registerDataChangeCallback( updateClass, [uiGridConstants.dataChange.COLUMN, uiGridConstants.dataChange.EDIT]);
+
+ // watch the col and row to see if they change - which would indicate that we've scrolled or sorted or otherwise
+ // changed the row/col that this cell relates to, and we need to re-evaluate cell classes and maybe other things
+ function cellChangeFunction( n, o ) {
+ if ( n !== o ) {
+ if ( classAdded || $scope.col.cellClass ) {
+ updateClass();
+ }
+
+ // See if the column's internal class has changed
+ var newColClass = $scope.col.getColClass(false);
+
+ if (newColClass !== initColClass) {
+ $elm.removeClass(initColClass);
+ $elm.addClass(newColClass);
+ initColClass = newColClass;
+ }
+ }
+ }
+
+ // TODO(c0bra): Turn this into a deep array watch
+ var rowWatchDereg = $scope.$watch( 'row', cellChangeFunction );
+
+ function deregisterFunction() {
+ dataChangeDereg();
+ rowWatchDereg();
+ }
+
+ $scope.$on('$destroy', deregisterFunction);
+ $elm.on('$destroy', deregisterFunction);
+ }
+ };
+ }
+ };
+}]);
+
+(function() {
+
+angular.module('ui.grid')
+.service('uiGridColumnMenuService', [ 'i18nService', 'uiGridConstants', 'gridUtil',
+function ( i18nService, uiGridConstants, gridUtil ) {
+/**
+ * @ngdoc service
+ * @name ui.grid.service:uiGridColumnMenuService
+ *
+ * @description Services for working with column menus, factored out
+ * to make the code easier to understand
+ */
+
+ var service = {
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.service:uiGridColumnMenuService
+ * @name initialize
+ * @description Sets defaults, puts a reference to the $scope on
+ * the uiGridController
+ * @param {$scope} $scope the $scope from the uiGridColumnMenu
+ * @param {controller} uiGridCtrl the uiGridController for the grid
+ * we're on
+ *
+ */
+ initialize: function( $scope, uiGridCtrl ) {
+ $scope.grid = uiGridCtrl.grid;
+
+ // Store a reference to this link/controller in the main uiGrid controller
+ // to allow showMenu later
+ uiGridCtrl.columnMenuScope = $scope;
+
+ // Save whether we're shown or not so the columns can check
+ $scope.menuShown = false;
+ },
+
+
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.service:uiGridColumnMenuService
+ * @name setColMenuItemWatch
+ * @description Setup a watch on $scope.col.menuItems, and update
+ * menuItems based on this. $scope.col needs to be set by the column
+ * before calling the menu.
+ * @param {$scope} $scope the $scope from the uiGridColumnMenu
+ */
+ setColMenuItemWatch: function ( $scope ) {
+ var deregFunction = $scope.$watch('col.menuItems', function (n) {
+ if (typeof(n) !== 'undefined' && n && angular.isArray(n)) {
+ n.forEach(function (item) {
+ if (typeof(item.context) === 'undefined' || !item.context) {
+ item.context = {};
+ }
+ item.context.col = $scope.col;
+ });
+
+ $scope.menuItems = $scope.defaultMenuItems.concat(n);
+ }
+ else {
+ $scope.menuItems = $scope.defaultMenuItems;
+ }
+ });
+
+ $scope.$on( '$destroy', deregFunction );
+ },
+
+
+ /**
+ * @ngdoc boolean
+ * @name enableSorting
+ * @propertyOf ui.grid.class:GridOptions.columnDef
+ * @description (optional) True by default. When enabled, this setting adds sort
+ * widgets to the column header, allowing sorting of the data in the individual column.
+ */
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.service:uiGridColumnMenuService
+ * @name sortable
+ * @description determines whether this column is sortable
+ * @param {$scope} $scope the $scope from the uiGridColumnMenu
+ *
+ */
+ sortable: function( $scope ) {
+ return Boolean( $scope.grid.options.enableSorting && typeof($scope.col) !== 'undefined' && $scope.col && $scope.col.enableSorting);
+ },
+
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.service:uiGridColumnMenuService
+ * @name isActiveSort
+ * @description determines whether the requested sort direction is current active, to
+ * allow highlighting in the menu
+ * @param {$scope} $scope the $scope from the uiGridColumnMenu
+ * @param {string} direction the direction that we'd have selected for us to be active
+ *
+ */
+ isActiveSort: function( $scope, direction ) {
+ return Boolean(typeof($scope.col) !== 'undefined' && typeof($scope.col.sort) !== 'undefined' &&
+ typeof($scope.col.sort.direction) !== 'undefined' && $scope.col.sort.direction === direction);
+ },
+
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.service:uiGridColumnMenuService
+ * @name suppressRemoveSort
+ * @description determines whether we should suppress the removeSort option
+ * @param {$scope} $scope the $scope from the uiGridColumnMenu
+ *
+ */
+ suppressRemoveSort: function( $scope ) {
+ return Boolean($scope.col && $scope.col.suppressRemoveSort);
+ },
+
+
+ /**
+ * @ngdoc boolean
+ * @name enableHiding
+ * @propertyOf ui.grid.class:GridOptions.columnDef
+ * @description (optional) True by default. When set to false, this setting prevents a user from hiding the column
+ * using the column menu or the grid menu.
+ */
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.service:uiGridColumnMenuService
+ * @name hideable
+ * @description determines whether a column can be hidden, by checking the enableHiding columnDef option
+ * @param {$scope} $scope the $scope from the uiGridColumnMenu
+ *
+ */
+ hideable: function( $scope ) {
+ return !(typeof($scope.col) !== 'undefined' && $scope.col && $scope.col.colDef && $scope.col.colDef.enableHiding === false );
+ },
+
+
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.service:uiGridColumnMenuService
+ * @name getDefaultMenuItems
+ * @description returns the default menu items for a column menu
+ * @param {$scope} $scope the $scope from the uiGridColumnMenu
+ *
+ */
+ getDefaultMenuItems: function( $scope ) {
+ return [
+ {
+ title: function() {return i18nService.getSafeText('sort.ascending');},
+ icon: 'ui-grid-icon-sort-alt-up',
+ action: function($event) {
+ $event.stopPropagation();
+ $scope.sortColumn($event, uiGridConstants.ASC);
+ },
+ shown: function () {
+ return service.sortable( $scope );
+ },
+ active: function() {
+ return service.isActiveSort( $scope, uiGridConstants.ASC);
+ }
+ },
+ {
+ title: function() {return i18nService.getSafeText('sort.descending');},
+ icon: 'ui-grid-icon-sort-alt-down',
+ action: function($event) {
+ $event.stopPropagation();
+ $scope.sortColumn($event, uiGridConstants.DESC);
+ },
+ shown: function() {
+ return service.sortable( $scope );
+ },
+ active: function() {
+ return service.isActiveSort( $scope, uiGridConstants.DESC);
+ }
+ },
+ {
+ title: function() {return i18nService.getSafeText('sort.remove');},
+ icon: 'ui-grid-icon-cancel',
+ action: function ($event) {
+ $event.stopPropagation();
+ $scope.unsortColumn();
+ },
+ shown: function() {
+ return service.sortable( $scope ) &&
+ typeof($scope.col) !== 'undefined' && (typeof($scope.col.sort) !== 'undefined' &&
+ typeof($scope.col.sort.direction) !== 'undefined') && $scope.col.sort.direction !== null &&
+ !service.suppressRemoveSort( $scope );
+ }
+ },
+ {
+ title: function() {return i18nService.getSafeText('column.hide');},
+ icon: 'ui-grid-icon-cancel',
+ shown: function() {
+ return service.hideable( $scope );
+ },
+ action: function ($event) {
+ $event.stopPropagation();
+ $scope.hideColumn();
+ }
+ }
+ ];
+ },
+
+
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.service:uiGridColumnMenuService
+ * @name getColumnElementPosition
+ * @description gets the position information needed to place the column
+ * menu below the column header
+ * @param {$scope} $scope the $scope from the uiGridColumnMenu
+ * @param {GridColumn} column the column we want to position below
+ * @param {element} $columnElement the column element we want to position below
+ * @returns {hash} containing left, top, offset, height, width
+ *
+ */
+ getColumnElementPosition: function( $scope, column, $columnElement ) {
+ var positionData = {};
+
+ positionData.left = $columnElement[0].offsetLeft;
+ positionData.top = $columnElement[0].offsetTop;
+ positionData.parentLeft = $columnElement[0].offsetParent.offsetLeft;
+
+ // Get the grid scrollLeft
+ positionData.offset = 0;
+ if (column.grid.options.offsetLeft) {
+ positionData.offset = column.grid.options.offsetLeft;
+ }
+
+ positionData.height = gridUtil.elementHeight($columnElement, true);
+ positionData.width = gridUtil.elementWidth($columnElement, true);
+
+ return positionData;
+ },
+
+
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.service:uiGridColumnMenuService
+ * @name repositionMenu
+ * @description Reposition the menu below the new column. If the menu has no child nodes
+ * (i.e. it's not currently visible) then we guess it's width at 100, we'll be called again
+ * later to fix it
+ * @param {$scope} $scope the $scope from the uiGridColumnMenu
+ * @param {GridColumn} column the column we want to position below
+ * @param {hash} positionData a hash containing left, top, offset, height, width
+ * @param {element} $elm the column menu element that we want to reposition
+ * @param {element} $columnElement the column element that we want to reposition underneath
+ *
+ */
+ repositionMenu: function( $scope, column, positionData, $elm, $columnElement ) {
+ var menu = $elm[0].querySelectorAll('.ui-grid-menu');
+
+ // It's possible that the render container of the column we're attaching to is
+ // offset from the grid (i.e. pinned containers), we need to get the difference in the offsetLeft
+ // between the render container and the grid
+ var renderContainerElm = gridUtil.closestElm($columnElement, '.ui-grid-render-container'),
+ renderContainerOffset = renderContainerElm.getBoundingClientRect().left - $scope.grid.element[0].getBoundingClientRect().left,
+ containerScrollLeft = renderContainerElm.querySelectorAll('.ui-grid-viewport')[0].scrollLeft;
+
+ // repositionMenu is now always called after it's visible in the DOM,
+ // allowing us to simply get the width every time the menu is opened
+ var myWidth = gridUtil.elementWidth(menu, true),
+ paddingRight = column.lastMenuPaddingRight ? column.lastMenuPaddingRight : ( $scope.lastMenuPaddingRight ? $scope.lastMenuPaddingRight : 10);
+
+ if ( menu.length !== 0 ) {
+ var mid = menu[0].querySelectorAll('.ui-grid-menu-mid');
+
+ if ( mid.length !== 0 ) {
+ // TODO(c0bra): use padding-left/padding-right based on document direction (ltr/rtl), place menu on proper side
+ // Get the column menu right padding
+ paddingRight = parseInt(gridUtil.getStyles(angular.element(menu)[0])['paddingRight'], 10);
+ $scope.lastMenuPaddingRight = paddingRight;
+ column.lastMenuPaddingRight = paddingRight;
+ }
+ }
+
+ var left = positionData.left + renderContainerOffset - containerScrollLeft + positionData.parentLeft + positionData.width + paddingRight;
+
+ if (left < positionData.offset + myWidth) {
+ left = Math.max(positionData.left - containerScrollLeft + positionData.parentLeft - paddingRight + myWidth, positionData.offset + myWidth);
+ }
+
+ $elm.css('left', left + 'px');
+ $elm.css('top', (positionData.top + positionData.height) + 'px');
+ }
+ };
+ return service;
+}])
+
+
+.directive('uiGridColumnMenu', ['$timeout', 'gridUtil', 'uiGridConstants', 'uiGridColumnMenuService', '$document',
+function ($timeout, gridUtil, uiGridConstants, uiGridColumnMenuService, $document) {
+/**
+ * @ngdoc directive
+ * @name ui.grid.directive:uiGridColumnMenu
+ * @description Provides the column menu framework, leverages uiGridMenu underneath
+ *
+ */
+
+ return {
+ priority: 0,
+ scope: true,
+ require: '^uiGrid',
+ templateUrl: 'ui-grid/uiGridColumnMenu',
+ replace: true,
+ link: function ($scope, $elm, $attrs, uiGridCtrl) {
+ uiGridColumnMenuService.initialize( $scope, uiGridCtrl );
+
+ $scope.defaultMenuItems = uiGridColumnMenuService.getDefaultMenuItems( $scope );
+
+ // Set the menu items for use with the column menu. The user can later add additional items via the watch
+ $scope.menuItems = $scope.defaultMenuItems;
+ uiGridColumnMenuService.setColMenuItemWatch( $scope );
+
+
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.directive:uiGridColumnMenu
+ * @name showMenu
+ * @description Shows the column menu. If the menu is already displayed it
+ * calls the menu to ask it to hide (it will animate), then it repositions the menu
+ * 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's size.
+ * @param {GridColumn} column the column we want to position below
+ * @param {element} $columnElement the column element we want to position below
+ */
+ $scope.showMenu = function(column, $columnElement, event) {
+ // Swap to this column
+ $scope.col = column;
+
+ // Get the position information for the column element
+ var colElementPosition = uiGridColumnMenuService.getColumnElementPosition( $scope, column, $columnElement );
+
+ if ($scope.menuShown) {
+ // we want to hide, then reposition, then show, but we want to wait for animations
+ // we set a variable, and then rely on the menu-hidden event to call the reposition and show
+ $scope.colElement = $columnElement;
+ $scope.colElementPosition = colElementPosition;
+ $scope.hideThenShow = true;
+
+ $scope.$broadcast('hide-menu', { originalEvent: event });
+ } else {
+ $scope.menuShown = true;
+
+ $scope.colElement = $columnElement;
+ $scope.colElementPosition = colElementPosition;
+ $scope.$broadcast('show-menu', { originalEvent: event });
+ }
+ };
+
+
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.directive:uiGridColumnMenu
+ * @name hideMenu
+ * @description Hides the column menu.
+ * @param {boolean} broadcastTrigger true if we were triggered by a broadcast
+ * from the menu itself - in which case don't broadcast again as we'll get
+ * an infinite loop
+ */
+ $scope.hideMenu = function( broadcastTrigger ) {
+ $scope.menuShown = false;
+ if ( !broadcastTrigger ) {
+ $scope.$broadcast('hide-menu');
+ }
+ };
+
+
+ $scope.$on('menu-hidden', function() {
+ var menuItems = angular.element($elm[0].querySelector('.ui-grid-menu-items'))[0];
+
+ $elm[0].removeAttribute('style');
+
+ if ( $scope.hideThenShow ) {
+ delete $scope.hideThenShow;
+
+ $scope.$broadcast('show-menu');
+
+ $scope.menuShown = true;
+ } else {
+ $scope.hideMenu( true );
+
+ if ($scope.col && $scope.col.visible) {
+ // Focus on the menu button
+ gridUtil.focus.bySelector($document, '.ui-grid-header-cell.' + $scope.col.getColClass()+ ' .ui-grid-column-menu-button', $scope.col.grid, false)
+ .catch(angular.noop);
+ }
+ }
+
+ if (menuItems) {
+ menuItems.onkeydown = null;
+ angular.forEach(menuItems.children, function removeHandlers(item) {
+ item.onkeydown = null;
+ });
+ }
+ });
+
+ $scope.$on('menu-shown', function() {
+ $timeout(function() {
+ uiGridColumnMenuService.repositionMenu( $scope, $scope.col, $scope.colElementPosition, $elm, $scope.colElement );
+
+ var hasVisibleMenuItems = $scope.menuItems.some(function (menuItem) {
+ return menuItem.shown();
+ });
+
+ // automatically set the focus to the first button element in the now open menu.
+ if (hasVisibleMenuItems) {
+ gridUtil.focus.bySelector($document, '.ui-grid-menu-items .ui-grid-menu-item:not(.ng-hide)', true)
+ .catch(angular.noop);
+ }
+
+ delete $scope.colElementPosition;
+ delete $scope.columnElement;
+ addKeydownHandlersToMenu();
+ });
+ });
+
+
+ /* Column methods */
+ $scope.sortColumn = function (event, dir) {
+ event.stopPropagation();
+
+ $scope.grid.sortColumn($scope.col, dir, true)
+ .then(function () {
+ $scope.grid.refresh();
+ $scope.hideMenu();
+ }).catch(angular.noop);
+ };
+
+ $scope.unsortColumn = function () {
+ $scope.col.unsort();
+
+ $scope.grid.refresh();
+ $scope.hideMenu();
+ };
+
+ function addKeydownHandlersToMenu() {
+ var menu = angular.element($elm[0].querySelector('.ui-grid-menu-items'))[0],
+ menuItems,
+ visibleMenuItems = [];
+
+ if (menu) {
+ menu.onkeydown = function closeMenu(event) {
+ if (event.keyCode === uiGridConstants.keymap.ESC) {
+ event.preventDefault();
+ $scope.hideMenu();
+ }
+ };
+
+ menuItems = menu.querySelectorAll('.ui-grid-menu-item:not(.ng-hide)');
+ angular.forEach(menuItems, function filterVisibleItems(item) {
+ if (item.offsetParent !== null) {
+ this.push(item);
+ }
+ }, visibleMenuItems);
+
+ if (visibleMenuItems.length) {
+ if (visibleMenuItems.length === 1) {
+ visibleMenuItems[0].onkeydown = function singleItemHandler(event) {
+ circularFocusHandler(event, true);
+ };
+ } else {
+ visibleMenuItems[0].onkeydown = function firstItemHandler(event) {
+ circularFocusHandler(event, false, event.shiftKey, visibleMenuItems.length - 1);
+ };
+ visibleMenuItems[visibleMenuItems.length - 1].onkeydown = function lastItemHandler(event) {
+ circularFocusHandler(event, false, !event.shiftKey, 0);
+ };
+ }
+ }
+ }
+
+ function circularFocusHandler(event, isSingleItem, shiftKeyStatus, index) {
+ if (event.keyCode === uiGridConstants.keymap.TAB) {
+ if (isSingleItem) {
+ event.preventDefault();
+ } else if (shiftKeyStatus) {
+ event.preventDefault();
+ visibleMenuItems[index].focus();
+ }
+ }
+ }
+ }
+
+ // Since we are hiding this column the default hide action will fail so we need to focus somewhere else.
+ var setFocusOnHideColumn = function() {
+ $timeout(function() {
+ // Get the UID of the first
+ var focusToGridMenu = function() {
+ return gridUtil.focus.byId('grid-menu', $scope.grid);
+ };
+
+ var thisIndex;
+ $scope.grid.columns.some(function(element, index) {
+ if (angular.equals(element, $scope.col)) {
+ thisIndex = index;
+ return true;
+ }
+ });
+
+ var previousVisibleCol;
+ // Try and find the next lower or nearest column to focus on
+ $scope.grid.columns.some(function(element, index) {
+ if (!element.visible) {
+ return false;
+ } // This columns index is below the current column index
+ else if ( index < thisIndex) {
+ previousVisibleCol = element;
+ } // This elements index is above this column index and we haven't found one that is lower
+ else if ( index > thisIndex && !previousVisibleCol) {
+ // This is the next best thing
+ previousVisibleCol = element;
+ // We've found one so use it.
+ return true;
+ } // We've reached an element with an index above this column and the previousVisibleCol variable has been set
+ else if (index > thisIndex && previousVisibleCol) {
+ // We are done.
+ return true;
+ }
+ });
+ // If found then focus on it
+ if (previousVisibleCol) {
+ var colClass = previousVisibleCol.getColClass();
+ gridUtil.focus.bySelector($document, '.ui-grid-header-cell.' + colClass+ ' .ui-grid-header-cell-primary-focus', true).then(angular.noop, function(reason) {
+ if (reason !== 'canceled') { // If this is canceled then don't perform the action
+ // The fallback action is to focus on the grid menu
+ return focusToGridMenu();
+ }
+ }).catch(angular.noop);
+ } else {
+ // Fallback action to focus on the grid menu
+ focusToGridMenu();
+ }
+ });
+ };
+
+ $scope.hideColumn = function () {
+ $scope.col.colDef.visible = false;
+ $scope.col.visible = false;
+
+ $scope.grid.queueGridRefresh();
+ $scope.hideMenu();
+ $scope.grid.api.core.notifyDataChange( uiGridConstants.dataChange.COLUMN );
+ $scope.grid.api.core.raise.columnVisibilityChanged( $scope.col );
+
+ // We are hiding so the default action of focusing on the button that opened this menu will fail.
+ setFocusOnHideColumn();
+ };
+ },
+
+ controller: ['$scope', function ($scope) {
+ var self = this;
+
+ $scope.$watch('menuItems', function (n) {
+ self.menuItems = n;
+ });
+ }]
+ };
+}]);
+})();
+
+(function() {
+ 'use strict';
+
+ angular.module('ui.grid').directive('uiGridFilter', ['$compile', '$templateCache', 'i18nService', 'gridUtil', function ($compile, $templateCache, i18nService, gridUtil) {
+
+ return {
+ compile: function() {
+ return {
+ pre: function ($scope, $elm) {
+ $scope.col.updateFilters = function( filterable ) {
+ $elm.children().remove();
+ if ( filterable ) {
+ var template = $scope.col.filterHeaderTemplate;
+ if (template === undefined && $scope.col.providedFilterHeaderTemplate !== '') {
+ if ($scope.col.filterHeaderTemplatePromise) {
+ $scope.col.filterHeaderTemplatePromise.then(function () {
+ template = $scope.col.filterHeaderTemplate;
+ $elm.append($compile(template)($scope));
+ });
+ }
+ }
+ else {
+ $elm.append($compile(template)($scope));
+ }
+ }
+ };
+
+ $scope.$on( '$destroy', function() {
+ delete $scope.col.filterable;
+ delete $scope.col.updateFilters;
+ });
+ },
+ post: function ($scope, $elm) {
+ $scope.aria = i18nService.getSafeText('headerCell.aria');
+ $scope.removeFilter = function(colFilter, index) {
+ colFilter.term = null;
+ // Set the focus to the filter input after the action disables the button
+ gridUtil.focus.bySelector($elm, '.ui-grid-filter-input-' + index);
+ };
+ }
+ };
+ }
+ };
+ }]);
+})();
+
+(function () {
+ 'use strict';
+
+ angular.module('ui.grid').directive('uiGridFooterCell', ['$timeout', 'gridUtil', 'uiGridConstants', '$compile',
+ function ($timeout, gridUtil, uiGridConstants, $compile) {
+ return {
+ priority: 0,
+ scope: {
+ col: '=',
+ row: '=',
+ renderIndex: '='
+ },
+ replace: true,
+ require: '^uiGrid',
+ compile: function compile() {
+ return {
+ pre: function ($scope, $elm) {
+ var template = $scope.col.footerCellTemplate;
+
+ if (template === undefined && $scope.col.providedFooterCellTemplate !== '') {
+ if ($scope.col.footerCellTemplatePromise) {
+ $scope.col.footerCellTemplatePromise.then(function () {
+ template = $scope.col.footerCellTemplate;
+ $elm.append($compile(template)($scope));
+ });
+ }
+ }
+ else {
+ $elm.append($compile(template)($scope));
+ }
+ },
+ post: function ($scope, $elm, $attrs, uiGridCtrl) {
+ // $elm.addClass($scope.col.getColClass(false));
+ $scope.grid = uiGridCtrl.grid;
+
+ var initColClass = $scope.col.getColClass(false);
+
+ $elm.addClass(initColClass);
+
+ // apply any footerCellClass
+ var classAdded;
+
+ var updateClass = function() {
+ var contents = $elm;
+
+ if ( classAdded ) {
+ contents.removeClass( classAdded );
+ classAdded = null;
+ }
+
+ if (angular.isFunction($scope.col.footerCellClass)) {
+ classAdded = $scope.col.footerCellClass($scope.grid, $scope.row, $scope.col, $scope.rowRenderIndex, $scope.colRenderIndex);
+ }
+ else {
+ classAdded = $scope.col.footerCellClass;
+ }
+ contents.addClass(classAdded);
+ };
+
+ if ($scope.col.footerCellClass) {
+ updateClass();
+ }
+
+ $scope.col.updateAggregationValue();
+
+ // Register a data change watch that would get triggered whenever someone edits a cell or modifies column defs
+ var dataChangeDereg = $scope.grid.registerDataChangeCallback( updateClass, [uiGridConstants.dataChange.COLUMN]);
+
+ // listen for visible rows change and update aggregation values
+ $scope.grid.api.core.on.rowsRendered( $scope, $scope.col.updateAggregationValue );
+ $scope.grid.api.core.on.rowsRendered( $scope, updateClass );
+ $scope.$on( '$destroy', dataChangeDereg );
+ }
+ };
+ }
+ };
+ }]);
+})();
+
+(function () {
+ 'use strict';
+
+ angular.module('ui.grid').directive('uiGridFooter', ['$templateCache', '$compile', 'uiGridConstants', 'gridUtil', '$timeout', function ($templateCache, $compile, uiGridConstants, gridUtil, $timeout) {
+
+ return {
+ restrict: 'EA',
+ replace: true,
+ // priority: 1000,
+ require: ['^uiGrid', '^uiGridRenderContainer'],
+ scope: true,
+ compile: function ($elm, $attrs) {
+ return {
+ pre: function ($scope, $elm, $attrs, controllers) {
+ var uiGridCtrl = controllers[0];
+ var containerCtrl = controllers[1];
+
+ $scope.grid = uiGridCtrl.grid;
+ $scope.colContainer = containerCtrl.colContainer;
+
+ containerCtrl.footer = $elm;
+
+ var footerTemplate = $scope.grid.options.footerTemplate;
+ gridUtil.getTemplate(footerTemplate)
+ .then(function (contents) {
+ var template = angular.element(contents);
+
+ var newElm = $compile(template)($scope);
+ $elm.append(newElm);
+
+ if (containerCtrl) {
+ // Inject a reference to the footer viewport (if it exists) into the grid controller for use in the horizontal scroll handler below
+ var footerViewport = $elm[0].getElementsByClassName('ui-grid-footer-viewport')[0];
+
+ if (footerViewport) {
+ containerCtrl.footerViewport = footerViewport;
+ }
+ }
+ }).catch(angular.noop);
+ },
+
+ post: function ($scope, $elm, $attrs, controllers) {
+ var uiGridCtrl = controllers[0];
+ var containerCtrl = controllers[1];
+
+ // gridUtil.logDebug('ui-grid-footer link');
+
+ var grid = uiGridCtrl.grid;
+
+ // Don't animate footer cells
+ gridUtil.disableAnimations($elm);
+
+ containerCtrl.footer = $elm;
+
+ var footerViewport = $elm[0].getElementsByClassName('ui-grid-footer-viewport')[0];
+ if (footerViewport) {
+ containerCtrl.footerViewport = footerViewport;
+ }
+ }
+ };
+ }
+ };
+ }]);
+
+})();
+
+(function() {
+ 'use strict';
+
+ angular.module('ui.grid').directive('uiGridGridFooter', ['$templateCache', '$compile', 'uiGridConstants', 'gridUtil',
+ function($templateCache, $compile, uiGridConstants, gridUtil) {
+ return {
+ restrict: 'EA',
+ replace: true,
+ require: '^uiGrid',
+ scope: true,
+ compile: function() {
+ return {
+ pre: function($scope, $elm, $attrs, uiGridCtrl) {
+ $scope.grid = uiGridCtrl.grid;
+
+ var footerTemplate = $scope.grid.options.gridFooterTemplate;
+
+ gridUtil.getTemplate(footerTemplate)
+ .then(function(contents) {
+ var template = angular.element(contents),
+ newElm = $compile(template)($scope);
+
+ $elm.append(newElm);
+ }).catch(angular.noop);
+ }
+ };
+ }
+ };
+ }]);
+})();
+
+(function() {
+ 'use strict';
+
+ angular.module('ui.grid').directive('uiGridHeaderCell', ['$compile', '$timeout', '$window', '$document', 'gridUtil', 'uiGridConstants', 'ScrollEvent', 'i18nService', '$rootScope',
+ function ($compile, $timeout, $window, $document, gridUtil, uiGridConstants, ScrollEvent, i18nService, $rootScope) {
+ // Do stuff after mouse has been down this many ms on the header cell
+ var mousedownTimeout = 500,
+ changeModeTimeout = 500; // length of time between a touch event and a mouse event being recognised again, and vice versa
+
+ return {
+ priority: 0,
+ scope: {
+ col: '=',
+ row: '=',
+ renderIndex: '='
+ },
+ require: ['^uiGrid', '^uiGridRenderContainer'],
+ replace: true,
+ compile: function() {
+ return {
+ pre: function ($scope, $elm) {
+ var template = $scope.col.headerCellTemplate;
+ if (template === undefined && $scope.col.providedHeaderCellTemplate !== '') {
+ if ($scope.col.headerCellTemplatePromise) {
+ $scope.col.headerCellTemplatePromise.then(function () {
+ template = $scope.col.headerCellTemplate;
+ $elm.append($compile(template)($scope));
+ });
+ }
+ }
+ else {
+ $elm.append($compile(template)($scope));
+ }
+ },
+
+ post: function ($scope, $elm, $attrs, controllers) {
+ var uiGridCtrl = controllers[0];
+ var renderContainerCtrl = controllers[1];
+
+ $scope.i18n = {
+ headerCell: i18nService.getSafeText('headerCell'),
+ sort: i18nService.getSafeText('sort')
+ };
+ $scope.isSortPriorityVisible = function() {
+ // show sort priority if column is sorted and there is at least one other sorted column
+ return $scope.col && $scope.col.sort && angular.isNumber($scope.col.sort.priority) && $scope.grid.columns.some(function(element, index) {
+ return angular.isNumber(element.sort.priority) && element !== $scope.col;
+ });
+ };
+ $scope.getSortDirectionAriaLabel = function() {
+ var col = $scope.col;
+ // Trying to recreate this sort of thing but it was getting messy having it in the template.
+ // Sort direction {{col.sort.direction == asc ? 'ascending' : ( col.sort.direction == desc ? 'descending': 'none')}}.
+ // {{col.sort.priority ? {{columnPriorityText}} {{col.sort.priority}} : ''}
+ var label = col.sort && col.sort.direction === uiGridConstants.ASC ? $scope.i18n.sort.ascending : ( col.sort && col.sort.direction === uiGridConstants.DESC ? $scope.i18n.sort.descending : $scope.i18n.sort.none);
+
+ if ($scope.isSortPriorityVisible()) {
+ label = label + '. ' + $scope.i18n.headerCell.priority + ' ' + (col.sort.priority + 1);
+ }
+ return label;
+ };
+
+ $scope.grid = uiGridCtrl.grid;
+
+ $scope.renderContainer = uiGridCtrl.grid.renderContainers[renderContainerCtrl.containerId];
+
+ var initColClass = $scope.col.getColClass(false);
+ $elm.addClass(initColClass);
+
+ // Hide the menu by default
+ $scope.menuShown = false;
+
+ // Put asc and desc sort directions in scope
+ $scope.asc = uiGridConstants.ASC;
+ $scope.desc = uiGridConstants.DESC;
+
+ // Store a reference to menu element
+ var $contentsElm = angular.element( $elm[0].querySelectorAll('.ui-grid-cell-contents') );
+
+
+ // apply any headerCellClass
+ var classAdded,
+ previousMouseX;
+
+ // filter watchers
+ var filterDeregisters = [];
+
+
+ /*
+ * Our basic approach here for event handlers is that we listen for a down event (mousedown or touchstart).
+ * Once we have a down event, we need to work out whether we have a click, a drag, or a
+ * hold. A click would sort the grid (if sortable). A drag would be used by moveable, so
+ * we ignore it. A hold would open the menu.
+ *
+ * So, on down event, we put in place handlers for move and up events, and a timer. If the
+ * timer expires before we see a move or up, then we have a long press and hence a column menu open.
+ * If the up happens before the timer, then we have a click, and we sort if the column is sortable.
+ * If a move happens before the timer, then we are doing column move, so we do nothing, the moveable feature
+ * will handle it.
+ *
+ * To deal with touch enabled devices that also have mice, we only create our handlers when
+ * we get the down event, and we create the corresponding handlers - if we're touchstart then
+ * we get touchmove and touchend, if we're mousedown then we get mousemove and mouseup.
+ *
+ * We also suppress the click action whilst this is happening - otherwise after the mouseup there
+ * will be a click event and that can cause the column menu to close
+ *
+ */
+ $scope.downFn = function( event ) {
+ event.stopPropagation();
+
+ if (typeof(event.originalEvent) !== 'undefined' && event.originalEvent !== undefined) {
+ event = event.originalEvent;
+ }
+
+ // Don't show the menu if it's not the left button
+ if (event.button && event.button !== 0) {
+ return;
+ }
+ previousMouseX = event.pageX;
+
+ $scope.mousedownStartTime = (new Date()).getTime();
+ $scope.mousedownTimeout = $timeout(function() { }, mousedownTimeout);
+
+ $scope.mousedownTimeout.then(function () {
+ if ( $scope.colMenu ) {
+ uiGridCtrl.columnMenuScope.showMenu($scope.col, $elm, event);
+ }
+ }).catch(angular.noop);
+
+ uiGridCtrl.fireEvent(uiGridConstants.events.COLUMN_HEADER_CLICK, {event: event, columnName: $scope.col.colDef.name});
+
+ $scope.offAllEvents();
+ if ( event.type === 'touchstart') {
+ $document.on('touchend', $scope.upFn);
+ $document.on('touchmove', $scope.moveFn);
+ } else if ( event.type === 'mousedown' ) {
+ $document.on('mouseup', $scope.upFn);
+ $document.on('mousemove', $scope.moveFn);
+ }
+ };
+
+ $scope.upFn = function( event ) {
+ event.stopPropagation();
+ $timeout.cancel($scope.mousedownTimeout);
+ $scope.offAllEvents();
+ $scope.onDownEvents(event.type);
+
+ var mousedownEndTime = (new Date()).getTime();
+ var mousedownTime = mousedownEndTime - $scope.mousedownStartTime;
+
+ if (mousedownTime > mousedownTimeout) {
+ // long click, handled above with mousedown
+ }
+ else {
+ // short click
+ if ( $scope.sortable ) {
+ $scope.handleClick(event);
+ }
+ }
+ };
+
+ $scope.handleKeyDown = function(event) {
+ if (event.keyCode === 32 || event.keyCode === 13) {
+ event.preventDefault();
+ $scope.handleClick(event);
+ }
+ };
+
+ $scope.moveFn = function( event ) {
+ // Chrome is known to fire some bogus move events.
+ var changeValue = event.pageX - previousMouseX;
+ if ( changeValue === 0 ) { return; }
+
+ // we're a move, so do nothing and leave for column move (if enabled) to take over
+ $timeout.cancel($scope.mousedownTimeout);
+ $scope.offAllEvents();
+ $scope.onDownEvents(event.type);
+ };
+
+ $scope.clickFn = function ( event ) {
+ event.stopPropagation();
+ $contentsElm.off('click', $scope.clickFn);
+ };
+
+
+ $scope.offAllEvents = function() {
+ $contentsElm.off('touchstart', $scope.downFn);
+ $contentsElm.off('mousedown', $scope.downFn);
+
+ $document.off('touchend', $scope.upFn);
+ $document.off('mouseup', $scope.upFn);
+
+ $document.off('touchmove', $scope.moveFn);
+ $document.off('mousemove', $scope.moveFn);
+
+ $contentsElm.off('click', $scope.clickFn);
+ };
+
+ $scope.onDownEvents = function( type ) {
+ // If there is a previous event, then wait a while before
+ // activating the other mode - i.e. if the last event was a touch event then
+ // don't enable mouse events for a wee while (500ms or so)
+ // Avoids problems with devices that emulate mouse events when you have touch events
+
+ switch (type) {
+ case 'touchmove':
+ case 'touchend':
+ $contentsElm.on('click', $scope.clickFn);
+ $contentsElm.on('touchstart', $scope.downFn);
+ $timeout(function() {
+ $contentsElm.on('mousedown', $scope.downFn);
+ }, changeModeTimeout);
+ break;
+ case 'mousemove':
+ case 'mouseup':
+ $contentsElm.on('click', $scope.clickFn);
+ $contentsElm.on('mousedown', $scope.downFn);
+ $timeout(function() {
+ $contentsElm.on('touchstart', $scope.downFn);
+ }, changeModeTimeout);
+ break;
+ default:
+ $contentsElm.on('click', $scope.clickFn);
+ $contentsElm.on('touchstart', $scope.downFn);
+ $contentsElm.on('mousedown', $scope.downFn);
+ }
+ };
+
+ var setFilter = function (updateFilters) {
+ if ( updateFilters ) {
+ if ( typeof($scope.col.updateFilters) !== 'undefined' ) {
+ $scope.col.updateFilters($scope.col.filterable);
+ }
+
+ // if column is filterable add a filter watcher
+ if ($scope.col.filterable) {
+ $scope.col.filters.forEach( function(filter, i) {
+ filterDeregisters.push($scope.$watch('col.filters[' + i + '].term', function(n, o) {
+ if (n !== o) {
+ uiGridCtrl.grid.api.core.raise.filterChanged( $scope.col );
+ uiGridCtrl.grid.api.core.notifyDataChange( uiGridConstants.dataChange.COLUMN );
+ uiGridCtrl.grid.queueGridRefresh();
+ }
+ }));
+ });
+ $scope.$on('$destroy', function() {
+ filterDeregisters.forEach( function(filterDeregister) {
+ filterDeregister();
+ });
+ });
+ } else {
+ filterDeregisters.forEach( function(filterDeregister) {
+ filterDeregister();
+ });
+ }
+ }
+ };
+
+ var updateHeaderOptions = function() {
+ var contents = $elm;
+
+ if ( classAdded ) {
+ contents.removeClass( classAdded );
+ classAdded = null;
+ }
+
+ if (angular.isFunction($scope.col.headerCellClass)) {
+ classAdded = $scope.col.headerCellClass($scope.grid, $scope.row, $scope.col, $scope.rowRenderIndex, $scope.colRenderIndex);
+ }
+ else {
+ classAdded = $scope.col.headerCellClass;
+ }
+ contents.addClass(classAdded);
+
+ $scope.$applyAsync(function() {
+ var rightMostContainer = $scope.grid.renderContainers['right'] && $scope.grid.renderContainers['right'].visibleColumnCache.length ?
+ $scope.grid.renderContainers['right'] : $scope.grid.renderContainers['body'];
+ $scope.isLastCol = uiGridCtrl.grid.options && uiGridCtrl.grid.options.enableGridMenu &&
+ $scope.col === rightMostContainer.visibleColumnCache[ rightMostContainer.visibleColumnCache.length - 1 ];
+ });
+
+ // Figure out whether this column is sortable or not
+ $scope.sortable = Boolean($scope.col.enableSorting);
+
+ // Figure out whether this column is filterable or not
+ var oldFilterable = $scope.col.filterable;
+ $scope.col.filterable = Boolean(uiGridCtrl.grid.options.enableFiltering && $scope.col.enableFiltering);
+
+ $scope.$applyAsync(function () {
+ setFilter(oldFilterable !== $scope.col.filterable);
+ });
+
+ // figure out whether we support column menus
+ $scope.colMenu = ($scope.col.grid.options && $scope.col.grid.options.enableColumnMenus !== false &&
+ $scope.col.colDef && $scope.col.colDef.enableColumnMenu !== false);
+
+ /**
+ * @ngdoc property
+ * @name enableColumnMenu
+ * @propertyOf ui.grid.class:GridOptions.columnDef
+ * @description if column menus are enabled, controls the column menus for this specific
+ * column (i.e. if gridOptions.enableColumnMenus, then you can control column menus
+ * using this option. If gridOptions.enableColumnMenus === false then you get no column
+ * menus irrespective of the value of this option ). Defaults to true.
+ *
+ * By default column menu's trigger is hidden before mouse over, but you can always force it to be visible with CSS:
+ *
+ *
+ * .ui-grid-column-menu-button {
+ * display: block;
+ * }
+ *
+ */
+ /**
+ * @ngdoc property
+ * @name enableColumnMenus
+ * @propertyOf ui.grid.class:GridOptions.columnDef
+ * @description Override for column menus everywhere - if set to false then you get no
+ * column menus. Defaults to true.
+ *
+ */
+
+ $scope.offAllEvents();
+
+ if ($scope.sortable || $scope.colMenu) {
+ $scope.onDownEvents();
+
+ $scope.$on('$destroy', function () {
+ $scope.offAllEvents();
+ });
+ }
+ };
+
+ updateHeaderOptions();
+
+ if ($scope.col.filterContainer === 'columnMenu' && $scope.col.filterable) {
+ $rootScope.$on('menu-shown', function() {
+ $scope.$applyAsync(function () {
+ setFilter($scope.col.filterable);
+ });
+ });
+ }
+
+ // Register a data change watch that would get triggered whenever someone edits a cell or modifies column defs
+ var dataChangeDereg = $scope.grid.registerDataChangeCallback( updateHeaderOptions, [uiGridConstants.dataChange.COLUMN]);
+
+ $scope.$on( '$destroy', dataChangeDereg );
+
+ $scope.handleClick = function(event) {
+ // If the shift key is being held down, add this column to the sort
+ var add = false;
+ if (event.shiftKey) {
+ add = true;
+ }
+
+ // Sort this column then rebuild the grid's rows
+ uiGridCtrl.grid.sortColumn($scope.col, add)
+ .then(function () {
+ if (uiGridCtrl.columnMenuScope) { uiGridCtrl.columnMenuScope.hideMenu(); }
+ uiGridCtrl.grid.refresh();
+ }).catch(angular.noop);
+ };
+
+ $scope.headerCellArrowKeyDown = function(event) {
+ if (event.keyCode === 32 || event.keyCode === 13) {
+ event.preventDefault();
+ $scope.toggleMenu(event);
+ }
+ };
+
+ $scope.toggleMenu = function(event) {
+
+ event.stopPropagation();
+
+ // If the menu is already showing...
+ if (uiGridCtrl.columnMenuScope.menuShown) {
+ // ... and we're the column the menu is on...
+ if (uiGridCtrl.columnMenuScope.col === $scope.col) {
+ // ... hide it
+ uiGridCtrl.columnMenuScope.hideMenu();
+ }
+ // ... and we're NOT the column the menu is on
+ else {
+ // ... move the menu to our column
+ uiGridCtrl.columnMenuScope.showMenu($scope.col, $elm);
+ }
+ }
+ // If the menu is NOT showing
+ else {
+ // ... show it on our column
+ uiGridCtrl.columnMenuScope.showMenu($scope.col, $elm);
+ }
+ };
+ }
+ };
+ }
+ };
+ }]);
+})();
+
+(function() {
+ 'use strict';
+
+ angular.module('ui.grid').directive('uiGridHeader', ['$templateCache', '$compile', 'uiGridConstants', 'gridUtil', '$timeout', 'ScrollEvent',
+ function($templateCache, $compile, uiGridConstants, gridUtil, $timeout, ScrollEvent) {
+ var defaultTemplate = 'ui-grid/ui-grid-header',
+ emptyTemplate = 'ui-grid/ui-grid-no-header';
+
+ return {
+ restrict: 'EA',
+ replace: true,
+ require: ['^uiGrid', '^uiGridRenderContainer'],
+ scope: true,
+ compile: function() {
+ return {
+ pre: function ($scope, $elm, $attrs, controllers) {
+ var uiGridCtrl = controllers[0],
+ containerCtrl = controllers[1];
+
+ $scope.grid = uiGridCtrl.grid;
+ $scope.colContainer = containerCtrl.colContainer;
+
+ updateHeaderReferences();
+
+ var headerTemplate;
+ if (!$scope.grid.options.showHeader) {
+ headerTemplate = emptyTemplate;
+ }
+ else {
+ headerTemplate = ($scope.grid.options.headerTemplate) ? $scope.grid.options.headerTemplate : defaultTemplate;
+ }
+
+ gridUtil.getTemplate(headerTemplate)
+ .then(function (contents) {
+ var template = angular.element(contents);
+
+ var newElm = $compile(template)($scope);
+ $elm.replaceWith(newElm);
+
+ // And update $elm to be the new element
+ $elm = newElm;
+
+ updateHeaderReferences();
+
+ if (containerCtrl) {
+ // Inject a reference to the header viewport (if it exists) into the grid controller for use in the horizontal scroll handler below
+ var headerViewport = $elm[0].getElementsByClassName('ui-grid-header-viewport')[0];
+
+
+ if (headerViewport) {
+ containerCtrl.headerViewport = headerViewport;
+ angular.element(headerViewport).on('scroll', scrollHandler);
+ $scope.$on('$destroy', function () {
+ angular.element(headerViewport).off('scroll', scrollHandler);
+ });
+ }
+ }
+
+ $scope.grid.queueRefresh();
+ }).catch(angular.noop);
+
+ function updateHeaderReferences() {
+ containerCtrl.header = containerCtrl.colContainer.header = $elm;
+
+ var headerCanvases = $elm[0].getElementsByClassName('ui-grid-header-canvas');
+
+ if (headerCanvases.length > 0) {
+ containerCtrl.headerCanvas = containerCtrl.colContainer.headerCanvas = headerCanvases[0];
+ }
+ else {
+ containerCtrl.headerCanvas = null;
+ }
+ }
+
+ function scrollHandler() {
+ if (uiGridCtrl.grid.isScrollingHorizontally) {
+ return;
+ }
+ var newScrollLeft = gridUtil.normalizeScrollLeft(containerCtrl.headerViewport, uiGridCtrl.grid);
+ var horizScrollPercentage = containerCtrl.colContainer.scrollHorizontal(newScrollLeft);
+
+ var scrollEvent = new ScrollEvent(uiGridCtrl.grid, null, containerCtrl.colContainer, ScrollEvent.Sources.ViewPortScroll);
+ scrollEvent.newScrollLeft = newScrollLeft;
+ if ( horizScrollPercentage > -1 ) {
+ scrollEvent.x = { percentage: horizScrollPercentage };
+ }
+
+ uiGridCtrl.grid.scrollContainers(null, scrollEvent);
+ }
+ },
+
+ post: function ($scope, $elm, $attrs, controllers) {
+ var uiGridCtrl = controllers[0];
+ var containerCtrl = controllers[1];
+
+ // gridUtil.logDebug('ui-grid-header link');
+
+ var grid = uiGridCtrl.grid;
+
+ // Don't animate header cells
+ gridUtil.disableAnimations($elm);
+
+ function updateColumnWidths() {
+ // this styleBuilder always runs after the renderContainer, so we can rely on the column widths
+ // already being populated correctly
+
+ var columnCache = containerCtrl.colContainer.visibleColumnCache;
+
+ // Build the CSS
+ // uiGridCtrl.grid.columns.forEach(function (column) {
+ var ret = '';
+ var canvasWidth = 0;
+ columnCache.forEach(function (column) {
+ ret = ret + column.getColClassDefinition();
+ canvasWidth += column.drawnWidth;
+ });
+
+ containerCtrl.colContainer.canvasWidth = canvasWidth;
+
+ // Return the styles back to buildStyles which pops them into the `customStyles` scope variable
+ return ret;
+ }
+
+ containerCtrl.header = $elm;
+
+ var headerViewport = $elm[0].getElementsByClassName('ui-grid-header-viewport')[0];
+ if (headerViewport) {
+ containerCtrl.headerViewport = headerViewport;
+ }
+
+ // todo: remove this if by injecting gridCtrl into unit tests
+ if (uiGridCtrl) {
+ uiGridCtrl.grid.registerStyleComputation({
+ priority: 15,
+ func: updateColumnWidths
+ });
+ }
+ }
+ };
+ }
+ };
+ }]);
+})();
+
+(function() {
+
+angular.module('ui.grid')
+.service('uiGridGridMenuService', [ 'gridUtil', 'i18nService', 'uiGridConstants', function( gridUtil, i18nService, uiGridConstants ) {
+ /**
+ * @ngdoc service
+ * @name ui.grid.uiGridGridMenuService
+ *
+ * @description Methods for working with the grid menu
+ */
+
+ var service = {
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.uiGridGridMenuService
+ * @name initialize
+ * @description Sets up the gridMenu. Most importantly, sets our
+ * scope onto the grid object as grid.gridMenuScope, allowing us
+ * to operate when passed only the grid. Second most importantly,
+ * we register the 'addToGridMenu' and 'removeFromGridMenu' methods
+ * on the core api.
+ * @param {$scope} $scope the scope of this gridMenu
+ * @param {Grid} grid the grid to which this gridMenu is associated
+ */
+ initialize: function( $scope, grid ) {
+ grid.gridMenuScope = $scope;
+ $scope.grid = grid;
+ $scope.registeredMenuItems = [];
+
+ // not certain this is needed, but would be bad to create a memory leak
+ $scope.$on('$destroy', function() {
+ if ( $scope.grid && $scope.grid.gridMenuScope ) {
+ $scope.grid.gridMenuScope = null;
+ }
+ if ( $scope.grid ) {
+ $scope.grid = null;
+ }
+ if ( $scope.registeredMenuItems ) {
+ $scope.registeredMenuItems = null;
+ }
+ });
+
+ $scope.registeredMenuItems = [];
+
+ /**
+ * @ngdoc function
+ * @name addToGridMenu
+ * @methodOf ui.grid.api:PublicApi
+ * @description add items to the grid menu. Used by features
+ * to add their menu items if they are enabled, can also be used by
+ * end users to add menu items. This method has the advantage of allowing
+ * remove again, which can simplify management of which items are included
+ * in the menu when. (Noting that in most cases the shown and active functions
+ * provide a better way to handle visibility of menu items)
+ * @param {Grid} grid the grid on which we are acting
+ * @param {array} items menu items in the format as described in the tutorial, with
+ * the added note that if you want to use remove you must also specify an `id` field,
+ * which is provided when you want to remove an item. The id should be unique.
+ *
+ */
+ grid.api.registerMethod( 'core', 'addToGridMenu', service.addToGridMenu );
+
+ /**
+ * @ngdoc function
+ * @name removeFromGridMenu
+ * @methodOf ui.grid.api:PublicApi
+ * @description Remove an item from the grid menu based on a provided id. Assumes
+ * that the id is unique, removes only the last instance of that id. Does nothing if
+ * the specified id is not found
+ * @param {Grid} grid the grid on which we are acting
+ * @param {string} id the id we'd like to remove from the menu
+ *
+ */
+ grid.api.registerMethod( 'core', 'removeFromGridMenu', service.removeFromGridMenu );
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name addToGridMenu
+ * @propertyOf ui.grid.uiGridGridMenuService
+ * @description add items to the grid menu. Used by features
+ * to add their menu items if they are enabled, can also be used by
+ * end users to add menu items. This method has the advantage of allowing
+ * remove again, which can simplify management of which items are included
+ * in the menu when. (Noting that in most cases the shown and active functions
+ * provide a better way to handle visibility of menu items)
+ * @param {Grid} grid the grid on which we are acting
+ * @param {array} menuItems menu items in the format as described in the tutorial, with
+ * the added note that if you want to use remove you must also specify an `id` field,
+ * which is provided when you want to remove an item. The id should be unique.
+ *
+ */
+ addToGridMenu: function( grid, menuItems ) {
+ if ( !angular.isArray( menuItems ) ) {
+ gridUtil.logError( 'addToGridMenu: menuItems must be an array, and is not, not adding any items');
+ } else {
+ if ( grid.gridMenuScope ) {
+ grid.gridMenuScope.registeredMenuItems = grid.gridMenuScope.registeredMenuItems ? grid.gridMenuScope.registeredMenuItems : [];
+ grid.gridMenuScope.registeredMenuItems = grid.gridMenuScope.registeredMenuItems.concat( menuItems );
+ } else {
+ gridUtil.logError( 'Asked to addToGridMenu, but gridMenuScope not present. Timing issue? Please log issue with ui-grid');
+ }
+ }
+ },
+
+
+ /**
+ * @ngdoc function
+ * @name removeFromGridMenu
+ * @methodOf ui.grid.uiGridGridMenuService
+ * @description Remove an item from the grid menu based on a provided id. Assumes
+ * that the id is unique, removes only the last instance of that id. Does nothing if
+ * the specified id is not found. If there is no gridMenuScope or registeredMenuItems
+ * then do nothing silently - the desired result is those menu items not be present and they
+ * aren't.
+ * @param {Grid} grid the grid on which we are acting
+ * @param {string} id the id we'd like to remove from the menu
+ *
+ */
+ removeFromGridMenu: function( grid, id ) {
+ var foundIndex = -1;
+
+ if ( grid && grid.gridMenuScope ) {
+ grid.gridMenuScope.registeredMenuItems.forEach( function( value, index ) {
+ if ( value.id === id ) {
+ if (foundIndex > -1) {
+ gridUtil.logError( 'removeFromGridMenu: found multiple items with the same id, removing only the last' );
+ } else {
+
+ foundIndex = index;
+ }
+ }
+ });
+ }
+
+ if ( foundIndex > -1 ) {
+ grid.gridMenuScope.registeredMenuItems.splice( foundIndex, 1 );
+ }
+ },
+
+
+ /**
+ * @ngdoc array
+ * @name gridMenuCustomItems
+ * @propertyOf ui.grid.class:GridOptions
+ * @description (optional) An array of menu items that should be added to
+ * the gridMenu. Follow the format documented in the tutorial for column
+ * menu customisation. The context provided to the action function will
+ * include context.grid. An alternative if working with dynamic menus is to use the
+ * provided api - core.addToGridMenu and core.removeFromGridMenu, which handles
+ * some of the management of items for you.
+ *
+ */
+ /**
+ * @ngdoc boolean
+ * @name gridMenuShowHideColumns
+ * @propertyOf ui.grid.class:GridOptions
+ * @description true by default, whether the grid menu should allow hide/show
+ * of columns
+ *
+ */
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.uiGridGridMenuService
+ * @name getMenuItems
+ * @description Decides the menu items to show in the menu. This is a
+ * combination of:
+ *
+ * - the default menu items that are always included,
+ * - any menu items that have been provided through the addMenuItem api. These
+ * are typically added by features within the grid
+ * - any menu items included in grid.options.gridMenuCustomItems. These can be
+ * changed dynamically, as they're always recalculated whenever we show the
+ * menu
+ * @param {$scope} $scope the scope of this gridMenu, from which we can find all
+ * the information that we need
+ * @returns {Array} an array of menu items that can be shown
+ */
+ getMenuItems: function( $scope ) {
+ var menuItems = [
+ // this is where we add any menu items we want to always include
+ ];
+
+ if ( $scope.grid.options.gridMenuCustomItems ) {
+ if ( !angular.isArray( $scope.grid.options.gridMenuCustomItems ) ) {
+ gridUtil.logError( 'gridOptions.gridMenuCustomItems must be an array, and is not');
+ } else {
+ menuItems = menuItems.concat( $scope.grid.options.gridMenuCustomItems );
+ }
+ }
+
+ var clearFilters = [{
+ title: i18nService.getSafeText('gridMenu.clearAllFilters'),
+ action: function ($event) {
+ $scope.grid.clearAllFilters();
+ },
+ shown: function() {
+ return $scope.grid.options.enableFiltering;
+ },
+ order: 100
+ }];
+ menuItems = menuItems.concat( clearFilters );
+
+ menuItems = menuItems.concat( $scope.registeredMenuItems );
+
+ if ( $scope.grid.options.gridMenuShowHideColumns !== false ) {
+ menuItems = menuItems.concat( service.showHideColumns( $scope ) );
+ }
+
+ menuItems.sort(function(a, b) {
+ return a.order - b.order;
+ });
+
+ return menuItems;
+ },
+
+
+ /**
+ * @ngdoc array
+ * @name gridMenuTitleFilter
+ * @propertyOf ui.grid.class:GridOptions
+ * @description (optional) A function that takes a title string
+ * (usually the col.displayName), and converts it into a display value. The function
+ * must return either a string or a promise.
+ *
+ * Used for internationalization of the grid menu column names - for angular-translate
+ * you can pass $translate as the function, for i18nService you can pass getSafeText as the
+ * function
+ * @example
+ *
+ * gridOptions = {
+ * gridMenuTitleFilter: $translate
+ * }
+ *
+ */
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.uiGridGridMenuService
+ * @name showHideColumns
+ * @description Adds two menu items for each of the columns in columnDefs. One
+ * menu item for hide, one menu item for show. Each is visible when appropriate
+ * (show when column is not visible, hide when column is visible). Each toggles
+ * the visible property on the columnDef using toggleColumnVisibility
+ * @param {$scope} $scope of a gridMenu, which contains a reference to the grid
+ */
+ showHideColumns: function( $scope ) {
+ var showHideColumns = [];
+ if ( !$scope.grid.options.columnDefs || $scope.grid.options.columnDefs.length === 0 || $scope.grid.columns.length === 0 ) {
+ return showHideColumns;
+ }
+
+ function isColumnVisible(colDef) {
+ return colDef.visible === true || colDef.visible === undefined;
+ }
+
+ function getColumnIcon(colDef) {
+ return isColumnVisible(colDef) ? 'ui-grid-icon-ok' : 'ui-grid-icon-cancel';
+ }
+
+ // add header for columns
+ showHideColumns.push({
+ title: i18nService.getSafeText('gridMenu.columns'),
+ order: 300,
+ templateUrl: 'ui-grid/ui-grid-menu-header-item'
+ });
+
+ $scope.grid.options.gridMenuTitleFilter = $scope.grid.options.gridMenuTitleFilter ? $scope.grid.options.gridMenuTitleFilter : function( title ) { return title; };
+
+ $scope.grid.options.columnDefs.forEach( function( colDef, index ) {
+ if ( colDef.enableHiding !== false ) {
+ // add hide menu item - shows an OK icon as we only show when column is already visible
+ var menuItem = {
+ icon: getColumnIcon(colDef),
+ action: function($event) {
+ $event.stopPropagation();
+
+ service.toggleColumnVisibility( this.context.gridCol );
+
+ if ($event.target && $event.target.firstChild) {
+ if (angular.element($event.target)[0].nodeName === 'I') {
+ $event.target.className = getColumnIcon(this.context.gridCol.colDef);
+ }
+ else {
+ $event.target.firstChild.className = getColumnIcon(this.context.gridCol.colDef);
+ }
+ }
+ },
+ shown: function() {
+ return this.context.gridCol.colDef.enableHiding !== false;
+ },
+ context: { gridCol: $scope.grid.getColumn(colDef.name || colDef.field) },
+ leaveOpen: true,
+ order: 301 + index
+ };
+ service.setMenuItemTitle( menuItem, colDef, $scope.grid );
+ showHideColumns.push( menuItem );
+ }
+ });
+ return showHideColumns;
+ },
+
+
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.uiGridGridMenuService
+ * @name setMenuItemTitle
+ * @description Handles the response from gridMenuTitleFilter, adding it directly to the menu
+ * item if it returns a string, otherwise waiting for the promise to resolve or reject then
+ * putting the result into the title
+ * @param {object} menuItem the menuItem we want to put the title on
+ * @param {object} colDef the colDef from which we can get displayName, name or field
+ * @param {Grid} grid the grid, from which we can get the options.gridMenuTitleFilter
+ *
+ */
+ setMenuItemTitle: function( menuItem, colDef, grid ) {
+ var title = grid.options.gridMenuTitleFilter( colDef.displayName || gridUtil.readableColumnName(colDef.name) || colDef.field );
+
+ if ( typeof(title) === 'string' ) {
+ menuItem.title = title;
+ } else if ( title.then ) {
+ // must be a promise
+ menuItem.title = "";
+ title.then( function( successValue ) {
+ menuItem.title = successValue;
+ }, function( errorValue ) {
+ menuItem.title = errorValue;
+ }).catch(angular.noop);
+ } else {
+ gridUtil.logError('Expected gridMenuTitleFilter to return a string or a promise, it has returned neither, bad config');
+ menuItem.title = 'badconfig';
+ }
+ },
+
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.uiGridGridMenuService
+ * @name toggleColumnVisibility
+ * @description Toggles the visibility of an individual column. Expects to be
+ * provided a context that has on it a gridColumn, which is the column that
+ * we'll operate upon. We change the visibility, and refresh the grid as appropriate
+ * @param {GridColumn} gridCol the column that we want to toggle
+ *
+ */
+ toggleColumnVisibility: function( gridCol ) {
+ gridCol.colDef.visible = !( gridCol.colDef.visible === true || gridCol.colDef.visible === undefined );
+
+ gridCol.grid.refresh();
+ gridCol.grid.api.core.notifyDataChange( uiGridConstants.dataChange.COLUMN );
+ gridCol.grid.api.core.raise.columnVisibilityChanged( gridCol );
+ }
+ };
+
+ return service;
+}])
+
+.directive('uiGridMenuButton', ['gridUtil', 'uiGridConstants', 'uiGridGridMenuService', 'i18nService',
+function (gridUtil, uiGridConstants, uiGridGridMenuService, i18nService) {
+
+ return {
+ priority: 0,
+ scope: true,
+ require: ['^uiGrid'],
+ templateUrl: 'ui-grid/ui-grid-menu-button',
+ replace: true,
+
+ link: function ($scope, $elm, $attrs, controllers) {
+ var uiGridCtrl = controllers[0];
+
+ // For the aria label
+ $scope.i18n = {
+ aria: i18nService.getSafeText('gridMenu.aria')
+ };
+
+ uiGridGridMenuService.initialize($scope, uiGridCtrl.grid);
+
+ $scope.shown = false;
+
+ $scope.toggleMenu = function () {
+ if ( $scope.shown ) {
+ $scope.$broadcast('hide-menu');
+ $scope.shown = false;
+ } else {
+ $scope.menuItems = uiGridGridMenuService.getMenuItems( $scope );
+ $scope.$broadcast('show-menu');
+ $scope.shown = true;
+ }
+ };
+
+ $scope.$on('menu-hidden', function() {
+ $scope.shown = false;
+ gridUtil.focus.bySelector($elm, '.ui-grid-icon-container');
+ });
+ }
+ };
+}]);
+})();
+
+(function() {
+
+/**
+ * @ngdoc directive
+ * @name ui.grid.directive:uiGridMenu
+ * @element style
+ * @restrict A
+ *
+ * @description
+ * Allows us to interpolate expressions in `
+ I am in a box.
+
+
+ NOTE: It is important to remember to always pass in an event object to
+ * the scrollHandler as the grid scrolling behavior will break without it.
+ * Example+ *
+ * $scope.gridOptions = {
+ * customScroller: function myScrolling(uiGridViewport, scrollHandler) {
+ * uiGridViewport.on('scroll', function myScrollingOverride(event) {
+ * // Do something here
+ *
+ * scrollHandler(event);
+ * });
+ * }
+ * };
+ *
+ * @param {object} uiGridViewport Element being scrolled. (this gets passed in by the grid).
+ * @param {function} scrollHandler Function that needs to be called when scrolling happens. (this gets passed in by the grid).
+ */
+ if (grid && grid.options && grid.options.customScroller) {
+ grid.options.customScroller($elm, scrollHandler);
+ } else {
+ $elm.on('scroll', scrollHandler);
+ }
+
+ var ignoreScroll = false;
+
+ function scrollHandler() {
+ var newScrollTop = $elm[0].scrollTop;
+ var newScrollLeft = gridUtil.normalizeScrollLeft($elm, grid);
+
+ var vertScrollPercentage = rowContainer.scrollVertical(newScrollTop);
+ var horizScrollPercentage = colContainer.scrollHorizontal(newScrollLeft);
+
+ var scrollEvent = new ScrollEvent(grid, rowContainer, colContainer, ScrollEvent.Sources.ViewPortScroll);
+ scrollEvent.newScrollLeft = newScrollLeft;
+ scrollEvent.newScrollTop = newScrollTop;
+ if ( horizScrollPercentage > -1 ) {
+ scrollEvent.x = { percentage: horizScrollPercentage };
+ }
+
+ if ( vertScrollPercentage > -1 ) {
+ scrollEvent.y = { percentage: vertScrollPercentage };
+ }
+
+ grid.scrollContainers($scope.$parent.containerId, scrollEvent);
+ }
+
+ if ($scope.$parent.bindScrollVertical) {
+ grid.addVerticalScrollSync($scope.$parent.containerId, syncVerticalScroll);
+ }
+
+ if ($scope.$parent.bindScrollHorizontal) {
+ grid.addHorizontalScrollSync($scope.$parent.containerId, syncHorizontalScroll);
+ grid.addHorizontalScrollSync($scope.$parent.containerId + 'header', syncHorizontalHeader);
+ grid.addHorizontalScrollSync($scope.$parent.containerId + 'footer', syncHorizontalFooter);
+ }
+
+ function syncVerticalScroll(scrollEvent) {
+ containerCtrl.prevScrollArgs = scrollEvent;
+ $elm[0].scrollTop = scrollEvent.getNewScrollTop(rowContainer,containerCtrl.viewport);
+ }
+
+ function syncHorizontalScroll(scrollEvent) {
+ containerCtrl.prevScrollArgs = scrollEvent;
+ var newScrollLeft = scrollEvent.getNewScrollLeft(colContainer, containerCtrl.viewport);
+
+ $elm[0].scrollLeft = gridUtil.denormalizeScrollLeft(containerCtrl.viewport,newScrollLeft, grid);
+ }
+
+ function syncHorizontalHeader(scrollEvent) {
+ var newScrollLeft = scrollEvent.getNewScrollLeft(colContainer, containerCtrl.viewport);
+
+ if (containerCtrl.headerViewport) {
+ containerCtrl.headerViewport.scrollLeft = gridUtil.denormalizeScrollLeft(containerCtrl.viewport,newScrollLeft, grid);
+ }
+ }
+
+ function syncHorizontalFooter(scrollEvent) {
+ var newScrollLeft = scrollEvent.getNewScrollLeft(colContainer, containerCtrl.viewport);
+
+ if (containerCtrl.footerViewport) {
+ containerCtrl.footerViewport.scrollLeft = gridUtil.denormalizeScrollLeft(containerCtrl.viewport,newScrollLeft, grid);
+ }
+ }
+
+ $scope.$on('$destroy', function unbindEvents() {
+ $elm.off();
+ });
+ },
+ controller: ['$scope', function ($scope) {
+ this.rowStyle = function () {
+ var rowContainer = $scope.rowContainer;
+ var colContainer = $scope.colContainer;
+
+ var styles = {};
+
+ if (rowContainer.currentTopRow !== 0) {
+ // top offset based on hidden rows count
+ var translateY = "translateY("+ (rowContainer.currentTopRow * rowContainer.grid.options.rowHeight) +"px)";
+
+ styles['transform'] = translateY;
+ styles['-webkit-transform'] = translateY;
+ styles['-ms-transform'] = translateY;
+ }
+
+ if (colContainer.currentFirstColumn !== 0) {
+ if (colContainer.grid.isRTL()) {
+ styles['margin-right'] = colContainer.columnOffset + 'px';
+ }
+ else {
+ styles['margin-left'] = colContainer.columnOffset + 'px';
+ }
+ }
+
+ return styles;
+ };
+ }]
+ };
+ }
+ ]);
+
+})();
+
+(function() {
+ angular.module('ui.grid')
+ .directive('uiGridVisible', function uiGridVisibleAction() {
+ return function($scope, $elm, $attr) {
+ $scope.$watch($attr.uiGridVisible, function(visible) {
+ $elm[visible ? 'removeClass' : 'addClass']('ui-grid-invisible');
+ });
+ };
+ });
+})();
+
+(function () {
+ 'use strict';
+
+ angular.module('ui.grid').controller('uiGridController', ['$scope', '$element', '$attrs', 'gridUtil', '$q', 'uiGridConstants',
+ 'gridClassFactory', '$parse', '$compile',
+ function ($scope, $elm, $attrs, gridUtil, $q, uiGridConstants,
+ gridClassFactory, $parse, $compile) {
+ // gridUtil.logDebug('ui-grid controller');
+ var self = this;
+ var deregFunctions = [];
+
+ self.grid = gridClassFactory.createGrid($scope.uiGrid);
+
+ // assign $scope.$parent if appScope not already assigned
+ self.grid.appScope = self.grid.appScope || $scope.$parent;
+
+ $elm.addClass('grid' + self.grid.id);
+ self.grid.rtl = gridUtil.getStyles($elm[0])['direction'] === 'rtl';
+
+
+ // angular.extend(self.grid.options, );
+
+ // all properties of grid are available on scope
+ $scope.grid = self.grid;
+
+ if ($attrs.uiGridColumns) {
+ deregFunctions.push( $attrs.$observe('uiGridColumns', function(value) {
+ self.grid.options.columnDefs = angular.isString(value) ? angular.fromJson(value) : value;
+ self.grid.buildColumns()
+ .then(function() {
+ self.grid.preCompileCellTemplates();
+
+ self.grid.refreshCanvas(true);
+ }).catch(angular.noop);
+ }) );
+ }
+
+ // prevents an error from being thrown when the array is not defined yet and fastWatch is on
+ function getSize(array) {
+ return array ? array.length : 0;
+ }
+
+ // if fastWatch is set we watch only the length and the reference, not every individual object
+ if (self.grid.options.fastWatch) {
+ self.uiGrid = $scope.uiGrid;
+ if (angular.isString($scope.uiGrid.data)) {
+ deregFunctions.push( $scope.$parent.$watch($scope.uiGrid.data, dataWatchFunction) );
+ deregFunctions.push( $scope.$parent.$watch(function() {
+ if ( self.grid.appScope[$scope.uiGrid.data] ) {
+ return self.grid.appScope[$scope.uiGrid.data].length;
+ } else {
+ return undefined;
+ }
+ }, dataWatchFunction) );
+ } else {
+ deregFunctions.push( $scope.$parent.$watch(function() { return $scope.uiGrid.data; }, dataWatchFunction) );
+ deregFunctions.push( $scope.$parent.$watch(function() { return getSize($scope.uiGrid.data); }, function() { dataWatchFunction($scope.uiGrid.data); }) );
+ }
+ deregFunctions.push( $scope.$parent.$watch(function() { return $scope.uiGrid.columnDefs; }, columnDefsWatchFunction) );
+ deregFunctions.push( $scope.$parent.$watch(function() { return getSize($scope.uiGrid.columnDefs); }, function() { columnDefsWatchFunction($scope.uiGrid.columnDefs); }) );
+ } else {
+ if (angular.isString($scope.uiGrid.data)) {
+ deregFunctions.push( $scope.$parent.$watchCollection($scope.uiGrid.data, dataWatchFunction) );
+ } else {
+ deregFunctions.push( $scope.$parent.$watchCollection(function() { return $scope.uiGrid.data; }, dataWatchFunction) );
+ }
+ deregFunctions.push( $scope.$parent.$watchCollection(function() { return $scope.uiGrid.columnDefs; }, columnDefsWatchFunction) );
+ }
+
+
+ function columnDefsWatchFunction(n, o) {
+ if (n && n !== o) {
+ self.grid.options.columnDefs = $scope.uiGrid.columnDefs;
+ self.grid.callDataChangeCallbacks(uiGridConstants.dataChange.COLUMN, {
+ orderByColumnDefs: true,
+ preCompileCellTemplates: true
+ });
+ }
+ }
+
+ var mostRecentData;
+
+ function dataWatchFunction(newData) {
+ // gridUtil.logDebug('dataWatch fired');
+ var promises = [];
+
+ if ( self.grid.options.fastWatch ) {
+ if (angular.isString($scope.uiGrid.data)) {
+ newData = self.grid.appScope.$eval($scope.uiGrid.data);
+ } else {
+ newData = $scope.uiGrid.data;
+ }
+ }
+
+ mostRecentData = newData;
+
+ if (newData) {
+ // columns length is greater than the number of row header columns, which don't count because they're created automatically
+ var hasColumns = self.grid.columns.length > (self.grid.rowHeaderColumns ? self.grid.rowHeaderColumns.length : 0);
+
+ if (
+ // If we have no columns
+ !hasColumns &&
+ // ... and we don't have a ui-grid-columns attribute, which would define columns for us
+ !$attrs.uiGridColumns &&
+ // ... and we have no pre-defined columns
+ self.grid.options.columnDefs.length === 0 &&
+ // ... but we DO have data
+ newData.length > 0
+ ) {
+ // ... then build the column definitions from the data that we have
+ self.grid.buildColumnDefsFromData(newData);
+ }
+
+ // If we haven't built columns before and either have some columns defined or some data defined
+ if (!hasColumns && (self.grid.options.columnDefs.length > 0 || newData.length > 0)) {
+ // Build the column set, then pre-compile the column cell templates
+ promises.push(self.grid.buildColumns()
+ .then(function() {
+ self.grid.preCompileCellTemplates();
+ }).catch(angular.noop));
+ }
+
+ $q.all(promises).then(function() {
+ // use most recent data, rather than the potentially outdated data passed into watcher handler
+ self.grid.modifyRows(mostRecentData)
+ .then(function () {
+ // if (self.viewport) {
+ self.grid.redrawInPlace(true);
+ // }
+
+ $scope.$evalAsync(function() {
+ self.grid.refreshCanvas(true);
+ self.grid.callDataChangeCallbacks(uiGridConstants.dataChange.ROW);
+ });
+ }).catch(angular.noop);
+ }).catch(angular.noop);
+ }
+ }
+
+ var styleWatchDereg = $scope.$watch(function () { return self.grid.styleComputations; }, function() {
+ self.grid.refreshCanvas(true);
+ });
+
+ $scope.$on('$destroy', function() {
+ deregFunctions.forEach( function( deregFn ) { deregFn(); });
+ styleWatchDereg();
+ });
+
+ self.fireEvent = function(eventName, args) {
+ args = args || {};
+
+ // Add the grid to the event arguments if it's not there
+ if (angular.isUndefined(args.grid)) {
+ args.grid = self.grid;
+ }
+
+ $scope.$broadcast(eventName, args);
+ };
+
+ self.innerCompile = function innerCompile(elm) {
+ $compile(elm)($scope);
+ };
+ }]);
+
+/**
+ * @ngdoc directive
+ * @name ui.grid.directive:uiGrid
+ * @element div
+ * @restrict EA
+ * @param {Object} uiGrid Options for the grid to use
+ *
+ * @description Create a very basic grid.
+ *
+ * @example
+
+
+
+ '
+ + ''
+ + ' ',
+ scope: {
+ side: '=uiGridPinnedContainer'
+ },
+ require: '^uiGrid',
+ compile: function compile() {
+ return {
+ post: function ($scope, $elm, $attrs, uiGridCtrl) {
+ // gridUtil.logDebug('ui-grid-pinned-container ' + $scope.side + ' link');
+
+ var grid = uiGridCtrl.grid;
+
+ var myWidth = 0;
+
+ $elm.addClass('ui-grid-pinned-container-' + $scope.side);
+
+ // Monkey-patch the viewport width function
+ if ($scope.side === 'left' || $scope.side === 'right') {
+ grid.renderContainers[$scope.side].getViewportWidth = monkeyPatchedGetViewportWidth;
+ }
+
+ function monkeyPatchedGetViewportWidth() {
+ /*jshint validthis: true */
+ var self = this;
+
+ var viewportWidth = 0;
+ self.visibleColumnCache.forEach(function (column) {
+ viewportWidth += column.drawnWidth;
+ });
+
+ var adjustment = self.getViewportAdjustment();
+
+ viewportWidth = viewportWidth + adjustment.width;
+
+ return viewportWidth;
+ }
+
+ function updateContainerWidth() {
+ if ($scope.side === 'left' || $scope.side === 'right') {
+ var cols = grid.renderContainers[$scope.side].visibleColumnCache;
+ var width = 0;
+ for (var i = 0; i < cols.length; i++) {
+ var col = cols[i];
+ width += col.drawnWidth || col.width || 0;
+ }
+
+ return width;
+ }
+ }
+
+ function updateContainerDimensions() {
+ var ret = '';
+
+ // Column containers
+ if ($scope.side === 'left' || $scope.side === 'right') {
+ myWidth = updateContainerWidth();
+
+ // gridUtil.logDebug('myWidth', myWidth);
+
+ // TODO(c0bra): Subtract sum of col widths from grid viewport width and update it
+ $elm.attr('style', null);
+
+ // var myHeight = grid.renderContainers.body.getViewportHeight(); // + grid.horizontalScrollbarHeight;
+
+ ret += '.grid' + grid.id + ' .ui-grid-pinned-container-' + $scope.side + ', .grid' + grid.id + ' .ui-grid-pinned-container-' + $scope.side + ' .ui-grid-render-container-' + $scope.side + ' .ui-grid-viewport { width: ' + myWidth + 'px; } ';
+ }
+
+ return ret;
+ }
+
+ grid.renderContainers.body.registerViewportAdjuster(function (adjustment) {
+ myWidth = updateContainerWidth();
+
+ // Subtract our own width
+ adjustment.width -= myWidth;
+ adjustment.side = $scope.side;
+
+ return adjustment;
+ });
+
+ // Register style computation to adjust for columns in `side`'s render container
+ grid.registerStyleComputation({
+ priority: 15,
+ func: updateContainerDimensions
+ });
+ }
+ };
+ }
+ };
+ }]);
+})();
+
+(function () {
+ angular.module('ui.grid').config(['$provide', function($provide) {
+ $provide.decorator('i18nService', ['$delegate', function($delegate) {
+ $delegate.add('en', {
+ headerCell: {
+ aria: {
+ defaultFilterLabel: 'Filter for column',
+ removeFilter: 'Remove Filter',
+ columnMenuButtonLabel: 'Column Menu',
+ column: 'Column'
+ },
+ priority: 'Priority:',
+ filterLabel: "Filter for column: "
+ },
+ aggregate: {
+ label: 'items'
+ },
+ groupPanel: {
+ description: 'Drag a column header here and drop it to group by that column.'
+ },
+ search: {
+ aria: {
+ selected: 'Row selected',
+ notSelected: 'Row not selected'
+ },
+ placeholder: 'Search...',
+ showingItems: 'Showing Items:',
+ selectedItems: 'Selected Items:',
+ totalItems: 'Total Items:',
+ size: 'Page Size:',
+ first: 'First Page',
+ next: 'Next Page',
+ previous: 'Previous Page',
+ last: 'Last Page'
+ },
+ menu: {
+ text: 'Choose Columns:'
+ },
+ sort: {
+ ascending: 'Sort Ascending',
+ descending: 'Sort Descending',
+ none: 'Sort None',
+ remove: 'Remove Sort'
+ },
+ column: {
+ hide: 'Hide Column'
+ },
+ aggregation: {
+ count: 'total rows: ',
+ sum: 'total: ',
+ avg: 'avg: ',
+ min: 'min: ',
+ max: 'max: '
+ },
+ pinning: {
+ pinLeft: 'Pin Left',
+ pinRight: 'Pin Right',
+ unpin: 'Unpin'
+ },
+ columnMenu: {
+ close: 'Close'
+ },
+ gridMenu: {
+ aria: {
+ buttonLabel: 'Grid Menu'
+ },
+ columns: 'Columns:',
+ importerTitle: 'Import file',
+ exporterAllAsCsv: 'Export all data as csv',
+ exporterVisibleAsCsv: 'Export visible data as csv',
+ exporterSelectedAsCsv: 'Export selected data as csv',
+ exporterAllAsPdf: 'Export all data as pdf',
+ exporterVisibleAsPdf: 'Export visible data as pdf',
+ exporterSelectedAsPdf: 'Export selected data as pdf',
+ exporterAllAsExcel: 'Export all data as excel',
+ exporterVisibleAsExcel: 'Export visible data as excel',
+ exporterSelectedAsExcel: 'Export selected data as excel',
+ clearAllFilters: 'Clear all filters'
+ },
+ importer: {
+ noHeaders: 'Column names were unable to be derived, does the file have a header?',
+ noObjects: 'Objects were not able to be derived, was there data in the file other than headers?',
+ invalidCsv: 'File was unable to be processed, is it valid CSV?',
+ invalidJson: 'File was unable to be processed, is it valid Json?',
+ jsonNotArray: 'Imported json file must contain an array, aborting.'
+ },
+ pagination: {
+ aria: {
+ pageToFirst: 'Page to first',
+ pageBack: 'Page back',
+ pageSelected: 'Selected page',
+ pageForward: 'Page forward',
+ pageToLast: 'Page to last'
+ },
+ sizes: 'items per page',
+ totalItems: 'items',
+ through: 'through',
+ of: 'of'
+ },
+ grouping: {
+ group: 'Group',
+ ungroup: 'Ungroup',
+ aggregate_count: 'Agg: Count',
+ aggregate_sum: 'Agg: Sum',
+ aggregate_max: 'Agg: Max',
+ aggregate_min: 'Agg: Min',
+ aggregate_avg: 'Agg: Avg',
+ aggregate_remove: 'Agg: Remove'
+ },
+ validate: {
+ error: 'Error:',
+ minLength: 'Value should be at least THRESHOLD characters long.',
+ maxLength: 'Value should be at most THRESHOLD characters long.',
+ required: 'A value is needed.'
+ }
+ });
+ return $delegate;
+ }]);
+ }]);
+})();
+
+(function() {
+
+angular.module('ui.grid')
+.factory('Grid', ['$q', '$compile', '$parse', 'gridUtil', 'uiGridConstants', 'GridOptions', 'GridColumn', 'GridRow', 'GridApi', 'rowSorter', 'rowSearcher', 'GridRenderContainer', '$timeout','ScrollEvent',
+ function($q, $compile, $parse, gridUtil, uiGridConstants, GridOptions, GridColumn, GridRow, GridApi, rowSorter, rowSearcher, GridRenderContainer, $timeout, ScrollEvent) {
+
+ /**
+ * @ngdoc object
+ * @name ui.grid.api:PublicApi
+ * @description Public Api for the core grid features
+ *
+ */
+
+ /**
+ * @ngdoc function
+ * @name ui.grid.class:Grid
+ * @description Grid is the main viewModel. Any properties or methods needed to maintain state are defined in
+ * this prototype. One instance of Grid is created per Grid directive instance.
+ * @param {object} options Object map of options to pass into the grid. An 'id' property is expected.
+ */
+ var Grid = function Grid(options) {
+ var self = this;
+ // Get the id out of the options, then remove it
+ if (options !== undefined && typeof(options.id) !== 'undefined' && options.id) {
+ if (!/^[_a-zA-Z0-9-]+$/.test(options.id)) {
+ throw new Error("Grid id '" + options.id + '" is invalid. It must follow CSS selector syntax rules.');
+ }
+ }
+ else {
+ throw new Error('No ID provided. An ID must be given when creating a grid.');
+ }
+
+ self.id = options.id;
+ delete options.id;
+
+ // Get default options
+ self.options = GridOptions.initialize( options );
+
+ /**
+ * @ngdoc object
+ * @name appScope
+ * @propertyOf ui.grid.class:Grid
+ * @description reference to the application scope (the parent scope of the ui-grid element). Assigned in ui-grid controller
+ * + * use gridOptions.appScopeProvider to override the default assignment of $scope.$parent with any reference + */ + self.appScope = self.options.appScopeProvider; + + self.headerHeight = self.options.headerRowHeight; + + + /** + * @ngdoc object + * @name footerHeight + * @propertyOf ui.grid.class:Grid + * @description returns the total footer height gridFooter + columnFooter + */ + self.footerHeight = self.calcFooterHeight(); + + + /** + * @ngdoc object + * @name columnFooterHeight + * @propertyOf ui.grid.class:Grid + * @description returns the total column footer height + */ + self.columnFooterHeight = self.calcColumnFooterHeight(); + + self.rtl = false; + self.gridHeight = 0; + self.gridWidth = 0; + self.columnBuilders = []; + self.rowBuilders = []; + self.rowsProcessors = []; + self.columnsProcessors = []; + self.styleComputations = []; + self.viewportAdjusters = []; + self.rowHeaderColumns = []; + self.dataChangeCallbacks = {}; + self.verticalScrollSyncCallBackFns = {}; + self.horizontalScrollSyncCallBackFns = {}; + + // self.visibleRowCache = []; + + // Set of 'render' containers for self grid, which can render sets of rows + self.renderContainers = {}; + + // Create a + self.renderContainers.body = new GridRenderContainer('body', self); + + self.cellValueGetterCache = {}; + + // Cached function to use with custom row templates + self.getRowTemplateFn = null; + + + // representation of the rows on the grid. + // these are wrapped references to the actual data rows (options.data) + self.rows = []; + + // represents the columns on the grid + self.columns = []; + + /** + * @ngdoc boolean + * @name isScrollingVertically + * @propertyOf ui.grid.class:Grid + * @description set to true when Grid is scrolling vertically. Set to false via debounced method + */ + self.isScrollingVertically = false; + + /** + * @ngdoc boolean + * @name isScrollingHorizontally + * @propertyOf ui.grid.class:Grid + * @description set to true when Grid is scrolling horizontally. Set to false via debounced method + */ + self.isScrollingHorizontally = false; + + /** + * @ngdoc property + * @name scrollDirection + * @propertyOf ui.grid.class:Grid + * @description set one of the {@link ui.grid.service:uiGridConstants#properties_scrollDirection uiGridConstants.scrollDirection} + * values (UP, DOWN, LEFT, RIGHT, NONE), which tells us which direction we are scrolling. + * Set to NONE via debounced method + */ + self.scrollDirection = uiGridConstants.scrollDirection.NONE; + + // if true, grid will not respond to any scroll events + self.disableScrolling = false; + + + function vertical (scrollEvent) { + self.isScrollingVertically = false; + self.api.core.raise.scrollEnd(scrollEvent); + self.scrollDirection = uiGridConstants.scrollDirection.NONE; + } + + var debouncedVertical = gridUtil.debounce(vertical, self.options.scrollDebounce); + var debouncedVerticalMinDelay = gridUtil.debounce(vertical, 0); + + function horizontal (scrollEvent) { + self.isScrollingHorizontally = false; + self.api.core.raise.scrollEnd(scrollEvent); + self.scrollDirection = uiGridConstants.scrollDirection.NONE; + } + + var debouncedHorizontal = gridUtil.debounce(horizontal, self.options.scrollDebounce); + var debouncedHorizontalMinDelay = gridUtil.debounce(horizontal, 0); + + + /** + * @ngdoc function + * @name flagScrollingVertically + * @methodOf ui.grid.class:Grid + * @description sets isScrollingVertically to true and sets it to false in a debounced function + */ + self.flagScrollingVertically = function(scrollEvent) { + if (!self.isScrollingVertically && !self.isScrollingHorizontally) { + self.api.core.raise.scrollBegin(scrollEvent); + } + self.isScrollingVertically = true; + if (self.options.scrollDebounce === 0 || !scrollEvent.withDelay) { + debouncedVerticalMinDelay(scrollEvent); + } + else { + debouncedVertical(scrollEvent); + } + }; + + /** + * @ngdoc function + * @name flagScrollingHorizontally + * @methodOf ui.grid.class:Grid + * @description sets isScrollingHorizontally to true and sets it to false in a debounced function + */ + self.flagScrollingHorizontally = function(scrollEvent) { + if (!self.isScrollingVertically && !self.isScrollingHorizontally) { + self.api.core.raise.scrollBegin(scrollEvent); + } + self.isScrollingHorizontally = true; + if (self.options.scrollDebounce === 0 || !scrollEvent.withDelay) { + debouncedHorizontalMinDelay(scrollEvent); + } + else { + debouncedHorizontal(scrollEvent); + } + }; + + self.scrollbarHeight = 0; + self.scrollbarWidth = 0; + if (self.options.enableHorizontalScrollbar !== uiGridConstants.scrollbars.NEVER) { + self.scrollbarHeight = gridUtil.getScrollbarWidth(); + } + + if (self.options.enableVerticalScrollbar !== uiGridConstants.scrollbars.NEVER) { + self.scrollbarWidth = gridUtil.getScrollbarWidth(); + } + + self.api = new GridApi(self); + + /** + * @ngdoc function + * @name refresh + * @methodOf ui.grid.api:PublicApi + * @description Refresh the rendered grid on screen. + * The refresh method re-runs both the columnProcessors and the + * rowProcessors, as well as calling refreshCanvas to update all + * the grid sizing. In general you should prefer to use queueGridRefresh + * instead, which is basically a debounced version of refresh. + * + * If you only want to resize the grid, not regenerate all the rows + * and columns, you should consider directly calling refreshCanvas instead. + * + * @param {boolean} [rowsAltered] Optional flag for refreshing when the number of rows has changed + */ + self.api.registerMethod( 'core', 'refresh', this.refresh ); + + /** + * @ngdoc function + * @name queueGridRefresh + * @methodOf ui.grid.api:PublicApi + * @description Request a refresh of the rendered grid on screen, if multiple + * calls to queueGridRefresh are made within a digest cycle only one will execute. + * The refresh method re-runs both the columnProcessors and the + * rowProcessors, as well as calling refreshCanvas to update all + * the grid sizing. In general you should prefer to use queueGridRefresh + * instead, which is basically a debounced version of refresh. + * + */ + self.api.registerMethod( 'core', 'queueGridRefresh', this.queueGridRefresh ); + + /** + * @ngdoc function + * @name refreshRows + * @methodOf ui.grid.api:PublicApi + * @description Runs only the rowProcessors, columns remain as they were. + * It then calls redrawInPlace and refreshCanvas, which adjust the grid sizing. + * @returns {promise} promise that is resolved when render completes? + * + */ + self.api.registerMethod( 'core', 'refreshRows', this.refreshRows ); + + /** + * @ngdoc function + * @name queueRefresh + * @methodOf ui.grid.api:PublicApi + * @description Requests execution of refreshCanvas, if multiple requests are made + * during a digest cycle only one will run. RefreshCanvas updates the grid sizing. + * @returns {promise} promise that is resolved when render completes? + * + */ + self.api.registerMethod( 'core', 'queueRefresh', this.queueRefresh ); + + /** + * @ngdoc function + * @name handleWindowResize + * @methodOf ui.grid.api:PublicApi + * @description Trigger a grid resize, normally this would be picked + * up by a watch on window size, but in some circumstances it is necessary + * to call this manually + * @returns {promise} promise that is resolved when render completes? + * + */ + self.api.registerMethod( 'core', 'handleWindowResize', this.handleWindowResize ); + + + /** + * @ngdoc function + * @name addRowHeaderColumn + * @methodOf ui.grid.api:PublicApi + * @description adds a row header column to the grid + * @param {object} column def + * @param {number} order Determines order of header column on grid. Lower order means header + * is positioned to the left of higher order headers + * + */ + self.api.registerMethod( 'core', 'addRowHeaderColumn', this.addRowHeaderColumn ); + + /** + * @ngdoc function + * @name scrollToIfNecessary + * @methodOf ui.grid.api:PublicApi + * @description Scrolls the grid to make a certain row and column combo visible, + * in the case that it is not completely visible on the screen already. + * @param {GridRow} gridRow row to make visible + * @param {GridColumn} gridCol column to make visible + * @returns {promise} a promise that is resolved when scrolling is complete + * + */ + self.api.registerMethod( 'core', 'scrollToIfNecessary', function(gridRow, gridCol) { return self.scrollToIfNecessary(gridRow, gridCol);} ); + + /** + * @ngdoc function + * @name scrollTo + * @methodOf ui.grid.api:PublicApi + * @description Scroll the grid such that the specified + * row and column is in view + * @param {object} rowEntity gridOptions.data[] array instance to make visible + * @param {object} colDef to make visible + * @returns {promise} a promise that is resolved after any scrolling is finished + */ + self.api.registerMethod( 'core', 'scrollTo', function (rowEntity, colDef) { return self.scrollTo(rowEntity, colDef);} ); + + /** + * @ngdoc function + * @name registerRowsProcessor + * @methodOf ui.grid.api:PublicApi + * @description + * Register a "rows processor" function. When the rows are updated, + * the grid calls each registered "rows processor", which has a chance + * to alter the set of rows (sorting, etc) as long as the count is not + * modified. + * + * @param {function(renderedRowsToProcess, columns )} processorFunction rows processor function, which + * is run in the context of the grid (i.e. this for the function will be the grid), and must + * return the updated rows list, which is passed to the next processor in the chain + * @param {number} priority the priority of this processor. In general we try to do them in 100s to leave room + * for other people to inject rows processors at intermediate priorities. Lower priority rowsProcessors run earlier. + * + * At present allRowsVisible is running at 50, sort manipulations running at 60-65, filter is running at 100, + * sort is at 200, grouping and treeview at 400-410, selectable rows at 500, pagination at 900 (pagination will generally want to be last) + */ + self.api.registerMethod( 'core', 'registerRowsProcessor', this.registerRowsProcessor ); + + /** + * @ngdoc function + * @name registerColumnsProcessor + * @methodOf ui.grid.api:PublicApi + * @description + * Register a "columns processor" function. When the columns are updated, + * the grid calls each registered "columns processor", which has a chance + * to alter the set of columns as long as the count is not + * modified. + * + * @param {function(renderedColumnsToProcess, rows )} processorFunction columns processor function, which + * is run in the context of the grid (i.e. this for the function will be the grid), and must + * return the updated columns list, which is passed to the next processor in the chain + * @param {number} priority the priority of this processor. In general we try to do them in 100s to leave room + * for other people to inject columns processors at intermediate priorities. Lower priority columnsProcessors run earlier. + * + * At present allRowsVisible is running at 50, filter is running at 100, sort is at 200, grouping at 400, selectable rows at 500, pagination at 900 (pagination will generally want to be last) + */ + self.api.registerMethod( 'core', 'registerColumnsProcessor', this.registerColumnsProcessor ); + + /** + * @ngdoc function + * @name sortHandleNulls + * @methodOf ui.grid.api:PublicApi + * @description A null handling method that can be used when building custom sort + * functions + * @example + *
+ * mySortFn = function(a, b) {
+ * var nulls = $scope.gridApi.core.sortHandleNulls(a, b);
+ * if ( nulls !== null ) {
+ * return nulls;
+ * } else {
+ * // your code for sorting here
+ * };
+ *
+ * @param {object} a sort value a
+ * @param {object} b sort value b
+ * @returns {number} null if there were no nulls/undefineds, otherwise returns
+ * a sort value that should be passed back from the sort function
+ *
+ */
+ self.api.registerMethod( 'core', 'sortHandleNulls', rowSorter.handleNulls );
+
+ /**
+ * @ngdoc function
+ * @name sortChanged
+ * @methodOf ui.grid.api:PublicApi
+ * @description The sort criteria on one or more columns has
+ * changed. Provides as parameters the grid and the output of
+ * getColumnSorting, which is an array of gridColumns
+ * that have sorting on them, sorted in priority order.
+ *
+ * @param {$scope} scope The scope of the controller. This is used to deregister this event when the scope is destroyed.
+ * @param {Function} callBack Will be called when the event is emited. The function passes back the grid and an array of
+ * columns with sorts on them, in priority order.
+ *
+ * @example
+ *
+ * gridApi.core.on.sortChanged( $scope, function(grid, sortColumns) {
+ * // do something
+ * });
+ *
+ */
+ self.api.registerEvent( 'core', 'sortChanged' );
+
+ /**
+ * @ngdoc function
+ * @name columnVisibilityChanged
+ * @methodOf ui.grid.api:PublicApi
+ * @description The visibility of a column has changed,
+ * the column itself is passed out as a parameter of the event.
+ *
+ * @param {$scope} scope The scope of the controller. This is used to deregister this event when the scope is destroyed.
+ * @param {Function} callBack Will be called when the event is emited. The function passes back the GridCol that has changed.
+ *
+ * @example
+ *
+ * gridApi.core.on.columnVisibilityChanged( $scope, function (column) {
+ * // do something
+ * } );
+ *
+ */
+ self.api.registerEvent( 'core', 'columnVisibilityChanged' );
+
+ /**
+ * @ngdoc method
+ * @name notifyDataChange
+ * @methodOf ui.grid.api:PublicApi
+ * @description Notify the grid that a data or config change has occurred,
+ * where that change isn't something the grid was otherwise noticing. This
+ * might be particularly relevant where you've changed values within the data
+ * and you'd like cell classes to be re-evaluated, or changed config within
+ * the columnDef and you'd like headerCellClasses to be re-evaluated.
+ * @param {string} type one of the
+ * {@link ui.grid.service:uiGridConstants#properties_dataChange uiGridConstants.dataChange}
+ * values (ALL, ROW, EDIT, COLUMN, OPTIONS), which tells us which refreshes to fire.
+ *
+ * - ALL: listeners fired on any of these events, fires listeners on all events.
+ * - ROW: fired when a row is added or removed.
+ * - EDIT: fired when the data in a cell is edited.
+ * - COLUMN: fired when the column definitions are modified.
+ * - OPTIONS: fired when the grid options are modified.
+ */
+ self.api.registerMethod( 'core', 'notifyDataChange', this.notifyDataChange );
+
+ /**
+ * @ngdoc method
+ * @name clearAllFilters
+ * @methodOf ui.grid.api:PublicApi
+ * @description Clears all filters and optionally refreshes the visible rows.
+ * @param {object} refreshRows Defaults to true.
+ * @param {object} clearConditions Defaults to false.
+ * @param {object} clearFlags Defaults to false.
+ * @returns {promise} If `refreshRows` is true, returns a promise of the rows refreshing.
+ */
+ self.api.registerMethod('core', 'clearAllFilters', this.clearAllFilters);
+
+ self.registerDataChangeCallback( self.columnRefreshCallback, [uiGridConstants.dataChange.COLUMN]);
+ self.registerDataChangeCallback( self.processRowsCallback, [uiGridConstants.dataChange.EDIT]);
+ self.registerDataChangeCallback( self.updateFooterHeightCallback, [uiGridConstants.dataChange.OPTIONS]);
+
+ self.registerStyleComputation({
+ priority: 10,
+ func: self.getFooterStyles
+ });
+ };
+
+ Grid.prototype.calcFooterHeight = function () {
+ if (!this.hasFooter()) {
+ return 0;
+ }
+
+ var height = 0;
+ if (this.options.showGridFooter) {
+ height += this.options.gridFooterHeight;
+ }
+
+ height += this.calcColumnFooterHeight();
+
+ return height;
+ };
+
+ Grid.prototype.calcColumnFooterHeight = function () {
+ var height = 0;
+
+ if (this.options.showColumnFooter) {
+ height += this.options.columnFooterHeight;
+ }
+
+ return height;
+ };
+
+ Grid.prototype.getFooterStyles = function () {
+ var style = '.grid' + this.id + ' .ui-grid-footer-aggregates-row { height: ' + this.options.columnFooterHeight + 'px; }';
+ style += ' .grid' + this.id + ' .ui-grid-footer-info { height: ' + this.options.gridFooterHeight + 'px; }';
+ return style;
+ };
+
+ Grid.prototype.hasFooter = function () {
+ return this.options.showGridFooter || this.options.showColumnFooter;
+ };
+
+ /**
+ * @ngdoc function
+ * @name isRTL
+ * @methodOf ui.grid.class:Grid
+ * @description Returns true if grid is RightToLeft
+ */
+ Grid.prototype.isRTL = function () {
+ return this.rtl;
+ };
+
+
+ /**
+ * @ngdoc function
+ * @name registerColumnBuilder
+ * @methodOf ui.grid.class:Grid
+ * @description When the build creates columns from column definitions, the columnbuilders will be called to add
+ * additional properties to the column.
+ * @param {function(colDef, col, gridOptions)} columnBuilder function to be called
+ */
+ Grid.prototype.registerColumnBuilder = function registerColumnBuilder(columnBuilder) {
+ this.columnBuilders.push(columnBuilder);
+ };
+
+ /**
+ * @ngdoc function
+ * @name buildColumnDefsFromData
+ * @methodOf ui.grid.class:Grid
+ * @description Populates columnDefs from the provided data
+ * @param {function(colDef, col, gridOptions)} rowBuilder function to be called
+ */
+ Grid.prototype.buildColumnDefsFromData = function (dataRows) {
+ this.options.columnDefs = gridUtil.getColumnsFromData(dataRows, this.options.excludeProperties);
+ };
+
+ /**
+ * @ngdoc function
+ * @name registerRowBuilder
+ * @methodOf ui.grid.class:Grid
+ * @description When the build creates rows from gridOptions.data, the rowBuilders will be called to add
+ * additional properties to the row.
+ * @param {function(row, gridOptions)} rowBuilder function to be called
+ */
+ Grid.prototype.registerRowBuilder = function registerRowBuilder(rowBuilder) {
+ this.rowBuilders.push(rowBuilder);
+ };
+
+ /**
+ * @ngdoc function
+ * @name registerDataChangeCallback
+ * @methodOf ui.grid.class:Grid
+ * @description When a data change occurs, the data change callbacks of the specified type
+ * will be called. The rules are:
+ *
+ * - when the data watch fires, that is considered a ROW change (the data watch only notices
+ * added or removed rows)
+ * - when the api is called to inform us of a change, the declared type of that change is used
+ * - when a cell edit completes, the EDIT callbacks are triggered
+ * - when the columnDef watch fires, the COLUMN callbacks are triggered
+ * - when the options watch fires, the OPTIONS callbacks are triggered
+ *
+ * For a given event:
+ * - ALL calls ROW, EDIT, COLUMN, OPTIONS and ALL callbacks
+ * - ROW calls ROW and ALL callbacks
+ * - EDIT calls EDIT and ALL callbacks
+ * - COLUMN calls COLUMN and ALL callbacks
+ * - OPTIONS calls OPTIONS and ALL callbacks
+ *
+ * @param {function(grid)} callback function to be called
+ * @param {array} types the types of data change you want to be informed of. Values from
+ * the {@link ui.grid.service:uiGridConstants#properties_dataChange uiGridConstants.dataChange}
+ * values ( ALL, EDIT, ROW, COLUMN, OPTIONS ). Optional and defaults to ALL
+ * @returns {function} deregister function - a function that can be called to deregister this callback
+ */
+ Grid.prototype.registerDataChangeCallback = function registerDataChangeCallback(callback, types, _this) {
+ var self = this,
+ uid = gridUtil.nextUid();
+
+ if ( !types ) {
+ types = [uiGridConstants.dataChange.ALL];
+ }
+ if ( !Array.isArray(types)) {
+ gridUtil.logError("Expected types to be an array or null in registerDataChangeCallback, value passed was: " + types );
+ }
+ this.dataChangeCallbacks[uid] = { callback: callback, types: types, _this: _this };
+
+ return function() {
+ delete self.dataChangeCallbacks[uid];
+ };
+ };
+
+ /**
+ * @ngdoc function
+ * @name callDataChangeCallbacks
+ * @methodOf ui.grid.class:Grid
+ * @description Calls the callbacks based on the type of data change that
+ * has occurred. Always calls the ALL callbacks, calls the ROW, EDIT, COLUMN and OPTIONS callbacks if the
+ * event type is matching, or if the type is ALL.
+ * @param {string} type the type of event that occurred - one of the
+ * {@link ui.grid.service:uiGridConstants#properties_dataChange uiGridConstants.dataChange}
+ * values (ALL, ROW, EDIT, COLUMN, OPTIONS)
+ */
+ Grid.prototype.callDataChangeCallbacks = function callDataChangeCallbacks(type, options) {
+ angular.forEach( this.dataChangeCallbacks, function( callback, uid ) {
+ if ( callback.types.indexOf( uiGridConstants.dataChange.ALL ) !== -1 ||
+ callback.types.indexOf( type ) !== -1 ||
+ type === uiGridConstants.dataChange.ALL ) {
+ if (callback._this) {
+ callback.callback.apply(callback._this, this, options);
+ }
+ else {
+ callback.callback(this, options);
+ }
+ }
+ }, this);
+ };
+
+ /**
+ * @ngdoc function
+ * @name notifyDataChange
+ * @methodOf ui.grid.class:Grid
+ * @description Notifies us that a data change has occurred, used in the public
+ * api for users to tell us when they've changed data or some other event that
+ * our watches cannot pick up
+ * @param {string} type the type of event that occurred - one of the
+ * uiGridConstants.dataChange values (ALL, ROW, EDIT, COLUMN, OPTIONS)
+ *
+ * - ALL: listeners fired on any of these events, fires listeners on all events.
+ * - ROW: fired when a row is added or removed.
+ * - EDIT: fired when the data in a cell is edited.
+ * - COLUMN: fired when the column definitions are modified.
+ * - OPTIONS: fired when the grid options are modified.
+ */
+ Grid.prototype.notifyDataChange = function notifyDataChange(type) {
+ var constants = uiGridConstants.dataChange;
+
+ if ( type === constants.ALL ||
+ type === constants.COLUMN ||
+ type === constants.EDIT ||
+ type === constants.ROW ||
+ type === constants.OPTIONS ) {
+ this.callDataChangeCallbacks( type );
+ }
+ else {
+ gridUtil.logError("Notified of a data change, but the type was not recognised, so no action taken, type was: " + type);
+ }
+ };
+
+ /**
+ * @ngdoc function
+ * @name columnRefreshCallback
+ * @methodOf ui.grid.class:Grid
+ * @description refreshes the grid when a column refresh
+ * is notified, which triggers handling of the visible flag.
+ * This is called on uiGridConstants.dataChange.COLUMN, and is
+ * registered as a dataChangeCallback in grid.js
+ * @param {object} grid The grid object.
+ * @param {object} options Any options passed into the callback.
+ */
+ Grid.prototype.columnRefreshCallback = function columnRefreshCallback(grid, options) {
+ grid.buildColumns(options);
+ grid.queueGridRefresh();
+ };
+
+ /**
+ * @ngdoc function
+ * @name processRowsCallback
+ * @methodOf ui.grid.class:Grid
+ * @description calls the row processors, specifically
+ * intended to reset the sorting when an edit is called,
+ * registered as a dataChangeCallback on uiGridConstants.dataChange.EDIT
+ * @param {object} grid The grid object.
+ */
+ Grid.prototype.processRowsCallback = function processRowsCallback( grid ) {
+ grid.queueGridRefresh();
+ };
+
+
+ /**
+ * @ngdoc function
+ * @name updateFooterHeightCallback
+ * @methodOf ui.grid.class:Grid
+ * @description recalculates the footer height,
+ * registered as a dataChangeCallback on uiGridConstants.dataChange.OPTIONS
+ * @param {object} grid The grid object.
+ */
+ Grid.prototype.updateFooterHeightCallback = function updateFooterHeightCallback( grid ) {
+ grid.footerHeight = grid.calcFooterHeight();
+ grid.columnFooterHeight = grid.calcColumnFooterHeight();
+ };
+
+
+ /**
+ * @ngdoc function
+ * @name getColumn
+ * @methodOf ui.grid.class:Grid
+ * @description returns a grid column for the column name
+ * @param {string} name column name
+ */
+ Grid.prototype.getColumn = function getColumn(name) {
+ var columns = this.columns.filter(function (column) {
+ return column.colDef.name === name;
+ });
+
+ return columns.length > 0 ? columns[0] : null;
+ };
+
+ /**
+ * @ngdoc function
+ * @name getColDef
+ * @methodOf ui.grid.class:Grid
+ * @description returns a grid colDef for the column name
+ * @param {string} name column.field
+ */
+ Grid.prototype.getColDef = function getColDef(name) {
+ var colDefs = this.options.columnDefs.filter(function (colDef) {
+ return colDef.name === name;
+ });
+ return colDefs.length > 0 ? colDefs[0] : null;
+ };
+
+ /**
+ * @ngdoc function
+ * @name assignTypes
+ * @methodOf ui.grid.class:Grid
+ * @description uses the first row of data to assign colDef.type for any types not defined.
+ */
+ /**
+ * @ngdoc property
+ * @name type
+ * @propertyOf ui.grid.class:GridOptions.columnDef
+ * @description the type of the column, used in sorting. If not provided then the
+ * grid will guess the type. Add this only if the grid guessing is not to your
+ * satisfaction. One of:
+ * - 'string'
+ * - 'boolean'
+ * - 'number'
+ * - 'date'
+ * - 'object'
+ * - 'numberStr'
+ * Note that if you choose date, your dates should be in a javascript date type
+ *
+ */
+ Grid.prototype.assignTypes = function() {
+ var self = this;
+
+ self.options.columnDefs.forEach(function (colDef, index) {
+ // Assign colDef type if not specified
+ if (!colDef.type) {
+ var col = new GridColumn(colDef, index, self);
+ var firstRow = self.rows.length > 0 ? self.rows[0] : null;
+ if (firstRow) {
+ colDef.type = gridUtil.guessType(self.getCellValue(firstRow, col));
+ }
+ else {
+ colDef.type = 'string';
+ }
+ }
+ });
+ };
+
+
+ /**
+ * @ngdoc function
+ * @name isRowHeaderColumn
+ * @methodOf ui.grid.class:Grid
+ * @description returns true if the column is a row Header
+ * @param {object} column column
+ */
+ Grid.prototype.isRowHeaderColumn = function isRowHeaderColumn(column) {
+ return this.rowHeaderColumns.indexOf(column) !== -1;
+ };
+
+ /**
+ * @ngdoc function
+ * @name addRowHeaderColumn
+ * @methodOf ui.grid.class:Grid
+ * @description adds a row header column to the grid
+ * @param {object} colDef Column definition object.
+ * @param {float} order Number that indicates where the column should be placed in the grid.
+ * @param {boolean} stopColumnBuild Prevents the buildColumn callback from being triggered. This is useful to improve
+ * performance of the grid during initial load.
+ */
+ Grid.prototype.addRowHeaderColumn = function addRowHeaderColumn(colDef, order, stopColumnBuild) {
+ var self = this;
+
+ // default order
+ if (order === undefined) {
+ order = 0;
+ }
+
+ var rowHeaderCol = new GridColumn(colDef, gridUtil.nextUid(), self);
+ rowHeaderCol.isRowHeader = true;
+ if (self.isRTL()) {
+ self.createRightContainer();
+ rowHeaderCol.renderContainer = 'right';
+ }
+ else {
+ self.createLeftContainer();
+ rowHeaderCol.renderContainer = 'left';
+ }
+
+ // relies on the default column builder being first in array, as it is instantiated
+ // as part of grid creation
+ self.columnBuilders[0](colDef,rowHeaderCol,self.options)
+ .then(function() {
+ rowHeaderCol.enableFiltering = false;
+ rowHeaderCol.enableSorting = false;
+ rowHeaderCol.enableHiding = false;
+ rowHeaderCol.headerPriority = order;
+ self.rowHeaderColumns.push(rowHeaderCol);
+ self.rowHeaderColumns = self.rowHeaderColumns.sort(function (a, b) {
+ return a.headerPriority - b.headerPriority;
+ });
+
+ if (!stopColumnBuild) {
+ self.buildColumns()
+ .then(function() {
+ self.preCompileCellTemplates();
+ self.queueGridRefresh();
+ }).catch(angular.noop);
+ }
+ }).catch(angular.noop);
+ };
+
+ /**
+ * @ngdoc function
+ * @name getOnlyDataColumns
+ * @methodOf ui.grid.class:Grid
+ * @description returns all columns except for rowHeader columns
+ */
+ Grid.prototype.getOnlyDataColumns = function getOnlyDataColumns() {
+ var self = this,
+ cols = [];
+
+ self.columns.forEach(function (col) {
+ if (self.rowHeaderColumns.indexOf(col) === -1) {
+ cols.push(col);
+ }
+ });
+ return cols;
+ };
+
+ /**
+ * @ngdoc function
+ * @name buildColumns
+ * @methodOf ui.grid.class:Grid
+ * @description creates GridColumn objects from the columnDefinition. Calls each registered
+ * columnBuilder to further process the column
+ * @param {object} opts An object contains options to use when building columns
+ *
+ * * **orderByColumnDefs**: defaults to **false**. When true, `buildColumns` will reorder existing columns according to the order within the column definitions.
+ *
+ * @returns {Promise} a promise to load any needed column resources
+ */
+ Grid.prototype.buildColumns = function buildColumns(opts) {
+ var options = {
+ orderByColumnDefs: false
+ };
+
+ angular.extend(options, opts);
+
+ // gridUtil.logDebug('buildColumns');
+ var self = this;
+ var builderPromises = [];
+ var headerOffset = self.rowHeaderColumns.length;
+ var i;
+
+ // Remove any columns for which a columnDef cannot be found
+ // Deliberately don't use forEach, as it doesn't like splice being called in the middle
+ // Also don't cache columns.length, as it will change during this operation
+ for (i = 0; i < self.columns.length; i++) {
+ if (!self.getColDef(self.columns[i].name)) {
+ self.columns.splice(i, 1);
+ i--;
+ }
+ }
+
+ // add row header columns to the grid columns array _after_ columns without columnDefs have been removed
+ // rowHeaderColumns is ordered by priority so insert in reverse
+ for (var j = self.rowHeaderColumns.length - 1; j >= 0; j--) {
+ self.columns.unshift(self.rowHeaderColumns[j]);
+ }
+
+ // look at each column def, and update column properties to match. If the column def
+ // doesn't have a column, then splice in a new gridCol
+ self.options.columnDefs.forEach(function (colDef, index) {
+ self.preprocessColDef(colDef);
+ var col = self.getColumn(colDef.name);
+
+ if (!col) {
+ col = new GridColumn(colDef, gridUtil.nextUid(), self);
+ self.columns.splice(index + headerOffset, 0, col);
+ }
+ else {
+ // tell updateColumnDef that the column was pre-existing
+ col.updateColumnDef(colDef, false);
+ }
+
+ self.columnBuilders.forEach(function (builder) {
+ builderPromises.push(builder.call(self, colDef, col, self.options));
+ });
+ });
+
+ /*** Reorder columns if necessary ***/
+ if (!!options.orderByColumnDefs) {
+ // Create a shallow copy of the columns as a cache
+ var columnCache = self.columns.slice(0);
+
+ // We need to allow for the "row headers" when mapping from the column defs array to the columns array
+ // If we have a row header in columns[0] and don't account for it we'll overwrite it with the column in columnDefs[0]
+
+ // Go through all the column defs, use the shorter of columns length and colDefs.length because if a user has given two columns the same name then
+ // columns will be shorter than columnDefs. In this situation we'll avoid an error, but the user will still get an unexpected result
+ var len = Math.min(self.options.columnDefs.length, self.columns.length);
+ for (i = 0; i < len; i++) {
+ // If the column at this index has a different name than the column at the same index in the column defs...
+ if (self.columns[i + headerOffset].name !== self.options.columnDefs[i].name) {
+ // Replace the one in the cache with the appropriate column
+ columnCache[i + headerOffset] = self.getColumn(self.options.columnDefs[i].name);
+ }
+ else {
+ // Otherwise just copy over the one from the initial columns
+ columnCache[i + headerOffset] = self.columns[i + headerOffset];
+ }
+ }
+
+ // Empty out the columns array, non-destructively
+ self.columns.length = 0;
+
+ // And splice in the updated, ordered columns from the cache
+ Array.prototype.splice.apply(self.columns, [0, 0].concat(columnCache));
+ }
+
+ return $q.all(builderPromises).then(function() {
+ if (self.rows.length > 0) {
+ self.assignTypes();
+ }
+ if (options.preCompileCellTemplates) {
+ self.preCompileCellTemplates();
+ }
+ }).catch(angular.noop);
+ };
+
+ Grid.prototype.preCompileCellTemplate = function(col) {
+ var self = this;
+ var html = col.cellTemplate.replace(uiGridConstants.MODEL_COL_FIELD, self.getQualifiedColField(col));
+ html = html.replace(uiGridConstants.COL_FIELD, 'grid.getCellValue(row, col)');
+
+ col.compiledElementFn = $compile(html);
+
+ if (col.compiledElementFnDefer) {
+ col.compiledElementFnDefer.resolve(col.compiledElementFn);
+ }
+ };
+
+/**
+ * @ngdoc function
+ * @name preCompileCellTemplates
+ * @methodOf ui.grid.class:Grid
+ * @description precompiles all cell templates
+ */
+ Grid.prototype.preCompileCellTemplates = function() {
+ var self = this;
+ self.columns.forEach(function (col) {
+ if ( col.cellTemplate ) {
+ self.preCompileCellTemplate( col );
+ } else if ( col.cellTemplatePromise ) {
+ col.cellTemplatePromise.then( function() {
+ self.preCompileCellTemplate( col );
+ }).catch(angular.noop);
+ }
+ });
+ };
+
+ /**
+ * @ngdoc function
+ * @name getGridQualifiedColField
+ * @methodOf ui.grid.class:Grid
+ * @description Returns the $parse-able accessor for a column within its $scope
+ * @param {GridColumn} col col object
+ */
+ Grid.prototype.getQualifiedColField = function (col) {
+ var base = 'row.entity';
+ if ( col.field === uiGridConstants.ENTITY_BINDING ) {
+ return base;
+ }
+ return gridUtil.preEval(base + '.' + col.field);
+ };
+
+ /**
+ * @ngdoc function
+ * @name createLeftContainer
+ * @methodOf ui.grid.class:Grid
+ * @description creates the left render container if it doesn't already exist
+ */
+ Grid.prototype.createLeftContainer = function() {
+ if (!this.hasLeftContainer()) {
+ this.renderContainers.left = new GridRenderContainer('left', this, { disableColumnOffset: true });
+ }
+ };
+
+ /**
+ * @ngdoc function
+ * @name createRightContainer
+ * @methodOf ui.grid.class:Grid
+ * @description creates the right render container if it doesn't already exist
+ */
+ Grid.prototype.createRightContainer = function() {
+ if (!this.hasRightContainer()) {
+ this.renderContainers.right = new GridRenderContainer('right', this, { disableColumnOffset: true });
+ }
+ };
+
+ /**
+ * @ngdoc function
+ * @name hasLeftContainer
+ * @methodOf ui.grid.class:Grid
+ * @description returns true if leftContainer exists
+ */
+ Grid.prototype.hasLeftContainer = function() {
+ return this.renderContainers.left !== undefined;
+ };
+
+ /**
+ * @ngdoc function
+ * @name hasRightContainer
+ * @methodOf ui.grid.class:Grid
+ * @description returns true if rightContainer exists
+ */
+ Grid.prototype.hasRightContainer = function() {
+ return this.renderContainers.right !== undefined;
+ };
+
+
+ /**
+ * undocumented function
+ * @name preprocessColDef
+ * @methodOf ui.grid.class:Grid
+ * @description defaults the name property from field to maintain backwards compatibility with 2.x
+ * validates that name or field is present
+ */
+ Grid.prototype.preprocessColDef = function preprocessColDef(colDef) {
+ var self = this;
+
+ if (!colDef.field && !colDef.name) {
+ throw new Error('colDef.name or colDef.field property is required');
+ }
+
+ // maintain backwards compatibility with 2.x
+ // field was required in 2.x. now name is required
+ if (colDef.name === undefined && colDef.field !== undefined) {
+ // See if the column name already exists:
+ var newName = colDef.field,
+ counter = 2;
+ while (self.getColumn(newName)) {
+ newName = colDef.field + counter.toString();
+ counter++;
+ }
+ colDef.name = newName;
+ }
+ };
+
+ // Return a list of items that exist in the `n` array but not the `o` array. Uses optional property accessors passed as third & fourth parameters
+ Grid.prototype.newInN = function newInN(o, n, oAccessor, nAccessor) {
+ var self = this;
+
+ var t = [];
+ for (var i = 0; i < n.length; i++) {
+ var nV = nAccessor ? n[i][nAccessor] : n[i];
+
+ var found = false;
+ for (var j = 0; j < o.length; j++) {
+ var oV = oAccessor ? o[j][oAccessor] : o[j];
+ if (self.options.rowEquality(nV, oV)) {
+ found = true;
+ break;
+ }
+ }
+ if (!found) {
+ t.push(nV);
+ }
+ }
+
+ return t;
+ };
+
+ /**
+ * @ngdoc function
+ * @name getRow
+ * @methodOf ui.grid.class:Grid
+ * @description returns the GridRow that contains the rowEntity
+ * @param {object} rowEntity the gridOptions.data array element instance
+ * @param {array} lookInRows [optional] the rows to look in - if not provided then
+ * looks in grid.rows
+ */
+ Grid.prototype.getRow = function getRow(rowEntity, lookInRows) {
+ var self = this;
+
+ lookInRows = typeof(lookInRows) === 'undefined' ? self.rows : lookInRows;
+
+ var rows = lookInRows.filter(function (row) {
+ return self.options.rowEquality(row.entity, rowEntity);
+ });
+ return rows.length > 0 ? rows[0] : null;
+ };
+
+
+ /**
+ * @ngdoc function
+ * @name modifyRows
+ * @methodOf ui.grid.class:Grid
+ * @description creates or removes GridRow objects from the newRawData array. Calls each registered
+ * rowBuilder to further process the row
+ * @param {array} newRawData Modified set of data
+ *
+ * This method aims to achieve three things:
+ * 1. the resulting rows array is in the same order as the newRawData, we'll call
+ * rowsProcessors immediately after to sort the data anyway
+ * 2. if we have row hashing available, we try to use the rowHash to find the row
+ * 3. no memory leaks - rows that are no longer in newRawData need to be garbage collected
+ *
+ * The basic logic flow makes use of the newRawData, oldRows and oldHash, and creates
+ * the newRows and newHash
+ *
+ * ```
+ * newRawData.forEach newEntity
+ * if (hashing enabled)
+ * check oldHash for newEntity
+ * else
+ * look for old row directly in oldRows
+ * if !oldRowFound // must be a new row
+ * create newRow
+ * append to the newRows and add to newHash
+ * run the processors
+ * ```
+ *
+ * Rows are identified using the hashKey if configured. If not configured, then rows
+ * are identified using the gridOptions.rowEquality function
+ *
+ * This method is useful when trying to select rows immediately after loading data without
+ * using a $timeout/$interval, e.g.:
+ *
+ * $scope.gridOptions.data = someData;
+ * $scope.gridApi.grid.modifyRows($scope.gridOptions.data);
+ * $scope.gridApi.selection.selectRow($scope.gridOptions.data[0]);
+ *
+ * OR to persist row selection after data update (e.g. rows selected, new data loaded, want
+ * originally selected rows to be re-selected))
+ */
+ Grid.prototype.modifyRows = function modifyRows(newRawData) {
+ var self = this;
+ var oldRows = self.rows.slice(0);
+ var oldRowHash = self.rowHashMap || self.createRowHashMap();
+ var allRowsSelected = true;
+ self.rowHashMap = self.createRowHashMap();
+ self.rows.length = 0;
+
+ newRawData.forEach( function( newEntity, i ) {
+ var newRow, oldRow;
+
+ if ( self.options.enableRowHashing ) {
+ // if hashing is enabled, then this row will be in the hash if we already know about it
+ oldRow = oldRowHash.get( newEntity );
+ } else {
+ // otherwise, manually search the oldRows to see if we can find this row
+ oldRow = self.getRow(newEntity, oldRows);
+ }
+
+ // update newRow to have an entity
+ if ( oldRow ) {
+ newRow = oldRow;
+ newRow.entity = newEntity;
+ }
+
+ // if we didn't find the row, it must be new, so create it
+ if ( !newRow ) {
+ newRow = self.processRowBuilders(new GridRow(newEntity, i, self));
+ }
+
+ self.rows.push( newRow );
+ self.rowHashMap.put( newEntity, newRow );
+ if (!newRow.isSelected) {
+ allRowsSelected = false;
+ }
+ });
+
+ if (self.selection && self.rows.length) {
+ self.selection.selectAll = allRowsSelected;
+ }
+
+ self.assignTypes();
+
+ var p1 = $q.when(self.processRowsProcessors(self.rows))
+ .then(function (renderableRows) {
+ return self.setVisibleRows(renderableRows);
+ }).catch(angular.noop);
+
+ var p2 = $q.when(self.processColumnsProcessors(self.columns))
+ .then(function (renderableColumns) {
+ return self.setVisibleColumns(renderableColumns);
+ }).catch(angular.noop);
+
+ return $q.all([p1, p2]);
+ };
+
+
+ /**
+ * Private Undocumented Method
+ * @name addRows
+ * @methodOf ui.grid.class:Grid
+ * @description adds the newRawData array of rows to the grid and calls all registered
+ * rowBuilders. this keyword will reference the grid
+ */
+ Grid.prototype.addRows = function addRows(newRawData) {
+ var self = this,
+ existingRowCount = self.rows.length;
+
+ for (var i = 0; i < newRawData.length; i++) {
+ var newRow = self.processRowBuilders(new GridRow(newRawData[i], i + existingRowCount, self));
+
+ if (self.options.enableRowHashing) {
+ var found = self.rowHashMap.get(newRow.entity);
+ if (found) {
+ found.row = newRow;
+ }
+ }
+
+ self.rows.push(newRow);
+ }
+ };
+
+ /**
+ * @ngdoc function
+ * @name processRowBuilders
+ * @methodOf ui.grid.class:Grid
+ * @description processes all RowBuilders for the gridRow
+ * @param {GridRow} gridRow reference to gridRow
+ * @returns {GridRow} the gridRow with all additional behavior added
+ */
+ Grid.prototype.processRowBuilders = function processRowBuilders(gridRow) {
+ var self = this;
+
+ self.rowBuilders.forEach(function (builder) {
+ builder.call(self, gridRow, self.options);
+ });
+
+ return gridRow;
+ };
+
+ /**
+ * @ngdoc function
+ * @name registerStyleComputation
+ * @methodOf ui.grid.class:Grid
+ * @description registered a styleComputation function
+ *
+ * If the function returns a value it will be appended into the grid's `"
+ );
+
+
+ $templateCache.put('ui-grid/uiGridCell',
+ " {{COL_FIELD CUSTOM_FILTERS}} "
+ );
+
+
+ $templateCache.put('ui-grid/uiGridColumnMenu',
+ ""
+ );
+
+
+ $templateCache.put('ui-grid/uiGridFooterCell',
+ " {{ col.getAggregationText() + ( col.getAggregationValue() CUSTOM_FILTERS ) }} {{ col.displayName CUSTOM_FILTERS }} {{col.sort.priority + 1}} 0\">/ {{ paginationApi.getTotalPages() }} 1 && !grid.options.useCustomPagination\"> {{sizesLabel}} {{grid.options.paginationPageSize}} {{sizesLabel}} 0\">{{ 1 + paginationApi.getFirstRowIndex() }} - {{ 1 + paginationApi.getLastRowIndex() }} {{paginationOf}} {{grid.options.totalItems}} {{totalItemsLabel}} -1 }\" tabindex=\"0\" ng-keydown=\"treeButtonKeyDown(row, $event)\" ng-click=\"treeButtonClick(row, $event)\"> "
+ );
+
+
+ $templateCache.put('ui-grid/cellTitleValidator',
+ "{{COL_FIELD CUSTOM_FILTERS}} "
+ );
+
+
+ $templateCache.put('ui-grid/cellTooltipValidator',
+ "{{COL_FIELD CUSTOM_FILTERS}} "
+ );
+
+}]);
diff --git a/release/4.9.2/ui-grid.min.css b/release/4.9.2/ui-grid.min.css
new file mode 100644
index 000000000..6a4561cc3
--- /dev/null
+++ b/release/4.9.2/ui-grid.min.css
@@ -0,0 +1,4 @@
+/*!
+ * ui-grid - v4.9.2 - 2020-12-01
+ * Copyright (c) 2020 ; License: MIT
+ */.ui-grid{border:1px solid #d4d4d4;box-sizing:content-box;-webkit-border-radius:0;-moz-border-radius:0;border-radius:0;-webkit-transform:translateZ(0);-moz-transform:translateZ(0);-o-transform:translateZ(0);-ms-transform:translateZ(0);transform:translateZ(0)}.ui-grid-vertical-bar{position:absolute;right:0;width:0}.ui-grid-header-cell:not(:last-child) .ui-grid-vertical-bar,.ui-grid-cell:not(:last-child) .ui-grid-vertical-bar{width:1px}.ui-grid-scrollbar-placeholder{background-color:transparent}.ui-grid-header-cell:not(:last-child) .ui-grid-vertical-bar{background-color:#d4d4d4}.ui-grid-cell:not(:last-child) .ui-grid-vertical-bar{background-color:#d4d4d4}.ui-grid-header-cell:last-child .ui-grid-vertical-bar{right:-1px;width:1px;background-color:#d4d4d4}.ui-grid-clearfix:before,.ui-grid-clearfix:after{content:"";display:table}.ui-grid-clearfix:after{clear:both}.ui-grid-invisible{visibility:hidden}.ui-grid-contents-wrapper{position:relative;height:100%;width:100%}.ui-grid-sr-only{position:absolute;width:1px;height:1px;margin:-1px;padding:0;overflow:hidden;clip:rect(0, 0, 0, 0);border:0}.ui-grid-icon-button{background-color:transparent;border:none;padding:0}.clickable{cursor:pointer}.ui-grid-top-panel-background{background-color:#f3f3f3}.ui-grid-header{border-bottom:1px solid #d4d4d4;box-sizing:border-box}.ui-grid-top-panel{position:relative;overflow:hidden;font-weight:bold;background-color:#f3f3f3;-webkit-border-top-right-radius:-1px;-webkit-border-bottom-right-radius:0;-webkit-border-bottom-left-radius:0;-webkit-border-top-left-radius:-1px;-moz-border-radius-topright:-1px;-moz-border-radius-bottomright:0;-moz-border-radius-bottomleft:0;-moz-border-radius-topleft:-1px;border-top-right-radius:-1px;border-bottom-right-radius:0;border-bottom-left-radius:0;border-top-left-radius:-1px;-moz-background-clip:padding-box;-webkit-background-clip:padding-box;background-clip:padding-box}.ui-grid-header-viewport{overflow:hidden}.ui-grid-header-canvas:before,.ui-grid-header-canvas:after{content:"";display:-ms-flexbox;display:flex;line-height:0}.ui-grid-header-canvas:after{clear:both}.ui-grid-header-cell-wrapper{position:relative;display:-ms-flexbox;display:flex;box-sizing:border-box;height:100%;width:100%}.ui-grid-header-cell-row{display:-ms-flexbox;display:flex;-ms-flex-direction:row;flex-direction:row;-ms-flex-wrap:wrap;flex-wrap:wrap}.ui-grid-header-cell{position:relative;box-sizing:border-box;background-color:inherit;border-right:1px solid;border-color:#d4d4d4;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;width:0}.ui-grid-header-cell:last-child{border-right:0}.ui-grid-header-cell .sortable{cursor:pointer}.ui-grid-header-cell .ui-grid-sort-priority-number{margin-left:-8px}.ui-grid-header-cell>div{-ms-flex-basis:100%;flex-basis:100%}.ui-grid-header .ui-grid-vertical-bar{top:0;bottom:0}.ui-grid-column-menu-button{position:absolute;right:1px;top:0}.ui-grid-column-menu-button .ui-grid-icon-angle-down{vertical-align:sub}.ui-grid-header-cell-last-col .ui-grid-cell-contents,.ui-grid-header-cell-last-col .ui-grid-filter-container,.ui-grid-header-cell-last-col .ui-grid-column-menu-button,.ui-grid-header-cell-last-col+.ui-grid-column-resizer.right{margin-right:13px}.ui-grid-render-container-right .ui-grid-header-cell-last-col .ui-grid-cell-contents,.ui-grid-render-container-right .ui-grid-header-cell-last-col .ui-grid-filter-container,.ui-grid-render-container-right .ui-grid-header-cell-last-col .ui-grid-column-menu-button,.ui-grid-render-container-right .ui-grid-header-cell-last-col+.ui-grid-column-resizer.right{margin-right:28px}.ui-grid-column-menu{position:absolute}.ui-grid-column-menu .ui-grid-menu .ui-grid-menu-mid.ng-hide-add,.ui-grid-column-menu .ui-grid-menu .ui-grid-menu-mid.ng-hide-remove{-webkit-transition:all .04s linear;-moz-transition:all .04s linear;-o-transition:all .04s linear;transition:all .04s linear;display:block !important}.ui-grid-column-menu .ui-grid-menu .ui-grid-menu-mid.ng-hide-add.ng-hide-add-active,.ui-grid-column-menu .ui-grid-menu .ui-grid-menu-mid.ng-hide-remove{-webkit-transform:translateY(-100%);-moz-transform:translateY(-100%);-o-transform:translateY(-100%);-ms-transform:translateY(-100%);transform:translateY(-100%)}.ui-grid-column-menu .ui-grid-menu .ui-grid-menu-mid.ng-hide-add,.ui-grid-column-menu .ui-grid-menu .ui-grid-menu-mid.ng-hide-remove.ng-hide-remove-active{-webkit-transform:translateY(0);-moz-transform:translateY(0);-o-transform:translateY(0);-ms-transform:translateY(0);transform:translateY(0)}.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid.ng-hide-add,.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid.ng-hide-remove{-webkit-transition:all .04s linear;-moz-transition:all .04s linear;-o-transition:all .04s linear;transition:all .04s linear;display:block !important}.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid.ng-hide-add.ng-hide-add-active,.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid.ng-hide-remove{-webkit-transform:translateY(-100%);-moz-transform:translateY(-100%);-o-transform:translateY(-100%);-ms-transform:translateY(-100%);transform:translateY(-100%)}.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid.ng-hide-add,.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid.ng-hide-remove.ng-hide-remove-active{-webkit-transform:translateY(0);-moz-transform:translateY(0);-o-transform:translateY(0);-ms-transform:translateY(0);transform:translateY(0)}.ui-grid-filter-container{padding:4px 10px;position:relative}.ui-grid-filter-container .ui-grid-filter-button{position:absolute;top:0;bottom:0;right:0}.ui-grid-filter-container .ui-grid-filter-button [class^="ui-grid-icon"]{position:absolute;top:50%;line-height:32px;margin-top:-16px;right:10px;opacity:.66}.ui-grid-filter-container .ui-grid-filter-button [class^="ui-grid-icon"]:hover{opacity:1}.ui-grid-filter-container .ui-grid-filter-button-select{position:absolute;top:0;bottom:0;right:0}.ui-grid-filter-container .ui-grid-filter-button-select [class^="ui-grid-icon"]{position:absolute;top:50%;line-height:32px;margin-top:-16px;right:0px;opacity:.66}.ui-grid-filter-container .ui-grid-filter-button-select [class^="ui-grid-icon"]:hover{opacity:1}input[type="text"].ui-grid-filter-input{box-sizing:border-box;padding:0 18px 0 0;margin:0;width:100%;border:1px solid #d4d4d4;-webkit-border-top-right-radius:0;-webkit-border-bottom-right-radius:0;-webkit-border-bottom-left-radius:0;-webkit-border-top-left-radius:0;-moz-border-radius-topright:0;-moz-border-radius-bottomright:0;-moz-border-radius-bottomleft:0;-moz-border-radius-topleft:0;border-top-right-radius:0;border-bottom-right-radius:0;border-bottom-left-radius:0;border-top-left-radius:0;-moz-background-clip:padding-box;-webkit-background-clip:padding-box;background-clip:padding-box}input[type="text"].ui-grid-filter-input:hover{border:1px solid #d4d4d4}select.ui-grid-filter-select{padding:0;margin:0;border:0;width:90%;border:1px solid #d4d4d4;-webkit-border-top-right-radius:0;-webkit-border-bottom-right-radius:0;-webkit-border-bottom-left-radius:0;-webkit-border-top-left-radius:0;-moz-border-radius-topright:0;-moz-border-radius-bottomright:0;-moz-border-radius-bottomleft:0;-moz-border-radius-topleft:0;border-top-right-radius:0;border-bottom-right-radius:0;border-bottom-left-radius:0;border-top-left-radius:0;-moz-background-clip:padding-box;-webkit-background-clip:padding-box;background-clip:padding-box}select.ui-grid-filter-select:hover{border:1px solid #d4d4d4}.ui-grid-filter-cancel-button-hidden select.ui-grid-filter-select{width:100%}.ui-grid-render-container{position:inherit;-webkit-border-top-right-radius:0;-webkit-border-bottom-right-radius:0;-webkit-border-bottom-left-radius:0;-webkit-border-top-left-radius:0;-moz-border-radius-topright:0;-moz-border-radius-bottomright:0;-moz-border-radius-bottomleft:0;-moz-border-radius-topleft:0;border-top-right-radius:0;border-bottom-right-radius:0;border-bottom-left-radius:0;border-top-left-radius:0;-moz-background-clip:padding-box;-webkit-background-clip:padding-box;background-clip:padding-box}.ui-grid-render-container:focus{outline:none}.ui-grid-viewport{min-height:20px;position:relative;overflow-y:scroll;-webkit-overflow-scrolling:touch}.ui-grid-viewport:focus{outline:none !important}.ui-grid-canvas{position:relative;padding-top:1px}.ui-grid-row{clear:both}.ui-grid-row:nth-child(odd) .ui-grid-cell{background-color:#fdfdfd}.ui-grid-row:nth-child(even) .ui-grid-cell{background-color:#f3f3f3}.ui-grid-row:last-child .ui-grid-cell{border-bottom-color:#d4d4d4;border-bottom-style:solid}.ui-grid-row:hover>[ui-grid-row]>.ui-grid-cell:hover .ui-grid-cell,.ui-grid-row:nth-child(odd):hover .ui-grid-cell,.ui-grid-row:nth-child(even):hover .ui-grid-cell{background-color:#d5eaee}.ui-grid-no-row-overlay{position:absolute;top:0;bottom:0;left:0;right:0;margin:10%;background-color:#f3f3f3;-webkit-border-top-right-radius:0;-webkit-border-bottom-right-radius:0;-webkit-border-bottom-left-radius:0;-webkit-border-top-left-radius:0;-moz-border-radius-topright:0;-moz-border-radius-bottomright:0;-moz-border-radius-bottomleft:0;-moz-border-radius-topleft:0;border-top-right-radius:0;border-bottom-right-radius:0;border-bottom-left-radius:0;border-top-left-radius:0;-moz-background-clip:padding-box;-webkit-background-clip:padding-box;background-clip:padding-box;border:1px solid #d4d4d4;font-size:2em;text-align:center}.ui-grid-no-row-overlay>*{position:absolute;display:table;margin:auto 0;width:100%;top:0;bottom:0;left:0;right:0;opacity:.66}.ui-grid-cell{overflow:hidden;float:left;background-color:inherit;border-right:1px solid;border-color:#d4d4d4;box-sizing:border-box}.ui-grid-cell:last-child{border-right:0}.ui-grid-cell-contents{padding:5px;-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box;white-space:nowrap;-ms-text-overflow:ellipsis;-o-text-overflow:ellipsis;text-overflow:ellipsis;overflow:hidden;height:100%}.ui-grid-cell-contents-hidden{visibility:hidden;width:0;height:0;display:none}.ui-grid-row .ui-grid-cell.ui-grid-row-header-cell{background-color:#F0F0EE;border-bottom:solid 1px #d4d4d4}.ui-grid-cell-empty{display:inline-block;width:10px;height:10px}.ui-grid-footer-info{padding:5px 10px}.ui-grid-footer-panel-background{background-color:#f3f3f3}.ui-grid-footer-panel{position:relative;border-bottom:1px solid #d4d4d4;border-top:1px solid #d4d4d4;overflow:hidden;font-weight:bold;background-color:#f3f3f3;-webkit-border-top-right-radius:-1px;-webkit-border-bottom-right-radius:0;-webkit-border-bottom-left-radius:0;-webkit-border-top-left-radius:-1px;-moz-border-radius-topright:-1px;-moz-border-radius-bottomright:0;-moz-border-radius-bottomleft:0;-moz-border-radius-topleft:-1px;border-top-right-radius:-1px;border-bottom-right-radius:0;border-bottom-left-radius:0;border-top-left-radius:-1px;-moz-background-clip:padding-box;-webkit-background-clip:padding-box;background-clip:padding-box}.ui-grid-grid-footer{float:left;width:100%}.ui-grid-footer-viewport,.ui-grid-footer-canvas{height:100%}.ui-grid-footer-viewport{overflow:hidden}.ui-grid-footer-canvas{position:relative}.ui-grid-footer-canvas:before,.ui-grid-footer-canvas:after{content:"";display:table;line-height:0}.ui-grid-footer-canvas:after{clear:both}.ui-grid-footer-cell-wrapper{position:relative;display:table;box-sizing:border-box;height:100%}.ui-grid-footer-cell-row{display:table-row}.ui-grid-footer-cell{overflow:hidden;background-color:inherit;border-right:1px solid;border-color:#d4d4d4;box-sizing:border-box;display:table-cell}.ui-grid-footer-cell:last-child{border-right:0}.ui-grid-menu-button{z-index:2;position:absolute;right:0;top:0;background:#f3f3f3;border:0;border-left:1px solid #d4d4d4;border-bottom:1px solid #d4d4d4;cursor:pointer;height:32px;font-weight:normal}.ui-grid-menu-button .ui-grid-icon-container{margin-top:5px;margin-left:2px}.ui-grid-menu-button .ui-grid-menu{right:0}.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid{overflow:scroll}.ui-grid-menu{overflow:hidden;max-width:320px;z-index:2;position:absolute;right:100%;padding:0 10px 20px 10px;cursor:pointer;box-sizing:border-box}.ui-grid-menu-item{width:100%;overflow:hidden;text-overflow:ellipsis;white-space:nowrap}.ui-grid-menu .ui-grid-menu-inner{background:#fff;border:1px solid #d4d4d4;position:relative;white-space:nowrap;-webkit-border-radius:0;-moz-border-radius:0;border-radius:0}.ui-grid-menu .ui-grid-menu-inner ul{margin:0;padding:0;list-style-type:none}.ui-grid-menu .ui-grid-menu-inner ul li{padding:0}.ui-grid-menu .ui-grid-menu-inner ul li .ui-grid-menu-item{color:#000;min-width:100%;padding:8px;text-align:left;background:transparent;border:none;cursor:default}.ui-grid-menu .ui-grid-menu-inner ul li button.ui-grid-menu-item{cursor:pointer}.ui-grid-menu .ui-grid-menu-inner ul li button.ui-grid-menu-item:hover,.ui-grid-menu .ui-grid-menu-inner ul li button.ui-grid-menu-item:focus{background-color:#b3c4c7}.ui-grid-menu .ui-grid-menu-inner ul li button.ui-grid-menu-item.ui-grid-menu-item-active{background-color:#9cb2b6}.ui-grid-menu .ui-grid-menu-inner ul li:not(:last-child)>.ui-grid-menu-item{border-bottom:1px solid #d4d4d4}.ui-grid-sortarrow{right:5px;position:absolute;width:20px;top:0;bottom:0;background-position:center}.ui-grid-sortarrow.down{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-o-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}@font-face{font-family:'ui-grid';src:url('fonts/ui-grid.eot');src:url('fonts/ui-grid.eot#iefix') format('embedded-opentype'),url('fonts/ui-grid.woff') format('woff'),url('fonts/ui-grid.ttf') format('truetype'),url('fonts/ui-grid.svg?#ui-grid') format('svg');font-weight:normal;font-style:normal}[class^="ui-grid-icon"]:before,[class*=" ui-grid-icon"]:before{font-family:"ui-grid";font-style:normal;font-weight:normal;speak:none;display:inline-block;text-decoration:inherit;width:1em;margin-right:.2em;text-align:center;font-variant:normal;text-transform:none;line-height:1em;margin-left:.2em}.ui-grid-icon-blank::before{width:1em;content:' '}.ui-grid-icon-plus-squared:before{content:'\c350'}.ui-grid-icon-minus-squared:before{content:'\c351'}.ui-grid-icon-search:before{content:'\c352'}.ui-grid-icon-cancel:before{content:'\c353'}.ui-grid-icon-info-circled:before{content:'\c354'}.ui-grid-icon-lock:before{content:'\c355'}.ui-grid-icon-lock-open:before{content:'\c356'}.ui-grid-icon-pencil:before{content:'\c357'}.ui-grid-icon-down-dir:before{content:'\c358'}.ui-grid-icon-up-dir:before{content:'\c359'}.ui-grid-icon-left-dir:before{content:'\c35a'}.ui-grid-icon-right-dir:before{content:'\c35b'}.ui-grid-icon-left-open:before{content:'\c35c'}.ui-grid-icon-right-open:before{content:'\c35d'}.ui-grid-icon-angle-down:before{content:'\c35e'}.ui-grid-icon-filter:before{content:'\c35f'}.ui-grid-icon-sort-alt-up:before{content:'\c360'}.ui-grid-icon-sort-alt-down:before{content:'\c361'}.ui-grid-icon-ok:before{content:'\c362'}.ui-grid-icon-menu:before{content:'\c363'}.ui-grid-icon-indent-left:before{content:'\e800'}.ui-grid-icon-indent-right:before{content:'\e801'}.ui-grid-icon-spin5:before{content:'\ea61'}.ui-grid[dir=rtl] .ui-grid-header-cell,.ui-grid[dir=rtl] .ui-grid-footer-cell,.ui-grid[dir=rtl] .ui-grid-cell{float:right !important}.ui-grid[dir=rtl] .ui-grid-column-menu-button{position:absolute;left:1px;top:0;right:inherit}.ui-grid[dir=rtl] .ui-grid-cell:first-child,.ui-grid[dir=rtl] .ui-grid-header-cell:first-child,.ui-grid[dir=rtl] .ui-grid-footer-cell:first-child{border-right:0}.ui-grid[dir=rtl] .ui-grid-cell:last-child,.ui-grid[dir=rtl] .ui-grid-header-cell:last-child{border-right:1px solid #d4d4d4;border-left:0}.ui-grid[dir=rtl] .ui-grid-header-cell:first-child .ui-grid-vertical-bar,.ui-grid[dir=rtl] .ui-grid-footer-cell:first-child .ui-grid-vertical-bar,.ui-grid[dir=rtl] .ui-grid-cell:first-child .ui-grid-vertical-bar{width:0}.ui-grid[dir=rtl] .ui-grid-menu-button{z-index:2;position:absolute;left:0;right:auto;background:#f3f3f3;border:1px solid #d4d4d4;cursor:pointer;min-height:27px;font-weight:normal}.ui-grid[dir=rtl] .ui-grid-menu-button .ui-grid-menu{left:0;right:auto}.ui-grid[dir=rtl] .ui-grid-filter-container .ui-grid-filter-button{right:initial;left:0}.ui-grid[dir=rtl] .ui-grid-filter-container .ui-grid-filter-button [class^="ui-grid-icon"]{right:initial;left:10px}.ui-grid-animate-spin{-moz-animation:ui-grid-spin 2s infinite linear;-o-animation:ui-grid-spin 2s infinite linear;-webkit-animation:ui-grid-spin 2s infinite linear;animation:ui-grid-spin 2s infinite linear;display:inline-block}@-moz-keyframes ui-grid-spin{0%{-moz-transform:rotate(0deg);-o-transform:rotate(0deg);-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-moz-transform:rotate(359deg);-o-transform:rotate(359deg);-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@-webkit-keyframes ui-grid-spin{0%{-moz-transform:rotate(0deg);-o-transform:rotate(0deg);-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-moz-transform:rotate(359deg);-o-transform:rotate(359deg);-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@-o-keyframes ui-grid-spin{0%{-moz-transform:rotate(0deg);-o-transform:rotate(0deg);-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-moz-transform:rotate(359deg);-o-transform:rotate(359deg);-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@-ms-keyframes ui-grid-spin{0%{-moz-transform:rotate(0deg);-o-transform:rotate(0deg);-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-moz-transform:rotate(359deg);-o-transform:rotate(359deg);-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes ui-grid-spin{0%{-moz-transform:rotate(0deg);-o-transform:rotate(0deg);-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-moz-transform:rotate(359deg);-o-transform:rotate(359deg);-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.ui-grid-cell-focus{outline:0;background-color:#b3c4c7}.ui-grid-focuser{position:absolute;left:0;top:0;z-index:-1;width:100%;height:100%}.ui-grid-focuser:focus{border-color:#66afe9;outline:0;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 8px rgba(102,175,233,0.6);box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 8px rgba(102,175,233,0.6)}.ui-grid-offscreen{display:block;position:absolute;left:-10000px;top:-10000px;clip:rect(0, 0, 0, 0)}.ui-grid-cell input{border-radius:inherit;padding:0;width:100%;color:inherit;height:auto;font:inherit;outline:none}.ui-grid-cell input:focus{color:inherit;outline:none}.ui-grid-cell input[type="checkbox"]{margin:9px 0 0 6px;width:auto}.ui-grid-cell input.ng-invalid{border:1px solid #fc8f8f}.ui-grid-cell input.ng-valid{border:1px solid #d4d4d4}.ui-grid-viewport .ui-grid-empty-base-layer-container{position:absolute;overflow:hidden;pointer-events:none;z-index:-1}.expandableRow .ui-grid-row:nth-child(odd) .ui-grid-cell{background-color:#fdfdfd}.expandableRow .ui-grid-row:nth-child(even) .ui-grid-cell{background-color:#f3f3f3}.ui-grid-cell.ui-grid-disable-selection.ui-grid-row-header-cell{pointer-events:none}.ui-grid-expandable-buttons-cell i{pointer-events:all}.scrollFiller{float:left;border:1px solid #d4d4d4}.ui-grid-tree-header-row{font-weight:bold !important}.movingColumn{position:absolute;top:0;border:1px solid #d4d4d4;box-shadow:inset 0 0 14px rgba(0,0,0,0.2)}.movingColumn .ui-grid-icon-angle-down{display:none}.ui-grid-pager-panel{display:flex;justify-content:space-between;align-items:center;position:absolute;left:0;bottom:0;width:100%;padding-top:3px;padding-bottom:3px;box-sizing:content-box}.ui-grid-pager-container{float:left}.ui-grid-pager-control{padding:5px 0;display:flex;flex-flow:row nowrap;align-items:center;margin-right:10px;margin-left:10px;min-width:135px;float:left}.ui-grid-pager-control button,.ui-grid-pager-control span,.ui-grid-pager-control input{margin-right:4px}.ui-grid-pager-control button{height:25px;min-width:26px;display:inline-block;margin-bottom:0;font-weight:normal;text-align:center;vertical-align:middle;touch-action:manipulation;cursor:pointer;background:#f3f3f3;border:1px solid #ccc;white-space:nowrap;padding:6px 12px;font-size:14px;line-height:1.42857143;border-radius:4px;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;color:#eee}.ui-grid-pager-control button:hover{border-color:#adadad;text-decoration:none}.ui-grid-pager-control button:focus{border-color:#8c8c8c;text-decoration:none;outline:5px auto -webkit-focus-ring-color;outline-offset:-2px}.ui-grid-pager-control button:active{border-color:#adadad;outline:0;-webkit-box-shadow:inset 0 3px 5px rgba(0,0,0,0.125);box-shadow:inset 0 3px 5px rgba(0,0,0,0.125)}.ui-grid-pager-control button:active:focus{outline:5px auto -webkit-focus-ring-color;outline-offset:-2px}.ui-grid-pager-control button:active:hover,.ui-grid-pager-control button:active:focus{background-color:#c8c8c8;border-color:#8c8c8c}.ui-grid-pager-control button:hover,.ui-grid-pager-control button:focus,.ui-grid-pager-control button:active{color:#eee;background:#dadada}.ui-grid-pager-control button[disabled]{cursor:not-allowed;opacity:.65;filter:alpha(opacity=65);-webkit-box-shadow:none;box-shadow:none}.ui-grid-pager-control button[disabled]:hover,.ui-grid-pager-control button[disabled]:focus{background-color:#f3f3f3;border-color:#ccc}.ui-grid-pager-control input{display:inline;height:26px;width:50px;vertical-align:top;color:#555555;background:#fff;border:1px solid #ccc;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);-webkit-transition:border-color ease-in-out .15s,box-shadow ease-in-out .15s;-o-transition:border-color ease-in-out .15s,box-shadow ease-in-out .15s;transition:border-color ease-in-out .15s,box-shadow ease-in-out .15s;padding:5px 10px;font-size:12px;line-height:1.5;border-radius:3px}.ui-grid-pager-control input:focus{border-color:#66afe9;outline:0;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 8px rgba(102,175,233,0.6);box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 8px rgba(102,175,233,0.6)}.ui-grid-pager-control input[disabled],.ui-grid-pager-control input[readonly],.ui-grid-pager-control input::-moz-placeholder{opacity:1}.ui-grid-pager-control input::-moz-placeholder,.ui-grid-pager-control input:-ms-input-placeholder,.ui-grid-pager-control input::-webkit-input-placeholder{color:#999}.ui-grid-pager-control input::-ms-expand{border:0;background-color:transparent}.ui-grid-pager-control input[disabled],.ui-grid-pager-control input[readonly]{background-color:#eeeeee}.ui-grid-pager-control input[disabled]{cursor:not-allowed}.ui-grid-pager-control .ui-grid-pager-max-pages-number{vertical-align:bottom}.ui-grid-pager-control .ui-grid-pager-max-pages-number>*{vertical-align:bottom}.ui-grid-pager-control .ui-grid-pager-max-pages-number abbr{border-bottom:none;text-decoration:none}.ui-grid-pager-control .first-bar{width:10px;border-left:2px solid #4d4d4d;margin-top:-6px;height:12px;margin-left:-3px}.ui-grid-pager-control .first-bar-rtl{width:10px;border-left:2px solid #4d4d4d;margin-top:-6px;height:12px;margin-right:-7px}.ui-grid-pager-control .first-triangle{width:0;height:0;border-style:solid;border-width:5px 8.7px 5px 0;border-color:transparent #4d4d4d transparent transparent;margin-left:2px}.ui-grid-pager-control .next-triangle{margin-left:1px}.ui-grid-pager-control .prev-triangle{margin-left:0}.ui-grid-pager-control .last-triangle{width:0;height:0;border-style:solid;border-width:5px 0 5px 8.7px;border-color:transparent transparent transparent #4d4d4d;margin-left:-1px}.ui-grid-pager-control .last-bar{width:10px;border-left:2px solid #4d4d4d;margin-top:-6px;height:12px;margin-left:1px}.ui-grid-pager-control .last-bar-rtl{width:10px;border-left:2px solid #4d4d4d;margin-top:-6px;height:12px;margin-right:-11px}.ui-grid-pager-row-count-picker{float:left;padding:5px 10px}.ui-grid-pager-row-count-picker select{color:#555555;background:#fff;border:1px solid #ccc;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);-webkit-transition:border-color ease-in-out .15s,box-shadow ease-in-out .15s;-o-transition:border-color ease-in-out .15s,box-shadow ease-in-out .15s;transition:border-color ease-in-out .15s,box-shadow ease-in-out .15s;padding:5px 10px;font-size:12px;line-height:1.5;border-radius:3px;height:25px;width:67px;display:inline;vertical-align:middle}.ui-grid-pager-row-count-picker select:focus{border-color:#66afe9;outline:0;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 8px rgba(102,175,233,0.6);box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 8px rgba(102,175,233,0.6)}.ui-grid-pager-row-count-picker select[disabled],.ui-grid-pager-row-count-picker select[readonly],.ui-grid-pager-row-count-picker select::-moz-placeholder{opacity:1}.ui-grid-pager-row-count-picker select::-moz-placeholder,.ui-grid-pager-row-count-picker select:-ms-input-placeholder,.ui-grid-pager-row-count-picker select::-webkit-input-placeholder{color:#999}.ui-grid-pager-row-count-picker select::-ms-expand{border:0;background-color:transparent}.ui-grid-pager-row-count-picker select[disabled],.ui-grid-pager-row-count-picker select[readonly]{background-color:#eeeeee}.ui-grid-pager-row-count-picker select[disabled]{cursor:not-allowed}.ui-grid-pager-row-count-picker .ui-grid-pager-row-count-label{margin-top:3px}.ui-grid-pager-count-container{float:right;margin-top:4px;min-width:50px}.ui-grid-pager-count-container .ui-grid-pager-count{margin-right:10px;margin-left:10px;float:right}.ui-grid-pager-count-container .ui-grid-pager-count abbr{border-bottom:none;text-decoration:none}.ui-grid-pinned-container{position:absolute;display:inline;top:0}.ui-grid-pinned-container.ui-grid-pinned-container-left{float:left;left:0}.ui-grid-pinned-container.ui-grid-pinned-container-right{float:right;right:0}.ui-grid-pinned-container.ui-grid-pinned-container-left .ui-grid-header-cell:last-child{box-sizing:border-box;border-right:1px solid;border-width:1px;border-right-color:#aeaeae}.ui-grid-pinned-container.ui-grid-pinned-container-left .ui-grid-cell:last-child{box-sizing:border-box;border-right:1px solid;border-width:1px;border-right-color:#aeaeae}.ui-grid-pinned-container.ui-grid-pinned-container-left .ui-grid-header-cell:not(:last-child) .ui-grid-vertical-bar,.ui-grid-pinned-container .ui-grid-cell:not(:last-child) .ui-grid-vertical-bar{width:1px}.ui-grid-pinned-container.ui-grid-pinned-container-left .ui-grid-header-cell:not(:last-child) .ui-grid-vertical-bar{background-color:#d4d4d4}.ui-grid-pinned-container.ui-grid-pinned-container-left .ui-grid-cell:not(:last-child) .ui-grid-vertical-bar{background-color:#aeaeae}.ui-grid-pinned-container.ui-grid-pinned-container-left .ui-grid-header-cell:last-child .ui-grid-vertical-bar{right:-1px;width:1px;background-color:#aeaeae}.ui-grid-pinned-container.ui-grid-pinned-container-right .ui-grid-header-cell:first-child{box-sizing:border-box;border-left:1px solid;border-width:1px;border-left-color:#aeaeae}.ui-grid-pinned-container.ui-grid-pinned-container-right .ui-grid-cell:first-child{box-sizing:border-box;border-left:1px solid;border-width:1px;border-left-color:#aeaeae}.ui-grid-pinned-container.ui-grid-pinned-container-right .ui-grid-header-cell:not(:first-child) .ui-grid-vertical-bar,.ui-grid-pinned-container .ui-grid-cell:not(:first-child) .ui-grid-vertical-bar{width:1px}.ui-grid-pinned-container.ui-grid-pinned-container-right .ui-grid-header-cell:not(:first-child) .ui-grid-vertical-bar{background-color:#d4d4d4}.ui-grid-pinned-container.ui-grid-pinned-container-right .ui-grid-cell:not(:last-child) .ui-grid-vertical-bar{background-color:#aeaeae}.ui-grid-pinned-container.ui-grid-pinned-container-first .ui-grid-header-cell:first-child .ui-grid-vertical-bar{left:-1px;width:1px;background-color:#aeaeae}.ui-grid-column-resizer{top:0;bottom:0;width:5px;position:absolute;cursor:col-resize}.ui-grid-column-resizer.left{left:0}.ui-grid-column-resizer.right{right:0}.ui-grid-header-cell:last-child .ui-grid-column-resizer.right{border-right:1px solid #d4d4d4}.ui-grid[dir=rtl] .ui-grid-header-cell:last-child .ui-grid-column-resizer.right{border-right:0}.ui-grid[dir=rtl] .ui-grid-header-cell:last-child .ui-grid-column-resizer.left{border-left:1px solid #d4d4d4}.ui-grid.column-resizing{cursor:col-resize;-webkit-touch-callout:none;-webkit-user-select:none;-khtml-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}.ui-grid.column-resizing .ui-grid-resize-overlay{position:absolute;top:0;height:100%;width:1px;background-color:#aeaeae}.ui-grid-row-saving .ui-grid-cell{color:#848484 !important}.ui-grid-row-dirty .ui-grid-cell{color:#610B38}.ui-grid-row-error .ui-grid-cell{color:#FF0000 !important}.ui-grid-row.ui-grid-row-selected>[ui-grid-row]>.ui-grid-cell{background-color:#C9DDE1}.ui-grid-disable-selection{-webkit-touch-callout:none;-webkit-user-select:none;-khtml-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;cursor:default}.ui-grid-selection-row-header-buttons{display:flex;align-items:center;height:100%;cursor:pointer}.ui-grid-selection-row-header-buttons::before{opacity:.1}.ui-grid-selection-row-header-buttons.ui-grid-row-selected::before,.ui-grid-selection-row-header-buttons.ui-grid-all-selected::before{opacity:1}.ui-grid-tree-row-header-buttons.ui-grid-tree-header{cursor:pointer;opacity:1}.ui-grid-tree-header-row{font-weight:bold !important}.ui-grid-tree-header-row .ui-grid-cell.ui-grid-disable-selection.ui-grid-row-header-cell{pointer-events:all}.ui-grid-cell-contents.invalid{border:1px solid #fc8f8f}
\ No newline at end of file
diff --git a/release/4.9.2/ui-grid.min.js b/release/4.9.2/ui-grid.min.js
new file mode 100644
index 000000000..e4e6be6fd
--- /dev/null
+++ b/release/4.9.2/ui-grid.min.js
@@ -0,0 +1,7 @@
+/*!
+ * ui-grid - v4.9.2 - 2020-12-01
+ * Copyright (c) 2020 ; License: MIT
+ */
+
+
+!function(){"use strict";angular.module("ui.grid.i18n",[]),angular.module("ui.grid",["ui.grid.i18n"])}(),function(){"use strict";angular.module("ui.grid.autoResize",["ui.grid"]).directive("uiGridAutoResize",["gridUtil",function(i){return{require:"uiGrid",scope:!1,link:function(e,n,t,o){var r;r=i.debounce(function(e,t,r,i){null!==n[0].offsetParent&&(o.grid.gridWidth=r,o.grid.gridHeight=i,o.grid.queueGridRefresh().then(function(){o.grid.api.core.raise.gridDimensionChanged(t,e,i,r)}))},400),e.$watchCollection(function(){return{width:i.elementWidth(n),height:i.elementHeight(n)}},function(e,t){angular.equals(e,t)||r(t.width,t.height,e.width,e.height)})}}}])}(),function(){"use strict";var e=angular.module("ui.grid.cellNav",["ui.grid"]);e.constant("uiGridCellNavConstants",{FEATURE_NAME:"gridCellNav",CELL_NAV_EVENT:"cellNav",direction:{LEFT:0,RIGHT:1,UP:2,DOWN:3,PG_UP:4,PG_DOWN:5},EVENT_TYPE:{KEYDOWN:0,CLICK:1,CLEAR:2}}),e.factory("uiGridCellNavFactory",["gridUtil","uiGridConstants","uiGridCellNavConstants","GridRowColumn","$q",function(e,t,i,l,r){var n=function(e,t,r,i){this.rows=e.visibleRowCache,this.columns=t.visibleColumnCache,this.leftColumns=r?r.visibleColumnCache:[],this.rightColumns=i?i.visibleColumnCache:[],this.bodyContainer=e};return n.prototype.getFocusableCols=function(){return this.leftColumns.concat(this.columns,this.rightColumns).filter(function(e){return e.colDef.allowCellFocus})},n.prototype.getFocusableRows=function(){return this.rows.filter(function(e){return!1!==e.allowCellFocus})},n.prototype.getNextRowCol=function(e,t,r){switch(e){case i.direction.LEFT:return this.getRowColLeft(t,r);case i.direction.RIGHT:return this.getRowColRight(t,r);case i.direction.UP:return this.getRowColUp(t,r);case i.direction.DOWN:return this.getRowColDown(t,r);case i.direction.PG_UP:return this.getRowColPageUp(t,r);case i.direction.PG_DOWN:return this.getRowColPageDown(t,r)}},n.prototype.initializeSelection=function(){var e=this.getFocusableCols(),t=this.getFocusableRows();return 0===e.length||0===t.length?null:new l(t[0],e[0])},n.prototype.getRowColLeft=function(e,t){var r=this.getFocusableCols(),i=this.getFocusableRows(),n=r.indexOf(t),o=i.indexOf(e);-1===n&&(n=1);var a=0===n?r.length-1:n-1;return new l(n<=a?0===o?e:i[o-1]:e,r[a])},n.prototype.getRowColRight=function(e,t){var r=this.getFocusableCols(),i=this.getFocusableRows(),n=r.indexOf(t),o=i.indexOf(e);-1===n&&(n=0);var a=n===r.length-1?0:n+1;return a<=n?o===i.length-1?new l(e,r[a]):new l(i[o+1],r[a]):new l(e,r[a])},n.prototype.getRowColDown=function(e,t){var r=this.getFocusableCols(),i=this.getFocusableRows(),n=r.indexOf(t),o=i.indexOf(e);return-1===n&&(n=0),o===i.length-1?new l(e,r[n]):new l(i[o+1],r[n])},n.prototype.getRowColPageDown=function(e,t){var r=this.getFocusableCols(),i=this.getFocusableRows(),n=r.indexOf(t),o=i.indexOf(e);-1===n&&(n=0);var a=this.bodyContainer.minRowsToRender();return o>=i.length-a?new l(i[i.length-1],r[n]):new l(i[o+a],r[n])},n.prototype.getRowColUp=function(e,t){var r=this.getFocusableCols(),i=this.getFocusableRows(),n=r.indexOf(t),o=i.indexOf(e);return-1===n&&(n=0),new l(0===o?e:i[o-1],r[n])},n.prototype.getRowColPageUp=function(e,t){var r=this.getFocusableCols(),i=this.getFocusableRows(),n=r.indexOf(t),o=i.indexOf(e);-1===n&&(n=0);var a=this.bodyContainer.minRowsToRender();return new l(o-a<0?i[0]:i[o-a],r[n])},n}]),e.service("uiGridCellNavService",["gridUtil","uiGridConstants","uiGridCellNavConstants","$q","uiGridCellNavFactory","GridRowColumn","ScrollEvent",function(e,t,r,i,n,o,a){var l={initializeGrid:function(i){i.registerColumnBuilder(l.cellNavColumnBuilder),i.cellNav={},i.cellNav.lastRowCol=null,i.cellNav.focusedCells=[],l.defaultGridOptions(i.options);var e={events:{cellNav:{navigate:function(e,t){},viewPortKeyDown:function(e,t){},viewPortKeyPress:function(e,t){}}},methods:{cellNav:{scrollToFocus:function(e,t){return l.scrollToFocus(i,e,t)},getFocusedCell:function(){return i.cellNav.lastRowCol},getCurrentSelection:function(){return i.cellNav.focusedCells},rowColSelectIndex:function(e){for(var t=-1,r=0;r')[0],r="reverse";return document.body.appendChild(t),0 "}),n.trustAsHtml(" "+o.getSafeText("validate.error")+" "+r)},getTitleFormattedErrors:function(e,t){var r="",i=c.getErrorMessages(e,t);if(i.length)return i.forEach(function(e){r+=e+"\n"}),n.trustAsHtml(o.getSafeText("validate.error")+"\n"+r)},runValidators:function(e,t,n,o,a){if(n!==o){if(void 0===t.name||!t.name)throw new Error("colDef.name is required to perform validation");c.setValid(e,t);var r=function(t,r,i){return function(e){e||(c.setInvalid(t,r),c.setError(t,r,i),a&&a.api.validate.raise.validationFailed(t,r,n,o))}},i=[];for(var l in t.validators){c.clearError(e,t,l);var s=c.getValidator(l,t.validators[l]),d=u.when(s(o,n,e,t)).then(r(e,t,l));i.push(d)}return u.all(i)}},createDefaultValidators:function(){c.setValidator("minLength",function(r){return function(e,t){return null==t||""===t||t.length>=r}},function(e){return o.getSafeText("validate.minLength").replace("THRESHOLD",e)}),c.setValidator("maxLength",function(r){return function(e,t){return null==t||""===t||t.length<=r}},function(e){return o.getSafeText("validate.maxLength").replace("THRESHOLD",e)}),c.setValidator("required",function(r){return function(e,t){return!r||!(null==t||""===t)}},function(){return o.getSafeText("validate.required")})},initializeGrid:function(e,n){n.validate={isInvalid:c.isInvalid,getErrorMessages:c.getErrorMessages,getFormattedErrors:c.getFormattedErrors,getTitleFormattedErrors:c.getTitleFormattedErrors,runValidators:c.runValidators};var t={events:{validate:{validationFailed:function(e,t,r,i){}}},methods:{validate:{isInvalid:function(e,t){return n.validate.isInvalid(e,t)},getErrorMessages:function(e,t){return n.validate.getErrorMessages(e,t)},getFormattedErrors:function(e,t){return n.validate.getFormattedErrors(e,t)},getTitleFormattedErrors:function(e,t){return n.validate.getTitleFormattedErrors(e,t)}}}};n.api.registerEventsFromObject(t.events),n.api.registerMethodsFromObject(t.methods),n.edit&&n.api.edit.on.afterCellEdit(e,function(e,t,r,i){n.validate.runValidators(e,t,r,i,n)}),c.createDefaultValidators()}};return c}]),e.directive("uiGridValidate",["gridUtil","uiGridValidateService",function(e,n){return{priority:0,replace:!0,require:"^uiGrid",scope:!1,compile:function(){return{pre:function(e,t,r,i){n.initializeGrid(e,i.grid)},post:function(e,t,r,i){}}}}}])}(),angular.module("ui.grid").run(["$templateCache",function(e){"use strict";e.put("ui-grid/ui-grid-filter",'\x3c!-- tfooter --\x3e '),e.put("ui-grid/ui-grid-grid-footer",'{{\'search.totalItems\' | t}} {{grid.rows.length}} ({{"search.showingItems" | t}} {{grid.renderContainers.body.visibleRowCache.length}}) '),e.put("ui-grid/ui-grid-header",'\x3c!-- theader --\x3e '),e.put("ui-grid/ui-grid-menu-button",'\x3c!-- TODO (c0bra): add "scoped" attr here, eventually? --\x3e '),e.put("ui-grid/uiGridCell",'{{COL_FIELD CUSTOM_FILTERS}} '),e.put("ui-grid/uiGridColumnMenu",'\x3c!-- \n --\x3e\n \n
\n \n {{ col.getAggregationText() + ( col.getAggregationValue() CUSTOM_FILTERS ) }} {{ col.displayName CUSTOM_FILTERS }} {{col.sort.priority + 1}} \x3c!-- All of these dom elements are replaced in place --\x3e "),e.put("ui-grid/uiGridViewport",'\x3c!-- tbody --\x3e '),e.put("ui-grid/cellEditor",''),e.put("ui-grid/dropdownEditor",''),e.put("ui-grid/fileChooserEditor",''),e.put("ui-grid/emptyBaseLayerContainer",' / {{ paginationApi.getTotalPages() }} {{sizesLabel}} {{grid.options.paginationPageSize}} {{sizesLabel}}{{ 1 + paginationApi.getFirstRowIndex() }} - {{ 1 + paginationApi.getLastRowIndex() }} {{paginationOf}} {{grid.options.totalItems}} {{totalItemsLabel}} \x3c!-- '),e.put("ui-grid/selectionRowHeader",'{{COL_FIELD CUSTOM_FILTERS}} '),e.put("ui-grid/cellTooltipValidator",'{{COL_FIELD CUSTOM_FILTERS}} ')}]);
\ No newline at end of file
diff --git a/release/4.9.2/ui-grid.move-columns.js b/release/4.9.2/ui-grid.move-columns.js
new file mode 100644
index 000000000..c4e2f3e43
--- /dev/null
+++ b/release/4.9.2/ui-grid.move-columns.js
@@ -0,0 +1,581 @@
+/*!
+ * ui-grid - v4.9.2 - 2020-12-01
+ * Copyright (c) 2020 ; License: MIT
+ */
+
+(function () {
+ 'use strict';
+
+ /**
+ * @ngdoc overview
+ * @name ui.grid.moveColumns
+ * @description
+ *
+ * # ui.grid.moveColumns
+ *
+ * Alpha This feature is in development. There will almost certainly be breaking api changes, or there are major outstanding bugs.
+ *
+ * This module provides column moving capability to ui.grid. It enables to change the position of columns.
+ *
+ */
+ var module = angular.module('ui.grid.moveColumns', ['ui.grid']);
+
+ /**
+ * @ngdoc service
+ * @name ui.grid.moveColumns.service:uiGridMoveColumnService
+ * @description Service for column moving feature.
+ */
+ module.service('uiGridMoveColumnService', ['$q', '$rootScope', '$log', 'ScrollEvent', 'uiGridConstants', 'gridUtil', function ($q, $rootScope, $log, ScrollEvent, uiGridConstants, gridUtil) {
+ var service = {
+ initializeGrid: function (grid) {
+ var self = this;
+ this.registerPublicApi(grid);
+ this.defaultGridOptions(grid.options);
+ grid.moveColumns = {orderCache: []}; // Used to cache the order before columns are rebuilt
+ grid.registerColumnBuilder(self.movableColumnBuilder);
+ grid.registerDataChangeCallback(self.verifyColumnOrder, [uiGridConstants.dataChange.COLUMN]);
+ },
+ registerPublicApi: function (grid) {
+ var self = this;
+ /**
+ * @ngdoc object
+ * @name ui.grid.moveColumns.api:PublicApi
+ * @description Public Api for column moving feature.
+ */
+ var publicApi = {
+ events: {
+ /**
+ * @ngdoc event
+ * @name columnPositionChanged
+ * @eventOf ui.grid.moveColumns.api:PublicApi
+ * @description raised when column is moved
+ *
+ * gridApi.colMovable.on.columnPositionChanged(scope,function(colDef, originalPosition, newPosition) {})
+ *
+ * @param {object} colDef the column that was moved
+ * @param {integer} originalPosition of the column
+ * @param {integer} finalPosition of the column
+ */
+ colMovable: {
+ columnPositionChanged: function (colDef, originalPosition, newPosition) {
+ }
+ }
+ },
+ methods: {
+ /**
+ * @ngdoc method
+ * @name moveColumn
+ * @methodOf ui.grid.moveColumns.api:PublicApi
+ * @description Method can be used to change column position.
+ * + * gridApi.colMovable.moveColumn(oldPosition, newPosition) + *+ * @param {integer} originalPosition of the column + * @param {integer} finalPosition of the column + */ + colMovable: { + moveColumn: function (originalPosition, finalPosition) { + var columns = grid.columns; + if (!angular.isNumber(originalPosition) || !angular.isNumber(finalPosition)) { + gridUtil.logError('MoveColumn: Please provide valid values for originalPosition and finalPosition'); + return; + } + var nonMovableColumns = 0; + for (var i = 0; i < columns.length; i++) { + if ((angular.isDefined(columns[i].colDef.visible) && columns[i].colDef.visible === false) || columns[i].isRowHeader === true) { + nonMovableColumns++; + } + } + if (originalPosition >= (columns.length - nonMovableColumns) || finalPosition >= (columns.length - nonMovableColumns)) { + gridUtil.logError('MoveColumn: Invalid values for originalPosition, finalPosition'); + return; + } + var findPositionForRenderIndex = function (index) { + var position = index; + for (var i = 0; i <= position; i++) { + if (angular.isDefined(columns[i]) && ((angular.isDefined(columns[i].colDef.visible) && columns[i].colDef.visible === false) || columns[i].isRowHeader === true)) { + position++; + } + } + return position; + }; + self.redrawColumnAtPosition(grid, findPositionForRenderIndex(originalPosition), findPositionForRenderIndex(finalPosition)); + } + } + } + }; + grid.api.registerEventsFromObject(publicApi.events); + grid.api.registerMethodsFromObject(publicApi.methods); + }, + defaultGridOptions: function (gridOptions) { + /** + * @ngdoc object + * @name ui.grid.moveColumns.api:GridOptions + * + * @description Options for configuring the move column feature, these are available to be + * set using the ui-grid {@link ui.grid.class:GridOptions gridOptions} + */ + /** + * @ngdoc object + * @name enableColumnMoving + * @propertyOf ui.grid.moveColumns.api:GridOptions + * @description If defined, sets the default value for the colMovable flag on each individual colDefs + * if their individual enableColumnMoving configuration is not defined. Defaults to true. + */ + gridOptions.enableColumnMoving = gridOptions.enableColumnMoving !== false; + }, + movableColumnBuilder: function (colDef, col, gridOptions) { + var promises = []; + /** + * @ngdoc object + * @name ui.grid.moveColumns.api:ColumnDef + * + * @description Column Definition for move column feature, these are available to be + * set using the ui-grid {@link ui.grid.class:GridOptions.columnDef gridOptions.columnDefs} + */ + /** + * @ngdoc object + * @name enableColumnMoving + * @propertyOf ui.grid.moveColumns.api:ColumnDef + * @description Enable column moving for the column. + */ + colDef.enableColumnMoving = colDef.enableColumnMoving === undefined ? gridOptions.enableColumnMoving + : colDef.enableColumnMoving; + return $q.all(promises); + }, + /** + * @ngdoc method + * @name updateColumnCache + * @methodOf ui.grid.moveColumns + * @description Cache the current order of columns, so we can restore them after new columnDefs are defined + */ + updateColumnCache: function(grid) { + grid.moveColumns.orderCache = grid.getOnlyDataColumns(); + }, + /** + * @ngdoc method + * @name verifyColumnOrder + * @methodOf ui.grid.moveColumns + * @description dataChangeCallback which uses the cached column order to restore the column order + * when it is reset by altering the columnDefs array. + */ + verifyColumnOrder: function(grid) { + var headerRowOffset = grid.rowHeaderColumns.length; + var newIndex; + + angular.forEach(grid.moveColumns.orderCache, function(cacheCol, cacheIndex) { + newIndex = grid.columns.indexOf(cacheCol); + if ( newIndex !== -1 && newIndex - headerRowOffset !== cacheIndex ) { + var column = grid.columns.splice(newIndex, 1)[0]; + grid.columns.splice(cacheIndex + headerRowOffset, 0, column); + } + }); + }, + redrawColumnAtPosition: function (grid, originalPosition, newPosition) { + var columns = grid.columns; + + if (originalPosition === newPosition) { + return; + } + + // check columns in between move-range to make sure they are visible columns + var pos = (originalPosition < newPosition) ? originalPosition + 1 : originalPosition - 1; + var i0 = Math.min(pos, newPosition); + for (i0; i0 <= Math.max(pos, newPosition); i0++) { + if (columns[i0].visible) { + break; + } + } + if (i0 > Math.max(pos, newPosition)) { + // no visible column found, column did not visibly move + return; + } + + var originalColumn = columns[originalPosition]; + if (originalColumn.colDef.enableColumnMoving) { + if (originalPosition > newPosition) { + for (var i1 = originalPosition; i1 > newPosition; i1--) { + columns[i1] = columns[i1 - 1]; + } + } + else if (newPosition > originalPosition) { + for (var i2 = originalPosition; i2 < newPosition; i2++) { + columns[i2] = columns[i2 + 1]; + } + } + columns[newPosition] = originalColumn; + service.updateColumnCache(grid); + grid.queueGridRefresh(); + $rootScope.$applyAsync(function () { + grid.api.core.notifyDataChange( uiGridConstants.dataChange.COLUMN ); + grid.api.colMovable.raise.columnPositionChanged(originalColumn.colDef, originalPosition, newPosition); + }); + } + } + }; + return service; + }]); + + /** + * @ngdoc directive + * @name ui.grid.moveColumns.directive:uiGridMoveColumns + * @element div + * @restrict A + * @description Adds column moving features to the ui-grid directive. + * @example +
+
+
+
+
+
+ 0\">/ {{ paginationApi.getTotalPages() }} 1 && !grid.options.useCustomPagination\"> {{sizesLabel}} {{grid.options.paginationPageSize}} {{sizesLabel}} 0\">{{ 1 + paginationApi.getFirstRowIndex() }} - {{ 1 + paginationApi.getLastRowIndex() }} {{paginationOf}} {{grid.options.totalItems}} {{totalItemsLabel}} / {{ paginationApi.getTotalPages() }} {{sizesLabel}} {{grid.options.paginationPageSize}} {{sizesLabel}}{{ 1 + paginationApi.getFirstRowIndex() }} - {{ 1 + paginationApi.getLastRowIndex() }} {{paginationOf}} {{grid.options.totalItems}} {{totalItemsLabel}} Stable This feature is stable. There should no longer be breaking api changes without a deprecation warning.
+ *
+ * This module provides column pinning to the end user via menu options in the column header
+ *
+ *
+ */
+
+ var module = angular.module('ui.grid.pinning', ['ui.grid']);
+
+ module.constant('uiGridPinningConstants', {
+ container: {
+ LEFT: 'left',
+ RIGHT: 'right',
+ NONE: ''
+ }
+ });
+
+ module.service('uiGridPinningService', ['gridUtil', 'GridRenderContainer', 'i18nService', 'uiGridPinningConstants', function (gridUtil, GridRenderContainer, i18nService, uiGridPinningConstants) {
+ var service = {
+
+ initializeGrid: function (grid) {
+ service.defaultGridOptions(grid.options);
+
+ // Register a column builder to add new menu items for pinning left and right
+ grid.registerColumnBuilder(service.pinningColumnBuilder);
+
+ /**
+ * @ngdoc object
+ * @name ui.grid.pinning.api:PublicApi
+ *
+ * @description Public Api for pinning feature
+ */
+ var publicApi = {
+ events: {
+ pinning: {
+ /**
+ * @ngdoc event
+ * @name columnPinned
+ * @eventOf ui.grid.pinning.api:PublicApi
+ * @description raised when column pin state has changed
+ *
+ * gridApi.pinning.on.columnPinned(scope, function(colDef){})
+ *
+ * @param {object} colDef the column that was changed
+ * @param {string} container the render container the column is in ('left', 'right', '')
+ */
+ columnPinned: function(colDef, container) {
+ }
+ }
+ },
+ methods: {
+ pinning: {
+ /**
+ * @ngdoc function
+ * @name pinColumn
+ * @methodOf ui.grid.pinning.api:PublicApi
+ * @description pin column left, right, or none
+ * + * gridApi.pinning.pinColumn(col, uiGridPinningConstants.container.LEFT) + *+ * @param {gridColumn} col the column being pinned + * @param {string} container one of the recognised types + * from uiGridPinningConstants + */ + pinColumn: function(col, container) { + service.pinColumn(grid, col, container); + } + } + } + }; + + grid.api.registerEventsFromObject(publicApi.events); + grid.api.registerMethodsFromObject(publicApi.methods); + }, + + defaultGridOptions: function (gridOptions) { + // default option to true unless it was explicitly set to false + /** + * @ngdoc object + * @name ui.grid.pinning.api:GridOptions + * + * @description GridOptions for pinning feature, these are available to be + * set using the ui-grid {@link ui.grid.class:GridOptions gridOptions} + */ + + /** + * @ngdoc object + * @name enablePinning + * @propertyOf ui.grid.pinning.api:GridOptions + * @description Enable pinning for the entire grid. + * Defaults to true + */ + gridOptions.enablePinning = gridOptions.enablePinning !== false; + /** + * @ngdoc object + * @name hidePinLeft + * @propertyOf ui.grid.pinning.api:GridOptions + * @description Hide Pin Left for the entire grid. + * Defaults to false + */ + gridOptions.hidePinLeft = gridOptions.enablePinning && gridOptions.hidePinLeft; + /** + * @ngdoc object + * @name hidePinRight + * @propertyOf ui.grid.pinning.api:GridOptions + * @description Hide Pin Right pinning for the entire grid. + * Defaults to false + */ + gridOptions.hidePinRight = gridOptions.enablePinning && gridOptions.hidePinRight; + }, + + pinningColumnBuilder: function (colDef, col, gridOptions) { + // default to true unless gridOptions or colDef is explicitly false + + /** + * @ngdoc object + * @name ui.grid.pinning.api:ColumnDef + * + * @description ColumnDef for pinning feature, these are available to be + * set using the ui-grid {@link ui.grid.class:GridOptions.columnDef gridOptions.columnDefs} + */ + + /** + * @ngdoc object + * @name enablePinning + * @propertyOf ui.grid.pinning.api:ColumnDef + * @description Enable pinning for the individual column. + * Defaults to true + */ + colDef.enablePinning = colDef.enablePinning === undefined ? gridOptions.enablePinning : colDef.enablePinning; + /** + * @ngdoc object + * @name hidePinLeft + * @propertyOf ui.grid.pinning.api:ColumnDef + * @description Hide Pin Left for the individual column. + * Defaults to false + */ + colDef.hidePinLeft = colDef.hidePinLeft === undefined ? gridOptions.hidePinLeft : colDef.hidePinLeft; + /** + * @ngdoc object + * @name hidePinRight + * @propertyOf ui.grid.pinning.api:ColumnDef + * @description Hide Pin Right for the individual column. + * Defaults to false + */ + colDef.hidePinRight = colDef.hidePinRight === undefined ? gridOptions.hidePinRight : colDef.hidePinRight; + + /** + * @ngdoc object + * @name pinnedLeft + * @propertyOf ui.grid.pinning.api:ColumnDef + * @description Column is pinned left when grid is rendered + * Defaults to false + */ + + /** + * @ngdoc object + * @name pinnedRight + * @propertyOf ui.grid.pinning.api:ColumnDef + * @description Column is pinned right when grid is rendered + * Defaults to false + */ + if (colDef.pinnedLeft) { + col.renderContainer = 'left'; + col.grid.createLeftContainer(); + } + else if (colDef.pinnedRight) { + col.renderContainer = 'right'; + col.grid.createRightContainer(); + } + + if (!colDef.enablePinning) { + return; + } + + var pinColumnLeftAction = { + name: 'ui.grid.pinning.pinLeft', + title: i18nService.get().pinning.pinLeft, + icon: 'ui-grid-icon-left-open', + shown: function () { + return typeof(this.context.col.renderContainer) === 'undefined' || !this.context.col.renderContainer || this.context.col.renderContainer !== 'left'; + }, + action: function () { + service.pinColumn(this.context.col.grid, this.context.col, uiGridPinningConstants.container.LEFT); + } + }; + + var pinColumnRightAction = { + name: 'ui.grid.pinning.pinRight', + title: i18nService.get().pinning.pinRight, + icon: 'ui-grid-icon-right-open', + shown: function () { + return typeof(this.context.col.renderContainer) === 'undefined' || !this.context.col.renderContainer || this.context.col.renderContainer !== 'right'; + }, + action: function () { + service.pinColumn(this.context.col.grid, this.context.col, uiGridPinningConstants.container.RIGHT); + } + }; + + var removePinAction = { + name: 'ui.grid.pinning.unpin', + title: i18nService.get().pinning.unpin, + icon: 'ui-grid-icon-cancel', + shown: function () { + return typeof(this.context.col.renderContainer) !== 'undefined' && this.context.col.renderContainer !== null && this.context.col.renderContainer !== 'body'; + }, + action: function () { + service.pinColumn(this.context.col.grid, this.context.col, uiGridPinningConstants.container.NONE); + } + }; + + // Skip from menu if hidePinLeft or hidePinRight is true + if (!colDef.hidePinLeft && !gridUtil.arrayContainsObjectWithProperty(col.menuItems, 'name', 'ui.grid.pinning.pinLeft')) { + col.menuItems.push(pinColumnLeftAction); + } + if (!colDef.hidePinRight && !gridUtil.arrayContainsObjectWithProperty(col.menuItems, 'name', 'ui.grid.pinning.pinRight')) { + col.menuItems.push(pinColumnRightAction); + } + if (!gridUtil.arrayContainsObjectWithProperty(col.menuItems, 'name', 'ui.grid.pinning.unpin')) { + col.menuItems.push(removePinAction); + } + }, + + pinColumn: function(grid, col, container) { + if (container === uiGridPinningConstants.container.NONE) { + col.renderContainer = null; + col.colDef.pinnedLeft = col.colDef.pinnedRight = false; + } + else { + col.renderContainer = container; + if (container === uiGridPinningConstants.container.LEFT) { + grid.createLeftContainer(); + } + else if (container === uiGridPinningConstants.container.RIGHT) { + grid.createRightContainer(); + } + } + + grid.refresh() + .then(function() { + grid.api.pinning.raise.columnPinned( col.colDef, container ); + }); + } + }; + + return service; + }]); + + module.directive('uiGridPinning', ['gridUtil', 'uiGridPinningService', + function (gridUtil, uiGridPinningService) { + return { + require: 'uiGrid', + scope: false, + compile: function () { + return { + pre: function ($scope, $elm, $attrs, uiGridCtrl) { + uiGridPinningService.initializeGrid(uiGridCtrl.grid); + }, + post: function ($scope, $elm, $attrs, uiGridCtrl) { + } + }; + } + }; + }]); +})(); diff --git a/release/4.9.2/ui-grid.pinning.min.js b/release/4.9.2/ui-grid.pinning.min.js new file mode 100644 index 000000000..e1c7607de --- /dev/null +++ b/release/4.9.2/ui-grid.pinning.min.js @@ -0,0 +1,7 @@ +/*! + * ui-grid - v4.9.2 - 2020-12-01 + * Copyright (c) 2020 ; License: MIT + */ + + +!function(){"use strict";var n=angular.module("ui.grid.pinning",["ui.grid"]);n.constant("uiGridPinningConstants",{container:{LEFT:"left",RIGHT:"right",NONE:""}}),n.service("uiGridPinningService",["gridUtil","GridRenderContainer","i18nService","uiGridPinningConstants",function(c,n,d,u){var a={initializeGrid:function(e){a.defaultGridOptions(e.options),e.registerColumnBuilder(a.pinningColumnBuilder);var n={events:{pinning:{columnPinned:function(n,i){}}},methods:{pinning:{pinColumn:function(n,i){a.pinColumn(e,n,i)}}}};e.api.registerEventsFromObject(n.events),e.api.registerMethodsFromObject(n.methods)},defaultGridOptions:function(n){n.enablePinning=!1!==n.enablePinning,n.hidePinLeft=n.enablePinning&&n.hidePinLeft,n.hidePinRight=n.enablePinning&&n.hidePinRight},pinningColumnBuilder:function(n,i,e){if(n.enablePinning=void 0===n.enablePinning?e.enablePinning:n.enablePinning,n.hidePinLeft=void 0===n.hidePinLeft?e.hidePinLeft:n.hidePinLeft,n.hidePinRight=void 0===n.hidePinRight?e.hidePinRight:n.hidePinRight,n.pinnedLeft?(i.renderContainer="left",i.grid.createLeftContainer()):n.pinnedRight&&(i.renderContainer="right",i.grid.createRightContainer()),n.enablePinning){var t={name:"ui.grid.pinning.pinLeft",title:d.get().pinning.pinLeft,icon:"ui-grid-icon-left-open",shown:function(){return void 0===this.context.col.renderContainer||!this.context.col.renderContainer||"left"!==this.context.col.renderContainer},action:function(){a.pinColumn(this.context.col.grid,this.context.col,u.container.LEFT)}},r={name:"ui.grid.pinning.pinRight",title:d.get().pinning.pinRight,icon:"ui-grid-icon-right-open",shown:function(){return void 0===this.context.col.renderContainer||!this.context.col.renderContainer||"right"!==this.context.col.renderContainer},action:function(){a.pinColumn(this.context.col.grid,this.context.col,u.container.RIGHT)}},o={name:"ui.grid.pinning.unpin",title:d.get().pinning.unpin,icon:"ui-grid-icon-cancel",shown:function(){return void 0!==this.context.col.renderContainer&&null!==this.context.col.renderContainer&&"body"!==this.context.col.renderContainer},action:function(){a.pinColumn(this.context.col.grid,this.context.col,u.container.NONE)}};n.hidePinLeft||c.arrayContainsObjectWithProperty(i.menuItems,"name","ui.grid.pinning.pinLeft")||i.menuItems.push(t),n.hidePinRight||c.arrayContainsObjectWithProperty(i.menuItems,"name","ui.grid.pinning.pinRight")||i.menuItems.push(r),c.arrayContainsObjectWithProperty(i.menuItems,"name","ui.grid.pinning.unpin")||i.menuItems.push(o)}},pinColumn:function(n,i,e){e===u.container.NONE?(i.renderContainer=null,i.colDef.pinnedLeft=i.colDef.pinnedRight=!1):(i.renderContainer=e)===u.container.LEFT?n.createLeftContainer():e===u.container.RIGHT&&n.createRightContainer(),n.refresh().then(function(){n.api.pinning.raise.columnPinned(i.colDef,e)})}};return a}]),n.directive("uiGridPinning",["gridUtil","uiGridPinningService",function(n,r){return{require:"uiGrid",scope:!1,compile:function(){return{pre:function(n,i,e,t){r.initializeGrid(t.grid)},post:function(n,i,e,t){}}}}}])}(); \ No newline at end of file diff --git a/release/4.9.2/ui-grid.resize-columns.js b/release/4.9.2/ui-grid.resize-columns.js new file mode 100644 index 000000000..52f8b97f4 --- /dev/null +++ b/release/4.9.2/ui-grid.resize-columns.js @@ -0,0 +1,573 @@ +/*! + * ui-grid - v4.9.2 - 2020-12-01 + * Copyright (c) 2020 ; License: MIT + */ + +(function() { + 'use strict'; + + /** + * @ngdoc overview + * @name ui.grid.resizeColumns + * @description + * + * # ui.grid.resizeColumns + * + * Stable This feature is stable. There should no longer be breaking api changes without a deprecation warning.
+ *
+ * This module allows columns to be resized.
+ */
+ var module = angular.module('ui.grid.resizeColumns', ['ui.grid']);
+
+ module.service('uiGridResizeColumnsService', ['gridUtil', '$q', '$rootScope',
+ function (gridUtil, $q, $rootScope) {
+ return {
+ defaultGridOptions: function(gridOptions) {
+ // default option to true unless it was explicitly set to false
+ /**
+ * @ngdoc object
+ * @name ui.grid.resizeColumns.api:GridOptions
+ *
+ * @description GridOptions for resizeColumns feature, these are available to be
+ * set using the ui-grid {@link ui.grid.class:GridOptions gridOptions}
+ */
+
+ /**
+ * @ngdoc object
+ * @name enableColumnResizing
+ * @propertyOf ui.grid.resizeColumns.api:GridOptions
+ * @description Enable column resizing on the entire grid
+ * Defaults to true + */ + gridOptions.enableColumnResizing = gridOptions.enableColumnResizing !== false; + + // legacy support + // use old name if it is explicitly false + if (gridOptions.enableColumnResize === false) { + gridOptions.enableColumnResizing = false; + } + }, + + colResizerColumnBuilder: function (colDef, col, gridOptions) { + var promises = []; + + /** + * @ngdoc object + * @name ui.grid.resizeColumns.api:ColumnDef + * + * @description ColumnDef for resizeColumns feature, these are available to be + * set using the ui-grid {@link ui.grid.class:GridOptions.columnDef gridOptions.columnDefs} + */ + + /** + * @ngdoc object + * @name enableColumnResizing + * @propertyOf ui.grid.resizeColumns.api:ColumnDef + * @description Enable column resizing on an individual column + * Defaults to GridOptions.enableColumnResizing + */ + // default to true unless gridOptions or colDef is explicitly false + colDef.enableColumnResizing = colDef.enableColumnResizing === undefined ? gridOptions.enableColumnResizing : colDef.enableColumnResizing; + + + // legacy support of old option name + if (colDef.enableColumnResize === false) { + colDef.enableColumnResizing = false; + } + + return $q.all(promises); + }, + + registerPublicApi: function (grid) { + /** + * @ngdoc object + * @name ui.grid.resizeColumns.api:PublicApi + * @description Public Api for column resize feature. + */ + var publicApi = { + events: { + /** + * @ngdoc event + * @name columnSizeChanged + * @eventOf ui.grid.resizeColumns.api:PublicApi + * @description raised when column is resized + *
+ * gridApi.colResizable.on.columnSizeChanged(scope,function(colDef, deltaChange) {})
+ *
+ * @param {object} colDef the column that was resized
+ * @param {integer} delta of the column size change
+ */
+ colResizable: {
+ columnSizeChanged: function (colDef, deltaChange) {
+ }
+ }
+ }
+ };
+ grid.api.registerEventsFromObject(publicApi.events);
+ },
+
+ fireColumnSizeChanged: function (grid, colDef, deltaChange) {
+ $rootScope.$applyAsync(function () {
+ if ( grid.api.colResizable ) {
+ grid.api.colResizable.raise.columnSizeChanged(colDef, deltaChange);
+ } else {
+ gridUtil.logError("The resizeable api is not registered, this may indicate that you've included the module but not added the 'ui-grid-resize-columns' directive to your grid definition. Cannot raise any events.");
+ }
+ });
+ },
+
+ // get either this column, or the column next to this column, to resize,
+ // returns the column we're going to resize
+ findTargetCol: function(col, position, rtlMultiplier) {
+ var renderContainer = col.getRenderContainer();
+
+ if (position === 'left') {
+ // Get the column to the left of this one
+ var colIndex = renderContainer.visibleColumnCache.indexOf(col);
+ if (colIndex === 0) {
+ return renderContainer.visibleColumnCache[0];
+ }
+ return renderContainer.visibleColumnCache[colIndex - 1 * rtlMultiplier];
+ } else {
+ return col;
+ }
+ }
+ };
+ }]);
+
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.resizeColumns.directive:uiGridResizeColumns
+ * @element div
+ * @restrict A
+ * @description
+ * Enables resizing for all columns on the grid. If, for some reason, you want to use the ui-grid-resize-columns directive, but not allow column resizing, you can explicitly set the
+ * option to false. This prevents resizing for the entire grid, regardless of individual columnDef options.
+ *
+ * @example
+
+
+
+
+
+
+ Stable This feature is stable. There should no longer be breaking api changes without a deprecation warning.
+ *
+ * This module extends the edit feature to provide tracking and saving of rows
+ * of data. The tutorial provides more information on how this feature is best
+ * used {@link tutorial/205_row_editable here}.
+ * + * This feature depends on usage of the ui-grid-edit feature, and also benefits + * from use of ui-grid-cellNav to provide the full spreadsheet-like editing + * experience + * + */ + + var module = angular.module('ui.grid.rowEdit', ['ui.grid', 'ui.grid.edit', 'ui.grid.cellNav']); + + /** + * @ngdoc object + * @name ui.grid.rowEdit.constant:uiGridRowEditConstants + * + * @description constants available in row edit module + */ + module.constant('uiGridRowEditConstants', { + }); + + /** + * @ngdoc service + * @name ui.grid.rowEdit.service:uiGridRowEditService + * + * @description Services for row editing features + */ + module.service('uiGridRowEditService', ['$interval', '$q', 'uiGridConstants', 'uiGridRowEditConstants', 'gridUtil', + function ($interval, $q, uiGridConstants, uiGridRowEditConstants, gridUtil) { + + var service = { + + initializeGrid: function (scope, grid) { + /** + * @ngdoc object + * @name ui.grid.rowEdit.api:PublicApi + * + * @description Public Api for rowEdit feature + */ + + grid.rowEdit = {}; + + var publicApi = { + events: { + rowEdit: { + /** + * @ngdoc event + * @eventOf ui.grid.rowEdit.api:PublicApi + * @name saveRow + * @description raised when a row is ready for saving. Once your + * row has saved you may need to use angular.extend to update the + * data entity with any changed data from your save (for example, + * lock version information if you're using optimistic locking, + * or last update time/user information). + * + * Your method should call setSavePromise somewhere in the body before + * returning control. The feature will then wait, with the gridRow greyed out + * whilst this promise is being resolved. + * + *
+ * gridApi.rowEdit.on.saveRow(scope,function(rowEntity) {})
+ *
+ * and somewhere within the event handler:
+ * + * gridApi.rowEdit.setSavePromise( rowEntity, savePromise) + *+ * @param {object} rowEntity the options.data element that was edited + * @returns {promise} Your saveRow method should return a promise, the + * promise should either be resolved (implying successful save), or + * rejected (implying an error). + */ + saveRow: function (rowEntity) { + } + } + }, + methods: { + rowEdit: { + /** + * @ngdoc method + * @methodOf ui.grid.rowEdit.api:PublicApi + * @name setSavePromise + * @description Sets the promise associated with the row save, mandatory that + * the saveRow event handler calls this method somewhere before returning. + * + * gridApi.rowEdit.setSavePromise(rowEntity, savePromise) + *+ * @param {object} rowEntity a data row from the grid for which a save has + * been initiated + * @param {promise} savePromise the promise that will be resolved when the + * save is successful, or rejected if the save fails + * + */ + setSavePromise: function ( rowEntity, savePromise) { + service.setSavePromise(grid, rowEntity, savePromise); + }, + /** + * @ngdoc method + * @methodOf ui.grid.rowEdit.api:PublicApi + * @name getDirtyRows + * @description Returns all currently dirty rows + * + * gridApi.rowEdit.getDirtyRows(grid) + *+ * @returns {array} An array of gridRows that are currently dirty + * + */ + getDirtyRows: function () { + return grid.rowEdit.dirtyRows ? grid.rowEdit.dirtyRows : []; + }, + /** + * @ngdoc method + * @methodOf ui.grid.rowEdit.api:PublicApi + * @name getErrorRows + * @description Returns all currently errored rows + * + * gridApi.rowEdit.getErrorRows(grid) + *+ * @returns {array} An array of gridRows that are currently in error + * + */ + getErrorRows: function () { + return grid.rowEdit.errorRows ? grid.rowEdit.errorRows : []; + }, + /** + * @ngdoc method + * @methodOf ui.grid.rowEdit.api:PublicApi + * @name flushDirtyRows + * @description Triggers a save event for all currently dirty rows, could + * be used where user presses a save button or navigates away from the page + * + * gridApi.rowEdit.flushDirtyRows(grid) + *+ * @returns {promise} a promise that represents the aggregate of all + * of the individual save promises - i.e. it will be resolved when all + * the individual save promises have been resolved. + * + */ + flushDirtyRows: function () { + return service.flushDirtyRows(grid); + }, + + /** + * @ngdoc method + * @methodOf ui.grid.rowEdit.api:PublicApi + * @name setRowsDirty + * @description Sets each of the rows passed in dataRows + * to be dirty. Note that if you have only just inserted the + * rows into your data you will need to wait for a $digest cycle + * before the gridRows are present - so often you would wrap this + * call in a $interval or $timeout. Also, you must pass row.entity + * into this function rather than row objects themselves. + *
+ * $interval( function() {
+ * gridApi.rowEdit.setRowsDirty(myDataRows);
+ * }, 0, 1);
+ *
+ * @param {array} dataRows the data entities for which the gridRows
+ * should be set dirty.
+ *
+ */
+ setRowsDirty: function ( dataRows) {
+ service.setRowsDirty(grid, dataRows);
+ },
+
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.rowEdit.api:PublicApi
+ * @name setRowsClean
+ * @description Sets each of the rows passed in dataRows
+ * to be clean, removing them from the dirty cache and the error cache,
+ * and clearing the error flag and the dirty flag
+ *
+ * var gridRows = $scope.gridApi.rowEdit.getDirtyRows();
+ * var dataRows = gridRows.map( function( gridRow ) { return gridRow.entity; });
+ * $scope.gridApi.rowEdit.setRowsClean( dataRows );
+ *
+ * @param {array} dataRows the data entities for which the gridRows
+ * should be set clean.
+ *
+ */
+ setRowsClean: function ( dataRows) {
+ service.setRowsClean(grid, dataRows);
+ }
+ }
+ }
+ };
+
+ grid.api.registerEventsFromObject(publicApi.events);
+ grid.api.registerMethodsFromObject(publicApi.methods);
+
+ grid.api.core.on.renderingComplete( scope, function ( gridApi ) {
+ grid.api.edit.on.afterCellEdit( scope, service.endEditCell );
+ grid.api.edit.on.beginCellEdit( scope, service.beginEditCell );
+ grid.api.edit.on.cancelCellEdit( scope, service.cancelEditCell );
+
+ if ( grid.api.cellNav ) {
+ grid.api.cellNav.on.navigate( scope, service.navigate );
+ }
+ });
+
+ },
+
+ defaultGridOptions: function (gridOptions) {
+
+ /**
+ * @ngdoc object
+ * @name ui.grid.rowEdit.api:GridOptions
+ *
+ * @description Options for configuring the rowEdit feature, these are available to be
+ * set using the ui-grid {@link ui.grid.class:GridOptions gridOptions}
+ */
+
+ },
+
+
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.rowEdit.service:uiGridRowEditService
+ * @name saveRow
+ * @description Returns a function that saves the specified row from the grid,
+ * and returns a promise
+ * @param {object} grid the grid for which dirty rows should be flushed
+ * @param {GridRow} gridRow the row that should be saved
+ * @returns {function} the saveRow function returns a function. That function
+ * in turn, when called, returns a promise relating to the save callback
+ */
+ saveRow: function ( grid, gridRow ) {
+ var self = this;
+
+ return function() {
+ gridRow.isSaving = true;
+
+ if ( gridRow.rowEditSavePromise ) {
+ // don't save the row again if it's already saving - that causes stale object exceptions
+ return gridRow.rowEditSavePromise;
+ }
+
+ var promise = grid.api.rowEdit.raise.saveRow( gridRow.entity );
+
+ if ( gridRow.rowEditSavePromise ) {
+ gridRow.rowEditSavePromise.then( self.processSuccessPromise( grid, gridRow ), self.processErrorPromise( grid, gridRow ));
+ } else {
+ gridUtil.logError( 'A promise was not returned when saveRow event was raised, either nobody is listening to event, or event handler did not return a promise' );
+ }
+ return promise;
+ };
+ },
+
+
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.rowEdit.service:uiGridRowEditService
+ * @name setSavePromise
+ * @description Sets the promise associated with the row save, mandatory that
+ * the saveRow event handler calls this method somewhere before returning.
+ * + * gridApi.rowEdit.setSavePromise(grid, rowEntity) + *+ * @param {object} grid the grid for which dirty rows should be returned + * @param {object} rowEntity a data row from the grid for which a save has + * been initiated + * @param {promise} savePromise the promise that will be resolved when the + * save is successful, or rejected if the save fails + * + */ + setSavePromise: function (grid, rowEntity, savePromise) { + var gridRow = grid.getRow( rowEntity ); + gridRow.rowEditSavePromise = savePromise; + }, + + + /** + * @ngdoc method + * @methodOf ui.grid.rowEdit.service:uiGridRowEditService + * @name processSuccessPromise + * @description Returns a function that processes the successful + * resolution of a save promise + * @param {object} grid the grid for which the promise should be processed + * @param {GridRow} gridRow the row that has been saved + * @returns {function} the success handling function + */ + processSuccessPromise: function ( grid, gridRow ) { + var self = this; + + return function() { + delete gridRow.isSaving; + delete gridRow.isDirty; + delete gridRow.isError; + delete gridRow.rowEditSaveTimer; + delete gridRow.rowEditSavePromise; + self.removeRow( grid.rowEdit.errorRows, gridRow ); + self.removeRow( grid.rowEdit.dirtyRows, gridRow ); + }; + }, + + + /** + * @ngdoc method + * @methodOf ui.grid.rowEdit.service:uiGridRowEditService + * @name processErrorPromise + * @description Returns a function that processes the failed + * resolution of a save promise + * @param {object} grid the grid for which the promise should be processed + * @param {GridRow} gridRow the row that is now in error + * @returns {function} the error handling function + */ + processErrorPromise: function ( grid, gridRow ) { + return function() { + delete gridRow.isSaving; + delete gridRow.rowEditSaveTimer; + delete gridRow.rowEditSavePromise; + + gridRow.isError = true; + + if (!grid.rowEdit.errorRows) { + grid.rowEdit.errorRows = []; + } + if (!service.isRowPresent( grid.rowEdit.errorRows, gridRow ) ) { + grid.rowEdit.errorRows.push( gridRow ); + } + }; + }, + + + /** + * @ngdoc method + * @methodOf ui.grid.rowEdit.service:uiGridRowEditService + * @name removeRow + * @description Removes a row from a cache of rows - either + * grid.rowEdit.errorRows or grid.rowEdit.dirtyRows. If the row + * is not present silently does nothing. + * @param {array} rowArray the array from which to remove the row + * @param {GridRow} gridRow the row that should be removed + */ + removeRow: function( rowArray, removeGridRow ) { + if (typeof(rowArray) === 'undefined' || rowArray === null) { + return; + } + + rowArray.forEach( function( gridRow, index ) { + if ( gridRow.uid === removeGridRow.uid ) { + rowArray.splice( index, 1); + } + }); + }, + + + /** + * @ngdoc method + * @methodOf ui.grid.rowEdit.service:uiGridRowEditService + * @name isRowPresent + * @description Checks whether a row is already present + * in the given array + * @param {array} rowArray the array in which to look for the row + * @param {GridRow} gridRow the row that should be looked for + */ + isRowPresent: function( rowArray, removeGridRow ) { + var present = false; + rowArray.forEach( function( gridRow, index ) { + if ( gridRow.uid === removeGridRow.uid ) { + present = true; + } + }); + return present; + }, + + + /** + * @ngdoc method + * @methodOf ui.grid.rowEdit.service:uiGridRowEditService + * @name flushDirtyRows + * @description Triggers a save event for all currently dirty rows, could + * be used where user presses a save button or navigates away from the page + * + * gridApi.rowEdit.flushDirtyRows(grid) + *+ * @param {object} grid the grid for which dirty rows should be flushed + * @returns {promise} a promise that represents the aggregate of all + * of the individual save promises - i.e. it will be resolved when all + * the individual save promises have been resolved. + * + */ + flushDirtyRows: function(grid) { + var promises = []; + grid.api.rowEdit.getDirtyRows().forEach( function( gridRow ) { + service.cancelTimer( grid, gridRow ); + service.saveRow( grid, gridRow )(); + promises.push( gridRow.rowEditSavePromise ); + }); + + return $q.all( promises ); + }, + + + /** + * @ngdoc method + * @methodOf ui.grid.rowEdit.service:uiGridRowEditService + * @name endEditCell + * @description Receives an afterCellEdit event from the edit function, + * and sets flags as appropriate. Only the rowEntity parameter + * is processed, although other params are available. Grid + * is automatically provided by the gridApi. + * @param {object} rowEntity the data entity for which the cell + * was edited + */ + endEditCell: function( rowEntity, colDef, newValue, previousValue ) { + var grid = this.grid; + var gridRow = grid.getRow( rowEntity ); + if ( !gridRow ) { gridUtil.logError( 'Unable to find rowEntity in grid data, dirty flag cannot be set' ); return; } + + if ( newValue !== previousValue || gridRow.isDirty ) { + if ( !grid.rowEdit.dirtyRows ) { + grid.rowEdit.dirtyRows = []; + } + + if ( !gridRow.isDirty ) { + gridRow.isDirty = true; + grid.rowEdit.dirtyRows.push( gridRow ); + } + + delete gridRow.isError; + + service.considerSetTimer( grid, gridRow ); + } + }, + + + /** + * @ngdoc method + * @methodOf ui.grid.rowEdit.service:uiGridRowEditService + * @name beginEditCell + * @description Receives a beginCellEdit event from the edit function, + * and cancels any rowEditSaveTimers if present, as the user is still editing + * this row. Only the rowEntity parameter + * is processed, although other params are available. Grid + * is automatically provided by the gridApi. + * @param {object} rowEntity the data entity for which the cell + * editing has commenced + */ + beginEditCell: function( rowEntity, colDef ) { + var grid = this.grid; + var gridRow = grid.getRow( rowEntity ); + if ( !gridRow ) { gridUtil.logError( 'Unable to find rowEntity in grid data, timer cannot be cancelled' ); return; } + + service.cancelTimer( grid, gridRow ); + }, + + + /** + * @ngdoc method + * @methodOf ui.grid.rowEdit.service:uiGridRowEditService + * @name cancelEditCell + * @description Receives a cancelCellEdit event from the edit function, + * and if the row was already dirty, restarts the save timer. If the row + * was not already dirty, then it's not dirty now either and does nothing. + * + * Only the rowEntity parameter + * is processed, although other params are available. Grid + * is automatically provided by the gridApi. + * + * @param {object} rowEntity the data entity for which the cell + * editing was cancelled + */ + cancelEditCell: function( rowEntity, colDef ) { + var grid = this.grid; + var gridRow = grid.getRow( rowEntity ); + if ( !gridRow ) { gridUtil.logError( 'Unable to find rowEntity in grid data, timer cannot be set' ); return; } + + service.considerSetTimer( grid, gridRow ); + }, + + + /** + * @ngdoc method + * @methodOf ui.grid.rowEdit.service:uiGridRowEditService + * @name navigate + * @description cellNav tells us that the selected cell has changed. If + * the new row had a timer running, then stop it similar to in a beginCellEdit + * call. If the old row is dirty and not the same as the new row, then + * start a timer on it. + * @param {object} newRowCol the row and column that were selected + * @param {object} oldRowCol the row and column that was left + * + */ + navigate: function( newRowCol, oldRowCol ) { + var grid = this.grid; + if ( newRowCol.row.rowEditSaveTimer ) { + service.cancelTimer( grid, newRowCol.row ); + } + + if ( oldRowCol && oldRowCol.row && oldRowCol.row !== newRowCol.row ) { + service.considerSetTimer( grid, oldRowCol.row ); + } + }, + + + /** + * @ngdoc property + * @propertyOf ui.grid.rowEdit.api:GridOptions + * @name rowEditWaitInterval + * @description How long the grid should wait for another change on this row + * before triggering a save (in milliseconds). If set to -1, then saves are + * never triggered by timer (implying that the user will call flushDirtyRows() + * manually) + * + * @example + * Setting the wait interval to 4 seconds + *
+ * $scope.gridOptions = { rowEditWaitInterval: 4000 }
+ *
+ *
+ */
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.rowEdit.service:uiGridRowEditService
+ * @name considerSetTimer
+ * @description Consider setting a timer on this row (if it is dirty). if there is a timer running
+ * on the row and the row isn't currently saving, cancel it, using cancelTimer, then if the row is
+ * dirty and not currently saving then set a new timer
+ * @param {object} grid the grid for which we are processing
+ * @param {GridRow} gridRow the row for which the timer should be adjusted
+ *
+ */
+ considerSetTimer: function( grid, gridRow ) {
+ service.cancelTimer( grid, gridRow );
+
+ if ( gridRow.isDirty && !gridRow.isSaving ) {
+ if ( grid.options.rowEditWaitInterval !== -1 ) {
+ var waitTime = grid.options.rowEditWaitInterval ? grid.options.rowEditWaitInterval : 2000;
+ gridRow.rowEditSaveTimer = $interval( service.saveRow( grid, gridRow ), waitTime, 1);
+ }
+ }
+ },
+
+
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.rowEdit.service:uiGridRowEditService
+ * @name cancelTimer
+ * @description cancel the $interval for any timer running on this row
+ * then delete the timer itself
+ * @param {object} grid the grid for which we are processing
+ * @param {GridRow} gridRow the row for which the timer should be adjusted
+ *
+ */
+ cancelTimer: function( grid, gridRow ) {
+ if ( gridRow.rowEditSaveTimer && !gridRow.isSaving ) {
+ $interval.cancel(gridRow.rowEditSaveTimer);
+ delete gridRow.rowEditSaveTimer;
+ }
+ },
+
+
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.rowEdit.service:uiGridRowEditService
+ * @name setRowsDirty
+ * @description Sets each of the rows passed in dataRows
+ * to be dirty. note that if you have only just inserted the
+ * rows into your data you will need to wait for a $digest cycle
+ * before the gridRows are present - so often you would wrap this
+ * call in a $interval or $timeout
+ *
+ * $interval( function() {
+ * gridApi.rowEdit.setRowsDirty( myDataRows);
+ * }, 0, 1);
+ *
+ * @param {object} grid the grid for which rows should be set dirty
+ * @param {array} dataRows the data entities for which the gridRows
+ * should be set dirty.
+ *
+ */
+ setRowsDirty: function( grid, myDataRows ) {
+ var gridRow;
+ myDataRows.forEach( function( value, index ) {
+ gridRow = grid.getRow( value );
+ if ( gridRow ) {
+ if ( !grid.rowEdit.dirtyRows ) {
+ grid.rowEdit.dirtyRows = [];
+ }
+
+ if ( !gridRow.isDirty ) {
+ gridRow.isDirty = true;
+ grid.rowEdit.dirtyRows.push( gridRow );
+ }
+
+ delete gridRow.isError;
+
+ service.considerSetTimer( grid, gridRow );
+ } else {
+ gridUtil.logError( "requested row not found in rowEdit.setRowsDirty, row was: " + value );
+ }
+ });
+ },
+
+
+ /**
+ * @ngdoc method
+ * @methodOf ui.grid.rowEdit.service:uiGridRowEditService
+ * @name setRowsClean
+ * @description Sets each of the rows passed in dataRows
+ * to be clean, clearing the dirty flag and the error flag, and removing
+ * the rows from the dirty and error caches.
+ * @param {object} grid the grid for which rows should be set clean
+ * @param {array} dataRows the data entities for which the gridRows
+ * should be set clean.
+ *
+ */
+ setRowsClean: function( grid, myDataRows ) {
+ var gridRow;
+
+ myDataRows.forEach( function( value, index ) {
+ gridRow = grid.getRow( value );
+ if ( gridRow ) {
+ delete gridRow.isDirty;
+ service.removeRow( grid.rowEdit.dirtyRows, gridRow );
+ service.cancelTimer( grid, gridRow );
+
+ delete gridRow.isError;
+ service.removeRow( grid.rowEdit.errorRows, gridRow );
+ } else {
+ gridUtil.logError( "requested row not found in rowEdit.setRowsClean, row was: " + value );
+ }
+ });
+ }
+
+ };
+
+ return service;
+
+ }]);
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.rowEdit.directive:uiGridEdit
+ * @element div
+ * @restrict A
+ *
+ * @description Adds row editing features to the ui-grid-edit directive.
+ *
+ */
+ module.directive('uiGridRowEdit', ['gridUtil', 'uiGridRowEditService', 'uiGridEditConstants',
+ function (gridUtil, uiGridRowEditService, uiGridEditConstants) {
+ return {
+ replace: true,
+ priority: 0,
+ require: '^uiGrid',
+ scope: false,
+ compile: function () {
+ return {
+ pre: function ($scope, $elm, $attrs, uiGridCtrl) {
+ uiGridRowEditService.initializeGrid($scope, uiGridCtrl.grid);
+ },
+ post: function ($scope, $elm, $attrs, uiGridCtrl) {
+ }
+ };
+ }
+ };
+ }]);
+
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.rowEdit.directive:uiGridViewport
+ * @element div
+ *
+ * @description Stacks on top of ui.grid.uiGridViewport to alter the attributes used
+ * for the grid row to allow coloring of saving and error rows
+ */
+ module.directive('uiGridViewport',
+ ['$compile', 'uiGridConstants', 'gridUtil', '$parse',
+ function ($compile, uiGridConstants, gridUtil, $parse) {
+ return {
+ priority: -200, // run after default directive
+ scope: false,
+ compile: function ($elm, $attrs) {
+ var rowRepeatDiv = angular.element($elm.children().children()[0]);
+
+ var existingNgClass = rowRepeatDiv.attr("ng-class");
+ var newNgClass = '';
+ if ( existingNgClass ) {
+ newNgClass = existingNgClass.slice(0, -1) + ", 'ui-grid-row-dirty': row.isDirty, 'ui-grid-row-saving': row.isSaving, 'ui-grid-row-error': row.isError}";
+ } else {
+ newNgClass = "{'ui-grid-row-dirty': row.isDirty, 'ui-grid-row-saving': row.isSaving, 'ui-grid-row-error': row.isError}";
+ }
+ rowRepeatDiv.attr("ng-class", newNgClass);
+
+ return {
+ pre: function ($scope, $elm, $attrs, controllers) {
+
+ },
+ post: function ($scope, $elm, $attrs, controllers) {
+ }
+ };
+ }
+ };
+ }]);
+
+})();
diff --git a/release/4.9.2/ui-grid.row-edit.min.js b/release/4.9.2/ui-grid.row-edit.min.js
new file mode 100644
index 000000000..9d6b8f620
--- /dev/null
+++ b/release/4.9.2/ui-grid.row-edit.min.js
@@ -0,0 +1,7 @@
+/*!
+ * ui-grid - v4.9.2 - 2020-12-01
+ * Copyright (c) 2020 ; License: MIT
+ */
+
+
+!function(){"use strict";var r=angular.module("ui.grid.rowEdit",["ui.grid","ui.grid.edit","ui.grid.cellNav"]);r.constant("uiGridRowEditConstants",{}),r.service("uiGridRowEditService",["$interval","$q","uiGridConstants","uiGridRowEditConstants","gridUtil",function(t,r,i,e,s){var d={initializeGrid:function(i,e){e.rowEdit={};var r={events:{rowEdit:{saveRow:function(r){}}},methods:{rowEdit:{setSavePromise:function(r,i){d.setSavePromise(e,r,i)},getDirtyRows:function(){return e.rowEdit.dirtyRows?e.rowEdit.dirtyRows:[]},getErrorRows:function(){return e.rowEdit.errorRows?e.rowEdit.errorRows:[]},flushDirtyRows:function(){return d.flushDirtyRows(e)},setRowsDirty:function(r){d.setRowsDirty(e,r)},setRowsClean:function(r){d.setRowsClean(e,r)}}}};e.api.registerEventsFromObject(r.events),e.api.registerMethodsFromObject(r.methods),e.api.core.on.renderingComplete(i,function(r){e.api.edit.on.afterCellEdit(i,d.endEditCell),e.api.edit.on.beginCellEdit(i,d.beginEditCell),e.api.edit.on.cancelCellEdit(i,d.cancelEditCell),e.api.cellNav&&e.api.cellNav.on.navigate(i,d.navigate)})},defaultGridOptions:function(r){},saveRow:function(i,e){var t=this;return function(){if(e.isSaving=!0,e.rowEditSavePromise)return e.rowEditSavePromise;var r=i.api.rowEdit.raise.saveRow(e.entity);return e.rowEditSavePromise?e.rowEditSavePromise.then(t.processSuccessPromise(i,e),t.processErrorPromise(i,e)):s.logError("A promise was not returned when saveRow event was raised, either nobody is listening to event, or event handler did not return a promise"),r}},setSavePromise:function(r,i,e){r.getRow(i).rowEditSavePromise=e},processSuccessPromise:function(r,i){var e=this;return function(){delete i.isSaving,delete i.isDirty,delete i.isError,delete i.rowEditSaveTimer,delete i.rowEditSavePromise,e.removeRow(r.rowEdit.errorRows,i),e.removeRow(r.rowEdit.dirtyRows,i)}},processErrorPromise:function(r,i){return function(){delete i.isSaving,delete i.rowEditSaveTimer,delete i.rowEditSavePromise,i.isError=!0,r.rowEdit.errorRows||(r.rowEdit.errorRows=[]),d.isRowPresent(r.rowEdit.errorRows,i)||r.rowEdit.errorRows.push(i)}},removeRow:function(e,t){null!=e&&e.forEach(function(r,i){r.uid===t.uid&&e.splice(i,1)})},isRowPresent:function(r,e){var t=!1;return r.forEach(function(r,i){r.uid===e.uid&&(t=!0)}),t},flushDirtyRows:function(i){var e=[];return i.api.rowEdit.getDirtyRows().forEach(function(r){d.cancelTimer(i,r),d.saveRow(i,r)(),e.push(r.rowEditSavePromise)}),r.all(e)},endEditCell:function(r,i,e,t){var o=this.grid,n=o.getRow(r);n?(e!==t||n.isDirty)&&(o.rowEdit.dirtyRows||(o.rowEdit.dirtyRows=[]),n.isDirty||(n.isDirty=!0,o.rowEdit.dirtyRows.push(n)),delete n.isError,d.considerSetTimer(o,n)):s.logError("Unable to find rowEntity in grid data, dirty flag cannot be set")},beginEditCell:function(r,i){var e=this.grid,t=e.getRow(r);t?d.cancelTimer(e,t):s.logError("Unable to find rowEntity in grid data, timer cannot be cancelled")},cancelEditCell:function(r,i){var e=this.grid,t=e.getRow(r);t?d.considerSetTimer(e,t):s.logError("Unable to find rowEntity in grid data, timer cannot be set")},navigate:function(r,i){var e=this.grid;r.row.rowEditSaveTimer&&d.cancelTimer(e,r.row),i&&i.row&&i.row!==r.row&&d.considerSetTimer(e,i.row)},considerSetTimer:function(r,i){if(d.cancelTimer(r,i),i.isDirty&&!i.isSaving&&-1!==r.options.rowEditWaitInterval){var e=r.options.rowEditWaitInterval?r.options.rowEditWaitInterval:2e3;i.rowEditSaveTimer=t(d.saveRow(r,i),e,1)}},cancelTimer:function(r,i){i.rowEditSaveTimer&&!i.isSaving&&(t.cancel(i.rowEditSaveTimer),delete i.rowEditSaveTimer)},setRowsDirty:function(e,r){var t;r.forEach(function(r,i){(t=e.getRow(r))?(e.rowEdit.dirtyRows||(e.rowEdit.dirtyRows=[]),t.isDirty||(t.isDirty=!0,e.rowEdit.dirtyRows.push(t)),delete t.isError,d.considerSetTimer(e,t)):s.logError("requested row not found in rowEdit.setRowsDirty, row was: "+r)})},setRowsClean:function(e,r){var t;r.forEach(function(r,i){(t=e.getRow(r))?(delete t.isDirty,d.removeRow(e.rowEdit.dirtyRows,t),d.cancelTimer(e,t),delete t.isError,d.removeRow(e.rowEdit.errorRows,t)):s.logError("requested row not found in rowEdit.setRowsClean, row was: "+r)})}};return d}]),r.directive("uiGridRowEdit",["gridUtil","uiGridRowEditService","uiGridEditConstants",function(r,o,i){return{replace:!0,priority:0,require:"^uiGrid",scope:!1,compile:function(){return{pre:function(r,i,e,t){o.initializeGrid(r,t.grid)},post:function(r,i,e,t){}}}}}]),r.directive("uiGridViewport",["$compile","uiGridConstants","gridUtil","$parse",function(r,i,e,t){return{priority:-200,scope:!1,compile:function(r,i){var e=angular.element(r.children().children()[0]),t=e.attr("ng-class"),o="";return o=t?t.slice(0,-1)+", 'ui-grid-row-dirty': row.isDirty, 'ui-grid-row-saving': row.isSaving, 'ui-grid-row-error': row.isError}":"{'ui-grid-row-dirty': row.isDirty, 'ui-grid-row-saving': row.isSaving, 'ui-grid-row-error': row.isError}",e.attr("ng-class",o),{pre:function(r,i,e,t){},post:function(r,i,e,t){}}}}}])}();
\ No newline at end of file
diff --git a/release/4.9.2/ui-grid.saveState.js b/release/4.9.2/ui-grid.saveState.js
new file mode 100644
index 000000000..026421497
--- /dev/null
+++ b/release/4.9.2/ui-grid.saveState.js
@@ -0,0 +1,830 @@
+/*!
+ * ui-grid - v4.9.2 - 2020-12-01
+ * Copyright (c) 2020 ; License: MIT
+ */
+
+(function () {
+ 'use strict';
+
+ /**
+ * @ngdoc overview
+ * @name ui.grid.saveState
+ * @description
+ *
+ * # ui.grid.saveState
+ *
+ * Stable This feature is stable. There should no longer be breaking api changes without a deprecation warning.
+ *
+ * This module provides the ability to save the grid state, and restore
+ * it when the user returns to the page.
+ *
+ * No UI is provided, the caller should provide their own UI/buttons
+ * as appropriate. Usually the navigate events would be used to save
+ * the grid state and restore it.
+ *
+ * + * + * + * + */ + + var module = angular.module('ui.grid.saveState', ['ui.grid', 'ui.grid.selection', 'ui.grid.cellNav', 'ui.grid.grouping', 'ui.grid.pinning', 'ui.grid.treeView']); + + /** + * @ngdoc object + * @name ui.grid.saveState.constant:uiGridSaveStateConstants + * + * @description constants available in save state module + */ + + module.constant('uiGridSaveStateConstants', { + featureName: 'saveState' + }); + + /** + * @ngdoc service + * @name ui.grid.saveState.service:uiGridSaveStateService + * + * @description Services for saveState feature + */ + module.service('uiGridSaveStateService', + function () { + var service = { + + initializeGrid: function (grid) { + + // add feature namespace and any properties to grid for needed state + grid.saveState = {}; + this.defaultGridOptions(grid.options); + + /** + * @ngdoc object + * @name ui.grid.saveState.api:PublicApi + * + * @description Public Api for saveState feature + */ + var publicApi = { + events: { + saveState: { + } + }, + methods: { + saveState: { + /** + * @ngdoc function + * @name save + * @methodOf ui.grid.saveState.api:PublicApi + * @description Packages the current state of the grid into + * an object, and provides it to the user for saving + * @returns {object} the state as a javascript object that can be saved + */ + save: function () { + return service.save(grid); + }, + /** + * @ngdoc function + * @name restore + * @methodOf ui.grid.saveState.api:PublicApi + * @description Restores the provided state into the grid + * @param {scope} $scope a scope that we can broadcast on + * @param {object} state the state that should be restored into the grid + * @returns {object} the promise created by refresh + */ + restore: function ( $scope, state) { + return service.restore(grid, $scope, state); + } + } + } + }; + + grid.api.registerEventsFromObject(publicApi.events); + + grid.api.registerMethodsFromObject(publicApi.methods); + }, + + defaultGridOptions: function (gridOptions) { + // default option to true unless it was explicitly set to false + /** + * @ngdoc object + * @name ui.grid.saveState.api:GridOptions + * + * @description GridOptions for saveState feature, these are available to be + * set using the ui-grid {@link ui.grid.class:GridOptions gridOptions} + */ + /** + * @ngdoc object + * @name saveWidths + * @propertyOf ui.grid.saveState.api:GridOptions + * @description Save the current column widths. Note that unless + * you've provided the user with some way to resize their columns (say + * the resize columns feature), then this makes little sense. + * Defaults to true + */ + gridOptions.saveWidths = gridOptions.saveWidths !== false; + /** + * @ngdoc object + * @name saveOrder + * @propertyOf ui.grid.saveState.api:GridOptions + * @description Restore the current column order. Note that unless + * you've provided the user with some way to reorder their columns (for + * example the move columns feature), this makes little sense. + * Defaults to true + */ + gridOptions.saveOrder = gridOptions.saveOrder !== false; + /** + * @ngdoc object + * @name saveScroll + * @propertyOf ui.grid.saveState.api:GridOptions + * @description Save the current scroll position. Note that this + * is saved as the percentage of the grid scrolled - so if your + * user returns to a grid with a significantly different number of + * rows (perhaps some data has been deleted) then the scroll won't + * actually show the same rows as before. If you want to scroll to + * a specific row then you should instead use the saveFocus option, which + * is the default. + * + * Note that this element will only be saved if the cellNav feature is + * enabled + * Defaults to false + */ + gridOptions.saveScroll = gridOptions.saveScroll === true; + /** + * @ngdoc object + * @name saveFocus + * @propertyOf ui.grid.saveState.api:GridOptions + * @description Save the current focused cell. On returning + * to this focused cell we'll also scroll. This option is + * preferred to the saveScroll option, so is set to true by + * default. If saveScroll is set to true then this option will + * be disabled. + * + * By default this option saves the current row number and column + * number, and returns to that row and column. However, if you define + * a saveRowIdentity function, then it will return you to the currently + * selected column within that row (in a business sense - so if some + * rows have been deleted, it will still find the same data, presuming it + * still exists in the list. If it isn't in the list then it will instead + * return to the same row number - i.e. scroll percentage) + * + * Note that this option will do nothing if the cellNav + * feature is not enabled. + * + * Defaults to true (unless saveScroll is true) + */ + gridOptions.saveFocus = gridOptions.saveScroll !== true && gridOptions.saveFocus !== false; + /** + * @ngdoc object + * @name saveRowIdentity + * @propertyOf ui.grid.saveState.api:GridOptions + * @description A function that can be called, passing in a rowEntity, + * and that will return a unique id for that row. This might simply + * return the `id` field from that row (if you have one), or it might + * concatenate some fields within the row to make a unique value. + * + * This value will be used to find the same row again and set the focus + * to it, if it exists when we return. + * + * Defaults to undefined + */ + /** + * @ngdoc object + * @name saveVisible + * @propertyOf ui.grid.saveState.api:GridOptions + * @description Save whether or not columns are visible. + * + * Defaults to true + */ + gridOptions.saveVisible = gridOptions.saveVisible !== false; + /** + * @ngdoc object + * @name saveSort + * @propertyOf ui.grid.saveState.api:GridOptions + * @description Save the current sort state for each column + * + * Defaults to true + */ + gridOptions.saveSort = gridOptions.saveSort !== false; + /** + * @ngdoc object + * @name saveFilter + * @propertyOf ui.grid.saveState.api:GridOptions + * @description Save the current filter state for each column + * + * Defaults to true + */ + gridOptions.saveFilter = gridOptions.saveFilter !== false; + /** + * @ngdoc object + * @name saveSelection + * @propertyOf ui.grid.saveState.api:GridOptions + * @description Save the currently selected rows. If the `saveRowIdentity` callback + * is defined, then it will save the id of the row and select that. If not, then + * it will attempt to select the rows by row number, which will give the wrong results + * if the data set has changed in the mean-time. + * + * Note that this option only does anything + * if the selection feature is enabled. + * + * Defaults to true + */ + gridOptions.saveSelection = gridOptions.saveSelection !== false; + /** + * @ngdoc object + * @name saveGrouping + * @propertyOf ui.grid.saveState.api:GridOptions + * @description Save the grouping configuration. If set to true and the + * grouping feature is not enabled then does nothing. + * + * Defaults to true + */ + gridOptions.saveGrouping = gridOptions.saveGrouping !== false; + /** + * @ngdoc object + * @name saveGroupingExpandedStates + * @propertyOf ui.grid.saveState.api:GridOptions + * @description Save the grouping row expanded states. If set to true and the + * grouping feature is not enabled then does nothing. + * + * This can be quite a bit of data, in many cases you wouldn't want to save this + * information. + * + * Defaults to false + */ + gridOptions.saveGroupingExpandedStates = gridOptions.saveGroupingExpandedStates === true; + /** + * @ngdoc object + * @name savePinning + * @propertyOf ui.grid.saveState.api:GridOptions + * @description Save pinning state for columns. + * + * Defaults to true + */ + gridOptions.savePinning = gridOptions.savePinning !== false; + /** + * @ngdoc object + * @name saveTreeView + * @propertyOf ui.grid.saveState.api:GridOptions + * @description Save the treeView configuration. If set to true and the + * treeView feature is not enabled then does nothing. + * + * Defaults to true + */ + gridOptions.saveTreeView = gridOptions.saveTreeView !== false; + }, + + /** + * @ngdoc function + * @name save + * @methodOf ui.grid.saveState.service:uiGridSaveStateService + * @description Saves the current grid state into an object, and + * passes that object back to the caller + * @param {Grid} grid the grid whose state we'd like to save + * @returns {object} the state ready to be saved + */ + save: function (grid) { + var savedState = {}; + + savedState.columns = service.saveColumns( grid ); + savedState.scrollFocus = service.saveScrollFocus( grid ); + savedState.selection = service.saveSelection( grid ); + savedState.grouping = service.saveGrouping( grid ); + savedState.treeView = service.saveTreeView( grid ); + savedState.pagination = service.savePagination( grid ); + + return savedState; + }, + + + /** + * @ngdoc function + * @name restore + * @methodOf ui.grid.saveState.service:uiGridSaveStateService + * @description Applies the provided state to the grid + * + * @param {Grid} grid the grid whose state we'd like to restore + * @param {scope} $scope a scope that we can broadcast on + * @param {object} state the state we'd like to restore + * @returns {object} the promise created by refresh + */ + restore: function( grid, $scope, state ) { + if ( state.columns ) { + service.restoreColumns( grid, state.columns ); + } + + if ( state.scrollFocus ) { + service.restoreScrollFocus( grid, $scope, state.scrollFocus ); + } + + if ( state.selection ) { + service.restoreSelection( grid, state.selection ); + } + + if ( state.grouping ) { + service.restoreGrouping( grid, state.grouping ); + } + + if ( state.treeView ) { + service.restoreTreeView( grid, state.treeView ); + } + + if ( state.pagination ) { + service.restorePagination( grid, state.pagination ); + } + + return grid.refresh(); + }, + + + /** + * @ngdoc function + * @name saveColumns + * @methodOf ui.grid.saveState.service:uiGridSaveStateService + * @description Saves the column setup, including sort, filters, ordering, + * pinning and column widths. + * + * Works through the current columns, storing them in order. Stores the + * column name, then the visible flag, width, sort and filters for each column. + * + * @param {Grid} grid the grid whose state we'd like to save + * @returns {array} the columns state ready to be saved + */ + saveColumns: function( grid ) { + var columns = []; + + grid.getOnlyDataColumns().forEach( function( column ) { + var savedColumn = {}; + savedColumn.name = column.name; + + if ( grid.options.saveVisible ) { + savedColumn.visible = column.visible; + } + + if ( grid.options.saveWidths ) { + savedColumn.width = column.width; + } + + // these two must be copied, not just pointed too - otherwise our saved state is pointing to the same object as current state + if ( grid.options.saveSort ) { + savedColumn.sort = angular.copy( column.sort ); + } + + if ( grid.options.saveFilter ) { + savedColumn.filters = []; + column.filters.forEach( function( filter ) { + var copiedFilter = {}; + angular.forEach( filter, function( value, key) { + if ( key !== 'condition' && key !== '$$hashKey' && key !== 'placeholder') { + copiedFilter[key] = value; + } + }); + savedColumn.filters.push(copiedFilter); + }); + } + + if ( !!grid.api.pinning && grid.options.savePinning ) { + savedColumn.pinned = column.renderContainer ? column.renderContainer : ''; + } + + columns.push( savedColumn ); + }); + + return columns; + }, + + + /** + * @ngdoc function + * @name saveScrollFocus + * @methodOf ui.grid.saveState.service:uiGridSaveStateService + * @description Saves the currently scroll or focus. + * + * If cellNav isn't present then does nothing - we can't return + * to the scroll position without cellNav anyway. + * + * If the cellNav module is present, and saveFocus is true, then + * it saves the currently focused cell. If rowIdentity is present + * then saves using rowIdentity, otherwise saves visibleRowNum. + * + * If the cellNav module is not present, and saveScroll is true, then + * it approximates the current scroll row and column, and saves that. + * + * @param {Grid} grid the grid whose state we'd like to save + * @returns {object} the selection state ready to be saved + */ + saveScrollFocus: function( grid ) { + if ( !grid.api.cellNav ) { + return {}; + } + + var scrollFocus = {}; + if ( grid.options.saveFocus ) { + scrollFocus.focus = true; + var rowCol = grid.api.cellNav.getFocusedCell(); + if ( rowCol !== null ) { + if ( rowCol.col !== null ) { + scrollFocus.colName = rowCol.col.colDef.name; + } + if ( rowCol.row !== null ) { + scrollFocus.rowVal = service.getRowVal( grid, rowCol.row ); + } + } + } + + if ( grid.options.saveScroll || grid.options.saveFocus && !scrollFocus.colName && !scrollFocus.rowVal ) { + scrollFocus.focus = false; + if ( grid.renderContainers.body.prevRowScrollIndex ) { + scrollFocus.rowVal = service.getRowVal( grid, grid.renderContainers.body.visibleRowCache[ grid.renderContainers.body.prevRowScrollIndex ]); + } + + if ( grid.renderContainers.body.prevColScrollIndex ) { + scrollFocus.colName = grid.renderContainers.body.visibleColumnCache[ grid.renderContainers.body.prevColScrollIndex ].name; + } + } + + return scrollFocus; + }, + + + /** + * @ngdoc function + * @name saveSelection + * @methodOf ui.grid.saveState.service:uiGridSaveStateService + * @description Saves the currently selected rows, if the selection feature is enabled + * @param {Grid} grid the grid whose state we'd like to save + * @returns {array} the selection state ready to be saved + */ + saveSelection: function( grid ) { + if ( !grid.api.selection || !grid.options.saveSelection ) { + return []; + } + + return grid.api.selection.getSelectedGridRows().map( function( gridRow ) { + return service.getRowVal( grid, gridRow ); + }); + }, + + + /** + * @ngdoc function + * @name saveGrouping + * @methodOf ui.grid.saveState.service:uiGridSaveStateService + * @description Saves the grouping state, if the grouping feature is enabled + * @param {Grid} grid the grid whose state we'd like to save + * @returns {object} the grouping state ready to be saved + */ + saveGrouping: function( grid ) { + if ( !grid.api.grouping || !grid.options.saveGrouping ) { + return {}; + } + + return grid.api.grouping.getGrouping( grid.options.saveGroupingExpandedStates ); + }, + + + /** + * @ngdoc function + * @name savePagination + * @methodOf ui.grid.saveState.service:uiGridSaveStateService + * @description Saves the pagination state, if the pagination feature is enabled + * @param {Grid} grid the grid whose state we'd like to save + * @returns {object} the pagination state ready to be saved + */ + savePagination: function( grid ) { + if ( !grid.api.pagination || !grid.options.paginationPageSize ) { + return {}; + } + + return { + paginationCurrentPage: grid.options.paginationCurrentPage, + paginationPageSize: grid.options.paginationPageSize + }; + }, + + + /** + * @ngdoc function + * @name saveTreeView + * @methodOf ui.grid.saveState.service:uiGridSaveStateService + * @description Saves the tree view state, if the tree feature is enabled + * @param {Grid} grid the grid whose state we'd like to save + * @returns {object} the tree view state ready to be saved + */ + saveTreeView: function( grid ) { + if ( !grid.api.treeView || !grid.options.saveTreeView ) { + return {}; + } + + return grid.api.treeView.getTreeView(); + }, + + + /** + * @ngdoc function + * @name getRowVal + * @methodOf ui.grid.saveState.service:uiGridSaveStateService + * @description Helper function that gets either the rowNum or + * the saveRowIdentity, given a gridRow + * @param {Grid} grid the grid the row is in + * @param {GridRow} gridRow the row we want the rowNum for + * @returns {object} an object containing { identity: true/false, row: rowNumber/rowIdentity } + * + */ + getRowVal: function( grid, gridRow ) { + if ( !gridRow ) { + return null; + } + + var rowVal = {}; + if ( grid.options.saveRowIdentity ) { + rowVal.identity = true; + rowVal.row = grid.options.saveRowIdentity( gridRow.entity ); + } + else { + rowVal.identity = false; + rowVal.row = grid.renderContainers.body.visibleRowCache.indexOf( gridRow ); + } + return rowVal; + }, + + + /** + * @ngdoc function + * @name restoreColumns + * @methodOf ui.grid.saveState.service:uiGridSaveStateService + * @description Restores the columns, including order, visible, width, + * pinning, sort and filters. + * + * @param {Grid} grid the grid whose state we'd like to restore + * @param {object} columnsState the list of columns we had before, with their state + */ + restoreColumns: function( grid, columnsState ) { + var isSortChanged = false; + + columnsState.forEach( function( columnState, index ) { + var currentCol = grid.getColumn( columnState.name ); + + if ( currentCol && !grid.isRowHeaderColumn(currentCol) ) { + if ( grid.options.saveVisible && + ( currentCol.visible !== columnState.visible || + currentCol.colDef.visible !== columnState.visible ) ) { + currentCol.visible = columnState.visible; + currentCol.colDef.visible = columnState.visible; + grid.api.core.raise.columnVisibilityChanged(currentCol); + } + + if ( grid.options.saveWidths && currentCol.width !== columnState.width) { + currentCol.width = columnState.width; + currentCol.hasCustomWidth = true; + } + + if ( grid.options.saveSort && + !angular.equals(currentCol.sort, columnState.sort) && + !( currentCol.sort === undefined && angular.isEmpty(columnState.sort) ) ) { + currentCol.sort = angular.copy( columnState.sort ); + isSortChanged = true; + } + + if ( grid.options.saveFilter && + !angular.equals(currentCol.filters, columnState.filters ) ) { + columnState.filters.forEach( function( filter, index ) { + angular.extend( currentCol.filters[index], filter ); + if ( typeof(filter.term) === 'undefined' || filter.term === null ) { + delete currentCol.filters[index].term; + } + }); + grid.api.core.raise.filterChanged( currentCol ); + } + + if ( !!grid.api.pinning && grid.options.savePinning && currentCol.renderContainer !== columnState.pinned ) { + grid.api.pinning.pinColumn(currentCol, columnState.pinned); + } + + var currentIndex = grid.getOnlyDataColumns().indexOf( currentCol ); + if (currentIndex !== -1) { + if (grid.options.saveOrder && currentIndex !== index) { + var column = grid.columns.splice(currentIndex + grid.rowHeaderColumns.length, 1)[0]; + grid.columns.splice(index + grid.rowHeaderColumns.length, 0, column); + } + } + } + }); + + if ( isSortChanged ) { + grid.api.core.raise.sortChanged( grid, grid.getColumnSorting() ); + } + }, + + + /** + * @ngdoc function + * @name restoreScrollFocus + * @methodOf ui.grid.saveState.service:uiGridSaveStateService + * @description Scrolls to the position that was saved. If focus is true, then + * sets focus to the specified row/col. If focus is false, then scrolls to the + * specified row/col. + * + * @param {Grid} grid the grid whose state we'd like to restore + * @param {scope} $scope a scope that we can broadcast on + * @param {object} scrollFocusState the scroll/focus state ready to be restored + */ + restoreScrollFocus: function( grid, $scope, scrollFocusState ) { + if ( !grid.api.cellNav ) { + return; + } + + var colDef, row; + if ( scrollFocusState.colName ) { + var colDefs = grid.options.columnDefs.filter( function( colDef ) { return colDef.name === scrollFocusState.colName; }); + if ( colDefs.length > 0 ) { + colDef = colDefs[0]; + } + } + + if ( scrollFocusState.rowVal && scrollFocusState.rowVal.row ) { + if ( scrollFocusState.rowVal.identity ) { + row = service.findRowByIdentity( grid, scrollFocusState.rowVal ); + } + else { + row = grid.renderContainers.body.visibleRowCache[ scrollFocusState.rowVal.row ]; + } + } + + var entity = row && row.entity ? row.entity : null ; + + if ( colDef || entity ) { + if (scrollFocusState.focus ) { + grid.api.cellNav.scrollToFocus( entity, colDef ); + } + else { + grid.scrollTo( entity, colDef ); + } + } + }, + + + /** + * @ngdoc function + * @name restoreSelection + * @methodOf ui.grid.saveState.service:uiGridSaveStateService + * @description Selects the rows that are provided in the selection + * state. If you are using `saveRowIdentity` and more than one row matches the identity + * function then only the first is selected. + * @param {Grid} grid the grid whose state we'd like to restore + * @param {object} selectionState the selection state ready to be restored + */ + restoreSelection: function( grid, selectionState ) { + if ( !grid.api.selection ) { + return; + } + + grid.api.selection.clearSelectedRows(); + + selectionState.forEach(function( rowVal ) { + if ( rowVal.identity ) { + var foundRow = service.findRowByIdentity( grid, rowVal ); + + if ( foundRow ) { + grid.api.selection.selectRow( foundRow.entity ); + } + + } + else { + grid.api.selection.selectRowByVisibleIndex( rowVal.row ); + } + }); + }, + + + /** + * @ngdoc function + * @name restoreGrouping + * @methodOf ui.grid.saveState.service:uiGridSaveStateService + * @description Restores the grouping configuration, if the grouping feature + * is enabled. + * @param {Grid} grid the grid whose state we'd like to restore + * @param {object} groupingState the grouping state ready to be restored + */ + restoreGrouping: function( grid, groupingState ) { + if ( !grid.api.grouping || typeof(groupingState) === 'undefined' || groupingState === null || angular.equals(groupingState, {}) ) { + return; + } + + grid.api.grouping.setGrouping( groupingState ); + }, + + /** + * @ngdoc function + * @name restoreTreeView + * @methodOf ui.grid.saveState.service:uiGridSaveStateService + * @description Restores the tree view configuration, if the tree view feature + * is enabled. + * @param {Grid} grid the grid whose state we'd like to restore + * @param {object} treeViewState the tree view state ready to be restored + */ + restoreTreeView: function( grid, treeViewState ) { + if ( !grid.api.treeView || typeof(treeViewState) === 'undefined' || treeViewState === null || angular.equals(treeViewState, {}) ) { + return; + } + + grid.api.treeView.setTreeView( treeViewState ); + }, + + /** + * @ngdoc function + * @name restorePagination + * @methodOf ui.grid.saveState.service:uiGridSaveStateService + * @description Restores the pagination information, if pagination is enabled. + * @param {Grid} grid the grid whose state we'd like to restore + * @param {object} pagination the pagination object to be restored + * @param {number} pagination.paginationCurrentPage the page number to restore + * @param {number} pagination.paginationPageSize the number of items displayed per page + */ + restorePagination: function( grid, pagination ) { + if ( !grid.api.pagination || !grid.options.paginationPageSize ) { + return; + } + + grid.options.paginationCurrentPage = pagination.paginationCurrentPage; + grid.options.paginationPageSize = pagination.paginationPageSize; + }, + + /** + * @ngdoc function + * @name findRowByIdentity + * @methodOf ui.grid.saveState.service:uiGridSaveStateService + * @description Finds a row given it's identity value, returns the first found row + * if any are found, otherwise returns null if no rows are found. + * @param {Grid} grid the grid whose state we'd like to restore + * @param {object} rowVal the row we'd like to find + * @returns {gridRow} the found row, or null if none found + */ + findRowByIdentity: function( grid, rowVal ) { + if ( !grid.options.saveRowIdentity ) { + return null; + } + + var filteredRows = grid.rows.filter( function( gridRow ) { + return ( grid.options.saveRowIdentity( gridRow.entity ) === rowVal.row ); + }); + + if ( filteredRows.length > 0 ) { + return filteredRows[0]; + } else { + return null; + } + } + }; + + return service; + } + ); + + /** + * @ngdoc directive + * @name ui.grid.saveState.directive:uiGridSaveState + * @element div + * @restrict A + * + * @description Adds saveState features to grid + * + * @example +
+
+
+ Defaults to true + */ + + /** + * @ngdoc object + * @name isSelected + * @propertyOf ui.grid.selection.api:GridRow + * @description Selected state of row. Should be readonly. Make any changes to selected state using setSelected(). + * Defaults to false + */ + + /** + * @ngdoc object + * @name isFocused + * @propertyOf ui.grid.selection.api:GridRow + * @description Focused state of row. Should be readonly. Make any changes to focused state using setFocused(). + * Defaults to false + */ + + /** + * @ngdoc function + * @name setSelected + * @methodOf ui.grid.selection.api:GridRow + * @description Sets the isSelected property and updates the selectedCount + * Changes to isSelected state should only be made via this function + * @param {Boolean} selected value to set + */ + $delegate.prototype.setSelected = function (selected) { + if (selected !== this.isSelected) { + this.isSelected = selected; + this.grid.selection.selectedCount += selected ? 1 : -1; + } + }; + + /** + * @ngdoc function + * @name setFocused + * @methodOf ui.grid.selection.api:GridRow + * @description Sets the isFocused property + * Changes to isFocused state should only be made via this function + * @param {Boolean} val value to set + */ + $delegate.prototype.setFocused = function(val) { + if (val !== this.isFocused) { + this.grid.selection.focusedRow && (this.grid.selection.focusedRow.isFocused = false); + this.grid.selection.focusedRow = val ? this : null; + this.isFocused = val; + } + }; + + return $delegate; + }]); + }]); + + /** + * @ngdoc service + * @name ui.grid.selection.service:uiGridSelectionService + * + * @description Services for selection features + */ + module.service('uiGridSelectionService', + function () { + var service = { + + initializeGrid: function (grid) { + + // add feature namespace and any properties to grid for needed + /** + * @ngdoc object + * @name ui.grid.selection.grid:selection + * + * @description Grid properties and functions added for selection + */ + grid.selection = { + lastSelectedRow: null, + /** + * @ngdoc object + * @name focusedRow + * @propertyOf ui.grid.selection.grid:selection + * @description Focused row. + */ + focusedRow: null, + selectAll: false + }; + + + /** + * @ngdoc object + * @name selectedCount + * @propertyOf ui.grid.selection.grid:selection + * @description Current count of selected rows + * @example + * var count = grid.selection.selectedCount + */ + grid.selection.selectedCount = 0; + + service.defaultGridOptions(grid.options); + + /** + * @ngdoc object + * @name ui.grid.selection.api:PublicApi + * + * @description Public Api for selection feature + */ + var publicApi = { + events: { + selection: { + /** + * @ngdoc event + * @name rowFocusChanged + * @eventOf ui.grid.selection.api:PublicApi + * @description is raised after the row.isFocused state is changed + * @param {object} scope the scope associated with the grid + * @param {GridRow} row the row that was focused/unfocused + * @param {Event} evt object if raised from an event + */ + rowFocusChanged: function (scope, row, evt) {}, + /** + * @ngdoc event + * @name rowSelectionChanged + * @eventOf ui.grid.selection.api:PublicApi + * @description is raised after the row.isSelected state is changed + * @param {object} scope the scope associated with the grid + * @param {GridRow} row the row that was selected/deselected + * @param {Event} evt object if raised from an event + */ + rowSelectionChanged: function (scope, row, evt) { + }, + /** + * @ngdoc event + * @name rowSelectionChangedBatch + * @eventOf ui.grid.selection.api:PublicApi + * @description is raised after the row.isSelected state is changed + * in bulk, if the `enableSelectionBatchEvent` option is set to true + * (which it is by default). This allows more efficient processing + * of bulk events. + * @param {object} scope the scope associated with the grid + * @param {array} rows the rows that were selected/deselected + * @param {Event} evt object if raised from an event + */ + rowSelectionChangedBatch: function (scope, rows, evt) { + } + } + }, + methods: { + selection: { + /** + * @ngdoc function + * @name toggleRowSelection + * @methodOf ui.grid.selection.api:PublicApi + * @description Toggles data row as selected or unselected + * @param {object} rowEntity gridOptions.data[] array instance + * @param {Event} evt object if raised from an event + */ + toggleRowSelection: function (rowEntity, evt) { + var row = grid.getRow(rowEntity); + if (row !== null) { + service.toggleRowSelection(grid, row, evt, grid.options.multiSelect, grid.options.noUnselect); + } + }, + /** + * @ngdoc function + * @name selectRow + * @methodOf ui.grid.selection.api:PublicApi + * @description Select the data row + * @param {object} rowEntity gridOptions.data[] array instance + * @param {Event} evt object if raised from an event + */ + selectRow: function (rowEntity, evt) { + var row = grid.getRow(rowEntity); + if (row !== null && !row.isSelected) { + service.toggleRowSelection(grid, row, evt, grid.options.multiSelect, grid.options.noUnselect); + } + }, + /** + * @ngdoc function + * @name selectRowByVisibleIndex + * @methodOf ui.grid.selection.api:PublicApi + * @description Select the specified row by visible index (i.e. if you + * specify row 0 you'll get the first visible row selected). In this context + * visible means of those rows that are theoretically visible (i.e. not filtered), + * rather than rows currently rendered on the screen. + * @param {number} rowNum index within the rowsVisible array + * @param {Event} evt object if raised from an event + */ + selectRowByVisibleIndex: function (rowNum, evt) { + var row = grid.renderContainers.body.visibleRowCache[rowNum]; + if (row !== null && typeof (row) !== 'undefined' && !row.isSelected) { + service.toggleRowSelection(grid, row, evt, grid.options.multiSelect, grid.options.noUnselect); + } + }, + /** + * @ngdoc function + * @name unSelectRow + * @methodOf ui.grid.selection.api:PublicApi + * @description UnSelect the data row + * @param {object} rowEntity gridOptions.data[] array instance + * @param {Event} evt object if raised from an event + */ + unSelectRow: function (rowEntity, evt) { + var row = grid.getRow(rowEntity); + if (row !== null && row.isSelected) { + service.toggleRowSelection(grid, row, evt, grid.options.multiSelect, grid.options.noUnselect); + } + }, + /** + * @ngdoc function + * @name unSelectRowByVisibleIndex + * @methodOf ui.grid.selection.api:PublicApi + * @description Unselect the specified row by visible index (i.e. if you + * specify row 0 you'll get the first visible row unselected). In this context + * visible means of those rows that are theoretically visible (i.e. not filtered), + * rather than rows currently rendered on the screen. + * @param {number} rowNum index within the rowsVisible array + * @param {Event} evt object if raised from an event + */ + unSelectRowByVisibleIndex: function (rowNum, evt) { + var row = grid.renderContainers.body.visibleRowCache[rowNum]; + if (row !== null && typeof (row) !== 'undefined' && row.isSelected) { + service.toggleRowSelection(grid, row, evt, grid.options.multiSelect, grid.options.noUnselect); + } + }, + /** + * @ngdoc function + * @name selectAllRows + * @methodOf ui.grid.selection.api:PublicApi + * @description Selects all rows. Does nothing if multiSelect = false + * @param {Event} evt object if raised from an event + */ + selectAllRows: function (evt) { + if (grid.options.multiSelect !== false) { + var changedRows = []; + grid.rows.forEach(function (row) { + if (!row.isSelected && row.enableSelection !== false && grid.options.isRowSelectable(row) !== false) { + row.setSelected(true); + service.decideRaiseSelectionEvent(grid, row, changedRows, evt); + } + }); + grid.selection.selectAll = true; + service.decideRaiseSelectionBatchEvent(grid, changedRows, evt); + } + }, + /** + * @ngdoc function + * @name selectAllVisibleRows + * @methodOf ui.grid.selection.api:PublicApi + * @description Selects all visible rows. Does nothing if multiSelect = false + * @param {Event} evt object if raised from an event + */ + selectAllVisibleRows: function (evt) { + if (grid.options.multiSelect !== false) { + var changedRows = []; + grid.rows.forEach(function(row) { + if (row.visible) { + if (!row.isSelected && row.enableSelection !== false && grid.options.isRowSelectable(row) !== false) { + row.setSelected(true); + service.decideRaiseSelectionEvent(grid, row, changedRows, evt); + } + } else if (row.isSelected) { + row.setSelected(false); + service.decideRaiseSelectionEvent(grid, row, changedRows, evt); + } + }); + grid.selection.selectAll = true; + service.decideRaiseSelectionBatchEvent(grid, changedRows, evt); + } + }, + /** + * @ngdoc function + * @name clearSelectedRows + * @methodOf ui.grid.selection.api:PublicApi + * @description Unselects all rows + * @param {Event} evt object if raised from an event + */ + clearSelectedRows: function (evt) { + service.clearSelectedRows(grid, evt); + }, + /** + * @ngdoc function + * @name getSelectedRows + * @methodOf ui.grid.selection.api:PublicApi + * @description returns all selectedRow's entity references + */ + getSelectedRows: function () { + return service.getSelectedRows(grid).map(function (gridRow) { + return gridRow.entity; + }).filter(function (entity) { + return entity.hasOwnProperty('$$hashKey') || !angular.isObject(entity); + }); + }, + /** + * @ngdoc function + * @name getSelectedGridRows + * @methodOf ui.grid.selection.api:PublicApi + * @description returns all selectedRow's as gridRows + */ + getSelectedGridRows: function () { + return service.getSelectedRows(grid); + }, + /** + * @ngdoc function + * @name getSelectedCount + * @methodOf ui.grid.selection.api:PublicApi + * @description returns the number of rows selected + */ + getSelectedCount: function () { + return grid.selection.selectedCount; + }, + /** + * @ngdoc function + * @name setMultiSelect + * @methodOf ui.grid.selection.api:PublicApi + * @description Sets the current gridOption.multiSelect to true or false + * @param {bool} multiSelect true to allow multiple rows + */ + setMultiSelect: function (multiSelect) { + grid.options.multiSelect = multiSelect; + }, + /** + * @ngdoc function + * @name setModifierKeysToMultiSelect + * @methodOf ui.grid.selection.api:PublicApi + * @description Sets the current gridOption.modifierKeysToMultiSelect to true or false + * @param {bool} modifierKeysToMultiSelect true to only allow multiple rows when using ctrlKey or shiftKey is used + */ + setModifierKeysToMultiSelect: function (modifierKeysToMultiSelect) { + grid.options.modifierKeysToMultiSelect = modifierKeysToMultiSelect; + }, + /** + * @ngdoc function + * @name getSelectAllState + * @methodOf ui.grid.selection.api:PublicApi + * @description Returns whether or not the selectAll checkbox is currently ticked. The + * grid doesn't automatically select rows when you add extra data - so when you add data + * you need to explicitly check whether the selectAll is set, and then call setVisible rows + * if it is + */ + getSelectAllState: function () { + return grid.selection.selectAll; + } + + } + } + }; + + grid.api.registerEventsFromObject(publicApi.events); + + grid.api.registerMethodsFromObject(publicApi.methods); + + }, + + defaultGridOptions: function (gridOptions) { + // default option to true unless it was explicitly set to false + /** + * @ngdoc object + * @name ui.grid.selection.api:GridOptions + * + * @description GridOptions for selection feature, these are available to be + * set using the ui-grid {@link ui.grid.class:GridOptions gridOptions} + */ + + /** + * @ngdoc object + * @name enableRowSelection + * @propertyOf ui.grid.selection.api:GridOptions + * @description Enable row selection for entire grid. + * Defaults to true + */ + gridOptions.enableRowSelection = gridOptions.enableRowSelection !== false; + /** + * @ngdoc object + * @name multiSelect + * @propertyOf ui.grid.selection.api:GridOptions + * @description Enable multiple row selection for entire grid + * Defaults to true + */ + gridOptions.multiSelect = gridOptions.multiSelect !== false; + /** + * @ngdoc object + * @name noUnselect + * @propertyOf ui.grid.selection.api:GridOptions + * @description Prevent a row from being unselected. Works in conjunction + * with `multiselect = false` and `gridApi.selection.selectRow()` to allow + * you to create a single selection only grid - a row is always selected, you + * can only select different rows, you can't unselect the row. + * Defaults to false + */ + gridOptions.noUnselect = gridOptions.noUnselect === true; + /** + * @ngdoc object + * @name modifierKeysToMultiSelect + * @propertyOf ui.grid.selection.api:GridOptions + * @description Enable multiple row selection only when using the ctrlKey or shiftKey. Requires multiSelect to be true. + * Defaults to false + */ + gridOptions.modifierKeysToMultiSelect = gridOptions.modifierKeysToMultiSelect === true; + /** + * @ngdoc object + * @name enableRowHeaderSelection + * @propertyOf ui.grid.selection.api:GridOptions + * @description Enable a row header to be used for selection + * Defaults to true + */ + gridOptions.enableRowHeaderSelection = gridOptions.enableRowHeaderSelection !== false; + /** + * @ngdoc object + * @name enableFullRowSelection + * @propertyOf ui.grid.selection.api:GridOptions + * @description Enable selection by clicking anywhere on the row. Defaults to + * false if `enableRowHeaderSelection` is true, otherwise defaults to true. + */ + if (typeof (gridOptions.enableFullRowSelection) === 'undefined') { + gridOptions.enableFullRowSelection = !gridOptions.enableRowHeaderSelection; + } + /** + * @ngdoc object + * @name enableFocusRowOnRowHeaderClick + * @propertyOf ui.grid.selection.api:GridOptions + * @description Enable focuse row by clicking on the row header. Defaults to + * true if `enableRowHeaderSelection` is true, otherwise defaults to false. + */ + gridOptions.enableFocusRowOnRowHeaderClick = (gridOptions.enableFocusRowOnRowHeaderClick !== false) + || !gridOptions.enableRowHeaderSelection; + /** + * @ngdoc object + * @name enableSelectRowOnFocus + * @propertyOf ui.grid.selection.api:GridOptions + * @description Enable focuse row by clicking on the row anywhere. Defaults true. + */ + gridOptions.enableSelectRowOnFocus = (gridOptions.enableSelectRowOnFocus !== false); + /** + * @ngdoc object + * @name enableSelectAll + * @propertyOf ui.grid.selection.api:GridOptions + * @description Enable the select all checkbox at the top of the selectionRowHeader + * Defaults to true + */ + gridOptions.enableSelectAll = gridOptions.enableSelectAll !== false; + /** + * @ngdoc object + * @name enableSelectionBatchEvent + * @propertyOf ui.grid.selection.api:GridOptions + * @description If selected rows are changed in bulk, either via the API or + * via the selectAll checkbox, then a separate event is fired. Setting this + * option to false will cause the rowSelectionChanged event to be called multiple times + * instead + * Defaults to true + */ + gridOptions.enableSelectionBatchEvent = gridOptions.enableSelectionBatchEvent !== false; + /** + * @ngdoc object + * @name selectionRowHeaderWidth + * @propertyOf ui.grid.selection.api:GridOptions + * @description can be used to set a custom width for the row header selection column + * Defaults to 30px + */ + gridOptions.selectionRowHeaderWidth = angular.isDefined(gridOptions.selectionRowHeaderWidth) ? gridOptions.selectionRowHeaderWidth : 30; + /** + * @ngdoc object + * @name enableFooterTotalSelected + * @propertyOf ui.grid.selection.api:GridOptions + * @description Shows the total number of selected items in footer if true. + * Defaults to true. + * GridOptions.showGridFooter must also be set to true. + */ + gridOptions.enableFooterTotalSelected = gridOptions.enableFooterTotalSelected !== false; + + /** + * @ngdoc object + * @name isRowSelectable + * @propertyOf ui.grid.selection.api:GridOptions + * @description Makes it possible to specify a method that evaluates for each row and sets its "enableSelection" property. + */ + gridOptions.isRowSelectable = angular.isDefined(gridOptions.isRowSelectable) ? gridOptions.isRowSelectable : angular.noop; + }, + + /** + * @ngdoc function + * @name toggleRowSelection + * @methodOf ui.grid.selection.service:uiGridSelectionService + * @description Toggles row as selected or unselected + * @param {Grid} grid grid object + * @param {GridRow} row row to select or deselect + * @param {Event} evt object if resulting from event + * @param {bool} multiSelect if false, only one row at time can be selected + * @param {bool} noUnselect if true then rows cannot be unselected + */ + toggleRowSelection: function (grid, row, evt, multiSelect, noUnselect) { + if ( row.enableSelection === false ) { + return; + } + + var selected = row.isSelected, + selectedRows; + + if (!multiSelect) { + if (!selected) { + service.clearSelectedRows(grid, evt); + } + else { + selectedRows = service.getSelectedRows(grid); + if (selectedRows.length > 1) { + selected = false; // Enable reselect of the row + service.clearSelectedRows(grid, evt); + } + } + } + + // only select row in this case + if (!(selected && noUnselect)) { + row.setSelected(!selected); + if (row.isSelected === true) { + grid.selection.lastSelectedRow = row; + } + + selectedRows = service.getSelectedRows(grid); + grid.selection.selectAll = grid.rows.length === selectedRows.length; + + grid.api.selection.raise.rowSelectionChanged(row, evt); + } + }, + /** + * @ngdoc function + * @name shiftSelect + * @methodOf ui.grid.selection.service:uiGridSelectionService + * @description selects a group of rows from the last selected row using the shift key + * @param {Grid} grid grid object + * @param {GridRow} row clicked row + * @param {Event} evt object if raised from an event + * @param {bool} multiSelect if false, does nothing this is for multiSelect only + */ + shiftSelect: function (grid, row, evt, multiSelect) { + if (!multiSelect) { + return; + } + var selectedRows = service.getSelectedRows(grid); + var fromRow = selectedRows.length > 0 ? grid.renderContainers.body.visibleRowCache.indexOf(grid.selection.lastSelectedRow) : 0; + var toRow = grid.renderContainers.body.visibleRowCache.indexOf(row); + // reverse select direction + if (fromRow > toRow) { + var tmp = fromRow; + fromRow = toRow; + toRow = tmp; + } + + var changedRows = []; + for (var i = fromRow; i <= toRow; i++) { + var rowToSelect = grid.renderContainers.body.visibleRowCache[i]; + if (rowToSelect) { + if (!rowToSelect.isSelected && rowToSelect.enableSelection !== false) { + rowToSelect.setSelected(true); + grid.selection.lastSelectedRow = rowToSelect; + service.decideRaiseSelectionEvent(grid, rowToSelect, changedRows, evt); + } + } + } + service.decideRaiseSelectionBatchEvent(grid, changedRows, evt); + }, + /** + * @ngdoc function + * @name getSelectedRows + * @methodOf ui.grid.selection.service:uiGridSelectionService + * @description Returns all the selected rows + * @param {Grid} grid grid object + */ + getSelectedRows: function (grid) { + return grid.rows.filter(function (row) { + return row.isSelected; + }); + }, + + /** + * @ngdoc function + * @name clearSelectedRows + * @methodOf ui.grid.selection.service:uiGridSelectionService + * @description Clears all selected rows + * @param {Grid} grid grid object + * @param {Event} evt object if raised from an event + */ + clearSelectedRows: function (grid, evt) { + var changedRows = []; + service.getSelectedRows(grid).forEach(function (row) { + if (row.isSelected) { + row.setSelected(false); + service.decideRaiseSelectionEvent(grid, row, changedRows, evt); + } + }); + grid.selection.selectAll = false; + grid.selection.selectedCount = 0; + service.decideRaiseSelectionBatchEvent(grid, changedRows, evt); + }, + + /** + * @ngdoc function + * @name decideRaiseSelectionEvent + * @methodOf ui.grid.selection.service:uiGridSelectionService + * @description Decides whether to raise a single event or a batch event + * @param {Grid} grid grid object + * @param {GridRow} row row that has changed + * @param {array} changedRows an array to which we can append the changed + * @param {Event} evt object if raised from an event + * row if we're doing batch events + */ + decideRaiseSelectionEvent: function (grid, row, changedRows, evt) { + if (!grid.options.enableSelectionBatchEvent) { + grid.api.selection.raise.rowSelectionChanged(row, evt); + } + else { + changedRows.push(row); + } + }, + + /** + * @ngdoc function + * @name raiseSelectionEvent + * @methodOf ui.grid.selection.service:uiGridSelectionService + * @description Decides whether we need to raise a batch event, and + * raises it if we do. + * @param {Grid} grid grid object + * @param {array} changedRows an array of changed rows, only populated + * @param {Event} evt object if raised from an event + * if we're doing batch events + */ + decideRaiseSelectionBatchEvent: function (grid, changedRows, evt) { + if (changedRows.length > 0) { + grid.api.selection.raise.rowSelectionChangedBatch(changedRows, evt); + } + } + }; + + return service; + }); + + /** + * @ngdoc directive + * @name ui.grid.selection.directive:uiGridSelection + * @element div + * @restrict A + * + * @description Adds selection features to grid + * + * @example +
+
+
+ \x3c!-- '),e.put("ui-grid/selectionRowHeader",'Beta This feature is ready for testing, but it either hasn't seen a lot of use or has some known bugs.
+ *
+ * This module provides base tree handling functions that are shared by other features, notably grouping
+ * and treeView. It provides a tree view of the data, with nodes in that
+ * tree and leaves.
+ *
+ * Design information:
+ * -------------------
+ *
+ * The raw data that is provided must come with a $$treeLevel on any non-leaf node. Grouping will create
+ * these on all the group header rows, treeView will expect these to be set in the raw data by the user.
+ * TreeBase will run a rowsProcessor that:
+ * - builds `treeBase.tree` out of the provided rows
+ * - permits a recursive sort of the tree
+ * - maintains the expand/collapse state of each node
+ * - provides the expand/collapse all button and the expand/collapse buttons
+ * - maintains the count of children for each node
+ *
+ * Each row is updated with a link to the tree node that represents it. Refer {@link ui.grid.treeBase.grid:treeBase.tree tree documentation}
+ * for information.
+ *
+ * TreeBase adds information to the rows
+ * - treeLevel: if present and > -1 tells us the level (level 0 is the top level)
+ * - treeNode: pointer to the node in the grid.treeBase.tree that refers
+ * to this row, allowing us to manipulate the state
+ *
+ * Since the logic is baked into the rowsProcessors, it should get triggered whenever
+ * row order or filtering or anything like that is changed. We recall the expanded state
+ * across invocations of the rowsProcessors by the reference to the treeNode on the individual
+ * rows. We rebuild the tree itself quite frequently, when we do this we use the saved treeNodes to
+ * get the state, but we overwrite the other data in that treeNode.
+ *
+ * By default rows are collapsed, which means all data rows have their visible property
+ * set to false, and only level 0 group rows are set to visible.
+ *
+ * We rely on the rowsProcessors to do the actual expanding and collapsing, so we set the flags we want into
+ * grid.treeBase.tree, then call refresh. This is because we can't easily change the visible
+ * row cache without calling the processors, and once we've built the logic into the rowProcessors we may as
+ * well use it all the time.
+ *
+ * Tree base provides sorting (on non-grouped columns).
+ *
+ * Sorting works in two passes. The standard sorting is performed for any columns that are important to building
+ * the tree (for example, any grouped columns). Then after the tree is built, a recursive tree sort is performed
+ * for the remaining sort columns (including the original sort) - these columns are sorted within each tree level
+ * (so all the level 1 nodes are sorted, then all the level 2 nodes within each level 1 node etc).
+ *
+ * To achieve this we make use of the `ignoreSort` property on the sort configuration. The parent feature (treeView or grouping)
+ * must provide a rowsProcessor that runs with very low priority (typically in the 60-65 range), and that sets
+ * the `ignoreSort`on any sort that it wants to run on the tree. TreeBase will clear the ignoreSort on all sorts - so it
+ * will turn on any sorts that haven't run. It will then call a recursive sort on the tree.
+ *
+ * Tree base provides treeAggregation. It checks the treeAggregation configuration on each column, and aggregates based on
+ * the logic provided as it builds the tree. Footer aggregation from the uiGrid core should not be used with treeBase aggregation,
+ * since it operates on all visible rows, as opposed to to leaf nodes only. Setting `showColumnFooter: true` will show the
+ * treeAggregations in the column footer. Aggregation information will be collected in the format:
+ *
+ * ```
+ * {
+ * type: 'count',
+ * value: 4,
+ * label: 'count: ',
+ * rendered: 'count: 4'
+ * }
+ * ```
+ *
+ * A callback is provided to format the value once it is finalised (aka a valueFilter).
+ *
+ * + * + * + * + */ + + var module = angular.module('ui.grid.treeBase', ['ui.grid']); + + /** + * @ngdoc object + * @name ui.grid.treeBase.constant:uiGridTreeBaseConstants + * + * @description constants available in treeBase module. + * + * These constants are manually copied into grouping and treeView, + * as I haven't found a way to simply include them, and it's not worth + * investing time in for something that changes very infrequently. + * + */ + module.constant('uiGridTreeBaseConstants', { + featureName: "treeBase", + rowHeaderColName: 'treeBaseRowHeaderCol', + EXPANDED: 'expanded', + COLLAPSED: 'collapsed', + aggregation: { + COUNT: 'count', + SUM: 'sum', + MAX: 'max', + MIN: 'min', + AVG: 'avg' + } + }); + + /** + * @ngdoc service + * @name ui.grid.treeBase.service:uiGridTreeBaseService + * + * @description Services for treeBase feature + */ + /** + * @ngdoc object + * @name ui.grid.treeBase.api:ColumnDef + * + * @description ColumnDef for tree feature, these are available to be + * set using the ui-grid {@link ui.grid.class:GridOptions.columnDef gridOptions.columnDefs} + */ + + module.service('uiGridTreeBaseService', ['$q', 'uiGridTreeBaseConstants', 'gridUtil', 'GridRow', 'gridClassFactory', 'i18nService', 'uiGridConstants', 'rowSorter', + function ($q, uiGridTreeBaseConstants, gridUtil, GridRow, gridClassFactory, i18nService, uiGridConstants, rowSorter) { + + var service = { + + initializeGrid: function (grid) { + + // add feature namespace and any properties to grid for needed + /** + * @ngdoc object + * @name ui.grid.treeBase.grid:treeBase + * + * @description Grid properties and functions added for treeBase + */ + grid.treeBase = {}; + + /** + * @ngdoc property + * @propertyOf ui.grid.treeBase.grid:treeBase + * @name numberLevels + * + * @description Total number of tree levels currently used, calculated by the rowsProcessor by + * retaining the highest tree level it sees + */ + grid.treeBase.numberLevels = 0; + + /** + * @ngdoc property + * @propertyOf ui.grid.treeBase.grid:treeBase + * @name expandAll + * + * @description Whether or not the expandAll box is selected + */ + grid.treeBase.expandAll = false; + + /** + * @ngdoc property + * @propertyOf ui.grid.treeBase.grid:treeBase + * @name tree + * + * @description Tree represented as a nested array that holds the state of each node, along with a + * pointer to the row. The array order is material - we will display the children in the order + * they are stored in the array + * + * Each node stores: + * + * - the state of this node + * - an array of children of this node + * - a pointer to the parent of this node (reverse pointer, allowing us to walk up the tree) + * - the number of children of this node + * - aggregation information calculated from the nodes + * + * ``` + * [{ + * state: 'expanded', + * row:
+ * gridApi.treeBase.on.rowExpanded(scope,function(row) {})
+ *
+ * @param {gridRow} row the row that was expanded. You can also
+ * retrieve the grid from this row with row.grid
+ */
+ rowExpanded: {},
+
+ /**
+ * @ngdoc event
+ * @eventOf ui.grid.treeBase.api:PublicApi
+ * @name rowCollapsed
+ * @description raised whenever a row is collapsed. Doesn't really have
+ * a purpose at the moment, included for symmetry
+ *
+ *
+ * gridApi.treeBase.on.rowCollapsed(scope,function(row) {})
+ *
+ * @param {gridRow} row the row that was collapsed. You can also
+ * retrieve the grid from this row with row.grid
+ */
+ rowCollapsed: {}
+ }
+ },
+
+ methods: {
+ treeBase: {
+ /**
+ * @ngdoc function
+ * @name expandAllRows
+ * @methodOf ui.grid.treeBase.api:PublicApi
+ * @description Expands all tree rows
+ */
+ expandAllRows: function () {
+ service.expandAllRows(grid);
+ },
+
+ /**
+ * @ngdoc function
+ * @name collapseAllRows
+ * @methodOf ui.grid.treeBase.api:PublicApi
+ * @description collapse all tree rows
+ */
+ collapseAllRows: function () {
+ service.collapseAllRows(grid);
+ },
+
+ /**
+ * @ngdoc function
+ * @name toggleRowTreeState
+ * @methodOf ui.grid.treeBase.api:PublicApi
+ * @description call expand if the row is collapsed, collapse if it is expanded
+ * @param {gridRow} row the row you wish to toggle
+ */
+ toggleRowTreeState: function (row) {
+ service.toggleRowTreeState(grid, row);
+ },
+
+ /**
+ * @ngdoc function
+ * @name expandRow
+ * @methodOf ui.grid.treeBase.api:PublicApi
+ * @description expand the immediate children of the specified row
+ * @param {gridRow} row the row you wish to expand
+ * @param {boolean} recursive true if you wish to expand the row's ancients
+ */
+ expandRow: function (row, recursive) {
+ service.expandRow(grid, row, recursive);
+ },
+
+ /**
+ * @ngdoc function
+ * @name expandRowChildren
+ * @methodOf ui.grid.treeBase.api:PublicApi
+ * @description expand all children of the specified row
+ * @param {gridRow} row the row you wish to expand
+ */
+ expandRowChildren: function (row) {
+ service.expandRowChildren(grid, row);
+ },
+
+ /**
+ * @ngdoc function
+ * @name collapseRow
+ * @methodOf ui.grid.treeBase.api:PublicApi
+ * @description collapse the specified row. When
+ * you expand the row again, all grandchildren will retain their state
+ * @param {gridRow} row the row you wish to collapse
+ */
+ collapseRow: function ( row ) {
+ service.collapseRow(grid, row);
+ },
+
+ /**
+ * @ngdoc function
+ * @name collapseRowChildren
+ * @methodOf ui.grid.treeBase.api:PublicApi
+ * @description collapse all children of the specified row. When
+ * you expand the row again, all grandchildren will be collapsed
+ * @param {gridRow} row the row you wish to collapse children for
+ */
+ collapseRowChildren: function ( row ) {
+ service.collapseRowChildren(grid, row);
+ },
+
+ /**
+ * @ngdoc function
+ * @name getTreeState
+ * @methodOf ui.grid.treeBase.api:PublicApi
+ * @description Get the tree state for this grid,
+ * used by the saveState feature
+ * Returned treeState as an object
+ * `{ expandedState: { uid: 'expanded', uid: 'collapsed' } }`
+ * where expandedState is a hash of row uid and the current expanded state
+ *
+ * @returns {object} tree state
+ *
+ * TODO - this needs work - we need an identifier that persists across instantiations,
+ * not uid. This really means we need a row identity defined, but that won't work for
+ * grouping. Perhaps this needs to be moved up to treeView and grouping, rather than
+ * being in base.
+ */
+ getTreeExpandedState: function () {
+ return { expandedState: service.getTreeState(grid) };
+ },
+
+ /**
+ * @ngdoc function
+ * @name setTreeState
+ * @methodOf ui.grid.treeBase.api:PublicApi
+ * @description Set the expanded states of the tree
+ * @param {object} config the config you want to apply, in the format
+ * provided by getTreeState
+ */
+ setTreeState: function ( config ) {
+ service.setTreeState( grid, config );
+ },
+
+ /**
+ * @ngdoc function
+ * @name getRowChildren
+ * @methodOf ui.grid.treeBase.api:PublicApi
+ * @description Get the children of the specified row
+ * @param {GridRow} row the row you want the children of
+ * @returns {Array} array of children of this row, the children
+ * are all gridRows
+ */
+ getRowChildren: function ( row ) {
+ return row.treeNode.children.map( function( childNode ) {
+ return childNode.row;
+ });
+ }
+ }
+ }
+ };
+
+ grid.api.registerEventsFromObject(publicApi.events);
+
+ grid.api.registerMethodsFromObject(publicApi.methods);
+ },
+
+
+ defaultGridOptions: function (gridOptions) {
+ // default option to true unless it was explicitly set to false
+ /**
+ * @ngdoc object
+ * @name ui.grid.treeBase.api:GridOptions
+ *
+ * @description GridOptions for treeBase feature, these are available to be
+ * set using the ui-grid {@link ui.grid.class:GridOptions gridOptions}
+ */
+
+ /**
+ * @ngdoc object
+ * @name treeRowHeaderBaseWidth
+ * @propertyOf ui.grid.treeBase.api:GridOptions
+ * @description Base width of the tree header, provides for a single level of tree. This
+ * is incremented by `treeIndent` for each extra level
+ * Defaults to 30 + */ + gridOptions.treeRowHeaderBaseWidth = gridOptions.treeRowHeaderBaseWidth || 30; + + /** + * @ngdoc object + * @name treeIndent + * @propertyOf ui.grid.treeBase.api:GridOptions + * @description Number of pixels of indent for the icon at each tree level, wider indents are visually more pleasing, + * but will make the tree row header wider + * Defaults to 10 + */ + gridOptions.treeIndent = (gridOptions.treeIndent != null) ? gridOptions.treeIndent : 10; + + /** + * @ngdoc object + * @name showTreeRowHeader + * @propertyOf ui.grid.treeBase.api:GridOptions + * @description If set to false, don't create the row header. You'll need to programmatically control the expand + * states + * Defaults to true + */ + gridOptions.showTreeRowHeader = gridOptions.showTreeRowHeader !== false; + + /** + * @ngdoc object + * @name showTreeExpandNoChildren + * @propertyOf ui.grid.treeBase.api:GridOptions + * @description If set to true, show the expand/collapse button even if there are no + * children of a node. You'd use this if you're planning to dynamically load the children + * + * Defaults to true, grouping overrides to false + */ + gridOptions.showTreeExpandNoChildren = gridOptions.showTreeExpandNoChildren !== false; + + /** + * @ngdoc object + * @name treeRowHeaderAlwaysVisible + * @propertyOf ui.grid.treeBase.api:GridOptions + * @description If set to true, row header even if there are no tree nodes + * + * Defaults to true + */ + gridOptions.treeRowHeaderAlwaysVisible = gridOptions.treeRowHeaderAlwaysVisible !== false; + + /** + * @ngdoc object + * @name treeCustomAggregations + * @propertyOf ui.grid.treeBase.api:GridOptions + * @description Define custom aggregation functions. The properties of this object will be + * aggregation types available for use on columnDef with {@link ui.grid.treeBase.api:ColumnDef treeAggregationType} or through the column menu. + * If a function defined here uses the same name as one of the native aggregations, this one will take precedence. + * The object format is: + * + *
+ * {
+ * aggregationName: {
+ * label: (optional) string,
+ * aggregationFn: function( aggregation, fieldValue, numValue, row ) {...},
+ * finalizerFn: (optional) function( aggregation ) {...}
+ * },
+ * mean: {
+ * label: 'mean',
+ * aggregationFn: function( aggregation, fieldValue, numValue ) {
+ * aggregation.count = (aggregation.count || 1) + 1;
+ * aggregation.sum = (aggregation.sum || 0) + numValue;
+ * },
+ * finalizerFn: function( aggregation ) {
+ * aggregation.value = aggregation.sum / aggregation.count
+ * }
+ * }
+ * }
+ *
+ *
+ * The `finalizerFn` may be used to manipulate the value before rendering, or to + * apply a custom rendered value. If `aggregation.rendered` is left undefined, the value will be + * rendered. Note that the native aggregation functions use an `finalizerFn` to concatenate + * the label and the value. + * + * Defaults to {} + */ + gridOptions.treeCustomAggregations = gridOptions.treeCustomAggregations || {}; + + /** + * @ngdoc object + * @name enableExpandAll + * @propertyOf ui.grid.treeBase.api:GridOptions + * @description Enable the expand all button at the top of the row header + * + * Defaults to true + */ + gridOptions.enableExpandAll = gridOptions.enableExpandAll !== false; + }, + + + /** + * @ngdoc function + * @name treeBaseColumnBuilder + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Sets the tree defaults based on the columnDefs + * + * @param {object} colDef columnDef we're basing on + * @param {GridColumn} col the column we're to update + * @param {object} gridOptions the options we should use + * @returns {promise} promise for the builder - actually we do it all inline so it's immediately resolved + */ + treeBaseColumnBuilder: function (colDef, col, gridOptions) { + + + /** + * @ngdoc object + * @name customTreeAggregationFn + * @propertyOf ui.grid.treeBase.api:ColumnDef + * @description A custom function that aggregates rows into some form of + * total. Aggregations run row-by-row, the function needs to be capable of + * creating a running total. + * + * The function will be provided the aggregation item (in which you can store running + * totals), the row value that is to be aggregated, and that same row value converted to + * a number (most aggregations work on numbers) + * @example + *
+ * customTreeAggregationFn = function ( aggregation, fieldValue, numValue, row ) {
+ * // calculates the average of the squares of the values
+ * if ( typeof(aggregation.count) === 'undefined' ) {
+ * aggregation.count = 0;
+ * }
+ * aggregation.count++;
+ *
+ * if ( !isNaN(numValue) ) {
+ * if ( typeof(aggregation.total) === 'undefined' ) {
+ * aggregation.total = 0;
+ * }
+ * aggregation.total = aggregation.total + numValue * numValue;
+ * }
+ *
+ * aggregation.value = aggregation.total / aggregation.count;
+ * }
+ *
+ * Defaults to undefined. May be overwritten by treeAggregationType, the two options should not be used together. + */ + if ( typeof(colDef.customTreeAggregationFn) !== 'undefined' ) { + col.treeAggregationFn = colDef.customTreeAggregationFn; + } + + /** + * @ngdoc object + * @name treeAggregationType + * @propertyOf ui.grid.treeBase.api:ColumnDef + * @description Use one of the native or grid-level aggregation methods for calculating aggregations on this column. + * Native method are in the constants file and include: SUM, COUNT, MIN, MAX, AVG. This may also be the property the + * name of an aggregation function defined with {@link ui.grid.treeBase.api:GridOptions treeCustomAggregations}. + * + * + * treeAggregationType = uiGridTreeBaseConstants.aggregation.SUM, + * } + *+ * + * If you are using aggregations you should either: + * + * - also use grouping, in which case the aggregations are displayed in the group header, OR + * - use treeView, in which case you can set `treeAggregationUpdateEntity: true` in the colDef, and + * treeBase will store the aggregation information in the entity, or you can set `treeAggregationUpdateEntity: false` + * in the colDef, and you need to manual retrieve the calculated aggregations from the row.treeNode.aggregations + * + * Takes precendence over a treeAggregationFn, the two options should not be used together. + * Defaults to undefined. + */ + if ( typeof(colDef.treeAggregationType) !== 'undefined' ) { + col.treeAggregation = { type: colDef.treeAggregationType }; + if ( typeof(gridOptions.treeCustomAggregations[colDef.treeAggregationType]) !== 'undefined' ) { + col.treeAggregationFn = gridOptions.treeCustomAggregations[colDef.treeAggregationType].aggregationFn; + col.treeAggregationFinalizerFn = gridOptions.treeCustomAggregations[colDef.treeAggregationType].finalizerFn; + col.treeAggregation.label = gridOptions.treeCustomAggregations[colDef.treeAggregationType].label; + } + else if ( typeof(service.nativeAggregations()[colDef.treeAggregationType]) !== 'undefined' ) { + col.treeAggregationFn = service.nativeAggregations()[colDef.treeAggregationType].aggregationFn; + col.treeAggregation.label = service.nativeAggregations()[colDef.treeAggregationType].label; + } + } + + /** + * @ngdoc object + * @name treeAggregationLabel + * @propertyOf ui.grid.treeBase.api:ColumnDef + * @description A custom label to use for this aggregation. If provided we don't use native i18n. + */ + if ( typeof(colDef.treeAggregationLabel) !== 'undefined' ) { + if (typeof(col.treeAggregation) === 'undefined' ) { + col.treeAggregation = {}; + } + col.treeAggregation.label = colDef.treeAggregationLabel; + } + + /** + * @ngdoc object + * @name treeAggregationUpdateEntity + * @propertyOf ui.grid.treeBase.api:ColumnDef + * @description Store calculated aggregations into the entity, allowing them + * to be displayed in the grid using a standard cellTemplate. This defaults to true, + * if you are using grouping then you shouldn't set it to false, as then the aggregations won't + * display. + * + * If you are using treeView in most cases you'll want to set this to true. This will result in + * getCellValue returning the aggregation rather than whatever was stored in the cell attribute on + * the entity. If you want to render the underlying entity value (and do something else with the aggregation) + * then you could use a custom cellTemplate to display `row.entity.myAttribute`, rather than using getCellValue. + * + * Defaults to true + * + * @example + *
+ * gridOptions.columns = [{
+ * name: 'myCol',
+ * treeAggregation: { type: uiGridTreeBaseConstants.aggregation.SUM },
+ * treeAggregationUpdateEntity: true
+ * cellTemplate: '
+ */
+ col.treeAggregationUpdateEntity = colDef.treeAggregationUpdateEntity !== false;
+
+ /**
+ * @ngdoc object
+ * @name customTreeAggregationFinalizerFn
+ * @propertyOf ui.grid.treeBase.api:ColumnDef
+ * @description A custom function that populates aggregation.rendered, this is called when
+ * a particular aggregation has been fully calculated, and we want to render the value.
+ *
+ * With the native aggregation options we just concatenate `aggregation.label` and
+ * `aggregation.value`, but if you wanted to apply a filter or otherwise manipulate the label
+ * or the value, you can do so with this function. This function will be called after the
+ * the default `finalizerFn`.
+ *
+ * @example
+ *
+ * customTreeAggregationFinalizerFn = function ( aggregation ) {
+ * aggregation.rendered = aggregation.label + aggregation.value / 100 + '%';
+ * }
+ *
+ * Defaults to undefined. + */ + if ( typeof(col.customTreeAggregationFinalizerFn) === 'undefined' ) { + col.customTreeAggregationFinalizerFn = colDef.customTreeAggregationFinalizerFn; + } + + }, + + + /** + * @ngdoc function + * @name createRowHeader + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Create the rowHeader. If treeRowHeaderAlwaysVisible then + * set it to visible, otherwise set it to invisible + * + * @param {Grid} grid grid object + */ + createRowHeader: function( grid ) { + var rowHeaderColumnDef = { + name: uiGridTreeBaseConstants.rowHeaderColName, + displayName: '', + width: grid.options.treeRowHeaderBaseWidth, + minWidth: 10, + cellTemplate: 'ui-grid/treeBaseRowHeader', + headerCellTemplate: 'ui-grid/treeBaseHeaderCell', + enableColumnResizing: false, + enableColumnMenu: false, + exporterSuppressExport: true, + allowCellFocus: true + }; + + rowHeaderColumnDef.visible = grid.options.treeRowHeaderAlwaysVisible; + grid.addRowHeaderColumn(rowHeaderColumnDef, -100); + }, + + + /** + * @ngdoc function + * @name expandAllRows + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Expands all nodes in the tree + * + * @param {Grid} grid grid object + */ + expandAllRows: function (grid) { + grid.treeBase.tree.forEach( function( node ) { + service.setAllNodes( grid, node, uiGridTreeBaseConstants.EXPANDED); + }); + grid.treeBase.expandAll = true; + grid.queueGridRefresh(); + }, + + + /** + * @ngdoc function + * @name collapseAllRows + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Collapses all nodes in the tree + * + * @param {Grid} grid grid object + */ + collapseAllRows: function (grid) { + grid.treeBase.tree.forEach( function( node ) { + service.setAllNodes( grid, node, uiGridTreeBaseConstants.COLLAPSED); + }); + grid.treeBase.expandAll = false; + grid.queueGridRefresh(); + }, + + + /** + * @ngdoc function + * @name setAllNodes + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Works through a subset of grid.treeBase.rowExpandedStates, setting + * all child nodes (and their descendents) of the provided node to the given state. + * + * Calls itself recursively on all nodes so as to achieve this. + * + * @param {Grid} grid the grid we're operating on (so we can raise events) + * @param {object} treeNode a node in the tree that we want to update + * @param {string} targetState the state we want to set it to + */ + setAllNodes: function (grid, treeNode, targetState) { + if ( typeof(treeNode.state) !== 'undefined' && treeNode.state !== targetState ) { + treeNode.state = targetState; + + if ( targetState === uiGridTreeBaseConstants.EXPANDED ) { + grid.api.treeBase.raise.rowExpanded(treeNode.row); + } + else { + grid.api.treeBase.raise.rowCollapsed(treeNode.row); + } + } + + // set all child nodes + if ( treeNode.children ) { + treeNode.children.forEach(function( childNode ) { + service.setAllNodes(grid, childNode, targetState); + }); + } + }, + + + /** + * @ngdoc function + * @name toggleRowTreeState + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Toggles the expand or collapse state of this grouped row, if + * it's a parent row + * + * @param {Grid} grid grid object + * @param {GridRow} row the row we want to toggle + */ + toggleRowTreeState: function ( grid, row ) { + if ( typeof(row.treeLevel) === 'undefined' || row.treeLevel === null || row.treeLevel < 0 ) { + return; + } + + if (row.treeNode.state === uiGridTreeBaseConstants.EXPANDED) { + service.collapseRow(grid, row); + } + else { + service.expandRow(grid, row, false); + } + + grid.queueGridRefresh(); + }, + + + /** + * @ngdoc function + * @name expandRow + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Expands this specific row, showing only immediate children. + * + * @param {Grid} grid grid object + * @param {GridRow} row the row we want to expand + * @param {boolean} recursive true if you wish to expand the row's ancients + */ + expandRow: function ( grid, row, recursive ) { + if ( recursive ) { + var parents = []; + while ( row && typeof(row.treeLevel) !== 'undefined' && row.treeLevel !== null && row.treeLevel >= 0 && row.treeNode.state !== uiGridTreeBaseConstants.EXPANDED ) { + parents.push(row); + row = row.treeNode.parentRow; + } + + if ( parents.length > 0 ) { + row = parents.pop(); + while ( row ) { + row.treeNode.state = uiGridTreeBaseConstants.EXPANDED; + grid.api.treeBase.raise.rowExpanded(row); + row = parents.pop(); + } + + grid.treeBase.expandAll = service.allExpanded(grid.treeBase.tree); + grid.queueGridRefresh(); + } + } + else { + if ( typeof(row.treeLevel) === 'undefined' || row.treeLevel === null || row.treeLevel < 0 ) { + return; + } + + if ( row.treeNode.state !== uiGridTreeBaseConstants.EXPANDED ) { + row.treeNode.state = uiGridTreeBaseConstants.EXPANDED; + grid.api.treeBase.raise.rowExpanded(row); + grid.treeBase.expandAll = service.allExpanded(grid.treeBase.tree); + grid.queueGridRefresh(); + } + } + }, + + + /** + * @ngdoc function + * @name expandRowChildren + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Expands this specific row, showing all children. + * + * @param {Grid} grid grid object + * @param {GridRow} row the row we want to expand + */ + expandRowChildren: function ( grid, row ) { + if ( typeof(row.treeLevel) === 'undefined' || row.treeLevel === null || row.treeLevel < 0 ) { + return; + } + + service.setAllNodes(grid, row.treeNode, uiGridTreeBaseConstants.EXPANDED); + grid.treeBase.expandAll = service.allExpanded(grid.treeBase.tree); + grid.queueGridRefresh(); + }, + + + /** + * @ngdoc function + * @name collapseRow + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Collapses this specific row + * + * @param {Grid} grid grid object + * @param {GridRow} row the row we want to collapse + */ + collapseRow: function( grid, row ) { + if ( typeof(row.treeLevel) === 'undefined' || row.treeLevel === null || row.treeLevel < 0 ) { + return; + } + + if ( row.treeNode.state !== uiGridTreeBaseConstants.COLLAPSED ) { + row.treeNode.state = uiGridTreeBaseConstants.COLLAPSED; + grid.treeBase.expandAll = false; + grid.api.treeBase.raise.rowCollapsed(row); + grid.queueGridRefresh(); + } + }, + + + /** + * @ngdoc function + * @name collapseRowChildren + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Collapses this specific row and all children + * + * @param {Grid} grid grid object + * @param {GridRow} row the row we want to collapse + */ + collapseRowChildren: function( grid, row ) { + if ( typeof(row.treeLevel) === 'undefined' || row.treeLevel === null || row.treeLevel < 0 ) { + return; + } + + service.setAllNodes(grid, row.treeNode, uiGridTreeBaseConstants.COLLAPSED); + grid.treeBase.expandAll = false; + grid.queueGridRefresh(); + }, + + + /** + * @ngdoc function + * @name allExpanded + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Returns true if all rows are expanded, false + * if they're not. Walks the tree to determine this. Used + * to set the expandAll state. + * + * If the node has no children, then return true (it's immaterial + * whether it is expanded). If the node has children, then return + * false if this node is collapsed, or if any child node is not all expanded + * + * @param {object} tree the grid to check + * @returns {boolean} whether or not the tree is all expanded + */ + allExpanded: function( tree ) { + var allExpanded = true; + + tree.forEach(function( node ) { + if ( !service.allExpandedInternal( node ) ) { + allExpanded = false; + } + }); + return allExpanded; + }, + + allExpandedInternal: function( treeNode ) { + if ( treeNode.children && treeNode.children.length > 0 ) { + if ( treeNode.state === uiGridTreeBaseConstants.COLLAPSED ) { + return false; + } + var allExpanded = true; + treeNode.children.forEach( function( node ) { + if ( !service.allExpandedInternal( node ) ) { + allExpanded = false; + } + }); + return allExpanded; + } + else { + return true; + } + }, + + + /** + * @ngdoc function + * @name treeRows + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description The rowProcessor that adds the nodes to the tree, and sets the visible + * state of each row based on it's parent state + * + * Assumes it is always called after the sorting processor, and the grouping processor if there is one. + * Performs any tree sorts itself after having built the tree + * + * Processes all the rows in order, setting the group level based on the $$treeLevel in the associated + * entity, and setting the visible state based on the parent's state. + * + * Calculates the deepest level of tree whilst it goes, and updates that so that the header column can be correctly + * sized. + * + * Aggregates if necessary along the way. + * + * @param {array} renderableRows the rows we want to process, usually the output from the previous rowProcessor + * @returns {array} the updated rows + */ + treeRows: function( renderableRows ) { + var grid = this; + + if (renderableRows.length === 0) { + service.updateRowHeaderWidth( grid ); + return renderableRows; + } + + grid.treeBase.tree = service.createTree( grid, renderableRows ); + service.updateRowHeaderWidth( grid ); + + service.sortTree( grid ); + service.fixFilter( grid ); + + return service.renderTree( grid.treeBase.tree ); + }, + + + /** + * @ngdoc function + * @name createOrUpdateRowHeaderWidth + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Calculates the rowHeader width. + * + * If rowHeader is always present, updates the width. + * + * If rowHeader is only sometimes present (`treeRowHeaderAlwaysVisible: false`), determines whether there + * should be one, then creates or removes it as appropriate, with the created rowHeader having the + * right width. + * + * If there's never a rowHeader then never creates one: `showTreeRowHeader: false` + * + * @param {Grid} grid the grid we want to set the row header on + */ + updateRowHeaderWidth: function( grid ) { + var rowHeader = grid.getColumn(uiGridTreeBaseConstants.rowHeaderColName), + newWidth = grid.options.treeRowHeaderBaseWidth + grid.options.treeIndent * Math.max(grid.treeBase.numberLevels - 1, 0); + + if ( rowHeader && newWidth !== rowHeader.width ) { + rowHeader.width = newWidth; + grid.queueRefresh(); + } + + var newVisibility = true; + + if ( grid.options.showTreeRowHeader === false ) { + newVisibility = false; + } + if ( grid.options.treeRowHeaderAlwaysVisible === false && grid.treeBase.numberLevels <= 0 ) { + newVisibility = false; + } + if ( rowHeader && rowHeader.visible !== newVisibility ) { + rowHeader.visible = newVisibility; + rowHeader.colDef.visible = newVisibility; + grid.queueGridRefresh(); + } + }, + + + /** + * @ngdoc function + * @name renderTree + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Creates an array of rows based on the tree, exporting only + * the visible nodes and leaves + * + * @param {array} nodeList The list of nodes - can be grid.treeBase.tree, or can be node.children when + * we're calling recursively + * @returns {array} renderable rows + */ + renderTree: function( nodeList ) { + var renderableRows = []; + + nodeList.forEach( function ( node ) { + if ( node.row.visible ) { + renderableRows.push( node.row ); + } + if ( node.state === uiGridTreeBaseConstants.EXPANDED && node.children && node.children.length > 0 ) { + renderableRows = renderableRows.concat( service.renderTree( node.children ) ); + } + }); + return renderableRows; + }, + + + /** + * @ngdoc function + * @name createTree + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Creates a tree from the renderableRows + * + * @param {Grid} grid The grid + * @param {array} renderableRows The rows we want to create a tree from + * @returns {object} The tree we've build + */ + createTree: function( grid, renderableRows ) { + var currentLevel = -1, + parentsCache = {}, + parents = [], + currentState; + + grid.treeBase.tree = []; + grid.treeBase.numberLevels = 0; + + var aggregations = service.getAggregations( grid ); + + function createNode( row ) { + if ( !row.internalRow && row.treeLevel !== row.entity.$$treeLevel ) { + row.treeLevel = row.entity.$$treeLevel; + } + + if ( row.treeLevel <= currentLevel ) { + // pop any levels that aren't parents of this level, formatting the aggregation at the same time + while ( row.treeLevel <= currentLevel ) { + var lastParent = parents.pop(); + service.finaliseAggregations( lastParent ); + currentLevel--; + } + + // reset our current state based on the new parent, set to expanded if this is a level 0 node + if ( parents.length > 0 ) { + currentState = service.setCurrentState(parents); + } + else { + currentState = uiGridTreeBaseConstants.EXPANDED; + } + } + + // If row header as parent exists in parentsCache + if ( + typeof row.treeLevel !== 'undefined' && + row.treeLevel !== null && + row.treeLevel >= 0 && + parentsCache.hasOwnProperty(row.uid) + ) { + parents.push(parentsCache[row.uid]); + } + + // aggregate if this is a leaf node + if ( ( typeof(row.treeLevel) === 'undefined' || row.treeLevel === null || row.treeLevel < 0 ) && row.visible ) { + service.aggregate( grid, row, parents ); + } + + // add this node to the tree + if (!parentsCache.hasOwnProperty(row.uid)) { + service.addOrUseNode(grid, row, parents, aggregations); + } + + if ( typeof(row.treeLevel) !== 'undefined' && row.treeLevel !== null && row.treeLevel >= 0 ) { + if (!parentsCache.hasOwnProperty(row.uid)) { + parentsCache[row.uid] = row; + parents.push(row); + } + currentLevel++; + currentState = service.setCurrentState(parents); + } + + // update the tree number of levels, so we can set header width if we need to + if ( grid.treeBase.numberLevels < row.treeLevel + 1) { + grid.treeBase.numberLevels = row.treeLevel + 1; + } + } + + renderableRows.forEach( createNode ); + + // finalize remaining aggregations + while ( parents.length > 0 ) { + var lastParent = parents.pop(); + service.finaliseAggregations( lastParent ); + } + + return grid.treeBase.tree; + }, + + + /** + * @ngdoc function + * @name addOrUseNode + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Creates a tree node for this row. If this row already has a treeNode + * recorded against it, preserves the state, but otherwise overwrites the data. + * + * @param {grid} grid The grid we're operating on + * @param {gridRow} row The row we want to set + * @param {array} parents An array of the parents this row should have + * @param {array} aggregationBase Empty aggregation information + * @returns {undefined} Updates the parents array, updates the row to have a treeNode, and updates the + * grid.treeBase.tree + */ + addOrUseNode: function( grid, row, parents, aggregationBase ) { + var newAggregations = []; + aggregationBase.forEach( function(aggregation) { + newAggregations.push(service.buildAggregationObject(aggregation.col)); + }); + + var newNode = { state: uiGridTreeBaseConstants.COLLAPSED, row: row, parentRow: null, aggregations: newAggregations, children: [] }; + if ( row.treeNode ) { + newNode.state = row.treeNode.state; + } + if ( parents.length > 0 ) { + newNode.parentRow = parents[parents.length - 1]; + } + row.treeNode = newNode; + + if ( parents.length === 0 ) { + grid.treeBase.tree.push( newNode ); + } else { + parents[parents.length - 1].treeNode.children.push( newNode ); + } + }, + + + /** + * @ngdoc function + * @name setCurrentState + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Looks at the parents array to determine our current state. + * If any node in the hierarchy is collapsed, then return collapsed, otherwise return + * expanded. + * + * @param {array} parents An array of the parents this row should have + * @returns {string} The state we should be setting to any nodes we see + */ + setCurrentState: function( parents ) { + var currentState = uiGridTreeBaseConstants.EXPANDED; + + parents.forEach( function(parent) { + if ( parent.treeNode.state === uiGridTreeBaseConstants.COLLAPSED ) { + currentState = uiGridTreeBaseConstants.COLLAPSED; + } + }); + return currentState; + }, + + + /** + * @ngdoc function + * @name sortTree + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Performs a recursive sort on the tree nodes, sorting the + * children of each node and putting them back into the children array. + * + * Before doing this it turns back on all the sortIgnore - things that were previously + * ignored we process now. Since we're sorting within the nodes, presumably anything + * that was already sorted is how we derived the nodes, we can keep those sorts too. + * + * We only sort tree nodes that are expanded - no point in wasting effort sorting collapsed + * nodes + * + * @param {Grid} grid The grid to get the aggregation information from + * @returns {array} The aggregation information + */ + sortTree: function( grid ) { + grid.columns.forEach( function( column ) { + if ( column.sort && column.sort.ignoreSort ) { + delete column.sort.ignoreSort; + } + }); + + grid.treeBase.tree = service.sortInternal( grid, grid.treeBase.tree ); + }, + + sortInternal: function( grid, treeList ) { + var rows = treeList.map( function( node ) { + return node.row; + }); + + rows = rowSorter.sort( grid, rows, grid.columns ); + + var treeNodes = rows.map( function( row ) { + return row.treeNode; + }); + + treeNodes.forEach( function( node ) { + if ( node.state === uiGridTreeBaseConstants.EXPANDED && node.children && node.children.length > 0 ) { + node.children = service.sortInternal( grid, node.children ); + } + }); + + return treeNodes; + }, + + /** + * @ngdoc function + * @name fixFilter + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description After filtering has run, we need to go back through the tree + * and make sure the parent rows are always visible if any of the child rows + * are visible (filtering may make a child visible, but the parent may not + * match the filter criteria) + * + * This has a risk of being computationally expensive, we do it by walking + * the tree and remembering whether there are any invisible nodes on the + * way down. + * + * @param {Grid} grid the grid to fix filters on + */ + fixFilter: function( grid ) { + var parentsVisible; + + grid.treeBase.tree.forEach( function( node ) { + if ( node.children && node.children.length > 0 ) { + parentsVisible = node.row.visible; + service.fixFilterInternal( node.children, parentsVisible ); + } + }); + }, + + fixFilterInternal: function( nodes, parentsVisible) { + nodes.forEach(function( node ) { + if ( node.row.visible && !parentsVisible ) { + service.setParentsVisible( node ); + parentsVisible = true; + } + + if ( node.children && node.children.length > 0 ) { + if ( service.fixFilterInternal( node.children, ( parentsVisible && node.row.visible ) ) ) { + parentsVisible = true; + } + } + }); + + return parentsVisible; + }, + + setParentsVisible: function( node ) { + while ( node.parentRow ) { + node.parentRow.visible = true; + node = node.parentRow.treeNode; + } + }, + + /** + * @ngdoc function + * @name buildAggregationObject + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Build the object which is stored on the column for holding meta-data about the aggregation. + * This method should only be called with columns which have an aggregation. + * + * @param {GridColumn} column The column which this object relates to + * @returns {object} {col: GridColumn object, label: string, type: string (optional)} + */ + buildAggregationObject: function( column ) { + var newAggregation = { col: column }; + + if ( column.treeAggregation && column.treeAggregation.type ) { + newAggregation.type = column.treeAggregation.type; + } + + if ( column.treeAggregation && column.treeAggregation.label ) { + newAggregation.label = column.treeAggregation.label; + } + + return newAggregation; + }, + + /** + * @ngdoc function + * @name getAggregations + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Looks through the grid columns to find those with aggregations, + * and collates the aggregation information into an array, returns that array + * + * @param {Grid} grid the grid to get the aggregation information from + * @returns {array} the aggregation information + */ + getAggregations: function( grid ) { + var aggregateArray = []; + + grid.columns.forEach( function(column) { + if ( typeof(column.treeAggregationFn) !== 'undefined' ) { + aggregateArray.push( service.buildAggregationObject(column) ); + + if ( grid.options.showColumnFooter && typeof(column.colDef.aggregationType) === 'undefined' && column.treeAggregation ) { + // Add aggregation object for footer + column.treeFooterAggregation = service.buildAggregationObject(column); + column.aggregationType = service.treeFooterAggregationType; + } + } + }); + return aggregateArray; + }, + + + /** + * @ngdoc function + * @name aggregate + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Accumulate the data from this row onto the aggregations for each parent + * + * Iterate over the parents, then iterate over the aggregations for each of those parents, + * and perform the aggregation for each individual aggregation + * + * @param {Grid} grid grid object + * @param {GridRow} row the row we want to set grouping visibility on + * @param {array} parents the parents that we would want to aggregate onto + */ + aggregate: function( grid, row, parents ) { + if (parents.length === 0 && row.treeNode && row.treeNode.aggregations) { + row.treeNode.aggregations.forEach(function(aggregation) { + // Calculate aggregations for footer even if there are no grouped rows + if (typeof(aggregation.col.treeFooterAggregation) !== 'undefined') { + var fieldValue = grid.getCellValue(row, aggregation.col); + var numValue = Number(fieldValue); + if (aggregation.col.treeAggregationFn) { + aggregation.col.treeAggregationFn(aggregation.col.treeFooterAggregation, fieldValue, numValue, row); + } else { + aggregation.col.treeFooterAggregation.value = undefined; + } + } + }); + } + + parents.forEach( function( parent, index ) { + if (parent.treeNode.aggregations) { + parent.treeNode.aggregations.forEach( function( aggregation ) { + var fieldValue = grid.getCellValue(row, aggregation.col); + var numValue = Number(fieldValue); + aggregation.col.treeAggregationFn(aggregation, fieldValue, numValue, row); + + if (index === 0 && typeof(aggregation.col.treeFooterAggregation) !== 'undefined') { + if (aggregation.col.treeAggregationFn) { + aggregation.col.treeAggregationFn(aggregation.col.treeFooterAggregation, fieldValue, numValue, row); + } else { + aggregation.col.treeFooterAggregation.value = undefined; + } + } + }); + } + }); + }, + + + // Aggregation routines - no doco needed as self evident + nativeAggregations: function() { + return { + count: { + label: i18nService.get().aggregation.count, + menuTitle: i18nService.get().grouping.aggregate_count, + aggregationFn: function (aggregation, fieldValue, numValue) { + if (typeof(aggregation.value) === 'undefined') { + aggregation.value = 1; + } else { + aggregation.value++; + } + } + }, + + sum: { + label: i18nService.get().aggregation.sum, + menuTitle: i18nService.get().grouping.aggregate_sum, + aggregationFn: function( aggregation, fieldValue, numValue ) { + if (!isNaN(numValue)) { + if (typeof(aggregation.value) === 'undefined') { + aggregation.value = numValue; + } else { + aggregation.value += numValue; + } + } + } + }, + + min: { + label: i18nService.get().aggregation.min, + menuTitle: i18nService.get().grouping.aggregate_min, + aggregationFn: function( aggregation, fieldValue, numValue ) { + if (typeof(aggregation.value) === 'undefined') { + aggregation.value = fieldValue; + } else { + if (typeof(fieldValue) !== 'undefined' && fieldValue !== null && (fieldValue < aggregation.value || aggregation.value === null)) { + aggregation.value = fieldValue; + } + } + } + }, + + max: { + label: i18nService.get().aggregation.max, + menuTitle: i18nService.get().grouping.aggregate_max, + aggregationFn: function( aggregation, fieldValue, numValue ) { + if ( typeof(aggregation.value) === 'undefined' ) { + aggregation.value = fieldValue; + } else { + if ( typeof(fieldValue) !== 'undefined' && fieldValue !== null && (fieldValue > aggregation.value || aggregation.value === null)) { + aggregation.value = fieldValue; + } + } + } + }, + + avg: { + label: i18nService.get().aggregation.avg, + menuTitle: i18nService.get().grouping.aggregate_avg, + aggregationFn: function( aggregation, fieldValue, numValue ) { + if ( typeof(aggregation.count) === 'undefined' ) { + aggregation.count = 1; + } else { + aggregation.count++; + } + + if ( isNaN(numValue) ) { + return; + } + + if ( typeof(aggregation.value) === 'undefined' || typeof(aggregation.sum) === 'undefined' ) { + aggregation.value = numValue; + aggregation.sum = numValue; + } else { + aggregation.sum += numValue; + aggregation.value = aggregation.sum / aggregation.count; + } + } + } + }; + }, + + /** + * @ngdoc function + * @name finaliseAggregation + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Helper function used to finalize aggregation nodes and footer cells + * + * @param {gridRow} row The parent we're finalising + * @param {aggregation} aggregation The aggregation object manipulated by the aggregationFn + */ + finaliseAggregation: function(row, aggregation) { + if ( aggregation.col.treeAggregationUpdateEntity && typeof(row) !== 'undefined' && typeof(row.entity[ '$$' + aggregation.col.uid ]) !== 'undefined' ) { + angular.extend( aggregation, row.entity[ '$$' + aggregation.col.uid ]); + } + + if ( typeof(aggregation.col.treeAggregationFinalizerFn) === 'function' ) { + aggregation.col.treeAggregationFinalizerFn( aggregation ); + } + if ( typeof(aggregation.col.customTreeAggregationFinalizerFn) === 'function' ) { + aggregation.col.customTreeAggregationFinalizerFn( aggregation ); + } + if ( typeof(aggregation.rendered) === 'undefined' ) { + aggregation.rendered = aggregation.label ? aggregation.label + aggregation.value : aggregation.value; + } + }, + + /** + * @ngdoc function + * @name finaliseAggregations + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Format the data from the aggregation into the rendered text + * e.g. if we had label: 'sum: ' and value: 25, we'd create 'sum: 25'. + * + * As part of this we call any formatting callback routines we've been provided. + * + * We write our aggregation out to the row.entity if treeAggregationUpdateEntity is + * set on the column - we don't overwrite any information that's already there, we append + * to it so that grouping can have set the groupVal beforehand without us overwriting it. + * + * We need to copy the data from the row.entity first before we finalise the aggregation, + * we need that information for the finaliserFn + * + * @param {gridRow} row the parent we're finalising + */ + finaliseAggregations: function( row ) { + if ( row == null || typeof(row.treeNode.aggregations) === 'undefined' ) { + return; + } + + row.treeNode.aggregations.forEach( function( aggregation ) { + service.finaliseAggregation(row, aggregation); + + if ( aggregation.col.treeAggregationUpdateEntity ) { + var aggregationCopy = {}; + + angular.forEach( aggregation, function( value, key ) { + if ( aggregation.hasOwnProperty(key) && key !== 'col' ) { + aggregationCopy[key] = value; + } + }); + + row.entity[ '$$' + aggregation.col.uid ] = aggregationCopy; + } + }); + }, + + /** + * @ngdoc function + * @name treeFooterAggregationType + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Uses the tree aggregation functions and finalizers to set the + * column footer aggregations. + * + * @param {rows} rows The visible rows. not used, but accepted to match signature of GridColumn.aggregationType + * @param {GridColumn} column The column we are finalizing + */ + treeFooterAggregationType: function( rows, column ) { + service.finaliseAggregation(undefined, column.treeFooterAggregation); + if ( typeof(column.treeFooterAggregation.value) === 'undefined' || column.treeFooterAggregation.rendered === null ) { + // The was apparently no aggregation performed (perhaps this is a grouped column + return ''; + } + return column.treeFooterAggregation.rendered; + } + }; + + return service; + }]); + + + /** + * @ngdoc directive + * @name ui.grid.treeBase.directive:uiGridTreeRowHeaderButtons + * @element div + * + * @description Provides the expand/collapse button on rows + */ + module.directive('uiGridTreeBaseRowHeaderButtons', ['$templateCache', 'uiGridTreeBaseService', + function ($templateCache, uiGridTreeBaseService) { + return { + replace: true, + restrict: 'E', + template: $templateCache.get('ui-grid/treeBaseRowHeaderButtons'), + scope: true, + require: '^uiGrid', + link: function($scope, $elm, $attrs, uiGridCtrl) { + var self = uiGridCtrl.grid; + $scope.treeButtonClass = function(row) { + if ( ( self.options.showTreeExpandNoChildren && row.treeLevel > -1 ) || ( row.treeNode.children && row.treeNode.children.length > 0 ) ) { + if (row.treeNode.state === 'expanded' ) { + return 'ui-grid-icon-minus-squared'; + } + if (row.treeNode.state === 'collapsed' ) { + return 'ui-grid-icon-plus-squared'; + } + } + }; + $scope.treeButtonClick = function(row, evt) { + evt.stopPropagation(); + uiGridTreeBaseService.toggleRowTreeState(self, row, evt); + }; + $scope.treeButtonKeyDown = function (row, evt) { + if (evt.keyCode === 32 || evt.keyCode === 13) { + $scope.treeButtonClick(row, evt); + } + }; + } + }; + }]); + + + /** + * @ngdoc directive + * @name ui.grid.treeBase.directive:uiGridTreeBaseExpandAllButtons + * @element div + * + * @description Provides the expand/collapse all button + */ + module.directive('uiGridTreeBaseExpandAllButtons', ['$templateCache', 'uiGridTreeBaseService', + function ($templateCache, uiGridTreeBaseService) { + return { + replace: true, + restrict: 'E', + template: $templateCache.get('ui-grid/treeBaseExpandAllButtons'), + scope: false, + link: function($scope) { + var self = $scope.col.grid; + $scope.headerButtonClass = function() { + if (self.treeBase.numberLevels > 0 && self.treeBase.expandAll) { + return 'ui-grid-icon-minus-squared'; + } + if (self.treeBase.numberLevels > 0 && !self.treeBase.expandAll) { + return 'ui-grid-icon-plus-squared'; + } + }; + $scope.headerButtonClick = function(row, evt) { + if ( self.treeBase.expandAll ) { + uiGridTreeBaseService.collapseAllRows(self, evt); + } else { + uiGridTreeBaseService.expandAllRows(self, evt); + } + }; + $scope.headerButtonKeyDown = function (evt) { + if (evt.keyCode === 32 || evt.keyCode === 13) { + $scope.headerButtonClick(self, evt); + } + }; + } + }; + }]); + + + /** + * @ngdoc directive + * @name ui.grid.treeBase.directive:uiGridViewport + * @element div + * + * @description Stacks on top of ui.grid.uiGridViewport to set formatting on a tree header row + */ + module.directive('uiGridViewport', + function () { + return { + priority: -200, // run after default directive + scope: false, + compile: function ($elm) { + var rowRepeatDiv = angular.element($elm.children().children()[0]); + + var existingNgClass = rowRepeatDiv.attr("ng-class"); + var newNgClass = ''; + if ( existingNgClass ) { + newNgClass = existingNgClass.slice(0, -1) + ",'ui-grid-tree-header-row': row.treeLevel > -1}"; + } else { + newNgClass = "{'ui-grid-tree-header-row': row.treeLevel > -1}"; + } + rowRepeatDiv.attr("ng-class", newNgClass); + + return { + pre: function ($scope, $elm, $attrs, controllers) { + + }, + post: function ($scope, $elm, $attrs, controllers) { + } + }; + } + }; + }); +})(); + +angular.module('ui.grid.treeBase').run(['$templateCache', function($templateCache) { + 'use strict'; + + $templateCache.put('ui-grid/treeBaseExpandAllButtons', + "" + ); + + + $templateCache.put('ui-grid/treeBaseHeaderCell', + " -1 }\" tabindex=\"0\" ng-keydown=\"treeButtonKeyDown(row, $event)\" ng-click=\"treeButtonClick(row, $event)\"> "
+ );
+
+}]);
diff --git a/release/4.9.2/ui-grid.tree-base.min.js b/release/4.9.2/ui-grid.tree-base.min.js
new file mode 100644
index 000000000..5150373cd
--- /dev/null
+++ b/release/4.9.2/ui-grid.tree-base.min.js
@@ -0,0 +1,7 @@
+/*!
+ * ui-grid - v4.9.2 - 2020-12-01
+ * Copyright (c) 2020 ; License: MIT
+ */
+
+
+!function(){"use strict";var e=angular.module("ui.grid.treeBase",["ui.grid"]);e.constant("uiGridTreeBaseConstants",{featureName:"treeBase",rowHeaderColName:"treeBaseRowHeaderCol",EXPANDED:"expanded",COLLAPSED:"collapsed",aggregation:{COUNT:"count",SUM:"sum",MAX:"max",MIN:"min",AVG:"avg"}}),e.service("uiGridTreeBaseService",["$q","uiGridTreeBaseConstants","gridUtil","GridRow","gridClassFactory","i18nService","uiGridConstants","rowSorter",function(e,l,t,r,n,o,a,i){var g={initializeGrid:function(r){r.treeBase={},r.treeBase.numberLevels=0,r.treeBase.expandAll=!1,r.treeBase.tree=[],g.defaultGridOptions(r.options),r.registerRowsProcessor(g.treeRows,410),r.registerColumnBuilder(g.treeBaseColumnBuilder),g.createRowHeader(r);var e={events:{treeBase:{rowExpanded:{},rowCollapsed:{}}},methods:{treeBase:{expandAllRows:function(){g.expandAllRows(r)},collapseAllRows:function(){g.collapseAllRows(r)},toggleRowTreeState:function(e){g.toggleRowTreeState(r,e)},expandRow:function(e,t){g.expandRow(r,e,t)},expandRowChildren:function(e){g.expandRowChildren(r,e)},collapseRow:function(e){g.collapseRow(r,e)},collapseRowChildren:function(e){g.collapseRowChildren(r,e)},getTreeExpandedState:function(){return{expandedState:g.getTreeState(r)}},setTreeState:function(e){g.setTreeState(r,e)},getRowChildren:function(e){return e.treeNode.children.map(function(e){return e.row})}}}};r.api.registerEventsFromObject(e.events),r.api.registerMethodsFromObject(e.methods)},defaultGridOptions:function(e){e.treeRowHeaderBaseWidth=e.treeRowHeaderBaseWidth||30,e.treeIndent=null!=e.treeIndent?e.treeIndent:10,e.showTreeRowHeader=!1!==e.showTreeRowHeader,e.showTreeExpandNoChildren=!1!==e.showTreeExpandNoChildren,e.treeRowHeaderAlwaysVisible=!1!==e.treeRowHeaderAlwaysVisible,e.treeCustomAggregations=e.treeCustomAggregations||{},e.enableExpandAll=!1!==e.enableExpandAll},treeBaseColumnBuilder:function(e,t,r){void 0!==e.customTreeAggregationFn&&(t.treeAggregationFn=e.customTreeAggregationFn),void 0!==e.treeAggregationType&&(t.treeAggregation={type:e.treeAggregationType},void 0!==r.treeCustomAggregations[e.treeAggregationType]?(t.treeAggregationFn=r.treeCustomAggregations[e.treeAggregationType].aggregationFn,t.treeAggregationFinalizerFn=r.treeCustomAggregations[e.treeAggregationType].finalizerFn,t.treeAggregation.label=r.treeCustomAggregations[e.treeAggregationType].label):void 0!==g.nativeAggregations()[e.treeAggregationType]&&(t.treeAggregationFn=g.nativeAggregations()[e.treeAggregationType].aggregationFn,t.treeAggregation.label=g.nativeAggregations()[e.treeAggregationType].label)),void 0!==e.treeAggregationLabel&&(void 0===t.treeAggregation&&(t.treeAggregation={}),t.treeAggregation.label=e.treeAggregationLabel),t.treeAggregationUpdateEntity=!1!==e.treeAggregationUpdateEntity,void 0===t.customTreeAggregationFinalizerFn&&(t.customTreeAggregationFinalizerFn=e.customTreeAggregationFinalizerFn)},createRowHeader:function(e){var t={name:l.rowHeaderColName,displayName:"",width:e.options.treeRowHeaderBaseWidth,minWidth:10,cellTemplate:"ui-grid/treeBaseRowHeader",headerCellTemplate:"ui-grid/treeBaseHeaderCell",enableColumnResizing:!1,enableColumnMenu:!1,exporterSuppressExport:!0,allowCellFocus:!0};t.visible=e.options.treeRowHeaderAlwaysVisible,e.addRowHeaderColumn(t,-100)},expandAllRows:function(t){t.treeBase.tree.forEach(function(e){g.setAllNodes(t,e,l.EXPANDED)}),t.treeBase.expandAll=!0,t.queueGridRefresh()},collapseAllRows:function(t){t.treeBase.tree.forEach(function(e){g.setAllNodes(t,e,l.COLLAPSED)}),t.treeBase.expandAll=!1,t.queueGridRefresh()},setAllNodes:function(t,e,r){void 0!==e.state&&e.state!==r&&((e.state=r)===l.EXPANDED?t.api.treeBase.raise.rowExpanded(e.row):t.api.treeBase.raise.rowCollapsed(e.row)),e.children&&e.children.forEach(function(e){g.setAllNodes(t,e,r)})},toggleRowTreeState:function(e,t){void 0===t.treeLevel||null===t.treeLevel||t.treeLevel<0||(t.treeNode.state===l.EXPANDED?g.collapseRow(e,t):g.expandRow(e,t,!1),e.queueGridRefresh())},expandRow:function(e,t,r){if(r){for(var n=[];t&&void 0!==t.treeLevel&&null!==t.treeLevel&&0<=t.treeLevel&&t.treeNode.state!==l.EXPANDED;)n.push(t),t=t.treeNode.parentRow;if(0Beta This feature is ready for testing, but it either hasn't seen a lot of use or has some known bugs.
+ *
+ * This module provides a tree view of the data that it is provided, with nodes in that
+ * tree and leaves. Unlike grouping, the tree is an inherent property of the data and must
+ * be provided with your data array.
+ *
+ * Design information:
+ * -------------------
+ *
+ * TreeView uses treeBase for the underlying functionality, and is a very thin wrapper around
+ * that logic. Most of the design information has now moved to treebase.
+ * + * + * + * + */ + + var module = angular.module('ui.grid.treeView', ['ui.grid', 'ui.grid.treeBase']); + + /** + * @ngdoc object + * @name ui.grid.treeView.constant:uiGridTreeViewConstants + * + * @description constants available in treeView module, this includes + * all the constants declared in the treeBase module (these are manually copied + * as there isn't an easy way to include constants in another constants file, and + * we don't want to make users include treeBase) + * + */ + module.constant('uiGridTreeViewConstants', { + featureName: "treeView", + rowHeaderColName: 'treeBaseRowHeaderCol', + EXPANDED: 'expanded', + COLLAPSED: 'collapsed', + aggregation: { + COUNT: 'count', + SUM: 'sum', + MAX: 'max', + MIN: 'min', + AVG: 'avg' + } + }); + + /** + * @ngdoc service + * @name ui.grid.treeView.service:uiGridTreeViewService + * + * @description Services for treeView features + */ + module.service('uiGridTreeViewService', ['$q', 'uiGridTreeViewConstants', 'uiGridTreeBaseConstants', 'uiGridTreeBaseService', 'gridUtil', 'GridRow', 'gridClassFactory', 'i18nService', 'uiGridConstants', + function ($q, uiGridTreeViewConstants, uiGridTreeBaseConstants, uiGridTreeBaseService, gridUtil, GridRow, gridClassFactory, i18nService, uiGridConstants) { + + var service = { + + initializeGrid: function (grid, $scope) { + uiGridTreeBaseService.initializeGrid( grid, $scope ); + + /** + * @ngdoc object + * @name ui.grid.treeView.grid:treeView + * + * @description Grid properties and functions added for treeView + */ + grid.treeView = {}; + + grid.registerRowsProcessor(service.adjustSorting, 60); + + /** + * @ngdoc object + * @name ui.grid.treeView.api:PublicApi + * + * @description Public Api for treeView feature + */ + var publicApi = { + events: { + treeView: { + } + }, + methods: { + treeView: { + } + } + }; + + grid.api.registerEventsFromObject(publicApi.events); + + grid.api.registerMethodsFromObject(publicApi.methods); + + }, + + defaultGridOptions: function (gridOptions) { + // default option to true unless it was explicitly set to false + /** + * @ngdoc object + * @name ui.grid.treeView.api:GridOptions + * + * @description GridOptions for treeView feature, these are available to be + * set using the ui-grid {@link ui.grid.class:GridOptions gridOptions} + * + * Many tree options are set on treeBase, make sure to look at that feature in + * conjunction with these options. + */ + + /** + * @ngdoc object + * @name enableTreeView + * @propertyOf ui.grid.treeView.api:GridOptions + * @description Enable row tree view for entire grid. + * Defaults to true + */ + gridOptions.enableTreeView = gridOptions.enableTreeView !== false; + + }, + + + /** + * @ngdoc function + * @name adjustSorting + * @methodOf ui.grid.treeBase.service:uiGridTreeBaseService + * @description Trees cannot be sorted the same as flat lists of rows - + * trees are sorted recursively within each level - so the children of each + * node are sorted, but not the full set of rows. + * + * To achieve this, we suppress the normal sorting by setting ignoreSort on + * each of the sort columns. When the treeBase rowsProcessor runs it will then + * unignore these, and will perform a recursive sort against the tree that it builds. + * + * @param {array} renderableRows the rows that we need to pass on through + * @returns {array} renderableRows that we passed on through + */ + adjustSorting: function( renderableRows ) { + var grid = this; + + grid.columns.forEach( function( column ) { + if ( column.sort ) { + column.sort.ignoreSort = true; + } + }); + + return renderableRows; + } + }; + + return service; + }]); + + /** + * @ngdoc directive + * @name ui.grid.treeView.directive:uiGridTreeView + * @element div + * @restrict A + * + * @description Adds treeView features to grid + * + * @example +
+
+
+ Alpha This feature is in development. There will almost certainly be breaking api changes, or there are major outstanding bugs.
+ *
+ * This module provides the ability to validate cells upon change.
+ *
+ * Design information:
+ * -------------------
+ *
+ * Validation is not based on angularjs validation, since it would work only when editing the field.
+ *
+ * Instead it adds custom properties to any field considered as invalid.
+ *
+ * + * + * + * + */ + var module = angular.module('ui.grid.validate', ['ui.grid']); + + /** + * @ngdoc service + * @name ui.grid.validate.service:uiGridValidateService + * + * @description Services for validation features + */ + module.service('uiGridValidateService', ['$sce', '$q', '$http', 'i18nService', 'uiGridConstants', function ($sce, $q, $http, i18nService, uiGridConstants) { + + var service = { + + /** + * @ngdoc object + * @name validatorFactories + * @propertyOf ui.grid.validate.service:uiGridValidateService + * @description object containing all the factories used to validate data. + * These factories will be in the form + * ``` + * { + * validatorFactory: function(argument) { + * return function(newValue, oldValue, rowEntity, colDef) { + * return true || false || promise + * } + * }, + * messageFunction: function(argument) { + * return string + * } + * } + * ``` + * + * Promises should return true or false as result according to the result of validation. + */ + validatorFactories: {}, + + /** + * @ngdoc service + * @name setExternalFactoryFunction + * @methodOf ui.grid.validate.service:uiGridValidateService + * @description Adds a way to retrieve validators from an external service + * Validators from this external service have a higher priority than default
+ * ones
+ * @param {function} externalFactoryFunction a function that accepts name and argument to pass to a
+ * validator factory and that returns an object with the same properties as
+ * you can see in {@link ui.grid.validate.service:uiGridValidateService#properties_validatorFactories validatorFactories}
+ */
+ setExternalFactoryFunction: function(externalFactoryFunction) {
+ service.externalFactoryFunction = externalFactoryFunction;
+ },
+
+ /**
+ * @ngdoc service
+ * @name clearExternalFactory
+ * @methodOf ui.grid.validate.service:uiGridValidateService
+ * @description Removes any link to external factory from this service
+ */
+ clearExternalFactory: function() {
+ delete service.externalFactoryFunction;
+ },
+
+ /**
+ * @ngdoc service
+ * @name getValidatorFromExternalFactory
+ * @methodOf ui.grid.validate.service:uiGridValidateService
+ * @description Retrieves a validator by executing a validatorFactory
+ * stored in an external service.
+ * @param {string} name the name of the validator to retrieve
+ * @param {object} argument an argument to pass to the validator factory
+ */
+ getValidatorFromExternalFactory: function(name, argument) {
+ return service.externalFactoryFunction(name, argument).validatorFactory(argument);
+ },
+
+ /**
+ * @ngdoc service
+ * @name getMessageFromExternalFactory
+ * @methodOf ui.grid.validate.service:uiGridValidateService
+ * @description Retrieves a message stored in an external service.
+ * @param {string} name the name of the validator
+ * @param {object} argument an argument to pass to the message function
+ */
+ getMessageFromExternalFactory: function(name, argument) {
+ return service.externalFactoryFunction(name, argument).messageFunction(argument);
+ },
+
+ /**
+ * @ngdoc service
+ * @name setValidator
+ * @methodOf ui.grid.validate.service:uiGridValidateService
+ * @description Adds a new validator to the service
+ * @param {string} name the name of the validator, must be unique
+ * @param {function} validatorFactory a factory that return a validatorFunction
+ * @param {function} messageFunction a function that return the error message
+ */
+ setValidator: function(name, validatorFactory, messageFunction) {
+ service.validatorFactories[name] = {
+ validatorFactory: validatorFactory,
+ messageFunction: messageFunction
+ };
+ },
+
+ /**
+ * @ngdoc service
+ * @name getValidator
+ * @methodOf ui.grid.validate.service:uiGridValidateService
+ * @description Returns a validator registered to the service
+ * or retrieved from the external factory
+ * @param {string} name the name of the validator to retrieve
+ * @param {object} argument an argument to pass to the validator factory
+ * @returns {object} the validator function
+ */
+ getValidator: function(name, argument) {
+ if (service.externalFactoryFunction) {
+ var validator = service.getValidatorFromExternalFactory(name, argument);
+ if (validator) {
+ return validator;
+ }
+ }
+ if (!service.validatorFactories[name]) {
+ throw ("Invalid validator name: " + name);
+ }
+ return service.validatorFactories[name].validatorFactory(argument);
+ },
+
+ /**
+ * @ngdoc service
+ * @name getMessage
+ * @methodOf ui.grid.validate.service:uiGridValidateService
+ * @description Returns the error message related to the validator
+ * @param {string} name the name of the validator
+ * @param {object} argument an argument to pass to the message function
+ * @returns {string} the error message related to the validator
+ */
+ getMessage: function(name, argument) {
+ if (service.externalFactoryFunction) {
+ var message = service.getMessageFromExternalFactory(name, argument);
+ if (message) {
+ return message;
+ }
+ }
+ return service.validatorFactories[name].messageFunction(argument);
+ },
+
+ /**
+ * @ngdoc service
+ * @name isInvalid
+ * @methodOf ui.grid.validate.service:uiGridValidateService
+ * @description Returns true if the cell (identified by rowEntity, colDef) is invalid
+ * @param {object} rowEntity the row entity of the cell
+ * @param {object} colDef the colDef of the cell
+ * @returns {boolean} true if the cell is invalid
+ */
+ isInvalid: function (rowEntity, colDef) {
+ return rowEntity['$$invalid'+colDef.name];
+ },
+
+ /**
+ * @ngdoc service
+ * @name setInvalid
+ * @methodOf ui.grid.validate.service:uiGridValidateService
+ * @description Makes the cell invalid by adding the proper field to the entity
+ * @param {object} rowEntity the row entity of the cell
+ * @param {object} colDef the colDef of the cell
+ */
+ setInvalid: function (rowEntity, colDef) {
+ rowEntity['$$invalid'+colDef.name] = true;
+ },
+
+ /**
+ * @ngdoc service
+ * @name setValid
+ * @methodOf ui.grid.validate.service:uiGridValidateService
+ * @description Makes the cell valid by removing the proper error field from the entity
+ * @param {object} rowEntity the row entity of the cell
+ * @param {object} colDef the colDef of the cell
+ */
+ setValid: function (rowEntity, colDef) {
+ delete rowEntity['$$invalid'+colDef.name];
+ },
+
+ /**
+ * @ngdoc service
+ * @name setError
+ * @methodOf ui.grid.validate.service:uiGridValidateService
+ * @description Adds the proper error to the entity errors field
+ * @param {object} rowEntity the row entity of the cell
+ * @param {object} colDef the colDef of the cell
+ * @param {string} validatorName the name of the validator that is failing
+ */
+ setError: function(rowEntity, colDef, validatorName) {
+ if (!rowEntity['$$errors'+colDef.name]) {
+ rowEntity['$$errors'+colDef.name] = {};
+ }
+ rowEntity['$$errors'+colDef.name][validatorName] = true;
+ },
+
+ /**
+ * @ngdoc service
+ * @name clearError
+ * @methodOf ui.grid.validate.service:uiGridValidateService
+ * @description Removes the proper error from the entity errors field
+ * @param {object} rowEntity the row entity of the cell
+ * @param {object} colDef the colDef of the cell
+ * @param {string} validatorName the name of the validator that is failing
+ */
+ clearError: function(rowEntity, colDef, validatorName) {
+ if (!rowEntity['$$errors'+colDef.name]) {
+ return;
+ }
+ if (validatorName in rowEntity['$$errors'+colDef.name]) {
+ delete rowEntity['$$errors'+colDef.name][validatorName];
+ }
+ },
+
+ /**
+ * @ngdoc function
+ * @name getErrorMessages
+ * @methodOf ui.grid.validate.service:uiGridValidateService
+ * @description returns an array of i18n-ed error messages.
+ * @param {object} rowEntity gridOptions.data[] array instance whose errors we are looking for
+ * @param {object} colDef the column whose errors we are looking for
+ * @returns {array} An array of strings containing all the error messages for the cell
+ */
+ getErrorMessages: function(rowEntity, colDef) {
+ var errors = [];
+
+ if (!rowEntity['$$errors'+colDef.name] || Object.keys(rowEntity['$$errors'+colDef.name]).length === 0) {
+ return errors;
+ }
+
+ Object.keys(rowEntity['$$errors'+colDef.name]).sort().forEach(function(validatorName) {
+ errors.push(service.getMessage(validatorName, colDef.validators[validatorName]));
+ });
+
+ return errors;
+ },
+
+ /**
+ * @ngdoc function
+ * @name getFormattedErrors
+ * @methodOf ui.grid.validate.service:uiGridValidateService
+ * @description returns the error i18n-ed and formatted in html to be shown inside the page.
+ * @param {object} rowEntity gridOptions.data[] array instance whose errors we are looking for
+ * @param {object} colDef the column whose errors we are looking for
+ * @returns {object} An object that can be used in a template (like a cellTemplate) to display the
+ * message inside the page (i.e. inside a div)
+ */
+ getFormattedErrors: function(rowEntity, colDef) {
+ var msgString = "",
+ errors = service.getErrorMessages(rowEntity, colDef);
+
+ if (!errors.length) {
+ return;
+ }
+
+ errors.forEach(function(errorMsg) {
+ msgString += errorMsg + " ' + i18nService.getSafeText('validate.error') + ' ' + msgString ); + }, + + /** + * @ngdoc function + * @name getTitleFormattedErrors + * @methodOf ui.grid.validate.service:uiGridValidateService + * @description returns the error i18n-ed and formatted in javaScript to be shown inside an html + * title attribute. + * @param {object} rowEntity gridOptions.data[] array instance whose errors we are looking for + * @param {object} colDef the column whose errors we are looking for + * @returns {object} An object that can be used in a template (like a cellTemplate) to display the + * message inside an html title attribute + */ + getTitleFormattedErrors: function(rowEntity, colDef) { + var newLine = "\n", + msgString = "", + errors = service.getErrorMessages(rowEntity, colDef); + + if (!errors.length) { + return; + } + + errors.forEach(function(errorMsg) { + msgString += errorMsg + newLine; + }); + + return $sce.trustAsHtml(i18nService.getSafeText('validate.error') + newLine + msgString); + }, + + /** + * @ngdoc function + * @name getTitleFormattedErrors + * @methodOf ui.grid.validate.service:uiGridValidateService + * @description Executes all validators on a cell (identified by row entity and column definition) and sets or clears errors + * @param {object} rowEntity the row entity of the cell we want to run the validators on + * @param {object} colDef the column definition of the cell we want to run the validators on + * @param {object} newValue the value the user just entered + * @param {object} oldValue the value the field had before + */ + runValidators: function(rowEntity, colDef, newValue, oldValue, grid) { + if (newValue === oldValue) { + // If the value has not changed we perform no validation + return; + } + + if (typeof(colDef.name) === 'undefined' || !colDef.name) { + throw new Error('colDef.name is required to perform validation'); + } + + service.setValid(rowEntity, colDef); + + var validateClosureFactory = function(rowEntity, colDef, validatorName) { + return function(value) { + if (!value) { + service.setInvalid(rowEntity, colDef); + service.setError(rowEntity, colDef, validatorName); + if (grid) { + grid.api.validate.raise.validationFailed(rowEntity, colDef, newValue, oldValue); + } + } + }; + }; + + var promises = []; + + for (var validatorName in colDef.validators) { + service.clearError(rowEntity, colDef, validatorName); + var validatorFunction = service.getValidator(validatorName, colDef.validators[validatorName]); + + // We pass the arguments as oldValue, newValue so they are in the same order + // as ng-model validators (modelValue, viewValue) + var promise = $q.when(validatorFunction(oldValue, newValue, rowEntity, colDef)) + .then(validateClosureFactory(rowEntity, colDef, validatorName)); + + promises.push(promise); + } + + return $q.all(promises); + }, + + /** + * @ngdoc function + * @name createDefaultValidators + * @methodOf ui.grid.validate.service:uiGridValidateService + * @description adds the basic validators to the list of service validators + */ + createDefaultValidators: function() { + service.setValidator('minLength', function (argument) { + return function (oldValue, newValue) { + if (newValue === undefined || newValue === null || newValue === '') { + return true; + } + return newValue.length >= argument; + }; + }, function(argument) { + return i18nService.getSafeText('validate.minLength').replace('THRESHOLD', argument); + }); + + service.setValidator('maxLength', function (argument) { + return function (oldValue, newValue) { + if (newValue === undefined || newValue === null || newValue === '') { + return true; + } + return newValue.length <= argument; + }; + }, function(threshold) { + return i18nService.getSafeText('validate.maxLength').replace('THRESHOLD', threshold); + }); + + service.setValidator('required', function (argument) { + return function (oldValue, newValue) { + if (argument) { + return !(newValue === undefined || newValue === null || newValue === ''); + } + return true; + }; + }, function() { + return i18nService.getSafeText('validate.required'); + }); + }, + + initializeGrid: function (scope, grid) { + grid.validate = { + + isInvalid: service.isInvalid, + + getErrorMessages: service.getErrorMessages, + + getFormattedErrors: service.getFormattedErrors, + + getTitleFormattedErrors: service.getTitleFormattedErrors, + + runValidators: service.runValidators + }; + + /** + * @ngdoc object + * @name ui.grid.validate.api:PublicApi + * + * @description Public Api for validation feature + */ + var publicApi = { + events: { + validate: { + /** + * @ngdoc event + * @name validationFailed + * @eventOf ui.grid.validate.api:PublicApi + * @description raised when one or more failure happened during validation + *
+ * gridApi.validate.on.validationFailed(scope, function(rowEntity, colDef, newValue, oldValue){...})
+ *
+ * @param {object} rowEntity the options.data element whose validation failed
+ * @param {object} colDef the column whose validation failed
+ * @param {object} newValue new value
+ * @param {object} oldValue old value
+ */
+ validationFailed: function (rowEntity, colDef, newValue, oldValue) {
+ }
+ }
+ },
+ methods: {
+ validate: {
+ /**
+ * @ngdoc function
+ * @name isInvalid
+ * @methodOf ui.grid.validate.api:PublicApi
+ * @description checks if a cell (identified by rowEntity, colDef) is invalid
+ * @param {object} rowEntity gridOptions.data[] array instance we want to check
+ * @param {object} colDef the column whose errors we want to check
+ * @returns {boolean} true if the cell value is not valid
+ */
+ isInvalid: function(rowEntity, colDef) {
+ return grid.validate.isInvalid(rowEntity, colDef);
+ },
+ /**
+ * @ngdoc function
+ * @name getErrorMessages
+ * @methodOf ui.grid.validate.api:PublicApi
+ * @description returns an array of i18n-ed error messages.
+ * @param {object} rowEntity gridOptions.data[] array instance whose errors we are looking for
+ * @param {object} colDef the column whose errors we are looking for
+ * @returns {array} An array of strings containing all the error messages for the cell
+ */
+ getErrorMessages: function (rowEntity, colDef) {
+ return grid.validate.getErrorMessages(rowEntity, colDef);
+ },
+ /**
+ * @ngdoc function
+ * @name getFormattedErrors
+ * @methodOf ui.grid.validate.api:PublicApi
+ * @description returns the error i18n-ed and formatted in html to be shown inside the page.
+ * @param {object} rowEntity gridOptions.data[] array instance whose errors we are looking for
+ * @param {object} colDef the column whose errors we are looking for
+ * @returns {object} An object that can be used in a template (like a cellTemplate) to display the
+ * message inside the page (i.e. inside a div)
+ */
+ getFormattedErrors: function (rowEntity, colDef) {
+ return grid.validate.getFormattedErrors(rowEntity, colDef);
+ },
+ /**
+ * @ngdoc function
+ * @name getTitleFormattedErrors
+ * @methodOf ui.grid.validate.api:PublicApi
+ * @description returns the error i18n-ed and formatted in javaScript to be shown inside an html
+ * title attribute.
+ * @param {object} rowEntity gridOptions.data[] array instance whose errors we are looking for
+ * @param {object} colDef the column whose errors we are looking for
+ * @returns {object} An object that can be used in a template (like a cellTemplate) to display the
+ * message inside an html title attribute
+ */
+ getTitleFormattedErrors: function (rowEntity, colDef) {
+ return grid.validate.getTitleFormattedErrors(rowEntity, colDef);
+ }
+ }
+ }
+ };
+
+ grid.api.registerEventsFromObject(publicApi.events);
+ grid.api.registerMethodsFromObject(publicApi.methods);
+
+ if (grid.edit) {
+ grid.api.edit.on.afterCellEdit(scope, function(rowEntity, colDef, newValue, oldValue) {
+ grid.validate.runValidators(rowEntity, colDef, newValue, oldValue, grid);
+ });
+ }
+
+ service.createDefaultValidators();
+ }
+ };
+
+ return service;
+ }]);
+
+ /**
+ * @ngdoc directive
+ * @name ui.grid.validate.directive:uiGridValidate
+ * @element div
+ * @restrict A
+ * @description Adds validating features to the ui-grid directive.
+ * @example
+
+
+
+ {{COL_FIELD CUSTOM_FILTERS}} "
+ );
+
+
+ $templateCache.put('ui-grid/cellTooltipValidator',
+ "{{COL_FIELD CUSTOM_FILTERS}} "
+ );
+
+}]);
diff --git a/release/4.9.2/ui-grid.validate.min.js b/release/4.9.2/ui-grid.validate.min.js
new file mode 100644
index 000000000..bd1d6b9e3
--- /dev/null
+++ b/release/4.9.2/ui-grid.validate.min.js
@@ -0,0 +1,7 @@
+/*!
+ * ui-grid - v4.9.2 - 2020-12-01
+ * Copyright (c) 2020 ; License: MIT
+ */
+
+
+!function(){"use strict";var t=angular.module("ui.grid.validate",["ui.grid"]);t.service("uiGridValidateService",["$sce","$q","$http","i18nService","uiGridConstants",function(i,c,t,n,r){var u={validatorFactories:{},setExternalFactoryFunction:function(t){u.externalFactoryFunction=t},clearExternalFactory:function(){delete u.externalFactoryFunction},getValidatorFromExternalFactory:function(t,r){return u.externalFactoryFunction(t,r).validatorFactory(r)},getMessageFromExternalFactory:function(t,r){return u.externalFactoryFunction(t,r).messageFunction(r)},setValidator:function(t,r,e){u.validatorFactories[t]={validatorFactory:r,messageFunction:e}},getValidator:function(t,r){if(u.externalFactoryFunction){var e=u.getValidatorFromExternalFactory(t,r);if(e)return e}if(!u.validatorFactories[t])throw"Invalid validator name: "+t;return u.validatorFactories[t].validatorFactory(r)},getMessage:function(t,r){if(u.externalFactoryFunction){var e=u.getMessageFromExternalFactory(t,r);if(e)return e}return u.validatorFactories[t].messageFunction(r)},isInvalid:function(t,r){return t["$$invalid"+r.name]},setInvalid:function(t,r){t["$$invalid"+r.name]=!0},setValid:function(t,r){delete t["$$invalid"+r.name]},setError:function(t,r,e){t["$$errors"+r.name]||(t["$$errors"+r.name]={}),t["$$errors"+r.name][e]=!0},clearError:function(t,r,e){t["$$errors"+r.name]&&e in t["$$errors"+r.name]&&delete t["$$errors"+r.name][e]},getErrorMessages:function(t,r){var e=[];return t["$$errors"+r.name]&&0!==Object.keys(t["$$errors"+r.name]).length&&Object.keys(t["$$errors"+r.name]).sort().forEach(function(t){e.push(u.getMessage(t,r.validators[t]))}),e},getFormattedErrors:function(t,r){var e="",a=u.getErrorMessages(t,r);if(a.length)return a.forEach(function(t){e+=t+""}),i.trustAsHtml(" "+n.getSafeText("validate.error")+" "+e)},getTitleFormattedErrors:function(t,r){var e="",a=u.getErrorMessages(t,r);if(a.length)return a.forEach(function(t){e+=t+"\n"}),i.trustAsHtml(n.getSafeText("validate.error")+"\n"+e)},runValidators:function(t,r,i,n,o){if(i!==n){if(void 0===r.name||!r.name)throw new Error("colDef.name is required to perform validation");u.setValid(t,r);var e=function(r,e,a){return function(t){t||(u.setInvalid(r,e),u.setError(r,e,a),o&&o.api.validate.raise.validationFailed(r,e,i,n))}},a=[];for(var l in r.validators){u.clearError(t,r,l);var d=u.getValidator(l,r.validators[l]),s=c.when(d(n,i,t,r)).then(e(t,r,l));a.push(s)}return c.all(a)}},createDefaultValidators:function(){u.setValidator("minLength",function(e){return function(t,r){return null==r||""===r||r.length>=e}},function(t){return n.getSafeText("validate.minLength").replace("THRESHOLD",t)}),u.setValidator("maxLength",function(e){return function(t,r){return null==r||""===r||r.length<=e}},function(t){return n.getSafeText("validate.maxLength").replace("THRESHOLD",t)}),u.setValidator("required",function(e){return function(t,r){return!e||!(null==r||""===r)}},function(){return n.getSafeText("validate.required")})},initializeGrid:function(t,i){i.validate={isInvalid:u.isInvalid,getErrorMessages:u.getErrorMessages,getFormattedErrors:u.getFormattedErrors,getTitleFormattedErrors:u.getTitleFormattedErrors,runValidators:u.runValidators};var r={events:{validate:{validationFailed:function(t,r,e,a){}}},methods:{validate:{isInvalid:function(t,r){return i.validate.isInvalid(t,r)},getErrorMessages:function(t,r){return i.validate.getErrorMessages(t,r)},getFormattedErrors:function(t,r){return i.validate.getFormattedErrors(t,r)},getTitleFormattedErrors:function(t,r){return i.validate.getTitleFormattedErrors(t,r)}}}};i.api.registerEventsFromObject(r.events),i.api.registerMethodsFromObject(r.methods),i.edit&&i.api.edit.on.afterCellEdit(t,function(t,r,e,a){i.validate.runValidators(t,r,e,a,i)}),u.createDefaultValidators()}};return u}]),t.directive("uiGridValidate",["gridUtil","uiGridValidateService",function(t,i){return{priority:0,replace:!0,require:"^uiGrid",scope:!1,compile:function(){return{pre:function(t,r,e,a){i.initializeGrid(t,a.grid)},post:function(t,r,e,a){}}}}}])}(),angular.module("ui.grid.validate").run(["$templateCache",function(t){"use strict";t.put("ui-grid/cellTitleValidator",'{{COL_FIELD CUSTOM_FILTERS}} '),t.put("ui-grid/cellTooltipValidator",'{{COL_FIELD CUSTOM_FILTERS}} ')}]);
\ No newline at end of file
diff --git a/release/css/ui-grid.core.css b/release/css/ui-grid.core.css
index e3be4ec52..4560afcc5 100644
--- a/release/css/ui-grid.core.css
+++ b/release/css/ui-grid.core.css
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
.ui-grid {
diff --git a/release/css/ui-grid.core.min.css b/release/css/ui-grid.core.min.css
index 35990902a..d872513d5 100644
--- a/release/css/ui-grid.core.min.css
+++ b/release/css/ui-grid.core.min.css
@@ -1,4 +1,4 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/.ui-grid{border:1px solid #d4d4d4;box-sizing:content-box;-webkit-border-radius:0;-moz-border-radius:0;border-radius:0;-webkit-transform:translateZ(0);-moz-transform:translateZ(0);-o-transform:translateZ(0);-ms-transform:translateZ(0);transform:translateZ(0)}.ui-grid-vertical-bar{position:absolute;right:0;width:0}.ui-grid-header-cell:not(:last-child) .ui-grid-vertical-bar,.ui-grid-cell:not(:last-child) .ui-grid-vertical-bar{width:1px}.ui-grid-scrollbar-placeholder{background-color:transparent}.ui-grid-header-cell:not(:last-child) .ui-grid-vertical-bar{background-color:#d4d4d4}.ui-grid-cell:not(:last-child) .ui-grid-vertical-bar{background-color:#d4d4d4}.ui-grid-header-cell:last-child .ui-grid-vertical-bar{right:-1px;width:1px;background-color:#d4d4d4}.ui-grid-clearfix:before,.ui-grid-clearfix:after{content:"";display:table}.ui-grid-clearfix:after{clear:both}.ui-grid-invisible{visibility:hidden}.ui-grid-contents-wrapper{position:relative;height:100%;width:100%}.ui-grid-sr-only{position:absolute;width:1px;height:1px;margin:-1px;padding:0;overflow:hidden;clip:rect(0, 0, 0, 0);border:0}.ui-grid-icon-button{background-color:transparent;border:none;padding:0}.clickable{cursor:pointer}.ui-grid-top-panel-background{background-color:#f3f3f3}.ui-grid-header{border-bottom:1px solid #d4d4d4;box-sizing:border-box}.ui-grid-top-panel{position:relative;overflow:hidden;font-weight:bold;background-color:#f3f3f3;-webkit-border-top-right-radius:-1px;-webkit-border-bottom-right-radius:0;-webkit-border-bottom-left-radius:0;-webkit-border-top-left-radius:-1px;-moz-border-radius-topright:-1px;-moz-border-radius-bottomright:0;-moz-border-radius-bottomleft:0;-moz-border-radius-topleft:-1px;border-top-right-radius:-1px;border-bottom-right-radius:0;border-bottom-left-radius:0;border-top-left-radius:-1px;-moz-background-clip:padding-box;-webkit-background-clip:padding-box;background-clip:padding-box}.ui-grid-header-viewport{overflow:hidden}.ui-grid-header-canvas:before,.ui-grid-header-canvas:after{content:"";display:-ms-flexbox;display:flex;line-height:0}.ui-grid-header-canvas:after{clear:both}.ui-grid-header-cell-wrapper{position:relative;display:-ms-flexbox;display:flex;box-sizing:border-box;height:100%;width:100%}.ui-grid-header-cell-row{display:-ms-flexbox;display:flex;-ms-flex-direction:row;flex-direction:row;-ms-flex-wrap:wrap;flex-wrap:wrap}.ui-grid-header-cell{position:relative;box-sizing:border-box;background-color:inherit;border-right:1px solid;border-color:#d4d4d4;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;width:0}.ui-grid-header-cell:last-child{border-right:0}.ui-grid-header-cell .sortable{cursor:pointer}.ui-grid-header-cell .ui-grid-sort-priority-number{margin-left:-8px}.ui-grid-header-cell>div{-ms-flex-basis:100%;flex-basis:100%}.ui-grid-header .ui-grid-vertical-bar{top:0;bottom:0}.ui-grid-column-menu-button{position:absolute;right:1px;top:0}.ui-grid-column-menu-button .ui-grid-icon-angle-down{vertical-align:sub}.ui-grid-header-cell-last-col .ui-grid-cell-contents,.ui-grid-header-cell-last-col .ui-grid-filter-container,.ui-grid-header-cell-last-col .ui-grid-column-menu-button,.ui-grid-header-cell-last-col+.ui-grid-column-resizer.right{margin-right:13px}.ui-grid-render-container-right .ui-grid-header-cell-last-col .ui-grid-cell-contents,.ui-grid-render-container-right .ui-grid-header-cell-last-col .ui-grid-filter-container,.ui-grid-render-container-right .ui-grid-header-cell-last-col .ui-grid-column-menu-button,.ui-grid-render-container-right .ui-grid-header-cell-last-col+.ui-grid-column-resizer.right{margin-right:28px}.ui-grid-column-menu{position:absolute}.ui-grid-column-menu .ui-grid-menu .ui-grid-menu-mid.ng-hide-add,.ui-grid-column-menu .ui-grid-menu .ui-grid-menu-mid.ng-hide-remove{-webkit-transition:all .04s linear;-moz-transition:all .04s linear;-o-transition:all .04s linear;transition:all .04s linear;display:block !important}.ui-grid-column-menu .ui-grid-menu .ui-grid-menu-mid.ng-hide-add.ng-hide-add-active,.ui-grid-column-menu .ui-grid-menu .ui-grid-menu-mid.ng-hide-remove{-webkit-transform:translateY(-100%);-moz-transform:translateY(-100%);-o-transform:translateY(-100%);-ms-transform:translateY(-100%);transform:translateY(-100%)}.ui-grid-column-menu .ui-grid-menu .ui-grid-menu-mid.ng-hide-add,.ui-grid-column-menu .ui-grid-menu .ui-grid-menu-mid.ng-hide-remove.ng-hide-remove-active{-webkit-transform:translateY(0);-moz-transform:translateY(0);-o-transform:translateY(0);-ms-transform:translateY(0);transform:translateY(0)}.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid.ng-hide-add,.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid.ng-hide-remove{-webkit-transition:all .04s linear;-moz-transition:all .04s linear;-o-transition:all .04s linear;transition:all .04s linear;display:block !important}.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid.ng-hide-add.ng-hide-add-active,.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid.ng-hide-remove{-webkit-transform:translateY(-100%);-moz-transform:translateY(-100%);-o-transform:translateY(-100%);-ms-transform:translateY(-100%);transform:translateY(-100%)}.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid.ng-hide-add,.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid.ng-hide-remove.ng-hide-remove-active{-webkit-transform:translateY(0);-moz-transform:translateY(0);-o-transform:translateY(0);-ms-transform:translateY(0);transform:translateY(0)}.ui-grid-filter-container{padding:4px 10px;position:relative}.ui-grid-filter-container .ui-grid-filter-button{position:absolute;top:0;bottom:0;right:0}.ui-grid-filter-container .ui-grid-filter-button [class^="ui-grid-icon"]{position:absolute;top:50%;line-height:32px;margin-top:-16px;right:10px;opacity:.66}.ui-grid-filter-container .ui-grid-filter-button [class^="ui-grid-icon"]:hover{opacity:1}.ui-grid-filter-container .ui-grid-filter-button-select{position:absolute;top:0;bottom:0;right:0}.ui-grid-filter-container .ui-grid-filter-button-select [class^="ui-grid-icon"]{position:absolute;top:50%;line-height:32px;margin-top:-16px;right:0px;opacity:.66}.ui-grid-filter-container .ui-grid-filter-button-select [class^="ui-grid-icon"]:hover{opacity:1}input[type="text"].ui-grid-filter-input{box-sizing:border-box;padding:0 18px 0 0;margin:0;width:100%;border:1px solid #d4d4d4;-webkit-border-top-right-radius:0;-webkit-border-bottom-right-radius:0;-webkit-border-bottom-left-radius:0;-webkit-border-top-left-radius:0;-moz-border-radius-topright:0;-moz-border-radius-bottomright:0;-moz-border-radius-bottomleft:0;-moz-border-radius-topleft:0;border-top-right-radius:0;border-bottom-right-radius:0;border-bottom-left-radius:0;border-top-left-radius:0;-moz-background-clip:padding-box;-webkit-background-clip:padding-box;background-clip:padding-box}input[type="text"].ui-grid-filter-input:hover{border:1px solid #d4d4d4}select.ui-grid-filter-select{padding:0;margin:0;border:0;width:90%;border:1px solid #d4d4d4;-webkit-border-top-right-radius:0;-webkit-border-bottom-right-radius:0;-webkit-border-bottom-left-radius:0;-webkit-border-top-left-radius:0;-moz-border-radius-topright:0;-moz-border-radius-bottomright:0;-moz-border-radius-bottomleft:0;-moz-border-radius-topleft:0;border-top-right-radius:0;border-bottom-right-radius:0;border-bottom-left-radius:0;border-top-left-radius:0;-moz-background-clip:padding-box;-webkit-background-clip:padding-box;background-clip:padding-box}select.ui-grid-filter-select:hover{border:1px solid #d4d4d4}.ui-grid-filter-cancel-button-hidden select.ui-grid-filter-select{width:100%}.ui-grid-render-container{position:inherit;-webkit-border-top-right-radius:0;-webkit-border-bottom-right-radius:0;-webkit-border-bottom-left-radius:0;-webkit-border-top-left-radius:0;-moz-border-radius-topright:0;-moz-border-radius-bottomright:0;-moz-border-radius-bottomleft:0;-moz-border-radius-topleft:0;border-top-right-radius:0;border-bottom-right-radius:0;border-bottom-left-radius:0;border-top-left-radius:0;-moz-background-clip:padding-box;-webkit-background-clip:padding-box;background-clip:padding-box}.ui-grid-render-container:focus{outline:none}.ui-grid-viewport{min-height:20px;position:relative;overflow-y:scroll;-webkit-overflow-scrolling:touch}.ui-grid-viewport:focus{outline:none !important}.ui-grid-canvas{position:relative;padding-top:1px}.ui-grid-row{clear:both}.ui-grid-row:nth-child(odd) .ui-grid-cell{background-color:#fdfdfd}.ui-grid-row:nth-child(even) .ui-grid-cell{background-color:#f3f3f3}.ui-grid-row:last-child .ui-grid-cell{border-bottom-color:#d4d4d4;border-bottom-style:solid}.ui-grid-row:hover>[ui-grid-row]>.ui-grid-cell:hover .ui-grid-cell,.ui-grid-row:nth-child(odd):hover .ui-grid-cell,.ui-grid-row:nth-child(even):hover .ui-grid-cell{background-color:#d5eaee}.ui-grid-no-row-overlay{position:absolute;top:0;bottom:0;left:0;right:0;margin:10%;background-color:#f3f3f3;-webkit-border-top-right-radius:0;-webkit-border-bottom-right-radius:0;-webkit-border-bottom-left-radius:0;-webkit-border-top-left-radius:0;-moz-border-radius-topright:0;-moz-border-radius-bottomright:0;-moz-border-radius-bottomleft:0;-moz-border-radius-topleft:0;border-top-right-radius:0;border-bottom-right-radius:0;border-bottom-left-radius:0;border-top-left-radius:0;-moz-background-clip:padding-box;-webkit-background-clip:padding-box;background-clip:padding-box;border:1px solid #d4d4d4;font-size:2em;text-align:center}.ui-grid-no-row-overlay>*{position:absolute;display:table;margin:auto 0;width:100%;top:0;bottom:0;left:0;right:0;opacity:.66}.ui-grid-cell{overflow:hidden;float:left;background-color:inherit;border-right:1px solid;border-color:#d4d4d4;box-sizing:border-box}.ui-grid-cell:last-child{border-right:0}.ui-grid-cell-contents{padding:5px;-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box;white-space:nowrap;-ms-text-overflow:ellipsis;-o-text-overflow:ellipsis;text-overflow:ellipsis;overflow:hidden;height:100%}.ui-grid-cell-contents-hidden{visibility:hidden;width:0;height:0;display:none}.ui-grid-row .ui-grid-cell.ui-grid-row-header-cell{background-color:#F0F0EE;border-bottom:solid 1px #d4d4d4}.ui-grid-cell-empty{display:inline-block;width:10px;height:10px}.ui-grid-footer-info{padding:5px 10px}.ui-grid-footer-panel-background{background-color:#f3f3f3}.ui-grid-footer-panel{position:relative;border-bottom:1px solid #d4d4d4;border-top:1px solid #d4d4d4;overflow:hidden;font-weight:bold;background-color:#f3f3f3;-webkit-border-top-right-radius:-1px;-webkit-border-bottom-right-radius:0;-webkit-border-bottom-left-radius:0;-webkit-border-top-left-radius:-1px;-moz-border-radius-topright:-1px;-moz-border-radius-bottomright:0;-moz-border-radius-bottomleft:0;-moz-border-radius-topleft:-1px;border-top-right-radius:-1px;border-bottom-right-radius:0;border-bottom-left-radius:0;border-top-left-radius:-1px;-moz-background-clip:padding-box;-webkit-background-clip:padding-box;background-clip:padding-box}.ui-grid-grid-footer{float:left;width:100%}.ui-grid-footer-viewport,.ui-grid-footer-canvas{height:100%}.ui-grid-footer-viewport{overflow:hidden}.ui-grid-footer-canvas{position:relative}.ui-grid-footer-canvas:before,.ui-grid-footer-canvas:after{content:"";display:table;line-height:0}.ui-grid-footer-canvas:after{clear:both}.ui-grid-footer-cell-wrapper{position:relative;display:table;box-sizing:border-box;height:100%}.ui-grid-footer-cell-row{display:table-row}.ui-grid-footer-cell{overflow:hidden;background-color:inherit;border-right:1px solid;border-color:#d4d4d4;box-sizing:border-box;display:table-cell}.ui-grid-footer-cell:last-child{border-right:0}.ui-grid-menu-button{z-index:2;position:absolute;right:0;top:0;background:#f3f3f3;border:0;border-left:1px solid #d4d4d4;border-bottom:1px solid #d4d4d4;cursor:pointer;height:32px;font-weight:normal}.ui-grid-menu-button .ui-grid-icon-container{margin-top:5px;margin-left:2px}.ui-grid-menu-button .ui-grid-menu{right:0}.ui-grid-menu-button .ui-grid-menu .ui-grid-menu-mid{overflow:scroll}.ui-grid-menu{overflow:hidden;max-width:320px;z-index:2;position:absolute;right:100%;padding:0 10px 20px 10px;cursor:pointer;box-sizing:border-box}.ui-grid-menu-item{width:100%;overflow:hidden;text-overflow:ellipsis;white-space:nowrap}.ui-grid-menu .ui-grid-menu-inner{background:#fff;border:1px solid #d4d4d4;position:relative;white-space:nowrap;-webkit-border-radius:0;-moz-border-radius:0;border-radius:0}.ui-grid-menu .ui-grid-menu-inner ul{margin:0;padding:0;list-style-type:none}.ui-grid-menu .ui-grid-menu-inner ul li{padding:0}.ui-grid-menu .ui-grid-menu-inner ul li .ui-grid-menu-item{color:#000;min-width:100%;padding:8px;text-align:left;background:transparent;border:none;cursor:default}.ui-grid-menu .ui-grid-menu-inner ul li button.ui-grid-menu-item{cursor:pointer}.ui-grid-menu .ui-grid-menu-inner ul li button.ui-grid-menu-item:hover,.ui-grid-menu .ui-grid-menu-inner ul li button.ui-grid-menu-item:focus{background-color:#b3c4c7}.ui-grid-menu .ui-grid-menu-inner ul li button.ui-grid-menu-item.ui-grid-menu-item-active{background-color:#9cb2b6}.ui-grid-menu .ui-grid-menu-inner ul li:not(:last-child)>.ui-grid-menu-item{border-bottom:1px solid #d4d4d4}.ui-grid-sortarrow{right:5px;position:absolute;width:20px;top:0;bottom:0;background-position:center}.ui-grid-sortarrow.down{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-o-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}@font-face{font-family:'ui-grid';src:url('../fonts/ui-grid.eot');src:url('../fonts/ui-grid.eot#iefix') format('embedded-opentype'),url('../fonts/ui-grid.woff') format('woff'),url('../fonts/ui-grid.ttf') format('truetype'),url('../fonts/ui-grid.svg?#ui-grid') format('svg');font-weight:normal;font-style:normal}[class^="ui-grid-icon"]:before,[class*=" ui-grid-icon"]:before{font-family:"ui-grid";font-style:normal;font-weight:normal;speak:none;display:inline-block;text-decoration:inherit;width:1em;margin-right:.2em;text-align:center;font-variant:normal;text-transform:none;line-height:1em;margin-left:.2em}.ui-grid-icon-blank::before{width:1em;content:' '}.ui-grid-icon-plus-squared:before{content:'\c350'}.ui-grid-icon-minus-squared:before{content:'\c351'}.ui-grid-icon-search:before{content:'\c352'}.ui-grid-icon-cancel:before{content:'\c353'}.ui-grid-icon-info-circled:before{content:'\c354'}.ui-grid-icon-lock:before{content:'\c355'}.ui-grid-icon-lock-open:before{content:'\c356'}.ui-grid-icon-pencil:before{content:'\c357'}.ui-grid-icon-down-dir:before{content:'\c358'}.ui-grid-icon-up-dir:before{content:'\c359'}.ui-grid-icon-left-dir:before{content:'\c35a'}.ui-grid-icon-right-dir:before{content:'\c35b'}.ui-grid-icon-left-open:before{content:'\c35c'}.ui-grid-icon-right-open:before{content:'\c35d'}.ui-grid-icon-angle-down:before{content:'\c35e'}.ui-grid-icon-filter:before{content:'\c35f'}.ui-grid-icon-sort-alt-up:before{content:'\c360'}.ui-grid-icon-sort-alt-down:before{content:'\c361'}.ui-grid-icon-ok:before{content:'\c362'}.ui-grid-icon-menu:before{content:'\c363'}.ui-grid-icon-indent-left:before{content:'\e800'}.ui-grid-icon-indent-right:before{content:'\e801'}.ui-grid-icon-spin5:before{content:'\ea61'}.ui-grid[dir=rtl] .ui-grid-header-cell,.ui-grid[dir=rtl] .ui-grid-footer-cell,.ui-grid[dir=rtl] .ui-grid-cell{float:right !important}.ui-grid[dir=rtl] .ui-grid-column-menu-button{position:absolute;left:1px;top:0;right:inherit}.ui-grid[dir=rtl] .ui-grid-cell:first-child,.ui-grid[dir=rtl] .ui-grid-header-cell:first-child,.ui-grid[dir=rtl] .ui-grid-footer-cell:first-child{border-right:0}.ui-grid[dir=rtl] .ui-grid-cell:last-child,.ui-grid[dir=rtl] .ui-grid-header-cell:last-child{border-right:1px solid #d4d4d4;border-left:0}.ui-grid[dir=rtl] .ui-grid-header-cell:first-child .ui-grid-vertical-bar,.ui-grid[dir=rtl] .ui-grid-footer-cell:first-child .ui-grid-vertical-bar,.ui-grid[dir=rtl] .ui-grid-cell:first-child .ui-grid-vertical-bar{width:0}.ui-grid[dir=rtl] .ui-grid-menu-button{z-index:2;position:absolute;left:0;right:auto;background:#f3f3f3;border:1px solid #d4d4d4;cursor:pointer;min-height:27px;font-weight:normal}.ui-grid[dir=rtl] .ui-grid-menu-button .ui-grid-menu{left:0;right:auto}.ui-grid[dir=rtl] .ui-grid-filter-container .ui-grid-filter-button{right:initial;left:0}.ui-grid[dir=rtl] .ui-grid-filter-container .ui-grid-filter-button [class^="ui-grid-icon"]{right:initial;left:10px}.ui-grid-animate-spin{-moz-animation:ui-grid-spin 2s infinite linear;-o-animation:ui-grid-spin 2s infinite linear;-webkit-animation:ui-grid-spin 2s infinite linear;animation:ui-grid-spin 2s infinite linear;display:inline-block}@-moz-keyframes ui-grid-spin{0%{-moz-transform:rotate(0deg);-o-transform:rotate(0deg);-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-moz-transform:rotate(359deg);-o-transform:rotate(359deg);-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@-webkit-keyframes ui-grid-spin{0%{-moz-transform:rotate(0deg);-o-transform:rotate(0deg);-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-moz-transform:rotate(359deg);-o-transform:rotate(359deg);-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@-o-keyframes ui-grid-spin{0%{-moz-transform:rotate(0deg);-o-transform:rotate(0deg);-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-moz-transform:rotate(359deg);-o-transform:rotate(359deg);-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@-ms-keyframes ui-grid-spin{0%{-moz-transform:rotate(0deg);-o-transform:rotate(0deg);-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-moz-transform:rotate(359deg);-o-transform:rotate(359deg);-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes ui-grid-spin{0%{-moz-transform:rotate(0deg);-o-transform:rotate(0deg);-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-moz-transform:rotate(359deg);-o-transform:rotate(359deg);-webkit-transform:rotate(359deg);transform:rotate(359deg)}}
\ No newline at end of file
diff --git a/release/i18n/ui-grid.auto-resize.js b/release/i18n/ui-grid.auto-resize.js
index 2653ffc3e..33f3f9d70 100644
--- a/release/i18n/ui-grid.auto-resize.js
+++ b/release/i18n/ui-grid.auto-resize.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.auto-resize.min.js b/release/i18n/ui-grid.auto-resize.min.js
index d5dd9c969..a7cdd99b5 100644
--- a/release/i18n/ui-grid.auto-resize.min.js
+++ b/release/i18n/ui-grid.auto-resize.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.cellnav.js b/release/i18n/ui-grid.cellnav.js
index 8f02f4cd4..e803b72df 100644
--- a/release/i18n/ui-grid.cellnav.js
+++ b/release/i18n/ui-grid.cellnav.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.cellnav.min.js b/release/i18n/ui-grid.cellnav.min.js
index 225df02f3..039383f41 100644
--- a/release/i18n/ui-grid.cellnav.min.js
+++ b/release/i18n/ui-grid.cellnav.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.core.js b/release/i18n/ui-grid.core.js
index c6b32d019..ad0fcda88 100644
--- a/release/i18n/ui-grid.core.js
+++ b/release/i18n/ui-grid.core.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.core.min.js b/release/i18n/ui-grid.core.min.js
index 08c609e30..3f9499f22 100644
--- a/release/i18n/ui-grid.core.min.js
+++ b/release/i18n/ui-grid.core.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.edit.js b/release/i18n/ui-grid.edit.js
index c01a67fbb..59383d962 100644
--- a/release/i18n/ui-grid.edit.js
+++ b/release/i18n/ui-grid.edit.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.edit.min.js b/release/i18n/ui-grid.edit.min.js
index c2fe3581a..7ebac9fab 100644
--- a/release/i18n/ui-grid.edit.min.js
+++ b/release/i18n/ui-grid.edit.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.empty-base-layer.js b/release/i18n/ui-grid.empty-base-layer.js
index 000a6a09e..15da41f62 100644
--- a/release/i18n/ui-grid.empty-base-layer.js
+++ b/release/i18n/ui-grid.empty-base-layer.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.empty-base-layer.min.js b/release/i18n/ui-grid.empty-base-layer.min.js
index 31b77adcf..74d2da617 100644
--- a/release/i18n/ui-grid.empty-base-layer.min.js
+++ b/release/i18n/ui-grid.empty-base-layer.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.expandable.js b/release/i18n/ui-grid.expandable.js
index c69f102f4..83fe562e8 100644
--- a/release/i18n/ui-grid.expandable.js
+++ b/release/i18n/ui-grid.expandable.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.expandable.min.js b/release/i18n/ui-grid.expandable.min.js
index 607e464b1..d51932761 100644
--- a/release/i18n/ui-grid.expandable.min.js
+++ b/release/i18n/ui-grid.expandable.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.exporter.js b/release/i18n/ui-grid.exporter.js
index 49c5a5619..19864b705 100644
--- a/release/i18n/ui-grid.exporter.js
+++ b/release/i18n/ui-grid.exporter.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.exporter.min.js b/release/i18n/ui-grid.exporter.min.js
index df7a39ecf..b785b37ec 100644
--- a/release/i18n/ui-grid.exporter.min.js
+++ b/release/i18n/ui-grid.exporter.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.grouping.js b/release/i18n/ui-grid.grouping.js
index 3f1cd2a7f..6119ea6b4 100644
--- a/release/i18n/ui-grid.grouping.js
+++ b/release/i18n/ui-grid.grouping.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.grouping.min.js b/release/i18n/ui-grid.grouping.min.js
index 71a69a1ee..46bf7ea91 100644
--- a/release/i18n/ui-grid.grouping.min.js
+++ b/release/i18n/ui-grid.grouping.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.importer.js b/release/i18n/ui-grid.importer.js
index 9b694d6f4..4179f99a8 100644
--- a/release/i18n/ui-grid.importer.js
+++ b/release/i18n/ui-grid.importer.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.importer.min.js b/release/i18n/ui-grid.importer.min.js
index 45fbee8c2..d47b30d87 100644
--- a/release/i18n/ui-grid.importer.min.js
+++ b/release/i18n/ui-grid.importer.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.infinite-scroll.js b/release/i18n/ui-grid.infinite-scroll.js
index 6d0cc8b84..6dfba39e4 100644
--- a/release/i18n/ui-grid.infinite-scroll.js
+++ b/release/i18n/ui-grid.infinite-scroll.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.infinite-scroll.min.js b/release/i18n/ui-grid.infinite-scroll.min.js
index c0e0fc526..dd8b53274 100644
--- a/release/i18n/ui-grid.infinite-scroll.min.js
+++ b/release/i18n/ui-grid.infinite-scroll.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.all.js b/release/i18n/ui-grid.language.all.js
index 8af6e4d30..6766a27b4 100644
--- a/release/i18n/ui-grid.language.all.js
+++ b/release/i18n/ui-grid.language.all.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.all.min.js b/release/i18n/ui-grid.language.all.min.js
index 840d982d5..b6e820287 100644
--- a/release/i18n/ui-grid.language.all.min.js
+++ b/release/i18n/ui-grid.language.all.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.ar.js b/release/i18n/ui-grid.language.ar.js
index 863239069..1c42b6b6e 100644
--- a/release/i18n/ui-grid.language.ar.js
+++ b/release/i18n/ui-grid.language.ar.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.ar.min.js b/release/i18n/ui-grid.language.ar.min.js
index e6ce9f38a..c103a8c5e 100644
--- a/release/i18n/ui-grid.language.ar.min.js
+++ b/release/i18n/ui-grid.language.ar.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.bg.js b/release/i18n/ui-grid.language.bg.js
index 3aba66aff..337e39a2c 100644
--- a/release/i18n/ui-grid.language.bg.js
+++ b/release/i18n/ui-grid.language.bg.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.bg.min.js b/release/i18n/ui-grid.language.bg.min.js
index b9168dc4d..94131ec07 100644
--- a/release/i18n/ui-grid.language.bg.min.js
+++ b/release/i18n/ui-grid.language.bg.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.cs.js b/release/i18n/ui-grid.language.cs.js
index c5fae85a9..10ad82bca 100644
--- a/release/i18n/ui-grid.language.cs.js
+++ b/release/i18n/ui-grid.language.cs.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.cs.min.js b/release/i18n/ui-grid.language.cs.min.js
index 7cd9e153e..7f50f2beb 100644
--- a/release/i18n/ui-grid.language.cs.min.js
+++ b/release/i18n/ui-grid.language.cs.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.da.js b/release/i18n/ui-grid.language.da.js
index 8622ef1bf..f18e38793 100644
--- a/release/i18n/ui-grid.language.da.js
+++ b/release/i18n/ui-grid.language.da.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.da.min.js b/release/i18n/ui-grid.language.da.min.js
index 4313d7fe4..d491419b5 100644
--- a/release/i18n/ui-grid.language.da.min.js
+++ b/release/i18n/ui-grid.language.da.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.de.js b/release/i18n/ui-grid.language.de.js
index d56f03631..e423a2a95 100644
--- a/release/i18n/ui-grid.language.de.js
+++ b/release/i18n/ui-grid.language.de.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.de.min.js b/release/i18n/ui-grid.language.de.min.js
index fab76289b..acb7ceb46 100644
--- a/release/i18n/ui-grid.language.de.min.js
+++ b/release/i18n/ui-grid.language.de.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.es-ct.js b/release/i18n/ui-grid.language.es-ct.js
index 0026f3883..d2129fcda 100644
--- a/release/i18n/ui-grid.language.es-ct.js
+++ b/release/i18n/ui-grid.language.es-ct.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.es-ct.min.js b/release/i18n/ui-grid.language.es-ct.min.js
index 0229cfc6f..c41476767 100644
--- a/release/i18n/ui-grid.language.es-ct.min.js
+++ b/release/i18n/ui-grid.language.es-ct.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.es.js b/release/i18n/ui-grid.language.es.js
index 5fc5e85ff..ec000978b 100644
--- a/release/i18n/ui-grid.language.es.js
+++ b/release/i18n/ui-grid.language.es.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.es.min.js b/release/i18n/ui-grid.language.es.min.js
index 19bd6d9dd..5714755cb 100644
--- a/release/i18n/ui-grid.language.es.min.js
+++ b/release/i18n/ui-grid.language.es.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.fa.js b/release/i18n/ui-grid.language.fa.js
index b52e21a0b..a5b89778c 100644
--- a/release/i18n/ui-grid.language.fa.js
+++ b/release/i18n/ui-grid.language.fa.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.fa.min.js b/release/i18n/ui-grid.language.fa.min.js
index 17e7f1284..ac37abcbc 100644
--- a/release/i18n/ui-grid.language.fa.min.js
+++ b/release/i18n/ui-grid.language.fa.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.fi.js b/release/i18n/ui-grid.language.fi.js
index 0175c02ed..72038f447 100644
--- a/release/i18n/ui-grid.language.fi.js
+++ b/release/i18n/ui-grid.language.fi.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.fi.min.js b/release/i18n/ui-grid.language.fi.min.js
index 60639781b..c7d9c5c05 100644
--- a/release/i18n/ui-grid.language.fi.min.js
+++ b/release/i18n/ui-grid.language.fi.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.fr.js b/release/i18n/ui-grid.language.fr.js
index c42534df0..06992a354 100644
--- a/release/i18n/ui-grid.language.fr.js
+++ b/release/i18n/ui-grid.language.fr.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.fr.min.js b/release/i18n/ui-grid.language.fr.min.js
index 5bd4a9105..c32817f08 100644
--- a/release/i18n/ui-grid.language.fr.min.js
+++ b/release/i18n/ui-grid.language.fr.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.he.js b/release/i18n/ui-grid.language.he.js
index 267d23371..1a52b7069 100644
--- a/release/i18n/ui-grid.language.he.js
+++ b/release/i18n/ui-grid.language.he.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.he.min.js b/release/i18n/ui-grid.language.he.min.js
index ca2bd4e85..4220fabb6 100644
--- a/release/i18n/ui-grid.language.he.min.js
+++ b/release/i18n/ui-grid.language.he.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.hy.js b/release/i18n/ui-grid.language.hy.js
index 21bde80b4..ba64ee5ab 100644
--- a/release/i18n/ui-grid.language.hy.js
+++ b/release/i18n/ui-grid.language.hy.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.hy.min.js b/release/i18n/ui-grid.language.hy.min.js
index 438d052ab..3f7999451 100644
--- a/release/i18n/ui-grid.language.hy.min.js
+++ b/release/i18n/ui-grid.language.hy.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.is.js b/release/i18n/ui-grid.language.is.js
index 56d6b7345..39f643ced 100644
--- a/release/i18n/ui-grid.language.is.js
+++ b/release/i18n/ui-grid.language.is.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.is.min.js b/release/i18n/ui-grid.language.is.min.js
index ae616db61..825a2aa9f 100644
--- a/release/i18n/ui-grid.language.is.min.js
+++ b/release/i18n/ui-grid.language.is.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.it.js b/release/i18n/ui-grid.language.it.js
index 0a2e87112..e4f6dc64f 100644
--- a/release/i18n/ui-grid.language.it.js
+++ b/release/i18n/ui-grid.language.it.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.it.min.js b/release/i18n/ui-grid.language.it.min.js
index c6e875e01..740ef57f9 100644
--- a/release/i18n/ui-grid.language.it.min.js
+++ b/release/i18n/ui-grid.language.it.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.ja.js b/release/i18n/ui-grid.language.ja.js
index 26d715afe..09862fced 100644
--- a/release/i18n/ui-grid.language.ja.js
+++ b/release/i18n/ui-grid.language.ja.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.ja.min.js b/release/i18n/ui-grid.language.ja.min.js
index bcdcf2449..0c19a99c7 100644
--- a/release/i18n/ui-grid.language.ja.min.js
+++ b/release/i18n/ui-grid.language.ja.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.ko.js b/release/i18n/ui-grid.language.ko.js
index 27f9984b9..3b1a8c014 100644
--- a/release/i18n/ui-grid.language.ko.js
+++ b/release/i18n/ui-grid.language.ko.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.ko.min.js b/release/i18n/ui-grid.language.ko.min.js
index dcfc8bbf1..2a3499ce6 100644
--- a/release/i18n/ui-grid.language.ko.min.js
+++ b/release/i18n/ui-grid.language.ko.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.nl.js b/release/i18n/ui-grid.language.nl.js
index 5d64adcd9..8645f5dc3 100644
--- a/release/i18n/ui-grid.language.nl.js
+++ b/release/i18n/ui-grid.language.nl.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.nl.min.js b/release/i18n/ui-grid.language.nl.min.js
index 2e6602e28..a467979d7 100644
--- a/release/i18n/ui-grid.language.nl.min.js
+++ b/release/i18n/ui-grid.language.nl.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.no.js b/release/i18n/ui-grid.language.no.js
index 98ba89fc3..8b07fcbee 100644
--- a/release/i18n/ui-grid.language.no.js
+++ b/release/i18n/ui-grid.language.no.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.no.min.js b/release/i18n/ui-grid.language.no.min.js
index 0a1064aa7..d4bb16653 100644
--- a/release/i18n/ui-grid.language.no.min.js
+++ b/release/i18n/ui-grid.language.no.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.pl.js b/release/i18n/ui-grid.language.pl.js
index facd0b437..c3c722bf8 100644
--- a/release/i18n/ui-grid.language.pl.js
+++ b/release/i18n/ui-grid.language.pl.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.pl.min.js b/release/i18n/ui-grid.language.pl.min.js
index eaf538008..45708923e 100644
--- a/release/i18n/ui-grid.language.pl.min.js
+++ b/release/i18n/ui-grid.language.pl.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.pt-br.js b/release/i18n/ui-grid.language.pt-br.js
index d6260c843..c1dc9b332 100644
--- a/release/i18n/ui-grid.language.pt-br.js
+++ b/release/i18n/ui-grid.language.pt-br.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.pt-br.min.js b/release/i18n/ui-grid.language.pt-br.min.js
index f2984a2ec..a6e4c0737 100644
--- a/release/i18n/ui-grid.language.pt-br.min.js
+++ b/release/i18n/ui-grid.language.pt-br.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.pt.js b/release/i18n/ui-grid.language.pt.js
index d0f18ecaf..7bd3df629 100644
--- a/release/i18n/ui-grid.language.pt.js
+++ b/release/i18n/ui-grid.language.pt.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.pt.min.js b/release/i18n/ui-grid.language.pt.min.js
index 5a1498add..f815be72f 100644
--- a/release/i18n/ui-grid.language.pt.min.js
+++ b/release/i18n/ui-grid.language.pt.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.ro.js b/release/i18n/ui-grid.language.ro.js
index 48a2a24cf..0bba04b80 100644
--- a/release/i18n/ui-grid.language.ro.js
+++ b/release/i18n/ui-grid.language.ro.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.ro.min.js b/release/i18n/ui-grid.language.ro.min.js
index 197b5bcd2..4fe39c2e5 100644
--- a/release/i18n/ui-grid.language.ro.min.js
+++ b/release/i18n/ui-grid.language.ro.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.rs-lat.js b/release/i18n/ui-grid.language.rs-lat.js
index 7c4d86730..4f65ede43 100644
--- a/release/i18n/ui-grid.language.rs-lat.js
+++ b/release/i18n/ui-grid.language.rs-lat.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.rs-lat.min.js b/release/i18n/ui-grid.language.rs-lat.min.js
index 1fc525cdb..da6af1ad0 100644
--- a/release/i18n/ui-grid.language.rs-lat.min.js
+++ b/release/i18n/ui-grid.language.rs-lat.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.ru.js b/release/i18n/ui-grid.language.ru.js
index a68e2b370..d96e10c67 100644
--- a/release/i18n/ui-grid.language.ru.js
+++ b/release/i18n/ui-grid.language.ru.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.ru.min.js b/release/i18n/ui-grid.language.ru.min.js
index 797f4c0ed..08e996dfc 100644
--- a/release/i18n/ui-grid.language.ru.min.js
+++ b/release/i18n/ui-grid.language.ru.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.sk.js b/release/i18n/ui-grid.language.sk.js
index e2afbc3a4..ad39f7a94 100644
--- a/release/i18n/ui-grid.language.sk.js
+++ b/release/i18n/ui-grid.language.sk.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.sk.min.js b/release/i18n/ui-grid.language.sk.min.js
index 3ef5e852a..6b926b9de 100644
--- a/release/i18n/ui-grid.language.sk.min.js
+++ b/release/i18n/ui-grid.language.sk.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.sv.js b/release/i18n/ui-grid.language.sv.js
index d873c788b..dceb8fef9 100644
--- a/release/i18n/ui-grid.language.sv.js
+++ b/release/i18n/ui-grid.language.sv.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.sv.min.js b/release/i18n/ui-grid.language.sv.min.js
index c99f6a692..6ec3d8e32 100644
--- a/release/i18n/ui-grid.language.sv.min.js
+++ b/release/i18n/ui-grid.language.sv.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.ta.js b/release/i18n/ui-grid.language.ta.js
index 4c4a81098..8a3f9f7de 100644
--- a/release/i18n/ui-grid.language.ta.js
+++ b/release/i18n/ui-grid.language.ta.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.ta.min.js b/release/i18n/ui-grid.language.ta.min.js
index 32ee25a4d..1e7162b92 100644
--- a/release/i18n/ui-grid.language.ta.min.js
+++ b/release/i18n/ui-grid.language.ta.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.tr.js b/release/i18n/ui-grid.language.tr.js
index 18f6f8cee..0dc718a8c 100644
--- a/release/i18n/ui-grid.language.tr.js
+++ b/release/i18n/ui-grid.language.tr.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.tr.min.js b/release/i18n/ui-grid.language.tr.min.js
index 8767d9db3..5f22550c2 100644
--- a/release/i18n/ui-grid.language.tr.min.js
+++ b/release/i18n/ui-grid.language.tr.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.ua.js b/release/i18n/ui-grid.language.ua.js
index 549bdaa6c..d71dfedc8 100644
--- a/release/i18n/ui-grid.language.ua.js
+++ b/release/i18n/ui-grid.language.ua.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.ua.min.js b/release/i18n/ui-grid.language.ua.min.js
index dfd1454f5..af5a5fa71 100644
--- a/release/i18n/ui-grid.language.ua.min.js
+++ b/release/i18n/ui-grid.language.ua.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.zh-cn.js b/release/i18n/ui-grid.language.zh-cn.js
index b37b39c29..a7ad0f03e 100644
--- a/release/i18n/ui-grid.language.zh-cn.js
+++ b/release/i18n/ui-grid.language.zh-cn.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.zh-cn.min.js b/release/i18n/ui-grid.language.zh-cn.min.js
index 7f909fba2..9f083b96e 100644
--- a/release/i18n/ui-grid.language.zh-cn.min.js
+++ b/release/i18n/ui-grid.language.zh-cn.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.zh-tw.js b/release/i18n/ui-grid.language.zh-tw.js
index 44e580c59..6c68e2acf 100644
--- a/release/i18n/ui-grid.language.zh-tw.js
+++ b/release/i18n/ui-grid.language.zh-tw.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.language.zh-tw.min.js b/release/i18n/ui-grid.language.zh-tw.min.js
index 1b2d30c92..bf2fe3512 100644
--- a/release/i18n/ui-grid.language.zh-tw.min.js
+++ b/release/i18n/ui-grid.language.zh-tw.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.move-columns.js b/release/i18n/ui-grid.move-columns.js
index e39b9dbdb..c4e2f3e43 100644
--- a/release/i18n/ui-grid.move-columns.js
+++ b/release/i18n/ui-grid.move-columns.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.move-columns.min.js b/release/i18n/ui-grid.move-columns.min.js
index 1897cc245..aad34e81f 100644
--- a/release/i18n/ui-grid.move-columns.min.js
+++ b/release/i18n/ui-grid.move-columns.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.pagination.js b/release/i18n/ui-grid.pagination.js
index fffb501f7..a5d496721 100644
--- a/release/i18n/ui-grid.pagination.js
+++ b/release/i18n/ui-grid.pagination.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.pagination.min.js b/release/i18n/ui-grid.pagination.min.js
index 6f7c24926..d26c87809 100644
--- a/release/i18n/ui-grid.pagination.min.js
+++ b/release/i18n/ui-grid.pagination.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.pinning.js b/release/i18n/ui-grid.pinning.js
index 3939ef3f9..85c9ff9bd 100644
--- a/release/i18n/ui-grid.pinning.js
+++ b/release/i18n/ui-grid.pinning.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.pinning.min.js b/release/i18n/ui-grid.pinning.min.js
index 1574e1395..e1c7607de 100644
--- a/release/i18n/ui-grid.pinning.min.js
+++ b/release/i18n/ui-grid.pinning.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.resize-columns.js b/release/i18n/ui-grid.resize-columns.js
index efbd5c62d..52f8b97f4 100644
--- a/release/i18n/ui-grid.resize-columns.js
+++ b/release/i18n/ui-grid.resize-columns.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.resize-columns.min.js b/release/i18n/ui-grid.resize-columns.min.js
index 70ace8b83..d6c51b2c7 100644
--- a/release/i18n/ui-grid.resize-columns.min.js
+++ b/release/i18n/ui-grid.resize-columns.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.row-edit.js b/release/i18n/ui-grid.row-edit.js
index a75e52b10..da061ede4 100644
--- a/release/i18n/ui-grid.row-edit.js
+++ b/release/i18n/ui-grid.row-edit.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.row-edit.min.js b/release/i18n/ui-grid.row-edit.min.js
index c52e16ff0..9d6b8f620 100644
--- a/release/i18n/ui-grid.row-edit.min.js
+++ b/release/i18n/ui-grid.row-edit.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.saveState.js b/release/i18n/ui-grid.saveState.js
index 3b6ff2087..026421497 100644
--- a/release/i18n/ui-grid.saveState.js
+++ b/release/i18n/ui-grid.saveState.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.saveState.min.js b/release/i18n/ui-grid.saveState.min.js
index f86726ba7..213782541 100644
--- a/release/i18n/ui-grid.saveState.min.js
+++ b/release/i18n/ui-grid.saveState.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.selection.js b/release/i18n/ui-grid.selection.js
index 2631978c8..102fb25dc 100644
--- a/release/i18n/ui-grid.selection.js
+++ b/release/i18n/ui-grid.selection.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.selection.min.js b/release/i18n/ui-grid.selection.min.js
index 1ad96e702..40625c5f6 100644
--- a/release/i18n/ui-grid.selection.min.js
+++ b/release/i18n/ui-grid.selection.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/i18n/ui-grid.tree-base.js b/release/i18n/ui-grid.tree-base.js
index c9be6b44d..5f053a610 100644
--- a/release/i18n/ui-grid.tree-base.js
+++ b/release/i18n/ui-grid.tree-base.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
@@ -1091,6 +1091,7 @@
*/
createTree: function( grid, renderableRows ) {
var currentLevel = -1,
+ parentsCache = {},
parents = [],
currentState;
@@ -1121,16 +1122,31 @@
}
}
+ // If row header as parent exists in parentsCache
+ if (
+ typeof row.treeLevel !== 'undefined' &&
+ row.treeLevel !== null &&
+ row.treeLevel >= 0 &&
+ parentsCache.hasOwnProperty(row.uid)
+ ) {
+ parents.push(parentsCache[row.uid]);
+ }
+
// aggregate if this is a leaf node
if ( ( typeof(row.treeLevel) === 'undefined' || row.treeLevel === null || row.treeLevel < 0 ) && row.visible ) {
service.aggregate( grid, row, parents );
}
// add this node to the tree
- service.addOrUseNode(grid, row, parents, aggregations);
+ if (!parentsCache.hasOwnProperty(row.uid)) {
+ service.addOrUseNode(grid, row, parents, aggregations);
+ }
if ( typeof(row.treeLevel) !== 'undefined' && row.treeLevel !== null && row.treeLevel >= 0 ) {
- parents.push(row);
+ if (!parentsCache.hasOwnProperty(row.uid)) {
+ parentsCache[row.uid] = row;
+ parents.push(row);
+ }
currentLevel++;
currentState = service.setCurrentState(parents);
}
diff --git a/release/i18n/ui-grid.tree-base.min.js b/release/i18n/ui-grid.tree-base.min.js
index c36c32b2b..5150373cd 100644
--- a/release/i18n/ui-grid.tree-base.min.js
+++ b/release/i18n/ui-grid.tree-base.min.js
@@ -1,7 +1,7 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
-!function(){"use strict";var e=angular.module("ui.grid.treeBase",["ui.grid"]);e.constant("uiGridTreeBaseConstants",{featureName:"treeBase",rowHeaderColName:"treeBaseRowHeaderCol",EXPANDED:"expanded",COLLAPSED:"collapsed",aggregation:{COUNT:"count",SUM:"sum",MAX:"max",MIN:"min",AVG:"avg"}}),e.service("uiGridTreeBaseService",["$q","uiGridTreeBaseConstants","gridUtil","GridRow","gridClassFactory","i18nService","uiGridConstants","rowSorter",function(e,i,t,r,n,o,a,l){var g={initializeGrid:function(r){r.treeBase={},r.treeBase.numberLevels=0,r.treeBase.expandAll=!1,r.treeBase.tree=[],g.defaultGridOptions(r.options),r.registerRowsProcessor(g.treeRows,410),r.registerColumnBuilder(g.treeBaseColumnBuilder),g.createRowHeader(r);var e={events:{treeBase:{rowExpanded:{},rowCollapsed:{}}},methods:{treeBase:{expandAllRows:function(){g.expandAllRows(r)},collapseAllRows:function(){g.collapseAllRows(r)},toggleRowTreeState:function(e){g.toggleRowTreeState(r,e)},expandRow:function(e,t){g.expandRow(r,e,t)},expandRowChildren:function(e){g.expandRowChildren(r,e)},collapseRow:function(e){g.collapseRow(r,e)},collapseRowChildren:function(e){g.collapseRowChildren(r,e)},getTreeExpandedState:function(){return{expandedState:g.getTreeState(r)}},setTreeState:function(e){g.setTreeState(r,e)},getRowChildren:function(e){return e.treeNode.children.map(function(e){return e.row})}}}};r.api.registerEventsFromObject(e.events),r.api.registerMethodsFromObject(e.methods)},defaultGridOptions:function(e){e.treeRowHeaderBaseWidth=e.treeRowHeaderBaseWidth||30,e.treeIndent=null!=e.treeIndent?e.treeIndent:10,e.showTreeRowHeader=!1!==e.showTreeRowHeader,e.showTreeExpandNoChildren=!1!==e.showTreeExpandNoChildren,e.treeRowHeaderAlwaysVisible=!1!==e.treeRowHeaderAlwaysVisible,e.treeCustomAggregations=e.treeCustomAggregations||{},e.enableExpandAll=!1!==e.enableExpandAll},treeBaseColumnBuilder:function(e,t,r){void 0!==e.customTreeAggregationFn&&(t.treeAggregationFn=e.customTreeAggregationFn),void 0!==e.treeAggregationType&&(t.treeAggregation={type:e.treeAggregationType},void 0!==r.treeCustomAggregations[e.treeAggregationType]?(t.treeAggregationFn=r.treeCustomAggregations[e.treeAggregationType].aggregationFn,t.treeAggregationFinalizerFn=r.treeCustomAggregations[e.treeAggregationType].finalizerFn,t.treeAggregation.label=r.treeCustomAggregations[e.treeAggregationType].label):void 0!==g.nativeAggregations()[e.treeAggregationType]&&(t.treeAggregationFn=g.nativeAggregations()[e.treeAggregationType].aggregationFn,t.treeAggregation.label=g.nativeAggregations()[e.treeAggregationType].label)),void 0!==e.treeAggregationLabel&&(void 0===t.treeAggregation&&(t.treeAggregation={}),t.treeAggregation.label=e.treeAggregationLabel),t.treeAggregationUpdateEntity=!1!==e.treeAggregationUpdateEntity,void 0===t.customTreeAggregationFinalizerFn&&(t.customTreeAggregationFinalizerFn=e.customTreeAggregationFinalizerFn)},createRowHeader:function(e){var t={name:i.rowHeaderColName,displayName:"",width:e.options.treeRowHeaderBaseWidth,minWidth:10,cellTemplate:"ui-grid/treeBaseRowHeader",headerCellTemplate:"ui-grid/treeBaseHeaderCell",enableColumnResizing:!1,enableColumnMenu:!1,exporterSuppressExport:!0,allowCellFocus:!0};t.visible=e.options.treeRowHeaderAlwaysVisible,e.addRowHeaderColumn(t,-100)},expandAllRows:function(t){t.treeBase.tree.forEach(function(e){g.setAllNodes(t,e,i.EXPANDED)}),t.treeBase.expandAll=!0,t.queueGridRefresh()},collapseAllRows:function(t){t.treeBase.tree.forEach(function(e){g.setAllNodes(t,e,i.COLLAPSED)}),t.treeBase.expandAll=!1,t.queueGridRefresh()},setAllNodes:function(t,e,r){void 0!==e.state&&e.state!==r&&((e.state=r)===i.EXPANDED?t.api.treeBase.raise.rowExpanded(e.row):t.api.treeBase.raise.rowCollapsed(e.row)),e.children&&e.children.forEach(function(e){g.setAllNodes(t,e,r)})},toggleRowTreeState:function(e,t){void 0===t.treeLevel||null===t.treeLevel||t.treeLevel<0||(t.treeNode.state===i.EXPANDED?g.collapseRow(e,t):g.expandRow(e,t,!1),e.queueGridRefresh())},expandRow:function(e,t,r){if(r){for(var n=[];t&&void 0!==t.treeLevel&&null!==t.treeLevel&&0<=t.treeLevel&&t.treeNode.state!==i.EXPANDED;)n.push(t),t=t.treeNode.parentRow;if(0')[0],r="reverse";return document.body.appendChild(t),0 "}),n.trustAsHtml(" "+o.getSafeText("validate.error")+" "+r)},getTitleFormattedErrors:function(e,t){var r="",i=c.getErrorMessages(e,t);if(i.length)return i.forEach(function(e){r+=e+"\n"}),n.trustAsHtml(o.getSafeText("validate.error")+"\n"+r)},runValidators:function(e,t,n,o,a){if(n!==o){if(void 0===t.name||!t.name)throw new Error("colDef.name is required to perform validation");c.setValid(e,t);var r=function(t,r,i){return function(e){e||(c.setInvalid(t,r),c.setError(t,r,i),a&&a.api.validate.raise.validationFailed(t,r,n,o))}},i=[];for(var l in t.validators){c.clearError(e,t,l);var s=c.getValidator(l,t.validators[l]),d=u.when(s(o,n,e,t)).then(r(e,t,l));i.push(d)}return u.all(i)}},createDefaultValidators:function(){c.setValidator("minLength",function(r){return function(e,t){return null==t||""===t||t.length>=r}},function(e){return o.getSafeText("validate.minLength").replace("THRESHOLD",e)}),c.setValidator("maxLength",function(r){return function(e,t){return null==t||""===t||t.length<=r}},function(e){return o.getSafeText("validate.maxLength").replace("THRESHOLD",e)}),c.setValidator("required",function(r){return function(e,t){return!r||!(null==t||""===t)}},function(){return o.getSafeText("validate.required")})},initializeGrid:function(e,n){n.validate={isInvalid:c.isInvalid,getErrorMessages:c.getErrorMessages,getFormattedErrors:c.getFormattedErrors,getTitleFormattedErrors:c.getTitleFormattedErrors,runValidators:c.runValidators};var t={events:{validate:{validationFailed:function(e,t,r,i){}}},methods:{validate:{isInvalid:function(e,t){return n.validate.isInvalid(e,t)},getErrorMessages:function(e,t){return n.validate.getErrorMessages(e,t)},getFormattedErrors:function(e,t){return n.validate.getFormattedErrors(e,t)},getTitleFormattedErrors:function(e,t){return n.validate.getTitleFormattedErrors(e,t)}}}};n.api.registerEventsFromObject(t.events),n.api.registerMethodsFromObject(t.methods),n.edit&&n.api.edit.on.afterCellEdit(e,function(e,t,r,i){n.validate.runValidators(e,t,r,i,n)}),c.createDefaultValidators()}};return c}]),e.directive("uiGridValidate",["gridUtil","uiGridValidateService",function(e,n){return{priority:0,replace:!0,require:"^uiGrid",scope:!1,compile:function(){return{pre:function(e,t,r,i){n.initializeGrid(e,i.grid)},post:function(e,t,r,i){}}}}}])}(),angular.module("ui.grid").run(["$templateCache",function(e){"use strict";e.put("ui-grid/ui-grid-filter",'\x3c!-- tfooter --\x3e '),e.put("ui-grid/ui-grid-grid-footer",'{{\'search.totalItems\' | t}} {{grid.rows.length}} ({{"search.showingItems" | t}} {{grid.renderContainers.body.visibleRowCache.length}}) '),e.put("ui-grid/ui-grid-header",'\x3c!-- theader --\x3e '),e.put("ui-grid/ui-grid-menu-button",'\x3c!-- TODO (c0bra): add "scoped" attr here, eventually? --\x3e '),e.put("ui-grid/uiGridCell",'{{COL_FIELD CUSTOM_FILTERS}} '),e.put("ui-grid/uiGridColumnMenu",'\x3c!-- \n --\x3e\n \n
\n \n {{ col.getAggregationText() + ( col.getAggregationValue() CUSTOM_FILTERS ) }} {{ col.displayName CUSTOM_FILTERS }} {{col.sort.priority + 1}} \x3c!-- All of these dom elements are replaced in place --\x3e "),e.put("ui-grid/uiGridViewport",'\x3c!-- tbody --\x3e '),e.put("ui-grid/cellEditor",''),e.put("ui-grid/dropdownEditor",''),e.put("ui-grid/fileChooserEditor",''),e.put("ui-grid/emptyBaseLayerContainer",' / {{ paginationApi.getTotalPages() }} {{sizesLabel}} {{grid.options.paginationPageSize}} {{sizesLabel}}{{ 1 + paginationApi.getFirstRowIndex() }} - {{ 1 + paginationApi.getLastRowIndex() }} {{paginationOf}} {{grid.options.totalItems}} {{totalItemsLabel}} \x3c!-- '),e.put("ui-grid/selectionRowHeader",'{{COL_FIELD CUSTOM_FILTERS}} '),e.put("ui-grid/cellTooltipValidator",'{{COL_FIELD CUSTOM_FILTERS}} ')}]);
\ No newline at end of file
+!function(){"use strict";angular.module("ui.grid.i18n",[]),angular.module("ui.grid",["ui.grid.i18n"])}(),function(){"use strict";angular.module("ui.grid.autoResize",["ui.grid"]).directive("uiGridAutoResize",["gridUtil",function(i){return{require:"uiGrid",scope:!1,link:function(e,n,t,o){var r;r=i.debounce(function(e,t,r,i){null!==n[0].offsetParent&&(o.grid.gridWidth=r,o.grid.gridHeight=i,o.grid.queueGridRefresh().then(function(){o.grid.api.core.raise.gridDimensionChanged(t,e,i,r)}))},400),e.$watchCollection(function(){return{width:i.elementWidth(n),height:i.elementHeight(n)}},function(e,t){angular.equals(e,t)||r(t.width,t.height,e.width,e.height)})}}}])}(),function(){"use strict";var e=angular.module("ui.grid.cellNav",["ui.grid"]);e.constant("uiGridCellNavConstants",{FEATURE_NAME:"gridCellNav",CELL_NAV_EVENT:"cellNav",direction:{LEFT:0,RIGHT:1,UP:2,DOWN:3,PG_UP:4,PG_DOWN:5},EVENT_TYPE:{KEYDOWN:0,CLICK:1,CLEAR:2}}),e.factory("uiGridCellNavFactory",["gridUtil","uiGridConstants","uiGridCellNavConstants","GridRowColumn","$q",function(e,t,i,l,r){var n=function(e,t,r,i){this.rows=e.visibleRowCache,this.columns=t.visibleColumnCache,this.leftColumns=r?r.visibleColumnCache:[],this.rightColumns=i?i.visibleColumnCache:[],this.bodyContainer=e};return n.prototype.getFocusableCols=function(){return this.leftColumns.concat(this.columns,this.rightColumns).filter(function(e){return e.colDef.allowCellFocus})},n.prototype.getFocusableRows=function(){return this.rows.filter(function(e){return!1!==e.allowCellFocus})},n.prototype.getNextRowCol=function(e,t,r){switch(e){case i.direction.LEFT:return this.getRowColLeft(t,r);case i.direction.RIGHT:return this.getRowColRight(t,r);case i.direction.UP:return this.getRowColUp(t,r);case i.direction.DOWN:return this.getRowColDown(t,r);case i.direction.PG_UP:return this.getRowColPageUp(t,r);case i.direction.PG_DOWN:return this.getRowColPageDown(t,r)}},n.prototype.initializeSelection=function(){var e=this.getFocusableCols(),t=this.getFocusableRows();return 0===e.length||0===t.length?null:new l(t[0],e[0])},n.prototype.getRowColLeft=function(e,t){var r=this.getFocusableCols(),i=this.getFocusableRows(),n=r.indexOf(t),o=i.indexOf(e);-1===n&&(n=1);var a=0===n?r.length-1:n-1;return new l(n<=a?0===o?e:i[o-1]:e,r[a])},n.prototype.getRowColRight=function(e,t){var r=this.getFocusableCols(),i=this.getFocusableRows(),n=r.indexOf(t),o=i.indexOf(e);-1===n&&(n=0);var a=n===r.length-1?0:n+1;return a<=n?o===i.length-1?new l(e,r[a]):new l(i[o+1],r[a]):new l(e,r[a])},n.prototype.getRowColDown=function(e,t){var r=this.getFocusableCols(),i=this.getFocusableRows(),n=r.indexOf(t),o=i.indexOf(e);return-1===n&&(n=0),o===i.length-1?new l(e,r[n]):new l(i[o+1],r[n])},n.prototype.getRowColPageDown=function(e,t){var r=this.getFocusableCols(),i=this.getFocusableRows(),n=r.indexOf(t),o=i.indexOf(e);-1===n&&(n=0);var a=this.bodyContainer.minRowsToRender();return o>=i.length-a?new l(i[i.length-1],r[n]):new l(i[o+a],r[n])},n.prototype.getRowColUp=function(e,t){var r=this.getFocusableCols(),i=this.getFocusableRows(),n=r.indexOf(t),o=i.indexOf(e);return-1===n&&(n=0),new l(0===o?e:i[o-1],r[n])},n.prototype.getRowColPageUp=function(e,t){var r=this.getFocusableCols(),i=this.getFocusableRows(),n=r.indexOf(t),o=i.indexOf(e);-1===n&&(n=0);var a=this.bodyContainer.minRowsToRender();return new l(o-a<0?i[0]:i[o-a],r[n])},n}]),e.service("uiGridCellNavService",["gridUtil","uiGridConstants","uiGridCellNavConstants","$q","uiGridCellNavFactory","GridRowColumn","ScrollEvent",function(e,t,r,i,n,o,a){var l={initializeGrid:function(i){i.registerColumnBuilder(l.cellNavColumnBuilder),i.cellNav={},i.cellNav.lastRowCol=null,i.cellNav.focusedCells=[],l.defaultGridOptions(i.options);var e={events:{cellNav:{navigate:function(e,t){},viewPortKeyDown:function(e,t){},viewPortKeyPress:function(e,t){}}},methods:{cellNav:{scrollToFocus:function(e,t){return l.scrollToFocus(i,e,t)},getFocusedCell:function(){return i.cellNav.lastRowCol},getCurrentSelection:function(){return i.cellNav.focusedCells},rowColSelectIndex:function(e){for(var t=-1,r=0;r')[0],r="reverse";return document.body.appendChild(t),0 "}),n.trustAsHtml(" "+o.getSafeText("validate.error")+" "+r)},getTitleFormattedErrors:function(e,t){var r="",i=c.getErrorMessages(e,t);if(i.length)return i.forEach(function(e){r+=e+"\n"}),n.trustAsHtml(o.getSafeText("validate.error")+"\n"+r)},runValidators:function(e,t,n,o,a){if(n!==o){if(void 0===t.name||!t.name)throw new Error("colDef.name is required to perform validation");c.setValid(e,t);var r=function(t,r,i){return function(e){e||(c.setInvalid(t,r),c.setError(t,r,i),a&&a.api.validate.raise.validationFailed(t,r,n,o))}},i=[];for(var l in t.validators){c.clearError(e,t,l);var s=c.getValidator(l,t.validators[l]),d=u.when(s(o,n,e,t)).then(r(e,t,l));i.push(d)}return u.all(i)}},createDefaultValidators:function(){c.setValidator("minLength",function(r){return function(e,t){return null==t||""===t||t.length>=r}},function(e){return o.getSafeText("validate.minLength").replace("THRESHOLD",e)}),c.setValidator("maxLength",function(r){return function(e,t){return null==t||""===t||t.length<=r}},function(e){return o.getSafeText("validate.maxLength").replace("THRESHOLD",e)}),c.setValidator("required",function(r){return function(e,t){return!r||!(null==t||""===t)}},function(){return o.getSafeText("validate.required")})},initializeGrid:function(e,n){n.validate={isInvalid:c.isInvalid,getErrorMessages:c.getErrorMessages,getFormattedErrors:c.getFormattedErrors,getTitleFormattedErrors:c.getTitleFormattedErrors,runValidators:c.runValidators};var t={events:{validate:{validationFailed:function(e,t,r,i){}}},methods:{validate:{isInvalid:function(e,t){return n.validate.isInvalid(e,t)},getErrorMessages:function(e,t){return n.validate.getErrorMessages(e,t)},getFormattedErrors:function(e,t){return n.validate.getFormattedErrors(e,t)},getTitleFormattedErrors:function(e,t){return n.validate.getTitleFormattedErrors(e,t)}}}};n.api.registerEventsFromObject(t.events),n.api.registerMethodsFromObject(t.methods),n.edit&&n.api.edit.on.afterCellEdit(e,function(e,t,r,i){n.validate.runValidators(e,t,r,i,n)}),c.createDefaultValidators()}};return c}]),e.directive("uiGridValidate",["gridUtil","uiGridValidateService",function(e,n){return{priority:0,replace:!0,require:"^uiGrid",scope:!1,compile:function(){return{pre:function(e,t,r,i){n.initializeGrid(e,i.grid)},post:function(e,t,r,i){}}}}}])}(),angular.module("ui.grid").run(["$templateCache",function(e){"use strict";e.put("ui-grid/ui-grid-filter",'\x3c!-- tfooter --\x3e '),e.put("ui-grid/ui-grid-grid-footer",'{{\'search.totalItems\' | t}} {{grid.rows.length}} ({{"search.showingItems" | t}} {{grid.renderContainers.body.visibleRowCache.length}}) '),e.put("ui-grid/ui-grid-header",'\x3c!-- theader --\x3e '),e.put("ui-grid/ui-grid-menu-button",'\x3c!-- TODO (c0bra): add "scoped" attr here, eventually? --\x3e '),e.put("ui-grid/uiGridCell",'{{COL_FIELD CUSTOM_FILTERS}} '),e.put("ui-grid/uiGridColumnMenu",'\x3c!-- \n --\x3e\n \n
\n \n {{ col.getAggregationText() + ( col.getAggregationValue() CUSTOM_FILTERS ) }} {{ col.displayName CUSTOM_FILTERS }} {{col.sort.priority + 1}} \x3c!-- All of these dom elements are replaced in place --\x3e "),e.put("ui-grid/uiGridViewport",'\x3c!-- tbody --\x3e '),e.put("ui-grid/cellEditor",''),e.put("ui-grid/dropdownEditor",''),e.put("ui-grid/fileChooserEditor",''),e.put("ui-grid/emptyBaseLayerContainer",' / {{ paginationApi.getTotalPages() }} {{sizesLabel}} {{grid.options.paginationPageSize}} {{sizesLabel}}{{ 1 + paginationApi.getFirstRowIndex() }} - {{ 1 + paginationApi.getLastRowIndex() }} {{paginationOf}} {{grid.options.totalItems}} {{totalItemsLabel}} \x3c!-- '),e.put("ui-grid/selectionRowHeader",'{{COL_FIELD CUSTOM_FILTERS}} '),e.put("ui-grid/cellTooltipValidator",'{{COL_FIELD CUSTOM_FILTERS}} ')}]);
\ No newline at end of file
diff --git a/release/ui-grid.move-columns.js b/release/ui-grid.move-columns.js
index e39b9dbdb..c4e2f3e43 100644
--- a/release/ui-grid.move-columns.js
+++ b/release/ui-grid.move-columns.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/ui-grid.move-columns.min.js b/release/ui-grid.move-columns.min.js
index 1897cc245..aad34e81f 100644
--- a/release/ui-grid.move-columns.min.js
+++ b/release/ui-grid.move-columns.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/ui-grid.pagination.js b/release/ui-grid.pagination.js
index fffb501f7..a5d496721 100644
--- a/release/ui-grid.pagination.js
+++ b/release/ui-grid.pagination.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/ui-grid.pagination.min.js b/release/ui-grid.pagination.min.js
index 6f7c24926..d26c87809 100644
--- a/release/ui-grid.pagination.min.js
+++ b/release/ui-grid.pagination.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/ui-grid.pinning.js b/release/ui-grid.pinning.js
index 3939ef3f9..85c9ff9bd 100644
--- a/release/ui-grid.pinning.js
+++ b/release/ui-grid.pinning.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/ui-grid.pinning.min.js b/release/ui-grid.pinning.min.js
index 1574e1395..e1c7607de 100644
--- a/release/ui-grid.pinning.min.js
+++ b/release/ui-grid.pinning.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/ui-grid.resize-columns.js b/release/ui-grid.resize-columns.js
index efbd5c62d..52f8b97f4 100644
--- a/release/ui-grid.resize-columns.js
+++ b/release/ui-grid.resize-columns.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/ui-grid.resize-columns.min.js b/release/ui-grid.resize-columns.min.js
index 70ace8b83..d6c51b2c7 100644
--- a/release/ui-grid.resize-columns.min.js
+++ b/release/ui-grid.resize-columns.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/ui-grid.row-edit.js b/release/ui-grid.row-edit.js
index a75e52b10..da061ede4 100644
--- a/release/ui-grid.row-edit.js
+++ b/release/ui-grid.row-edit.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/ui-grid.row-edit.min.js b/release/ui-grid.row-edit.min.js
index c52e16ff0..9d6b8f620 100644
--- a/release/ui-grid.row-edit.min.js
+++ b/release/ui-grid.row-edit.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/ui-grid.saveState.js b/release/ui-grid.saveState.js
index 3b6ff2087..026421497 100644
--- a/release/ui-grid.saveState.js
+++ b/release/ui-grid.saveState.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/ui-grid.saveState.min.js b/release/ui-grid.saveState.min.js
index f86726ba7..213782541 100644
--- a/release/ui-grid.saveState.min.js
+++ b/release/ui-grid.saveState.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/ui-grid.selection.js b/release/ui-grid.selection.js
index 2631978c8..102fb25dc 100644
--- a/release/ui-grid.selection.js
+++ b/release/ui-grid.selection.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/ui-grid.selection.min.js b/release/ui-grid.selection.min.js
index 1ad96e702..40625c5f6 100644
--- a/release/ui-grid.selection.min.js
+++ b/release/ui-grid.selection.min.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
diff --git a/release/ui-grid.tree-base.js b/release/ui-grid.tree-base.js
index c9be6b44d..5f053a610 100644
--- a/release/ui-grid.tree-base.js
+++ b/release/ui-grid.tree-base.js
@@ -1,5 +1,5 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
@@ -1091,6 +1091,7 @@
*/
createTree: function( grid, renderableRows ) {
var currentLevel = -1,
+ parentsCache = {},
parents = [],
currentState;
@@ -1121,16 +1122,31 @@
}
}
+ // If row header as parent exists in parentsCache
+ if (
+ typeof row.treeLevel !== 'undefined' &&
+ row.treeLevel !== null &&
+ row.treeLevel >= 0 &&
+ parentsCache.hasOwnProperty(row.uid)
+ ) {
+ parents.push(parentsCache[row.uid]);
+ }
+
// aggregate if this is a leaf node
if ( ( typeof(row.treeLevel) === 'undefined' || row.treeLevel === null || row.treeLevel < 0 ) && row.visible ) {
service.aggregate( grid, row, parents );
}
// add this node to the tree
- service.addOrUseNode(grid, row, parents, aggregations);
+ if (!parentsCache.hasOwnProperty(row.uid)) {
+ service.addOrUseNode(grid, row, parents, aggregations);
+ }
if ( typeof(row.treeLevel) !== 'undefined' && row.treeLevel !== null && row.treeLevel >= 0 ) {
- parents.push(row);
+ if (!parentsCache.hasOwnProperty(row.uid)) {
+ parentsCache[row.uid] = row;
+ parents.push(row);
+ }
currentLevel++;
currentState = service.setCurrentState(parents);
}
diff --git a/release/ui-grid.tree-base.min.js b/release/ui-grid.tree-base.min.js
index c36c32b2b..5150373cd 100644
--- a/release/ui-grid.tree-base.min.js
+++ b/release/ui-grid.tree-base.min.js
@@ -1,7 +1,7 @@
/*!
- * ui-grid - v4.9.1 - 2020-10-26
+ * ui-grid - v4.9.2 - 2020-12-01
* Copyright (c) 2020 ; License: MIT
*/
-!function(){"use strict";var e=angular.module("ui.grid.treeBase",["ui.grid"]);e.constant("uiGridTreeBaseConstants",{featureName:"treeBase",rowHeaderColName:"treeBaseRowHeaderCol",EXPANDED:"expanded",COLLAPSED:"collapsed",aggregation:{COUNT:"count",SUM:"sum",MAX:"max",MIN:"min",AVG:"avg"}}),e.service("uiGridTreeBaseService",["$q","uiGridTreeBaseConstants","gridUtil","GridRow","gridClassFactory","i18nService","uiGridConstants","rowSorter",function(e,i,t,r,n,o,a,l){var g={initializeGrid:function(r){r.treeBase={},r.treeBase.numberLevels=0,r.treeBase.expandAll=!1,r.treeBase.tree=[],g.defaultGridOptions(r.options),r.registerRowsProcessor(g.treeRows,410),r.registerColumnBuilder(g.treeBaseColumnBuilder),g.createRowHeader(r);var e={events:{treeBase:{rowExpanded:{},rowCollapsed:{}}},methods:{treeBase:{expandAllRows:function(){g.expandAllRows(r)},collapseAllRows:function(){g.collapseAllRows(r)},toggleRowTreeState:function(e){g.toggleRowTreeState(r,e)},expandRow:function(e,t){g.expandRow(r,e,t)},expandRowChildren:function(e){g.expandRowChildren(r,e)},collapseRow:function(e){g.collapseRow(r,e)},collapseRowChildren:function(e){g.collapseRowChildren(r,e)},getTreeExpandedState:function(){return{expandedState:g.getTreeState(r)}},setTreeState:function(e){g.setTreeState(r,e)},getRowChildren:function(e){return e.treeNode.children.map(function(e){return e.row})}}}};r.api.registerEventsFromObject(e.events),r.api.registerMethodsFromObject(e.methods)},defaultGridOptions:function(e){e.treeRowHeaderBaseWidth=e.treeRowHeaderBaseWidth||30,e.treeIndent=null!=e.treeIndent?e.treeIndent:10,e.showTreeRowHeader=!1!==e.showTreeRowHeader,e.showTreeExpandNoChildren=!1!==e.showTreeExpandNoChildren,e.treeRowHeaderAlwaysVisible=!1!==e.treeRowHeaderAlwaysVisible,e.treeCustomAggregations=e.treeCustomAggregations||{},e.enableExpandAll=!1!==e.enableExpandAll},treeBaseColumnBuilder:function(e,t,r){void 0!==e.customTreeAggregationFn&&(t.treeAggregationFn=e.customTreeAggregationFn),void 0!==e.treeAggregationType&&(t.treeAggregation={type:e.treeAggregationType},void 0!==r.treeCustomAggregations[e.treeAggregationType]?(t.treeAggregationFn=r.treeCustomAggregations[e.treeAggregationType].aggregationFn,t.treeAggregationFinalizerFn=r.treeCustomAggregations[e.treeAggregationType].finalizerFn,t.treeAggregation.label=r.treeCustomAggregations[e.treeAggregationType].label):void 0!==g.nativeAggregations()[e.treeAggregationType]&&(t.treeAggregationFn=g.nativeAggregations()[e.treeAggregationType].aggregationFn,t.treeAggregation.label=g.nativeAggregations()[e.treeAggregationType].label)),void 0!==e.treeAggregationLabel&&(void 0===t.treeAggregation&&(t.treeAggregation={}),t.treeAggregation.label=e.treeAggregationLabel),t.treeAggregationUpdateEntity=!1!==e.treeAggregationUpdateEntity,void 0===t.customTreeAggregationFinalizerFn&&(t.customTreeAggregationFinalizerFn=e.customTreeAggregationFinalizerFn)},createRowHeader:function(e){var t={name:i.rowHeaderColName,displayName:"",width:e.options.treeRowHeaderBaseWidth,minWidth:10,cellTemplate:"ui-grid/treeBaseRowHeader",headerCellTemplate:"ui-grid/treeBaseHeaderCell",enableColumnResizing:!1,enableColumnMenu:!1,exporterSuppressExport:!0,allowCellFocus:!0};t.visible=e.options.treeRowHeaderAlwaysVisible,e.addRowHeaderColumn(t,-100)},expandAllRows:function(t){t.treeBase.tree.forEach(function(e){g.setAllNodes(t,e,i.EXPANDED)}),t.treeBase.expandAll=!0,t.queueGridRefresh()},collapseAllRows:function(t){t.treeBase.tree.forEach(function(e){g.setAllNodes(t,e,i.COLLAPSED)}),t.treeBase.expandAll=!1,t.queueGridRefresh()},setAllNodes:function(t,e,r){void 0!==e.state&&e.state!==r&&((e.state=r)===i.EXPANDED?t.api.treeBase.raise.rowExpanded(e.row):t.api.treeBase.raise.rowCollapsed(e.row)),e.children&&e.children.forEach(function(e){g.setAllNodes(t,e,r)})},toggleRowTreeState:function(e,t){void 0===t.treeLevel||null===t.treeLevel||t.treeLevel<0||(t.treeNode.state===i.EXPANDED?g.collapseRow(e,t):g.expandRow(e,t,!1),e.queueGridRefresh())},expandRow:function(e,t,r){if(r){for(var n=[];t&&void 0!==t.treeLevel&&null!==t.treeLevel&&0<=t.treeLevel&&t.treeNode.state!==i.EXPANDED;)n.push(t),t=t.treeNode.parentRow;if(0 |