LightningChart JS API Reference

https://lightningchart.com/js-charts/api-documentation/v8.1.1/
Admin
This is the API reference documentation for the `@lightningchart/lcjs` package, providing detailed...
Tokens:345,302
Snippets:4,435
Trust Score:8
Update:3 months ago
Show doc for...
Tokens:
Raw
### start

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/Animation.html

Starts the animation.

```APIDOC
## start()

### Description
Starts an animation.

### Returns
- **Animation** - The object itself for fluent interface.
```

--------------------------------

### Theme Example Properties Warning

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/interfaces/ThemeExampleProperties.html

Note regarding the stability and intended usage of example theme properties.

```text
Theme example properties are primarly intended to be used by official LCJS applications and examples.  
     As such, users should be aware that they may change even in minor version releases.
```

--------------------------------

### getStart

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/SurfaceScrollingGridSeries3D.html

Get start coordinate of Heatmap on its X and Z axis.

```APIDOC
### getStart()

#### Description
Get start coordinate of Heatmap on its X and Z axis.

#### Returns
- **PointXZ**
```

--------------------------------

### getStart

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/HeatmapGridSeries.html

Get the start coordinate of the Heatmap on its X and Y axis.

```APIDOC
## getStart()

### Description
Get start coordinate of Heatmap on its X and Y axis.

### Returns
- **Point** - Coordinate on axis where 1st heatmap sample will be positioned.
```

--------------------------------

### getLabelConnectorGapStart()

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/PieChartWithLabelsOnSides.html

Get labelConnectorGapStart.

```APIDOC
## getLabelConnectorGapStart()

### Description
Get labelConnectorGapStart.

### Signature
`getLabelConnectorGapStart(): number`
```

--------------------------------

### getAmplitudeStart

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/PolarSector.html

Retrieves the start amplitude of the sector.

```APIDOC
## getAmplitudeStart()

### Description
Returns the start amplitude of the sector. If undefined, it tracks the PolarAxes start value.

### Returns
- **undefined | number** - The start amplitude.
```

--------------------------------

### setAmplitudeStart

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/PolarSector.html

Sets the start amplitude of the sector.

```APIDOC
## setAmplitudeStart(amplitudeStart)

### Description
Sets the sector's start amplitude.

### Parameters
- **amplitudeStart** (number) - The start amplitude.

### Returns
- **PolarSector** - The object itself for fluent interface.
```

--------------------------------

### Configure ChartXY Initialization

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/interfaces/ChartXYOptions.html

Examples of initializing a ChartXY with various configurations such as default axes, themes, and custom settings.

```javascript
 // Example, configure default X Axis.  
 const chart = LightningChart.ChartXY({  
     defaultAxisX: {  
         type: 'linear',  
     }  
 })
```

```javascript
 // Example 1, create chart with default configuration.  
 const chart = LightningChart.ChartXY({})
```

```javascript
 // Example 2, create chart with specified color theme.  
 const chart = LightningChart.ChartXY({  
     theme: Themes.light,  
 })
```

```javascript
 // Example 3, create chart with specified default axis configurations.  
 const chart = LightningChart.ChartXY({  
     defaultAxisX: {  
         type: 'linear',  
     },  
     defaultAxisY: {  
         type: 'logarithmic',  
         base: 10,  
     }  
 })
```

--------------------------------

### Initialize and configure a TextSeries

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/TextSeries.html

Demonstrates how to create a TextSeries, apply default styles, and add a text figure to the chart.

```javascript
 // Example usage  
 const fillText = new SolidFill({ color: ColorRGBA(255, 255, 255) })  
 const font = new FontSettings({ font: 'Segoe UI', size: 20 })  
 const textSeries = chart.addTextSeries()  
     .setEffect(false)  
     .setCursorEnabled(false)  
     .setHighlightOnHover(false)  
     .setDefaultStyle((fig) => fig.setFillStyle(fillText).setFont(font))  
  
 const textFigure = textSeries.add({ location: { x: 0, y: 0 }, alignment: { x: 0, y: 1 } })
```

--------------------------------

### Construct SolidFill with Color Factories

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/SolidFill.html

Examples of creating SolidFill instances using different color factory functions.

```javascript
 // Example using RGBA color factory.  
 const solidRed = new SolidFill({  
     color: ColorRGBA( 255, 0, 0 )  
 })
```

```javascript
 // Example using HEX color factory.  
 const solidRed = new SolidFill({  
     color: ColorHEX( '#ff0000' )  
 })
```

--------------------------------

### getAngleInterval(): { end: number; start: number; }

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/GaugeChart.html

Get the angle interval of the gauge.

```APIDOC
## getAngleInterval(): { end: number; start: number; }

### Description
Get the angle interval of the gauge.

### Returns
- **end** (number) - The end angle.
- **start** (number) - The start angle.
```

--------------------------------

### getStart

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/SurfaceGridSeries3D.html

Retrieves the start coordinate of the Heatmap on its X and Z axis.

```APIDOC
## getStart()

### Description
Get start coordinate of Heatmap on its X and Z axis.

### Returns
- **PointXZ** - Coordinate on axis where 1st heatmap sample will be positioned.
```

--------------------------------

### Save Chart to File Examples

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/functions/saveToFile.html

Demonstrates basic usage for downloading screenshots, specifying file formats, and adjusting compression quality.

```javascript
// Download 'screenshot.png'  
saveToFile(chart.engine, 'screenshot')  
// Attempt download 'maybeNotSupported.bmp'  
saveToFile(chart.engine, 'maybeNotSupported', 'image/bmp')  
// Attempt download jpeg.file with specified compression quality  
saveToFile(chart.engine, 'fileName', 'image/jpeg', 0.50)
```

