Documentation

RadialGradient

Type class

Radial gradient class.

Sources

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

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


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

Inheritance

RadialGradient extends BaseObject.

RadialGradient 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.
cx
#

Type $type.Optional < number | Percent >

Center x coordinate of the gradient, can be set as number or Percent
cy
#

Type $type.Optional < number | Percent >

Center y coordinate of the gradient, can be set as number or Percent
fx
#

Type $type.Optional < number | Percent >

y coordinate of the focal point of a gradient, can be set in pixels or as Percent
fy
#

Type $type.Optional < number | Percent >

y coordinate of the focal point of a gradient, can be set in pixels or as Percent
id
#

Type $type.Optional < string >

Inherited from BaseObject

Sets the user-defined id of the element.
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 RadialGradient

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

RadialGradient does not have any events.

Adapters

RadialGradient does not have any adapters.