An immutable object which represents a rectangular gradient fill for a cell.

Constructors

Section titled "Constructors"

CellFillRectangularGradient

new CellFillRectangularGradient(left: number, top: number, right: number, bottom: number, stops: CellFillGradientStop[]): CellFillRectangularGradient

Returns CellFillRectangularGradient

Properties

Section titled "Properties"

$t

Section titled "$t" 
$t: Type

Accessors

Section titled "Accessors"

bottom

Section titled "bottom"

Gets the bottom edge of the inner rectangle of the gradient, ranging from 0.0 (the top of the cell) to 1.0 (the bottom of the cell).

get bottom(): number

Returns number

left

Section titled "left"

Gets the left edge of the inner rectangle of the gradient, ranging from 0.0 (the left of the cell) to 1.0 (the right of the cell).

get left(): number

Returns number

Section titled "right"

Gets the right edge of the inner rectangle of the gradient, ranging from 0.0 (the left of the cell) to 1.0 (the right of the cell).

get right(): number

Returns number

stops

Section titled "stops"

Inherited from: CellFillGradient

Gets the read-only collection of gradient stops which describe the color transitions and their positions within the gradient.

get stops(): IList$1<CellFillGradientStop>

Returns IList$1<CellFillGradientStop>

top

Section titled "top"

Gets the top edge of the inner rectangle of the gradient, ranging from 0.0 (the top of the cell) to 1.0 (the bottom of the cell).

get top(): number

Returns number

noColor

Section titled "noColor"

Inherited from: CellFillGradient

Gets the default cell fill, which is no background color.

get noColor(): CellFill

Returns CellFill

Methods

Section titled "Methods"

equals

Section titled "equals"

Determines whether the [[CellFillRectangularGradient]] is equal to the specified object.

equals(obj: any): boolean

Parameters

  • obj: any

    The object to test for equality.

Returns boolean

getHashCode

Section titled "getHashCode"

Gets the hash code for the [[CellFillRectangularGradient]].

getHashCode(): number

Returns number

createLinearGradientFill

Section titled "createLinearGradientFill"

Inherited from: CellFillGradient

Creates a linear gradient that can be applied to a cell's fill.

createLinearGradientFill(angle: number, stops: CellFillGradientStop[]): CellFillLinearGradient

Parameters

  • angle: number

    The angle, in degrees, of the direction of the linear gradient, going clockwise from the left-to-right direction.
  • stops: CellFillGradientStop[]

    Two or more gradient stops which describe the color transitions and their positions within the gradient.

Returns CellFillLinearGradient

createPatternFill

Section titled "createPatternFill"

Inherited from: CellFillGradient

Creates a solid color or pattern fill that can be applied to a cell.

createPatternFill(backgroundColorInfo: WorkbookColorInfo, patternColorInfo: WorkbookColorInfo, patternStyle: FillPatternStyle): CellFillPattern

Parameters

  • backgroundColorInfo: WorkbookColorInfo

    A [[WorkbookColorInfo]] which describes the background color of the cell, which will only be seen if the 'patternStyle' is not None.
  • patternColorInfo: WorkbookColorInfo

    A [[WorkbookColorInfo]] which describes the pattern color of the cell, which will only be seen if the 'patternStyle' is not None or Solid.
  • patternStyle: FillPatternStyle

    The fill pattern for the cell.

Returns CellFillPattern

createRectangularGradientFill

Section titled "createRectangularGradientFill"

Inherited from: CellFillGradient

Creates a rectangular gradient that can be applied to a cell's fill.

createRectangularGradientFill(colorInfo1: WorkbookColorInfo, colorInfo2: WorkbookColorInfo): CellFillRectangularGradient

Parameters

  • colorInfo1: WorkbookColorInfo

    A [[WorkbookColorInfo]] which describes the color at the inner rectangle (cell center) of the gradient.
  • colorInfo2: WorkbookColorInfo

    A [[WorkbookColorInfo]] which describes the color at the outer rectangle (cell edges) of the gradient.

Returns CellFillRectangularGradient

createSolidFill

Section titled "createSolidFill"

Inherited from: CellFillGradient

Creates a solid color fill that can be applied to a cell.

createSolidFill(solidColorInfo: WorkbookColorInfo): CellFillPattern

Parameters

  • solidColorInfo: WorkbookColorInfo

    A [[WorkbookColorInfo]] which describes the solid color of the fill.

Returns CellFillPattern