Class: Mask

fabric.Image.filters.Mask

new Mask()

Mask filter class See http://resources.aleph-1.com/mask/
Source:
See:

Extends

Members

type

Filter type
Overrides:
Default Value:
  • Mask
Source:

Methods

applyTo(canvasEl)

Applies filter to canvas element
Parameters:
Name Type Description
canvasEl Object Canvas element to apply filter to
Source:

initialize(optionsopt)

Constructor
Parameters:
Name Type Attributes Description
options Object <optional>
 Options object
Properties
Name Type Attributes Default Description
mask fabric.Image <optional>
 Mask image object
channel Number <optional>
 0 Rgb channel (0, 1, 2 or 3)
Overrides:
Source:

setOptions(optionsopt)

Sets filter's properties from options
Parameters:
Name Type Attributes Description
options Object <optional>
 Options object
Inherited From:
Source:

toJSON() → {Object}

Returns a JSON representation of an instance
Inherited From:
Source:
Returns:
JSON
Type
Object

toObject() → {Object}

Returns object representation of an instance
Overrides:
Source:
Returns:
Object representation of an instance
Type
Object