Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Theme

Interface for all properties of a library color theme.

A collection of default implementations can be accessed by Themes.

Color theme of components must be specified when it is created, and can't be changed afterwards (without destroying and recreating the component). See ChartXY for example usage on specifying a color theme - the syntax is the same for every other component.

Index

Properties

Properties

Optional OHLCBarNegativeHighlightStyle

OHLCBarNegativeHighlightStyle : LineStyle

Highlighted StrokeStyle for negative OHLC Bars

deprecated

Theme highlighted style properties will be removed in v.4.0.

OHLCBarNegativeStyle

OHLCBarNegativeStyle : LineStyle

StrokeStyle for negative OHLC Bars

Optional OHLCBarPositiveHighlightStyle

OHLCBarPositiveHighlightStyle : LineStyle

Highlighted StrokeStyle for positive OHLC Bars

deprecated

Theme highlighted style properties will be removed in v.4.0.

OHLCBarPositiveStyle

OHLCBarPositiveStyle : LineStyle

StrokeStyle for positive OHLC Bars

axesStyles3D

axesStyles3D : Vec3<LineStyle | SolidLine<SolidFill>>

Default styles for 3D Charts Axes.

Optional axisLabelFillStyle

axisLabelFillStyle : FillStyle

FillStyle for Axis labels

deprecated

axisLabelFillStyle has no effect on any property of LightningChart JS. It will be permanently removed in v.4.0. To style default Axis tick labels using Theme API, refer to numericTickStrategy or other tick strategy properties.

Optional axisLabelFont

axisLabelFont : FontSettings

FontSettings for Axis title

deprecated

axisLabelFont has no effect on any property of LightningChart JS. It will be permanently removed in v.4.0. To style default Axis tick labels using Theme API, refer to numericTickStrategy or other tick strategy properties.

axisNibOverlayStyle

axisNibOverlayStyle : FillStyle

FillStyle for highlighted Axis Nibs (mouse-picking area)

axisNibStyle

axisNibStyle : LineStyle

Style for Axis Nibs

axisOverlayStyle

axisOverlayStyle : FillStyle

FillStyle for highlighted Axes (mouse-picking area)

axisStyle

axisStyle : LineStyle

FillStyle for Axis

axisTitleFillStyle

axisTitleFillStyle : FillStyle

FillStyle for Axis title

axisTitleFont

axisTitleFont : FontSettings

FontSettings for Axis title

bandFillStyle

bandFillStyle : FillStyle

Default fill style for UI Band

bandStrokeStyle

bandStrokeStyle : LineStyle

Default stroke style for UI Band

boundingBoxStyle3D

boundingBoxStyle3D : LineStyle | SolidLine<SolidFill>

Default style for 3D Charts bounding box.

boxFigureLineStyle

boxFigureLineStyle : LineStyle

StrokeStyle for Box Figures Line

boxFigureMedianLineStyle

boxFigureMedianLineStyle : LineStyle

StrokeStyle for Box Figures Median Line

boxFigureStrokeStyle

boxFigureStrokeStyle : LineStyle

StrokeStyle for Box Figures

boxFigureStyle

boxFigureStyle : FillStyle

FillStyle for Box Figures

boxSeriesFillStyle

boxSeriesFillStyle : FillStyle | Palette<FillStyle>

FillStyle for Box series.

candleStickNegativeStrokeStyle

candleStickNegativeStrokeStyle : LineStyle

StrokeStyle for Negative OHLC candle sticks

Optional candleStickNegativeStrokeStyleHighlight

candleStickNegativeStrokeStyleHighlight : LineStyle

StrokeStyle for Negative OHLC candle sticks when highlighted

deprecated

Theme highlighted style properties will be removed in v.4.0.

candleStickNegativeStyle

candleStickNegativeStyle : FillStyle

FillStyle for Negative OHLC candle sticks

Optional candleStickNegativeStyleHighlight

candleStickNegativeStyleHighlight : FillStyle

FillStyle for Negative OHLC candle sticks when highlighted

deprecated

Theme highlighted style properties will be removed in v.4.0.

candleStickPositiveStrokeStyle

candleStickPositiveStrokeStyle : LineStyle

