The class that extends PdfShading class and is in charge of Shading Dictionary with axial type, that define a colour blend that varies along a linear axis between two endpoints and extends indefinitely perpendicular to that axis. More...

Inheritance diagram for iText.Kernel.Pdf.Colorspace.PdfShading.Axial:

Public Member Functions
	Axial (PdfColorSpace cs, float x0, float y0, float[] color0, float x1, float y1, float[] color1)
	Creates the new instance of the class. More...

	Axial (PdfColorSpace cs, float x0, float y0, float[] color0, float x1, float y1, float[] color1, bool[] extend)
	Creates the new instance of the class. More...

	Axial (PdfColorSpace cs, PdfArray coords, IPdfFunction function)
	Creates the new instance of the class. More...

	Axial (PdfColorSpace cs, PdfArray coords, PdfArray domain, IPdfFunction function)
	Creates the new instance of the class. More...

virtual PdfArray	GetCoords ()
	Gets the Coords object - a iText.Kernel.Pdf.PdfArray of four numbers [x0 y0 x1 y1] that specified the starting and the endings coordinates of thew axis, expressed in the shading's target coordinate space. More...

virtual void	SetCoords (float x0, float y0, float x1, float y1)
	Sets the Choords object with the four params expressed in the shading's target coordinate space. More...

virtual void	SetCoords (PdfArray coords)
	Sets the Choords object with the iText.Kernel.Pdf.PdfArray of four numbers [x0 y0 x1 y1], that specified the starting and the endings coordinates of thew axis, expressed in the shading's target coordinate space. More...

virtual PdfArray	GetDomain ()
	Gets the iText.Kernel.Pdf.PdfArray of two `float` [t0, t1] that represent the limiting values of a parametric variable t, that becomes an input of color function(s). More...

virtual void	SetDomain (float t0, float t1)
	Sets the Domain with the array of two `float` [t0, t1] that represent the limiting values of a parametric variable t, that becomes an input of color function(s). More...

virtual void	SetDomain (PdfArray domain)
	Sets the Domain with the iText.Kernel.Pdf.PdfArray of two `float` [t0, t1] that represent the limiting values of a parametric variable t, that becomes an input of color function(s). More...

virtual PdfArray	GetExtend ()
	Gets the iText.Kernel.Pdf.PdfArray of two `boolean` that specified whether to extend the shading beyond the starting and ending points of the axis, respectively. More...

virtual void	SetExtend (bool extendStart, bool extendEnd)
	Sets the Extend object with the two `boolean` value. More...

virtual void	SetExtend (PdfArray extend)
	Sets the Extend object with the iText.Kernel.Pdf.PdfArray of two `boolean`. More...

Public Member Functions inherited from iText.Kernel.Pdf.Colorspace.PdfShading
virtual int	GetShadingType ()
	Gets the shading type. More...

virtual PdfObject	GetColorSpace ()
	Gets the color space in which colour values shall be expressed. More...

virtual PdfObject	GetFunction ()
	Gets the function PdfObject that represents color transitions across the shading geometry. More...

virtual void	SetFunction (IPdfFunction function)
	Sets the function that represents color transitions across the shading geometry as one object. More...

virtual void	SetFunction (IPdfFunction[] functions)
	Sets the function object that represents color transitions across the shading geometry as an array of functions. More...

override void	Flush ()
	To manually flush a `PdfObject` behind this wrapper, you have to ensure that this object is added to the document, i.e. it has an indirect reference. More...

Public Member Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >
virtual T	GetPdfObject ()

virtual iText.Kernel.Pdf.PdfObjectWrapper< T >	MakeIndirect (PdfDocument document, PdfIndirectReference reference)
	Marks object behind wrapper to be saved as indirect. More...

virtual iText.Kernel.Pdf.PdfObjectWrapper< T >	MakeIndirect (PdfDocument document)
	Marks object behind wrapper to be saved as indirect. More...

virtual iText.Kernel.Pdf.PdfObjectWrapper< T >	SetModified ()

virtual bool	IsFlushed ()

