Coloring Series per-point using the PaletteProvider

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203

import { appTheme } from "./appTheme";
import { RandomWalkGenerator } from "./RandomWalkGenerator";

import {
    BoxAnnotation,
    ECoordinateMode,
    EDataLabelSkipMode,
    EHorizontalAnchorPoint,
    ELabelPlacement,
    EllipsePointMarker,
    EStrokePaletteMode,
    FastLineRenderableSeries,
    HorizontalLineAnnotation,
    IPointMarkerPaletteProvider,
    IPointMetadata,
    IRenderableSeries,
    IStrokePaletteProvider,
    NumberRange,
    NumericAxis,
    parseColorToUIntArgb,
    SciChartSurface,
    TextAnnotation,
    Thickness,
    TPointMarkerArgb,
    XyDataSeries,
    XyScatterRenderableSeries,
} from "scichart";

export const drawExample = async (rootElement: string | HTMLDivElement) => {
    // Create a SciChartSurface
    const { sciChartSurface, wasmContext } = await SciChartSurface.create(rootElement, {
        theme: appTheme.SciChartJsTheme,
    });

    // Create the X,Y Axis
    sciChartSurface.xAxes.add(new NumericAxis(wasmContext, { maxAutoTicks: 5 }));
    sciChartSurface.yAxes.add(new NumericAxis(wasmContext, { maxAutoTicks: 5, growBy: new NumberRange(0.05, 0.2) }));

    const { xValues, yValues } = new RandomWalkGenerator().Seed(1337).getRandomWalkSeries(50);

    let THRESHOLD_HIGH_LEVEL = 0;
    let THRESHOLD_LOW_LEVEL = -2;
    // For performance reasons PaletteProviders require colors as Argb numbers e.g. 0xFFFF0000 = red
    const THRESHOLD_LOW_COLOR_ARGB = parseColorToUIntArgb(appTheme.VividPink);
    const THRESHOLD_HIGH_COLOR_ARGB = parseColorToUIntArgb(appTheme.VividTeal);

    const getColor = (yValue: number) => {
        if (yValue < THRESHOLD_LOW_LEVEL) {
            return THRESHOLD_LOW_COLOR_ARGB;
        }
        if (yValue > THRESHOLD_HIGH_LEVEL) {
            return THRESHOLD_HIGH_COLOR_ARGB;
        }
        // Undefined means use default series stroke on this data-point
        return undefined;
    };

    // PaletteProvider API allows for per-point colouring, filling of points or areas based on a rule
    // see PaletteProvider API for more details
    const strokePaletteProvider: IStrokePaletteProvider = {
        onAttached(parentSeries: IRenderableSeries): void {},
        onDetached(): void {},
        strokePaletteMode: EStrokePaletteMode.GRADIENT,
        // This function called once per data-point for line stroke. Colors returned must be in ARGB format (uint) e.g. 0xFF0000FF is Red
        overrideStrokeArgb(
            xValue: number,
            yValue: number,
            index: number,
            opacity?: number,
            metadata?: IPointMetadata
        ): number {
            return getColor(yValue);
        },
    };

    // Create a line series with threshold palette provider
    sciChartSurface.renderableSeries.add(
        new FastLineRenderableSeries(wasmContext, {
            dataSeries: new XyDataSeries(wasmContext, { xValues, yValues }),
            strokeThickness: 4,
            stroke: appTheme.VividOrange,
            dataLabels: {
                style: { fontFamily: "Arial", fontSize: 13, padding: Thickness.fromNumber(5) },
                color: appTheme.PaleSkyBlue,
                skipMode: EDataLabelSkipMode.SkipIfOverlapPrevious,
            },
            paletteProvider: strokePaletteProvider,
        })
    );

    const pointPaletteProvider: IPointMarkerPaletteProvider = {
        strokePaletteMode: EStrokePaletteMode.SOLID,
        onAttached(parentSeries: IRenderableSeries): void {},
        onDetached(): void {},
        // This function called once per data-point for scatter fill
        overridePointMarkerArgb(
            xValue: number,
            yValue: number,
            index: number,
            opacity?: number,
            metadata?: IPointMetadata
        ): TPointMarkerArgb {
            const color = getColor(yValue);
            return { stroke: color, fill: color };
        },
    };

    // Create a scatter series with threshold paletteprovider
    sciChartSurface.renderableSeries.add(
        new XyScatterRenderableSeries(wasmContext, {
            dataSeries: new XyDataSeries(wasmContext, { xValues, yValues }),
            pointMarker: new EllipsePointMarker(wasmContext, {
                width: 7,
                height: 7,
                stroke: appTheme.VividOrange,
                fill: appTheme.VividOrange,
            }),
            paletteProvider: pointPaletteProvider,
        })
    );

    // Add annotations to fill the threshold areas
    const boxHighAnnotation = new BoxAnnotation({
        x1: 0,
        x2: 1,
        y1: THRESHOLD_LOW_LEVEL,
        y2: -9999,
        fill: appTheme.VividPink + "11",
        strokeThickness: 0,
        xCoordinateMode: ECoordinateMode.Relative,
    });
    sciChartSurface.annotations.add(boxHighAnnotation);
    const boxLowAnnotation = new BoxAnnotation({
        x1: 0,
        x2: 1,
        y1: THRESHOLD_HIGH_LEVEL,
        y2: 9999,
        fill: appTheme.VividTeal + "11",
        strokeThickness: 0,
        xCoordinateMode: ECoordinateMode.Relative,
    });
    sciChartSurface.annotations.add(boxLowAnnotation);
    // Add annotations to show the thresholds
    const thresholdHighAnnotation = new HorizontalLineAnnotation({
        stroke: appTheme.VividTeal,
        strokeThickness: 2,
        strokeDashArray: [3, 3],
        y1: THRESHOLD_HIGH_LEVEL,
        labelPlacement: ELabelPlacement.TopRight,
        labelValue: "High warning",
        axisLabelFill: appTheme.VividTeal,
        axisFontSize: 16,
        showLabel: true,
        isEditable: true,
        onDrag: (args) => {
            // When the vertical line is dragged, update the
            // threshold palette and redraw the SciChartSurface
            THRESHOLD_HIGH_LEVEL = thresholdHighAnnotation.y1;
            boxLowAnnotation.y1 = thresholdHighAnnotation.y1;
            sciChartSurface.invalidateElement();
        },
    });
    sciChartSurface.annotations.add(thresholdHighAnnotation);
    const thresholdLowAnnotation = new HorizontalLineAnnotation({
        stroke: appTheme.VividPink,
        strokeThickness: 2,
        strokeDashArray: [3, 3],
        labelPlacement: ELabelPlacement.BottomLeft,
        y1: THRESHOLD_LOW_LEVEL,
        labelValue: "Low warning",
        axisLabelFill: appTheme.VividPink,
        axisFontSize: 16,
        showLabel: true,
        isEditable: true,
        onDrag: (args) => {
            // When the vertical line is dragged, update the
            // threshold palette and redraw the SciChartSurface
            THRESHOLD_LOW_LEVEL = thresholdLowAnnotation.y1;
            boxHighAnnotation.y1 = THRESHOLD_LOW_LEVEL;
            sciChartSurface.invalidateElement();
        },
    });
    sciChartSurface.annotations.add(thresholdLowAnnotation);
    // Add title annotation
    sciChartSurface.annotations.add(
        new TextAnnotation({
            text: "Per point colouring in SciChart.js. Can be applied to lines, areas, scatter points and bubbles",
            fontSize: 16,
            textColor: appTheme.ForegroundColor,
            x1: 0,
            y1: 0,
            xCoordShift: 10,
            yCoordShift: 10,
            opacity: 0.77,
            horizontalAnchorPoint: EHorizontalAnchorPoint.Left,
            xCoordinateMode: ECoordinateMode.Relative,
            yCoordinateMode: ECoordinateMode.Relative,
        })
    );

    return { sciChartSurface, wasmContext };
};