--------------------------------

### MapChart Configuration and Usage

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/MapChart.html

Examples for initializing a MapChart, applying dynamic region coloring, and updating region values.

```APIDOC
## MapChart Initialization

### Description
Create a new MapChart instance by specifying the desired map type.

### Example
```javascript
const mapChart = lightningChart().Map({
    type: MapTypes.Europe,
})
```

## Dynamic Region Coloring

### Description
Configure the fill style of map regions using a PalettedFill to enable dynamic coloring based on a color look-up table.

### Example
```javascript
MapChart.setFillStyle(new PalettedFill({
    lut: new LUT({
        interpolate: true,
        steps: [
            { value: 0, color: ColorRGBA(255, 0, 0) },
            { value: 100, color: ColorRGBA(0, 255, 0) }
        ]
    })
}))
```

## Updating Region Values

### Description
Update the values associated with specific map regions to trigger color changes based on the configured LUT.

### Example
```javascript
MapChart.invalidateRegionValues([
    { value: 0, ISO_A3: 'FIN' }
])
```
```

--------------------------------

### Create Column Layouts

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/variables/UILayoutBuilders.html

Demonstrates creating a basic column layout and one with a custom background shape.

```javascript
// Create a Column  
Chart.addUIElement(UILayouts.Column)  
// Create a Column with specified Background  
Chart.addUIElement(UILayouts.Column.setBackground(UIBackgrounds.Circle))
```

--------------------------------

### getNextSampleIndex()

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/PointLineAreaSeries.html

Get next new sample index.

```APIDOC
### getNextSampleIndex()

#### Description
Get next new sample index. This also counts old samples that have been dropped out by data cleaning logic.

#### Returns
- **number** - The next sample index.
```

--------------------------------

### Create PieChart with Default Configuration

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/interfaces/PieChartOptions.html

Initialize a pie chart using default settings.

```javascript
 // Example 1, create chart with default configuration.  
 const chart = LightningChart.Pie({})
```

--------------------------------

### getCornerRadius()

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/TreeMapChart.html

Get rounded-ness of corners.

```APIDOC
## getCornerRadius()

### Description
Get rounded-ness of corners. (Beta: API might be changed depending on user feedback).

### Returns
- **undefined | number** - The corner radius or undefined.
```

--------------------------------

### getPointShape

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/PolarPointLineSeries.html

Get shape of points.

```APIDOC
## getPointShape()

### Description
Get shape of points.

### Returns
- **PointShape** - PointShape.
```

--------------------------------

### Constructing a LUT with interpolation settings

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/LUT.html

Examples showing how to initialize a LUT with interpolation disabled or enabled.

```javascript
 const lut = new LUT({  
     steps: [  
         { value: 0, color: ColorRGBA( 0, 0, 0 ) },  
         { value: 10, color: ColorRGBA( 255, 0, 0 ) },  
         { value: 100, color: ColorRGBA( 0, 255, 0 ) }  
     ],  
     interpolate: false  
 })
```

```javascript
 const lut = new LUT({  
     steps: [  
         { value: 0, color: ColorRGBA( 0, 0, 0 ) },  
         { value: 10, color: ColorRGBA( 255, 0, 0 ) },  
         { value: 100, color: ColorRGBA( 0, 255, 0 ) }  
     ],  
     interpolate: true  
 })
```

--------------------------------

### getPackData

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/OHLCSeries.html

Get packing status.

```APIDOC
## getPackData()

### Description
Get packing status. True = packing enabled, false = disabled. Default is true.

### Returns
- **boolean** - Packing status.
```

--------------------------------

### getWireframeStyle

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/HeatmapScrollingGridSeries.html

Get style of wireframe.

```APIDOC
## getWireframeStyle()

### Description
Get style of wireframe. Wireframe is a line grid that highlights the edges of each cell of the heatmap.

### Returns
- **LineStyle** - LineStyle.
```

--------------------------------

### Configure Point Fill Styles

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/PointCloudSeries3D.html

Examples for applying solid or paletted fill styles to point clouds.

```javascript
 // Example syntax, solid points color.  
 pointCloudSeries3D.setPointStyle(new PointStyle3D.Pixelated({  
     fillStyle: new SolidFill({ color: ColorRGBA(255, 0, 0) }),  
     size: 10  
 }))
```

```javascript
 // Example syntax, dynamic points color.  
 pointCloudSeries3D.setPointStyle(new PointStyle3D.Pixelated({  
     fillStyle: new PalettedFill({  
         // lookUpProperty defines basis of selecting look up value (number).  
         lookUpProperty: 'value',  
         // lut defines table for mapping look up value (number) to a color.  
         lut: new LUT({  
             interpolate: true,  
             steps: [  
                 { value: 0, color: ColorRGBA(0, 0, 0) },  
                 { value: 1, color: ColorRGBA(255, 0, 0) }  
             ]  
         })  
     }),  
     size: 10  
 }))
```

--------------------------------

### lightningChart(arg1?: string | LightningChartOptions, arg2?: AppDeploymentLicenseInformation)

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/functions/lightningChart-1.html

Initializes the LightningChart library and returns the main interface for creating top-level components.

