Abstract base class for a gradient fill of a cell.

Constructors

Section titled "Constructors"

CellFillGradient

new CellFillGradient(a: CellFillGradientStop[]): CellFillGradient

Returns CellFillGradient

Properties

Section titled "Properties"

$t

Section titled "$t" 
$t: Type

Accessors

Section titled "Accessors"

stops

Section titled "stops"

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>

noColor

Section titled "noColor"

Inherited from: CellFill

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 [[CellFillGradient]] 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 [[CellFillGradient]].

getHashCode(): number

Returns number

createLinearGradientFill

Section titled "createLinearGradientFill"

Inherited from: CellFill

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: CellFill

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: CellFill

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: CellFill

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