Additional Inherited Members
Static Public Member Functions inherited from iText.Kernel.Pdf.Colorspace.PdfShading
static PdfShading	MakeShading (PdfDictionary shadingDictionary)
	Creates the PdfShading object from the existing iText.Kernel.Pdf.PdfDictionary with corresponding type. More...

Detailed Description

The class that extends PdfShading class and is in charge of Shading Dictionary with axial type, that define a colour blend that varies along a linear axis between two endpoints and extends indefinitely perpendicular to that axis.

Constructor & Destructor Documentation

◆ Axial() [1/4]

iText.Kernel.Pdf.Colorspace.PdfShading.Axial.Axial	(	PdfColorSpace	cs,
		float	x0,
		float	y0,
		float[]	color0,
		float	x1,
		float	y1,
		float[]	color1
	)

inline

Creates the new instance of the class.

Parameters

cs	the PdfColorSpace object in which colour values shall be expressed. The special Pattern space isn't excepted.
x0	the start coordinate of X axis expressed in the shading's target coordinate space.
y0	the start coordinate of Y axis expressed in the shading's target coordinate space.
color0	the `float[]` that represents the color in the start point.
x1	the end coordinate of X axis expressed in the shading's target coordinate space.
y1	the end coordinate of Y axis expressed in the shading's target coordinate space.
color1	the `float[]` that represents the color in the end point.

◆ Axial() [2/4]

iText.Kernel.Pdf.Colorspace.PdfShading.Axial.Axial	(	PdfColorSpace	cs,
		float	x0,
		float	y0,
		float[]	color0,
		float	x1,
		float	y1,
		float[]	color1,
		bool[]	extend
	)

inline

Creates the new instance of the class.

Parameters

cs	the PdfColorSpace object in which colour values shall be expressed. The special Pattern space isn't excepted.
x0	the start coordinate of X axis expressed in the shading's target coordinate space.
y0	the start coordinate of Y axis expressed in the shading's target coordinate space.
color0	the `float[]` that represents the color in the start point.
x1	the end coordinate of X axis expressed in the shading's target coordinate space.
y1	the end coordinate of Y axis expressed in the shading's target coordinate space.
color1	the `float[]` that represents the color in the end point.
extend	the array of two booleans that specified whether to extend the shading beyond the starting and ending points of the axis, respectively.

◆ Axial() [3/4]

iText.Kernel.Pdf.Colorspace.PdfShading.Axial.Axial	(	PdfColorSpace	cs,
		PdfArray	coords,
		IPdfFunction	function
	)

inline

Creates the new instance of the class.

Parameters

cs	the PdfColorSpace object in which colour values shall be expressed. The special Pattern space isn't excepted.
coords	the iText.Kernel.Pdf.PdfArray of four numbers [x0 y0 x1 y1] that specified the starting and the endings coordinates of thew axis, expressed in the shading's target coordinate space.
function	the iText.Kernel.Pdf.Function.IPdfFunction object, that is used to calculate color transitions.

◆ Axial() [4/4]

iText.Kernel.Pdf.Colorspace.PdfShading.Axial.Axial	(	PdfColorSpace	cs,
		PdfArray	coords,
		PdfArray	domain,
		IPdfFunction	function
	)

inline

Creates the new instance of the class.

Parameters

cs	the PdfColorSpace object in which colour values shall be expressed. The special Pattern space isn't excepted.
coords	the iText.Kernel.Pdf.PdfArray of four numbers [x0 y0 x1 y1] that specified the starting and the endings coordinates of thew axis, expressed in the shading's target coordinate space.
domain	the iText.Kernel.Pdf.PdfArray of two numbers [t0 t1] specifying the limiting values of a parametric variable t which is considered to vary linearly between these two values and becomes the input argument to the colour function.
function	the iText.Kernel.Pdf.Function.IPdfFunction object, that is used to calculate color transitions.

Member Function Documentation

◆ GetCoords()

virtual PdfArray iText.Kernel.Pdf.Colorspace.PdfShading.Axial.GetCoords ( )

inlinevirtual

Gets the Coords object - a iText.Kernel.Pdf.PdfArray of four numbers [x0 y0 x1 y1] that specified the starting and the endings coordinates of thew axis, expressed in the shading's target coordinate space.

