Patterns can be defined as a dictionary of predefined patterns in the document definition.

Only tiling patterns are supported.

Pattern definition

Each pattern is defined using:

For more information on each property and patterns in general see the PDF reference, section 4.6 and 4.6.2 specifically on tiling patterns.

Pattern definition example

Basic pattern that produces a 45° stripe pattern:

var docDefinition = {
  content: ["..."],
  patterns: {
    stripe45d: {
      boundingBox: [1, 1, 4, 4],
      xStep: 3,
      yStep: 3,
      pattern: "1 w 0 1 m 4 5 l s 2 0 m 5 3 l s",

The output can be seen in the vector example.

Usage in vectors, tables and text

The following properties are available.

For text:

For vectors:

For table cells:

Each of the above properties is defined as a tuple [string, string]. The first element is the key in the patterns dictionary and the second is the color to use to paint the pattern.



{ text: 'Insert lorem. And ipsum', background: ['stripe45d', 'gray'] }


  type: 'rect',
  x: 10, y: 250, w: 50, h: 30,
  color: ['stripe45d', 'blue'],

Table (as used in table cells):

  text: 'Sample value',
  fillOpacity: 0.85,
  fillColor: ['stripe45d', 'blue']
  text: 'Sample value',
  fillOpacity: 0.15,
  fillColor: 'blue',
  overlayPattern: ['stripe45d', 'gray'],
  overlayOpacity: 0.15