• English
  • RacePie

    Description

    Dynamic pie chart (Race Pie Chart)

    Suitable for showing the proportion relationship of data changes over time, using the size of the sector area to represent the proportion of each category.

    Applicable scenarios:

    - Show the change of proportion distribution of categorical data over time

    - Emphasize the evolution of the overall and partial relationship of data on the time dimension

    - Observe the proportion fluctuation of different categories in the total amount

    Note

    Dynamic pie chart:

    - Angle maps measure values, color maps dimension values

    - Supports controlling the time dimension through a player, animating the proportion changes

    - Sector area is adjusted with animation as data changes

    chartType

    Type: "racePie"

    Description

    Dynamic pie chart, suitable for showing proportional relationships in data over time

    dataset

    Type: Record[]

    Description

    Data source

    dimensions

    Type: RacePieDimension[] | undefined

    Description

    Dimensions

    id

    Type: string

    Description

    Field ID corresponding to the dimension

    alias

    Type: string | undefined

    Description

    Dimension alias

    timeFormat

    Type: TimeFormat | undefined

    Description

    Dimension date format configuration

    type

    Type: "year" | "quarter" | "month" | "week" | "day" | "hour" | "minute" | "second"

    Description

    Time granularity, determines the date display precision

    encoding

    Type: "color" | "detail" | "tooltip" | "label" | "row" | "column" | "player" | undefined

    Description

    Channel to which the dimension is mapped

    - 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

    - player: supports mapping multiple dimensions to the player channel

    measures

    Type: PieMeasure[] | undefined

    Description

    Measures

    id

    Type: string

    Description

    Measure ID, must be unique

    alias

    Type: string | undefined

    Description

    Measure alias, duplicates allowed; when not set, alias defaults to id

    autoFormat

    Type: boolean | undefined

    Description

    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万

    • locale=en-US: 749740.264 → 744.5K

    numFormat

    Type: NumFormat | undefined

    Description

    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 configuration.

    type

    Type: "number" | "percent" | "permille" | "scientific" | undefined

    Description

    Number format type, supports: number (decimal), percent (%), permille (‰), scientific notation

    ratio

    Type: number | undefined

    Description

    Number format ratio, cannot be 0

    Example

    • 100000 converts to 10万, ratio:10000, symbol:"万"
    • 100000 converts to 10K, ratio:1000, symbol:"K"

    symbol

    Type: string | undefined

    Description

    Number format symbol, e.g. %, ‰

    Example

    • 100000 converts to 10万, ratio:10000, symbol:"万"
    • 100000 converts to 10K, ratio:1000, symbol:"K"

    thousandSeparator

    Type: boolean | undefined

    Description

    Thousands separator for number formatting

    suffix

    Type: string | undefined

    Description

    Number format suffix

    prefix

    Type: string | undefined

    Description

    Number format prefix

    fractionDigits

    Type: number | undefined

    Description

    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

    Description

    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

    Description

    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

    Description

    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

    Description

    Number format type, supports: number (decimal), percent (%), permille (‰), scientific notation

    ratio

    Type: number | undefined

    Description

    Number format ratio, cannot be 0

    Example

    • 100000 converts to 10万, ratio:10000, symbol:"万"
    • 100000 converts to 10K, ratio:1000, symbol:"K"

    symbol

    Type: string | undefined

    Description

    Number format symbol, e.g. %, ‰

    Example

    • 100000 converts to 10万, ratio:10000, symbol:"万"
    • 100000 converts to 10K, ratio:1000, symbol:"K"

    thousandSeparator

    Type: boolean | undefined

    Description

    Thousands separator for number formatting

    suffix

    Type: string | undefined

    Description

    Number format suffix

    prefix

    Type: string | undefined

    Description

    Number format prefix

    fractionDigits

    Type: number | undefined

    Description

    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

    Description

    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

    Description

    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

    Description

    Rounding mode for number formatting, using the browser's Intl.NumberFormat, following the same rules as Intl.NumberFormat's roundingMode.

    encoding

    Type: "color" | "tooltip" | "label" | "angle" | undefined

    Description

    Channel to which the measure is mapped:

    • angle: measure mapped to the angle 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

    Description

    In a flat measure configuration, builds a tree-like measure structure. parentId points to the ID of the parent measure group, used for building the hierarchy.

    Tip

    There are two ways to configure the measure tree: Option 1 is directly configuring a measure tree with children; Option 2 is providing a flat measure list with parentId. These two methods cannot be used simultaneously.

    page

    Type: Page | undefined

    Description

    Pagination configuration. Specifies the field name for pagination, which must be a dimension.

    field

    Type: string

    Description

    Pagination field; specifies the field name for pagination, must be a dimension.

    currentValue

    Type: string

    Description

    Current pagination value; specifies the value used to determine the current page.

    Example '2023-01-01'

    player

    Type: Player | undefined

    Description

    Player configuration, used to specify the time dimension, the core configuration of the dynamic pie chart

    Player configuration, used to specify the player field name, must be a dimension

    Warning

    This feature does not support chart types such as table, pivotTable, dualAxis, histogram, boxPlot, etc., and does not support use when measure combination or row/column pivot is enabled

    maxCount

    Type: number | false | undefined

    Description

    Maximum playback count; data exceeding this count will be truncated, set to false for no limit

    interval

    Type: number | undefined

    Description

    Playback interval, unit: ms

    autoPlay

    Type: boolean | undefined

    Description

    Whether to auto play

    loop

    Type: boolean | undefined

    Description

    Whether to loop play

    position

    Type: "left" | "top" | "right" | "bottom" | undefined

    Description

    Player position

    railColor

    Type: string | undefined

    Description

    Player progress bar rail color

    fontFamily

    Type: string | undefined

    Description

    Player text font family

    fontSize

    Type: number | undefined

    Description

    Player text font size

    trackColor

    Type: string | undefined

    Description

    Player progress bar track color

    sliderHandleColor

    Type: string | undefined

    Description

    Player progress bar slider handle color

    sliderHandleBorderColor

    Type: string | undefined

    Description

    Player progress bar slider handle border color

    startButtonColor

    Type: string | undefined

    Description

    Player start button color

    pauseButtonColor

    Type: string | undefined

    Description

    Player pause button color

    backwardButtonColor

    Type: string | undefined

    Description

    Player backward button color

    forwardButtonColor

    Type: string | undefined

    Description

    Player forward button color

    backgroundColor

    Type: BackgroundColor

    Description

    Chart background color. Default is transparent. 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

    Description

    Color configuration for defining the chart's color scheme, including color lists, color mappings, and color gradients.

    colorScheme

    Type: string[] | undefined

    Description

    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

    Description

    Linear gradient color scheme used to define the colors of different elements in the chart.

    Example ['#FFCDD2, #F8BBD0]

    colorMapping

    Type: Record<string, string> | undefined

    Description

    Color mapping used to map data values to specific colors.

    Example { 'profit': 'red', 'sales': 'blue', }

    positiveColor

    Type: string | undefined

    Description

    Positive/negative color configuration; defines the color for positive values in the chart.

    negativeColor

    Type: string | undefined

    Description

    Positive/negative color configuration; defines the color for negative values in the chart.

    label

    Type: PieLabel | undefined

    Description

    Label configuration for defining chart data labels, including their position, format, and style.

    enable

    Type: false | true

    Description

    Whether label functionality is enabled.

    wrap

    Type: boolean | undefined

    Description

    Whether labels wrap to the next line.

    showValue

    Type: boolean | undefined

    Description

    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 labels have higher priority; this config does not affect encoding labels.

    showValuePercent

    Type: boolean | undefined

    Description

    Whether labels display measure value percentages.

    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 labels have higher priority; this config does not affect encoding labels.

    showDimension

    Type: boolean | undefined

    Description

    Whether labels display dimension names.

    Displays all dimension labels.

    Note: Encoding labels have higher priority; this config does not affect encoding labels.

    autoFormat

    Type: boolean | undefined

    Description

    Whether label values are automatically formatted. When autoFormat is true, numFormat configuration is ignored.

    numFormat

    Type: NumFormat | undefined

    Description

    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

    Description

    Number format type, supports: number (decimal), percent (%), permille (‰), scientific notation

    ratio

    Type: number | undefined

    Description

    Number format ratio, cannot be 0

    Example

    • 100000 converts to 10万, ratio:10000, symbol:"万"
    • 100000 converts to 10K, ratio:1000, symbol:"K"

    symbol

    Type: string | undefined

    Description

    Number format symbol, e.g. %, ‰

    Example

    • 100000 converts to 10万, ratio:10000, symbol:"万"
    • 100000 converts to 10K, ratio:1000, symbol:"K"

    thousandSeparator

    Type: boolean | undefined

    Description

    Thousands separator for number formatting

    suffix

    Type: string | undefined

    Description

    Number format suffix

    prefix

    Type: string | undefined

    Description

    Number format prefix

    fractionDigits

    Type: number | undefined

    Description

    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

    Description

    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

    Description

    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

    Description

    Rounding mode for number formatting, using the browser's Intl.NumberFormat, following the same rules as Intl.NumberFormat's roundingMode.

    labelFontSize

    Type: number | undefined

    Description

    Label font size.

    labelFontWeight

    Type: string | number | undefined

    Description

    Label font weight.

    labelBackgroundColor

    Type: string | undefined

    Description

    Label background color.

    labelStroke

    Type: string | undefined

    Description

    Label stroke (outline) color.

    labelColor

    Type: string | undefined

    Description

    Label font color.

    labelColorSmartInvert

    Type: boolean | undefined

    Description

    Whether to automatically invert the label font color based on the sector color.

    labelPosition

    Type: "inside" | "outside" | undefined

    Description

    Label position.

    labelOverlap

    Type: boolean | undefined

    Description

    Whether the label overlap avoidance function is enabled.

    selector

    Type: Selector | Selectors | undefined

    Description

    Label filtering; the default condition relationship between selectors is OR.

    field

    Type: string

    Description

    Dimension field ID.

    operator

    Type: "in" | "not in" | undefined

    Description

    Operator:

    • in: Select data items where the dimension field value is in the 'value' list.

    • not in: Select data items where the dimension field value is not in the 'value' list.

    op

    Type: "in" | "not in" | undefined

    Description

    Operator:

    • in: Select data items where the dimension field value is in the 'value' list.

    • not in: Select data items where the dimension field value is not in the 'value' list.

    Same as operator.

    value

    Type: string | number | (string | number)[]

    Description

    Selective dimension values; supports arrays.

    dynamicFilter

    Type: ChartDynamicFilter | undefined

    Description

    Dynamic filter (AI-generated code execution).

    Implement complex data filtering logic via AI-generated JavaScript code.

    Key capabilities:

    • Supports any complex data filtering conditions.

    • Uses built-in utility functions for data operations.

    • Executes safely in the browser environment (Web Worker sandbox).

    Requirements: Supports only browser environments; Node.js environments will use the fallback.

    Note: selector and dynamicFilter cannot be used simultaneously; dynamicFilter has higher priority.

    Configuration for the chart dynamic filter.

    Filter chart marks (columns, points, etc.) via AI-generated JavaScript code.

    type

    Type: "row-with-field"

    description

    Type: string | undefined

    Description

    User's filtering requirement description (natural language).

    Example "Highlight sectors with shares greater than 30%."

    "Highlight the category with the highest value in each region."

    code

    Type: string

    Description

    AI-generated JavaScript filtering code.

    • Can only use built-in utility functions (access via _ or R).

    • Input parameter: data (array); each item includes 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 'sales' field for data items where sales > 1000:

    const filtered = _.filter(data, item => item.sales > 1000);
    return _.map(filtered, item => ({
    __row_index: item.__row_index,
    field: 'sales'
    }));

    Highlight data items with the highest profit margin in each region:

    const grouped = _.groupBy(data, 'area');
    const maxItems = _.map(grouped, group =>
    _.maxBy(group, item => item.profit / item.sales)
    );
    return _.flatten(
    _.map(maxItems, item => [
    { __row_index: item.__row_index, field: 'product' },
    { __row_index: item.__row_index, field: 'profit' }
    ])
    );

    Highlight data items meeting multiple filtering conditions:

    const filtered = _.filter(data, item => {
    const profitRate = item.profit / item.sales;
    return profitRate > 0.2 && item.sales > 5000;
    });
    return _.flatten(
    _.map(filtered, item => [
    { __row_index: item.__row_index, field: 'product' },
    { __row_index: item.__row_index, field: 'sales' }
    ])
    );

    fallback

    Type: Selector | Selectors | undefined

    Description

    Fallback plan when code execution fails or the environment is not supported.

    field

    Type: string

    Description

    Dimension field ID.

    operator

    Type: "in" | "not in" | undefined

    Description

    Operator:

    • in: Select data items where the dimension field value is in the 'value' list.

    • not in: Select data items where the dimension field value is not in the 'value' list.

    op

    Type: "in" | "not in" | undefined

    Description

    Operator:

    • in: Select data items where the dimension field value is in the 'value' list.

    • not in: Select data items where the dimension field value is not in the 'value' list.

    Same as operator.

    value

    Type: string | number | (string | number)[]

    Description

    Selective dimension values; supports arrays.

    result

    Type: DynamicFilterExecutionResult<RowWithFieldRes> | undefined

    Description

    Dynamic filter execution result (runtime field). Written during the prepare() phase; read-only at runtime.

    success

    Type: false | true

    data

    Type: T[] | undefined

    error

    Type: string | undefined

    labelLayout

    Type: "arc" | "labelLine" | "edge" | undefined

    Description

    Label layout mode. Only effective for pie chart and donut chart when labelPosition is outside.

    • arc: Layout labels along the arc.

    • labelLine: Aligns labels at both ends, connecting sector graphics with labels via leader lines.

    • edge: Aligns labels at both ends, connecting sector graphics with labels via leader lines, positioned close to the edges of the chart.

    legend

    Type: Legend | undefined

    Description

    Legend configuration, used to define the chart's legend, including position, format, and style.

    enable

    Type: boolean | undefined

    Description

    Whether legend functionality is enabled.

    Example enable: true

    border

    Type: boolean | undefined

    Description

    Whether the legend border is enabled.

    Warning

    Only effective for discrete legends.

    Example border: true

    labelColor

    Type: string | undefined

    Description

    Legend font color.

    pagerIconColor

    Type: string | undefined

    Description

    Pagination icon color.

    pagerIconDisableColor

    Type: string | undefined

    Description

    Pagination icon disabled color.

    labelFontSize

    Type: number | undefined

    Description

    Legend font size.

    Example labelFontSize: 10

    labelFontColor

    Type: string | undefined

    Description

    Legend font color.

    labelFontWeight

    Type: string | number | undefined

    Description

    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

    Description

    Legend shape.

    Warning

    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

    Description

    Legend position.

    Example position: 'rightTop'

    maxSize

    Type: number | undefined

    Description

    Maximum number of columns or rows for the legend when many items exist.

    If position is horizontal (bottom, top, etc.), maxSize controls the number of columns. If position is vertical (left, right, etc.), maxSize controls the number of rows.

    Warning

    Only effective for discrete legends.

    Example maxSize: 2

    tooltip

    Type: Tooltip | undefined

    Description

    Tooltip configuration, used to define the chart's tooltips, including position, format, and style.

    enable

    Type: false | true

    Description

    Whether tooltip functionality is enabled.

    brush

    Type: Brush | undefined

    Description

    Brush configuration, used to enable/disable region selection capabilities.

    enable

    Type: boolean | undefined

    Description

    Whether region selection is enabled.

    brushType

    Type: "rect" | "x" | "y" | "polygon" | undefined

    Description

    Brush type. Defines the selection box shape and direction:

    • rect: Rectangular selection, allows selecting in both X and Y directions.

    • polygon: Polygon selection, allows drawing arbitrary shapes by clicking multiple points.

    • x: Horizontal selection, restricts selection to the X-axis direction.

    • y: Vertical selection, restricts selection to the Y-axis direction.

    brushMode

    Type: "single" | "multiple" | undefined

    Description

    Selection mode, single or multiple. Defines the selection logic:

    • 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

    Description

    Whether to clear selection boxes after region selection ends.

    inBrushStyle

    Type: { opacity?: number; stroke?: string; lineWidth?: number; } | undefined

    Description

    Style for data within the selected region.

    opacity

    Type: number | undefined

    Description

    Opacity for selected data points, range 0-1.

    stroke

    Type: string | undefined

    Description

    Stroke color.

    lineWidth

    Type: number | undefined

    Description

    Stroke width.

    outOfBrushStyle

    Type: { opacity?: number; stroke?: string; lineWidth?: number; } | undefined

    Description

    Style for data outside the selected region.

    opacity

    Type: number | undefined

    Description

    Opacity for data points outside the selection, range 0-1.

    stroke

    Type: string | undefined

    Description

    Stroke color.

    lineWidth

    Type: number | undefined

    Description

    Stroke width.

    theme

    Type: Theme | undefined

    Description

    Theme configuration

    Theme

    Built-in light and dark themes; new custom themes can be defined via registerTheme.

    length

    Type: number

    brand

    Type: brand

    locale

    Type: "zh-CN" | "en-US" | "ja-JP" | "de-DE" | "id-ID" | "fr-FR" | "ko-KR" | "vi-VN" | undefined

    Description

    Locale. Chart language configuration; supports 'zh-CN' and 'en-US'. Alternatively, call intl.setLocale('zh-CN') to set the language.