```APIDOC
## lightningChart(arg1?: string | LightningChartOptions, arg2?: AppDeploymentLicenseInformation)

### Description
Initializes the LightningChart library. Returns the main interface of LCJS, which is used to create all top level components such as charts and dashboards.

### Parameters
- **arg1** (string | LightningChartOptions) - Optional - Object containing properties supported by LightningChartOptions, primarily used for supplying license information.
- **arg2** (AppDeploymentLicenseInformation) - Optional - Additional information for license verification, required only by Application Deployment licenses.

### Returns
- **LightningChart** - The main interface object for creating charts and components.

### Example
```javascript
const lcjs = lightningChart({  
    // Either supply license number, or omit for automatic community license.  
    // license: 'my-license-number'  
})  
 
// Create charts...  
const chart = lcjs.ChartXY()
```
```

--------------------------------

### getSeries

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/ChartWithSeries.html

Get series of a chart.

```APIDOC
## getSeries()

### Description
Get series of a chart.

### Returns
- **_SeriesType[]** - Array of series
```

--------------------------------

### getValue

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/ConstantLine.html

Get value of ConstantLine.

```APIDOC
## getValue()

### Description
Get value of ConstantLine. This is in values of its owning Axis.

### Returns
- **number** - Value on Axis.
```

--------------------------------

### Create OHLC Series with Configuration

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/interfaces/OHLCSeriesOptions.html

Demonstrates initializing an OHLC series with default settings or specific visual types like bars.

```javascript
 // Example 1, create series with default configuration.  
 const series = ChartXY.addOHLCSeries({})
```

```javascript
 // Example 2, display data as bars  
 const series = ChartXY.addOHLCSeries({  
     type: OHLCSeriesTypes.Bars  
 })
```

--------------------------------

### getFillStyle

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/BoxSeries3D.html

Get FillStyle of BoxSeries.

```APIDOC
### getFillStyle()

#### Description
Get FillStyle of BoxSeries. Supports SolidFill, IndividualPointFill, and PalettedFill.

#### Returns
- **FillStyle** - The FillStyle object.
```

--------------------------------

### getBoundaries

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/AreaRangeSeries.html

Get the boundaries of the series.

```APIDOC
## getBoundaries()

### Returns
- **Interval<Point>**
```

--------------------------------

### new LUT(options: LUTOptions)

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/LUT.html

Constructs a new LUT object with the specified configuration options.

```APIDOC
## new LUT(options: LUTOptions)

### Description
Constructs a LUT object, specifying any amount of its properties to define color mapping behavior.

### Parameters
#### options (LUTOptions) - Required
- **steps** (LUTStep[]) - The collection of colors and their corresponding values.
- **interpolate** (boolean) - Whether to use linear interpolation (gradient) or a step-function.
- **formatter** (function) - Custom formatter for LUT values.
- **percentageValues** (boolean) - Whether values represent percentages.
- **title** (string) - Title of the LUT.
- **units** (string) - Units of the data-values.

### Returns
- **LUT** - A new LUT instance.
```

--------------------------------

### Create PyramidChart with default configuration

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/interfaces/PyramidChartOptions.html

Initialize a pyramid chart using default settings.

```javascript
 // Example 1, create pyramid chart with default configuration.  
 const chart = LightningChart.Pyramid({})
```

--------------------------------

### setAngleStart

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/PolarSector.html

Sets the start angle of the sector.

```APIDOC
## setAngleStart(angleStart)

### Description
Sets the sector's start angle in degrees.

### Parameters
- **angleStart** (number) - Start angle in degrees.

### Returns
- **PolarSector** - The object itself for fluent interface.
```

--------------------------------

### Define PyramidChart configurations

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/interfaces/PyramidOptions.html

Examples showing how to define PyramidChart configurations with default and specific types.

```typescript
// Pyramid Chart with default type  
undefined  
// Pyramid Chart with specified type  
{ pyramidOptions: { type: PyramidChartTypes.LabelsInsideSlices } }
```

--------------------------------

### Initialize Chart3D with default or custom settings

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/interfaces/ChartOptions3D.html

Create a 3D chart using either default settings or a specific color theme.

```javascript
 // Example 1, create chart with default configuration.  
 const chart = LightningChart.Chart3D({})
```

```javascript
 // Example 2, create chart with specified color theme.  
 const chart = LightningChart.Chart3D({  
     theme: Themes.light,  
 })
```

--------------------------------

### getTickLength

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/interfaces/AbstractCustomTick.html

Gets the tickline length in pixels.

```APIDOC
## getTickLength()

### Description
Get tickline length as pixels.

### Returns
- **number** - Tickline length as pixels.
```

--------------------------------

### LightningChart.ChartXY(options: ChartXYOptions)

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/interfaces/ChartXYOptions.html

Initializes a new ChartXY instance with the provided configuration options.

```APIDOC
## LightningChart.ChartXY(options: ChartXYOptions)

### Description
Creates a new ChartXY instance. The options object allows for initial configuration of the chart, such as themes, axis settings, and animation states.

### Parameters
- **animationsEnabled** (boolean) - Optional - Convenience flag to enable or disable all animations in the chart.
- **cursorBuilder** (CursorBuilderXY) - Optional - Builder for the chart's auto cursor.
- **defaultAxisX** (AxisOptions) - Optional - Configuration for the default X Axis.
- **defaultAxisY** (AxisOptions) - Optional - Configuration for the default Y Axis.
- **legend** (LegendOptions) - Optional - Configuration for the chart legend.
- **theme** (Theme) - Optional - Specify the chart color theme.

### Example
```javascript
const chart = LightningChart.ChartXY({
    theme: Themes.light,
    defaultAxisX: {
        type: 'linear'
    },
    animationsEnabled: false
});
```
```

--------------------------------

### Construct and Apply a SolidLine

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/SolidLine.html

