SheetXL - v1.0.2
    Preparing search index...

    Interface ChartPaintKindBeta

    How a kind of chart group is painted: the ECharts series and graphic elements for a group of the kind's layout, and the key its series show in the legend. The built-in kinds register through ChartPaintKinds the way a host's kind does; a custom group (ChartLayout.CustomGroupLayout) is painted by the kind registered under custom:<its kind>.

    The painter translates the layout and decides nothing: a kind reads where the layout put things, in px, and says how ECharts draws them. It is given the shared vocabulary as a ChartPaintKind.Context: fills and strokes as ECharts states them, markers, text boxes, and for a group on axes the grid indexes and how a series' data is placed on them.

    interface ChartPaintKind {
        grid?: boolean;
        types: readonly string[];
        graphic?(group: GroupLayout, context: ChartPaintKind.Context): any[];
        horizontal?(group: GroupLayout): boolean;
        legendKey?(
            entry: LegendEntryLayout,
            series: SeriesLayout,
            group: GroupLayout,
            key: Bounds,
            context: ChartPaintKind.Context,
        ): any[] | undefined;
        modules?(): readonly unknown[];
        series?(group: GroupLayout, context: ChartPaintKind.Context): any[];
    }
    Index
    grid?: boolean

    Whether the kind's series sit on the grid's axes.

    the group names two axes
    
    types: readonly string[]

    The layout group types the kind paints: 'bar', 'line'..., or custom:<kind> for a custom group.

    • Beta

      The graphic elements for a group, drawn with its series: a radar's spokes, an of-pie's bar.

      Parameters

      Returns any[]

    • Beta

      Whether the group's categories run up a vertical axis (horizontal bars), which the grid is told.

      Parameters

      • group: GroupLayout

      Returns boolean

    • Beta

      The key a legend entry for one of the group's series shows, as graphic elements in key: a line's line and marker, a slice's colors. undefined for the default, a swatch of the series' fill and line.

      Parameters

      • entry: LegendEntryLayout
      • series: SeriesLayout
      • group: GroupLayout
      • key: Bounds
      • context: ChartPaintKind.Context

      Returns any[] | undefined

    • Beta

      The ECharts pieces the kind's series need (echarts/charts, echarts/components), registered with echarts.use before a chart with a group of the kind is first painted. A kind drawn as graphic elements alone needs none.

      Returns readonly unknown[]