# SvgContext ## Content [**DsPdfJS API v9.1.3**](../README) *** [DsPdfJS API](../globals) / SvgContext # Class: SvgContext Represents a drawing context for a new [SvgDocument](SvgDocument). ## Extends - [`DrawingContext`](DrawingContext) ## Constructors ### Constructor > **new SvgContext**(`width`, `height`, `svgContextProperties?`): `SvgContext` Creates an SvgContext for drawing graphics and converting to [SvgDocument](SvgDocument). #### Parameters ##### width `number` The width of the image, in device-independent pixels. ##### height `number` The height of the image, in device-independent pixels. ##### svgContextProperties? [`SvgContextProperties`](../type-aliases/SvgContextProperties) The settings for creating a [DrawingContext](DrawingContext) for SVG. #### Returns `SvgContext` #### Overrides `DrawingContext.constructor` ### Constructor > **new SvgContext**(`om`, `width`, `height`, `svgContextProperties?`): `SvgContext` Creates an SvgContext for drawing graphics and converting to [SvgDocument](SvgDocument). #### Parameters ##### om [`ObjectManager`](ObjectManager) An object manager that controls the lifetime of the SvgContext object. ##### width `number` The width of the image, in device-independent pixels. ##### height `number` The height of the image, in device-independent pixels. ##### svgContextProperties? [`SvgContextProperties`](../type-aliases/SvgContextProperties) The settings for creating a [DrawingContext](DrawingContext) for SVG. #### Returns `SvgContext` #### Overrides `DrawingContext.constructor` ## Accessors ### description #### Get Signature > **get** **description**(): `string` Gets or sets the description of the SVG document. ##### Returns `string` #### Set Signature > **set** **description**(`value`): `void` Gets or sets the description of the SVG document. ##### Parameters ###### value `string` ##### Returns `void` *** ### drawTextAsPath #### Get Signature > **get** **drawTextAsPath**(): `boolean` Gets or sets a value indicating if text is rendered using the graphic paths instead of the specialized text drawing services. Assigning a null value resets the property to a default value that depends on context type. This property does not affect drawing to [BmpContext](BmpContext). ##### Returns `boolean` #### Set Signature > **set** **drawTextAsPath**(`value`): `void` Gets or sets a value indicating if text is rendered using the graphic paths instead of the specialized text drawing services. Assigning a null value resets the property to a default value that depends on context type. This property does not affect drawing to [BmpContext](BmpContext). ##### Parameters ###### value `boolean` | `null` ##### Returns `void` #### Inherited from [`DrawingContext`](DrawingContext).[`drawTextAsPath`](DrawingContext#drawtextaspath) *** ### embedFonts #### Get Signature > **get** **embedFonts**(): `boolean` Gets or sets a value indicating whether fonts used in 'text' elements should be embedded. ##### Returns `boolean` #### Set Signature > **set** **embedFonts**(`value`): `void` Gets or sets a value indicating whether fonts used in 'text' elements should be embedded. ##### Parameters ###### value `boolean` ##### Returns `void` *** ### fontCollection #### Get Signature > **get** **fontCollection**(): [`FontCollection`](FontCollection) \| `null` Gets or sets the [FontCollection](FontCollection) used by measureText and [DrawingContext#drawText](DrawingContext#drawtext)/[DrawingContext#drawLayout](DrawingContext#drawlayout) methods. ##### Returns [`FontCollection`](FontCollection) \| `null` #### Set Signature > **set** **fontCollection**(`coll`): `void` Gets or sets the [FontCollection](FontCollection) used by measureText and [DrawingContext#drawText](DrawingContext#drawtext)/[DrawingContext#drawLayout](DrawingContext#drawlayout) methods. ##### Parameters ###### coll [`FontCollection`](FontCollection) | `null` ##### Returns `void` #### Inherited from [`DrawingContext`](DrawingContext).[`fontCollection`](DrawingContext#fontcollection) *** ### height #### Get Signature > **get** **height**(): `number` Gets or sets the height of the image, in device-independent pixels. ##### Returns `number` #### Set Signature > **set** **height**(`value`): `void` Gets or sets the height of the image, in device-independent pixels. ##### Parameters ###### value `number` ##### Returns `void` #### Overrides [`DrawingContext`](DrawingContext).[`height`](DrawingContext#height) *** ### id #### Get Signature > **get** **id**(): `number` Gets the reference to the object. ##### Returns `number` #### Inherited from [`DrawingContext`](DrawingContext).[`id`](DrawingContext#id) *** ### idSuffix #### Get Signature > **get** **idSuffix**(): `string` Gets or sets a string to be appended to the auto-generated ID values. ##### Returns `string` #### Set Signature > **set** **idSuffix**(`value`): `void` Gets or sets a string to be appended to the auto-generated ID values. ##### Parameters ###### value `string` ##### Returns `void` *** ### imageRendering #### Get Signature > **get** **imageRendering**(): [`ImageRendering`](../enumerations/ImageRendering) Gets or sets a hint to the implementation about how to make speed vs. quality tradeoffs as it performs image processing. ##### Returns [`ImageRendering`](../enumerations/ImageRendering) #### Set Signature > **set** **imageRendering**(`imageRendering`): `void` Gets or sets a hint to the implementation about how to make speed vs. quality tradeoffs as it performs image processing. ##### Parameters ###### imageRendering [`ImageRendering`](../enumerations/ImageRendering) ##### Returns `void` *** ### matrix #### Get Signature > **get** **matrix**(): `number`[] Gets or sets the transformation matrix. The matrix consists of six numbers (their meaning is simplified for clarity): m11 - scales the drawing horizontally m12 - skew the the drawing horizontally m21 - skew the the drawing vertically m22 - scales the drawing vertically m31 - moves the the drawing horizontally m32 - moves the the drawing vertically ##### Returns `number`[] #### Set Signature > **set** **matrix**(`matrix`): `void` Gets or sets the transformation matrix. The matrix consists of six numbers (their meaning is simplified for clarity): m11 - scales the drawing horizontally m12 - skew the the drawing horizontally m21 - skew the the drawing vertically m22 - scales the drawing vertically m31 - moves the the drawing horizontally m32 - moves the the drawing vertically ##### Parameters ###### matrix `number`[] ##### Returns `void` #### Inherited from [`DrawingContext`](DrawingContext).[`matrix`](DrawingContext#matrix) *** ### om #### Get Signature > **get** **om**(): [`ObjectManager`](ObjectManager) Gets the owner [ObjectManager](ObjectManager) instance. ##### Returns [`ObjectManager`](ObjectManager) #### Inherited from [`DrawingContext`](DrawingContext).[`om`](DrawingContext#om) *** ### preciseCharPositions #### Get Signature > **get** **preciseCharPositions**(): `boolean` Gets or sets a value indicating whether the positions are set for each individual character within the 'text' element. ##### Returns `boolean` #### Set Signature > **set** **preciseCharPositions**(`value`): `void` Gets or sets a value indicating whether the positions are set for each individual character within the 'text' element. ##### Parameters ###### value `boolean` ##### Returns `void` *** ### resolution #### Get Signature > **get** **resolution**(): `number` Gets the resolution of the [DrawingContext](DrawingContext), in dots per Inch. ##### Returns `number` #### Overrides [`DrawingContext`](DrawingContext).[`resolution`](DrawingContext#resolution) *** ### shapeRendering #### Get Signature > **get** **shapeRendering**(): [`ShapeRendering`](../enumerations/ShapeRendering) Gets or sets a hint to the implementation about what tradeoffs to make as it renders vector graphics elements. ##### Returns [`ShapeRendering`](../enumerations/ShapeRendering) #### Set Signature > **set** **shapeRendering**(`shapeRendering`): `void` Gets or sets a hint to the implementation about what tradeoffs to make as it renders vector graphics elements. ##### Parameters ###### shapeRendering [`ShapeRendering`](../enumerations/ShapeRendering) ##### Returns `void` *** ### title #### Get Signature > **get** **title**(): `string` Gets or sets the title of the SVG document. ##### Returns `string` #### Set Signature > **set** **title**(`value`): `void` Gets or sets the title of the SVG document. ##### Parameters ###### value `string` ##### Returns `void` *** ### transform #### Get Signature > **get** **transform**(): [`Transform`](Transform) Gets or sets the current transformation of the drawing surface. ##### Returns [`Transform`](Transform) #### Set Signature > **set** **transform**(`transform`): `void` Gets or sets the current transformation of the drawing surface. ##### Parameters ###### transform [`Transform`](Transform) ##### Returns `void` #### Inherited from [`DrawingContext`](DrawingContext).[`transform`](DrawingContext#transform) *** ### type #### Get Signature > **get** **type**(): [`ContextType`](../enumerations/ContextType) Gets the type of [DrawingContext](DrawingContext). ##### Returns [`ContextType`](../enumerations/ContextType) #### Overrides [`DrawingContext`](DrawingContext).[`type`](DrawingContext#type) *** ### width #### Get Signature > **get** **width**(): `number` Gets or sets the width of the image, in device-independent pixels. ##### Returns `number` #### Set Signature > **set** **width**(`value`): `void` Gets or sets the width of the image, in device-independent pixels. ##### Parameters ###### value `number` ##### Returns `void` #### Overrides [`DrawingContext`](DrawingContext).[`width`](DrawingContext#width) ## Methods ### applyTransform() > **applyTransform**(`transform`): `void` Applies a new transformation to the current transformation matrix. #### Parameters ##### transform [`Transform`](Transform) The [Transform](Transform) object to be multiplied by the current transformation matrix. #### Returns `void` #### Inherited from [`DrawingContext`](DrawingContext).[`applyTransform`](DrawingContext#applytransform) *** ### createPath() > **createPath**(): [`GraphicsPath`](GraphicsPath) Creates a new [GraphicsPath](GraphicsPath). #### Returns [`GraphicsPath`](GraphicsPath) A new instance of the [GraphicsPath](GraphicsPath). #### Inherited from [`DrawingContext`](DrawingContext).[`createPath`](DrawingContext#createpath) *** ### drawEllipse() #### Call Signature > **drawEllipse**(`x`, `y`, `width`, `height`, `drawEllipseOptions`): `void` Draws and fills an ellipse. ##### Parameters ###### x `number` The X coordinate of the rectangle enclosing an ellipse. ###### y `number` The Y coordinate of the rectangle enclosing an ellipse. ###### width `number` The width of the rectangle enclosing an ellipse. ###### height `number` The height of the rectangle enclosing an ellipse. ###### drawEllipseOptions [`DrawEllipseOptions`](../type-aliases/DrawEllipseOptions) The options for drawing and filling an ellipse. ##### Returns `void` ##### Inherited from [`DrawingContext`](DrawingContext).[`drawEllipse`](DrawingContext#drawellipse) #### Call Signature > **drawEllipse**(`bounds`, `drawEllipseOptions`): `void` Draws and fills an ellipse. ##### Parameters ###### bounds [`Bounds`](../type-aliases/Bounds) The rectangle enclosing an ellipse. ###### drawEllipseOptions [`DrawEllipseOptions`](../type-aliases/DrawEllipseOptions) The options for drawing and filling an ellipse. ##### Returns `void` ##### Inherited from [`DrawingContext`](DrawingContext).[`drawEllipse`](DrawingContext#drawellipse) *** ### drawImage() #### Call Signature > **drawImage**(`image`, `x`, `y`, `width`, `height`, `drawImageOptions?`): `void` Draws an image or bitmap with specified size, location, and opacity. ##### Parameters ###### image [`ImageOrBitmap`](../type-aliases/ImageOrBitmap) The image object to draw. ###### x `number` The X coordinate of the destination rectangle. ###### y `number` The Y coordinate of the destination rectangle. ###### width `number` The width of the destination rectangle. ###### height `number` The height of the destination rectangle. ###### drawImageOptions? [`DrawImageOptions`](../type-aliases/DrawImageOptions) The options for drawing an image. ##### Returns `void` ##### Inherited from [`DrawingContext`](DrawingContext).[`drawImage`](DrawingContext#drawimage) #### Call Signature > **drawImage**(`image`, `bounds`, `drawImageOptions?`): `void` Draws an image or bitmap with specified size, location, and opacity. ##### Parameters ###### image [`ImageOrBitmap`](../type-aliases/ImageOrBitmap) The image object to draw. ###### bounds [`Bounds`](../type-aliases/Bounds) The destination rectangle. ###### drawImageOptions? [`DrawImageOptions`](../type-aliases/DrawImageOptions) The options for drawing an image. ##### Returns `void` ##### Inherited from [`DrawingContext`](DrawingContext).[`drawImage`](DrawingContext#drawimage) *** ### drawLayout() > **drawLayout**(`layout`, `x`, `y`): `void` Draws a [Layout](Layout) at the specified position. #### Parameters ##### layout An existing Layout object or the properties describing a new Layout settings. [`Layout`](Layout) | [`LayoutProperties`](../type-aliases/LayoutProperties) ##### x `number` The X coordinate at which to draw the Layout. ##### y `number` The Y coordinate at which to draw the Layout. #### Returns `void` #### Example ```ts const font = Font.getPdfFont(StandardPdfFont.CourierBold); const sb = new SolidBrush("CadetBlue"); const lgb = new LinearGradientBrush({ startColor: "Red", startPoint: { x: 0, y: 0 }, gradientStops: [{ offset: 0.5, color: "Green" }], endColor: "Blue", endPoint: { x: 1, y: 0 } }); const rgb = new RadialGradientBrush({ startColor: "Red", endColor: "Green" }); const bitmap = new Bitmap(600, 420); const ctx = bitmap.newContext({ backColor: "Yellow" }); const tf = new Format({ font: font, fontSize: 40 }); ctx.drawLayout({ maxWidth: 600, firstLineIndent: 50, runs: [ { text: "test font Solid fill brush in DsPdfJS\n", format: tf, fillBrush: sb }, { text: "test Linear Gradient fill in DsPdfJS\n", format: tf, fillBrush: lgb }, { text: "test Radial Gradient fill that spans multiple lines in DsPdfJS", format: tf, fillBrush: rgb } ] }, 0, 0); const res: Uint8Array = bitmap.saveAsPng(); ``` #### Inherited from [`DrawingContext`](DrawingContext).[`drawLayout`](DrawingContext#drawlayout) *** ### drawLine() > **drawLine**(`x1`, `y1`, `x2`, `y2`, `pen`): `void` Draws a line between two points, using the specified pen. #### Parameters ##### x1 `number` The X coordinate of the first point. ##### y1 `number` The Y coordinate of the first point. ##### x2 `number` The X coordinate of the second point. ##### y2 `number` The Y coordinate of the second point. ##### pen The [Pen](Pen) object or settings for creating a pen. [`Pen`](Pen) | [`PenProperties`](../type-aliases/PenProperties) #### Returns `void` #### Inherited from [`DrawingContext`](DrawingContext).[`drawLine`](DrawingContext#drawline) *** ### drawLines() > **drawLines**(`points`, `pen`): `void` Draws a series of connected lines, using a specified pen. #### Parameters ##### points [`Point`](../type-aliases/Point)[] The array of points to connect. ##### pen The [Pen](Pen) object or settings for creating a pen. [`Pen`](Pen) | [`PenProperties`](../type-aliases/PenProperties) #### Returns `void` #### Inherited from [`DrawingContext`](DrawingContext).[`drawLines`](DrawingContext#drawlines) *** ### drawPath() > **drawPath**(`path`, `drawPathOptions`): `void` Draws and fills a graphics path. #### Parameters ##### path [`GraphicsPath`](GraphicsPath) The [GraphicsPath](GraphicsPath) object to draw. ##### drawPathOptions [`DrawPathOptions`](../type-aliases/DrawPathOptions) The options for drawing and filling the [GraphicsPath](GraphicsPath). #### Returns `void` #### Example ```ts const ctx = new BmpContext(800, 600, 0.5, "Honeydew"); const path = ctx.createPath(); path.beginFigure(100, 350); path.addLine(210, 310); path.addArc({ size: { width: 183, height: 173 }, sweepDirection: SweepDirection.Clockwise, point: { x: 550, y: 205 } }); path.addLine(650, 170); path.addLine(680, 250); path.addLine(575, 285); path.addArc({ size: { width: 183, height: 173 }, sweepDirection: SweepDirection.Clockwise, point: { x: 240, y: 390 } }); path.addLine(130, 430); path.endFigure(true); path.addEllipse({ x: 295, y: 197, width: 200, height: 190 }); ctx.drawPath(path, { fillColor: "MediumAquamarine", lineColor: "Green", lineWidth: 20 }); const res: Uint8Array = ctx.bitmap.saveAsPng(); ``` #### Inherited from [`DrawingContext`](DrawingContext).[`drawPath`](DrawingContext#drawpath) *** ### drawPolygon() > **drawPolygon**(`points`, `drawPolygonOptions`): `void` Draws and fills a polygon. #### Parameters ##### points The array of points or a quadrilateral specifying the polygon. [`Point`](../type-aliases/Point)[] | [`Quadrilateral`](../type-aliases/Quadrilateral) ##### drawPolygonOptions [`DrawPolygonOptions`](../type-aliases/DrawPolygonOptions) The options for drawing and filling a polygon. #### Returns `void` #### Inherited from [`DrawingContext`](DrawingContext).[`drawPolygon`](DrawingContext#drawpolygon) *** ### drawRect() #### Call Signature > **drawRect**(`x`, `y`, `width`, `height`, `drawRectangleOptions`): `void` Draws and fills a rectangle or rounded rectangle. ##### Parameters ###### x `number` The X coordinate of the rectangle. ###### y `number` The Y coordinate of the rectangle. ###### width `number` The width of the rectangle. ###### height `number` The height of the rectangle. ###### drawRectangleOptions [`DrawRectangleOptions`](../type-aliases/DrawRectangleOptions) The options for drawing and filling a rectangle. ##### Returns `void` ##### Inherited from [`DrawingContext`](DrawingContext).[`drawRect`](DrawingContext#drawrect) #### Call Signature > **drawRect**(`bounds`, `drawRectangleOptions`): `void` Draws and fills a rectangle or rounded rectangle. ##### Parameters ###### bounds [`Bounds`](../type-aliases/Bounds) The rectangle bounds. ###### drawRectangleOptions [`DrawRectangleOptions`](../type-aliases/DrawRectangleOptions) The options for drawing and filling a rectangle. ##### Returns `void` ##### Inherited from [`DrawingContext`](DrawingContext).[`drawRect`](DrawingContext#drawrect) *** ### drawSvg() > **drawSvg**(`svgDocument`, `x`, `y`, `opacity?`): `void` Draws a [SvgDocument](SvgDocument) at a point specifying the position of SVG viewport. To specify the position of SVG content rather than viewport, see the drawSvgContent method. #### Parameters ##### svgDocument [`SvgDocument`](SvgDocument) The [SvgDocument](SvgDocument) to draw. ##### x `number` The X coordinate of SVG viewport. ##### y `number` The Y coordinate of SVG viewport. ##### opacity? `number` The opacity factor to be applied to SVG content, between 0.0 (fully transparent) and 1.0 (fully opaque). The default is 1.0. #### Returns `void` #### Example ```ts const svgDoc = SvgDocument.load(svgData); const margin = 50; const rect = svgDoc.measure(0, 0); const ctx = new BmpContext( rect.width + margin * 2, rect.height + margin * 2, 0.7, "Linen" }); ctx.slowAntialiasing = true; ctx.drawSvg(svgDoc, -rect.x + margin, -rect.y + margin); const res: Uint8Array = ctx.bitmap.saveAsPng(); ``` #### Inherited from [`DrawingContext`](DrawingContext).[`drawSvg`](DrawingContext#drawsvg) *** ### drawSvgContent() > **drawSvgContent**(`svgDocument`, `x`, `y`, `opacity?`): `void` Draws the content of a specified [SvgDocument](SvgDocument) at a point specifying the top-left corner of SVG content. To specify the position of SVG viewport rather than content, see the drawSvg method. #### Parameters ##### svgDocument [`SvgDocument`](SvgDocument) The [SvgDocument](SvgDocument) to draw. ##### x `number` The X coordinate of SVG content. ##### y `number` The Y coordinate of SVG content. ##### opacity? `number` The opacity factor to be applied to SVG content, between 0.0 (fully transparent) and 1.0 (fully opaque). The default is 1.0. #### Returns `void` #### Inherited from [`DrawingContext`](DrawingContext).[`drawSvgContent`](DrawingContext#drawsvgcontent) *** ### drawSvgToContentRect() #### Call Signature > **drawSvgToContentRect**(`svgDocument`, `contentX`, `contentY`, `contentWidth`, `contentHeight`, `opacity?`): `void` Draws the content of a specified [SvgDocument](SvgDocument), resizing the content to fit into a specified rectangle. To draw the SVG resizing its viewport rather than just the content, see the drawSvgToRect method. ##### Parameters ###### svgDocument [`SvgDocument`](SvgDocument) The [SvgDocument](SvgDocument) to draw. ###### contentX `number` The X coordinate of the target rectangle for SVG content. ###### contentY `number` The Y coordinate of the target rectangle for SVG content. ###### contentWidth `number` The width of the target rectangle for SVG content. ###### contentHeight `number` The height of the target rectangle for SVG content. ###### opacity? `number` The opacity factor to be applied to SVG content, between 0.0 (fully transparent) and 1.0 (fully opaque). The default is 1.0. ##### Returns `void` ##### Inherited from [`DrawingContext`](DrawingContext).[`drawSvgToContentRect`](DrawingContext#drawsvgtocontentrect) #### Call Signature > **drawSvgToContentRect**(`svgDocument`, `contentBounds`, `opacity?`): `void` Draws the content of a specified [SvgDocument](SvgDocument), resizing the content to fit into a specified rectangle. To draw the SVG resizing its viewport rather than just the content, see the drawSvgToRect method. ##### Parameters ###### svgDocument [`SvgDocument`](SvgDocument) The [SvgDocument](SvgDocument) to draw. ###### contentBounds [`Bounds`](../type-aliases/Bounds) The target rectangle for SVG content. ###### opacity? `number` The opacity factor to be applied to SVG content, between 0.0 (fully transparent) and 1.0 (fully opaque). The default is 1.0. ##### Returns `void` ##### Inherited from [`DrawingContext`](DrawingContext).[`drawSvgToContentRect`](DrawingContext#drawsvgtocontentrect) *** ### drawSvgToRect() #### Call Signature > **drawSvgToRect**(`svgDocument`, `x`, `y`, `width`, `height`, `opacity?`): `void` Draws a [SvgDocument](SvgDocument), resizing its viewport to fit into the specified rectangle. To draw just the content of the SVG ignoring viewport position, see the drawSvgToContentRect method. ##### Parameters ###### svgDocument [`SvgDocument`](SvgDocument) The [SvgDocument](SvgDocument) to draw. ###### x `number` The X coordinate of the target rectangle for SVG viewport. ###### y `number` The Y coordinate of the target rectangle for SVG viewport. ###### width `number` The width of the target rectangle for SVG viewport. ###### height `number` The height of the target rectangle for SVG viewport. ###### opacity? `number` The opacity factor to be applied to SVG content, between 0.0 (fully transparent) and 1.0 (fully opaque). The default is 1.0. ##### Returns `void` ##### Inherited from [`DrawingContext`](DrawingContext).[`drawSvgToRect`](DrawingContext#drawsvgtorect) #### Call Signature > **drawSvgToRect**(`svgDocument`, `bounds`, `opacity?`): `void` Draws a [SvgDocument](SvgDocument), resizing its viewport to fit into the specified rectangle. To draw just the content of the SVG ignoring viewport position, see the drawSvgToContentRect method. ##### Parameters ###### svgDocument [`SvgDocument`](SvgDocument) The [SvgDocument](SvgDocument) to draw. ###### bounds [`Bounds`](../type-aliases/Bounds) The target rectangle for SVG viewport. ###### opacity? `number` The opacity factor to be applied to the SVG content, between 0.0 (fully transparent) and 1.0 (fully opaque). The default is 1.0. ##### Returns `void` ##### Inherited from [`DrawingContext`](DrawingContext).[`drawSvgToRect`](DrawingContext#drawsvgtorect) *** ### drawText() #### Call Signature > **drawText**(`text`, `format`, `x`, `y`, `maxWidth?`): `void` Draws text using a specified format at the specified position. ##### Parameters ###### text `string` The text to draw. ###### format [`Format`](Format) The text format to use. ###### x `number` The X coordinate at which to draw the text. ###### y `number` The Y coordinate at which to draw the text. ###### maxWidth? If provided, specifies the maximum width of text. `number` | `null` ##### Returns `void` ##### Inherited from [`DrawingContext`](DrawingContext).[`drawText`](DrawingContext#drawtext) #### Call Signature > **drawText**(`text`, `font`, `fontSize`, `foreColor`, `x`, `y`, `maxWidth?`): `void` Draws text using specified format attributes at a specified location. ##### Parameters ###### text `string` The text to draw. ###### font [`Font`](Font) The font to use. ###### fontSize `number` The font size. ###### foreColor [`Color`](../type-aliases/Color) The text color. ###### x `number` The X coordinate at which to draw the text. ###### y `number` The Y coordinate at which to draw the text. ###### maxWidth? If provided, specifies the maximum width of text. `number` | `null` ##### Returns `void` ##### Inherited from [`DrawingContext`](DrawingContext).[`drawText`](DrawingContext#drawtext) #### Call Signature > **drawText**(`textRun`, `x`, `y`, `maxWidth?`): `void` Draws a text run at the specified position. ##### Parameters ###### textRun [`RunProperties`](../type-aliases/RunProperties) The formatted text section to draw. ###### x `number` The X coordinate at which to draw the text. ###### y `number` The Y coordinate at which to draw the text. ###### maxWidth? If provided, specifies the maximum width of text. `number` | `null` ##### Returns `void` ##### Example ```ts const pericFont = Font.load(await Util.loadFontAsArray("peric.ttf")); const emojiFont = Font.load(await Util.loadFontAsArray("seguiemj.ttf")); const fontColl = new FontCollection(); fontColl.loadFont(await Util.loadFontAsArray("arial.ttf")); const g = new BmpContext(540, 320, 2, "FloralWhite"); g.fontCollection = fontColl; g.drawText("Peric Font", pericFont, 40, "Black", 4, 90); g.drawText({ text: "Arial Font", fontFamily: "Arial", fontSize: 20 }, 300, 110); g.drawText({ text: "Emoji: " + String.fromCodePoint(0x1F433, 0x1F349, 0x1F367), font: emojiFont, fontSize: 40, paletteIndex: 0 }, 4, 140); const res: Uint8Array = g.bitmap.saveAsPng(); ``` ##### Inherited from [`DrawingContext`](DrawingContext).[`drawText`](DrawingContext#drawtext) *** ### free() > **free**(): `void` Detaches the object from the [ObjectManager](ObjectManager) and deallocates its memory, if possible. #### Returns `void` #### Inherited from [`DrawingContext`](DrawingContext).[`free`](DrawingContext#free) *** ### measureText() #### Call Signature > **measureText**(`text`, `format`, `maxWidth?`): [`Size`](../type-aliases/Size) Measures text using a specified [Format](Format). ##### Parameters ###### text `string` The string to measure. ###### format [`Format`](Format) The text format to use. ###### maxWidth? If provided, specifies the maximum width of text. `number` | `null` ##### Returns [`Size`](../type-aliases/Size) The actual size needed to draw the text. ##### Inherited from [`DrawingContext`](DrawingContext).[`measureText`](DrawingContext#measuretext) #### Call Signature > **measureText**(`text`, `font`, `fontSize`, `maxWidth?`): [`Size`](../type-aliases/Size) Measures text using a specified font, font size and layout width. ##### Parameters ###### text `string` The string to measure. ###### font [`Font`](Font) The font to use. ###### fontSize `number` The font size to use. ###### maxWidth? If provided, specifies the maximum width of text. `number` | `null` ##### Returns [`Size`](../type-aliases/Size) The actual size needed to draw the text. ##### Inherited from [`DrawingContext`](DrawingContext).[`measureText`](DrawingContext#measuretext) #### Call Signature > **measureText**(`textRun`, `maxWidth?`): [`Size`](../type-aliases/Size) Measures the size of the given text run. ##### Parameters ###### textRun [`RunProperties`](../type-aliases/RunProperties) The formatted text section to measure. ###### maxWidth? If provided, specifies the maximum width of text. `number` | `null` ##### Returns [`Size`](../type-aliases/Size) The actual size needed to draw the text. ##### Inherited from [`DrawingContext`](DrawingContext).[`measureText`](DrawingContext#measuretext) *** ### popClip() > **popClip**(): `void` Removes the last clip. After this method is called, the last clip is no longer applied to subsequent drawing operations. #### Returns `void` #### Inherited from [`DrawingContext`](DrawingContext).[`popClip`](DrawingContext#popclip) *** ### popGroup() > **popGroup**(): `void` Ends the group that was created by the last [SvgContext#pushGroup](#pushgroup) call. #### Returns `void` *** ### popLayer() > **popLayer**(): `void` Stops redirecting drawing operations to the transparency layer that was created by the last pushLayer call. #### Returns `void` #### Inherited from [`DrawingContext`](DrawingContext).[`popLayer`](DrawingContext#poplayer) *** ### popTransform() > **popTransform**(): `void` Restores the previously pushed transformation from the stack. #### Returns `void` #### Inherited from [`DrawingContext`](DrawingContext).[`popTransform`](DrawingContext#poptransform) *** ### pushClip() #### Call Signature > **pushClip**(`x`, `y`, `width`, `height`): `void` Specifies a rectangle to which all subsequent drawing operations are clipped. ##### Parameters ###### x `number` The X coordinate of the clipping rectangle. ###### y `number` The Y coordinate of the clipping rectangle. ###### width `number` The width of the clipping rectangle. ###### height `number` The height of the clipping rectangle. ##### Returns `void` ##### Inherited from [`DrawingContext`](DrawingContext).[`pushClip`](DrawingContext#pushclip) #### Call Signature > **pushClip**(`bounds`): `void` Specifies a rectangle to which all subsequent drawing operations are clipped. ##### Parameters ###### bounds [`Bounds`](../type-aliases/Bounds) The clipping rectangle. ##### Returns `void` ##### Inherited from [`DrawingContext`](DrawingContext).[`pushClip`](DrawingContext#pushclip) #### Call Signature > **pushClip**(`path`): `void` Specifies a path to which all subsequent drawing operations are clipped. ##### Parameters ###### path [`GraphicsPath`](GraphicsPath) The [GraphicsPath](GraphicsPath) object defining clipping area. ##### Returns `void` ##### Inherited from [`DrawingContext`](DrawingContext).[`pushClip`](DrawingContext#pushclip) *** ### pushGroup() #### Call Signature > **pushGroup**(`attributeName`, `value`, `namespace?`): `void` Starts a group ('g') element with custom attributes in the SVG document. Call the [SvgContext#popGroup](#popgroup) method to end the group. ##### Parameters ###### attributeName `string` The name of the attribute, including the optional prefix. ###### value `string` A string value of the attribute. ###### namespace? `string` The optional namespace of the attribute. ##### Returns `void` #### Call Signature > **pushGroup**(`attributes`): `void` Starts a group ('g') element with custom attributes in the SVG document. Call the [SvgContext#popGroup](#popgroup) method to end the group. ##### Parameters ###### attributes [`SvgAttribute`](../type-aliases/SvgAttribute)[] The list of attributes to be associated with the group. ##### Returns `void` *** ### pushLayer() > **pushLayer**(`opacity`, `contentBounds?`): `void` Adds a transparency layer to the target surface. That layer receives all subsequent drawing operations until popLayer is called. #### Parameters ##### opacity `number` An opacity value that is applied uniformly to all drawings in the layer when compositing to the backplate. The value is between 0.0 and 1.0. ##### contentBounds? The content bounds of the transparency layer. Content won't render outside these bounds. If not set, the content bounds are effectively taken to be the bounds of the target surface. [`Bounds`](../type-aliases/Bounds) | `null` #### Returns `void` #### Inherited from [`DrawingContext`](DrawingContext).[`pushLayer`](DrawingContext#pushlayer) *** ### pushTransform() > **pushTransform**(): `void` Saves the current transformation to the stack. #### Returns `void` #### Inherited from [`DrawingContext`](DrawingContext).[`pushTransform`](DrawingContext#pushtransform) *** ### rebind() > **rebind**(`omTo`): `void` Rebinds the object from the current [ObjectManager](ObjectManager) to the specified one. #### Parameters ##### omTo [`ObjectManager`](ObjectManager) The new [ObjectManager](ObjectManager) for the object. #### Returns `void` #### Inherited from [`DrawingContext`](DrawingContext).[`rebind`](DrawingContext#rebind) *** ### resetTransform() > **resetTransform**(): `void` Resets the transformation to the identity matrix. #### Returns `void` #### Inherited from [`DrawingContext`](DrawingContext).[`resetTransform`](DrawingContext#resettransform) *** ### rotate() > **rotate**(`angle`, `angleUnits?`, `cx?`, `cy?`): `void` Applies the rotation transformation. #### Parameters ##### angle `number` The rotation angle. ##### angleUnits? [`AngleUnits`](../enumerations/AngleUnits) The angle units. The default is Radians. ##### cx? `number` The optional center point X offset. ##### cy? `number` The optional center point Y offset. #### Returns `void` #### Inherited from [`DrawingContext`](DrawingContext).[`rotate`](DrawingContext#rotate) *** ### scale() > **scale**(`scaleFactor`, `cx?`, `cy?`): `void` Applies the scaling transformation. #### Parameters ##### scaleFactor `number` The value to scale by on the X and Y axes. ##### cx? `number` The optional center point X offset. ##### cy? `number` The optional center point Y offset. #### Returns `void` #### Inherited from [`DrawingContext`](DrawingContext).[`scale`](DrawingContext#scale) *** ### scaleXY() > **scaleXY**(`scaleX`, `scaleY`, `cx?`, `cy?`): `void` Applies the scaling transformation. #### Parameters ##### scaleX `number` The value to scale by on the X axis. ##### scaleY `number` The value to scale by on the Y axis. ##### cx? `number` The optional center point X offset. ##### cy? `number` The optional center point Y offset. #### Returns `void` #### Inherited from [`DrawingContext`](DrawingContext).[`scaleXY`](DrawingContext#scalexy) *** ### skew() > **skew**(`angleX`, `angleY`, `angleUnits?`, `cx?`, `cy?`): `void` Applies the skew transformation. #### Parameters ##### angleX `number` The X angle. ##### angleY `number` The Y angle. ##### angleUnits? [`AngleUnits`](../enumerations/AngleUnits) The angle units. The default is Radians. ##### cx? `number` The optional center point X offset. ##### cy? `number` The optional center point Y offset. #### Returns `void` #### Inherited from [`DrawingContext`](DrawingContext).[`skew`](DrawingContext#skew) *** ### skewX() > **skewX**(`angle`, `angleUnits?`): `void` Applies the skew transformation along the X axis. #### Parameters ##### angle `number` The X angle. ##### angleUnits? [`AngleUnits`](../enumerations/AngleUnits) The angle units. The default is Radians. #### Returns `void` #### Inherited from [`DrawingContext`](DrawingContext).[`skewX`](DrawingContext#skewx) *** ### skewY() > **skewY**(`angle`, `angleUnits?`): `void` Applies the skew transformation along the Y axis. #### Parameters ##### angle `number` The Y angle. ##### angleUnits? [`AngleUnits`](../enumerations/AngleUnits) The angle units. The default is Radians. #### Returns `void` #### Inherited from [`DrawingContext`](DrawingContext).[`skewY`](DrawingContext#skewy) *** ### toSvgDocument() > **toSvgDocument**(): [`SvgDocument`](SvgDocument) Generates a [SvgDocument](SvgDocument) from this context, and clears the context's command list afterwards. #### Returns [`SvgDocument`](SvgDocument) The resulting [SvgDocument](SvgDocument). *** ### translate() > **translate**(`offsetX`, `offsetY`): `void` Applies the translation transformation. #### Parameters ##### offsetX `number` The horizontal offset. ##### offsetY `number` The vertical offset. #### Returns `void` #### Inherited from [`DrawingContext`](DrawingContext).[`translate`](DrawingContext#translate)