Shows how to instantiate a SolidLine object and apply it to a LineSeries.

```javascript
 // Example, 1px solid red line.  
 const solidRed = new SolidLine({  
     thickness: 1,  
     fillStyle: new SolidFill({ color: ColorRGBA( 255, 0, 0 ) })  
 })  
  
 LineSeries.setStrokeStyle(solidRed)
```

--------------------------------

### getLayout

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/ZoomBandChart.html

Get chart layout information.

```APIDOC
## getLayout()

### Description
Get chart layout information. This is a getter variant of ChartXYLayoutChangedEvent.

### Returns
- **Promise<ChartXYLayoutInfo>** - Promise of layout information.
```

--------------------------------

### Initialize and Configure ParallelCoordinateChart

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/ParallelCoordinateChart.html

Demonstrates the basic setup of a parallel coordinate chart, including axis definition, interval setting, and adding a data series.

```javascript
 // Basic syntax  
 const chart = lightningChart().ParallelCoordinateChart()  
 const Axes = {  
     'Variable A': 0,  
     'Variable B': 1,  
     'Variable C': 2,  
 }  
 chart.setAxes(Axes)  
 chart.getAxis(Axes['Variable A']).setInterval({ start: 20, end: 60 })  
 chart.getAxis(Axes['Variable B']).setInterval({ start: 80, end: 120 })  
 chart.getAxis(Axes['Variable C']).setInterval({ start: 0.0, end: 2.5 })  
  
 const series1 = chart.addSeries().setName('Sample 1').setData({  
   'Variable A': 50,  
   'Variable B': 100,  
   'Variable C': 2.0,  
 })
```

--------------------------------

### getPathLabelFont()

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/TreeMapChart.html

Get the font of the path labels.

```APIDOC
## getPathLabelFont()

### Description
Get the font of the path labels.

### Returns
- **FontSettings** - The font settings.
```

--------------------------------

### getPathLabelFillStyle()

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/TreeMapChart.html

Get the color of the path labels.

```APIDOC
## getPathLabelFillStyle()

### Description
Get the color of the path labels.

### Returns
- **FillStyle** - The fill style.
```

--------------------------------

### Creating PointLineSeries3D

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/PointLineSeries3D.html

Demonstrates how to instantiate a PointLineSeries3D using the Chart3D instance.

```APIDOC
## PointLineSeries3D Creation

### Description
Creates a new instance of PointLineSeries3D within a 3D chart.

### Usage
```javascript
const pointLineSeries3D = chart3D.addPointLineSeries();
```
```

--------------------------------

### setStart

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/SurfaceScrollingGridSeries3D.html

Set start coordinate of Heatmap on its X and Z axis.

```APIDOC
### setStart(start: undefined | PointXZ)

Set start coordinate of Heatmap on its X and Z axis.

#### Parameters
- **start** (undefined | PointXZ) - Coordinate on axis where 1st heatmap sample will be positioned.

#### Returns
- **SurfaceScrollingGridSeries3D** - The object itself.
```

--------------------------------

### getNodeBorderStyle()

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/TreeMapChart.html

Get the LineStyle of the node labels.

```APIDOC
## getNodeBorderStyle()

### Description
Get the LineStyle of the node labels.

### Returns
- **LineStyle** - The line style.
```

--------------------------------

### Create colors using ColorHEX

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/functions/ColorHEX.html

Demonstrates initializing colors with standard and transparent hexadecimal strings.

```javascript
 const colorRed = ColorHEX('#ff0000')  
 const colorTransparentGreen = ColorHEX('#00ff0010')
```

--------------------------------

### setStart

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/SurfaceGridSeries3D.html

Sets the start coordinate of the heatmap on its X and Z axis.

```APIDOC
## setStart(start: undefined | PointXZ)

### Description
Set start coordinate of Heatmap on its X and Z axis.

### Parameters
- **start** (undefined | PointXZ) - Required - Coordinate on axis where 1st heatmap sample will be positioned.
```

--------------------------------

### getLabelFillStyle()

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/TreeMapChart.html

Get the FillStyle of the node labels.

```APIDOC
## getLabelFillStyle()

### Description
Get the FillStyle of the node labels.

### Returns
- **FillStyle** - The fill style.
```

--------------------------------

### ParallelCoordinateChart Initialization

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/ParallelCoordinateChart.html

Demonstrates how to instantiate a ParallelCoordinateChart, define axes, set axis intervals, and add data series.

```APIDOC
## ParallelCoordinateChart Initialization

### Description
Creates a new instance of a ParallelCoordinateChart and configures its axes and data series.

### Usage
```javascript
const chart = lightningChart().ParallelCoordinateChart();
const Axes = {
    'Variable A': 0,
    'Variable B': 1,
    'Variable C': 2,
};
chart.setAxes(Axes);
chart.getAxis(Axes['Variable A']).setInterval({ start: 20, end: 60 });

const series1 = chart.addSeries().setName('Sample 1').setData({
  'Variable A': 50,
  'Variable B': 100,
  'Variable C': 2.0,
});
```
```

--------------------------------

### getHeaderFont()

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/TreeMapChart.html

Get the font of the node labels.

```APIDOC
## getHeaderFont()

### Description
Get the font of the node labels.

### Returns
- **FontSettings** - The font settings.
```

--------------------------------

### Create Row Layouts

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/variables/UILayoutBuilders.html

Demonstrates creating a basic row layout and one with a custom background shape.

```javascript
// Create a Row  
Chart.addUIElement(UILayouts.Row)  
// Create a Row with specified Background  
Chart.addUIElement(*UILayouts.Row.setBackground(UIBackgrounds.Circle))
```

