RadialGradientModifier

Type class

This class can be used to modify radial gradient steps, changing visual properties like lightness, brightness, opacity of each set.

It can also set offsets for each gradient step.

E.g. if I want to fill a columns in a column series to be a solid fill from top to 80% of height, then gradually fades out, I can use the following gradient modifier as a fillModifier:

let fillModifier = new am4core.LinearGradientModifier();
fillModifier.opacities = [1, 1, 0];
fillModifier.offsets = [0, 0.8, 1];
columnSeries.columns.template.fillModifier = fillModifier;
var fillModifier = new am4core.LinearGradientModifier();
fillModifier.opacities = [1, 1, 0];
fillModifier.offsets = [0, 0.8, 1];
columnSeries.columns.template.fillModifier = fillModifier;
"series": [{
  "type": "ColumnSeries",
  "columns": {
    "fillModifier": {
      "type": "LinearGradientModifier",
      "opacities": [1, 1, 0],
      "offsets": [0, 0.8, 1]
    }
  }
}]

Sources

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

// RadialGradientModifier is available in all of the following modules.
// You only need to import one of them.

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

// RadialGradientModifier is available in all of the following modules.
// You only need to import one of them.

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

Inheritance

RadialGradientModifier extends GradientModifier.

RadialGradientModifier is not extended by any other symbol.

Properties

brightnesses
#

Type number[]

Inherited from GradientModifier

An array of brightness values for each step.

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.

gradient
#

Type RadialGradient

A reference to the gradient instance that this modifier is used for.

id
#

Type $type.Optional < string >

Inherited from BaseObject

Sets the user-defined id of the element.

lightnesses
#

Type number[]

Inherited from GradientModifier

An array of lightness values for each step.

offsets
#

Type number[]

Inherited from GradientModifier

An array of relative position (0-1) for each step.

If not set, all steps will be of equal relative length.

opacities
#

Type number[]

Inherited from GradientModifier

An array of opacity values for each step.

uid
#

Type string

Inherited from BaseObject

Returns object's internal unique ID.

There are 8 inherited items currently hidden from this list.

Methods

constructor()

#

Returns RadialGradientModifier

Constructor.

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.

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

RadialGradientModifier does not have any events.

Adapters

RadialGradientModifier does not have any adapters.