Interface Theme

Selection of Theme effect. Either none (undefined) or a GlowEffect.

For performance reasons only 1 configuration of a glow effect is allowed within an application at the moment.

Convenience flag for controlling whether theme effect should be shown in dashboard splitters by default.

false -> Dashboard splitters will have disabled theme effect by default.

Convenience flag for controlling whether theme effect should be shown in different Text components by default.

false -> Text components will have disabled theme effect by default.

Properties of Theme that are optional, and officially only used in LightningChart JS Online Examples and projects.

These are guaranteed to be included in all official Library Themes provided by LightningChart, but not required in custom Themes defined by users.

If you want to use example theme properties in your application, then make sure to do these two things:

1. Use an official Theme supplied by LightningChart.
2. If your project requires type safety, then add a sanity check that throws an error if the Theme.examples property is undefined, like this:

 // Example, ensure official LightningChart JS theme is in use.
 const theme = chart.getTheme()
 if (!theme.examples) {
     throw new Error(`LightningChart JS Theme.examples is undefined. You are probably using an unofficial theme and attempting to access example theme properties!`)
 }

Color offset for chart components when highlighted.

 // Example, highlighted components shift towards red.
 highlightColorOffset: ColorRGBA(100, -50, -50, 0)

 // Example, highlighted components are darkened.
 highlightColorOffset: ColorRGBA(-100, -100, -100, 0)

Override of highlightColorOffset for axis overlays (mouse interaction areas).

Flag if Theme is dark or not.

For user defined themes, it doesn't have large consequences. However, incorrect use can have a slight negative effect on text sharpness. For a Theme with dominantly dark backgrounds, should set the value to false.