v5.20192.631
|

PdfGradientStop Class

Represents an object which determines a transition point of a gradient.

Hierarchy

  • PdfGradientStop

Constructors

Properties

Methods

Constructors

constructor

  • new PdfGradientStop(offset?: number, color?: any, opacity?: number): PdfGradientStop
  • Initializes a new instance of the PdfGradientStop class.

    Parameters

    • Optional offset: number

      The location of the gradient stop on the gradient axis.

    • Optional color: any

      The color of the gradient stop. A wijmo.Color object or any string acceptable by the wijmo.Color.fromString method.

    • Optional opacity: number

      The opacity of the gradient stop.

    Returns PdfGradientStop

Properties

color

color: Color

Gets or sets the color of the gradient stop. The default color is black.

offset

offset: number

Gets or sets the location of the gradient stop on gradient axis of the brush. The value must be in range [0, 1], where 0 indicates that the gradient stop is placed at the beginning of the gradient axis, while 1 indicates that the gradient stop is placed at the end of the gradient axis. The default value is 0.

opacity

opacity: number

Gets or sets the opacity of the gradient stop. The value must be in range [0, 1], where 0 indicates that the gradient stop is completely transparent, while 1 indicates that the gradient stop is completely opaque. The default value is 1.

Methods

clone

equals

  • Determines whether the specified PdfGradientStop instance is equal to the current one.

    Parameters

    Returns boolean

    true if the specified object is equal to the current one, otherwise false.