--------------------------------

### Creating PointSeries3D

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/PointSeries3D.html

Demonstrates how to instantiate a PointSeries3D using the Chart3D.addPointSeries method.

```APIDOC
## Creating PointSeries3D

### Description
PointSeries3D instances are created via the `addPointSeries` method on a `Chart3D` object. Configuration options are passed as an object parameter.

### Example
```javascript
const pointSeries3D = Chart3D.addPointSeries({
    // Enable individual data points size.
    individualPointSizeEnabled: true
});
```
```

--------------------------------

### getHeaderFillStyle()

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/TreeMapChart.html

Get the FillStyle of the node labels.

```APIDOC
## getHeaderFillStyle()

### Description
Get the FillStyle of the node labels.

### Returns
- **FillStyle** - The fill style.
```

--------------------------------

### getPointRotation

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/PolarPointLineSeries.html

Get the current rotation of points.

```APIDOC
## getPointRotation()

### Description
Get the current rotation of points.

### Returns
- **number** - The current rotation of points.
```

--------------------------------

### Create a BarChart

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/interfaces/LightningChart.html

Shows how to instantiate a BarChart by specifying a container element ID.

```javascript
 // Example, create bar chart inside DOM element managed by user. The element must be added to the document, before creating the chart.  
 const chart = LightningChart.BarChart({  
     // Argument can be either *element id* or actual reference to the HTML element.  
     container: 'my-chart-div'  
 })
```

--------------------------------

### getLabelSliceOffset()

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/PieChartWithLabelsOnSides.html

Get distance between slice and label.

```APIDOC
## getLabelSliceOffset()

### Description
Get distance between slice and label (includes explosion offset), this points to reference position of label, so not necessarily the nearest corner.

### Signature
`getLabelSliceOffset(): number`
```

--------------------------------

### Create a Dashboard with a Theme

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/interfaces/DashboardOptions.html

Initializes a dashboard with defined grid dimensions and a specific color theme.

```javascript
 // Example 1, create dashboard with specified color theme.  
 const dashboard = LightningChart.Dashboard({  
     // Number of cells in X direction.  
     numberOfColumns: 3,  
     // Number of cells in Y direction.  
     numberOfRows: 3,  
     // Select color theme.  
     theme: Themes.light,  
 })
```

--------------------------------

### getStrokeStyle()

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/PolarAreaSeriesInterior.html

Get stroke style of Series.

```APIDOC
### getStrokeStyle()

#### Description
Get stroke style of Series.

#### Returns
- **LineStyle** - LineStyle object
```

--------------------------------

### Construct LUT with regularColorSteps

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/functions/regularColorSteps.html

Usage example for creating a LUT object using the regularColorSteps helper.

```javascript
 // Example, construct LUT with regular color steps from an array of colors.  
 const lut = new LUT({  
     interpolate: true,  
     steps: regularColorSteps(0, 100, [ ColorCSS('red'), ColorCSS('blue'), ColorCSS('green') ])  
 })
```

--------------------------------

### getPointStyle

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/PointCloudSeries3D.html

Get normal points style.

```APIDOC
## getPointStyle()

### Description
Get normal points style.

### Returns
- **PixelatedPoints3D** - The point style object.
```

--------------------------------

### constructor

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/EmptyFill.html

Creates a new instance of EmptyFill.

```APIDOC
## constructor

### Description
Creates a new instance of EmptyFill.

### Signature
`new EmptyFill(values?: Iterable<[string, unknown]> | Partial<{ fillType: "empty"; type: "fillstyle"; }>): EmptyFill`

### Parameters
- **values** (Iterable<[string, unknown]> | Partial<{ fillType: "empty"; type: "fillstyle"; }>) - Optional - Configuration values for the fill style.
```

--------------------------------

### Create PyramidChart with theme

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/interfaces/PyramidChartOptions.html

Initialize a pyramid chart with a specific color theme.

```javascript
 // Example, create chart with specified color theme.  
 const chart = LightningChart.Pyramid({  
     theme: Themes.light,  
 })
```

--------------------------------

### getLabelShadow

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/FunnelChart.html

Get label shadow color.

```APIDOC
## getLabelShadow()

### Description
Beta: Get label shadow color.

### Returns
undefined | Color
```

--------------------------------

### Configure ButtonBox UI Elements

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/variables/UIElementBuilders.html

Shows how to create a ButtonBox and customize its background or button shape.

```javascript
// Create a ButtonBox  
Chart.addUIElement(UIElementBuilders.ButtonBox)  
// Create a ButtonBox with specified Background  
Chart.addUIElement(UIElementBuilders.ButtonBox.setBackground(UIBackgrounds.Circle))  
// Create a ButtonBox with specified ButtonPicture  
Chart.addUIElement(UIElementBuilders.ButtonBox.setButtonShape(PointShape.Diamond))
```

--------------------------------

### getLabelFormatter

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/FunnelChart.html

Get formatter of Slice Labels.

```APIDOC
## getLabelFormatter()

### Description
Get formatter of Slice Labels.

### Returns
SliceLabelFormatter<FunnelSlice>
```

--------------------------------

### Create PieChart with Theme

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/interfaces/PieChartOptions.html

Initialize a pie chart with a specific color theme.

```javascript
 // Example, create chart with specified color theme.  
 const chart = LightningChart.Pie({  
     theme: Themes.light,  
 })
```

--------------------------------

### getFillStyle()

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/HeatmapScrollingGridSeriesIntensityValues.html

