SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface IGradient

    A gradient fill, where colors transition across the area.

    interface IGradient {
        isIFill: true;
        getAngle(): number;
        getColor(): IColor | null;
        getFocus(): Rectangle;
        getGradientType(): IFill.GradientType;
        getStops(): IGradientStop[];
        getType(): "gradient";
        hasVisibleStyling(): boolean;
        isEqual(other: IFill | null): boolean;
        setAngle(angle: number | null, options?: UpdateOptions): IGradient;
        setColor(color: Serializable | null, options?: UpdateOptions): IFill;
        setFocus(focus: Rectangle | null, options?: UpdateOptions): IGradient;
        setGradientType(
            type: IFill.GradientType | null,
            options?: UpdateOptions,
        ): IGradient;
        setStops(
            stops: (Serializable | IGradientStop | null)[],
            options?: UpdateOptions,
        ): IGradient;
        toCSS(mode?: CSSMode, size?: Size): Properties;
        toJSON(): GradientJSON;
    }

    Hierarchy (View Summary)

    Index
    isIFill
    getAngle getColor getFocus getGradientType getStops getType hasVisibleStyling isEqual setAngle setColor setFocus setGradientType setStops toCSS toJSON
    isIFill: true

    For type checking.

    • The angle of the gradient in degrees if gradient type is linear.

      Returns number

    • Used for path and circular gradients.

      Returns Rectangle

    • Returns true if the fill has any visible styling

      Returns boolean

    • Returns true if the fill is equal to the other fill.

      Parameters

      Returns boolean

    • Set the fill color.

      Parameters

      Returns IFill

      Different fill types will interpret the fill color differently. For example, a solid fill will use the color directly, while a gradient fill may use the color as one of the gradient stops.

    • Sets the focus area for the gradient.

      Parameters

      • focus: Rectangle | null

        The fill area.

      • Optionaloptions: UpdateOptions

      Returns IGradient

      • For 'rect' gradients, this is the inner rectangle where the color is solid.
      • For 'circle' gradients, the center of this rect is the focal point.

    • Returns the fill as a set of css string that are suitable for css.

      Parameters

      • Optionalmode: CSSMode

        The color rendering mode (see IColor.CSSMode): a boolean bakes that mode; 'adaptive' emits light-dark() so a light/dark flip needs no re-render. (Pattern fills bake their SVG data-URI body regardless — a data-URI never sees the host color-scheme.)

      • Optionalsize: Size

        Indicates the size of the area being filled.

      Returns Properties

      Size is used for determining the scaling or tiling of the fill within the specified area. (e.g. Scaled Gradient Fill).

    Settings
    Member Visibility

    On This Page
    Properties
    Methods