Skip to content
amCharts 4

ColorizeFilter

Type class

Creates a "Colorize" filter.

Sources

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

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

Inheritance

ColorizeFilter extends Filter.

ColorizeFilter is not extended by any other symbol.

Properties

color

Type $type.Optional <Color>

Target color to apply to the element.

Depending on the intensity, all colors of the target element will steer towards this color.

E.g. setting to am4core.color("greener") will make all colors greener.

intensity

Type numberDefault 1

Intensity of the color (0-1).

The bigger the number the more of a color target's colors will become.

0 means the colors will remain as they are.

1 means all colors will become the target color.

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

filterElement

Type $type.Optional <Group>Inherited from Filter

An SVG <group> element hold primitive (effect) definitions.

filterUnits

Type "objectBoundingBox" | "userSpaceOnUse"Default objectBoundingBoxInherited from FilterSince 4.9.17

Which units are used when drawing filter.

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

height

Type numberDefault 120Inherited from Filter

Height of the filter element in percent.

If the filter is designed to "bleed out" of the original target element, like for example a shadow, you need this bigger than 100, or the non-fitting parts will be clipped.

id

Type $type.Optional <string>Inherited from BaseObject

Sets the user-defined id of the element.

isTemplate

Type booleanDefault falseInherited from Filter

Identifies if this object is a "template" and should not be treated as real object that is drawn or actually used in the chart.

nonScaling

Type booleanDefault falseInherited from Filter

If a filter is non scaling, it will look the same even if the sprite is scaled, otherwise filter will scale together with a Sprite.

uid

Type stringInherited from BaseObject

Returns object's internal unique ID.

width

Type numberDefault 120Inherited from Filter

Width of the filter element in percent.

If the filter is designed to "bleed out" of the original target element, like for example a shadow, you need this bigger than 100, or the non-fitting parts will be clipped.

Methods

constructor()

Returns ColorizeFilter

Constructor

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

copyFrom(filter: this)

Returns voidInherited from Filter

Copies properties from another Filter object.

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

ColorizeFilter does not have any events.