ElementMask object

autoExpandImages

Boolean

If set to true, and the element mask is an image, the image is automatically expanded to fill the entire document, with areas "outside" the image showing through. If set to false (or if the element mask is not an image), areas "outside" the element mask are knocked out.

element

object

Element object (for more information, see Element object).

enabled

Boolean

If set to true, the mask applies to the element. If set to false, the mask remains present but does not visually affect the element in any way. Default value is true.

linked

Boolean

If set to true, moving the mask moves the element that owns it, and vice versa. If set to false, moving the mask does not affect the element that owns it (and moving the element does not affect the mask). Default value is true.

mode

string

Acceptable values are "mask to image" and "mask to path".

owner

object

The element (image, path, text, and so on) that owns the mask.

showAttrs

Boolean

If set to true, and mode is "mask to path", the mask element's fill and stroke (if any) are drawn. If set to false, the mask element's fill and stroke are ignored.