Interface IEffect

*** PLACEHOLDER - Not yet implemented.

Defines a single visual effect (shadow, glow, etc.) that can be applied to a shape, or to a theme's effectStyleLst entry.

Remarks

Covers DrawingML's "common" effect set — the effects real documents actually use on a shape or theme effect style: outer/inner/preset shadow, glow, soft edge, reflection. The broader alpha-/color-transform effect family (alphaMod, duotone, blend, etc.) is picture/blip adjustment territory, not modeled here.

interface IEffect {
    getType(): IEffect.Type;
    isEqual(other: IEffect | null): boolean;
    toCSS(mode?: CSSMode): Properties;
    toJSON(): IEffect.JSON;
}

Hierarchy (View Summary)

IEffect

Index

Methods

getType isEqual toCSS toJSON

Methods

getType

getType(): IEffect.Type

Returns the type of effect.

Returns IEffect.Type

isEqual

isEqual(other: IEffect | null): boolean
Returns true if the effect is equal to the other effect.
Parameters
- other: IEffect | null
Returns boolean

toCSS

toCSS(mode?: CSSMode): Properties
Returns the effect as a set of css strings that are suitable for css.
Parameters
- Optionalmode: CSSMode
Returns Properties

Remarks
Not all effect types will offer an exact css equivalent.

toJSON

toJSON(): IEffect.JSON

Returns the effect as a JSON object.

Returns IEffect.JSON

Interface IEffect

Remarks

Hierarchy (View Summary)

Index

Methods

Methods

getType

Returns IEffect.Type

isEqual

Parameters

Returns boolean

toCSS

Parameters

Returns Properties

Remarks

toJSON

Returns IEffect.JSON

Settings

On This Page