constructor(options?: any): PdfRunningTitle
Initializes a new instance of the PdfRunningTitle class.
An optional object containing initialization settings.
Gets or sets an object that provides the ability to setup the running title content declaratively.
Gets or sets the height of the running title, in points. To hide the running title, set this property to 0. Changing this property has no effect on previous drawings; they will not be resized or clipped.
The default value is 24.
Gets or sets the spacing between each line of text, in points.
The default value is 0.
Gets or sets the X-coordinate (in points) of the current point in the text flow used to draw a text or an image.
Gets or sets the Y-coordinate (in points) of the current point in the text flow used to draw a text or an image.
drawImage(url: string, x?: number, y?: number, options?: IPdfImageDrawSettings): PdfPageArea
Draws an image in JPG or PNG format with the given options.
If x and y are not defined, then @see:x and @see:y are used instead.
Finally, if the image was drawn in the text flow, the method updates @see:y. Hence, any subsequent text or image starts below this point.
A string containing the URL to get the image from or the data URI containing a base64 encoded image.
The x-coordinate of the point to draw the image at, in points.
The y-coordinate of the point to draw the image at, in points.
Determines the image drawing options.
drawSvg(url: string, x?: number, y?: number, options?: IPdfSvgDrawSettings): PdfPageArea
Draws a SVG image with the given options.
If x and y are not defined, then @see:x and @see:y are used instead.
The method uses the values of the width and height attributes of the outermost svg element to determine the scale factor according to the options.width and options.height properties. If any of these attributes are omitted then scaling is not performed and the image will be rendered in its original size.
Finally, if the image was drawn in the text flow, the method updates @see:y. Hence, any subsequent text or image starts below this point. The increment value is defined by the options.height property or by the outermost svg element's height attribute, which comes first. If none of them is provided then @see:y will stay unchanged.
The method supports a limited set of SVG features and provided primarily for rendering wijmo 5 chart controls.
A string containing the URL to get the SVG image from or the data URI containing a base64 encoded SVG image.
The x-coordinate of the point to draw the image at, in points.
The y-coordinate of the point to draw the image at, in points.
Determines the SVG image drawing options.
drawText(text: string, x?: number, y?: number, options?: IPdfTextDrawSettings): IPdfTextMeasurementInfo
Draws a string with the given options and returns the measurement information.
If options.pen, options.brush or options.font are omitted, the current document's pen, brush or font are used (see setPen, setBrush, and setFont).
The string is drawn within the rectangular area for which top-left corner, width and height are defined by the x, y, options.width and options.height values. If x and y are not provided, the x and y properties are used instead.
The text is wrapped and clipped automatically within the area. If options.height is not provided and the text exceeds the bottom body edge, then a new page will be added to accommodate the text.
Finally, the method updates the value of the x and y properties. Hence, any subsequent text or image starts below this point (depending on the value of options.continued).
The measurement result doesn't reflect the fact that text can be split into multiple pages or columns; the text is treated as a single block.
The text to draw.
The X-coordinate of the point to draw the text at, in points.
The Y-coordinate of the point to draw the text at, in points.
Determines the text drawing options.
lineHeight(font?: PdfFont): number
Gets the line height with a given font.
If font is not specified, then font used in the current document is used.
Font to get the line height.
measureText(text: string, font?: PdfFont, options?: IPdfTextSettings): IPdfTextMeasurementInfo
Measures a text with the given font and text drawing options without rendering it.
If font is not specified, then the font used in the current document is used.
The method uses the same text rendering engine as drawText, so it is tied up in the same way to @see:x and the right page margin, if options.width is not provided. The measurement result doesn't reflect the fact that text can be split into multiple pages or columns; the text is treated as a single block.
Text to measure.
Font to be applied on the text.
Determines the text drawing options.
moveDown(lines?: number, font?: PdfFont): PdfPageArea
Moves down the @see:y by a given number of lines using the given font or, using the font of current document, if not specified.
Number of lines to move down.
Font to calculate the line height.
moveUp(lines?: number, font?: PdfFont): PdfPageArea
Moves up the @see:y by a given number of lines using the given font or, using the font of current document, if not specified.
Number of lines to move up.
Font to calculate the line height.
rotate(angle: number, origin?: Point): PdfPageArea
Rotates the graphic context clockwise by a specified angle.
The rotation angle, in degrees.
The Point of rotation, in points. If it is not provided, then the top left corner is used.
scale(xFactor: number, yFactor?: number, origin?: Point): PdfPageArea
Scales the graphic context by a specified scaling factor.
The scaling factor value within the range [0, 1] indicates that the size will be decreased. The scaling factor value greater than 1 indicates that the size will be increased.
The factor to scale the X dimension.
The factor to scale the Y dimension. If it is not provided, it is assumed to be equal to xFactor.
The Point to scale around, in points. If it is not provided, then the top left corner is used.
transform(a: number, b: number, c: number, d: number, e: number, f: number): PdfPageArea
Transforms the graphic context with given six numbers which represents a 3x3 transformation matrix.
A transformation matrix is written as follows:
| a | b | 0 |
| c | d | 0 |
| e | f | 1 |
Value of the first row and first column.
Value of the first row and second column.
Value of the second row and first column.
Value of the second row and second column.
Value of the third row and first column.
Value of the third row and second column.
translate(x: number, y: number): PdfPageArea
Translates the graphic context with a given distance.
The distance to translate along the X-axis, in points.
The distance to translate along the Y-axis, in points.
Represents a running title of the page, like header and footer.
This class is not intended to be instantiated in your code.