Basic Chart Viz Props
Basic Chart Viz Props
The basic chart VIZ JSON config based on basic VIZ config, that applies to all chart VIZ
interface IBasicVizProps {
name: string // The title name of the chart
vizType?: any // The type of the viz
data?: any // The data for this viz
dataKey?: string // The data key for the data to get the specific data, defaults to undefined
description?: string // This text will show up on hover
width?: number | string // The static width of the chart, default unit is px
height?: number | string // The static height of the chart, default unit is px
className?: string // The additional css class for this widget
style?: React.CSSProperties // The additional CSS style
isLoading?: boolean // If true, the viz will show a loading diagram
colors?: string | string[] // The colors for the chart plots, it could be a strinf of COLOR_SET or an array of hex codes
collapsible?: boolean // If true, the chart panel is able to collapse or expand
xAxis?: string // The value unit of the x axis of the chart
yAxis?: string // The value unit of the y axis of the chart
unit?: string // unit for chart tooltip values
chartConfig?: IObject // The additional Highcharts config to customize
}{
"vizName": "mainChart", // The name of the viz
"vizType": ["line", "bar", "table", "pie", "map"], // The type of the viz
"dataSourceID": "RPT.ADC.ThunderDashboardSLBLoadDistribution", // The data source ID to provide data to the viz
"dataKey": null, // The data key for the data to get the specific data, defaults to undefined
"name": "LOAD DISTRIBUTION", // The title name of the chart
"description": "", // This text will show up on hover
"width": 200, // The static width of the chart, default unit is px
"height": 200, // The static height of the chart, default unit is px
"className": "", // The additional css class for this widget
"colors": "cyan_to_green", // The colors for the chart plots, it could be a COLOR_SET or an array of hex codes
"chartConfig": {}, // The additional Highcharts config to customize
"collapsible": false, // If true, the chart panel is able to collapse or expand
"style": {}, // The additional CSS style
"xAxis": "", //The value unit of the x axis of the chart
"yAxis": "", //The value unit of the y axis of the chart
"isLoading": false // If true, the viz will show a loading diagram
}Last updated
Was this helpful?