Returns: the iText.Kernel.Pdf.PdfArray Coords object.

◆ GetDomain()

virtual PdfArray iText.Kernel.Pdf.Colorspace.PdfShading.Axial.GetDomain ( )

inlinevirtual

Gets the iText.Kernel.Pdf.PdfArray of two float [t0, t1] that represent the limiting values of a parametric variable t, that becomes an input of color function(s).

Returns: the iText.Kernel.Pdf.PdfArray of Domain object ([0.0 1.0] by default)

◆ GetExtend()

virtual PdfArray iText.Kernel.Pdf.Colorspace.PdfShading.Axial.GetExtend ( )

inlinevirtual

Gets the iText.Kernel.Pdf.PdfArray of two boolean that specified whether to extend the shading beyond the starting and ending points of the axis, respectively.

Returns: the iText.Kernel.Pdf.PdfArray of Extended object ([false false] by default)

◆ SetCoords() [1/2]

virtual void iText.Kernel.Pdf.Colorspace.PdfShading.Axial.SetCoords	(	float	x0,
		float	y0,
		float	x1,
		float	y1
	)

inlinevirtual

Sets the Choords object with the four params expressed in the shading's target coordinate space.

Parameters

x0	the start coordinate of X axis to be set.
y0	the start coordinate of Y axis to be set.
x1	the end coordinate of X axis to be set.
y1	the end coordinate of Y axis to be set.

◆ SetCoords() [2/2]

virtual void iText.Kernel.Pdf.Colorspace.PdfShading.Axial.SetCoords ( PdfArray coords )

inlinevirtual

Sets the Choords object with the iText.Kernel.Pdf.PdfArray of four numbers [x0 y0 x1 y1], that specified the starting and the endings coordinates of thew axis, expressed in the shading's target coordinate space.

Parameters

coords the Chords iText.Kernel.Pdf.PdfArray to be set.

◆ SetDomain() [1/2]

virtual void iText.Kernel.Pdf.Colorspace.PdfShading.Axial.SetDomain	(	float	t0,
		float	t1
	)

inlinevirtual

Sets the Domain with the array of two float [t0, t1] that represent the limiting values of a parametric variable t, that becomes an input of color function(s).

Parameters

t0	first limit of variable t
t1	second limit of variable t

◆ SetDomain() [2/2]

virtual void iText.Kernel.Pdf.Colorspace.PdfShading.Axial.SetDomain ( PdfArray domain )

inlinevirtual

Sets the Domain with the iText.Kernel.Pdf.PdfArray of two float [t0, t1] that represent the limiting values of a parametric variable t, that becomes an input of color function(s).

Parameters

domain the iText.Kernel.Pdf.PdfArray that represents domain

◆ SetExtend() [1/2]

virtual void iText.Kernel.Pdf.Colorspace.PdfShading.Axial.SetExtend	(	bool	extendStart,
		bool	extendEnd
	)

inlinevirtual

Sets the Extend object with the two boolean value.

Parameters

extendStart	if true will extend shading beyond the starting point of Coords
extendEnd	if true will extend shading beyond the ending point of Coords

◆ SetExtend() [2/2]

virtual void iText.Kernel.Pdf.Colorspace.PdfShading.Axial.SetExtend ( PdfArray extend )

inlinevirtual

Sets the Extend object with the iText.Kernel.Pdf.PdfArray of two boolean.

Sets the Extend object with the iText.Kernel.Pdf.PdfArray of two boolean. If first is true shading will extend beyond the starting point of Coords. If second is true shading will extend beyond the ending point of Coords.

Parameters

extend the iText.Kernel.Pdf.PdfArray representing Extend object

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Axial() [1/4]

◆ Axial() [2/4]

◆ Axial() [3/4]

◆ Axial() [4/4]

Member Function Documentation

◆ GetCoords()

◆ GetDomain()

◆ GetExtend()

◆ SetCoords() [1/2]

◆ SetCoords() [2/2]

◆ SetDomain() [1/2]

◆ SetDomain() [2/2]

◆ SetExtend() [1/2]

◆ SetExtend() [2/2]