EffectInstance

The type of the effect that the instance uses, also when it isn’t registered.

Read only.

Type:

• String

The effect that the instance uses, registered under its type, or null if there is none.

Read only.

Type:

• Effect⟋null

Whether the effect applies. Effects that aren’t visible are skipped.

Default:

• true

Type:

• Boolean

The parameters of the instance. Changing them on the returned object updates it, as setting them as its properties does. Parameters that it doesn’t have yet are added by setting them all, as are changes within values such as arrays.

Type:

• Object

Example:

var instance = path.addEffect({
    type: 'offset',
    parameters: { distance: 10 }
});
instance.parameters.distance = 20; // Redraws.
instance.parameters = { distance: 5, join: 'round' };

The item that the instance is part of.

Read only.

Type:

• Item⟋null

The index of the instance in the item.effects of its item.

Read only.

Type:

• Number⟋null

Removes the instance from its item.

Returns:

• Boolean — true if the instance was removed, false otherwise

Checks whether the instance is equal to the supplied one.

Parameters:

• instance: EffectInstance

Returns:

• Boolean — true if they are equal, false otherwise