PdfGradientStop Class

File
wijmo.pdf.js
Module
wijmo.pdf

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

Constructor

Properties

Methods

Constructor

constructor

constructor(offset?: number, color?: any, opacity?: number): PdfGradientStop

Initializes a new instance of the PdfGradientStop class.

Parameters
Returns
PdfGradientStop

Properties

color

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

Type
Color

offset

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.

Type
number

opacity

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.

Type
number

Methods

clone

clone(): PdfGradientStop

Creates a copy of this PdfGradientStop.

Returns
PdfGradientStop

equals

equals(value: PdfGradientStop): boolean

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

Parameters
Returns
boolean