Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add notes about more specific options for axes #9923

Merged
merged 1 commit into from
Nov 30, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions docs/axes/cartesian/index.md
Original file line number Diff line number Diff line change
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
Original file line number Diff line number Diff line change
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