StrokeStyle for Positive OHLC candle sticks

Optional candleStickPositiveStrokeStyleHighlight

candleStickPositiveStrokeStyleHighlight : LineStyle

StrokeStyle for Positive OHLC candle sticks when highlighted

deprecated

Theme highlighted style properties will be removed in v.4.0.

candleStickPositiveStyle

candleStickPositiveStyle : FillStyle

FillStyle for Positive OHLC candle sticks

Optional candleStickPositiveStyleHighlight

candleStickPositiveStyleHighlight : FillStyle

FillStyle for Positive OHLC candle sticks when highlighted

deprecated

Theme highlighted style properties will be removed in v.4.0.

candleStickStyle

candleStickStyle : LineStyle

StrokeStyle for OHLC candle sticks

Optional candleStickStyleHighlight

candleStickStyleHighlight : LineStyle

StrokeStyle for OHLC candle sticks when highlighted

deprecated

Theme highlighted style properties will be removed in v.4.0.

chartTitleFillStyle

chartTitleFillStyle : FillStyle

FillStyle for Chart title

chartTitleFont

chartTitleFont : FontSettings

FontSettings for Chart title

chartXYFittingRectangleFillStyle

chartXYFittingRectangleFillStyle : FillStyle

FillStyle for Chart XY fitting rectangle

chartXYFittingRectangleStrokeStyle

chartXYFittingRectangleStrokeStyle : LineStyle

Style for Chart XY fitting rectangle stroke

chartXYZoomingRectangleFillStyle

chartXYZoomingRectangleFillStyle : FillStyle

FillStyle for Chart XY zooming rectangle

chartXYZoomingRectangleStrokeStyle

chartXYZoomingRectangleStrokeStyle : LineStyle

Style for Chart XY zooming rectangle stroke

constantLineStrokeStyle

constantLineStrokeStyle : SolidLine

Default stroke style for Axis ConstantLine

customTickGridStrokeStyle

customTickGridStrokeStyle : LineStyle

Style for Custom Tick Grid line.

Optional customTickMarkerFillStyle

customTickMarkerFillStyle : FillStyle

FillStyle for CustomTick Marker.

deprecated

Use uiPointableTextBoxFillStyle instead.

Optional customTickMarkerFont

customTickMarkerFont : FontSettings

Font Settings for CustomTick Marker.

deprecated

Custom Tick marker theme style has been split into two separate properties based on type of Custom Tick. Use either uiPointableTextBoxFont or uiTickFont

Optional customTickMarkerStrokeStyle

customTickMarkerStrokeStyle : LineStyle

StrokeStyle for CustomTick Marker.

deprecated

Custom Tick marker theme style has been split into two separate properties based on type of Custom Tick. Use either uiPointableTextBoxStrokeStyle or uiTickStrokeStyle

Optional customTickMarkerTextFillStyle

customTickMarkerTextFillStyle : FillStyle

FillStyle for Custom Tick Marker Text

deprecated

Custom Tick marker theme style has been split into two separate properties based on type of Custom Tick. Use either customTickMarkerTextFillStyle or uiTickTextFillStyle

customTickPointerLength

customTickPointerLength : number

Length for CustomTick pointer.

Optional dashboardBackgroundFillStyle

dashboardBackgroundFillStyle : FillStyle

FillStyle for Dashboard background.

deprecated

Will be removed in v.4.0, use lcjsBackgroundFillStyle instead. Using dashboardBackgroundFillStyle works same as lcjsBackgroundFillStyle since v.3.1

Optional dashboardBackgroundStrokeStyle

dashboardBackgroundStrokeStyle : LineStyle

StrokeStyle for Dashboard background.

deprecated

Will be removed in v.4.0, use lcjsBackgroundStrokeStyle instead. Using dashboardBackgroundFillStyle works same as lcjsBackgroundStrokeStyle since v.3.1

dashboardSplitterStyle

dashboardSplitterStyle : LineStyle

FillStyle for Dashboard splitter lines

dateTimeTickStrategy

dateTimeTickStrategy : DateTimeTickStrategy

Default DateTime tick strategy configuration.

gaugeBackgroundFillStyle

gaugeBackgroundFillStyle : FillStyle

