Filter

Type class

Base filter class.

This class while can be instantiated will not do anything. It is just a base functionality for any other "real" filters to extend.

Filters can be used to decorate, change and transform just about any DOM element.

A Filter works by applying one or more effects (primitives) to SVG element.

For more information on how SVG filters work, refer to this MDN tutorial.

@todo Example

Sources

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

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

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

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

Inheritance

Filter extends BaseObject.

Filter is extended by DropShadowFilter, DesaturateFilter, LightenFilter, BlurFilter, ColorizeFilter, FocusFilter.

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.

filterElement
#

Type $type.Optional < Group >

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

height
#

Type number

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 $type.Optional < string >

Inherited from BaseObject

Sets the user-defined id of the element.

isTemplate
#

Type boolean

Default false

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 boolean

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 string

Inherited from BaseObject

Returns object's internal unique ID.

width
#

Type number

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

Methods

constructor()

#

Returns Filter

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(

filter: this

)

#

Returns void

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

Events

Filter does not have any events.

Adapters

Filter does not have any adapters.