Skip to content

Commit 7e05552

Browse files
committed
Update documentation
1 parent aa211f9 commit 7e05552

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

docs/content/release_notes.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Release Notes
22

3+
## 6.2.0
4+
**New Features**
5+
6+
* Added the `UnitCode.roundToNearestTick` function.
7+
8+
**Technical Enhancements**
9+
10+
* Updated the [`@barchart/common-js`](https://github.com/barchart/common-js) library.
11+
312
## 6.1.1
413
**Bug Fixes**
514

docs/content/sdk/lib-utilities-data.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,7 @@
167167
* [.getFractionDigits([special])](#UnitCodegetFractionDigits) ⇒ <code>Number</code> \| <code>undefined</code>
168168
* [.getMinimumTick(tickIncrement)](#UnitCodegetMinimumTick) ⇒ <code>Number</code>
169169
* [.getMinimumTickValue(tickIncrement, pointValue)](#UnitCodegetMinimumTickValue) ⇒ <code>Number</code>
170+
* [.roundToNearestTick(value, tickIncrement, [roundToZero])](#UnitCoderoundToNearestTick) ⇒ <code>Number</code>
170171
* _static_
171172
* [.parse(code)](#UnitCodeparse)[<code>UnitCode</code>](#UnitCode) \| <code>null</code>
172173
* [.fromBaseCode(code)](#UnitCodefromBaseCode)[<code>UnitCode</code>](#UnitCode) \| <code>null</code>
@@ -315,6 +316,21 @@
315316
| pointValue | <code>Number</code> | <p>Taken from a [Profile](/content/sdk/lib-marketstate?id=profile) instance.</p> |
316317

317318

319+
* * *
320+
321+
### unitCode.roundToNearestTick(value, tickIncrement, [roundToZero]) :id=unitcoderoundtonearesttick
322+
> Rounds a value to the nearest valid tick.
323+
324+
**Kind**: instance method of [<code>UnitCode</code>](#UnitCode)
325+
**Returns**: <code>Number</code>
326+
327+
| Param | Type |
328+
| --- | --- |
329+
| value | <code>Number</code> \| <code>Decimal</code> |
330+
| tickIncrement | <code>Number</code> |
331+
| [roundToZero] | <code>Boolean</code> |
332+
333+
318334
* * *
319335

320336
### UnitCode.parse(code) :id=unitcodeparse

0 commit comments

Comments
 (0)