FillStyle for Gauge Chart area background

gaugeBackgroundStrokeStyle

gaugeBackgroundStrokeStyle : LineStyle

StrokeStyle for Gauge Chart area background

gaugeSliceFillStyle

gaugeSliceFillStyle : FillStyle

FillStyle for GaugeChart Slice

Optional heatmapFillStyle

heatmapFillStyle : FillStyle | Palette<FillStyle>

Default style for old deprecated 2D heatmap series fill.

If undefined, defaults to seriesFillStyle.

Optional heatmapGridSeriesFillStyle

heatmapGridSeriesFillStyle : FillStyle | Palette<FillStyle>

Default style for 2D heatmap grid series fill.

If undefined, defaults to seriesFillStyle.

Optional heatmapGridSeriesWireframeStyle

heatmapGridSeriesWireframeStyle : LineStyle | Palette<LineStyle>

Default style for 2D heatmap grid series wireframe.

If undefined, defaults to emptyLine.

Optional heatmapWireframeStyle

heatmapWireframeStyle : FillStyle | Palette<FillStyle>

Default style for old deprecated 2D heatmap series wireframe.

If undefined, defaults to emptyFill.

Optional lcjsBackgroundFillStyle

lcjsBackgroundFillStyle : FillStyle

FillStyle for LCJS container background.

This background wraps over the entire LCJS chart or dashboard area.

Optional, if undefined will fallback to TODO IMMEDIATE

Optional lcjsBackgroundStrokeStyle

lcjsBackgroundStrokeStyle : LineStyle

StrokeStyle for LCJS container background.

This background wraps over the entire LCJS chart or dashboard area.

Optional, if undefined will fallback to TODO IMMEDIATE

Optional lineSeries3DStrokeStyle

lineSeries3DStrokeStyle : SolidLine<SolidFill> | Palette<SolidLine<SolidFill>>

LineStyle for Line Series 3D.

If undefined, will default to seriesStrokeStyle3D.

mapChartFillStyle

mapChartFillStyle : FillStyle

Default fill style for Map Chart (region fill).

mapChartOutlierRegionFillStyle

mapChartOutlierRegionFillStyle : FillStyle

Default fill style for Map Chart outlier regions.

mapChartOutlierRegionStrokeStyle

mapChartOutlierRegionStrokeStyle : LineStyle

Default stroke style for Map Chart outlier regions.

mapChartSeparateRegionFillStyle

mapChartSeparateRegionFillStyle : FillStyle

Default fill style for Map Chart separate regions.

mapChartSeparateRegionStrokeStyle

mapChartSeparateRegionStrokeStyle : LineStyle

Default stroke style for Map Chart separate regions.

mapChartStrokeStyle

mapChartStrokeStyle : LineStyle

Default stroke style for Map Chart (region borders).

mountainsFillStyle

mountainsFillStyle : FillStyle | Palette<FillStyle>

FillStyle for mountain-series (Area, AreaRange).

mountainsInvertedFillStyle

mountainsInvertedFillStyle : FillStyle | Palette<FillStyle>

FillStyle for inverted part of mountain-series (Area, AreaRange).

mountainsInvertedStrokeStyle

mountainsInvertedStrokeStyle : SolidLine | Palette<SolidLine>

StrokeStyle for inverted part of mountain-series (Area, AreaRange).

mountainsStrokeStyle

mountainsStrokeStyle : SolidLine | Palette<SolidLine>

StrokeStyle for mountain-series (Area, AreaRange).

numericTickStrategy

numericTickStrategy : NumericTickStrategy

Default Numeric tick strategy configuration.

onScreenMenuButtonBackgroundColor

onScreenMenuButtonBackgroundColor : Color

On-screen menu button background color.

onScreenMenuButtonIconSet

onScreenMenuButtonIconSet : OnScreenMenuIconSet

Icon set for on-screen menu buttons.

panelBackgroundFillStyle

panelBackgroundFillStyle : FillStyle

FillStyle for Panel background.

This background exists over each individual chart or panel.

panelBackgroundStrokeStyle

panelBackgroundStrokeStyle : LineStyle

StrokeStyle for Panel background.

This background exists over each individual chart or panel.

