SheetXL - v1.0.2
    Preparing search index...

    Interface Context

    What a kind is given to paint a group.

    interface Context {
        darkMode: boolean;
        layout: ChartLayout;
        marker: {
            fill(marker: MarkerLayout | null): JSON | null;
            graphic(marker: MarkerLayout, cx: number, cy: number, z: number): any[];
            symbol(
                marker: MarkerLayout,
            ): {
                symbol: string;
                symbolOffset?: [number, number];
                symbolSize: number | [number, number];
            };
        };
        axisOf(id: number): AxisLayout | undefined;
        cartesian(group: { axisIds: number[] }): Cartesian;
        color(css: string): string;
        line(stroke: JSON | null | undefined): Record<string, unknown>;
        lines(lines: LinesLayout | undefined): any[];
        lineSeries(
            series: SeriesLayout,
            smooth: boolean,
            spanBlanks?: boolean,
        ): Record<string, any>;
        paint(fill: JSON | null | undefined, none?: string): any;
        stroke(stroke: JSON | null | undefined): Record<string, unknown>;
        text(
            text: TextLayout,
            fill: JSON | null,
            border: JSON | null,
            lineHeight?: number,
        ): any[];
        upDownBars(bars: UpDownBarsLayout | undefined): any[];
        width(stroke: JSON | null | undefined): number;
        withMarkerFills(series: SeriesLayout, drawn: any): any[];
    }
    Index
    darkMode layout marker
    axisOf cartesian color line lines lineSeries paint stroke text upDownBars width withMarkerFills
    darkMode: boolean

    Whether the chart is drawn as a dark grid draws its cells.

    layout: ChartLayout

    The layout to paint, its colors already in the mode painted.

    marker: {
        fill(marker: MarkerLayout | null): JSON | null;
        graphic(marker: MarkerLayout, cx: number, cy: number, z: number): any[];
        symbol(
            marker: MarkerLayout,
        ): {
            symbol: string;
            symbolOffset?: [number, number];
            symbolSize: number | [number, number];
        };
    }

    Type Declaration

    • fill: function
      • fill(marker: MarkerLayout | null): JSON | null

        The square under a filled x, star or plus; null for any other marker.

        Parameters

        • marker: MarkerLayout | null

        Returns JSON | null

    • graphic: function
      • graphic(marker: MarkerLayout, cx: number, cy: number, z: number): any[]

        A marker centered on a point, as graphic elements.

        Parameters

        • marker: MarkerLayout
        • cx: number
        • cy: number
        • z: number

        Returns any[]

    • symbol: function
      • symbol(
            marker: MarkerLayout,
        ): {
            symbol: string;
            symbolOffset?: [number, number];
            symbolSize: number | [number, number];
        }

        How ECharts draws a marker: its symbol, box and offset.

        Parameters

        • marker: MarkerLayout

        Returns {
            symbol: string;
            symbolOffset?: [number, number];
            symbolSize: number | [number, number];
        }

    • Parameters

      • id: number

      Returns AxisLayout | undefined

    • The grid a group's axes are on.

      Parameters

      • group: { axisIds: number[] }

      Returns Cartesian

    • A concrete CSS color of the kind's own (not the layout's, which are in the mode already) as the chart is drawn: as a dark grid draws it when darkMode.

      Parameters

      • css: string

      Returns string

    • A stroke as a series' lineStyle states it.

      Parameters

      • stroke: JSON | null | undefined

      Returns Record<string, unknown>

    • A group's lines (high-low, drop, series lines) as graphic lines.

      Parameters

      • lines: LinesLayout | undefined

      Returns any[]

    • A series drawn as a line with its markers, straight or smooth, broken or not at a blank.

      Parameters

      • series: SeriesLayout
      • smooth: boolean
      • OptionalspanBlanks: boolean

      Returns Record<string, any>

    • A fill as ECharts paints it; none for no fill.

      Parameters

      • fill: JSON | null | undefined
      • Optionalnone: string

      Returns any

    • A stroke as a graphic element's style states it.

      Parameters

      • stroke: JSON | null | undefined

      Returns Record<string, unknown>

    text

    • text(
          text: TextLayout,
          fill: JSON | null,
          border: JSON | null,
          lineHeight?: number,
      ): any[]

      A text box of the layout as graphic elements.

      Parameters

      • text: TextLayout
      • fill: JSON | null
      • border: JSON | null
      • OptionallineHeight: number

      Returns any[]

    • A group's up/down bars as graphic rects.

      Parameters

      • bars: UpDownBarsLayout | undefined

      Returns any[]

    • A stroke's width in px, 0 for none.

      Parameters

      • stroke: JSON | null | undefined

      Returns number

    • drawn with, beneath it, the squares under the series' filled x, star or plus markers.

      Parameters

      • series: SeriesLayout
      • drawn: any

      Returns any[]

    Settings
    Member Visibility

    On This Page
    Properties
    Methods