Documentation

LightenFilter

Type class

Creates a "Lighten" filter.

Sources

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

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


/**
 * --------------------------------------------------------
 * Include via: <script src="core.js"></script>
 * Access items like: am4.LightenFilter
 * --------------------------------------------------------
 */

Inheritance

LightenFilter extends Filter.

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

Inherited from Filter

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

Type "objectBoundingBox" | "userSpaceOnUse"

Default objectBoundingBox

Inherited from Filter

Which units are used when drawing filter.

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

@since 4.9.17

height
#

Type number

Default 120

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.
id
#

Type $type.Optional < string >

Inherited from BaseObject

Sets the user-defined id of the element.
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.
lightness
#

Type number

Lightness of the target colors.

If lightness is a positive number, the filter will make all colors lighter.

If lightness is negative, colors will be darkened.
nonScaling
#

Type boolean

Default false

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.
uid
#

Type string

Inherited from BaseObject

Returns object's internal unique ID.
width
#

Type number

Default 120

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.
There are 10 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 LightenFilter

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

LightenFilter does not have any events.

Adapters

LightenFilter does not have any adapters.