Optional pointCloudSeries3DPointStyle

pointCloudSeries3DPointStyle : PixelatedPoints3D | Palette<PixelatedPoints3D>

PointStyle for Point Line Series 3D.

If undefined, will default to seriesNonTriangulatedPointStyle3D.

Optional pointLineSeries3DPointStyle

pointLineSeries3DPointStyle : TriangulatedPoints3D | Palette<TriangulatedPoints3D>

PointStyle for Point Line Series 3D.

If undefined, will default to seriesTriangulatedPointStyle3D.

Optional pointLineSeries3DStrokeStyle

pointLineSeries3DStrokeStyle : SolidLine<SolidFill> | Palette<SolidLine<SolidFill>>

LineStyle for Point Line Series 3D.

If undefined, will default to seriesStrokeStyle3D.

pointMarkerFillStyle

pointMarkerFillStyle : FillStyle

FillStyle for Cursor PointMarker

Optional pointMarkerHorizontalGridStrokeStyle

pointMarkerHorizontalGridStrokeStyle : LineStyle

StrokeStyle for Horizontal Grid originating from Cursor PointMarker.

deprecated

Use customTickGridStrokeStyle instead.

pointMarkerStrokeStyle

pointMarkerStrokeStyle : LineStyle

StrokeStyle for Cursor PointMarker

Optional pointMarkerTextFillStyle

pointMarkerTextFillStyle : FillStyle

FillStyle for Cursor PointMarker Text

deprecated

Use uiPointableTextBoxTextFillStyle or uiTickTextFillStyle instead.

Optional pointMarkerVerticalGridStrokeStyle

pointMarkerVerticalGridStrokeStyle : LineStyle

StrokeStyle for Vertical Grid originating from Cursor PointMarker

deprecated

Use customTickGridStrokeStyle instead.

Optional pointSeries3DPointStyle

pointSeries3DPointStyle : TriangulatedPoints3D | Palette<TriangulatedPoints3D>

PointStyle for Point Series 3D.

If undefined, will default to seriesTriangulatedPointStyle3D.

polarAmplitudeAxisStyle

polarAmplitudeAxisStyle : SolidLine

Style for Polar Amplitude Axis line.

polarAmplitudeAxisTitleStyle

polarAmplitudeAxisTitleStyle : FillStyle

Style for Polar Amplitude Axis Title.

Optional polarAreaSeriesFillStyle

polarAreaSeriesFillStyle : FillStyle | Palette<FillStyle>

Fill Style for Polar Area Series.

If undefined, will fallback to mountainsFillStyle.

Optional polarAreaSeriesStrokeStyle

polarAreaSeriesStrokeStyle : LineStyle | Palette<LineStyle>

Stroke Style for Polar Area Series.

If undefined, will fallback to mountainsStrokeStyle.

polarRadialAxisStyle

polarRadialAxisStyle : SolidLine

Style for Polar Radial Axis line.

polarRadialAxisTickStyle

polarRadialAxisTickStyle : VisibleTicks

Style for Polar Radial Axis Ticks.

polarRadialAxisTitleStyle

polarRadialAxisTitleStyle : FillStyle

Style for Polar Radial Axis Title.

Optional polygonSeriesFillStyle

polygonSeriesFillStyle : FillStyle | Palette<FillStyle>

FillStyle for Polygon Series.

If undefined, will default to seriesFillStyle.

Optional polygonSeriesStrokeStyle

polygonSeriesStrokeStyle : LineStyle | Palette<LineStyle>

LineStyle for Polygon Series.

If undefined, will default to emptyLine.

Optional rectangleSeriesFillStyle

rectangleSeriesFillStyle : FillStyle | Palette<FillStyle>

FillStyle for Rectangle Series.

If undefined, will default to seriesFillStyle.

Optional rectangleSeriesStrokeStyle

rectangleSeriesStrokeStyle : LineStyle | Palette<LineStyle>

LineStyle for Rectangle Series.

If undefined, will default to emptyLine.

resultTableFillStyle

resultTableFillStyle : FillStyle

FillStyle for Cursor ResultTable

resultTableStrokeStyle

resultTableStrokeStyle : LineStyle

