-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b631eb9
commit 821beba
Showing
10 changed files
with
465 additions
and
1 deletion.
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
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,23 @@ | ||
| import * as React from 'react'; | ||
| import ApiPage from 'docs/src/modules/components/ApiPage'; | ||
| import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; | ||
| import jsonPageContent from './gauge-container.json'; | ||
|
|
||
| export default function Page(props) { | ||
| const { descriptions, pageContent } = props; | ||
| return <ApiPage descriptions={descriptions} pageContent={pageContent} />; | ||
| } | ||
|
|
||
| Page.getInitialProps = () => { | ||
| const req = require.context( | ||
| 'docsx/translations/api-docs/charts/gauge-container', | ||
| false, | ||
| /\.\/gauge-container.*.json$/, | ||
| ); | ||
| const descriptions = mapApiPageTranslations(req); | ||
|
|
||
| return { | ||
| descriptions, | ||
| pageContent: jsonPageContent, | ||
| }; | ||
| }; |
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,41 @@ | ||
| { | ||
| "props": { | ||
| "cornerRadius": { "type": { "name": "number" }, "default": "'50%'" }, | ||
| "cx": { "type": { "name": "union", "description": "number<br>| string" } }, | ||
| "cy": { "type": { "name": "union", "description": "number<br>| string" } }, | ||
| "disableAxisListener": { "type": { "name": "bool" }, "default": "false" }, | ||
| "endAngle": { "type": { "name": "number" }, "default": "360" }, | ||
| "height": { "type": { "name": "number" }, "default": "undefined" }, | ||
| "innerRadius": { | ||
| "type": { "name": "union", "description": "number<br>| string" }, | ||
| "default": "'80%'" | ||
| }, | ||
| "margin": { | ||
| "type": { | ||
| "name": "shape", | ||
| "description": "{ bottom?: number, left?: number, right?: number, top?: number }" | ||
| }, | ||
| "default": "object Depends on the charts type." | ||
| }, | ||
| "outerRadius": { | ||
| "type": { "name": "union", "description": "number<br>| string" }, | ||
| "default": "'100%'" | ||
| }, | ||
| "startAngle": { "type": { "name": "number" }, "default": "0" }, | ||
| "value": { "type": { "name": "number" } }, | ||
| "valueMax": { "type": { "name": "number" }, "default": "100" }, | ||
| "valueMin": { "type": { "name": "number" }, "default": "0" }, | ||
| "width": { "type": { "name": "number" }, "default": "undefined" } | ||
| }, | ||
| "name": "GaugeContainer", | ||
| "imports": [ | ||
| "import { GaugeContainer } from '@mui/x-charts/Gauge';", | ||
| "import { GaugeContainer } from '@mui/x-charts';" | ||
| ], | ||
| "classes": [], | ||
| "muiName": "MuiGaugeContainer", | ||
| "filename": "/packages/x-charts/src/Gauge/GaugeContainer.tsx", | ||
| "inheritance": null, | ||
| "demos": "<ul><li><a href=\"/x/react-charts/gauge/\">Charts - Gauge</a></li></ul>", | ||
| "cssComponent": false | ||
| } |
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,23 @@ | ||
| import * as React from 'react'; | ||
| import ApiPage from 'docs/src/modules/components/ApiPage'; | ||
| import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; | ||
| import jsonPageContent from './gauge.json'; | ||
|
|
||
| export default function Page(props) { | ||
| const { descriptions, pageContent } = props; | ||
| return <ApiPage descriptions={descriptions} pageContent={pageContent} />; | ||
| } | ||
|
|
||
| Page.getInitialProps = () => { | ||
| const req = require.context( | ||
| 'docsx/translations/api-docs/charts/gauge', | ||
| false, | ||
| /\.\/gauge.*.json$/, | ||
| ); | ||
| const descriptions = mapApiPageTranslations(req); | ||
|
|
||
| return { | ||
| descriptions, | ||
| pageContent: jsonPageContent, | ||
| }; | ||
| }; |
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,60 @@ | ||
| { | ||
| "props": { | ||
| "cornerRadius": { "type": { "name": "number" }, "default": "'50%'" }, | ||
| "cx": { "type": { "name": "union", "description": "number<br>| string" } }, | ||
| "cy": { "type": { "name": "union", "description": "number<br>| string" } }, | ||
| "disableAxisListener": { "type": { "name": "bool" }, "default": "false" }, | ||
| "endAngle": { "type": { "name": "number" }, "default": "360" }, | ||
| "height": { "type": { "name": "number" }, "default": "undefined" }, | ||
| "innerRadius": { | ||
| "type": { "name": "union", "description": "number<br>| string" }, | ||
| "default": "'80%'" | ||
| }, | ||
| "margin": { | ||
| "type": { | ||
| "name": "shape", | ||
| "description": "{ bottom?: number, left?: number, right?: number, top?: number }" | ||
| }, | ||
| "default": "object Depends on the charts type." | ||
| }, | ||
| "outerRadius": { | ||
| "type": { "name": "union", "description": "number<br>| string" }, | ||
| "default": "'100%'" | ||
| }, | ||
| "startAngle": { "type": { "name": "number" }, "default": "0" }, | ||
| "value": { "type": { "name": "number" } }, | ||
| "valueMax": { "type": { "name": "number" }, "default": "100" }, | ||
| "valueMin": { "type": { "name": "number" }, "default": "0" }, | ||
| "width": { "type": { "name": "number" }, "default": "undefined" } | ||
| }, | ||
| "name": "Gauge", | ||
| "imports": [ | ||
| "import { Gauge } from '@mui/x-charts/Gauge';", | ||
| "import { Gauge } from '@mui/x-charts';" | ||
| ], | ||
| "classes": [ | ||
| { | ||
| "key": "referenceArc", | ||
| "className": "MuiGauge-referenceArc", | ||
| "description": "Styles applied to the arc diplaying the range of available values.", | ||
| "isGlobal": false | ||
| }, | ||
| { | ||
| "key": "root", | ||
| "className": "MuiGauge-root", | ||
| "description": "Styles applied to the root element.", | ||
| "isGlobal": false | ||
| }, | ||
| { | ||
| "key": "valueArc", | ||
| "className": "MuiGauge-valueArc", | ||
| "description": "Styles applied to the arc diplaying the value.", | ||
| "isGlobal": false | ||
| } | ||
| ], | ||
| "muiName": "MuiGauge", | ||
| "filename": "/packages/x-charts/src/Gauge/Gauge.tsx", | ||
| "inheritance": null, | ||
| "demos": "<ul><li><a href=\"/x/react-charts/gauge/\">Charts - Gauge</a></li></ul>", | ||
| "cssComponent": false | ||
| } |
40 changes: 40 additions & 0 deletions
40
docs/translations/api-docs/charts/gauge-container/gauge-container.json
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,40 @@ | ||
| { | ||
| "componentDescription": "", | ||
| "propDescriptions": { | ||
| "cornerRadius": { | ||
| "description": "The radius applied to arc corners (similar to border radius)." | ||
| }, | ||
| "cx": { | ||
| "description": "The x coordinate of the pie center. Can be a number (in px) or a string with a percentage such as '50%'. The '100%' is the width the drawing area." | ||
| }, | ||
| "cy": { | ||
| "description": "The y coordinate of the pie center. Can be a number (in px) or a string with a percentage such as '50%'. The '100%' is the height the drawing area." | ||
| }, | ||
| "disableAxisListener": { | ||
| "description": "If <code>true</code>, the charts will not listen to the mouse move event. It might break interactive features, but will improve performance." | ||
| }, | ||
| "endAngle": { "description": "The end angle (deg)." }, | ||
| "height": { | ||
| "description": "The height of the chart in px. If not defined, it takes the height of the parent element." | ||
| }, | ||
| "innerRadius": { | ||
| "description": "The radius between circle center and the begining of the arc. Can be a number (in px) or a string with a percentage such as '50%'. The '100%' is the maximal radius that fit into the drawing area." | ||
| }, | ||
| "margin": { | ||
| "description": "The margin between the SVG and the drawing area. It's used for leaving some space for extra information such as the x- and y-axis or legend. Accepts an object with the optional properties: <code>top</code>, <code>bottom</code>, <code>left</code>, and <code>right</code>." | ||
| }, | ||
| "outerRadius": { | ||
| "description": "The radius between circle center and the end of the arc. Can be a number (in px) or a string with a percentage such as '50%'. The '100%' is the maximal radius that fit into the drawing area." | ||
| }, | ||
| "startAngle": { "description": "The start angle (deg)." }, | ||
| "value": { | ||
| "description": "The value of the gauge. Set to <code>null</code> if no value to display." | ||
| }, | ||
| "valueMax": { "description": "The maximal value of the gauge." }, | ||
| "valueMin": { "description": "The minimal value of the gauge." }, | ||
| "width": { | ||
| "description": "The width of the chart in px. If not defined, it takes the width of the parent element." | ||
| } | ||
| }, | ||
| "classDescriptions": {} | ||
| } |
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,50 @@ | ||
| { | ||
| "componentDescription": "", | ||
| "propDescriptions": { | ||
| "cornerRadius": { | ||
| "description": "The radius applied to arc corners (similar to border radius)." | ||
| }, | ||
| "cx": { | ||
| "description": "The x coordinate of the pie center. Can be a number (in px) or a string with a percentage such as '50%'. The '100%' is the width the drawing area." | ||
| }, | ||
| "cy": { | ||
| "description": "The y coordinate of the pie center. Can be a number (in px) or a string with a percentage such as '50%'. The '100%' is the height the drawing area." | ||
| }, | ||
| "disableAxisListener": { | ||
| "description": "If <code>true</code>, the charts will not listen to the mouse move event. It might break interactive features, but will improve performance." | ||
| }, | ||
| "endAngle": { "description": "The end angle (deg)." }, | ||
| "height": { | ||
| "description": "The height of the chart in px. If not defined, it takes the height of the parent element." | ||
| }, | ||
| "innerRadius": { | ||
| "description": "The radius between circle center and the begining of the arc. Can be a number (in px) or a string with a percentage such as '50%'. The '100%' is the maximal radius that fit into the drawing area." | ||
| }, | ||
| "margin": { | ||
| "description": "The margin between the SVG and the drawing area. It's used for leaving some space for extra information such as the x- and y-axis or legend. Accepts an object with the optional properties: <code>top</code>, <code>bottom</code>, <code>left</code>, and <code>right</code>." | ||
| }, | ||
| "outerRadius": { | ||
| "description": "The radius between circle center and the end of the arc. Can be a number (in px) or a string with a percentage such as '50%'. The '100%' is the maximal radius that fit into the drawing area." | ||
| }, | ||
| "startAngle": { "description": "The start angle (deg)." }, | ||
| "value": { | ||
| "description": "The value of the gauge. Set to <code>null</code> if no value to display." | ||
| }, | ||
| "valueMax": { "description": "The maximal value of the gauge." }, | ||
| "valueMin": { "description": "The minimal value of the gauge." }, | ||
| "width": { | ||
| "description": "The width of the chart in px. If not defined, it takes the width of the parent element." | ||
| } | ||
| }, | ||
| "classDescriptions": { | ||
| "referenceArc": { | ||
| "description": "Styles applied to {{nodeName}}.", | ||
| "nodeName": "the arc diplaying the range of available values" | ||
| }, | ||
| "root": { "description": "Styles applied to the root element." }, | ||
| "valueArc": { | ||
| "description": "Styles applied to {{nodeName}}.", | ||
| "nodeName": "the arc diplaying the value" | ||
| } | ||
| } | ||
| } |
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
Oops, something went wrong.