GradientModifier

Type class

This class can be used to modify linear 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.GradientModifier();
fillModifier.opacities = [1, 1, 0];
fillModifier.offsets = [0, 0.8, 1];
columnSeries.columns.template.fillModifier = fillModifier;

var fillModifier = new am4core.GradientModifier();
fillModifier.opacities = [1, 1, 0];
fillModifier.offsets = [0, 0.8, 1];
columnSeries.columns.template.fillModifier = fillModifier;

"series": [{
  "type": "ColumnSeries",
  "columns": {
    "fillModifier": {
      "type": "GradientModifier",
      "opacities": [1, 1, 0],
      "offsets": [0, 0.8, 1]
    }
  }
}]

Sources

This information about GradientModifier is provided for reference only and is not available through exported packages and thus should not be imported or used on its own.

Inheritance

GradientModifier extends ColorModifier.

GradientModifier is extended by LinearGradientModifier, RadialGradientModifier.

Properties

#brightnesses

Type number[]

An array of brightness values for each step.

#gradient

Type LinearGradient | RadialGradient

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

#lightnesses

Type number[]

An array of lightness values for each step.

#offsets

Type number[]

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

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

#opacities

Type number[]

An array of opacity values for each step.

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

#constructor()

Returns GradientModifier

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

GradientModifier does not have any events.