Constructor for a GlowEffect
object.
All parameters are optional, and when omitted fallback to default values.
// Example, define an GlowEffect object
const glowEffect = new GlowEffect({
color: ColorRGBA(100, 0, 0, 150),
blur: 5,
})
For details of the available properties, see GlowEffectProperties
Optional
props: Partial<GlowEffectProperties>Readonly
blurBlur distance as pixels.
Max value 10
.
Readonly
colorGlow color.
Assign using ColorRGBA or any other color factory. Glow intensity can be controlled with color alpha channel.
// Example, red glow color.
color: ColorRGBA(255, 0, 0, 255)
Readonly
offsetOffset as pixels.
Readonly
spreadSpread distance as pixels.
Max value 10
.
Readonly
typeConstruct a new GlowEffect object based on this one, but with modified blur distance.
// Example
const glow2 = glow1.setBlur(10)
New GlowEffect object
Blur distance as pixels. Max value is 10
.
Construct a new GlowEffect object based on this one, but with modified color.
// Example
const glow2 = glow1.setColor(ColorRGBA(255, 0, 0, 100))
New GlowEffect object
Construct a new GlowEffect object based on this one, but with modified offset distance.
// Example
const glow2 = glow1.setOffset({ x: 10, y: -10 })
New GlowEffect object
Offset distance as pixels.
Construct a new GlowEffect object based on this one, but with modified spread distance.
// Example
const glow2 = glow1.setSpread(10)
New GlowEffect object
Spread distance as pixels. Max value is 10
.
Type definition of an Glow Effect Configuration_.
A theme can specify an Effect to add extra visual oomph to chart applications, like Glow effects around data or other components. Whether this effect is drawn above a particular component can be configured using the
setEffect
method.Theme effect is configured with effect property.