StrokeStyle for Cursor ResultTable

resultTableTextFillStyle

resultTableTextFillStyle : FillStyle

FillStyle for Cursor ResultTable text

Optional resultTableTextFont

resultTableTextFont : FontSettings

FontSettings for Cursor ResultTable text

Optional, if undefined, will fallback to default LCJS font (same as new FontSettings()).

segmentSeriesStyle

segmentSeriesStyle : LineStyle | Palette<LineStyle>

StrokeStyle for segment series

seriesBackgroundFillStyle

seriesBackgroundFillStyle : FillStyle

FillStyle for series background fill.

This background exists in all chart types that have axes, and is contained in the area enclosed by the charts axes.

seriesBackgroundStrokeStyle

seriesBackgroundStrokeStyle : LineStyle

StrokeStyle for series background stroke.

This background exists in all chart types that have axes, and is contained in the area enclosed by the charts axes.

seriesFillStyle

seriesFillStyle : FillStyle | Palette<FillStyle>

FillStyle for a Chart XY Series

seriesNonTriangulatedPointStyle3D

seriesNonTriangulatedPointStyle3D : PixelatedPoints3D | Palette<PixelatedPoints3D>

PointStyle for 3D series with non-triangulated Points.

deprecated

Will be removed in v.4.0. Use pointCloudSeries3DPointStyle instead.

seriesPointFillStyle

seriesPointFillStyle : FillStyle | Palette<FillStyle>

FillStyle for a Chart XY Series Point.

seriesStrokeStyle

seriesStrokeStyle : SolidLine | Palette<SolidLine>

StrokeStyle for a Chart XY Series

seriesStrokeStyle3D

seriesStrokeStyle3D : SolidLine<SolidFill> | Palette<SolidLine<SolidFill>>

StrokeStyle for a Chart XYZ Series.

deprecated

Will be removed in v.4.0. Use lineSeries3DStrokeStyle instead.

seriesTriangulatedPointStyle3D

seriesTriangulatedPointStyle3D : TriangulatedPoints3D | Palette<TriangulatedPoints3D>

PointStyle for 3D Series with triangulated Points.

deprecated

Will be removed in v.4.0. Use pointSeries3DPointStyle instead.

sliceChartRadialFillStylePalette

sliceChartRadialFillStylePalette : Palette<FillStyle>

FillStyle Palette for Sliced Charts (Pie, Donut) Slices.

sliceChartStackedFillStylePalette

sliceChartStackedFillStylePalette : Palette<FillStyle>

FillStyle Palette for Sliced Charts (Funnel, Pyramid) Slices.

sliceChartStrokeStyle

sliceChartStrokeStyle : LineStyle

StrokeStyle for Sliced Chart (Pie, Funnel, Pyramid) Slices.

sliceLabelConnectorStyle

sliceLabelConnectorStyle : LineStyle

LineStyle for Sliced Chart (Pie, Funnel, Pyramid) Label connectors.

sliceLabelFillStyle

sliceLabelFillStyle : FillStyle

FillStyle for Sliced Chart (Pie, Funnel, Pyramid) Labels.

sliceLabelFont

sliceLabelFont : FontSettings

FontSettings for Sliced Chart (Pie, Funnel, Pyramid) Labels.

spiderAxisLabelFillStyle

spiderAxisLabelFillStyle : FillStyle

FillStyle for Spider axis labels.

spiderAxisLabelFont

spiderAxisLabelFont : FontSettings

FontSettings for Spider axis labels.

spiderAxisNibStyle

spiderAxisNibStyle : SolidLine

StrokeStyle for Axis Nib of Spider Chart.

spiderAxisStyle

spiderAxisStyle : SolidLine

StrokeStyle for Axis of Spider Chart.

spiderScaleLabelFillStyle

spiderScaleLabelFillStyle : FillStyle

FillStyle for Spider scale labels.

spiderScaleLabelFont

spiderScaleLabelFont : FontSettings

FontSettings for Spider scale labels.

spiderSeriesFillStyle

spiderSeriesFillStyle : FillStyle | Palette<FillStyle>

FillStyle for Spider Chart Series.

spiderSeriesStrokeStyle

