@sheetxl/sdk 0.7.22 → 0.7.23-beta.2

package/types/src/fill/IEffect.d.ts

@@ -0,0 +1,389 @@
+import { Properties as CSSProperties } from 'csstype';
+import { IColor } from '../color';
+/**
+ * *** **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.
+ */
+export interface IEffect {
+    /**
+     * Returns the type of effect.
+     */
+    getType(): IEffect.Type;
+    /**
+     * Returns the effect as a set of css strings that are suitable for css.
+     *
+     * @remarks
+     * Not all effect types will offer an exact css equivalent.
+     */
+    toCSS(mode?: IColor.CSSMode): CSSProperties;
+    /**
+     * Returns `true` if the effect is equal to the other effect.
+     */
+    isEqual(other: IEffect | null): boolean;
+    /**
+     * Returns the effect as a JSON object.
+     */
+    toJSON(): IEffect.JSON;
+}
+/**
+ * {@inheritDoc IEffect}
+ * @see
+ * ### **Interface**
+ *
+ * {@link IEffect}
+ */
+export declare namespace IEffect {
+    /**
+     * Types of effects that can be applied to a shape or theme effect style.
+     */
+    const Type: {
+        /**
+         * A shadow cast outside the shape's outline.
+         */
+        readonly OuterShadow: "outerShadow";
+        /**
+         * A shadow cast inside the shape's outline.
+         */
+        readonly InnerShadow: "innerShadow";
+        /**
+         * One of a fixed set of built-in shadow presets (perspective shadows, etc.).
+         */
+        readonly PresetShadow: "presetShadow";
+        /**
+         * A colored, blurred outline drawn around the shape.
+         */
+        readonly Glow: "glow";
+        /**
+         * Blurs the edges of the shape.
+         */
+        readonly SoftEdge: "softEdge";
+        /**
+         * A reflection of the shape.
+         */
+        readonly Reflection: "reflection";
+    };
+    type Type = typeof Type[keyof typeof Type];
+    interface Properties {
+        /**
+         * @see
+         * {@link IEffect.getType}
+         */
+        type: IEffect.Type;
+    }
+    /**
+     * Modifiers describe a partial list of properties that can be set with values or shorthand strings.
+     */
+    type Modifiers = Partial<IEffect.Properties>;
+    /**
+     * Options for updating an effect.
+     */
+    type Update = IEffect | Modifiers | null;
+    /**
+     * A JSON representation useful for persistence.
+     */
+    interface JSON extends Properties {
+    }
+    /**
+     * Shared shape for the shadow family (`outerShdw`/`innerShdw`/`prstShdw`).
+     */
+    interface ShadowProperties<C = IColor.Serializable> extends IEffect.Properties {
+        /**
+         * The color of the shadow.
+         */
+        color: C;
+        /**
+         * How far the shadow is offset from the shape.
+         *
+         * @remarks
+         * Points. (`dist` in OOXML, EMU.)
+         */
+        distance?: number;
+        /**
+         * The direction the shadow is offset toward, in degrees.
+         *
+         * @remarks
+         * (`dir` in OOXML, 60,000ths of a degree.)
+         */
+        angle?: number;
+    }
+    /**
+     * A shadow cast outside the shape's outline.
+     */
+    interface IOuterShadow extends IEffect {
+        /**
+         * Effect type is always {@link IEffect.Type.OuterShadow}.
+         */
+        getType(): typeof IEffect.Type.OuterShadow;
+        toJSON(): OuterShadowJSON;
+    }
+    interface OuterShadowProperties<C = IColor.Serializable> extends IEffect.ShadowProperties<C> {
+        type: typeof IEffect.Type.OuterShadow;
+        /**
+         * The blur radius of the shadow.
+         *
+         * @remarks
+         * Points. (`blurRad` in OOXML, EMU.)
+         */
+        blur?: number;
+        /**
+         * The alignment of the shadow relative to the shape.
+         *
+         * @remarks
+         * (`algn` in OOXML — e.g. `'tl'`, `'ctr'`, `'br'`.)
+         */
+        alignment?: string;
+        /**
+         * Whether the shadow should rotate with the shape when the shape is rotated.
+         *
+         * @remarks
+         * (`rotWithShape` in OOXML.)
+         */
+        isRotatedWithShape?: boolean;
+        /**
+         * Horizontal scaling factor applied to the shadow.
+         *
+         * @remarks
+         * (`sx` in OOXML, a percentage.)
+         */
+        scaleX?: number;
+        /**
+         * Vertical scaling factor applied to the shadow.
+         *
+         * @remarks
+         * (`sy` in OOXML, a percentage.)
+         */
+        scaleY?: number;
+        /**
+         * Horizontal skew applied to the shadow, in degrees.
+         *
+         * @remarks
+         * (`kx` in OOXML.)
+         */
+        skewX?: number;
+        /**
+         * Vertical skew applied to the shadow, in degrees.
+         *
+         * @remarks
+         * (`ky` in OOXML.)
+         */
+        skewY?: number;
+    }
+    interface OuterShadowJSON extends OuterShadowProperties<string> {
+    }
+    /**
+     * A shadow cast inside the shape's outline.
+     */
+    interface IInnerShadow extends IEffect {
+        /**
+         * Effect type is always {@link IEffect.Type.InnerShadow}.
+         */
+        getType(): typeof IEffect.Type.InnerShadow;
+        toJSON(): InnerShadowJSON;
+    }
+    interface InnerShadowProperties<C = IColor.Serializable> extends IEffect.ShadowProperties<C> {
+        type: typeof IEffect.Type.InnerShadow;
+        /**
+         * The blur radius of the shadow.
+         *
+         * @remarks
+         * Points. (`blurRad` in OOXML, EMU.)
+         */
+        blur?: number;
+    }
+    interface InnerShadowJSON extends InnerShadowProperties<string> {
+    }
+    /**
+     * One of a fixed set of built-in shadow presets.
+     *
+     * @see {@link https://c-rex.net/samples/ooxml/e1/Part4/OOXML_P4_DOCX_ST_PresetShadowVal_topic_ID0EN2WOB.html#topic_ID0EN2WOB}
+     */
+    interface IPresetShadow extends IEffect {
+        /**
+         * Effect type is always {@link IEffect.Type.PresetShadow}.
+         */
+        getType(): typeof IEffect.Type.PresetShadow;
+        toJSON(): PresetShadowJSON;
+    }
+    interface PresetShadowProperties<C = IColor.Serializable> extends IEffect.ShadowProperties<C> {
+        type: typeof IEffect.Type.PresetShadow;
+        /**
+         * The preset shadow to use.
+         *
+         * @remarks
+         * (`prst` in OOXML, `ST_PresetShadowVal`.)
+         */
+        preset: string;
+    }
+    interface PresetShadowJSON extends PresetShadowProperties<string> {
+    }
+    /**
+     * A colored, blurred outline drawn around the shape.
+     */
+    interface IGlow extends IEffect {
+        /**
+         * Effect type is always {@link IEffect.Type.Glow}.
+         */
+        getType(): typeof IEffect.Type.Glow;
+        toJSON(): GlowJSON;
+    }
+    interface GlowProperties<C = IColor.Serializable> extends IEffect.Properties {
+        type: typeof IEffect.Type.Glow;
+        /**
+         * The color of the glow.
+         */
+        color: C;
+        /**
+         * The radius of the glow.
+         *
+         * @remarks
+         * Points. (`rad` in OOXML, EMU.)
+         */
+        radius?: number;
+    }
+    interface GlowJSON extends GlowProperties<string> {
+    }
+    /**
+     * Blurs the edges of the shape.
+     */
+    interface ISoftEdge extends IEffect {
+        /**
+         * Effect type is always {@link IEffect.Type.SoftEdge}.
+         */
+        getType(): typeof IEffect.Type.SoftEdge;
+        toJSON(): SoftEdgeJSON;
+    }
+    interface SoftEdgeProperties extends IEffect.Properties {
+        type: typeof IEffect.Type.SoftEdge;
+        /**
+         * The radius of the soft edge.
+         *
+         * @remarks
+         * Points. (`rad` in OOXML, EMU.)
+         */
+        radius?: number;
+    }
+    interface SoftEdgeJSON extends SoftEdgeProperties {
+    }
+    /**
+     * A reflection of the shape.
+     */
+    interface IReflection extends IEffect {
+        /**
+         * Effect type is always {@link IEffect.Type.Reflection}.
+         */
+        getType(): typeof IEffect.Type.Reflection;
+        toJSON(): ReflectionJSON;
+    }
+    interface ReflectionProperties extends IEffect.Properties {
+        type: typeof IEffect.Type.Reflection;
+        /**
+         * The blur radius of the reflection.
+         *
+         * @remarks
+         * Points. (`blurRad` in OOXML, EMU.)
+         */
+        blur?: number;
+        /**
+         * How far the reflection is offset from the shape.
+         *
+         * @remarks
+         * Points. (`dist` in OOXML, EMU.)
+         */
+        distance?: number;
+        /**
+         * The direction the reflection is offset toward, in degrees.
+         *
+         * @remarks
+         * (`dir` in OOXML.)
+         */
+        angle?: number;
+        /**
+         * The direction to offset the reflection's fade, in degrees.
+         *
+         * @remarks
+         * (`fadeDir` in OOXML.)
+         */
+        fadeAngle?: number;
+        /**
+         * The starting opacity of the reflection, as a percentage.
+         *
+         * @remarks
+         * (`stA` in OOXML.)
+         */
+        startAlpha?: number;
+        /**
+         * The starting position of the reflection's opacity fade, as a percentage.
+         *
+         * @remarks
+         * (`stPos` in OOXML.)
+         */
+        startPosition?: number;
+        /**
+         * The ending opacity of the reflection, as a percentage.
+         *
+         * @remarks
+         * (`endA` in OOXML.)
+         */
+        endAlpha?: number;
+        /**
+         * The ending position of the reflection's opacity fade, as a percentage.
+         *
+         * @remarks
+         * (`endPos` in OOXML.)
+         */
+        endPosition?: number;
+        /**
+         * Horizontal scaling factor applied to the reflection.
+         *
+         * @remarks
+         * (`sx` in OOXML, a percentage.)
+         */
+        scaleX?: number;
+        /**
+         * Vertical scaling factor applied to the reflection.
+         *
+         * @remarks
+         * (`sy` in OOXML, a percentage.)
+         */
+        scaleY?: number;
+        /**
+         * Horizontal skew applied to the reflection, in degrees.
+         *
+         * @remarks
+         * (`kx` in OOXML.)
+         */
+        skewX?: number;
+        /**
+         * Vertical skew applied to the reflection, in degrees.
+         *
+         * @remarks
+         * (`ky` in OOXML.)
+         */
+        skewY?: number;
+        /**
+         * The alignment of the reflection relative to the shape.
+         *
+         * @remarks
+         * (`algn` in OOXML.)
+         */
+        alignment?: string;
+        /**
+         * Whether the reflection should rotate with the shape when the shape is rotated.
+         *
+         * @remarks
+         * (`rotWithShape` in OOXML.)
+         */
+        isRotatedWithShape?: boolean;
+    }
+    interface ReflectionJSON extends ReflectionProperties {
+    }
+}
+//# sourceMappingURL=IEffect.d.ts.map

