CanvasRenderer

Classes

CanvasRenderer

Implements

• ICanvasRenderer

Constructors

Constructor

new CanvasRenderer(
   selection, 
   dndHandler, 
   handlerConfiguration, 
   rubberbandHandler, 
   viewportHandler, 
   spotlightHandler, 
   hoverHandler, 
   snapLinesHandler, 
   canvasElementHandler, 
   interactiveZonesHandler, 
   isPreviewRenderer?): CanvasRenderer;

Parameters

Parameter	Type	Default value
selection	ISelectionHandler	undefined
dndHandler	IDragNDropHandler	undefined
handlerConfiguration	IHandlersConfiguration	undefined
rubberbandHandler	RubberbandHandler	undefined
viewportHandler	IViewportHandler	undefined
spotlightHandler	SpotlightHandler	undefined
hoverHandler	IHoverHandler	undefined
snapLinesHandler	ISnapLinesHandler	undefined
canvasElementHandler	ICanvasElementHandler	undefined
interactiveZonesHandler	IInteractiveZonesHandler	undefined
isPreviewRenderer	boolean	false

Returns

CanvasRenderer

Properties

getVariableDisplayName

getVariableDisplayName: (item) => string = null;

Parameters

Parameter	Type
item	any

Returns

string

previewMode

previewMode: boolean = false;

style

style: CanvasRendererStyle;

Accessors

conf

Set Signature

set conf(conf): void;

Parameters

Parameter	Type
conf	IHandlersConfiguration

Returns

void

textRenderer

Set Signature

set textRenderer(value): void;

Parameters

Parameter	Type
value	TextRenderer

Returns

void

violationSrc

Get Signature

get violationSrc(): ViolationService;

Returns

ViolationService

Set Signature

set violationSrc(service): void;

Parameters

Parameter	Type
service	ViolationService

Returns

void

Methods

applyContextScale()

applyContextScale(
   renderingContext, 
   workspace, 
   offset, 
   clipByWorkspace?, 
   dpi?): CanvasRenderingContext2D;

Parameters

Parameter	Type	Default value
renderingContext	CanvasRenderingContext2D	undefined
workspace	IWorkspace	undefined
offset	PointF	undefined
clipByWorkspace	boolean	true
dpi?	number	undefined

Returns

CanvasRenderingContext2D

Implementation of

ICanvasRenderer.applyContextScale

clearTextCursor()

clearTextCursor(canvas): void;

Parameters

Parameter	Type
canvas	HTMLCanvasElement

Returns

void

drawRubberband()

drawRubberband(
   context, 
   rubberband, 
   offset): void;

Parameters

Parameter	Type
context	CanvasRenderingContext2D
rubberband	Rubberband
offset	PointF

Returns

void

drawTextCursor()

drawTextCursor(
   canvas, 
   itemHandler, 
   callback, 
   workspace, 
   mul, 
   offset): void;

Parameters

Parameter	Type
canvas	HTMLCanvasElement
itemHandler	BaseRectangleItemHandler
callback	(context) => void
workspace	IWorkspace
mul	number
offset	PointF

Returns

void

drawWaitClock()

drawWaitClock(
   context, 
   center, 
   mul): void;

Parameters

Parameter	Type
context	CanvasRenderingContext2D
center	PointF
mul	number

Returns

void

Implementation of

ICanvasRenderer.drawWaitClock

redrawActiveCanvas()

redrawActiveCanvas(
   layers, 
   activeCanvas, 
   workspace, 
   productHandler, 
   offset): void;

Parameters

Parameter	Type
layers	Layer[]
activeCanvas	HTMLCanvasElement
workspace	IWorkspace
productHandler	IProductHandler
offset	PointF

Returns

void

redrawActiveTextCanvas()

redrawActiveTextCanvas(context, layers): void;

Parameters

Parameter	Type
context	ITextEditorContext
layers	Layer[]

Returns

void

redrawInactiveCanvas()

redrawInactiveCanvas(
   layers, 
   surfaceCanvas, 
   inactiveCanvas, 
   workspace, 
   margins, 
   mul, 
   productHandler, 
   offset, 
   mockupMarginWorkaroundEnabled?, 
   canvasBackground?, 
   dpi?): void;

Parameters

Parameter	Type
layers	Layer[]
surfaceCanvas	HTMLCanvasElement
inactiveCanvas	HTMLCanvasElement
workspace	IWorkspace
margins	IMargins
mul	number
productHandler	IProductHandler
offset	PointF
mockupMarginWorkaroundEnabled?	boolean
canvasBackground?	string
dpi?	number

Returns

void

Implementation of

ICanvasRenderer.redrawInactiveCanvas

redrawSelectionCanvas()

redrawSelectionCanvas(
   designCanvas, 
   workspace, 
   style, 
   textContext, 
   viewer, 
   contentAngle, 
   offset, 
   layers, 
   messages, 
   drawShadow?, 
   drawSnapLines?): void;

Parameters

Parameter	Type
designCanvas	HTMLCanvasElement
workspace	IWorkspace
style	CanvasRendererStyle
textContext	ITextLimitsContext & ITextEditorContext & ITranslationsContext
viewer	IViewportContext & IWorkspaceContext & IRulersContext
contentAngle	number
offset	PointF
layers	Layer[]
messages	IViewerMessagesConfig
drawShadow?	boolean
drawSnapLines?	boolean

Returns

void

setLoadingImageUrl()

setLoadingImageUrl(url): void;

Parameters

Parameter	Type
url	string

Returns

void

setTextWhizzModule()

setTextWhizzModule(textWhizz): void;

Parameters

Parameter	Type
textWhizz	any

Returns

void

Interfaces

ICanvasElementHandler

Properties

viewportMemoryCanvas

viewportMemoryCanvas: HTMLCanvasElement;

viewportTextureCanvas

viewportTextureCanvas: HTMLCanvasElement;

---

IDragNDropHandler

Methods

draw()

draw(): void;

Returns

void

---

IRulersContext

Properties

actualRulerWidth

actualRulerWidth: number;

---

ITextEditorContext

Properties

textEditor

textEditor: ITextEditor;

---

ITextLimitsContext

Properties

errorInput

errorInput: boolean;

lastLimitsEvent

lastLimitsEvent: ILimitsViolationEventData;

---

ITranslationsContext

Properties

translations

translations: Translations;