PdfGradientBrush Class

File
wijmo.pdf.js
Module
wijmo.pdf
Base Class
PdfBrush
Derived Classes
PdfLinearGradientBrush, PdfRadialGradientBrush
Show
   

Represents an abstract class that serves as a base class for the PdfLinearGradientBrush and PdfRadialGradientBrush classes.

This class is not intended to be instantiated in your code.

Constructor

Properties

Methods

Constructor

constructor

constructor(stops?: PdfGradientStop[], opacity?: number): PdfGradientBrush

Initializes a new instance of the PdfGradientBrush class.

Parameters
Returns
PdfGradientBrush

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.

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.

Type
PdfGradientStop[]

Methods

clone

clone(): PdfBrush

Creates a copy of this PdfBrush.

Inherited From
PdfBrush
Returns
PdfBrush

equals

equals(value: PdfGradientBrush): boolean

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

Parameters
Returns
boolean