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.
/** * -------------------------------------------------------- * Import from: "core.ts" * Use like: am4core.Filter * -------------------------------------------------------- */ import * as am4core from "@amcharts/amcharts4/core";
/** * -------------------------------------------------------- * Include via: <script src="core.js"></script> * Access items like: am4.Filter * -------------------------------------------------------- */
Inheritance
Filter extends BaseObject
.
Filter is extended by DropShadowFilter
, DesaturateFilter
, LightenFilter
, BlurFilter
, ColorizeFilter
, FocusFilter
.
Properties
clonedFrom # |
Type Inherited from 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 Inherited from 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 An SVG |
filterUnits # |
Type Default Which units are used when drawing filter. Use @since 4.9.17 |
height # |
Type Default 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 Inherited from Sets the user-defined id of the element. |
isTemplate # |
Type Default 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 Default If a filter is non scaling, it will look the same even if the sprite is scaled, otherwise filter will scale together with a |
uid # |
Type Inherited from Returns object's internal unique ID. |
width # |
Type Default 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. |
There are 4 inherited items currently hidden from this list. |
Methods
clone( cloneId?: ) |
Returns Inherited from 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 Constructor |
copyFrom( filter: ) |
Returns Copies properties from another |
dispose() |
Returns Inherited from Destroys this object and all related data. |
getCurrentThemes() |
Returns Inherited from 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 Inherited from 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.