Skip to content

PDFRadialShading

Namespace: O2S.Components.PDF4NET.Graphics

Defines a radial (type 3) shading.

public class PDFRadialShading : PDFShading

Inheritance ObjectPDFShadingPDFRadialShading

Constructors

PDFRadialShading()

Initializes a new PDFRadialShading object.

public PDFRadialShading()

Properties

AntiAlias

Gets or sets a value indicating whether to filter the shading function to prevent aliasing artifacts.

public bool AntiAlias { get; set; }

Property Value

Boolean
If true, the output device will antialias the shading output.


ColorSpace

Gets or sets the shading color space.

public PDFColorSpace ColorSpace { get; set; }

Property Value

PDFColorSpace
The color space in which color values are expressed.


Domain

Gets or sets the shading domain.

public Double[] Domain { get; set; }

Property Value

Double[]
An array of two numbers [t0 t1] specifying the limiting values of a parametric variable t.

Remarks

The variable is considered to vary linearly between these two values as the color gradient varies between the starting and ending circles. The variable t becomes the input argument to the shading function.


EndCircleCenter

Gets or sets the position of the ending circle.

public PDFPoint EndCircleCenter { get; set; }

Property Value

PDFPoint
The position in shading's target coordinate system of the ending circle center.


EndCircleRadius

Gets or sets the radius of the ending circle.

public double EndCircleRadius { get; set; }

Property Value

Double
The radius of the ending circle.


EndColor

Gets or sets the shading end color.

public PDFColor EndColor { get; set; }

Property Value

PDFColor
The shading end color.

Remarks

The PDFRadialShading.StartColor and EndColor can be set only when the shading uses an exponential function (PDFExponentialFunction).


ExtendEnd

Gets or sets a value indicating whether to extend shading beyond the ending circle.

public bool ExtendEnd { get; set; }

Property Value

Boolean
If true, the shading will be extended beyond the ending circle.


ExtendStart

Gets or sets a value indicating whether to extend shading beyond the starting circle.

public bool ExtendStart { get; set; }

Property Value

Boolean
If true, the shading will be extended beyond the starting circle.


Function

Gets or sets the shading function.

public PDFFunction Function { get; set; }

Property Value

PDFFunction
A 1-in, n-out function, where n is the number of color components in the shading dictionary's color space

Remarks

The function is called with values of the parametric variable t in the domain defined by the PDFRadialShading.Domain property.


StartCircleCenter

Gets or sets the position of the starting circle.

public PDFPoint StartCircleCenter { get; set; }

Property Value

PDFPoint
The position in shading's target coordinate system of the starting circle center.


StartCircleRadius

Gets or sets the radius of the starting circle.

public double StartCircleRadius { get; set; }

Property Value

Double
The radius of the starting circle.


StartColor

Gets or sets the shading start color.

public PDFColor StartColor { get; set; }

Property Value

PDFColor
The shading start color.

Remarks

The StartColor and PDFRadialShading.EndColor can be set only when the shading uses an exponential function (PDFExponentialFunction).