Skip to content

Commit

Permalink
Add notes about more specific options for axes (#9923)
Browse files Browse the repository at this point in the history
  • Loading branch information
kurkle committed Nov 30, 2021
1 parent f10fab6 commit 42e8594
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 2 deletions.
13 changes: 11 additions & 2 deletions docs/axes/cartesian/index.md
Expand Up @@ -192,6 +192,10 @@ module.exports = {

## Common Configuration

:::tip Note
These are only the common options supported by all cartesian axes. Please see the specific axis documentation for all the available options for that axis.
:::

!!!include(axes/cartesian/_common.md)!!!

!!!include(axes/_common.md)!!!
Expand Down Expand Up @@ -221,6 +225,10 @@ The `bounds` property controls the scale boundary strategy (bypassed by `min`/`m

### Tick Configuration

:::tip Note
These are only the common tick options supported by all cartesian axes. Please see specific axis documentation for all of the available options for that axis.
:::

!!!include(axes/cartesian/_common_ticks.md)!!!

!!!include(axes/_common_ticks.md)!!!
Expand Down Expand Up @@ -285,8 +293,9 @@ module.exports = {

:::tip Note
The `crossAlign` setting is only effective when these preconditions are met:
* tick rotation is `0`
* axis position is `'top'`, '`left'`, `'bottom'` or `'right'`

* tick rotation is `0`
* axis position is `'top'`, '`left'`, `'bottom'` or `'right'`
:::

### Axis ID
Expand Down
8 changes: 8 additions & 0 deletions docs/axes/index.md
Expand Up @@ -93,10 +93,18 @@ let chart = new Chart(ctx, {

## Common Configuration

:::tip Note
These are only the common options supported by all axes. Please see specific axis documentation for all of the available options for that axis.
:::

!!!include(axes/_common.md)!!!

## Tick Configuration

:::tip Note
These are only the common tick options supported by all axes. Please see specific axis documentation for all of the available tick options for that axis.
:::

!!!include(axes/_common_ticks.md)!!!

## Axis Range Settings
Expand Down

0 comments on commit 42e8594

Please sign in to comment.