BarPercent
- Recommended field configuration: 1 measure(s), 2 dimension(s)
- Supports Data Reshape: at least1 measure(s), 0 dimension(s)
Percentage Bar Chart supports the following visual channels:
yAxis : y-axis channel, supports multiple dimensions, mapped to the y-axis by dimension value
xAxis : x-axis channel, supports multiple measures, mapped to the x-axis by measure value
detail : detail channel, supports multiple dimensions, used to display finer-grained data within the same color series
color : color channel, supports multiple dimensions or one measure, dimension colors are used to distinguish different data series, measure colors are used for linearly mapping measure values to graphical colors
tooltip: tooltip channel, supports multiple dimensions and multiple measures, displayed when hovering over a data point
label : label channel, supports multiple dimensions and multiple measures, displays data labels on data points
Percentage Bar Chart, suitable for horizontally displaying the proportional relationships between categories, with the X-axis showing data proportions in percentage form.
Applicable scenarios:
- Proportion comparison when category names are long
- Horizontal composition analysis of multi-dimensional data
- Scenarios where rankings and proportions are displayed simultaneously
Data requirements:
- At least 1 dimension field and 1 measure field
- The sum of all category proportions must be 100%
- Supports multiple series stacking to display proportional relationships
Features enabled by default:
- Legends, axes, percentage labels, tooltips, and proportion calculation are enabled by default
chartType
Type: "barPercent"
Percentage Bar Chart, displaying the proportional relationship of various category data in a horizontal percentage format
Example 'barPercent'
dataset
Type: Record[]
Data source; a dataset conforming to TidyData specifications and already aggregated, used to define the data source and structure of the chart. User-inputted datasets do not require any processing as VSeed features powerful Data Reshape capabilities and will perform Data Reshape automatically. The data for the percentage bar chart will eventually be converted to 2 dimensions and 1 measure.
Example [{category:'A', value:30}, {category:'B', value:70}]
dimensions
Type: BarDimension[] | undefined
Dimensions; the first dimension will be placed on the Y-axis, and the remaining dimensions will be merged with measure names (when multiple measures exist) and displayed as legend items.
Example [{id: 'category', alias: 'Category'}]
id
Type: string
Field ID corresponding to the dimension
alias
Type: string | undefined
Dimension alias
timeFormat
Type: TimeFormat | undefined
Dimension date format configuration
type
Type: "year" | "quarter" | "month" | "week" | "day" | "hour" | "minute" | "second"
Time granularity, determines the date display precision
encoding
Type: "color" | "detail" | "tooltip" | "label" | "row" | "column" | "yAxis" | undefined
Channel to which the dimension is mapped
- yAxis: supports mapping multiple dimensions to the Y-axis
- color: supports mapping multiple dimensions to the color channel
- detail: supports mapping multiple dimensions to the detail channel
- tooltip: supports mapping multiple dimensions to the tooltip channel
- label: supports mapping multiple dimensions to the label channel
- row: supports mapping multiple dimensions to the row channel
- column: supports mapping multiple dimensions to the column channel
measures
Type: BarMeasure[] | undefined
Measures; measures will be automatically merged into one measure and mapped to the X-axis. When multiple measures exist, measure names will be merged with the remaining dimensions and displayed as legend items.
Example [{id: 'value', alias: 'Value Proportion', format: 'percent'}]
id
Type: string
Measure ID, must be unique
alias
Type: string | undefined
Measure alias, duplicates allowed; when not set, alias defaults to id
autoFormat
Type: boolean | undefined
Automatic number formatting, enabled by default, highest priority
When autoFormat=true, it overrides all numFormat configurations
When enabled, chart data labels and tooltips will automatically select the appropriate formatting based on measure values and locale
Formatting rules: decimal numbers with compact notation enabled, minimum 0 decimal places, maximum 2 decimal places, automatic rounding, using the browser's Intl.NumberFormat implementation
For example:
- locale=zh-CN: 749740.264 → 74.45~74.45万
- locale=en-US: 749740.264 → 744.5K
numFormat
Type: NumFormat | undefined
Custom number formatting for measures; automatically applied to labels and tooltips
Note: To use custom formatting, you must explicitly set autoFormat=false; otherwise autoFormat will override this config
type
Type: "number" | "percent" | "permille" | "scientific" | undefined
Number format type, supports: number (decimal), percent (%), permille (‰), scientific notation
ratio
Type: number | undefined
Number format ratio, cannot be 0
Example - 100000 converts to 10W, ratio:10000, symbol:"W" - 100000 converts to 10K, ratio:1000, symbol:"K"
symbol
Type: string | undefined
Number format symbol, e.g. %, ‰
Example - 100000 converts to 10W, ratio:10000, symbol:"W" - 100000 converts to 10K, ratio:1000, symbol:"K"
thousandSeparator
Type: boolean | undefined
Thousands separator for number formatting
suffix
Type: string | undefined
Number format suffix
prefix
Type: string | undefined
Number format prefix
fractionDigits
Type: number | undefined
Decimal places for number formatting, using the browser's Intl.NumberFormat minimumFractionDigits and maximumFractionDigits; lower priority than significantDigits
Example - 1234.5678 converts to 1235, fractionDigits:0 (roundingMode:halfCeil) - 1234.5678 converts to 1234.6, fractionDigits:1 (roundingMode:halfCeil) - 1234.5678 converts to 1234.57, fractionDigits:2 (roundingMode:halfCeil) - 1234.5678 converts to 1230.568, fractionDigits:3 (roundingMode:halfCeil) - 1234.5678 converts to 1234.5678, fractionDigits:4 (roundingMode:halfCeil) - 1234.5678 converts to 1234.56780, fractionDigits:5 (roundingMode:halfCeil)
significantDigits
Type: number | undefined
Significant digits for number formatting, using the browser's Intl.NumberFormat minimumSignificantDigits and maximumSignificantDigits; higher priority than fractionDigits
Example - 1234.5678 converts to 1000, significantDigits:1 - 1234.5678 converts to 1200, significantDigits:2 - 1234.5678 converts to 1230, significantDigits:3 - 1234.5678 converts to 1234, significantDigits:4 - 1234.5678 converts to 1234.6, significantDigits:5 (roundingMode:halfCeil) - 1234.5678 converts to 1234.57, significantDigits:6 (roundingMode:halfCeil) - 1234.5678 converts to 1234.568, significantDigits:7 (roundingMode:halfCeil) - 1234.5678 converts to 1234.5678, significantDigits:8 (roundingMode:halfCeil)
roundingPriority
Type: "morePrecision" | "lessPrecision" | undefined
Rounding priority for number formatting when both significantDigits and fractionDigits are set; uses the browser's Intl.NumberFormat, following the same rules as Intl.NumberFormat's roundingPriority
Example - 1234.5678 converts to 1230, significantDigits:3 (roundingPriority:lessPrecision) - 1234.5678 converts to 1234.5678, significantDigits:3 (roundingPriority:morePrecision)
roundingMode
Type: "floor" | "ceil" | "expand" | "trunc" | "halfCeil" | "halfFloor" | "halfExpand" | "halfTrunc" | "halfEven" | undefined
Rounding mode for number formatting, using the browser's Intl.NumberFormat, following the same rules as Intl.NumberFormat's roundingMode
format
Type: NumFormat | undefined
type
Type: "number" | "percent" | "permille" | "scientific" | undefined
Number format type, supports: number (decimal), percent (%), permille (‰), scientific notation
ratio
Type: number | undefined
Number format ratio, cannot be 0
Example - 100000 converts to 10W, ratio:10000, symbol:"W" - 100000 converts to 10K, ratio:1000, symbol:"K"
symbol
Type: string | undefined
Number format symbol, e.g. %, ‰
Example - 100000 converts to 10W, ratio:10000, symbol:"W" - 100000 converts to 10K, ratio:1000, symbol:"K"
thousandSeparator
Type: boolean | undefined
Thousands separator for number formatting
suffix
Type: string | undefined
Number format suffix
prefix
Type: string | undefined
Number format prefix
fractionDigits
Type: number | undefined
Decimal places for number formatting, using the browser's Intl.NumberFormat minimumFractionDigits and maximumFractionDigits; lower priority than significantDigits
Example - 1234.5678 converts to 1235, fractionDigits:0 (roundingMode:halfCeil) - 1234.5678 converts to 1234.6, fractionDigits:1 (roundingMode:halfCeil) - 1234.5678 converts to 1234.57, fractionDigits:2 (roundingMode:halfCeil) - 1234.5678 converts to 1230.568, fractionDigits:3 (roundingMode:halfCeil) - 1234.5678 converts to 1234.5678, fractionDigits:4 (roundingMode:halfCeil) - 1234.5678 converts to 1234.56780, fractionDigits:5 (roundingMode:halfCeil)
significantDigits
Type: number | undefined
Significant digits for number formatting, using the browser's Intl.NumberFormat minimumSignificantDigits and maximumSignificantDigits; higher priority than fractionDigits
Example - 1234.5678 converts to 1000, significantDigits:1 - 1234.5678 converts to 1200, significantDigits:2 - 1234.5678 converts to 1230, significantDigits:3 - 1234.5678 converts to 1234, significantDigits:4 - 1234.5678 converts to 1234.6, significantDigits:5 (roundingMode:halfCeil) - 1234.5678 converts to 1234.57, significantDigits:6 (roundingMode:halfCeil) - 1234.5678 converts to 1234.568, significantDigits:7 (roundingMode:halfCeil) - 1234.5678 converts to 1234.5678, significantDigits:8 (roundingMode:halfCeil)
roundingPriority
Type: "morePrecision" | "lessPrecision" | undefined
Rounding priority for number formatting when both significantDigits and fractionDigits are set; uses the browser's Intl.NumberFormat, following the same rules as Intl.NumberFormat's roundingPriority
Example - 1234.5678 converts to 1230, significantDigits:3 (roundingPriority:lessPrecision) - 1234.5678 converts to 1234.5678, significantDigits:3 (roundingPriority:morePrecision)
roundingMode
Type: "floor" | "ceil" | "expand" | "trunc" | "halfCeil" | "halfFloor" | "halfExpand" | "halfTrunc" | "halfEven" | undefined
Rounding mode for number formatting, using the browser's Intl.NumberFormat, following the same rules as Intl.NumberFormat's roundingMode
encoding
Type: "xAxis" | "color" | "detail" | "tooltip" | "label" | undefined
Channel to which the measure is mapped
- xAxis: measure mapped to the x-axis
- detail: measure mapped to the detail channel
- color: measure mapped to the color channel
- label: measure mapped to the label channel
- tooltip: measure mapped to the tooltip channel
parentId
Type: string | undefined
In flat measure configuration form, builds a tree-shaped measure group. parentId points to the id of the parent measure group, used for building the measure tree
There are two ways to configure the measure tree: Option 1 is directly configuring a measure tree with children; Option 2 is configuring a flat measure list with parentId. These two methods cannot be used simultaneously
page
Type: Page | undefined
Pagination
Pagination configuration for the chart's pagination feature
field
Type: string
Pagination field; specifies the field name for pagination, must be a dimension
currentValue
Type: string
Current pagination value; specifies the value used to determine the current page
Example '2023-01-01'
backgroundColor
Type: BackgroundColor
Chart background color, defaults to a transparent background. Background color can be a color string (e.g. 'red', 'blue'), or a hex, rgb, or rgba value (e.g. '#ff0000', 'rgba(255,0,0,0.5)')
color
Type: Color | undefined
Color configuration for defining the chart's color scheme, including color lists, color mappings, and color gradients.
colorScheme
Type: string[] | undefined
Discrete color scheme used to define the colors of different elements in the chart
Example ['#FFCDD2,#F8BBD0,#E1BEE7,#D1C4E9,#C5CAE9,#BBDEFB,#B3E5FC,#B2EBF2,#B2DFDB,#C8E6C9,#DCEDC8,#F0F4C3,#FFF9C4,#FFECB3,#FFE0B2']
linearColorScheme
Type: string[] | undefined
Linear gradient color scheme used to define the colors of different elements in the chart
Example ['#FFCDD2, #F8BBD0]
colorMapping
Type: Record<string, string> | undefined
Color mapping used to map data values to specific colors
Example { 'profit': 'red', 'sales': 'blue', }
positiveColor
Type: string | undefined
Positive/negative color configuration; defines the color for positive values in the chart
negativeColor
Type: string | undefined
Positive/negative color configuration; defines the color for negative values in the chart
label
Type: Label | undefined
Label configuration for defining chart data labels, including their position, format, and style.
enable
Type: false | true
Whether label functionality is enabled
wrap
Type: boolean | undefined
Whether labels wrap to the next line
showValue
Type: boolean | undefined
Whether labels display measure values
In multi-measure scenarios, there is no concern about conflicting values, because all plot-related measures go through foldMeasures processing and are merged into one measure representing a single data point
Note: encoding's label has higher priority; this config does not affect encoding's label
showValuePercent
Type: boolean | undefined
Whether labels display the percentage of measure values
In multi-measure scenarios, there is no concern about conflicting values, because all plot-related measures go through foldMeasures processing and are merged into one measure representing a single data point
Note: encoding's label has higher priority; this config does not affect encoding's label
showDimension
Type: boolean | undefined
Whether labels display dimension labels
Display all dimension labels
Note: encoding's label has higher priority; this config does not affect encoding's label
autoFormat
Type: boolean | undefined
Whether label values are automatically formatted; when autoFormat is true, numFormat configuration is ignored
numFormat
Type: NumFormat | undefined
Label value format configuration; merged with the format in measure, where measure's format has higher priority. numFormat priority is lower than autoFormat
type
Type: "number" | "percent" | "permille" | "scientific" | undefined
Number format type, supports: number (decimal), percent (%), permille (‰), scientific notation
ratio
Type: number | undefined
Number format ratio, cannot be 0
Example - 100000 converts to 10W, ratio:10000, symbol:"W" - 100000 converts to 10K, ratio:1000, symbol:"K"
symbol
Type: string | undefined
Number format symbol, e.g. %, ‰
Example - 100000 converts to 10W, ratio:10000, symbol:"W" - 100000 converts to 10K, ratio:1000, symbol:"K"
thousandSeparator
Type: boolean | undefined
Thousands separator for number formatting
suffix
Type: string | undefined
Number format suffix
prefix
Type: string | undefined
Number format prefix
fractionDigits
Type: number | undefined
Decimal places for number formatting, using the browser's Intl.NumberFormat minimumFractionDigits and maximumFractionDigits; lower priority than significantDigits
Example - 1234.5678 converts to 1235, fractionDigits:0 (roundingMode:halfCeil) - 1234.5678 converts to 1234.6, fractionDigits:1 (roundingMode:halfCeil) - 1234.5678 converts to 1234.57, fractionDigits:2 (roundingMode:halfCeil) - 1234.5678 converts to 1230.568, fractionDigits:3 (roundingMode:halfCeil) - 1234.5678 converts to 1234.5678, fractionDigits:4 (roundingMode:halfCeil) - 1234.5678 converts to 1234.56780, fractionDigits:5 (roundingMode:halfCeil)
significantDigits
Type: number | undefined
Significant digits for number formatting, using the browser's Intl.NumberFormat minimumSignificantDigits and maximumSignificantDigits; higher priority than fractionDigits
Example - 1234.5678 converts to 1000, significantDigits:1 - 1234.5678 converts to 1200, significantDigits:2 - 1234.5678 converts to 1230, significantDigits:3 - 1234.5678 converts to 1234, significantDigits:4 - 1234.5678 converts to 1234.6, significantDigits:5 (roundingMode:halfCeil) - 1234.5678 converts to 1234.57, significantDigits:6 (roundingMode:halfCeil) - 1234.5678 converts to 1234.568, significantDigits:7 (roundingMode:halfCeil) - 1234.5678 converts to 1234.5678, significantDigits:8 (roundingMode:halfCeil)
roundingPriority
Type: "morePrecision" | "lessPrecision" | undefined
Rounding priority for number formatting when both significantDigits and fractionDigits are set; uses the browser's Intl.NumberFormat, following the same rules as Intl.NumberFormat's roundingPriority
Example - 1234.5678 converts to 1230, significantDigits:3 (roundingPriority:lessPrecision) - 1234.5678 converts to 1234.5678, significantDigits:3 (roundingPriority:morePrecision)
roundingMode
Type: "floor" | "ceil" | "expand" | "trunc" | "halfCeil" | "halfFloor" | "halfExpand" | "halfTrunc" | "halfEven" | undefined
Rounding mode for number formatting, using the browser's Intl.NumberFormat, following the same rules as Intl.NumberFormat's roundingMode
labelFontSize
Type: number | undefined
Label font size
labelFontWeight
Type: string | number | undefined
Label font weight
labelBackgroundColor
Type: string | undefined
Label background color
labelStroke
Type: string | undefined
Label stroke color
labelColor
Type: string | undefined
Label font color
labelColorSmartInvert
Type: boolean | undefined
Whether the label font color automatically inverts based on the graphic element color
labelPosition
Type: "inside" | "outside" | undefined
label position
labelOverlap
Type: boolean | undefined
Whether the label anti-overlap feature is enabled
selector
Type: Selector | Selectors | undefined
Label filtering; the default relationship between selectors is OR
field
Type: string
Dimension field; the ID of an item in dimensions
operator
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the value of the dimension field is in 'value'
- not in: Select data items where the value of the dimension field is not in 'value'
op
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the value of the dimension field is in 'value'
- not in: Select data items where the value of the dimension field is not in 'value'
Same as operator
value
Type: string | number | (string | number)[]
Select the value of the dimension field in the data item; supports arrays
dynamicFilter
Type: ChartDynamicFilter | undefined
Animated filter (AI-generated code execution)
Implement complex data filtering logic via AI-generated JavaScript code.
Core capabilities:
- Supports arbitrarily complex data filtering conditions
- Use built-in utility functions for data operations
- Safe execution in the browser environment (Web Worker sandbox)
Environment requirements: Only supports browser environments; Node.js environments will use the fallback.
Note: selector and dynamicFilter cannot be used simultaneously; dynamicFilter has higher priority.
Chart animated filter configuration
Implement filtering of chart marks (bars, points, etc.) via AI-generated JavaScript code.
type
Type: "row-with-field"
description
Type: string | undefined
Description of the user's filtering requirements (natural language)
Example "Highlight bars with sales greater than 1000"
"Highlight the bar with the highest profit rate in each region"
code
Type: string
AI-generated JavaScript filtering code
- Only built-in utility functions can be used (accessed via _ or R)
- Input parameters: data (array), each item contains a __row_index field representing the row number
- Must return an array of row index and field combinations: Array<{ __row_index: number, field: string }>
- __row_index represents the row number of the original data item, and field represents the field to be illuminated
- Prohibited: eval, Function, asynchronous operations, DOM API, network requests
Example Highlight the 'sales' field for data items with sales greater than 1000
Highlight the data item with the highest profit rate in each region
Highlight data items filtered by multiple conditions
fallback
Type: Selector | Selectors | undefined
Fallback solution when code execution fails or the environment is not supported
field
Type: string
Dimension field; the ID of an item in dimensions
operator
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the value of the dimension field is in 'value'
- not in: Select data items where the value of the dimension field is not in 'value'
op
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the value of the dimension field is in 'value'
- not in: Select data items where the value of the dimension field is not in 'value'
Same as operator
value
Type: string | number | (string | number)[]
Select the value of the dimension field in the data item; supports arrays
result
Type: DynamicFilterExecutionResult<RowWithFieldRes> | undefined
Animated filter execution result (runtime field)
Captured during the prepare() phase; read-only at runtime
success
Type: false | true
data
Type: T[] | undefined
error
Type: string | undefined
legend
Type: Legend | undefined
Legend configuration; used to define the chart legend, including its position, format, style, etc.
enable
Type: boolean | undefined
Whether the legend feature is enabled
Example enable: true
border
Type: boolean | undefined
Whether the legend border is enabled
Only effective for discrete legends
Example border: true
labelColor
Type: string | undefined
Legend font color
pagerIconColor
Type: string | undefined
Pager icon color
pagerIconDisableColor
Type: string | undefined
Pager icon disabled color
labelFontSize
Type: number | undefined
Legend font size
Example labelFontSize: 10
labelFontColor
Type: string | undefined
Legend font color
labelFontWeight
Type: string | number | undefined
Legend font weight
Example labelFontWeight: 400
shapeType
Type: "circle" | "cross" | "diamond" | "square" | "arrow" | "arrow2Left" | "arrow2Right" | "wedge" | "thinTriangle" | "triangle" | "triangleUp" | "triangleDown" | "triangleRight" | "triangleLeft" | "stroke" | "star" | "wye" | "rect" | "arrowLeft" | "arrowRight" | "rectRound" | "roundLine" | undefined
Legend shape
Only effective for discrete legends
Example shapeType: 'circle'
position
Type: "left" | "leftTop" | "leftBottom" | "lt" | "lb" | "top" | "topLeft" | "topRight" | "tl" | "tr" | "right" | "rightTop" | "rightBottom" | "rt" | "rb" | "bottom" | "bottomLeft" | "bottomRight" | "bl" | "br" | undefined
Legend position
Example position: 'rightTop'
maxSize
Type: number | undefined
Maximum number of columns or rows for the legend when many items exist.
If the position is horizontal (bottom, bottomLeft, bottomRight, bl, br, top, topLeft, topRight, tl, tr), maxSize controls the number of displayed columns.
If the position is vertical (left, leftTop, leftBottom, lt, lb, right, rightTop, rightBottom, rt, rb), maxSize controls the number of displayed rows.
Only effective for discrete legends
Example maxSize: 2
tooltip
Type: Tooltip | undefined
Tooltip configuration; used to define chart tooltips, including their position, format, style, etc.
enable
Type: false | true
Whether the tooltips feature is enabled
brush
Type: Brush | undefined
Brush selection
Brush configuration; used to enable/disable brush selection capabilities.
Chart brush configuration
enable
Type: boolean | undefined
Whether to enable brush selection
brushType
Type: "rect" | "x" | "y" | "polygon" | undefined
Brush type
Defines the shape and direction of the selection box.
- rect: Rectangular selection; selection can be made in both X and Y directions simultaneously.
- polygon: Polygon selection; perform selection by clicking multiple points to draw an arbitrary polygon.
- x: X-axis selection; selection only in the X direction, with no limits in the Y direction.
- y: Y-axis selection; selection only in the Y direction, with no limits in the X direction.
brushMode
Type: "single" | "multiple" | undefined
Brush selection mode: single or multiple.
Defines the selection mode.
- single: Single selection mode; only one selection box can exist at a time.
- multiple: Multiple selection mode; multiple selection boxes can exist simultaneously.
removeOnClick
Type: boolean | undefined
Whether to clear the selection box after the brush selection ends
inBrushStyle
Type: { opacity?: number; stroke?: string; lineWidth?: number; } | undefined
Style for selected data items
Defines the style of the selected data points.
opacity
Type: number | undefined
Opacity
Opacity of the selected data points, ranging from 0 to 1
stroke
Type: string | undefined
Stroke color
lineWidth
Type: number | undefined
Stroke width
outOfBrushStyle
Type: { opacity?: number; stroke?: string; lineWidth?: number; } | undefined
Style for unselected data items
Defines the style of the unselected data points.
opacity
Type: number | undefined
Opacity
Opacity of unselected data points, ranging from 0 to 1
stroke
Type: string | undefined
Stroke color
lineWidth
Type: number | undefined
Stroke width
xAxis
Type: XLinearAxis | undefined
X-axis; a numeric axis. X-axis configuration used to define the chart's X-axis, including its position, format, style, etc.
visible
Type: boolean | undefined
Whether the axis is visible
min
Type: number | undefined
The minimum value of the axis; has higher priority than 'nice' and 'zero'
max
Type: number | boolean | undefined
The maximum value of the axis; has higher priority than 'nice' and 'zero'. If set to true, the maximum value is automatically calculated based on the data range.
log
Type: boolean | undefined
Whether to use a logarithmic axis; only effective for numeric axes
logBase
Type: number | undefined
The base of the logarithmic axis; only effective for numeric axes
nice
Type: boolean | undefined
Whether to automatically adjust the axis scale interval to make the labels more readable; this configuration is ignored when min and max are specified. Only effective for numeric axes.
inverse
Type: boolean | undefined
Whether the axis is displayed in reverse; only effective for numeric axes
zero
Type: boolean | undefined
Whether to force the display of the zero value on the axis; this configuration is ignored when min and max are specified. Only effective for numeric axes.
autoFormat
Type: boolean | undefined
Whether to automatically format labels for the numeric axis; when autoFormat is true, the numFormat configuration is ignored. Only effective for numeric axes.
numFormat
Type: NumFormat | undefined
Numeric axis number formatting; only effective for numeric axes, with lower priority than autoFormat
type
Type: "number" | "percent" | "permille" | "scientific" | undefined
Number format type, supports: number (decimal), percent (%), permille (‰), scientific notation
ratio
Type: number | undefined
Number format ratio, cannot be 0
Example - 100000 converts to 10W, ratio:10000, symbol:"W" - 100000 converts to 10K, ratio:1000, symbol:"K"
symbol
Type: string | undefined
Number format symbol, e.g. %, ‰
Example - 100000 converts to 10W, ratio:10000, symbol:"W" - 100000 converts to 10K, ratio:1000, symbol:"K"
thousandSeparator
Type: boolean | undefined
Thousands separator for number formatting
suffix
Type: string | undefined
Number format suffix
prefix
Type: string | undefined
Number format prefix
fractionDigits
Type: number | undefined
Decimal places for number formatting, using the browser's Intl.NumberFormat minimumFractionDigits and maximumFractionDigits; lower priority than significantDigits
Example - 1234.5678 converts to 1235, fractionDigits:0 (roundingMode:halfCeil) - 1234.5678 converts to 1234.6, fractionDigits:1 (roundingMode:halfCeil) - 1234.5678 converts to 1234.57, fractionDigits:2 (roundingMode:halfCeil) - 1234.5678 converts to 1230.568, fractionDigits:3 (roundingMode:halfCeil) - 1234.5678 converts to 1234.5678, fractionDigits:4 (roundingMode:halfCeil) - 1234.5678 converts to 1234.56780, fractionDigits:5 (roundingMode:halfCeil)
significantDigits
Type: number | undefined
Significant digits for number formatting, using the browser's Intl.NumberFormat minimumSignificantDigits and maximumSignificantDigits; higher priority than fractionDigits
Example - 1234.5678 converts to 1000, significantDigits:1 - 1234.5678 converts to 1200, significantDigits:2 - 1234.5678 converts to 1230, significantDigits:3 - 1234.5678 converts to 1234, significantDigits:4 - 1234.5678 converts to 1234.6, significantDigits:5 (roundingMode:halfCeil) - 1234.5678 converts to 1234.57, significantDigits:6 (roundingMode:halfCeil) - 1234.5678 converts to 1234.568, significantDigits:7 (roundingMode:halfCeil) - 1234.5678 converts to 1234.5678, significantDigits:8 (roundingMode:halfCeil)
roundingPriority
Type: "morePrecision" | "lessPrecision" | undefined
Rounding priority for number formatting when both significantDigits and fractionDigits are set; uses the browser's Intl.NumberFormat, following the same rules as Intl.NumberFormat's roundingPriority
Example - 1234.5678 converts to 1230, significantDigits:3 (roundingPriority:lessPrecision) - 1234.5678 converts to 1234.5678, significantDigits:3 (roundingPriority:morePrecision)
roundingMode
Type: "floor" | "ceil" | "expand" | "trunc" | "halfCeil" | "halfFloor" | "halfExpand" | "halfTrunc" | "halfEven" | undefined
Rounding mode for number formatting, using the browser's Intl.NumberFormat, following the same rules as Intl.NumberFormat's roundingMode
label
Type: { visible?: boolean; labelColor?: string; labelFontSize?: number; labelFontWeight?: number; labelAngle?: number; } | undefined
X-axis tick label
visible
Type: boolean | undefined
Whether the label is visible
labelColor
Type: string | undefined
Label color
labelFontSize
Type: number | undefined
Label font size
labelFontWeight
Type: number | undefined
Label font weight
labelAngle
Type: number | undefined
Label rotation angle
line
Type: { visible?: boolean; lineColor?: string; lineWidth?: number; } | undefined
X-axis line
visible
Type: boolean | undefined
Whether the axis line is visible
lineColor
Type: string | undefined
Axis line color
lineWidth
Type: number | undefined
Axis line width
tick
Type: { visible?: boolean; tickInside?: boolean; tickColor?: string; tickSize?: number; } | undefined
X-axis tick
visible
Type: boolean | undefined
Whether the tick is visible
tickInside
Type: boolean | undefined
Whether the tick points inward
tickColor
Type: string | undefined
Tick color
tickSize
Type: number | undefined
Tick size
title
Type: { visible?: boolean; titleText?: string; titleColor?: string; titleFontSize?: number; titleFontWeight?: number; } | undefined
X-axis title
visible
Type: boolean | undefined
Whether the title is visible
titleText
Type: string | undefined
Title text, defaults to field configuration
titleColor
Type: string | undefined
Title color
titleFontSize
Type: number | undefined
Title font size
titleFontWeight
Type: number | undefined
Title font weight
grid
Type: { visible?: boolean; gridColor?: string; gridWidth?: number; gridLineDash?: number[]; } | undefined
X-axis grid line
visible
Type: boolean | undefined
gridColor
Type: string | undefined
Grid line color
gridWidth
Type: number | undefined
Grid line width
gridLineDash
Type: number[] | undefined
Grid line type
animation
Type: { duration?: number; easing?: string; } | undefined
Y-axis animation configuration
duration
Type: number | undefined
Animation duration
easing
Type: string | undefined
Animation easing function
yAxis
Type: YBandAxis | undefined
Y-axis; a category axis. Y-axis configuration used to define the chart's Y-axis, including its position, format, style, etc.
visible
Type: boolean | undefined
Whether the axis is visible
inverse
Type: boolean | undefined
Whether the axis is displayed in reverse; only effective for numeric axes
zero
Type: boolean | undefined
Whether to force display 0 on the axes; becomes invalid if min and max are configured. Only effective for numeric axes.
labelAutoHide
Type: boolean | undefined
Axis label automatic hiding; if two labels overlap (interval is less than autoHideGap), the overlapping labels are automatically hidden. Only effective for category axes.
labelAutoHideGap
Type: number | undefined
Axis label automatic hiding interval; if the interval between two labels is less than autoHideGap, the overlapping labels are automatically hidden. Only effective for category axes.
autoHide enabled: uses autoHideSeparation.
autoHide disabled: uses sampling, set on minGap.
labelAutoRotate
Type: boolean | undefined
Axis label automatic rotation; labels are automatically rotated when their width exceeds the axis length. Only effective for category axes.
labelAutoRotateAngleRange
Type: number[] | undefined
Axis label automatic rotation angle range; defines the rotation angle range when automatic rotation is enabled. Only effective for category axes.
labelAutoLimit
Type: boolean | undefined
Axis label automatic length limit; when label width exceeds the axis length, the excess is indicated by an ellipsis and becomes visible upon hovering. Only effective for category axes.
labelAutoLimitLength
Type: number | undefined
Axis label maximum length limit; when label text length exceeds the maximum, the excess is indicated by an ellipsis and becomes visible upon hovering. Only effective for category axes.
label
Type: { visible?: boolean; labelColor?: string; labelFontSize?: number; labelFontWeight?: number; labelAngle?: number; } | undefined
X-axis tick label
visible
Type: boolean | undefined
Whether the label is visible
labelColor
Type: string | undefined
Label color
labelFontSize
Type: number | undefined
Label font size
labelFontWeight
Type: number | undefined
Label font weight
labelAngle
Type: number | undefined
Label rotation angle
line
Type: { visible?: boolean; lineColor?: string; lineWidth?: number; } | undefined
X-axis line
visible
Type: boolean | undefined
Whether the axis line is visible
lineColor
Type: string | undefined
Axis line color
lineWidth
Type: number | undefined
Axis line width
tick
Type: { visible?: boolean; tickInside?: boolean; tickColor?: string; tickSize?: number; } | undefined
X-axis tick
visible
Type: boolean | undefined
Whether the tick is visible
tickInside
Type: boolean | undefined
Whether the tick points inward
tickColor
Type: string | undefined
Tick color
tickSize
Type: number | undefined
Tick size
title
Type: { visible?: boolean; titleText?: string; titleColor?: string; titleFontSize?: number; titleFontWeight?: number; } | undefined
X-axis title
visible
Type: boolean | undefined
Whether the title is visible
titleText
Type: string | undefined
Title text, defaults to field configuration
titleColor
Type: string | undefined
Title color
titleFontSize
Type: number | undefined
Title font size
titleFontWeight
Type: number | undefined
Title font weight
grid
Type: { visible?: boolean; gridColor?: string; gridWidth?: number; gridLineDash?: number[]; } | undefined
X-axis grid line
visible
Type: boolean | undefined
gridColor
Type: string | undefined
Grid line color
gridWidth
Type: number | undefined
Grid line width
gridLineDash
Type: number[] | undefined
Grid line type
animation
Type: { duration?: number; easing?: string; } | undefined
Y-axis animation configuration
duration
Type: number | undefined
Animation duration
easing
Type: string | undefined
Animation easing function
crosshairRect
Type: CrosshairRect | undefined
Horizontal tooltip configuration; used to define the chart's horizontal tooltip, including color and label style.
Crosshair rectangle configuration; a configuration type used to display a crosshair rectangle in the chart
visible
Type: boolean | undefined
Whether to show the crosshair rectangle
rectColor
Type: string | undefined
Crosshair rectangle color
labelColor
Type: string | undefined
Crosshair rectangle label color
labelVisible
Type: boolean | undefined
Whether to show the crosshair rectangle label
labelBackgroundColor
Type: string | undefined
Crosshair rectangle label background color
stackCornerRadius
Type: number | number[] | undefined
Bar chart stacking corner radius
barMaxWidth
Type: string | number | undefined
Maximum height of the rectangle; can be a pixel value or a percentage string
sort
Type: Sort | undefined
Y-axis sort configuration; supports sorting by dimensions or measures, and custom sort order.
Category axis sort configuration; supports sorting by dimensions or measures, and custom sort order.
Example sort: { orderBy: 'profit', order: 'asc', } sort: { customOrder:['2019', '2020', '2021'] }
- order:'asc' - orderBy:'date' or - customOrder:['2019', '2020', '2021']
order
Type: "asc" | "desc" | undefined
Sort order; can be 'asc' or 'desc'
Example order:'asc'
orderBy
Type: string | undefined
Field to sort by; can be a dimension ID or measure ID
Example - orderBy:'date' - orderBy:'profit'
customOrder
Type: string[] | undefined
Custom sort order; this order will be directly applied to the category axis
sortLegend
Type: SortLegend | undefined
Legend sort configuration; supports sorting by dimension or measure, as well as custom sort order.
Legend sort configuration; supports sorting by dimension or measure, as well as custom sort order.; sort arrays follow left-to-right or top-to-bottom order.
Example sortLegend: { orderBy: 'profit', order: 'asc', } sortLegend: { customOrder:['2019', '2020', '2021'] }
- order:'asc' - orderBy:'date' or - customOrder:['2019', '2020', '2021']
order
Type: "asc" | "desc" | undefined
Sort order; can be 'asc' or 'desc'
Example order:'asc'
orderBy
Type: string | undefined
Field to sort by; can be a dimension ID or measure ID
Example - orderBy:'date' - orderBy:'profit'
customOrder
Type: string[] | undefined
Custom sort order; this order will be directly applied to the legend. Ascending is from left-to-right or top-to-bottom, descending from right-to-left or bottom-to-top.
theme
Type: Theme | undefined
Chart theme; themes are lower-priority configurations containing general settings shared by all chart types as well as settings shared by specific chart categories.
Built-in light and dark themes; users can customize themes via the Builder.
Theme
Built-in light and dark themes; new themes can be customized via registerTheme.
Example 'dark'
'light'
'customThemeName'
length
Type: number
brand
Type: brand
barStyle
Type: BarStyle | BarStyle[] | undefined
Rectangle graphic element style
Bar chart style configuration; used to define bar chart styles, including color, borders, corner radius, etc.
Supports global styles or conditional style configurations.
Data filter
If a selector is configured, it provides four types of data matching capabilities: value selector, local data selector, conditional dimension selector, and conditional measure selector.
If no selector is configured, the style is applied globally.
selector
Type: Selector | Selectors | undefined
Data selector
If a selector is configured, it provides four types of data matching capabilities: value selector, local data selector, conditional dimension selector, and conditional measure selector.
If no selector is configured, the style is applied globally.
Example Value selector selector = "tool" selector = ["tool", "book"] selector = 100 selector = [100, 200]
Local data selector selector = { profit: 100 } selector = [{ profit: 100 }, { profit: 200 }]
Conditional dimension selector selector = { field: 'category', operator: 'in', value: 'tool' } selector = { field: 'category', operator: 'not in', value: 'book' }
Conditional measure selector selector = { field: 'profit', operator: '>=', value: 100 } selector = { field: 'profit', operator: 'between' value: [100, 300] }
field
Type: string
Dimension field; the ID of an item in dimensions
operator
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the value of the dimension field is in 'value'
- not in: Select data items where the value of the dimension field is not in 'value'
op
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the value of the dimension field is in 'value'
- not in: Select data items where the value of the dimension field is not in 'value'
Same as operator
value
Type: string | number | (string | number)[]
Select the value of the dimension field in the data item; supports arrays
dynamicFilter
Type: ChartDynamicFilter | undefined
Dynamic filter (AI-generated code execution)
Implement complex data filtering logic via AI-generated JavaScript code.
Suitable for Top N, statistical analysis, or complex conditions difficult to express with static selectors.
Core capabilities:
- Supports arbitrarily complex data filtering conditions
- Use built-in utility functions for data operations
- Safe execution in the browser environment (Web Worker sandbox)
Environment requirements: Only supports browser environments; Node.js environments will use the fallback
Note: selector and dynamicFilter cannot be used simultaneously; dynamicFilter has higher priority
Chart dynamic filter configuration
Implement filtering of chart marks (bars, points, etc.) via AI-generated JavaScript code.
type
Type: "row-with-field"
description
Type: string | undefined
Description of the user's filtering requirements (natural language)
Example "Highlight bars with sales greater than 1000"
"Highlight the bar with the highest profit rate in each region"
code
Type: string
AI-generated JavaScript filtering code
- Only built-in utility functions can be used (accessed via _ or R)
- Input parameters: data (array), each item contains a __row_index field representing the row number
- Must return an array of row index and field combinations: Array<{ __row_index: number, field: string }>
- __row_index represents the row number of the original data item, and field represents the field to be highlighted
- Prohibited: eval, Function, asynchronous operations, DOM API, network requests
Example Highlight the sales field for data items with sales greater than 1000
Highlight the data item with the highest profit rate in each region
Highlight data items filtered by multiple conditions
fallback
Type: Selector | Selectors | undefined
Fallback solution when code execution fails or the environment is not supported
field
Type: string
Dimension field; the ID of an item in dimensions
operator
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the value of the dimension field is in 'value'
- not in: Select data items where the value of the dimension field is not in 'value'
op
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the value of the dimension field is in 'value'
- not in: Select data items where the value of the dimension field is not in 'value'
same as operator
value
Type: string | number | (string | number)[]
Select the value of the dimension field in the data item; supports arrays
result
Type: DynamicFilterExecutionResult<RowWithFieldRes> | undefined
Dynamic filter execution result (runtime field)
Captured during the prepare() phase; read-only at runtime
success
Type: false | true
data
Type: T[] | undefined
error
Type: string | undefined
barVisible
Type: boolean | undefined
Whether the bar element (rectangle) is visible
barColor
Type: string | undefined
Bar element (rectangle) color
barColorOpacity
Type: number | undefined
Bar element (rectangle) opacity
barBorderColor
Type: string | undefined
Bar element (rectangle) border color
barBorderWidth
Type: number | undefined
Bar element (rectangle) border width
barBorderStyle
Type: "solid" | "dashed" | "dotted" | undefined
Bar element (rectangle) border style
Example solid
dashed
dotted
barBorderOpacity
Type: number | undefined
Bar element (rectangle) corner radius
Bar element (rectangle) stroke opacity
Example 4
[0, 0, 10, 10]
barRadius
Type: number | number[] | undefined
annotationPoint
Type: AnnotationPoint | AnnotationPoint[] | undefined
Annotation point
Annotation point configuration; defines points on the chart based on selected data, including their position, format, style, etc.
selector
Type: Selector | Selectors | undefined
Selector for the annotation point, used to select data points.
field
Type: string
Dimension field; the ID of an item in dimensions
operator
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the value of the dimension field is in 'value'
- not in: Select data items where the value of the dimension field is not in 'value'
op
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the value of the dimension field is in 'value'
- not in: Select data items where the value of the dimension field is not in 'value'
same as operator
value
Type: string | number | (string | number)[]
Select the value of the dimension field in the data item; supports arrays
dynamicFilter
Type: ChartDynamicFilter | undefined
Dynamic filter (AI-generated code execution)
Implement complex data filtering logic via AI-generated JavaScript code.
Suitable for Top N, statistical analysis, or complex conditions difficult to express with static selectors.
Core capabilities:
- Supports arbitrarily complex data filtering conditions
- Use built-in utility functions for data operations
- Safe execution in the browser environment (Web Worker sandbox)
Environment requirements: Only supports browser environments; Node.js environments will use the fallback
Note: selector and dynamicFilter cannot be used simultaneously; dynamicFilter has higher priority
Chart dynamic filter configuration
Implement filtering of chart marks (bars, points, etc.) via AI-generated JavaScript code.
type
Type: "row-with-field"
description
Type: string | undefined
Description of the user's filtering requirements (natural language)
Example "Highlight bars with sales greater than 1000"
"Highlight the bar with the highest profit rate in each region"
code
Type: string
AI-generated JavaScript filtering code
- Only built-in utility functions can be used (accessed via _ or R)
- Input parameters: data (array), each item contains a __row_index field representing the row number
- Must return an array of row index and field combinations: Array<{ __row_index: number, field: string }>
- __row_index represents the row number of the original data item, and field represents the field to be illuminated
- Prohibited: eval, Function, asynchronous operations, DOM API, network requests
Example Highlight the sales field for data items with sales greater than 1000
Highlight the data item with the highest profit rate in each region
Highlight data items filtered by multiple conditions
fallback
Type: Selector | Selectors | undefined
Fallback solution when code execution fails or the environment is not supported
field
Type: string
Dimension field; the ID of an item in dimensions
operator
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the value of the dimension field is in 'value'
- not in: Select data items where the value of the dimension field is not in 'value'
op
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the value of the dimension field is in 'value'
- not in: Select data items where the value of the dimension field is not in 'value'
same as operator
value
Type: string | number | (string | number)[]
Select the value of the dimension field in the data item; supports arrays
result
Type: DynamicFilterExecutionResult<RowWithFieldRes> | undefined
Dynamic filter execution result (runtime field)
Captured during the prepare() phase; read-only at runtime.
success
Type: false | true
data
Type: T[] | undefined
error
Type: string | undefined
text
Type: string | string[] | undefined
Annotation text
Example 'Annotation text'
textColor
Type: string | undefined
Text color
Example 'red'
textFontSize
Type: number | undefined
Text font size
Example 12
textFontWeight
Type: number | undefined
Text font weight
Example 400
textAlign
Type: "left" | "right" | "center" | undefined
Text alignment; generally set to 'right' so the text appears on the left of the point, ensuring visibility.
Recommended to set as 'right' to ensure the text is on the left of the point.
right: Text is on the left of the point; the right edge of the text aligns with the point.
left: Text is on the right of the point; the left edge of the text aligns with the point.
center: Text is centered on the point.
Example 'right' Text is on the left of the point
textBaseline
Type: "top" | "bottom" | "middle" | undefined
Text vertical alignment; generally set to 'top' so the text appears below the point, ensuring visibility within the chart area.
Recommended to set as 'top' to ensure the text is fully displayed within the chart area.
top: Text is at the bottom of the point; the top edge of the text aligns with the point.
middle: Text is centered on the point.
bottom: Text is at the top of the point; the bottom edge of the text aligns with the point.
Example 'top' Text is at the bottom of the point
textBackgroundVisible
Type: boolean | undefined
Background visible
Example true
textBackgroundColor
Type: string | undefined
Background color
Example 'red'
textBackgroundBorderColor
Type: string | undefined
Background border color
Example 'red'
textBackgroundBorderWidth
Type: number | undefined
Background border width
Example 2
textBackgroundBorderRadius
Type: number | undefined
Background border radius
Example 4
textBackgroundPadding
Type: number | undefined
Background padding
Example 4
offsetY
Type: number | undefined
The overall pixel offset of the annotation point in the Y direction. When the point is above the chart (higher values), it is recommended to set a positive value. When below (lower values), it is recommended to set a negative value.
A negative value shifts it upwards; for example, setting it to -10 shifts the entire annotation component (text, background) up by 10 pixels.
A positive value shifts it downwards; for example, setting it to 10 shifts the entire annotation component down by 10 pixels.
Example offsetY: 5, Annotation point overall offset down by 5 pixels
offsetX
Type: number | undefined
The overall pixel offset of the annotation point in the X direction. When the point is on the left of the chart (start of the category axis), it is recommended to set it to a positive value. When on the right (end of the category axis), it is recommended to set a negative value.
A negative value shifts it leftwards; for example, setting it to -10 shifts the entire annotation component (text, background) left by 10 pixels.
A positive value shifts it rightwards; for example, setting it to 10 shifts the entire annotation component right by 10 pixels.
Example offsetX: 5, Annotation point overall offset to the right by 5 pixels
annotationVerticalLine
Type: AnnotationVerticalLine | AnnotationVerticalLine[] | undefined
Annotation vertical line
Value annotation line (including mean, max, min, etc.); displayed vertically. Allows configuring the line's position and style; use this configuration to draw lines corresponding to values like the mean.
xValue
Type: string | number | (string | number)[] | undefined
Fixed X-value for the vertical annotation line; if the category axis is in the X direction, enter a dimension value; if the numeric axis is in the X direction, enter a specific value.
dynamicFilter
Type: ValueDynamicFilter | undefined
Dynamic filter (AI-generated code execution)
Calculate the annotation line value dynamically via AI-generated JavaScript code.
Suitable for scenarios requiring dynamic position determination based on data, such as mean, maximum, quantiles, or business lines.
Only supports browser environments (requires Web Worker).
type
Type: "value"
description
Type: string | undefined
Description of the user's filtering requirements (natural language)
Example "Get the highest sales value as the annotation line reference"
"Calculate average sales for the annotation line"
code
Type: string
AI-generated JavaScript filtering code
- Only built-in utility functions can be used (accessed via _ or R)
- Input parameters: data (array)
- Must return a single number or string: number | string
- Applicable scenarios: Dynamic values needed for annotation lines (horizontal or vertical)
- Prohibited: eval, Function, asynchronous operations, DOM API, network requests
Example Get the maximum sales value as the annotation line value
Calculate average for the annotation line
Get quantiles for the annotation line
Calculate goal value based on conditions
fallback
Type: string | number | undefined
Fallback solution when code execution fails or the environment is not supported
result
Type: { success: boolean; data?: number | string; } | undefined
Dynamic filter execution result (runtime field)
Captured during the prepare() phase; read-only at runtime.
success
Type: false | true
data
Type: string | number | undefined
text
Type: string | string[] | undefined
Annotation text
Example 'Annotation text'
textPosition
Type: "outsideStart" | "outsideEnd" | "outsideMiddle" | "insideStart" | "insideMiddle" | "insideEnd" | undefined
Text position; location of the annotation line's label (relative to the line).
Example 'outsideEnd'
textColor
Type: string | undefined
Text color
Example 'red'
textFontSize
Type: number | undefined
Text font size
Example 12
textFontWeight
Type: number | undefined
Text font weight
Example 400
textAlign
Type: "left" | "right" | "center" | undefined
Text alignment; generally unnecessary to set.
Recommended to set as 'right' to ensure text is on the left of the line.
right: Text is on the left of the reference line; the right edge of the text aligns with the (vertical) annotation line.
left: Text is on the right of the reference line; the left edge of the text aligns with the (vertical) annotation line.
center: Text is centered on the reference line; the center of the text aligns with the (vertical) annotation line.
Example 'right'
textBaseline
Type: "top" | "bottom" | "middle" | undefined
Text vertical alignment; generally unnecessary to set.
Recommended to set as 'top' to ensure the text is fully displayed within the chart area.
top: Text is at the bottom of the reference line; the top edge of the text aligns with the (vertical) annotation line's end.
middle: Text is centered on the reference line; the center of the text aligns with the (vertical) annotation line's end.
bottom: Text is at the top of the reference line; the bottom edge of the text aligns with the (vertical) annotation line's end.
Example 'top'
lineVisible
Type: boolean | undefined
Line visible
Example true
lineColor
Type: string | undefined
Line color
Example 'red'
lineWidth
Type: number | undefined
Line width
Example 2
lineStyle
Type: "solid" | "dashed" | "dotted" | undefined
Line style
Example 'solid'
textBackgroundVisible
Type: boolean | undefined
Background visible
Example true
textBackgroundColor
Type: string | undefined
Background color
Example 'red'
textBackgroundBorderColor
Type: string | undefined
Background border color
Example 'red'
textBackgroundBorderWidth
Type: number | undefined
Background border width
Example 2
textBackgroundBorderRadius
Type: number | undefined
Background border radius
Example 4
textBackgroundPadding
Type: number | undefined
Background padding
Example 4
annotationHorizontalLine
Type: AnnotationHorizontalLine | AnnotationHorizontalLine[] | undefined
Annotation horizontal line
Dimension value annotation line; displayed horizontally. Allows configuring the line's position and style.
yValue
Type: string | number | (string | number)[] | undefined
Fixed Y-value for the horizontal annotation line; if the category axis is in the Y direction, enter a dimension value; if the numeric axis is in the Y direction, enter a specific value.
dynamicFilter
Type: ValueDynamicFilter | undefined
Dynamic filter (AI-generated code execution)
Calculate the annotation line value dynamically via AI-generated JavaScript code.
Suitable for scenarios requiring dynamic position determination based on data, such as mean, maximum, quantiles, or business lines.
Only supports browser environments (requires Web Worker).
type
Type: "value"
description
Type: string | undefined
Description of the user's filtering requirements (natural language)
Example "Get the highest sales value as the annotation line reference"
"Calculate average sales for the annotation line"
code
Type: string
AI-generated JavaScript filtering code
- Only built-in utility functions can be used (accessed via _ or R)
- Input parameters: data (array)
- Must return a single number or string: number | string
- Applicable scenarios: Dynamic values needed for annotation lines (horizontal or vertical)
- Prohibited: eval, Function, asynchronous operations, DOM API, network requests
Example Get the maximum sales value as the annotation line value
Calculate average for the annotation line
Get quantiles for the annotation line
Calculate goal value based on conditions
fallback
Type: string | number | undefined
Fallback solution when code execution fails or the environment is not supported
result
Type: { success: boolean; data?: number | string; } | undefined
Dynamic filter execution result (runtime field)
Captured during the prepare() phase; read-only at runtime.
success
Type: false | true
data
Type: string | number | undefined
text
Type: string | string[] | undefined
Annotation text
Example 'Annotation text'
textPosition
Type: "outsideStart" | "outsideEnd" | "outsideMiddle" | "insideStart" | "insideMiddle" | "insideEnd" | undefined
Text position
Location of the annotation line's label (relative to the line).
Example 'outsideEnd'
textColor
Type: string | undefined
Text color
Example 'red'
textFontSize
Type: number | undefined
Text font size
Example 12
textFontWeight
Type: number | undefined
Text font weight
Example 400
textAlign
Type: "left" | "right" | "center" | undefined
Text alignment; generally unnecessary to set.
Recommended to set as 'right' to ensure the text is on the left of the line.
right: Text is on the left of the reference line; the right edge of the text aligns with the (horizontal) annotation line's end.
left: Text is on the right of the reference line; the left edge of the text aligns with the (horizontal) annotation line's end.
center: Text is centered on the reference line; the center of the text aligns with the (horizontal) annotation line's end.
Example 'right'
textBaseline
Type: "top" | "bottom" | "middle" | undefined
Text vertical alignment; generally unnecessary to set.
Recommended to set as 'top' to ensure the text is fully displayed within the chart area.
top: Text is at the bottom of the reference line; the top edge of the text aligns with the horizontal annotation line.
middle: Text is centered on the reference line; the center of the text aligns with the horizontal annotation line.
bottom: Text is at the top of the reference line; the bottom edge of the text aligns with the horizontal annotation line.
Example 'top'
textBackgroundVisible
Type: boolean | undefined
Background visible
Example true
textBackgroundColor
Type: string | undefined
Background color
Example 'red'
textBackgroundBorderColor
Type: string | undefined
Background border color
Example 'red'
textBackgroundBorderWidth
Type: number | undefined
Background border width
Background border width
Example 2
textBackgroundBorderRadius
Type: number | undefined
Background border radius
Example 4
textBackgroundPadding
Type: number | undefined
Background padding
Example 4
lineVisible
Type: boolean | undefined
Line visible
Line visible
Example true
lineColor
Type: string | undefined
Line color
Example 'red'
lineWidth
Type: number | undefined
Line width
Example 2
lineStyle
Type: "solid" | "dashed" | "dotted" | undefined
Line style
Example 'solid'
splitLine
Type: boolean | { positiveColor?: string; negativeColor?: string; } | undefined
Whether to enable splitting the main line into two segments.
positiveColor
Type: string | undefined
Primary color for parts greater than the annotation value
negativeColor
Type: string | undefined
Primary color for parts less than the annotation value
annotationArea
Type: AnnotationArea | AnnotationArea[] | undefined
Annotation area
Annotation area configuration; defines an area on the chart based on selected data, including its position, style, etc.
selector
Type: AreaSelector | AreaSelectors | undefined
Depends on selected data for area marking.
field
Type: string
Dimension field; the ID of an item in dimensions
operator
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the value of the dimension field is in 'value'
- not in: Select data items where the value of the dimension field is not in 'value'
op
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the value of the dimension field is in 'value'
- not in: Select data items where the value of the dimension field is not in 'value'
same as operator
value
Type: string | number | (string | number)[]
Select the value of the dimension field in the data item; supports arrays
text
Type: string | string[] | undefined
Annotation text
Example 'Annotation text'
textPosition
Type: "left" | "top" | "topLeft" | "topRight" | "right" | "bottom" | "bottomLeft" | "bottomRight" | undefined
Text position
Example 'top'
textColor
Type: string | undefined
Text color
Example 'red'
textFontSize
Type: number | undefined
Text font size
Example 12
textFontWeight
Type: number | undefined
Text font weight
Example 400
textAlign
Type: "left" | "right" | "center" | undefined
Text alignment; generally set to 'right' so the text appears in the middle of the area, ensuring visibility.
Recommended to set as 'center' to ensure the text is in the middle of the area.
right: Text is on the left of the area; the right edge of the text aligns with the area.
left: Text is on the right of the area; the left edge of the text aligns with the area.
center: Text is centered in the area.
Example 'center' Text is in the middle of the annotation area.
textBaseline
Type: "top" | "bottom" | "middle" | undefined
Text vertical alignment; generally set to 'top' so the text appears at the bottom of the area, ensuring visibility.
Recommended to set as 'top' to ensure the text is fully displayed within the chart area.
top: Text is at the bottom of the area; the top edge of the text aligns with the area.
middle: Text is centered in the area.
bottom: Text is at the top of the area; the bottom edge of the text aligns with the area.
Example 'top' Text is at the bottom of the annotation area.
textBackgroundVisible
Type: boolean | undefined
Background visible
Example true
textBackgroundColor
Type: string | undefined
Background color
Example 'red'
textBackgroundBorderColor
Type: string | undefined
Background border color
Background border color
Example 'red'
textBackgroundBorderWidth
Type: number | undefined
Background border width
Example 2
textBackgroundBorderRadius
Type: number | undefined
Background border radius
Background border radius
Example 4
textBackgroundPadding
Type: number | undefined
Background padding
Example 4
areaColor
Type: string | undefined
Annotation area color
Example 'red'
areaColorOpacity
Type: number | undefined
Annotation area opacity
Example 0.5
areaBorderColor
Type: string | undefined
Annotation area border color
Example 'red'
areaBorderWidth
Type: number | undefined
Annotation area border width
Example 2
areaBorderRadius
Type: number | undefined
Annotation area border radius
Example 4
areaLineDash
Type: number[] | undefined
Annotation area border line style
Example [2, 2]
outerPadding
Type: number | undefined
Annotation area padding
Example 0
dimensionLinkage
Type: DimensionLinkage | undefined
Whether to enable the dimension linkage feature when pivot charts or measure combinations are used.
When hovering over a dimension value, dynamically highlight data with the same dimension value in other charts.
Pivot chart dimension linkage configuration
enable
Type: false | true
Whether to enable pivot chart dimension linkage
showTooltip
Type: boolean | undefined
Whether to show tooltips for all child charts corresponding to the dimension
showLabel
Type: boolean | undefined
Whether to show the corresponding crosshair label
locale
Type: Locale | undefined
Locale
Chart locale configuration; supports 'zh-CN' and 'en-US'. You can also call intl.setLocale('zh-CN') to set the language.