Add adjustScaleRange options (#419)

* add adjustScaleRange options

* clean up

Co-authored-by: 6y <[email protected]>

Author: tlserver

docs/guide/types/box.md

@@ -52,6 +52,7 @@ The following options are available for box annotations.
 | Name | Type | [Scriptable](../options#scriptable-options) | Default
 | ---- | ---- | :----: | ----
 | [`display`](#general) | `boolean` | Yes | `true`
+| [`adjustScaleRange`](#general) | `boolean` | Yes | `true`
 | [`drawTime`](#general) | `string` | Yes | `'afterDatasetsDraw'`
 | [`xScaleID`](#general) | `string` | Yes | `'x'`
 | [`yScaleID`](#general) | `string` | Yes | `'y'`
@@ -73,6 +74,7 @@ If one of the axes does not match an axis in the chart, the box will take the en
 | Name | Description |
 | ---- | ---- |
 | `display` | Whether or not this annotation is visible
+| `adjustScaleRange` | Should the scale range be adjusted if this annotation is out of range
 | `drawTime` | See [drawTime](../options#draw-time)
 | `xScaleID` | ID of the X scale to bind onto, default is 'x'.
 | `yScaleID` | ID of the Y scale to bind onto, default is 'y'.

docs/guide/types/ellipse.md

@@ -52,6 +52,7 @@ The following options are available for ellipse annotations.
 | Name | Type | [Scriptable](../options#scriptable-options) | Default
 | ---- | ---- | :----: | ----
 | [`display`](#general) | `boolean` | Yes | `true`
+| [`adjustScaleRange`](#general) | `boolean` | Yes | `true`
 | [`drawTime`](#general) | `string` | Yes | `'afterDatasetsDraw'`
 | [`xScaleID`](#general) | `string` | Yes | `'x'`
 | [`yScaleID`](#general) | `string` | Yes | `'y'`
@@ -72,6 +73,7 @@ If one of the axes does not match an axis in the chart, the ellipse will take th
 | Name | Description |
 | ---- | ---- |
 | `display` | Whether or not this annotation is visible
+| `adjustScaleRange` | Should the scale range be adjusted if this annotation is out of range
 | `drawTime` | See [drawTime](../options#draw-time)
 | `xScaleID` | ID of the X scale to bind onto, default is 'x'.
 | `yScaleID` | ID of the Y scale to bind onto, default is 'y'.

docs/guide/types/line.md

@@ -51,6 +51,7 @@ The following options are available for line annotations. All of these options c
 | Name | Type | [Scriptable](../options#scriptable-options) | Default
 | ---- | ---- | ---- | :----: | ----
 | [`display`](#general) | `boolean` | Yes | `true`
+| [`adjustScaleRange`](#general) | `boolean` | Yes | `true`
 | [`drawTime`](#general) | `string` | Yes | `'afterDatasetsDraw'`
 | [`scaleID`](#positioning) | `string` | Yes | `undefined`
 | [`value`](#positioning) | `number` | Yes | `undefined`
@@ -74,6 +75,7 @@ If one of the axes does not match an axis in the chart, the box will take the en
 | Name | Description |
 | ---- | ---- |
 | `display` | Whether or not this annotation is visible
+| `adjustScaleRange` | Should the scale range be adjusted if this annotation is out of range
 | `drawTime` | See [drawTime](../options#draw-time)
 
 ### Positioning

docs/guide/types/point.md

@@ -50,6 +50,7 @@ The following options are available for ellipse annotations.
 | Name | Type | [Scriptable](../options#scriptable-options) | Default
 | ---- | ---- | :----: | ----
 | [`display`](#general) | `boolean` | Yes | `true`
+| [`adjustScaleRange`](#general) | `boolean` | Yes | `true`
 | [`drawTime`](#general) | `string` | Yes | `'afterDatasetsDraw'`
 | [`xScaleID`](#general) | `string` | Yes | `'x'`
 | [`yScaleID`](#general) | `string` | Yes | `'y'`
@@ -69,6 +70,7 @@ If one of the axes does not match an axis in the chart, the ellipse will take th
 | Name | Description |
 | ---- | ---- |
 | `display` | Whether or not this annotation is visible
+| `adjustScaleRange` | Should the scale range be adjusted if this annotation is out of range
 | `drawTime` | See [drawTime](../options#draw-time)
 | `xScaleID` | ID of the X scale to bind onto, default is 'x'.
 | `yScaleID` | ID of the Y scale to bind onto, default is 'y'.

src/annotation.js

@@ -65,7 +65,7 @@ export default {
 
   afterDataLimits(chart, args) {
     const state = chartStates.get(chart);
-    adjustScaleRange(chart, args.scale, state.annotations.filter(a => a.display));
+    adjustScaleRange(chart, args.scale, state.annotations.filter(a => a.display && a.adjustScaleRange));
   },
 
   afterUpdate(chart, args, options) {
@@ -253,7 +253,7 @@ function getScaleLimits(scale, annotations) {
   let max = valueOrDefault(scale.max, Number.POSITIVE_INFINITY);
   for (const annotation of annotations) {
     if (annotation.scaleID === scaleID) {
-      for (const prop of ['value', 'endValue']) { //
+      for (const prop of ['value', 'endValue']) {
         const raw = annotation[prop];
         if (raw) {
           const value = scale.parse(raw);

src/types/box.js

@@ -81,6 +81,7 @@ BoxAnnotation.id = 'boxAnnotation';
 
 BoxAnnotation.defaults = {
   display: true,
+  adjustScaleRange: true,
   borderDash: [],
   borderDashOffset: 0,
   borderWidth: 1,

src/types/ellipse.js

@@ -34,6 +34,7 @@ EllipseAnnotation.id = 'ellipseAnnotation';
 
 EllipseAnnotation.defaults = {
   display: true,
+  adjustScaleRange: true,
   borderDash: [],
   borderDashOffset: 0,
   borderWidth: 1,

src/types/line.js

@@ -145,6 +145,7 @@ export default class LineAnnotation extends Element {
 LineAnnotation.id = 'lineAnnotation';
 LineAnnotation.defaults = {
   display: true,
+  adjustScaleRange: true,
   borderWidth: 2,
   borderDash: [],
   borderDashOffset: 0,

src/types/point.js

@@ -68,6 +68,7 @@ PointAnnotation.id = 'pointAnnotation';
 
 PointAnnotation.defaults = {
   display: true,
+  adjustScaleRange: true,
   borderDash: [],
   borderDashOffset: 0,
   borderWidth: 1,