Class SVGRenderer

Renders onto an SVGElement.

See

Editor.toSVG

Hierarchy (View Summary)

AbstractRenderer
- SVGRenderer

Constructors

constructor

new SVGRenderer(
    elem: SVGSVGElement,
    viewport: Viewport,
    sanitize?: boolean,
): SVGRenderer
Creates a renderer that renders onto elem. If sanitize, don't render potentially untrusted data.

viewport is used to determine the translation/rotation/scaling/output size of the rendered data.
Parameters
- elem: SVGSVGElement
- viewport: Viewport
- sanitize: boolean = false
Returns SVGRenderer
Overrides AbstractRenderer.constructor
- Defined in js-draw/src/rendering/renderers/SVGRenderer.ts:63

Properties

`Protected`objectLevel

objectLevel: number = 0

Methods

`Protected`beginPath

beginPath(_startPoint: Vec3): void
Parameters
- _startPoint: Vec3
Returns void
Overrides AbstractRenderer.beginPath
- Defined in js-draw/src/rendering/renderers/SVGRenderer.ts:406

canRenderFromWithoutDataLoss

canRenderFromWithoutDataLoss(_other: AbstractRenderer): boolean
Returns true iff other can be rendered onto this without data loss.
Parameters
- _other: AbstractRenderer
Returns boolean
Inherited from AbstractRenderer.canRenderFromWithoutDataLoss
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:216

canvasToScreen

canvasToScreen(vec: Vec3): Vec3
Parameters
- vec: Vec3
Returns Vec3
Inherited from AbstractRenderer.canvasToScreen
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:259

clear

clear(): void
Returns void
Overrides AbstractRenderer.clear
- Defined in js-draw/src/rendering/renderers/SVGRenderer.ts:119

displaySize

displaySize(): Vec3
Returns the size of the rendered region of this on the display (in pixels).

Returns Vec3
Overrides AbstractRenderer.displaySize
- Defined in js-draw/src/rendering/renderers/SVGRenderer.ts:115

drawImage

drawImage(image: RenderableImage): void
Parameters
- image: RenderableImage
Returns void
Overrides AbstractRenderer.drawImage
- Defined in js-draw/src/rendering/renderers/SVGRenderer.ts:273

drawPath

drawPath(pathSpec: RenderablePathSpec): void
Draws a styled path. If within an object started by startObject, the resultant path may not be visible until endObject is called.
Parameters
- pathSpec: RenderablePathSpec
Returns void
Overrides AbstractRenderer.drawPath
- Defined in js-draw/src/rendering/renderers/SVGRenderer.ts:169

drawPoints

drawPoints(...points: Vec3[]): void
Draw a representation of [points]. Intended for debugging.
Parameters
- ...points: Vec3[]
Returns void
Overrides AbstractRenderer.drawPoints
- Defined in js-draw/src/rendering/renderers/SVGRenderer.ts:429

drawRect

drawRect(rect: Rect2, lineWidth: number, lineFill: RenderingStyle): void
Strokes a rectangle. Boundary lines have width [lineWidth] and are filled with [lineFill]. This is equivalent to drawPath(Path.fromRect(...).toRenderable(...)).
Parameters
- rect: Rect2
- lineWidth: number
- lineFill: RenderingStyle
Returns void
Inherited from AbstractRenderer.drawRect
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:158

drawSVGElem

drawSVGElem(elem: SVGElement): void
Adds a copy of the given element directly to the container SVG element, without applying transforms.

If sanitize is enabled, this does nothing.
Parameters
- elem: SVGElement
Returns void
- Defined in js-draw/src/rendering/renderers/SVGRenderer.ts:445

drawText

drawText(text: string, transform: Mat33, style: TextRenderingStyle): void
Parameters
- text: string
- transform: Mat33
- style: TextRenderingStyle
Returns void
Overrides AbstractRenderer.drawText
- Defined in js-draw/src/rendering/renderers/SVGRenderer.ts:208

drawWithSVGParent

