reaviz
Version:
Data Visualization using React
1,736 lines • 1.37 MB
JSON
[
{
"tags": {},
"filePath": "src/AreaChart/AreaChart.tsx",
"description": "",
"displayName": "AreaChart",
"methods": [],
"props": {
"data": {
"defaultValue": null,
"description": "Data the chart will receive to render.",
"name": "data",
"parent": {
"fileName": "src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
},
"declarations": [
{
"fileName": "src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
}
],
"required": false,
"type": {
"name": "ChartDataShape[]"
}
},
"series": {
"defaultValue": null,
"description": "The series component that renders the area/line/circles components.",
"name": "series",
"parent": {
"fileName": "src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
},
"declarations": [
{
"fileName": "src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
}
],
"required": false,
"type": {
"name": "ReactElement<AreaSeriesProps, FC<Partial<AreaSeriesProps>>>"
}
},
"yAxis": {
"defaultValue": null,
"description": "The linear axis component for the Y Axis of the chart.",
"name": "yAxis",
"parent": {
"fileName": "src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
},
"declarations": [
{
"fileName": "src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
}
],
"required": false,
"type": {
"name": "ReactElement<LinearAxisProps, FC<Partial<LinearAxisProps>>>"
}
},
"xAxis": {
"defaultValue": null,
"description": "The linear axis component for the X Axis of the chart.",
"name": "xAxis",
"parent": {
"fileName": "src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
},
"declarations": [
{
"fileName": "src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
}
],
"required": false,
"type": {
"name": "ReactElement<LinearAxisProps, FC<Partial<LinearAxisProps>>>"
}
},
"gridlines": {
"defaultValue": null,
"description": "The chart's background gridlines component.",
"name": "gridlines",
"parent": {
"fileName": "src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
},
"declarations": [
{
"fileName": "src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
}
],
"required": false,
"type": {
"name": "ReactElement<GridlineSeriesProps, FC<Partial<GridlineSeriesProps>>>"
}
},
"brush": {
"defaultValue": null,
"description": "The chart's brush component.",
"name": "brush",
"parent": {
"fileName": "src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
},
"declarations": [
{
"fileName": "src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
}
],
"required": false,
"type": {
"name": "ReactElement<ChartBrushProps, FC<Partial<ChartBrushProps>>>"
}
},
"zoomPan": {
"defaultValue": null,
"description": "The chart's zoom pan component.",
"name": "zoomPan",
"parent": {
"fileName": "src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
},
"declarations": [
{
"fileName": "src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
}
],
"required": false,
"type": {
"name": "ReactElement<ChartZoomPanProps, FC<Partial<ChartZoomPanProps>>>"
}
},
"secondaryAxis": {
"defaultValue": null,
"description": "Any secondary axis components. Useful for multi-axis charts.",
"name": "secondaryAxis",
"parent": {
"fileName": "src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
},
"declarations": [
{
"fileName": "src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
}
],
"required": false,
"type": {
"name": "ReactElement<LinearAxisProps, FC<Partial<LinearAxisProps>>>[]"
}
},
"id": {
"defaultValue": null,
"description": "Id of the chart.",
"name": "id",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "string"
}
},
"width": {
"defaultValue": null,
"description": "Width of the chart. If not provided will autosize.",
"name": "width",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "number"
}
},
"height": {
"defaultValue": null,
"description": "Height of the chart. If not provided will autosize.",
"name": "height",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "number"
}
},
"margins": {
"defaultValue": null,
"description": "Margins for the chart.",
"name": "margins",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "Margins"
}
},
"className": {
"defaultValue": null,
"description": "Classnames for the chart.",
"name": "className",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "string"
}
},
"containerClassName": {
"defaultValue": null,
"description": "Classnames for the chart.",
"name": "containerClassName",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "string"
}
},
"style": {
"defaultValue": null,
"description": "Additional css styles.",
"name": "style",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "StyleHTMLAttributes<SVGSVGElement>"
}
},
"center": {
"defaultValue": null,
"description": "Center the chart. Used mainly internally.",
"name": "center",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "boolean"
}
},
"centerX": {
"defaultValue": null,
"description": "Center chart on X Axis only. Used mainly internally.",
"name": "centerX",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "boolean"
}
},
"centerY": {
"defaultValue": null,
"description": "Center chart on Y Axis only. Used mainly internally.",
"name": "centerY",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "boolean"
}
}
}
},
{
"tags": {},
"filePath": "src/AreaChart/StackedAreaChart.tsx",
"description": "",
"displayName": "StackedAreaChart",
"methods": [],
"props": {
"data": {
"defaultValue": null,
"description": "Data the chart will receive to render.",
"name": "data",
"parent": {
"fileName": "src/AreaChart/StackedAreaChart.tsx",
"name": "StackedAreaChartProps"
},
"declarations": [
{
"fileName": "src/AreaChart/StackedAreaChart.tsx",
"name": "StackedAreaChartProps"
}
],
"required": false,
"type": {
"name": "ChartNestedDataShape[]"
}
},
"series": {
"defaultValue": null,
"description": "The series component that renders the area/line/circles components.",
"name": "series",
"parent": {
"fileName": "reaviz/src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
}
],
"required": false,
"type": {
"name": "ReactElement<AreaSeriesProps, FC<Partial<AreaSeriesProps>>>"
}
},
"yAxis": {
"defaultValue": null,
"description": "The linear axis component for the Y Axis of the chart.",
"name": "yAxis",
"parent": {
"fileName": "reaviz/src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
}
],
"required": false,
"type": {
"name": "ReactElement<LinearAxisProps, FC<Partial<LinearAxisProps>>>"
}
},
"xAxis": {
"defaultValue": null,
"description": "The linear axis component for the X Axis of the chart.",
"name": "xAxis",
"parent": {
"fileName": "reaviz/src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
}
],
"required": false,
"type": {
"name": "ReactElement<LinearAxisProps, FC<Partial<LinearAxisProps>>>"
}
},
"gridlines": {
"defaultValue": null,
"description": "The chart's background gridlines component.",
"name": "gridlines",
"parent": {
"fileName": "reaviz/src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
}
],
"required": false,
"type": {
"name": "ReactElement<GridlineSeriesProps, FC<Partial<GridlineSeriesProps>>>"
}
},
"brush": {
"defaultValue": null,
"description": "The chart's brush component.",
"name": "brush",
"parent": {
"fileName": "reaviz/src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
}
],
"required": false,
"type": {
"name": "ReactElement<ChartBrushProps, FC<Partial<ChartBrushProps>>>"
}
},
"zoomPan": {
"defaultValue": null,
"description": "The chart's zoom pan component.",
"name": "zoomPan",
"parent": {
"fileName": "reaviz/src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
}
],
"required": false,
"type": {
"name": "ReactElement<ChartZoomPanProps, FC<Partial<ChartZoomPanProps>>>"
}
},
"secondaryAxis": {
"defaultValue": null,
"description": "Any secondary axis components. Useful for multi-axis charts.",
"name": "secondaryAxis",
"parent": {
"fileName": "reaviz/src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
}
],
"required": false,
"type": {
"name": "ReactElement<LinearAxisProps, FC<Partial<LinearAxisProps>>>[]"
}
},
"id": {
"defaultValue": null,
"description": "Id of the chart.",
"name": "id",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "string"
}
},
"width": {
"defaultValue": null,
"description": "Width of the chart. If not provided will autosize.",
"name": "width",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "number"
}
},
"height": {
"defaultValue": null,
"description": "Height of the chart. If not provided will autosize.",
"name": "height",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "number"
}
},
"margins": {
"defaultValue": null,
"description": "Margins for the chart.",
"name": "margins",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "Margins"
}
},
"className": {
"defaultValue": null,
"description": "Classnames for the chart.",
"name": "className",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "string"
}
},
"containerClassName": {
"defaultValue": null,
"description": "Classnames for the chart.",
"name": "containerClassName",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "string"
}
},
"style": {
"defaultValue": null,
"description": "Additional css styles.",
"name": "style",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "StyleHTMLAttributes<SVGSVGElement>"
}
},
"center": {
"defaultValue": null,
"description": "Center the chart. Used mainly internally.",
"name": "center",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "boolean"
}
},
"centerX": {
"defaultValue": null,
"description": "Center chart on X Axis only. Used mainly internally.",
"name": "centerX",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "boolean"
}
},
"centerY": {
"defaultValue": null,
"description": "Center chart on Y Axis only. Used mainly internally.",
"name": "centerY",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "boolean"
}
}
}
},
{
"tags": {},
"filePath": "src/AreaChart/StackedNormalizedAreaChart.tsx",
"description": "",
"displayName": "StackedNormalizedAreaChart",
"methods": [],
"props": {
"data": {
"defaultValue": null,
"description": "Data the chart will receive to render.",
"name": "data",
"parent": {
"fileName": "src/AreaChart/StackedNormalizedAreaChart.tsx",
"name": "StackedNormalizedAreaChartProps"
},
"declarations": [
{
"fileName": "src/AreaChart/StackedNormalizedAreaChart.tsx",
"name": "StackedNormalizedAreaChartProps"
}
],
"required": false,
"type": {
"name": "ChartNestedDataShape[]"
}
},
"series": {
"defaultValue": null,
"description": "The series component that renders the area/line/circles components.",
"name": "series",
"parent": {
"fileName": "reaviz/src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
}
],
"required": false,
"type": {
"name": "ReactElement<AreaSeriesProps, FC<Partial<AreaSeriesProps>>>"
}
},
"yAxis": {
"defaultValue": null,
"description": "The linear axis component for the Y Axis of the chart.",
"name": "yAxis",
"parent": {
"fileName": "reaviz/src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
}
],
"required": false,
"type": {
"name": "ReactElement<LinearAxisProps, FC<Partial<LinearAxisProps>>>"
}
},
"xAxis": {
"defaultValue": null,
"description": "The linear axis component for the X Axis of the chart.",
"name": "xAxis",
"parent": {
"fileName": "reaviz/src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
}
],
"required": false,
"type": {
"name": "ReactElement<LinearAxisProps, FC<Partial<LinearAxisProps>>>"
}
},
"gridlines": {
"defaultValue": null,
"description": "The chart's background gridlines component.",
"name": "gridlines",
"parent": {
"fileName": "reaviz/src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
}
],
"required": false,
"type": {
"name": "ReactElement<GridlineSeriesProps, FC<Partial<GridlineSeriesProps>>>"
}
},
"brush": {
"defaultValue": null,
"description": "The chart's brush component.",
"name": "brush",
"parent": {
"fileName": "reaviz/src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
}
],
"required": false,
"type": {
"name": "ReactElement<ChartBrushProps, FC<Partial<ChartBrushProps>>>"
}
},
"zoomPan": {
"defaultValue": null,
"description": "The chart's zoom pan component.",
"name": "zoomPan",
"parent": {
"fileName": "reaviz/src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
}
],
"required": false,
"type": {
"name": "ReactElement<ChartZoomPanProps, FC<Partial<ChartZoomPanProps>>>"
}
},
"secondaryAxis": {
"defaultValue": null,
"description": "Any secondary axis components. Useful for multi-axis charts.",
"name": "secondaryAxis",
"parent": {
"fileName": "reaviz/src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/AreaChart/AreaChart.tsx",
"name": "AreaChartProps"
}
],
"required": false,
"type": {
"name": "ReactElement<LinearAxisProps, FC<Partial<LinearAxisProps>>>[]"
}
},
"id": {
"defaultValue": null,
"description": "Id of the chart.",
"name": "id",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "string"
}
},
"width": {
"defaultValue": null,
"description": "Width of the chart. If not provided will autosize.",
"name": "width",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "number"
}
},
"height": {
"defaultValue": null,
"description": "Height of the chart. If not provided will autosize.",
"name": "height",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "number"
}
},
"margins": {
"defaultValue": null,
"description": "Margins for the chart.",
"name": "margins",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "Margins"
}
},
"className": {
"defaultValue": null,
"description": "Classnames for the chart.",
"name": "className",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "string"
}
},
"containerClassName": {
"defaultValue": null,
"description": "Classnames for the chart.",
"name": "containerClassName",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "string"
}
},
"style": {
"defaultValue": null,
"description": "Additional css styles.",
"name": "style",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "StyleHTMLAttributes<SVGSVGElement>"
}
},
"center": {
"defaultValue": null,
"description": "Center the chart. Used mainly internally.",
"name": "center",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "boolean"
}
},
"centerX": {
"defaultValue": null,
"description": "Center chart on X Axis only. Used mainly internally.",
"name": "centerX",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "boolean"
}
},
"centerY": {
"defaultValue": null,
"description": "Center chart on Y Axis only. Used mainly internally.",
"name": "centerY",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "boolean"
}
}
}
},
{
"tags": {},
"filePath": "src/BarChart/BarChart.tsx",
"description": "",
"displayName": "BarChart",
"methods": [],
"props": {
"data": {
"defaultValue": null,
"description": "Data the chart will receive to render.",
"name": "data",
"parent": {
"fileName": "src/BarChart/BarChart.tsx",
"name": "BarChartProps"
},
"declarations": [
{
"fileName": "src/BarChart/BarChart.tsx",
"name": "BarChartProps"
}
],
"required": false,
"type": {
"name": "ChartDataShape[]"
}
},
"series": {
"defaultValue": null,
"description": "The series component that renders the bar components.",
"name": "series",
"parent": {
"fileName": "src/BarChart/BarChart.tsx",
"name": "BarChartProps"
},
"declarations": [
{
"fileName": "src/BarChart/BarChart.tsx",
"name": "BarChartProps"
}
],
"required": false,
"type": {
"name": "ReactElement<BarSeriesProps, FC<Partial<BarSeriesProps>>>"
}
},
"yAxis": {
"defaultValue": null,
"description": "The linear axis component for the Y Axis of the chart.",
"name": "yAxis",
"parent": {
"fileName": "src/BarChart/BarChart.tsx",
"name": "BarChartProps"
},
"declarations": [
{
"fileName": "src/BarChart/BarChart.tsx",
"name": "BarChartProps"
}
],
"required": false,
"type": {
"name": "ReactElement<LinearAxisProps, FC<Partial<LinearAxisProps>>>"
}
},
"xAxis": {
"defaultValue": null,
"description": "The linear axis component for the X Axis of the chart.",
"name": "xAxis",
"parent": {
"fileName": "src/BarChart/BarChart.tsx",
"name": "BarChartProps"
},
"declarations": [
{
"fileName": "src/BarChart/BarChart.tsx",
"name": "BarChartProps"
}
],
"required": false,
"type": {
"name": "ReactElement<LinearAxisProps, FC<Partial<LinearAxisProps>>>"
}
},
"gridlines": {
"defaultValue": null,
"description": "The chart's background gridlines component.",
"name": "gridlines",
"parent": {
"fileName": "src/BarChart/BarChart.tsx",
"name": "BarChartProps"
},
"declarations": [
{
"fileName": "src/BarChart/BarChart.tsx",
"name": "BarChartProps"
}
],
"required": false,
"type": {
"name": "ReactElement<GridlineSeriesProps, FC<Partial<GridlineSeriesProps>>>"
}
},
"brush": {
"defaultValue": null,
"description": "The chart's brush component.",
"name": "brush",
"parent": {
"fileName": "src/BarChart/BarChart.tsx",
"name": "BarChartProps"
},
"declarations": [
{
"fileName": "src/BarChart/BarChart.tsx",
"name": "BarChartProps"
}
],
"required": false,
"type": {
"name": "ReactElement<ChartBrushProps, FC<Partial<ChartBrushProps>>>"
}
},
"secondaryAxis": {
"defaultValue": null,
"description": "Any secondary axis components. Useful for multi-axis charts.",
"name": "secondaryAxis",
"parent": {
"fileName": "src/BarChart/BarChart.tsx",
"name": "BarChartProps"
},
"declarations": [
{
"fileName": "src/BarChart/BarChart.tsx",
"name": "BarChartProps"
}
],
"required": false,
"type": {
"name": "ReactElement<LinearAxisProps, FC<Partial<LinearAxisProps>>>[]"
}
},
"id": {
"defaultValue": null,
"description": "Id of the chart.",
"name": "id",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "string"
}
},
"width": {
"defaultValue": null,
"description": "Width of the chart. If not provided will autosize.",
"name": "width",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "number"
}
},
"height": {
"defaultValue": null,
"description": "Height of the chart. If not provided will autosize.",
"name": "height",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "number"
}
},
"margins": {
"defaultValue": null,
"description": "Margins for the chart.",
"name": "margins",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "Margins"
}
},
"className": {
"defaultValue": null,
"description": "Classnames for the chart.",
"name": "className",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "string"
}
},
"containerClassName": {
"defaultValue": null,
"description": "Classnames for the chart.",
"name": "containerClassName",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "string"
}
},
"style": {
"defaultValue": null,
"description": "Additional css styles.",
"name": "style",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "StyleHTMLAttributes<SVGSVGElement>"
}
},
"center": {
"defaultValue": null,
"description": "Center the chart. Used mainly internally.",
"name": "center",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "boolean"
}
},
"centerX": {
"defaultValue": null,
"description": "Center chart on X Axis only. Used mainly internally.",
"name": "centerX",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "boolean"
}
},
"centerY": {
"defaultValue": null,
"description": "Center chart on Y Axis only. Used mainly internally.",
"name": "centerY",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "boolean"
}
}
}
},
{
"tags": {},
"filePath": "src/BarChart/HistogramBarChart.tsx",
"description": "",
"displayName": "HistogramBarChart",
"methods": [],
"props": {
"data": {
"defaultValue": null,
"description": "Data the chart will receive to render.",
"name": "data",
"parent": {
"fileName": "src/BarChart/HistogramBarChart.tsx",
"name": "HistogramBarChartProps"
},
"declarations": [
{
"fileName": "src/BarChart/HistogramBarChart.tsx",
"name": "HistogramBarChartProps"
}
],
"required": false,
"type": {
"name": "ChartShallowDataShape<ChartDataTypes | [ChartDataTypes, ChartDataTypes]>[]"
}
},
"series": {
"defaultValue": null,
"description": "The series component that renders the bar components.",
"name": "series",
"parent": {
"fileName": "reaviz/src/BarChart/BarChart.tsx",
"name": "BarChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/BarChart/BarChart.tsx",
"name": "BarChartProps"
}
],
"required": false,
"type": {
"name": "ReactElement<BarSeriesProps, FC<Partial<BarSeriesProps>>>"
}
},
"yAxis": {
"defaultValue": null,
"description": "The linear axis component for the Y Axis of the chart.",
"name": "yAxis",
"parent": {
"fileName": "reaviz/src/BarChart/BarChart.tsx",
"name": "BarChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/BarChart/BarChart.tsx",
"name": "BarChartProps"
}
],
"required": false,
"type": {
"name": "ReactElement<LinearAxisProps, FC<Partial<LinearAxisProps>>>"
}
},
"xAxis": {
"defaultValue": null,
"description": "The linear axis component for the X Axis of the chart.",
"name": "xAxis",
"parent": {
"fileName": "reaviz/src/BarChart/BarChart.tsx",
"name": "BarChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/BarChart/BarChart.tsx",
"name": "BarChartProps"
}
],
"required": false,
"type": {
"name": "ReactElement<LinearAxisProps, FC<Partial<LinearAxisProps>>>"
}
},
"gridlines": {
"defaultValue": null,
"description": "The chart's background gridlines component.",
"name": "gridlines",
"parent": {
"fileName": "reaviz/src/BarChart/BarChart.tsx",
"name": "BarChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/BarChart/BarChart.tsx",
"name": "BarChartProps"
}
],
"required": false,
"type": {
"name": "ReactElement<GridlineSeriesProps, FC<Partial<GridlineSeriesProps>>>"
}
},
"brush": {
"defaultValue": null,
"description": "The chart's brush component.",
"name": "brush",
"parent": {
"fileName": "reaviz/src/BarChart/BarChart.tsx",
"name": "BarChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/BarChart/BarChart.tsx",
"name": "BarChartProps"
}
],
"required": false,
"type": {
"name": "ReactElement<ChartBrushProps, FC<Partial<ChartBrushProps>>>"
}
},
"secondaryAxis": {
"defaultValue": null,
"description": "Any secondary axis components. Useful for multi-axis charts.",
"name": "secondaryAxis",
"parent": {
"fileName": "reaviz/src/BarChart/BarChart.tsx",
"name": "BarChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/BarChart/BarChart.tsx",
"name": "BarChartProps"
}
],
"required": false,
"type": {
"name": "ReactElement<LinearAxisProps, FC<Partial<LinearAxisProps>>>[]"
}
},
"id": {
"defaultValue": null,
"description": "Id of the chart.",
"name": "id",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "string"
}
},
"width": {
"defaultValue": null,
"description": "Width of the chart. If not provided will autosize.",
"name": "width",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "number"
}
},
"height": {
"defaultValue": null,
"description": "Height of the chart. If not provided will autosize.",
"name": "height",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "number"
}
},
"margins": {
"defaultValue": null,
"description": "Margins for the chart.",
"name": "margins",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "Margins"
}
},
"className": {
"defaultValue": null,
"description": "Classnames for the chart.",
"name": "className",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "string"
}
},
"containerClassName": {
"defaultValue": null,
"description": "Classnames for the chart.",
"name": "containerClassName",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "string"
}
},
"style": {
"defaultValue": null,
"description": "Additional css styles.",
"name": "style",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "StyleHTMLAttributes<SVGSVGElement>"
}
},
"center": {
"defaultValue": null,
"description": "Center the chart. Used mainly internally.",
"name": "center",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "boolean"
}
},
"centerX": {
"defaultValue": null,
"description": "Center chart on X Axis only. Used mainly internally.",
"name": "centerX",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "boolean"
}
},
"centerY": {
"defaultValue": null,
"description": "Center chart on Y Axis only. Used mainly internally.",
"name": "centerY",
"parent": {
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
},
"declarations": [
{
"fileName": "reaviz/src/common/containers/ChartContainer.tsx",
"name": "ChartProps"
}
],
"required": false,
"type": {
"name": "boolean"
}
}
}
},
{
"tags": {},
"filePath": "src/BarChart/MarimekkoChart.tsx",
"description": "",
"displayName": "MarimekkoChart",
"methods": [],
"props": {
"data": {
"defaultValue": null,
"description": "Data the chart will receive to render.",
"name": "data",
"parent": {
"fileName": "src/BarChart/MarimekkoChart.tsx",
"name": "MarimekkoChartProps"
},
"declarations": [
{
"fileName": "src/BarChart/MarimekkoChart.t