ColorizeFilter

Type class

Creates a "Colorize" filter.

Sources

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

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

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

// ColorizeFilter 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.ColorizeFilter
 * --------------------------------------------------------
 */

Inheritance

ColorizeFilter extends Filter.

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

color
#

Type ...

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.

config
#

Type ...

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.

filterElement
#

Type $type.Optional < Group >

Inherited from Filter

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

height
#

Type ...

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

@default 120

id
#

Type ...

Inherited from BaseObject

Sets the user-defined id of the element.

intensity
#

Type ...

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.

@default 1

isTemplate
#

Type boolean

Default false

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

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

@default false

uid
#

Type ...

Inherited from BaseObject

Returns object's internal unique ID.

width
#

Type ...

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

@default 120

There are 9 inherited items currently hidden from this list.

Methods

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 ColorizeFilter

Constructor

copyFrom(

filter: this

)

#

Returns void

Inherited from Filter

Copies properties from another Filter object.

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 5 inherited items currently hidden from this list.

Events

ColorizeFilter does not have any events.

Adapters

ColorizeFilter does not have any adapters.