drawWithSVGParent(
    callback: (
        parent: SVGGElement,
        context: DrawWithSVGParentContext,
    ) => void,
): void
Allows rendering directly to the underlying SVG element. Rendered content is added to a <g> element that's passed as parent to callback.

Note: Unlike drawSVGElem, this method can be used even if sanitize is true. In this case, it's the responsibility of callback to ensure that everything added to parent is safe to render.
Parameters
- callback: (parent: SVGGElement, context: DrawWithSVGParentContext) => void
Returns void
- Defined in js-draw/src/rendering/renderers/SVGRenderer.ts:471

endObject

endObject(loaderData?: LoadSaveDataTable, elemClassNames?: string[]): void
Notes the end of an object.
Parameters
- OptionalloaderData: LoadSaveDataTable
  a map from strings to JSON-ifyable objects and contains properties attached to the object by whatever loader loaded the image. This is used to preserve attributes not supported by js-draw when loading/saving an image. Renderers may ignore this.
- OptionalelemClassNames: string[]
  a list of labels (e.g. classNames) to be attached to the object. Renderers may ignore this.
Returns void
Overrides AbstractRenderer.endObject
- Defined in js-draw/src/rendering/renderers/SVGRenderer.ts:301

`Protected`endPath

endPath(_style: RenderingStyle): void
Parameters
- _style: RenderingStyle
Returns void
Overrides AbstractRenderer.endPath
- Defined in js-draw/src/rendering/renderers/SVGRenderer.ts:409

fillRect

fillRect(rect: Rect2, fill: Color4): void
Draws a filled rectangle.
Parameters
- rect: Rect2
- fill: Color4
Returns void
Inherited from AbstractRenderer.fillRect
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:164

getCanvasToScreenTransform

getCanvasToScreenTransform(): Mat33
Get the matrix that transforms a vector on the canvas to a vector on this' rendering target.

Returns Mat33
Inherited from AbstractRenderer.getCanvasToScreenTransform
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:252

getDraftInkPresenter

getDraftInkPresenter(): DraftInkPresenter
Returns an API that can be used to accelerate inking.

Returns DraftInkPresenter
Inherited from AbstractRenderer.getDraftInkPresenter
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:88

`Protected`getNestingLevel

getNestingLevel(): number
Returns number
Inherited from AbstractRenderer.getNestingLevel
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:208

getSizeOfCanvasPixelOnScreen

getSizeOfCanvasPixelOnScreen(): number
Returns number
Inherited from AbstractRenderer.getSizeOfCanvasPixelOnScreen
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:263

`Protected`getViewport

getViewport(): Viewport
this.canvasToScreen, etc. should be used instead of the corresponding methods on Viewport, because the viewport may not accurately reflect what is rendered.

Returns Viewport
Inherited from AbstractRenderer.getViewport
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:61

getVisibleRect

getVisibleRect(): Rect2
Returns the region in canvas space that is visible within the viewport this canvas is rendering to.

Note that in some cases this might not be the same as the visibleRect given to components in their render method.

Returns Rect2
Inherited from AbstractRenderer.getVisibleRect
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:281

isTooSmallToRender

isTooSmallToRender(_rect: Rect2): boolean
Returns true iff the given rectangle is so small, rendering anything within it has no effect on the image.
Parameters
- _rect: Rect2
Returns boolean
Overrides AbstractRenderer.isTooSmallToRender
- Defined in js-draw/src/rendering/renderers/SVGRenderer.ts:481

pushTransform

pushTransform(transform: Mat33): void
Parameters
- transform: Mat33
Returns void
Inherited from AbstractRenderer.pushTransform
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:231

renderFromOtherOfSameType

renderFromOtherOfSameType(_renderTo: Mat33, other: AbstractRenderer): void
MUST throw if other and this are not of the same base class.
Parameters
- _renderTo: Mat33
- other: AbstractRenderer
Returns void
Inherited from AbstractRenderer.renderFromOtherOfSameType
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:221

setDraftMode

