Interface: QueryProps
Props for query-based data fetching
Extends
Section titled “Extends”Properties
Section titled “Properties”ariaLabel?
Section titled “ariaLabel?”
optionalariaLabel?:string
Accessibility label for screen readers
Inherited from
Section titled “Inherited from”className?
Section titled “className?”
optionalclassName?:string
Additional CSS classes
Inherited from
Section titled “Inherited from”colorPalette?
Section titled “colorPalette?”
optionalcolorPalette?:ChartColorPalette
Color palette to use. Auto-selected based on chart type if not specified.
- “categorical”: Distinct colors for different categories (bar, pie, line)
- “sequential”: Gradient for magnitude/intensity (heatmap)
- “diverging”: Two-tone for positive/negative values
Inherited from
Section titled “Inherited from”colors?
Section titled “colors?”
optionalcolors?:string[]
Custom colors for series (overrides colorPalette)
Inherited from
Section titled “Inherited from”
optionaldata?:undefined
format?
Section titled “format?”
optionalformat?:DataFormat
Data format to use
- “json_array”: Use JSON format (smaller payloads, simpler)
- “arrow_stream”: Use Arrow format (faster for large datasets)
- “auto”: Automatically select based on expected data size
Default
Section titled “Default”"auto"height?
Section titled “height?”
optionalheight?:number
Chart height in pixels
Default
Section titled “Default”300Inherited from
Section titled “Inherited from”onDataClick?
Section titled “onDataClick?”
optionalonDataClick?: (datum) =>void
Pointer-only: charts render to
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”options?
Section titled “options?”
optionaloptions?:Record<string,unknown>
Additional ECharts options to merge
Inherited from
Section titled “Inherited from”parameters?
Section titled “parameters?”
optionalparameters?:Record<string,unknown>
Query parameters passed to the analytics endpoint
queryKey
Section titled “queryKey”queryKey:
string
Analytics query key registered with analytics plugin
selected?
Section titled “selected?”
optionalselected?:string|string[]
Controlled selection by category name. Matching data element(s) render at full prominence while the rest are dimmed. Drive it from your own state to reflect a cross-filter or selection. Categorical charts (bar, pie/donut) show emphasis; other chart types ignore it.
Inherited from
Section titled “Inherited from”showLegend?
Section titled “showLegend?”
optionalshowLegend?:boolean
Show legend
Inherited from
Section titled “Inherited from”testId?
Section titled “testId?”
optionaltestId?:string
Test ID for automated testing
Inherited from
Section titled “Inherited from”title?
Section titled “title?”
optionaltitle?:string
Chart title
Inherited from
Section titled “Inherited from”transformer?
Section titled “transformer?”
optionaltransformer?: <T>(data) =>T
Transform raw data before rendering
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”T
Returns
Section titled “Returns”T
valueFormatter?
Section titled “valueFormatter?”
optionalvalueFormatter?:ChartValueFormatter
Formats measure values in the chart’s built-in value axes, tooltips, and
value labels. field is the corresponding yKey, so one formatter can
select a different format for each series.
For charts with multiple series on one value axis, axis ticks use the
first yKey; each tooltip uses its own series field.
Inherited from
Section titled “Inherited from”
optionalxKey?:string
X-axis field key. Auto-detected from schema if not provided.
Inherited from
Section titled “Inherited from”
optionalyKey?:string|string[]
Y-axis field key(s). Auto-detected from schema if not provided.