Interface TextStampOptions

An options for stampText

Hierarchy

Properties

backgroundColor?: string

Default

#00FFFFFF (Transparent)

behindExistingContent?: boolean

Set to true for apply stamp behind the content. If the content is opaque, the stamp may be invisible.

Default

false
fontFamily?: string

Font family name for the text.

Note: If using a web font from https://fonts.google.com/ then you must set useGoogleFont property of this TextStampOptions to true.

Default

Arial

fontSize?: number

Default

12

horizontalAlignment: HorizontalAlignment

The horizontal alignment of the stamp relative to the page.

horizontalOffset?: Length

The horizontal offset. Value of 0 has no effect. Positive indicates an offset to the right direction. Negative indicates an offset to the left direction.

Default

{@link MeasurementUnit.Percentage} value 0 (no offset)
hyperlink?: string

Makes stamped elements of this Stamper have an on-click hyperlink. Note: HTML links created by <a href=''> tags are not reserved by stamping.

Default

undefined

isBold?: boolean

Default

false

isItalic?: boolean

Default

false

isStrikethrough?: boolean

Default

false

isUnderline?: boolean

Default

false

maxHeight?: Length

The maximum height of the output stamp.

Default

undefined
maxWidth?: Length

The maximum width of the output stamp.

Default

undefined
minHeight?: Length

The minimum height of the output stamp.

Default

undefined
minWidth?: Length

The minimum width of the output stamp.

Default

undefined
opacity?: number

Gets opacity. Allows the stamp to be transparent. 0 is fully invisible, 100 if fully opaque.

Default

100
renderDelay?: number

Milliseconds to wait after Html is rendered before printing. This can use useful when considering the rendering of JavaScript, Ajax or animations.

Default

value for HtmlStamper is 100, The other Stamper is 0.
rotation?: number

Rotates the stamp clockwise from 0 to 360 degrees as specified.

Default

0
scale?: number

Applies a percentage scale to the stamps to be larger or smaller.

Default

100 (Percent) which has no effect.
textColor?: string

Default

#000000 (Black)

timeout?: number

Render timeout in seconds

Default

60
useGoogleFont?: boolean

Must be set to true, when using fontFamily from https://fonts.google.com/ as a web font

Default

false

verticalAlignment: VerticalAlignment

The vertical alignment of the stamp relative to the page.

verticalOffset?: Length

The horizontal offset. Value of 0 has no effect. Positive indicates an offset to the downward direction. Negative indicates an offset to the upward direction.

Default

{@link MeasurementUnit.Percentage} value 0 (no offset)

Generated using TypeDoc