[charts] Add domainLimit to axis config
#15294
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| import * as React from 'react'; | ||
| import Box from '@mui/material/Box'; | ||
| import { BarChart } from '@mui/x-charts/BarChart'; | ||
| import TextField from '@mui/material/TextField'; | ||
| import MenuItem from '@mui/material/MenuItem'; | ||
|
|
||
| const settings = { | ||
| valueFormatter: (v) => `${v}%`, | ||
| height: 200, | ||
| showTooltip: true, | ||
| showHighlight: true, | ||
| series: [{ data: [60, -15, 66, 68, 87, 82, 83, 85, 92, 75, 76, 50, 91] }], | ||
| margin: { top: 10, bottom: 20 }, | ||
| }; | ||
|
|
||
| // Extend a value to match a multiple of the step. | ||
| function extend(value, step) { | ||
| if (value > 0) { | ||
| // If >0 go to the next step | ||
| return step * Math.ceil(value / step); | ||
| } | ||
| // If <0 go to the previous step | ||
| return step * Math.floor(value / step); | ||
| } | ||
|
|
||
| export default function CustomDomainYAxis() { | ||
| const [domainLimit, setDomainLimit] = React.useState('nice'); | ||
|
|
||
| return ( | ||
| <Box sx={{ width: '100%' }}> | ||
| <TextField | ||
| select | ||
| value={domainLimit} | ||
| onChange={(event) => setDomainLimit(event.target.value)} | ||
| label="domain limit" | ||
| sx={{ minWidth: 150, mb: 2 }} | ||
| > | ||
| <MenuItem value="nice">nice</MenuItem> | ||
| <MenuItem value="strict">strict</MenuItem> | ||
| <MenuItem value="function">function</MenuItem> | ||
| </TextField> | ||
|
|
||
| <BarChart | ||
| yAxis={[ | ||
| { | ||
| domainLimit: | ||
| domainLimit === 'function' | ||
| ? (min, max) => ({ | ||
| min: extend(min, 10), | ||
| max: extend(max, 10), | ||
| }) | ||
| : domainLimit, | ||
| }, | ||
| ]} | ||
| {...settings} | ||
| /> | ||
| </Box> | ||
| ); | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| import * as React from 'react'; | ||
| import Box from '@mui/material/Box'; | ||
| import { BarChart } from '@mui/x-charts/BarChart'; | ||
| import TextField from '@mui/material/TextField'; | ||
| import MenuItem from '@mui/material/MenuItem'; | ||
|
|
||
| const settings = { | ||
| valueFormatter: (v: number | null) => `${v}%`, | ||
| height: 200, | ||
| showTooltip: true, | ||
| showHighlight: true, | ||
| series: [{ data: [60, -15, 66, 68, 87, 82, 83, 85, 92, 75, 76, 50, 91] }], | ||
| margin: { top: 10, bottom: 20 }, | ||
| }; | ||
|
|
||
| // Extend a value to match a multiple of the step. | ||
| function extend(value: number, step: number) { | ||
| if (value > 0) { | ||
| // If >0 go to the next step | ||
| return step * Math.ceil(value / step); | ||
| } | ||
| // If <0 go to the previous step | ||
| return step * Math.floor(value / step); | ||
| } | ||
|
|
||
| export default function CustomDomainYAxis() { | ||
| const [domainLimit, setDomainLimit] = React.useState< | ||
| 'nice' | 'strict' | 'function' | ||
| >('nice'); | ||
|
|
||
| return ( | ||
| <Box sx={{ width: '100%' }}> | ||
| <TextField | ||
| select | ||
| value={domainLimit} | ||
| onChange={(event) => | ||
| setDomainLimit(event.target.value as 'nice' | 'strict' | 'function') | ||
| } | ||
| label="domain limit" | ||
| sx={{ minWidth: 150, mb: 2 }} | ||
| > | ||
| <MenuItem value="nice">nice</MenuItem> | ||
| <MenuItem value="strict">strict</MenuItem> | ||
| <MenuItem value="function">function</MenuItem> | ||
| </TextField> | ||
|
|
||
|
|
||
| <BarChart | ||
| yAxis={[ | ||
| { | ||
| domainLimit: | ||
| domainLimit === 'function' | ||
| ? (min, max) => ({ | ||
| min: extend(min, 10), | ||
| max: extend(max, 10), | ||
| }) | ||
| : domainLimit, | ||
| }, | ||
| ]} | ||
| {...settings} | ||
| /> | ||
| </Box> | ||
| ); | ||
| } | ||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| import * as React from 'react'; | ||
| import TextField from '@mui/material/TextField'; | ||
| import MenuItem from '@mui/material/MenuItem'; | ||
| import Stack from '@mui/material/Stack'; | ||
| import Box from '@mui/material/Box'; | ||
| import Typography from '@mui/material/Typography'; | ||
|
|
||
| import { SparkLineChart } from '@mui/x-charts/SparkLineChart'; | ||
|
|
||
| const settings = { | ||
| valueFormatter: (v) => `${v}%`, | ||
| height: 100, | ||
| showTooltip: true, | ||
| showHighlight: true, | ||
| data: [60, -15, 66, 68, 87, 82, 83, 85, 92, 75, 76, 50, 91], | ||
| margin: { top: 10, bottom: 20, left: 5, right: 5 }, | ||
| sx: (theme) => ({ | ||
| borderWidth: 1, | ||
| borderStyle: 'solid', | ||
| borderColor: theme.palette.divider, | ||
| }), | ||
| }; | ||
|
|
||
| // Extend a value to match a multiple of the step. | ||
| function extend(value, step) { | ||
| if (value > 0) { | ||
| // If >0 go to the next step | ||
| return step * Math.ceil(value / step); | ||
| } | ||
| // If <0 go to the previous step | ||
| return step * Math.floor(value / step); | ||
| } | ||
|
|
||
| const yRange = { | ||
| nice: '-100, 100', | ||
| strict: '-15, 92', | ||
| function: '-20, 100', | ||
| }; | ||
| export default function CustomDomainYAxis() { | ||
| const [domainLimitKey, setDomainLimitKey] = React.useState('nice'); | ||
|
|
||
| const domainLimit = | ||
| domainLimitKey === 'function' | ||
| ? (min, max) => ({ | ||
| min: extend(min, 10), | ||
| max: extend(max, 10), | ||
| }) | ||
| : domainLimitKey; | ||
| return ( | ||
| <Box | ||
| sx={{ | ||
| width: '100%', | ||
| }} | ||
| > | ||
| <Stack direction="row" alignItems="baseline" justifyContent="space-between"> | ||
| <TextField | ||
| select | ||
| value={domainLimitKey} | ||
| onChange={(event) => setDomainLimitKey(event.target.value)} | ||
| label="domain limit" | ||
| sx={{ minWidth: 150, mb: 2 }} | ||
| > | ||
| <MenuItem value="nice">nice</MenuItem> | ||
| <MenuItem value="strict">strict</MenuItem> | ||
| <MenuItem value="function">function</MenuItem> | ||
| </TextField> | ||
| <Typography>y-axis range: {yRange[domainLimitKey]}</Typography> | ||
| </Stack> | ||
|
|
||
| <Stack | ||
| sx={{ | ||
| width: '100%', | ||
| }} | ||
| direction="row" | ||
| spacing={2} | ||
| > | ||
| <Box sx={{ flexGrow: 1 }}> | ||
| <SparkLineChart {...settings} yAxis={{ domainLimit }} /> | ||
| </Box> | ||
| <Box sx={{ flexGrow: 1 }}> | ||
| <SparkLineChart plotType="bar" {...settings} yAxis={{ domainLimit }} /> | ||
| </Box> | ||
| </Stack> | ||
| </Box> | ||
| ); | ||
| } |
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
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,90 @@ | ||||||||||
| import * as React from 'react'; | ||||||||||
| import TextField from '@mui/material/TextField'; | ||||||||||
| import MenuItem from '@mui/material/MenuItem'; | ||||||||||
| import Stack from '@mui/material/Stack'; | ||||||||||
| import Box from '@mui/material/Box'; | ||||||||||
| import Typography from '@mui/material/Typography'; | ||||||||||
| import { Theme } from '@mui/material/styles'; | ||||||||||
| import { SparkLineChart } from '@mui/x-charts/SparkLineChart'; | ||||||||||
|
Comment on lines
+7
to
+8
There was a problem hiding this comment. To avoid the blank line in the JavaScript generated demo?
Suggested change
|
||||||||||
|
|
||||||||||
| const settings = { | ||||||||||
| valueFormatter: (v: number | null) => `${v}%`, | ||||||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||||||
| height: 100, | ||||||||||
| showTooltip: true, | ||||||||||
| showHighlight: true, | ||||||||||
| data: [60, -15, 66, 68, 87, 82, 83, 85, 92, 75, 76, 50, 91], | ||||||||||
| margin: { top: 10, bottom: 20, left: 5, right: 5 }, | ||||||||||
| sx: (theme: Theme) => ({ | ||||||||||
| borderWidth: 1, | ||||||||||
| borderStyle: 'solid', | ||||||||||
| borderColor: theme.palette.divider, | ||||||||||
| }), | ||||||||||
| }; | ||||||||||
|
|
||||||||||
| // Extend a value to match a multiple of the step. | ||||||||||
| function extend(value: number, step: number) { | ||||||||||
| if (value > 0) { | ||||||||||
| // If >0 go to the next step | ||||||||||
| return step * Math.ceil(value / step); | ||||||||||
| } | ||||||||||
| // If <0 go to the previous step | ||||||||||
| return step * Math.floor(value / step); | ||||||||||
| } | ||||||||||
|
|
||||||||||
| const yRange = { | ||||||||||
| nice: '-100, 100', | ||||||||||
| strict: '-15, 92', | ||||||||||
| function: '-20, 100', | ||||||||||
| }; | ||||||||||
| export default function CustomDomainYAxis() { | ||||||||||
| const [domainLimitKey, setDomainLimitKey] = React.useState< | ||||||||||
| 'nice' | 'strict' | 'function' | ||||||||||
| >('nice'); | ||||||||||
|
|
||||||||||
| const domainLimit = | ||||||||||
| domainLimitKey === 'function' | ||||||||||
| ? (min: number, max: number) => ({ | ||||||||||
| min: extend(min, 10), | ||||||||||
| max: extend(max, 10), | ||||||||||
| }) | ||||||||||
| : domainLimitKey; | ||||||||||
| return ( | ||||||||||
| <Box | ||||||||||
| sx={{ | ||||||||||
| width: '100%', | ||||||||||
| }} | ||||||||||
| > | ||||||||||
| <Stack direction="row" alignItems="baseline" justifyContent="space-between"> | ||||||||||
| <TextField | ||||||||||
| select | ||||||||||
| value={domainLimitKey} | ||||||||||
| onChange={(event) => | ||||||||||
| setDomainLimitKey(event.target.value as 'nice' | 'strict' | 'function') | ||||||||||
| } | ||||||||||
| label="domain limit" | ||||||||||
| sx={{ minWidth: 150, mb: 2 }} | ||||||||||
| > | ||||||||||
| <MenuItem value="nice">nice</MenuItem> | ||||||||||
| <MenuItem value="strict">strict</MenuItem> | ||||||||||
| <MenuItem value="function">function</MenuItem> | ||||||||||
| </TextField> | ||||||||||
| <Typography>y-axis range: {yRange[domainLimitKey]}</Typography> | ||||||||||
| </Stack> | ||||||||||
|
|
||||||||||
|
|
||||||||||
| <Stack | ||||||||||
| sx={{ | ||||||||||
| width: '100%', | ||||||||||
| }} | ||||||||||
| direction="row" | ||||||||||
| spacing={2} | ||||||||||
| > | ||||||||||
| <Box sx={{ flexGrow: 1 }}> | ||||||||||
| <SparkLineChart {...settings} yAxis={{ domainLimit }} /> | ||||||||||
| </Box> | ||||||||||
| <Box sx={{ flexGrow: 1 }}> | ||||||||||
| <SparkLineChart plotType="bar" {...settings} yAxis={{ domainLimit }} /> | ||||||||||
| </Box> | ||||||||||
| </Stack> | ||||||||||
| </Box> | ||||||||||
| ); | ||||||||||
| } | ||||||||||
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -58,3 +58,11 @@ The following demo shows two sparklines, one with small and another with large v | |||||
| The first row has the default y-axis values, while on the second row a fixed range from `0` to `100` has been set. | ||||||
|
|
||||||
| {{"demo": "CustomYAxis.js"}} | ||||||
|
|
||||||
| You can adjust the y-axis range of a sparkline relatively to its data by using the `domainLimit` option in the `yAxis` configuration. | ||||||
| See the [axis docs page](http://localhost:3001/x/react-charts/axis/#relative-axis-sub-domain) form more information. | ||||||
|
There was a problem hiding this comment. Broken link and typo
Suggested change
|
||||||
|
|
||||||
| The demo below shows different ways to set the y-axis range. | ||||||
| They always display the same data, going from -15 to 92, but with different `domainLimit` settings. | ||||||
|
|
||||||
| {{"demo": "CustomDomainYAxis.js"}} | ||||||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,6 +9,11 @@ | |
| }, | ||
| "data": { "type": { "description": "V[]" } }, | ||
| "dataKey": { "type": { "description": "string" } }, | ||
| "domainLimit": { | ||
| "type": { | ||
| "description": "'nice' | 'strict' | ((min: number, max: number) => { min: number; max: number })" | ||
| } | ||
| }, | ||
| "hideTooltip": { "type": { "description": "boolean" } }, | ||
| "max": { "type": { "description": "number | Date" } }, | ||
| "min": { "type": { "description": "number | Date" } }, | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -108,13 +108,13 @@ | |
| "xAxis": { | ||
| "type": { | ||
| "name": "arrayOf", | ||
| "description": "Array<{ classes?: object, colorMap?: { colors: Array<string>, type: 'ordinal', unknownColor?: string, values?: Array<Date<br>| number<br>| string> }<br>| { color: Array<string><br>| func, max?: Date<br>| number, min?: Date<br>| number, type: 'continuous' }<br>| { colors: Array<string>, thresholds: Array<Date<br>| number>, type: 'piecewise' }, data?: array, dataKey?: string, disableLine?: bool, disableTicks?: bool, domainLimit?: 'nice'<br>| 'strict'<br>| func, fill?: string, hideTooltip?: bool, id?: number<br>| string, label?: string, labelFontSize?: number, labelStyle?: object, max?: Date<br>| number, min?: Date<br>| number, position?: 'bottom'<br>| 'top', reverse?: bool, scaleType?: 'band'<br>| 'linear'<br>| 'log'<br>| 'point'<br>| 'pow'<br>| 'sqrt'<br>| 'time'<br>| 'utc', slotProps?: object, slots?: object, stroke?: string, sx?: Array<func<br>| object<br>| bool><br>| func<br>| object, tickFontSize?: number, tickInterval?: 'auto'<br>| array<br>| func, tickLabelInterval?: 'auto'<br>| func, tickLabelPlacement?: 'middle'<br>| 'tick', tickLabelStyle?: object, tickMaxStep?: number, tickMinStep?: number, tickNumber?: number, tickPlacement?: 'end'<br>| 'extremities'<br>| 'middle'<br>| 'start', tickSize?: number, valueFormatter?: func, zoom?: { filterMode?: 'discard'<br>| 'keep', maxEnd?: number, maxSpan?: number, minSpan?: number, minStart?: number, panning?: bool, step?: number }<br>| bool }>" | ||
| } | ||
| }, | ||
| "yAxis": { | ||
| "type": { | ||
| "name": "arrayOf", | ||
| "description": "Array<{ classes?: object, colorMap?: { colors: Array<string>, type: 'ordinal', unknownColor?: string, values?: Array<Date<br>| number<br>| string> }<br>| { color: Array<string><br>| func, max?: Date<br>| number, min?: Date<br>| number, type: 'continuous' }<br>| { colors: Array<string>, thresholds: Array<Date<br>| number>, type: 'piecewise' }, data?: array, dataKey?: string, disableLine?: bool, disableTicks?: bool, domainLimit?: 'nice'<br>| 'strict'<br>| func, fill?: string, hideTooltip?: bool, id?: number<br>| string, label?: string, labelFontSize?: number, labelStyle?: object, max?: Date<br>| number, min?: Date<br>| number, position?: 'left'<br>| 'right', reverse?: bool, scaleType?: 'band'<br>| 'linear'<br>| 'log'<br>| 'point'<br>| 'pow'<br>| 'sqrt'<br>| 'time'<br>| 'utc', slotProps?: object, slots?: object, stroke?: string, sx?: Array<func<br>| object<br>| bool><br>| func<br>| object, tickFontSize?: number, tickInterval?: 'auto'<br>| array<br>| func, tickLabelInterval?: 'auto'<br>| func, tickLabelPlacement?: 'middle'<br>| 'tick', tickLabelStyle?: object, tickMaxStep?: number, tickMinStep?: number, tickNumber?: number, tickPlacement?: 'end'<br>| 'extremities'<br>| 'middle'<br>| 'start', tickSize?: number, valueFormatter?: func, zoom?: { filterMode?: 'discard'<br>| 'keep', maxEnd?: number, maxSpan?: number, minSpan?: number, minStart?: number, panning?: bool, step?: number }<br>| bool }>" | ||
| } | ||
| }, | ||
| "zoom": { | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.