Skip to content
This repository has been archived by the owner on May 24, 2024. It is now read-only.

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sdadn committed Apr 5, 2024
1 parent 094a9dc commit e86e543
Showing 1 changed file with 20 additions and 25 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -101,31 +101,31 @@ axis: {
## Properties Details

- ### `allowCalibration`
Set calibration for the axis.
If `true`, then the axis upper and lower limits will update to fit the entire graph on the x-axis.
This feature can _not_ be used in conjunction with panning.
If panning is enabled then this property will be ignored if it is `true`.
Set calibration for the axis.
If `true`, then the axis upper and lower limits will update to fit the entire graph on the x-axis.
This feature can _not_ be used in conjunction with panning.
If panning is enabled then this property will be ignored if it is `true`.

NOTE: This property is only implemented for the x-axis (`config.axis.x.allowCalibration`).
Refer to [`config.allowCalibration`](./graph-configuration-object/#allowcalibration) for calibrating the y-axes.
NOTE: This property is only implemented for the x-axis (`config.axis.x.allowCalibration`).
Refer to [`config.allowCalibration`](./graph-configuration-object/#allowcalibration) for calibrating the y-axes.

<AllowCalibrationXAxisDisabledExample/>
<AllowCalibrationXAxisEnabledExample/>
<AllowCalibrationXAxisDisabledExample/>
<AllowCalibrationXAxisEnabledExample/>


- ### `label`

Axis label value. Will not be rendered if nothing is provided.
Axis label value. Will not be rendered if nothing is provided.

- ### `orientation`

Sets the orientation for the x-axis.
Can be accessed through `AXES_ORIENTATION`.
Valid values are:
- `AXES_ORIENTATION.X.TOP`
- `AXES_ORIENTATION.X.BOTTOM`
Sets the orientation for the x-axis.
Can be accessed through `AXES_ORIENTATION`.
Valid values are:
- `AXES_ORIENTATION.X.TOP`
- `AXES_ORIENTATION.X.BOTTOM`

<XAxisOrientationTopExample/>
<XAxisOrientationTopExample/>


- ### `rangeRounding`
Expand All @@ -141,15 +141,12 @@ Axis label value. Will not be rendered if nothing is provided.


- ### `type`
Property to set the type of the axis.

| Constant | Value |
|-------------------------|----------------------------------------------------------------|
| `AXIS_TYPE.DEFAULT` | Numeric based x-axis. Will take a `<number>` for tick values. |
| `AXIS_TYPE.TIME_SERIES` | Timeseries based x-axis. Will take a `<Date>` for tick values. |


Property to set the type of the axis.

| Constant | Value |
|-------------------------|----------------------------------------------------------------|
| `AXIS_TYPE.DEFAULT` | Numeric based x-axis. Will take a `<number>` for tick values. |
| `AXIS_TYPE.TIME_SERIES` | Timeseries based x-axis. Will take a `<Date>` for tick values. |


#### Notes:
Expand Down Expand Up @@ -179,5 +176,3 @@ const datetime = padXAxisLimits(
])
);
```
import { jsx } from "react/jsx-runtime"

0 comments on commit e86e543

Please sign in to comment.