setDraftMode(_draftMode: boolean): void
Parameters
- _draftMode: boolean
Returns void
Inherited from AbstractRenderer.setDraftMode
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:83

setRootSVGAttribute

setRootSVGAttribute(name: string, value: null | string): void
Sets an attribute on the root SVG element.
Parameters
- name: string
- value: null | string
Returns void
- Defined in js-draw/src/rendering/renderers/SVGRenderer.ts:98

setTransform

setTransform(transform: null | Mat33): void
Set a transformation to apply to things before rendering, replacing the viewport's transform.
Parameters
- transform: null | Mat33
Returns void
Inherited from AbstractRenderer.setTransform
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:227

startObject

startObject(boundingBox: Rect2): void
This should be called whenever a new object is being drawn.
Parameters
- boundingBox: Rect2
  The bounding box of the object to be drawn.
Returns void
Overrides AbstractRenderer.startObject
- Defined in js-draw/src/rendering/renderers/SVGRenderer.ts:290

`Protected`traceCubicBezierCurve

traceCubicBezierCurve(
    _controlPoint1: Vec3,
    _controlPoint2: Vec3,
    _endPoint: Vec3,
): void
Parameters
- _controlPoint1: Vec3
- _controlPoint2: Vec3
- _endPoint: Vec3
Returns void
Overrides AbstractRenderer.traceCubicBezierCurve
- Defined in js-draw/src/rendering/renderers/SVGRenderer.ts:418

`Protected`traceQuadraticBezierCurve

traceQuadraticBezierCurve(_controlPoint: Vec3, _endPoint: Vec3): void
Parameters
- _controlPoint: Vec3
- _endPoint: Vec3
Returns void
Overrides AbstractRenderer.traceQuadraticBezierCurve
- Defined in js-draw/src/rendering/renderers/SVGRenderer.ts:425

`Static`fromViewport

fromViewport(
viewport: Viewport,
options?: boolean | FromViewportOptions,
): { element: SVGSVGElement; renderer: SVGRenderer }
Creates a new SVG element and SVGRenerer with width, height, viewBox, and other metadata attributes set for the given Viewport.

If options is a boolean, it is interpreted as whether to sanitize (not add unknown SVG entities to) the output.
Parameters
- viewport: Viewport
- options: boolean | FromViewportOptions = true
Returns { element: SVGSVGElement; renderer: SVGRenderer }
- Defined in js-draw/src/rendering/renderers/SVGRenderer.ts:492

Class SVGRenderer

See

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SVGRenderer

Properties

ProtectedobjectLevel

Methods

ProtectedbeginPath

Parameters

Returns void

canRenderFromWithoutDataLoss

Parameters

Returns boolean

canvasToScreen

Parameters

Returns Vec3

clear

Returns void

displaySize

Returns Vec3

drawImage

Parameters

Returns void

drawPath

Parameters

Returns void

drawPoints

Parameters

Returns void

drawRect

Parameters

Returns void

drawSVGElem

Parameters

Returns void

drawText

Parameters

Returns void

drawWithSVGParent

Parameters

Returns void

endObject

Parameters

Returns void

ProtectedendPath

Parameters

Returns void

fillRect

Parameters

Returns void

getCanvasToScreenTransform

Returns Mat33

getDraftInkPresenter

Returns DraftInkPresenter

ProtectedgetNestingLevel

Returns number

getSizeOfCanvasPixelOnScreen

Returns number

ProtectedgetViewport

Returns Viewport

getVisibleRect

Returns Rect2

isTooSmallToRender

Parameters

Returns boolean

ProtectedlineTo

Parameters

Returns void

ProtectedmoveTo

Parameters

Returns void

popTransform

Returns void

`Protected`objectLevel

`Protected`beginPath

`Protected`endPath

`Protected`getNestingLevel

`Protected`getViewport

`Protected`lineTo

`Protected`moveTo

`Protected`traceCubicBezierCurve

`Protected`traceQuadraticBezierCurve

`Static`fromViewport