spiderSeriesStrokeStyle : LineStyle | Palette<LineStyle>

StrokeStyle for Spider Chart Series.

spiderWebStyle

spiderWebStyle : LineStyle

StrokeStyle for Web line of Spider Chart.

surfaceSeriesFillStyle

surfaceSeriesFillStyle : FillStyle | Palette<FillStyle>

FillStyle for Surface series.

timeTickStrategy

timeTickStrategy : TimeTickStrategy

Default Time tick strategy configuration.

uiBackgroundFillStyle

uiBackgroundFillStyle : FillStyle

FillStyle for UI Element Background

uiBackgroundStrokeStyle

uiBackgroundStrokeStyle : LineStyle

StrokeStyle for UI Element Background

uiButtonFillStyle

uiButtonFillStyle : FillStyle

FillStyle for UI Button

uiButtonSize

uiButtonSize : number

Size for UI Button

uiFont

uiFont : FontSettings

Common UI font

Optional uiPointableTextBoxFillStyle

uiPointableTextBoxFillStyle : FillStyle

FillStyle for UIPointableTextBox Background.

This is used with default Auto Cursor (X, Y ticks) as well as with default Custom Ticks Axis.addCustomTick.

Added in v.3.1, if omitted or undefined will fallback to customTickMarkerFillStyle.

customTickMarkerFillStyle has priority over this, but it will be removed in next major release.

Optional uiPointableTextBoxFont

uiPointableTextBoxFont : FontSettings

FontSettings for UIPointableTextBox Text.

This is used with default Auto Cursor (X, Y ticks) as well as with default Custom Ticks Axis.addCustomTick.

Added in v.3.1, if omitted or undefined will fallback to customTickMarkerFont.

customTickMarkerFont has priority over this, but it will be removed in next major release.

Optional uiPointableTextBoxStrokeStyle

uiPointableTextBoxStrokeStyle : LineStyle

StrokeStyle for UIPointableTextBox Background Border.

This is used with default Auto Cursor (X, Y ticks) as well as with default Custom Ticks Axis.addCustomTick.

Added in v.3.1, if omitted or undefined will fallback to customTickMarkerTextFillStyle.

customTickMarkerTextFillStyle has priority over this, but it will be removed in next major release.

Optional uiPointableTextBoxTextFillStyle

uiPointableTextBoxTextFillStyle : FillStyle

FillStyle for UIPointableTextBox Text.

This is used with default Auto Cursor (X, Y ticks) as well as with default Custom Ticks Axis.addCustomTick.

Added in v.3.1, if omitted or undefined will fallback to customTickMarkerTextFillStyle.

customTickMarkerTextFillStyle has priority over this, but it will be removed in next major release.

uiTextFillStyle

uiTextFillStyle : FillStyle

FillStyle for UI Text

Optional uiTickFont

uiTickFont : FontSettings

FontSettings for UITick Text.

This is used with Custom Ticks, when UIElementBuilders.AxisTick is used:

 // Example, creation of UI tick.
 const tick = Axis.addCustomTick(UIElementBuilders.AxisTick)

Added in v.3.1, if omitted or undefined will fallback to customTickMarkerFont.

customTickMarkerFont has priority over this, but it will be removed in next major release.

Optional uiTickStrokeStyle

uiTickStrokeStyle : LineStyle

StrokeStyle for UITick Tick line.

This is used with Custom Ticks, when UIElementBuilders.AxisTick is used:

 // Example, creation of UI tick.
 const tick = Axis.addCustomTick(UIElementBuilders.AxisTick)

Added in v.3.1, if omitted or undefined will fallback to customTickMarkerTextFillStyle.

customTickMarkerTextFillStyle has priority over this, but it will be removed in next major release.

Optional uiTickTextFillStyle

uiTickTextFillStyle : FillStyle

FillStyle for UITick Text.

This is used with Custom Ticks, when UIElementBuilders.AxisTick is used:

 // Example, creation of UI tick.
 const tick = Axis.addCustomTick(UIElementBuilders.AxisTick)

Added in v.3.1, if omitted or undefined will fallback to customTickMarkerTextFillStyle.

customTickMarkerTextFillStyle has priority over this, but it will be removed in next major release.