Get the fill style of the series.

```APIDOC
## getFillStyle()

### Description
Get fill style of series.

### Returns
- **FillStyle** - The current FillStyle.
```

--------------------------------

### getLabelFont()

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/FunnelChartWithLabelsOnSides.html

Get font of Slice Labels.

```APIDOC
## getLabelFont()

### Description
Get font of Slice Labels.

### Returns
- **FontSettings** - FontSettings object.
```

--------------------------------

### Create a Chart3D

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/interfaces/LightningChart.html

Shows how to instantiate a Chart3D by specifying a container element ID.

```javascript
 // Example, create chart inside DOM element managed by user. The element must be added to the document, before creating the chart.  
 const chart = LightningChart.Chart3D({  
     // Argument can be either *element id* or actual reference to the HTML element.  
     container: 'my-chart-div'  
 })
```

--------------------------------

### getAggregation

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/HeatmapScrollingGridSeries.html

Gets the heatmap aggregation configuration.

```APIDOC
## getAggregation()

### Description
Get heatmap aggregation config.

### Returns
- **IntensityAggregationMode** - The current aggregation mode.
```

--------------------------------

### lightningChart(options: LightningChartOptions)

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/interfaces/LightningChartOptions.html

Initializes the LightningChart JS library with the provided configuration options.

```APIDOC
## lightningChart(options: LightningChartOptions)

### Description
Initializes the LightningChart JS library. This function accepts an optional configuration object to define licensing and resource base URLs.

### Parameters
- **options** (LightningChartOptions) - Optional - Configuration object for the library.

#### LightningChartOptions Properties
- **license** (string) - Optional - Development or deployment license key. Defaults to community license if omitted.
- **licenseInformation** (AppDeploymentLicenseInformation) - Optional - Additional information for license verification, required for Application Deployment licenses.
- **resourcesBaseUrl** (string) - Optional - URL path to the file server hosting LightningChart JS resources (e.g., maps, themes). Use 'fs:<path>' for Node.js environments.

### Usage Example
```javascript
const lcjs = lightningChart({
    license: 'my-license-number',
    resourcesBaseUrl: 'http://127.0.0.1:8081'
});
```
```

--------------------------------

### Create Dashboard instance

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/interfaces/LightningChart.html

Initializes a Dashboard with a defined grid layout. The grid dimensions are immutable after creation.

```javascript
 // Example, Create a 3x3 dashboard.  
 const dashboard = LightningChart.Dashboard({  
     // Number of cells along horizontal plane.  
     numberOfColumns: 3,  
     // Number of cells along vertical plane.  
     numberOfRows: 3,  
 })
```

```javascript
 // Example, create 3x3 dashboard inside DOM element managed by user. The element must be added to the document, before creating the dashboard.  
 const chart = LightningChart.Dashboard({  
     // Number of cells along horizontal plane.  
     numberOfColumns: 3,  
     // Number of cells along vertical plane.  
     numberOfRows: 3,  
     // Argument can be either *element id* or actual reference to the HTML element.  
     container: 'my-chart-div'  
 })
```

--------------------------------

### getDefaultAxisY()

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/ChartXY.html

Gets a reference to the default Y axis.

```APIDOC
## getDefaultAxisY()

### Description
Get reference to the default Y Axis of the ChartXY.

### Returns
- **Axis** - Default Y Axis of chart.
```

--------------------------------

### Creating an ImageFill with a video source

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/ImageFill.html

Initializes an ImageFill using an HTMLVideoElement as the source with the Fit mode.

```javascript
const myVideo = document.createElement('video')  
myVideo.autoplay = true  
myVideo.muted = true  
myVideo.loop = true  
myVideo.src = 'https://example.com/myVideo.mp4'  
myVideo.play()  
const imageFill = new ImageFill({  
     source: myVideo,  
     fitMode: ImageFitModes.Fit  
})
```

--------------------------------

### getCursorFormatting()

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/ChartXY.html

Gets the active cursor formatter.

```APIDOC
## getCursorFormatting()

### Description
Get active cursor formatter.

### Returns
- **CursorFormatterChartXY** - Cursor formatter.
```

--------------------------------

### Configure transparent chart backgrounds

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/Chart3D.html

Demonstrates how to set transparency for the engine, chart, and series backgrounds.

```javascript
 // Example, partially transparent chart  
  
 // Engine background exists under all LCJS components. In case of Dashboard, there is only 1 shared engine background.  
 chart.engine.setBackgroundFillStyle(emptyFill)  
 // Chart background covers every 1 chart. In case of Dashboard, every chart has its own chart background.  
 chart.setBackgroundFillStyle(new SolidFill({ color: ColorRGBA(0, 0, 0, 100) }))  
 // Some charts also have a separate series background.  
 chart.setSeriesBackgroundFillStyle(new SolidFill({ color: ColorRGBA(0, 0, 0, 100) }))
```

--------------------------------

### getYMin

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/BoxSeries3D.html

Get Min Y value of the series.

```APIDOC
### getYMin()

#### Returns
- **number** - Min Y value of the series.
```

--------------------------------

### getYMax

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/BoxSeries3D.html

Get Max Y value of the series.

```APIDOC
### getYMax()

#### Returns
- **number** - Max Y value of the series.
```

--------------------------------

### constructor

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/EmptyTickStrategy.html

Creates a new instance of EmptyTickStrategy.

