LinearGradient

Type class

Linear gradient class.

Sources

LinearGradient can be used (imported) via one of the following packages.

TypeScript

/**
 * Import from: "core.ts"
 * Use like: am4core.LinearGradient
 */
import * as am4core from "@amcharts/amcharts4/core";

JavaScript

/**
 * Include via: <script src="core.js"></script>
 * Access items like: am4core.LinearGradient
 */

Inheritance

LinearGradient extends BaseObject.

LinearGradient is not extended by any other symbol.

Properties

#element

Type Group

An SVG <group> element used to draw gradient.

#gradientUnits

Type "objectBoundingBox" | "userSpaceOnUse"Default objectBoundingBoxSince 4.9.17

Which units are used when drawing gradient filter.

Use "userSpaceOnUse" when applying gradient on a perfectly straight line.

#rotation

Type number

Rotation (direction) of the gradient in degrees.

#stops

Type List <IGradientStop>

A list of color stops in the gradient.

4 inherited items

#clonedFrom

Type $type.Optional <this>Inherited from BaseObject

Reference to the original object this object was cloned from. We need to keep this so we can disassociate it from source object when this object is disposed.

#config

Type objectInherited from BaseObject

Use this property to set JSON-based config. When set, triggers processing routine, which will go through all properties, and try to apply values, create instances, etc.

Use this with caution, as it is a time-consuming process. It's used for initialchart setup only, not routine operations.

#id

Type $type.Optional <string>Inherited from BaseObject

Sets the user-defined id of the element.

#uid

Type stringInherited from BaseObject

Returns object's internal unique ID.

Methods

#addColor(color: Color,
opacity?: number,
offset?: number)

Returns void

Adds a color step to the gradient.

#constructor()

Returns LinearGradient

Constructor.

#copyFrom(source: this)

Returns void

4 inherited items

#clone(cloneId?: string)

Returns thisInherited from BaseObject

Makes a copy of this object and returns the clone. Try to avoid cloning complex objects like chart, create new instances if you need them.

#dispose()

Returns voidInherited from BaseObject

Destroys this object and all related data.

#getCurrentThemes()

Returns ITheme[]Inherited from BaseObject

Returns a list of themes that should be applied to this element. It could either be a list of themes set explicitly on this element, or system-wide.

#isDisposed()

Returns booleanInherited from BaseObject

Returns if this object has been already been disposed.

Events

LinearGradient does not have any events.