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
}

Last updated

Was this helpful?