Blur

Kind: class

• Blur
  • new Blur(blurAmount, brightnessAmount, fillOpacity, visible, backgroundEffect)
  • .blurAmount : number
  • .brightnessAmount : number
  • .fillOpacity : number
  • .isBackgroundEffect : boolean
  • .visible : boolean

Blur()

Creates an object blur or background blur effect object with the given properties.

blur.blurAmount : number 0 - 50

Kind: instance property of Blur

blur.brightnessAmount : number -50 - 50

For background blur effects, the amount to increase or decrease the brightness of the background. Ignored for object blur effects.

Kind: instance property of Blur

blur.fillOpacity : number 0.0 - 1.0

For background blur effects, the a multiplier on the opacity of the object's fill drawn over top of the blurred background. Useful to create a color tint on top of the blurred background. Does not affect stroke opacity.

Ignored for object blur effects.

Kind: instance property of Blur

blur.isBackgroundEffect : boolean

If true, renders a background blur effect: all objects beneath the shape are blurred (modulated by brightnessAmount), but the shape itself is still rendered with crisp edges (with its fill modulated by fillOpacity).

If false, renders an object blur effect: the shape itself is blurred, and objects beneath it are unaffected.

Kind: instance property of Blur

blur.visible : boolean

If false, the blur effect is not rendered. The user can toggle this via a checkbox in the Properties panel.

Kind: instance property of Blur