Improve docs radial linear grid #10518
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
LeeLenaleee
commented
Jul 25, 2022
Comment on lines
+21
to
+39
| ### Common options to all axes | ||
|
|
||
| Namespace: `options.scales[scaleId]` | ||
|
|
||
| | Name | Type | Default | Description | ||
| | ---- | ---- | ------- | ----------- | ||
| | `type` | `string` | | Type of scale being employed. Custom scales can be created and registered with a string key. This allows changing the type of an axis for a chart. | ||
| | `alignToPixels` | `boolean` | `false` | Align pixel values to device pixels. | ||
| | `backgroundColor` | [`Color`](/general/colors.md) | | Background color of the scale area. | ||
| | `display` | `boolean`\|`string` | `true` | Controls the axis global visibility (visible when `true`, hidden when `false`). When `display: 'auto'`, the axis is visible only if at least one associated dataset is visible. | ||
| | `grid` | `object` | | Grid line configuration. [more...](#grid-line-configuration) | ||
| | `min` | `number` | | User defined minimum number for the scale, overrides minimum value from data. [more...](/axes/index.md#axis-range-settings) | ||
| | `max` | `number` | | User defined maximum number for the scale, overrides maximum value from data. [more...](/axes/index.md#axis-range-settings) | ||
| | `reverse` | `boolean` | `false` | Reverse the scale. | ||
| | `stacked` | `boolean`\|`string` | `false` | Should the data be stacked. [more...](/axes/index.md#stacking) | ||
| | `suggestedMax` | `number` | | Adjustment used when calculating the maximum data value. [more...](/axes/index.md#axis-range-settings) | ||
| | `suggestedMin` | `number` | | Adjustment used when calculating the minimum data value. [more...](/axes/index.md#axis-range-settings) | ||
| | `ticks` | `object` | | Tick configuration. [more...](/axes/index.md#tick-configuration) | ||
| | `weight` | `number` | `0` | The weight used to sort the axis. Higher weights are further away from the chart area. |
There was a problem hiding this comment.
Moved from the common file to here so the link the the grid styling can be correct
kurkle
reviewed
Jul 25, 2022
etimberg
approved these changes
Jul 27, 2022
kurkle
approved these changes
Jul 27, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #10407