```APIDOC
## constructor

### Description
Creates a new instance of the EmptyTickStrategy class.

### Signature
`new EmptyTickStrategy(values?: Iterable<[string, unknown]> | Partial<EmptyTickStrategyProperties>): EmptyTickStrategy`

### Parameters
- **values** (Iterable<[string, unknown]> | Partial<EmptyTickStrategyProperties>) - Optional - Configuration properties for the strategy.
```

--------------------------------

### getRoundedEdges

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/BoxSeries3D.html

Get rounded edges of Boxes.

```APIDOC
### getRoundedEdges()

#### Description
Get rounded edges of Boxes. Note: Rounded edges result in increased geometry precision.

#### Returns
- **undefined | number** - A number in range [0, 1] describing the amount of rounding or undefined for disabled.
```

--------------------------------

### constructor

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/UIObject.html

Creates a new instance of a UIObject.

```APIDOC
## constructor

### Description
Creates a new instance of the UIObject class.

### Signature
`new UIObject(): UIObject`

### Returns
- **UIObject** - A new instance of the UIObject.
```

--------------------------------

### Configure Resources for Node.js

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/interfaces/LightningChartOptions.html

Use the fs: prefix to provide a local file system path for resources when running in a Node.js environment.

```javascript
 const lcjs = lightningChart({  
     resourcesBaseUrl: `fs:${path.resolve(__dirname, 'node_modules', '@lightningchart', 'lcjs', 'dist', 'resources')}`  
 })
```

--------------------------------

### getStrokeStyle

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/ConstantLine.html

Get stroke style of ConstantLine.

```APIDOC
## getStrokeStyle()

### Description
Get stroke style of ConstantLine.

### Returns
- **LineStyle** - Normal StrokeStyle
```

--------------------------------

### getAngleStart

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/PolarSector.html

Retrieves the start angle of the sector in degrees.

```APIDOC
## getAngleStart()

### Description
Returns the start angle of the sector in degrees.

### Returns
- **number** - The start angle in degrees.
```

--------------------------------

### setAngleInterval

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/GaugeChart.html

Sets the start and end angles for the gauge.

```APIDOC
## setAngleInterval(angleStartDeg, angleEndDeg)

### Description
Set the angle interval of the gauge.

### Parameters
- **angleStartDeg** (number) - Required - Start angle.
- **angleEndDeg** (number) - Required - End angle.
```

--------------------------------

### BoxSeries3D Usage

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/BoxSeries3D.html

Example demonstrating how to construct a grid of vertical boxes using the BoxSeries3D class.

```APIDOC
const data = [  
    { x: 0, z: 0 },  
    { x: 1, z: 0 },  
    { x: 0, z: 1 },  
    { x: 1, z: 1 }  
]  
.map( coords => {  
    const height = Math.random() * 100  
    return {  
        xCenter: coords.x,  
        yCenter: height / 2,  
        zCenter: coords.z,  
        xSize: 1,  
        ySize: height,  
        zSize: 1  
    }  
})  
const chart = lightningChart().Chart3D()  
const boxSeries = chart.addBoxSeries()  
    .invalidateData( data )
```

--------------------------------

### getClockwise

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/interfaces/PolarAxisRadial.html

Get whether PolarAxisRadial is clockwise or counterclockwise.

```APIDOC
## getClockwise()

### Description
Get whether PolarAxisRadial is clockwise or counterclockwise.

### Returns
- **boolean** - True for clockwise direction, False for counterclockwise.
```

--------------------------------

### getTickStyle

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/interfaces/AbstractCustomTick.html

Gets the style of the custom ticks tickline.

```APIDOC
## getTickStyle()

### Description
Get style of custom ticks tickline.

### Returns
- **LineStyle** - The line style object.
```

--------------------------------

### Create FunnelChart with default configuration

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/interfaces/FunnelChartOptions.html

Initializes a funnel chart using default settings.

```javascript
 // Example 1, create funnel chart with default configuration.  
 const chart = LightningChart.Funnel({})
```

--------------------------------

### Create a ZoomBandChart

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/interfaces/LightningChart.html

Initializes a ZoomBandChart to display a zoomed-out overview of data. Requires a DOM container reference.

```javascript
 // Example, create chart inside DOM element managed by user. The element must be added to the document, before creating the chart.  
 const chart = LightningChart.ZoomBandChart({  
     // Argument can be either *element id* or actual reference to the HTML element.  
     container: 'my-chart-div'  
 })
```

--------------------------------

### getGridStrokeStyle

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/interfaces/AbstractCustomTick.html

Gets the style of the custom ticks gridline.

```APIDOC
## getGridStrokeStyle()

### Description
Get style of custom ticks gridline.

### Returns
- **LineStyle** - The line style object.
```

--------------------------------

### Creating LineSeries3D

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/LineSeries3D.html

Demonstrates how to instantiate a LineSeries3D using the Chart3D.addLineSeries method.

```APIDOC
## Creating LineSeries3D

### Description
LineSeries3D instances are created using the addLineSeries method on a Chart3D object.

### Example
```javascript
const lineSeries3D = chart3D.addLineSeries();
```
```

--------------------------------

### getMinimumSize

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/UILegendPanel.html

Gets the minimum size of the UIPanel in pixels.

```APIDOC
## getMinimumSize()

### Description
Get minimum size of UIPanel in pixels as set by user.

### Returns
- **undefined | Point** - Point minimum size in pixels or undefined.
```

--------------------------------

### getIntensityInterpolation

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/SurfaceScrollingGridSeries3D.html

Get surface intensity interpolation mode.

```APIDOC
### getIntensityInterpolation()

#### Description
Get surface intensity interpolation mode.

#### Returns
- **IntensityInterpolationMode**
```

