Update documentation

barchart · Sep 8, 2023 · 7e05552 · 7e05552
1 parent aa211f9
commit 7e05552
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/docs/content/release_notes.md b/docs/content/release_notes.md
@@ -1,5 +1,14 @@
 # Release Notes
 
+## 6.2.0
+**New Features**
+
+* Added the `UnitCode.roundToNearestTick` function.
+
+**Technical Enhancements**
+
+* Updated the [`@barchart/common-js`](https://github.com/barchart/common-js) library.
+
 ## 6.1.1
 **Bug Fixes**
 

diff --git a/docs/content/sdk/lib-utilities-data.md b/docs/content/sdk/lib-utilities-data.md
@@ -167,6 +167,7 @@
         * [.getFractionDigits([special])](#UnitCodegetFractionDigits) ⇒ <code>Number</code> \| <code>undefined</code>
         * [.getMinimumTick(tickIncrement)](#UnitCodegetMinimumTick) ⇒ <code>Number</code>
         * [.getMinimumTickValue(tickIncrement, pointValue)](#UnitCodegetMinimumTickValue) ⇒ <code>Number</code>
+        * [.roundToNearestTick(value, tickIncrement, [roundToZero])](#UnitCoderoundToNearestTick) ⇒ <code>Number</code>
     * _static_
         * [.parse(code)](#UnitCodeparse) ⇒ [<code>UnitCode</code>](#UnitCode) \| <code>null</code>
         * [.fromBaseCode(code)](#UnitCodefromBaseCode) ⇒ [<code>UnitCode</code>](#UnitCode) \| <code>null</code>
@@ -315,6 +316,21 @@
 | pointValue | <code>Number</code> | <p>Taken from a [Profile](/content/sdk/lib-marketstate?id=profile) instance.</p> |
 
 
+* * *
+
+### unitCode.roundToNearestTick(value, tickIncrement, [roundToZero]) :id=unitcoderoundtonearesttick
+> Rounds a value to the nearest valid tick.
+
+**Kind**: instance method of [<code>UnitCode</code>](#UnitCode)  
+**Returns**: <code>Number</code>  
+
+| Param | Type |
+| --- | --- |
+| value | <code>Number</code> \| <code>Decimal</code> | 
+| tickIncrement | <code>Number</code> | 
+| [roundToZero] | <code>Boolean</code> | 
+
+
 * * *
 
 ### UnitCode.parse(code) :id=unitcodeparse