DsPdfJS API v9.1.0

DsPdfJS API / RadialGradientBrushProperties

Type Alias: RadialGradientBrushProperties

RadialGradientBrushProperties = object

Provides settings for creating a radial gradient brush.

Properties

centerOfEndCircle?

optional centerOfEndCircle: Point

The center of the end circle that defines the end of the gradient. (0, 0) is the top-left corner, (1, 1) is the bottom-right corner. The default is (0.5, 0.5).

centerOfStartCircle?

optional centerOfStartCircle: Point | null

The center of the start circle that defines the beginning of the gradient. (0, 0) is the top-left corner, (1, 1) is the bottom-right corner. If not specified, the center of the start circle coincides with RadialGradientBrushProperties.centerOfEndCircle.

endColor

endColor: Color

The ending gradient color.

extendEndCircle?

optional extendEndCircle: boolean

Indicates whether to extend gradient beyond the end circle. The default is true.

extendStartCircle?

optional extendStartCircle: boolean

Indicates whether to extend the gradient beyond the start circle. The default is true.

gradientStops?

optional gradientStops: GradientStop[] | null

The array of gradient stops.

normalize?

optional normalize: boolean

Indicates whether to normalize the brush ensuring that it renders the same way on all supported target contexts (such as PdfContext, BmpContext, and SvgContext). If true, and the focal point is outside the end circle, it is moved to be on the end circle. If false, the focal point position is not adjusted if it is outside the end circle, and the result will depend on the implementation of the target DrawingContext. The default is true.

radiusOfEndCircle?

optional radiusOfEndCircle: number | null

The radius of the end circle that defines the end of the gradient, as a fraction of the normalized diagonal. The normalized diagonal length is calculated as sqrt(width * width + height * height) / 2. If not specified, the end radius is equal to max(width, height) / 2.

radiusOfStartCircle?

optional radiusOfStartCircle: number

The radius of the start circle that defines the beginning of the gradient, as a fraction of the normalized diagonal. The normalized diagonal length is calculated as sqrt(width * width + height * height) / 2. The default is 0.

startColor

startColor: Color

The starting gradient color.