|
18 | 18 | </div></td></tr></tbody></table><h5 id="methods_createboundedwrapper_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-function">Function</a></td><td><div class="createboundedwrapper-page"><p>The wrapper that performs the binding</p> |
19 | 19 | </div></td></tr></table></div> |
20 | 20 | </li> |
21 | | -<li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-grid-util.js#L1153" class="view-source icon-eye-open"> </a><h3 id="methods_debounce">debounce(func, wait, immediate)</h3> |
| 21 | +<li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-grid-util.js#L1158" class="view-source icon-eye-open"> </a><h3 id="methods_debounce">debounce(func, wait, immediate)</h3> |
22 | 22 | <div class="debounce"><div class="debounce-page"><p>Copied from <a href="https://github.com/shahata/angular-debounce">https://github.com/shahata/angular-debounce</a> |
23 | 23 | Takes a function, decorates it to execute only 1 time after multiple calls, and returns the decorated function</p> |
24 | 24 | </div><h5 id="methods_debounce_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>func</td><td><a href="" class="label type-hint type-hint-function">function</a></td><td><div class="debounce-page"><p>function to debounce</p> |
|
35 | 35 | </div></div> |
36 | 36 | </div> |
37 | 37 | </li> |
38 | | -<li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-grid-util.js#L1076" class="view-source icon-eye-open"> </a><h3 id="methods_denormalizescrollleft">denormalizeScrollLeft(element, scrollLeft, grid)</h3> |
| 38 | +<li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-grid-util.js#L1081" class="view-source icon-eye-open"> </a><h3 id="methods_denormalizescrollleft">denormalizeScrollLeft(element, scrollLeft, grid)</h3> |
39 | 39 | <div class="denormalizescrollleft"><div class="denormalizescrollleft-page"><p>Browsers currently handle RTL in different ways, resulting in inconsistent scrollLeft values. This method denormalizes a value for the current browser.</p> |
40 | 40 | </div><h5 id="methods_denormalizescrollleft_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>element</td><td><a href="" class="label type-hint type-hint-element">element</a></td><td><div class="denormalizescrollleft-page"><p>The element to normalize the <code>scrollLeft</code> value for</p> |
41 | 41 | </div></td></tr><tr><td>scrollLeft</td><td><a href="" class="label type-hint type-hint-number">number</a></td><td><div class="denormalizescrollleft-page"><p>The <code>scrollLeft</code> value to denormalize.</p> |
|
109 | 109 | </ul> |
110 | 110 | </div></td></tr></table></div> |
111 | 111 | </li> |
112 | | -<li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-grid-util.js#L773" class="view-source icon-eye-open"> </a><h3 id="methods_logdebug">logDebug()</h3> |
| 112 | +<li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-grid-util.js#L778" class="view-source icon-eye-open"> </a><h3 id="methods_logdebug">logDebug()</h3> |
113 | 113 | <div class="logdebug"><div class="logdebug-page"><p>wraps the $log method, allowing us to choose different |
114 | 114 | treatment within ui-grid if we so desired. At present we only log |
115 | 115 | debug messages if uiGridConstants.LOG_DEBUG_MESSAGES is set to true</p> |
116 | 116 | </div></div> |
117 | 117 | </li> |
118 | | -<li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-grid-util.js#L742" class="view-source icon-eye-open"> </a><h3 id="methods_logerror">logError(logMessage)</h3> |
| 118 | +<li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-grid-util.js#L747" class="view-source icon-eye-open"> </a><h3 id="methods_logerror">logError(logMessage)</h3> |
119 | 119 | <div class="logerror"><div class="logerror-page"><p>wraps the $log method, allowing us to choose different |
120 | 120 | treatment within ui-grid if we so desired. At present we only log |
121 | 121 | error messages if uiGridConstants.LOG_ERROR_MESSAGES is set to true</p> |
122 | 122 | </div><h5 id="methods_logerror_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>logMessage</td><td><a href="" class="label type-hint type-hint-string">string</a></td><td><div class="logerror-page"><p>message to be logged to the console</p> |
123 | 123 | </div></td></tr></tbody></table></div> |
124 | 124 | </li> |
125 | | -<li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-grid-util.js#L758" class="view-source icon-eye-open"> </a><h3 id="methods_logwarn">logWarn(logMessage)</h3> |
| 125 | +<li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-grid-util.js#L763" class="view-source icon-eye-open"> </a><h3 id="methods_logwarn">logWarn(logMessage)</h3> |
126 | 126 | <div class="logwarn"><div class="logwarn-page"><p>wraps the $log method, allowing us to choose different |
127 | 127 | treatment within ui-grid if we so desired. At present we only log |
128 | 128 | warning messages if uiGridConstants.LOG_WARN_MESSAGES is set to true</p> |
|
141 | 141 | </div></div> |
142 | 142 | </div> |
143 | 143 | </li> |
144 | | -<li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-grid-util.js#L1041" class="view-source icon-eye-open"> </a><h3 id="methods_normalizescrollleft">normalizeScrollLeft(element, grid)</h3> |
| 144 | +<li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-grid-util.js#L1046" class="view-source icon-eye-open"> </a><h3 id="methods_normalizescrollleft">normalizeScrollLeft(element, grid)</h3> |
145 | 145 | <div class="normalizescrollleft"><div class="normalizescrollleft-page"><p>Browsers currently handle RTL in different ways, resulting in inconsistent scrollLeft values. This method normalizes them</p> |
146 | 146 | </div><h5 id="methods_normalizescrollleft_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>element</td><td><a href="" class="label type-hint type-hint-element">element</a></td><td><div class="normalizescrollleft-page"><p>The element to get the <code>scrollLeft</code> from.</p> |
147 | 147 | </div></td></tr><tr><td>grid</td><td><a href="" class="label type-hint type-hint-grid">grid</a></td><td><div class="normalizescrollleft-page"><ul> |
|
150 | 150 | </div></td></tr></tbody></table><h5 id="methods_normalizescrollleft_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-number">number</a></td><td><div class="normalizescrollleft-page"><p>A normalized scrollLeft value for the current browser.</p> |
151 | 151 | </div></td></tr></table></div> |
152 | 152 | </li> |
153 | | -<li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-grid-util.js#L541" class="view-source icon-eye-open"> </a><h3 id="methods_normalizewheelevent">normalizeWheelEvent(event)</h3> |
| 153 | +<li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-grid-util.js#L546" class="view-source icon-eye-open"> </a><h3 id="methods_normalizewheelevent">normalizeWheelEvent(event)</h3> |
154 | 154 | <div class="normalizewheelevent"><div class="normalizewheelevent-page"><p>Given an event from this list:</p> |
155 | 155 | <p><code>wheel, mousewheel, DomMouseScroll, MozMousePixelScroll</code></p> |
156 | 156 | <p>"normalize" it |
|
159 | 159 | </div></td></tr></tbody></table><h5 id="methods_normalizewheelevent_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-event">event</a></td><td><div class="normalizewheelevent-page"><p>A normalized event</p> |
160 | 160 | </div></td></tr></table></div> |
161 | 161 | </li> |
162 | | -<li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-grid-util.js#L1116" class="view-source icon-eye-open"> </a><h3 id="methods_preeval">preEval(path)</h3> |
| 162 | +<li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-grid-util.js#L1121" class="view-source icon-eye-open"> </a><h3 id="methods_preeval">preEval(path)</h3> |
163 | 163 | <div class="preeval"><div class="preeval-page"><p>Takes a field path and converts it to bracket notation to allow for special characters in path</p> |
164 | 164 | </div><h5 id="methods_preeval_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>path</td><td><a href="" class="label type-hint type-hint-string">string</a></td><td><div class="preeval-page"><p>Path to evaluate</p> |
165 | 165 | </div></td></tr></tbody></table><h5 id="methods_preeval_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-string">string</a></td><td><div class="preeval-page"><p>A path that is normalized.</p> |
|
205 | 205 | </div></div> |
206 | 206 | </div> |
207 | 207 | </li> |
208 | | -<li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-grid-util.js#L1212" class="view-source icon-eye-open"> </a><h3 id="methods_throttle">throttle(func, wait, options)</h3> |
| 208 | +<li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-grid-util.js#L1217" class="view-source icon-eye-open"> </a><h3 id="methods_throttle">throttle(func, wait, options)</h3> |
209 | 209 | <div class="throttle"><div class="throttle-page"><p>Adapted from debounce function (above) |
210 | 210 | Potential keys for Params Object are: |
211 | 211 | trailing (bool) - whether to trigger after throttle time ends if called multiple times |
|
0 commit comments