PDFTron pdfnet-node

Class: PatternColor

PDFNet. PatternColor

new PatternColor()

Patterns are quite general, and have many uses; for example, they can be used to create various graphical textures, such as weaves, brick walls, sunbursts, and similar geometrical and chromatic effects. Patterns are specified in a special family of color spaces named Pattern, whose 'color values' are PatternColor objects instead of the numeric component values used with other spaces. Therefore PatternColor is to pattern color space what is ColorPt to all other color spaces. A tiling pattern consists of a small graphical figure called a pattern cell. Painting with the pattern replicates the cell at fixed horizontal and vertical intervals to fill an area. The effect is as if the figure were painted on the surface of a clear glass tile, identical copies of which were then laid down in an array covering the area and trimmed to its boundaries. This is called tiling the area. The pattern cell can include graphical elements such as filled areas, text, and sampled images. Its shape need not be rectangular, and the spacing of tiles can differ from the dimensions of the cell itself. The order in which individual tiles (instances of the cell) are painted is unspecified and unpredictable; it is inadvisable for the figures on adjacent tiles to overlap.

Extends

Members

<static> TilingType

Type:
  • number
Properties:
Name Type Description
e_constant_spacing number
e_no_distortion number
e_constant_spacing_fast_fill number

<static> Type

Type:
  • number
Properties:
Name Type Description
e_uncolored_tiling_pattern number
e_colored_tiling_pattern number
e_shading number
e_null number

Methods

<static> create(pattern)

Create a PatternColor from the given SDF/Cos object listed under Pattern entry in page Resource dictionary
Parameters:
Name Type Description
pattern PDFNet.Obj
Returns:
A promise that resolves to an object of type: "PDFNet.PatternColor"
Type
Promise.<PDFNet.PatternColor>

<static> getTypeFromObj(pattern)

Parameters:
Name Type Description
pattern PDFNet.Obj
Returns:
A promise that resolves to an object of type: "number" 
PDFNet.PatternColor.Type = {
	e_uncolored_tiling_pattern : 0
	e_colored_tiling_pattern : 1
	e_shading : 2
	e_null : 3
}
Type
Promise.<number>

destroy()

Destructor
Inherited From:
Returns:
Type
Promise.<void>

getBBox()

Returns:
A promise that resolves to a rectangle in the pattern coordinate system giving the coordinates of the left, bottom, right, and top edges, respectively, of the pattern cell's bounding box. These boundaries are used to clip the pattern cell. Note: for patterns other than Tiling this method throws an exception.
Type
Promise.<PDFNet.Rect>

getMatrix()

Returns:
A promise that resolves to pattern matrix, a transformation matrix that maps the pattern's internal coordinate system to the default coordinate system of the pattern's parent content stream (the content stream in which the pattern is defined as a resource). The concatenation of the pattern matrix with that of the parent content stream establishes the pattern coordinate space, within which all graphics objects in the pattern are interpreted.
Type
Promise.<PDFNet.Matrix2D>

getSDFObj()

Returns:
A promise that resolves to the underlying SDF/Cos object
Type
Promise.<PDFNet.Obj>

getShading()

Returns:
A promise that resolves to the shading object defining the shading pattern's gradient fill. Note: for patterns other than Shading this method throws an exception.
Type
Promise.<PDFNet.Shading>

getTilingType()

Returns:
A promise that resolves to the tiling type identifier that controls adjustments to the spacing of tiles relative to the device pixel grid: Note: for patterns other than Tiling this method throws an exception.
Type
Promise.<number>
Example
Return value enum:
<pre>
PDFNet.PatternColor.TilingType = {
	e_constant_spacing : 0
	e_no_distortion : 1
	e_constant_spacing_fast_fill : 2
}
</pre>

getType()

Returns:
A promise that resolves to the pattern type
Type
Promise.<number>
Example
Return value enum:
<pre>
PDFNet.PatternColor.Type = {
	e_uncolored_tiling_pattern : 0
	e_colored_tiling_pattern : 1
	e_shading : 2
	e_null : 3
}
</pre>

getXStep()

Returns:
A promise that resolves to the desired horizontal spacing between pattern cells, measured in the pattern coordinate system. Note: that XStep and YStep may differ from the dimensions of the pattern cell implied by the BBox entry. This allows tiling with irregularly shaped figures. XStep and YStep may be either positive or negative, but not zero. Note: for patterns other than Tiling this method throws an exception.
Type
Promise.<number>

getYStep()

Returns:
A promise that resolves to the desired vertical spacing between pattern cells, measured in the pattern coordinate system. Note: for patterns other than Tiling this method throws an exception.
Type
Promise.<number>

takeOwnership()

Take the ownership of this object, so that PDFNet.runWithCleanup won't destroy this object.
Inherited From:
Returns:
Type
void