LinearGradient – amCharts 4 Documentation

Type class

Linear gradient class.

Sources

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

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

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

Inheritance

LinearGradient extends BaseObject.

LinearGradient is not extended by any other symbol.

Properties

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 `object` Inherited 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.
element #	Type `Group` An SVG `<group>` element used to draw gradient.
gradientUnits #	Type `"objectBoundingBox"` \| `"userSpaceOnUse"` Default `objectBoundingBox` Which units are used when drawing gradient filter. Use `"userSpaceOnUse"` when applying gradient on a perfectly straight line. @since 4.9.17
id #	Type `$type.Optional` < `string` > Inherited from `BaseObject` Sets the user-defined id of the element.
rotation #	Type `number` Rotation (direction) of the gradient in degrees.
stops #	Type `List` < `IGradientStop` > A list of color stops in the gradient.
uid #	Type `string` Inherited from `BaseObject` Returns object's internal unique ID.
There are 4 inherited items currently hidden from this list.

Methods

addColor( color: `Color`, opacity?: `number`, offset?: `number` ) #	Returns `void` Adds a color step to the gradient.
clone( cloneId?: `string` ) #	Returns `this` Inherited 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.
constructor() #	Returns `LinearGradient` Constructor.
copyFrom( source: `this` ) #	Returns `void`
dispose() #	Returns `void` Inherited 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 `boolean` Inherited from `BaseObject` Returns if this object has been already been disposed.
There are 4 inherited items currently hidden from this list.

addColor(

color: Color,
opacity?: number,
offset?: number

)

Returns void

Adds a color step to the gradient.

clone(

cloneId?: string

)

Returns this

Inherited 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.

constructor()

Returns LinearGradient

Constructor.

copyFrom(

source: this

)

Returns void

dispose()

Returns void

Inherited 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 boolean

Inherited from BaseObject

Returns if this object has been already been disposed.

There are 4 inherited items currently hidden from this list.

Events

LinearGradient does not have any events.

Adapters

LinearGradient does not have any adapters.