package/types/src/fill/IEffect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEffect.d.ts","sourceRoot":"","sources":["../../../../src/fill/IEffect.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,UAAU,IAAI,aAAa,EAAE,MAAM,SAAS,CAAC;AAE3D,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC;;;;;;;;;;;GAWG;AAEH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IACxB;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,OAAO,GAAG,aAAa,CAAC;IAC5C;;OAEG;IACH,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI,GAAG,OAAO,CAAC;IACxC;;OAEG;IACH,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CACxB;AAED;;;;;;GAMG;AACH,yBAAiB,OAAO,CAAC;IACvB;;OAEG;IACI,MAAM,IAAI;QACf;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;KAEK,CAAC;IACX,KAAY,IAAI,GAAG,OAAO,IAAI,CAAC,MAAM,OAAO,IAAI,CAAC,CAAC;IAElD,UAAiB,UAAU;QACzB;;;WAGG;QACH,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC;KACpB;IAED;;OAEG;IACH,KAAY,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAEpD;;OAEG;IACH,KAAY,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,IAAI,CAAC;IAEhD;;OAEG;IACH,UAAiB,IAAK,SAAQ,UAAU;KAAG;IAE3C;;OAEG;IACH,UAAiB,gBAAgB,CAAC,CAAC,GAAC,MAAM,CAAC,YAAY,CAAE,SAAQ,OAAO,CAAC,UAAU;QACjF;;WAEG;QACH,KAAK,EAAE,CAAC,CAAC;QACT;;;;;WAKG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB;;;;;WAKG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED;;OAEG;IACH,UAAiB,YAAa,SAAQ,OAAO;QAC3C;;WAEG;QACH,OAAO,IAAI,OAAO,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC;QAE3C,MAAM,IAAI,eAAe,CAAC;KAC3B;IAED,UAAiB,qBAAqB,CAAC,CAAC,GAAC,MAAM,CAAC,YAAY,CAAE,SAAQ,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC;QAC/F,IAAI,EAAE,OAAO,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC;QACtC;;;;;WAKG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QACd;;;;;WAKG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB;;;;;WAKG;QACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;QAC7B;;;;;WAKG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;;;;;WAKG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;;;;;WAKG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;;;;WAKG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAGD,UAAiB,eAAgB,SAAQ,qBAAqB,CAAC,MAAM,CAAC;KAAG;IAEzE;;OAEG;IACH,UAAiB,YAAa,SAAQ,OAAO;QAC3C;;WAEG;QACH,OAAO,IAAI,OAAO,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC;QAE3C,MAAM,IAAI,eAAe,CAAC;KAC3B;IAED,UAAiB,qBAAqB,CAAC,CAAC,GAAC,MAAM,CAAC,YAAY,CAAE,SAAQ,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC;QAC/F,IAAI,EAAE,OAAO,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC;QACtC;;;;;WAKG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAGD,UAAiB,eAAgB,SAAQ,qBAAqB,CAAC,MAAM,CAAC;KAAG;IAEzE;;;;OAIG;IACH,UAAiB,aAAc,SAAQ,OAAO;QAC5C;;WAEG;QACH,OAAO,IAAI,OAAO,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC;QAE5C,MAAM,IAAI,gBAAgB,CAAC;KAC5B;IAED,UAAiB,sBAAsB,CAAC,CAAC,GAAC,MAAM,CAAC,YAAY,CAAE,SAAQ,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC;QAChG,IAAI,EAAE,OAAO,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC;QACvC;;;;;WAKG;QACH,MAAM,EAAE,MAAM,CAAC;KAChB;IAGD,UAAiB,gBAAiB,SAAQ,sBAAsB,CAAC,MAAM,CAAC;KAAG;IAE3E;;OAEG;IACH,UAAiB,KAAM,SAAQ,OAAO;QACpC;;WAEG;QACH,OAAO,IAAI,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;QAEpC,MAAM,IAAI,QAAQ,CAAC;KACpB;IAED,UAAiB,cAAc,CAAC,CAAC,GAAC,MAAM,CAAC,YAAY,CAAE,SAAQ,OAAO,CAAC,UAAU;QAC/E,IAAI,EAAE,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;QAC/B;;WAEG;QACH,KAAK,EAAE,CAAC,CAAC;QACT;;;;;WAKG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;IAGD,UAAiB,QAAS,SAAQ,cAAc,CAAC,MAAM,CAAC;KAAG;IAE3D;;OAEG;IACH,UAAiB,SAAU,SAAQ,OAAO;QACxC;;WAEG;QACH,OAAO,IAAI,OAAO,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC;QAExC,MAAM,IAAI,YAAY,CAAC;KACxB;IAED,UAAiB,kBAAmB,SAAQ,OAAO,CAAC,UAAU;QAC5D,IAAI,EAAE,OAAO,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC;QACnC;;;;;WAKG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;IAGD,UAAiB,YAAa,SAAQ,kBAAkB;KAAG;IAE3D;;OAEG;IACH,UAAiB,WAAY,SAAQ,OAAO;QAC1C;;WAEG;QACH,OAAO,IAAI,OAAO,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC;QAE1C,MAAM,IAAI,cAAc,CAAC;KAC1B;IAED,UAAiB,oBAAqB,SAAQ,OAAO,CAAC,UAAU;QAC9D,IAAI,EAAE,OAAO,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC;QACrC;;;;;WAKG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QACd;;;;;WAKG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB;;;;;WAKG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;;;;WAKG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB;;;;;WAKG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB;;;;;WAKG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB;;;;;WAKG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB;;;;;WAKG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB;;;;;WAKG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;;;;;WAKG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;;;;;WAKG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;;;;WAKG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;;;;WAKG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB;;;;;WAKG;QACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;KAC9B;IAGD,UAAiB,cAAe,SAAQ,oBAAoB;KAAG;CAEhE"}