Area
- Recommended field configuration: 1 measure(s), 2 dimension(s)
- Supports Data Reshape: at least1 measure(s), 0 dimension(s)
The Area Chart supports the following visual channels:
xAxis : x-axis channel, supportsmultiple dimensions, mapped to the x-axis by dimension value
yAxis : y-axis channel, supportsmultiple measures, mapped to the y-axis by measure value
color : color channel, supportsmultiple dimensionsor 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, supportsmultiple dimensions and multiple measures, displayed when hovering over a data point
label : label channel, supportsmultiple dimensions and multiple measures, displays data labels on data points
Area Chart, suitable for showing data trends over time and cumulative relationships, with filled areas enhancing data comparison. The X-axis is a categorical axis (categorical data), and the Y-axis is a numeric axis (continuous data).
Applicable scenarios:
- Show trend changes in a single data series
- Emphasize the cumulative effect of totals over time
- Compare total differences across multiple data series
Data requirements:
- At least 1 measure field
- The first dimension field is mapped to the X-axis; remaining dimension fields are merged with measure names (when multiple measures exist) and displayed as legend items.
- All measures are automatically merged into one measure
Features enabled by default:
- Stacking enabled by default
- Legend, axes, area fill, data labels, and tooltips are enabled by default
chartType
Type: "area"
Area Chart, Chart type for displaying data trends and cumulative relationships
Example
dataset
Type: Record[]
Dataset
A TidyData-compliant, pre-aggregated dataset defining the chart's data source and structure. Users do not need to manually process input data — VSeed's powerful Data Reshape capability handles it automatically. Area Chart data is ultimately reshaped to 2 dimensions and 1 measure.
Example [{month:'Jan', value:100}, {month:'Feb', value:150}, {month:'Mar', value:120}]
dimensions
Type: ColumnDimension[] | undefined
Dimensions
The first dimension is mapped to the X-axis; the remaining dimensions are merged with measure names (when multiple measures exist) and displayed as legend items.
Example [{ id: 'month', alias: 'Month' }, { id: 'year', alias: 'Year' }]
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: "xAxis" | "color" | "detail" | "tooltip" | "label" | "row" | "column" | undefined
Channel to which the dimension is mapped
- xAxis: supports mapping multiple dimensions to the x-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: ColumnMeasure[] | undefined
Measures
Area Chart measures are automatically merged into one measure, mapped to the Y-axis. Measure names are merged with the remaining dimensions and displayed as legend items.
Example [{id: 'value', alias: 'Value'}]
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: "color" | "detail" | "tooltip" | "label" | "yAxis" | undefined
Channel to which the measure is mapped
- yAxis: measure mapped to the y-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
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
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
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 measure values in percentage
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 automatically inverts font color based on element color
labelPosition
Type: "inside" | "outside" | undefined
label position
labelOverlap
Type: boolean | undefined
Whether the label anti-overlap function is enabled
selector
Type: Selector | Selectors | undefined
Label filtering, default relationship between selectors is 'Or'
field
Type: string
Dimension field, the ID of a dimension item
operator
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the dimension field value is in 'value'
- not in: Select data items where the dimension field value is not in 'value'
op
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the dimension field value is in 'value'
- not in: Select data items where the dimension field value is not in 'value'
same as operator
value
Type: string | number | (string | number)[]
Select data items based on dimension values, supports arrays
dynamicFilter
Type: ChartDynamicFilter | undefined
Dynamic filter (AI-generated code execution)
Implement complex data filtering logic via AI-generated JavaScript code
Key Capabilities:
- Supports any complex data filtering conditions
- Use built-in utility functions for data manipulation
- Secure execution in browser environment (Web Worker sandbox)
Environment requirements: Only supports browser environment; Node.js environment will use fallback
Note: selector and dynamicFilter cannot be used simultaneously; dynamicFilter has higher priority
Chart dynamic filter configuration
Filter chart markers (bars, points, etc.) via AI-generated JavaScript code
type
Type: "row-with-field"
description
Type: string | undefined
User requirement description (natural language)
Example "Highlight columns with sales greater than 1000"
"Highlight the column with the highest profit margin in each region"
code
Type: string
AI-generated JavaScript filtering code
- Only built-in utility functions (accessible via _ or R) are allowed
- 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 original row number; field represents the field to highlight
- Forbidden to use: 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 margin in each region
Highlight data items filtered by multiple conditions
fallback
Type: Selector | Selectors | undefined
Fallback plan when code execution fails or environment is not supported
field
Type: string
Dimension field, the ID of a dimension item
operator
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the dimension field value is in 'value'
- not in: Select data items where the dimension field value is not in 'value'
op
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the dimension field value is in 'value'
- not in: Select data items where the dimension field value is not in 'value'
same as operator
value
Type: string | number | (string | number)[]
Select data items based on dimension values, supports arrays
result
Type: DynamicFilterExecutionResult<RowWithFieldRes> | undefined
Dynamic filter execution results (runtime field)
Populated during the prepare() stage, read-only at runtime
success
Type: false | true
data
Type: T[] | undefined
error
Type: string | undefined
legend
Type: Legend | undefined
legend
Legend configuration, used to define chart legends, including position, format, style, etc.
enable
Type: boolean | undefined
Whether the legend function 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 when many legend items exist
If position is horizontal (bottom, bottomLeft, bottomRight, bl, br, top, topLeft, topRight, tl, tr), maxSize controls the number of columns.
If position is vertical (left, leftTop, leftBottom, lt, lb, right, rightTop, rightBottom, rt, rb), maxSize controls the number of rows.
Only effective for discrete legends
Example maxSize: 2
tooltip
Type: Tooltip | undefined
tooltips
Tooltip configuration, used to define chart tooltips, including position, format, style, etc.
enable
Type: false | true
Whether the tooltip function is enabled
brush
Type: Brush | undefined
Brush Selection
Brush configuration, used to enable/disable brush selection capability
Chart brush selection configuration
enable
Type: boolean | undefined
Whether to enable brush selection
brushType
Type: "rect" | "x" | "y" | "polygon" | undefined
brush type
Define the shape and direction of the brush selection box
- rect: Rectangular brush, allows simultaneous selection on X and Y axes
- polygon: Polygonal brush, creates custom polygons by clicking points
- x: X-axis brush, restricts selection to the X-axis
- y: Y-axis brush, restricts selection to the Y-axis
brushMode
Type: "single" | "multiple" | undefined
Brush mode, single or multiple selection
Define the selection mode
- single: Single selection mode, only one brush box allowed at a time
- multiple: Multiple selection mode, multiple brush boxes can exist simultaneously
removeOnClick
Type: boolean | undefined
Whether to clear the selection box when selection ends
inBrushStyle
Type: { opacity?: number; stroke?: string; lineWidth?: number; } | undefined
Style for selected data items
Define the style for data points within the brush
opacity
Type: number | undefined
Opacity
Opacity of selected data points, range 0-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
Define the style for data points outside the brush
opacity
Type: number | undefined
Opacity
Opacity of unselected data points, range 0-1
stroke
Type: string | undefined
Stroke color
lineWidth
Type: number | undefined
Stroke width
xAxis
Type: XBandAxis | undefined
X-axis
Category axis, X-axis configuration, used to define the X-axis including position, format, style, etc.
visible
Type: boolean | undefined
Whether the axis is visible
inverse
Type: boolean | undefined
Whether the axis is reversed, only effective for numeric axes
zero
Type: boolean | undefined
Whether to force display of 0 on the axis; this is ignored if min and max are set and is only effective for numeric axes.
labelAutoHide
Type: boolean | undefined
Axis label auto-hide; if two labels overlap, the overlapping label is hidden. Only effective for category axes.
labelAutoHideGap
Type: number | undefined
Axis label auto-hide interval; if the interval between two labels is less than autoHideGap, the overlapping label is hidden. Only effective for category axes.
autoHide enabled: uses autoHideGap
autoHide disabled: uses sampling with minGap
labelAutoRotate
Type: boolean | undefined
Axis label auto-rotate; if the label width exceeds the axis length, it rotates automatically. Only effective for category axes.
labelAutoRotateAngleRange
Type: number[] | undefined
Axis label auto-rotate angle range; the range of rotation angles if auto-rotate is enabled. Only effective for category axes.
labelAutoLimit
Type: boolean | undefined
Axis label auto-limit; if the label exceeds the axis length, it is truncated with an ellipsis and shown fully on hover. Only effective for category axes.
labelAutoLimitLength
Type: number | undefined
Axis label auto-limit maximum length; if the label text length exceeds this value, it is truncated with an ellipsis and shown fully on hover. 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 is oriented 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 the 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
X-axis animation configuration
duration
Type: number | undefined
Animation duration
easing
Type: string | undefined
Animation easing function
yAxis
Type: YLinearAxis | undefined
Y-axis
Numeric axis, Y-axis configuration, used to define the Y-axis including position, format, style, etc.
visible
Type: boolean | undefined
Whether the axis is visible
min
Type: number | undefined
The minimum value of the axis, takes priority over 'nice' and 'zero'
max
Type: number | boolean | undefined
The maximum value of the axis, takes priority over 'nice' and 'zero'; if true, it 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 labels more readable; this is ignored if min and max are set and is only effective for numeric axes.
inverse
Type: boolean | undefined
Whether the axis is reversed, only effective for numeric axes
zero
Type: boolean | undefined
Whether to force display of 0 on the axis; this is ignored if min and max are set and is only effective for numeric axes.
autoFormat
Type: boolean | undefined
Whether to automatically format axis tick labels; only effective for numeric axes. If autoFormat is true, numFormat configuration is ignored.
numFormat
Type: NumFormat | undefined
Numeric axis number formatting; only effective for numeric axes and has 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
Axis tick label
visible
Type: boolean | undefined
Whether the label is visible
labelColor
Type: string | undefined
LabelColor
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
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
Axis tick
visible
Type: boolean | undefined
Whether the tick is visible
tickInside
Type: boolean | undefined
Whether the tick is oriented 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
Axis title
visible
Type: boolean | undefined
Whether the title is visible
titleText
Type: string | undefined
Title text, defaults to the 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
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 dash type
animation
Type: { duration?: number; easing?: string; } | undefined
Axis animation configuration
duration
Type: number | undefined
Animation duration
easing
Type: string | undefined
Animation easing function
crosshairLine
Type: CrosshairLine | undefined
Vertical indicator line
Vertical indicator line displayed when hovering over the chart
Crosshair configuration, used for displaying crosshair lines (indicator lines) on the chart
visible
Type: boolean | undefined
Whether to display crosshairs
lineColor
Type: string | undefined
Crosshair line color
labelColor
Type: string | undefined
Crosshair label color
labelVisible
Type: boolean | undefined
Whether to display the crosshair label
labelBackgroundColor
Type: string | undefined
Crosshair label background color
sort
Type: Sort | undefined
X-axis sort configuration, supports sorting by dimensions or measures, as well as custom sort order.
Category axis sort configuration, supports sorting by dimensions or measures, as well as 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, supports 'asc' or 'desc'
Example order:'asc'
orderBy
Type: string | undefined
The field the sort depends on; can be a dimension ID or measure ID
Example - orderBy:'date' - orderBy:'profit'
customOrder
Type: string[] | undefined
Custom sort order, applied directly to the category axis
sortLegend
Type: SortLegend | undefined
Legend sort configuration, supports sorting by dimensions or measures, as well as custom sort order.
Legend sort configuration, supports sorting by dimensions or measures, as well as custom sort order; the sort array follows top-to-bottom or left-to-right 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, supports 'asc' or 'desc'
Example order:'asc'
orderBy
Type: string | undefined
The field the sort depends on; can be a dimension ID or measure ID
Example - orderBy:'date' - orderBy:'profit'
customOrder
Type: string[] | undefined
Custom sort order applied directly to the legend; ascending from left-to-right or top-to-bottom, descending from right-to-left or bottom-to-top.
theme
Type: Theme | undefined
Chart theme; theme is a lower-priority configuration that includes common styles shared across all chart types, as well as chart-specific configurations shared across a single category.
Built-in light and dark themes; users can define custom themes via the Builder.
Theme
Built-in light and dark themes; new themes can be registered via registerTheme.
Example 'dark'
'light'
'customThemeName'
length
Type: number
brand
Type: brand
pointStyle
Type: PointStyle | PointStyle[] | undefined
Point element style configuration, used to define the style for chart point elements, including colors, borders, etc.
Supports global styles or conditional style configurations.
Data filter.
If a selector is configured, it provides four types of data matching: numeric selector, partial data selector, conditional dimension selector, and conditional measure selector.
If no selector is configured, the style applies globally.
selector
Type: Selector | Selectors | undefined
Data selector
If a selector is configured, it provides four types of data matching: numeric selector, partial data selector, conditional dimension selector, and conditional measure selector.
If no selector is configured, the style applies globally.
Example Numeric selector selector = "tool" selector = ["tool", "book"] selector = 100 selector = [100, 200]
Partial 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 a dimension item
operator
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the dimension field value is in 'value'
- not in: Select data items where the dimension field value is not in 'value'
op
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the dimension field value is in 'value'
- not in: Select data items where the dimension field value is not in 'value'
same as operator
value
Type: string | number | (string | number)[]
Select dimension values; 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, complex conditions, and other scenarios that are hard to express with static selectors.
Core capabilities:
- Supports any complex data filtering conditions
- Uses built-in utility functions for data manipulation
- Safely executed in the browser environment (Web Worker sandbox)
Environment requirements: Only supports browser environment; Node.js environment will use fallback.
Note: selector and dynamicFilter cannot be used simultaneously; dynamicFilter has higher priority.
Chart dynamic filter configuration.
Implementation of filtering for chart markers (columns, points, etc.) via AI-generated JavaScript code.
type
Type: "row-with-field"
description
Type: string | undefined
User requirement description (natural language)
Example "Highlight columns with sales greater than 1000"
"Highlight the column with the highest profit margin in each region"
code
Type: string
AI-generated JavaScript filtering code
- Only built-in utility functions (accessible via _ or R) are allowed
- 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 original row number; field represents the field to highlight
- Forbidden to use: 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 margin in each region
Highlight data items filtered by multiple conditions
fallback
Type: Selector | Selectors | undefined
Fallback plan when code execution fails or environment is not supported
field
Type: string
Dimension field, the ID of a dimension item
operator
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the dimension field value is in 'value'
- not in: Select data items where the dimension field value is not in 'value'
op
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the dimension field value is in 'value'
- not in: Select data items where the dimension field value is not in 'value'
same as operator
value
Type: string | number | (string | number)[]
Select dimension values; supports arrays
result
Type: DynamicFilterExecutionResult<RowWithFieldRes> | undefined
Dynamic filter execution results (runtime field)
Populated during the prepare() stage, read-only at runtime
success
Type: false | true
data
Type: T[] | undefined
error
Type: string | undefined
pointVisible
Type: boolean | undefined
Whether the point is visible
pointSize
Type: number | undefined
Point size
pointColor
Type: string | undefined
Point element color
pointColorOpacity
Type: number | undefined
Point element opacity
pointBorderColor
Type: string | undefined
Point element border color
pointBorderWidth
Type: number | undefined
Point element border width
pointBorderStyle
Type: "solid" | "dashed" | "dotted" | undefined
Point element border style
Example solid
dashed
dotted
lineStyle
Type: LineStyle | LineStyle[] | undefined
Line element style configuration, used to define the style for chart line elements, including colors, opacity, curves, etc.
Supports global styles or conditional style configurations.
Data filter.
If a selector is configured, it provides four types of data matching: numeric selector, partial data selector, conditional dimension selector, and conditional measure selector.
If no selector is configured, the style applies globally.
selector
Type: Selector | Selectors | undefined
Data selector
If a selector is configured, it provides four types of data matching: numeric selector, partial data selector, conditional dimension selector, and conditional measure selector.
If no selector is configured, the style applies globally.
Example Numeric selector selector = "tool" selector = ["tool", "book"] selector = 100 selector = [100, 200]
Partial 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 a dimension item
operator
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the dimension field value is in 'value'
- not in: Select data items where the dimension field value is not in 'value'
op
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the dimension field value is in 'value'
- not in: Select data items where the dimension field value is not in 'value'
same as operator
value
Type: string | number | (string | number)[]
Select dimension values; 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, complex conditions, and other scenarios that are hard to express with static selectors.
Key Capabilities:
- Supports any complex data filtering conditions
- Use built-in utility functions for data manipulation
- Secure execution in browser environment (Web Worker sandbox)
Environment requirements: Only supports browser environment; Node.js environment will use fallback
Note: selector and dynamicFilter cannot be used simultaneously; dynamicFilter has higher priority
Chart dynamic filter configuration
Filter chart markers (bars, points, etc.) via AI-generated JavaScript code
type
Type: "row-with-field"
description
Type: string | undefined
User requirement description (natural language)
Example "Highlight columns with sales greater than 1000"
"Highlight the column with the highest profit margin in each region"
code
Type: string
AI-generated JavaScript filtering code
- Only built-in utility functions (accessible via _ or R) are allowed
- 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 original row number; field represents the field to highlight
- Forbidden to use: 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 margin in each region
Highlight data items filtered by multiple conditions
fallback
Type: Selector | Selectors | undefined
Fallback plan when code execution fails or environment is not supported
field
Type: string
Dimension field, the ID of a dimension item
operator
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the dimension field value is in 'value'
- not in: Select data items where the dimension field value is not in 'value'
op
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the dimension field value is in 'value'
- not in: Select data items where the dimension field value is not in 'value'
same as operator
value
Type: string | number | (string | number)[]
Select dimension values; supports arrays
result
Type: DynamicFilterExecutionResult<RowWithFieldRes> | undefined
Dynamic filter execution results (runtime field)
Populated during the prepare() stage, read-only at runtime
success
Type: false | true
data
Type: T[] | undefined
error
Type: string | undefined
lineVisible
Type: boolean | undefined
Whether the line segment is visible
lineSmooth
Type: boolean | undefined
Whether the line segment is smooth
lineColor
Type: string | undefined
Line segment color
lineColorOpacity
Type: number | undefined
Line segment opacity
lineWidth
Type: number | undefined
Line segment width
areaStyle
Type: AreaStyle | AreaStyle[] | undefined
Area element style configuration, used to define the style for chart area elements, including colors, opacity, borders, etc.
Supports global styles or conditional style configurations.
Data filter.
If a selector is configured, it provides four types of data matching: numeric selector, partial data selector, conditional dimension selector, and conditional measure selector.
If no selector is configured, the style applies globally.
selector
Type: Selector | Selectors | undefined
Data selector
If a selector is configured, it provides four types of data matching: numeric selector, partial data selector, conditional dimension selector, and conditional measure selector.
If no selector is configured, the style applies globally.
Example Numeric selector selector = "tool" selector = ["tool", "book"] selector = 100 selector = [100, 200]
Partial 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 a dimension item
operator
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the dimension field value is in 'value'
- not in: Select data items where the dimension field value is not in 'value'
op
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the dimension field value is in 'value'
- not in: Select data items where the dimension field value is not in 'value'
same as operator
value
Type: string | number | (string | number)[]
Select dimension values; 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, complex conditions, and other scenarios that are hard to express with static selectors.
Key Capabilities:
- Supports any complex data filtering conditions
- Use built-in utility functions for data manipulation
- Secure execution in browser environment (Web Worker sandbox)
Environment requirements: Only supports browser environment; Node.js environment will use fallback
Note: selector and dynamicFilter cannot be used simultaneously; dynamicFilter has higher priority
Chart dynamic filter configuration
Filter chart markers (bars, points, etc.) via AI-generated JavaScript code
type
Type: "row-with-field"
description
Type: string | undefined
User requirement description (natural language)
"Highlight columns with sales greater than 1000"
"Highlight the column with the highest profit margin in each region"
code
Type: string
AI-generated JavaScript filtering code
- Only built-in utility functions (accessible via _ or R) are allowed
- 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 original row number; field represents the field to highlight
- Forbidden to use: 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 margin in each region
Highlight data items filtered by multiple conditions
fallback
Type: Selector | Selectors | undefined
Fallback plan when code execution fails or environment is not supported
field
Type: string
Dimension field, the ID of a dimension item
operator
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the dimension field value is in 'value'
- not in: Select data items where the dimension field value is not in 'value'
op
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the dimension field value is in 'value'
- not in: Select data items where the dimension field value is not in 'value'
same as operator
value
Type: string | number | (string | number)[]
Select dimension values; supports arrays
result
Type: DynamicFilterExecutionResult<RowWithFieldRes> | undefined
Dynamic filter execution results (runtime field)
Populated during the prepare() stage, read-only at runtime
success
Type: false | true
data
Type: T[] | undefined
error
Type: string | undefined
areaVisible
Type: boolean | undefined
Whether the area element is visible
areaColor
Type: string | undefined
Color of the area element
areaColorOpacity
Type: number | undefined
Opacity of the area element color
annotationPoint
Type: AnnotationPoint | AnnotationPoint[] | undefined
MarkPoint configuration; according to the selected data, defines the annotation points in the chart, including position, format, style, etc.
selector
Type: Selector | Selectors | undefined
MarkPoint selector, used to select data points.
field
Type: string
Dimension field, the ID of a dimension item
operator
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the dimension field value is in 'value'
- not in: Select data items where the dimension field value is not in 'value'
op
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the dimension field value is in 'value'
- not in: Select data items where the dimension field value is not in 'value'
same as operator
value
Type: string | number | (string | number)[]
Select dimension values; 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, complex conditions, and other scenarios that are hard to express with static selectors.
Key Capabilities:
- Supports any complex data filtering conditions
- Use built-in utility functions for data manipulation
- Secure execution in browser environment (Web Worker sandbox)
Environment requirements: Only supports browser environment; Node.js environment will use fallback
Note: selector and dynamicFilter cannot be used simultaneously; dynamicFilter has higher priority
Chart dynamic filter configuration
Filter chart markers (bars, points, etc.) via AI-generated JavaScript code
type
Type: "row-with-field"
description
Type: string | undefined
User requirement description (natural language)
Example "Highlight columns with sales greater than 1000"
"Highlight the column with the highest profit margin in each region"
code
Type: string
AI-generated JavaScript filtering code
- Only built-in utility functions (accessible via _ or R) are allowed
- 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 original row number; field represents the field to highlight
- Forbidden to use: 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 margin in each region
Highlight data items filtered by multiple conditions
fallback
Type: Selector | Selectors | undefined
Fallback plan when code execution fails or environment is not supported
field
Type: string
Dimension field, the ID of a dimension item
operator
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the dimension field value is in 'value'
- not in: Select data items where the dimension field value is not in 'value'
op
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the dimension field value is in 'value'
- not in: Select data items where the dimension field value is not in 'value'
same as operator
value
Type: string | number | (string | number)[]
Select dimension values; supports arrays
result
Type: DynamicFilterExecutionResult<RowWithFieldRes> | undefined
Dynamic filter execution results (runtime field)
Populated during the prepare() stage, 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' to ensure the text is displayed on the left of the mark point and within the visible area of the chart.
Recommended to set to 'right' to ensure the text is on the left of the mark point.
right: Text is on the left of the mark point, aligned to the mark point by its right edge.
left: Text is on the right of the mark point, aligned to the mark point by its left edge.
center: Text is centered on the mark point.
Example 'right' Text is on the left of the mark point
textBaseline
Type: "top" | "bottom" | "middle" | undefined
Text vertical alignment; generally set to 'top' to ensure the text is displayed below the mark point and within the visible area.
Recommended to set to 'top' to ensure the text is displayed completely within the visible area.
top: Text is below the mark point, its top edge aligned with the mark point.
middle: Text is vertically centered on the mark point.
bottom: Text is above the mark point, its bottom edge aligned with the mark point.
Example 'top' Text is below the mark 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
Vertical offset distance of the annotation point. When the point is above the chart (high values), a positive value is recommended; when below (low values), a negative value is recommended.
A negative value offsets it upward (e.g., -10 pixels).
A positive value offsets it downward (e.g., 10 pixels).
Example offsetY: 5, MarkPoint offset down by 5 pixels
offsetX
Type: number | undefined
Horizontal offset distance of the annotation point. When the point is at the left (category axis start), a positive value is recommended; when at the right (category axis end), a negative value is recommended.
A negative value offsets it to the left (e.g., -10 pixels).
A positive value offsets it to the right (e.g., 10 pixels).
Example offsetX: 5, MarkPoint offset right by 5 pixels
annotationVerticalLine
Type: AnnotationVerticalLine | AnnotationVerticalLine[] | undefined
Dimension value mark line, displayed vertically; allows setting the position and style of the mark line.
xValue
Type: string | number | (string | number)[] | undefined
Fixed x-value for vertical mark lines; if the category axis is on the x-direction, you can enter a dimension value; if it's a numeric axis, enter a specific number.
dynamicFilter
Type: ValueDynamicFilter | undefined
Dynamic filter (AI-generated code execution)
Calculate mark line value via AI-generated JavaScript code.
Suitable for cases where mark line positions need to be determined dynamically based on data, such as mean, maximum, quantile, business lines, etc.
Only supports browser environment (requires Web Worker).
type
Type: "value"
description
Type: string | undefined
User requirement description (natural language)
Example "Get the highest sales value as mark line reference"
"Calculate average sales for mark line"
code
Type: string
AI-generated JavaScript filtering code
- Only built-in utility functions (accessible via _ or R) are allowed
- Input parameters: data (array)
- Must return a single numeric or string value: number | string
- Applicable scenario: Dynamic values needed for mark lines (horizontal lines, vertical lines)
- Forbidden to use: eval, Function, asynchronous operations, DOM API, network requests
Example Get the highest sales value as mark line value
Calculate average value for mark line
Get quantile for mark line
Calculate Goal value based on conditions
fallback
Type: string | number | undefined
Fallback plan when code execution fails or environment is not supported
result
Type: { success: boolean; data?: number | string; } | undefined
Dynamic filter execution results (runtime field)
Populated during the prepare() stage, 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, MarkLine's label position (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 no need to set.
Recommended to set to 'right' to ensure the text is on the left of the mark line.
right: Text is on the left of the reference line, its right edge aligned with the (vertical) mark line.
left: Text is on the right of the reference line, its left edge aligned with the (vertical) mark line.
center: Text is centered on the reference line.
Example 'right'
textBaseline
Type: "top" | "bottom" | "middle" | undefined
Text vertical alignment; generally no need to set.
Recommended to set to 'top' to ensure the text is displayed completely within the visible area.
top: Text is below the reference line, aligned to the endpoint of the (vertical) mark line by its top edge.
middle: Text is centered horizontally relative to the endpoint of the (vertical) mark line.
bottom: Text is above the reference line, aligned to the endpoint of the (vertical) mark line by its bottom edge.
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
Numeric mark line (including mean, maximum, minimum, etc.), displayed horizontally. Allows setting the position and style of the mark line. Use this configuration if you need to draw mark lines corresponding to specific values like the mean.
yValue
Type: string | number | (string | number)[] | undefined
Fixed y-value for horizontal mark lines; if the category axis is on the y-direction, you can enter a dimension value; if it's a numeric axis, enter a specific number.
dynamicFilter
Type: ValueDynamicFilter | undefined
Dynamic filter (AI-generated code execution)
Calculate mark line value via AI-generated JavaScript code.
Suitable for cases where mark line positions need to be determined dynamically based on data, such as mean, maximum, quantile, business lines, etc.
Only supports browser environment (requires Web Worker).
type
Type: "value"
description
Type: string | undefined
User requirement description (natural language)
Example "Get the highest sales value as mark line reference"
"Calculate average sales for mark line"
code
Type: string
AI-generated JavaScript filtering code
- Only built-in utility functions (accessible via _ or R) are allowed
- Input parameters: data (array)
- Must return a single numeric or string value: number | string
- Applicable scenario: Dynamic values needed for mark lines (horizontal lines, vertical lines)
- Forbidden to use: eval, Function, asynchronous operations, DOM API, network requests
Example Get the highest sales value as mark line value
Calculate average value for mark line
Get quantile for mark line
Calculate Goal value based on conditions
fallback
Type: string | number | undefined
Fallback plan when code execution fails or environment is not supported
result
Type: { success: boolean; data?: number | string; } | undefined
Dynamic filter execution results (runtime field)
Populated during the prepare() stage, 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
MarkLine's label position (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 no need to set.
Recommended to set to 'right' to ensure the text is on the left of the mark line.
right: Text is on the left of the reference line, its right edge aligned (horizontally) with the endpoint of the mark line.
left: Text is on the right of the reference line, its left edge aligned (horizontally) with the endpoint of the mark line.
center: Text is centered (horizontally) relative to the endpoint of the mark line.
Example 'right'
textBaseline
Type: "top" | "bottom" | "middle" | undefined
Text vertical alignment; generally no need to set.
Recommended to set to 'top' to ensure the text is displayed completely within the visible area of the chart.
top: Text is below the reference line, its top edge aligned (horizontally) with the mark line.
middle: Text is centered (horizontally) relative to the mark line.
bottom: Text is above the reference line, its bottom edge aligned (horizontally) with the mark 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
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
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 the function to split the main line into two segments.
positiveColor
Type: string | undefined
Main color for the portion greater than the mark value
negativeColor
Type: string | undefined
Main color for parts less than the mark value
annotationArea
Type: AnnotationArea | AnnotationArea[] | undefined
Mark area
Mark area configuration, according to the selected data, defines the annotation areas in the chart, including position and style.
selector
Type: AreaSelector | AreaSelectors | undefined
Depends on the selected data for marking.
field
Type: string
Dimension field, the ID of a dimension item
operator
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the dimension field value is in 'value'
- not in: Select data items where the dimension field value is not in 'value'
op
Type: "in" | "not in" | undefined
Operator
- in: Select data items where the dimension field value is in 'value'
- not in: Select data items where the dimension field value is not in 'value'
same as operator
value
Type: string | number | (string | number)[]
Select dimension values; 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' to ensure the text is displayed in the middle of the mark area and within the visible range.
Recommended to set to 'center' to ensure the text is in the center of the mark area.
right: Text is on the left of the mark area, its right edge aligned with the area.
left: Text is on the right of the mark area, its left edge aligned with the area.
center: Text is centered within the mark area.
Example 'center' Text is in the middle of the mark area
textBaseline
Type: "top" | "bottom" | "middle" | undefined
Text vertical alignment; generally set to 'top' to ensure the text is at the bottom of the mark area and within the visible range.
Recommended to set to 'top' to ensure the text is displayed completely within the visible area.
top: Text is at the bottom of the mark area, its top edge aligned with the area.
middle: Text is vertically centered within the mark area.
bottom: Text is at the top of the mark area, its bottom edge aligned with the area.
Example 'top' Text is at the bottom of the mark area
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
areaColor
Type: string | undefined
Mark area region color
Example 'red'
areaColorOpacity
Type: number | undefined
Mark area region color opacity
Example 0.5
areaBorderColor
Type: string | undefined
Mark area region border color
Example 'red'
areaBorderWidth
Type: number | undefined
Mark area region border width
Example 2
areaBorderRadius
Type: number | undefined
Mark area region border radius
Example 4
areaLineDash
Type: number[] | undefined
Line type for the mark area region border
Example [2, 2]
outerPadding
Type: number | undefined
Margin for the mark area region
Example 0
dimensionLinkage
Type: DimensionLinkage | undefined
Whether to enable the dimension linkage function when the chart has perspective enabled or measures are combined.
When hovering over certain dimension value(s), it highlights data with the same dimension values in other sub-charts.
Perspective chart dimension linkage configuration
enable
Type: false | true
Whether to enable perspective chart dimension linkage
showTooltip
Type: boolean | undefined
Whether to display tooltips for all dimension sub-charts
showLabel
Type: boolean | undefined
Whether to display crosshair labels
locale
Type: Locale | undefined
Language
Chart language configuration; supports 'zh-CN' and 'en-US' language; alternatively, call the intl.setLocale('zh-CN') method to set the language.