PdfRadialGradientBrush Class

File
wijmo.pdf.js
Module
wijmo.pdf
Base Class
PdfGradientBrush
Show
   

Represents a brush used to fill an area with a radial gradient.

Constructor

Properties

Methods

Constructor

constructor

constructor(x1: number, y1: number, r1: number, x2: number, y2: number, r2: number, stops: PdfGradientStop[], opacity: number): PdfRadialGradientBrush

Initializes a new instance of the PdfRadialGradientBrush class.

Parameters
Returns
PdfRadialGradientBrush

Properties

opacity

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

Inherited From
PdfGradientBrush
Type
number

r1

Gets or sets the radius of the inner circle that represents the starting point of the radial gradient, in page area coordinates, in points.

Type
number

r2

Gets or sets the radius of the outer circle that represents the ending point of the radial gradient, in page area coordinates, in points.

Type
number

stops

Gets or sets an array of PdfGradientStop objects representing a color, offset and opacity within the brush's gradient axis. The default value is an empty array.

Inherited From
PdfGradientBrush
Type
PdfGradientStop[]

x1

Gets or sets the X-coordinate of the inner circle's center that represents the starting point of the radial gradient, in page area coordinates, in points.

Type
number

x2

Gets or sets the X-coordinate of the outer circle's center that represents the ending point of the radial gradient, in page area coordinates, in points.

Type
number

y1

Gets or sets the Y-coordinate of the inner circle's center that represents the starting point of the radial gradient, in page area coordinates, in points.

Type
number

y2

Gets or sets the Y-coordinate of the outer circle's center that represents the ending point of the radial gradient, in page area coordinates, in points.

Type
number

Methods

clone

clone(): PdfRadialGradientBrush

Creates a copy of this PdfRadialGradientBrush.

Returns
PdfRadialGradientBrush

equals

equals(value: PdfRadialGradientBrush): boolean

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

Parameters
Returns
boolean