Immutable class which describes a color transition in a cell fill gradient.

See

  • [[CellFillLinearGradient]]
  • [[CellFillRectangularGradient]]

Hierarchy

Hierarchy

  • Base
    • CellFillGradientStop

Constructors

  • Parameters

    • color: string | Color
    • offset: number

    Returns CellFillGradientStop

  • Parameters

    Returns CellFillGradientStop

  • Parameters

    • Rest ..._rest: any[]

    Returns CellFillGradientStop

Properties

$type: Type
$t: Type
nextHashCode: number

Accessors

  • get colorInfo(): WorkbookColorInfo
  • Gets the [[WorkbookColorInfo]] describing the color transition for the gradient stop.

    See

    [[offset]]

    Returns WorkbookColorInfo

  • get offset(): number
  • Gets the position in the gradient of the color transition for the gradient stop, ranging from 0.0 to 1.0.

    When used in a [[CellFillLinearGradient]], a value of 0.0 is at the beginning of the gradient and 1.0 is at the end of the gradient. When used in a [[CellFillRectangularGradient]], a value of 0.0 is at the inner rectangle and 1.0 is at the outer edges of the cell.

    See

    [[colorInfo]]

    Returns number

Methods

  • Determines whether the [[CellFillGradientStop]] is equal to the specified object.

    Parameters

    • obj: any

      The object to test for equality.

    Returns boolean

  • Gets the hash code for the [[CellFillGradientStop]].

    Returns number

  • Returns Base

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

  • Parameters

    • obj: any

    Returns any[]

  • Parameters

    • obj: any

    Returns any[]

  • Parameters

    • obj: any

    Returns number

  • Parameters

    • a: any
    • b: any

    Returns boolean