Class GradientParams

Go to JavaScript Charting Documentation

Go to JavaScript Chart Examples

Go to SciChart.js on Github

A class used to define gradients by a number of gradient stops, with a start and end point

Hierarchy

GradientParams

Index

Constructors

constructor

Properties

Constructors

constructor

new GradientParams(startPoint: Point, endPoint: Point, gradientStops: TGradientStop[]): GradientParams

- Defined in src/Core/GradientParams.ts
description

Creates gradient brush params.

Parameters
- startPoint: Point
  
  x and y values should be from 0 to 1, 0 - start of the viewRect and 1 - end of the viewRect
- endPoint: Point
  
  x and y values should be from 0 to 1
- gradientStops: TGradientStop[]
  
  2 or more gradient stop point with color
Returns GradientParams

Properties

Readonly endPoint

endPoint: Point

Readonly gradientStops

gradientStops: keyof TGradientStop[] = []

Readonly startPoint

startPoint: Point

Generated using TypeDoc