--------------------------------

### getPointFillStyle()

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/PointLineAreaSeries.html

Get current markers fill style.

```APIDOC
### getPointFillStyle()

#### Description
Get current markers fill style.

#### Returns
- **FillStyle** - FillStyle object.
```

--------------------------------

### Create DataGrid instance

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/interfaces/LightningChart.html

Initializes a DataGrid component within a specified DOM container.

```javascript
 // Example, create data grid inside DOM element managed by user. The element must be added to the document, before creating the chart.  
 const dataGrid = LightningChart.DataGrid({  
     // Argument can be either *element id* or actual reference to the HTML element.  
     container: 'my-chart-div'  
 })
```

--------------------------------

### getPointDisplayBehavior()

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/PointLineAreaSeries.html

Get current point display behavior.

```APIDOC
### getPointDisplayBehavior()

#### Description
Get current point display behavior.

#### Returns
- **undefined | { sensitivity: number }** - Point display behavior object.
```

--------------------------------

### Create Color from CSS String

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/functions/ColorCSS.html

Demonstrates initializing color objects using standard CSS color names and RGBA strings.

```javascript
 const colorRed = ColorCSS('red')  
 const colorTransparentGreen = ColorCSS('rgba(0, 255, 0, 0.5)')
```

--------------------------------

### getDataSet()

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/PointLineAreaSeries.html

Get active data set of the series.

```APIDOC
## getDataSet()

### Description
Get active data set of the series.

### Returns
- **DataSetXY**
```

--------------------------------

### Configure LabelFillStyle

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/TickStyle.html

Demonstrates how to set the label fill style using a direct FillStyle instance, a mutator function, or by hiding it with emptyFill.

```javascript
// Specified FillStyle  
TickStyle.setLabelFillStyle(new SolidFill({ color: ColorHEX('#F00') }))  
// Changed transparency  
TickStyle.setLabelFillStyle((solidFill) => solidFill.setA(80))  
// Hidden  
TickStyle.setLabelFillStyle(emptyFill)
```

--------------------------------

### getCurvePreprocessing()

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/PointLineAreaSeries.html

Get active curve preprocessing mode.

```APIDOC
## getCurvePreprocessing()

### Description
Get active curve preprocessing mode.

### Returns
- **undefined | CurvePreprocessing** - CurvePreprocessing interface.
```

--------------------------------

### getAreaFillStyle()

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/PointLineAreaSeries.html

Get current area fill style.

```APIDOC
## getAreaFillStyle()

### Description
Get current area fill style.

### Returns
- **FillStyle** - FillStyle object.
```

--------------------------------

### Define ThemePropertyWithCallbackOption

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/types/ThemePropertyWithCallbackOption.html

Examples demonstrating both static value assignment and dynamic callback assignment for theme properties.

```typescript
 // Example, hard defined value  
 lineSeriesStrokeStyle: new SolidLine({ thickness: 2, fillStyle: ColorRGBA(255, 0, 0) })
```

```typescript
 // Example, different color for each series  
 lineSeriesStrokeStyle: (index) => new SolidLine({ thickness: 2, fillStyle: ColorHSV(index * 90) })
```

--------------------------------

### Create SpiderChart with Default Configuration

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/interfaces/SpiderChartOptions.html

Initialize a SpiderChart using default settings.

```typescript
 // Example 1, create chart with default configuration.  
 const chart = LightningChart.Spider({})
```

--------------------------------

### getPointSize

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/PolarPointLineSeries.html

Get current size of points in pixels.

```APIDOC
## getPointSize()

### Description
Get current size of points in pixels.

### Returns
- **number** - Size of point in pixels.
```

--------------------------------

### getPointFillStyle

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/PolarPointLineSeries.html

Get normal points fill style.

```APIDOC
## getPointFillStyle()

### Description
Get normal points fill style.

### Returns
- **FillStyle** - Normal point fillStyle.
```

--------------------------------

### new SolidFill(props?: Partial<VisibleFillStyleProperties>)

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/SolidFill.html

Constructs a new SolidFill object with the specified properties.

```APIDOC
## constructor

### Description
Constructs a SolidFill object, specifying any amount of its properties.

### Parameters
- **props** (Partial<VisibleFillStyleProperties>) - Optional - Object containing any amount of SolidFill properties.

### Returns
- **SolidFill** - A new SolidFill instance.
```

--------------------------------

### PolarAreaSeries.draggable

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/PolarAreaSeries.html

Get or set the draggable state of the series.

```APIDOC
## Accessor: draggable

### Description
Controls whether the series can be dragged.

### Getter
- **Returns**: boolean

### Setter
- **Parameters**:
  - **state** (boolean) - The new draggable state.
```

--------------------------------

### Create Bar Chart with Default Configuration

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/interfaces/BarChartOptions.html

Initializes a bar chart using default settings.

```typescript
 // Example 1, create chart with default configuration.  
 const chart = lightningChart().BarChart({})
```

--------------------------------

### Create PointLineAreaSeries with default configuration

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/interfaces/PointLineAreaSeriesOptions.html

Initializes a series using default settings.

```javascript
 // Example 1, create series with default configuration.  
 const series = ChartXY.addPointLineAreaSeries({})
```

--------------------------------

### getStrokeStylePositive

Source: https://lightningchart.com/js-charts/api-documentation/v8.1.1/classes/OHLCSeriesBars.html

Gets the positive change stroke style.

```APIDOC
## getStrokeStylePositive()

### Description
Get positive change stroke style.

### Returns
- **LineStyle** - Stroke style.
```
Tokens:
Raw