IPdfTextSettings Interface

File
wijmo.pdf.js
Module
wijmo.pdf

Represents text settings used by drawText and measureText methods.

Properties

Properties

align

Determines how text is aligned within the drawing area. The default value is Left.

Type
PdfTextHorizontalAlign

characterSpacing

Determines the spacing between text characters. The default value is 0.

Type
number

columnGap

Determines the spacing between each column, in points. The default value is 18.

Type
number

columns

Determines the number of columns to flow the text into. The default value is 1.

Type
number

continued

Indicates whether subsequent text should be continued right after that or it will be a new paragraph. If true, the text settings will be retained between drawText calls. It means that options argument will be merged with the one taken from the previous drawText call.

The default value is false.

Type
boolean

ellipsis

Determines the character to display at the end of the text when it exceeds the given area.The default value is undefined, that is, ellipsis is not displayed. Set to true to use the default character.

Type
any

fill

Indicates whether the text should be filled or not. The default value is true.

Type
boolean

height

Determines the height of the drawing area in points to which the text should be clipped. The default value is undefined which means that the text area will be limited by bottom edge of the body section. Use Infinity to indicate that the text area has an infinite height.

Type
number

indent

Determines the value of indentaion in each paragraph of text, in points. The default value is 0.

Type
number

lineBreak

Indicates whether line wrapping should be used or not. The property is ignored if width is defined. The default value is true.

Type
boolean

lineGap

Determines the spacing between lines of text. The default value is 0.

Type
number

paragraphGap

Determines the spacing between paragraphs of text. The default value is 0.

Type
number

strike

Indicates whether the text should be striked out or not. The default value is false.

Type
boolean

stroke

Indicates whether the text should be stroked or not. The default value is false.

Type
boolean

underline

Indicates whether the text should be underlined or not. The default value is false.

Type
boolean

width

Determines the width of the text area in points to which the text should wrap. The default value is undefined which means that the text area will be limited by right margin of the page. Use Infinity to indicate that the text area has an infinite width. If defined, forces the lineBreak property to be enabled.

Type
number

wordSpacing

Determines the spacing between words in the text. The default value is 0.

Type
number