Class Graphics

Package: @aurigma/design-atoms

Methods

clearCanvas(context, preserveTransform)

Declaration

static clearCanvas(context: CanvasRenderingContext2D, preserveTransform?: boolean): void;

Parameters

Type	Name	Description
CanvasRenderingContext2D	context
boolean	preserveTransform

Returns

Type	Description
void

clipPath(ctx, path)

Declaration

static clipPath(ctx: CanvasRenderingContext2D, path: Path): void;

Parameters

Type	Name	Description
CanvasRenderingContext2D	ctx
Path	path

Returns

Type	Description
void

drawCross(ctx, x, y, size, width, baselineColor)

Declaration

static drawCross(ctx: CanvasRenderingContext2D, x: number, y: number, size: number, width: number, baselineColor: string): void;

Parameters

Type	Name	Description
CanvasRenderingContext2D	ctx
number	x
number	y
number	size
number	width
string	baselineColor

Returns

Type	Description
void

drawDashedLine(ctx, x0, y0, x1, y1, lineWidth, color, altColor, dashWidth, altDashWidth, opacity)

Declaration

static drawDashedLine(ctx: CanvasRenderingContext2D, x0: number, y0: number, x1: number, y1: number, lineWidth: number, color: string, altColor: string, dashWidth: number, altDashWidth: number, opacity?: number): void;

Parameters

Type	Name	Description
CanvasRenderingContext2D	ctx
number	x0
number	y0
number	x1
number	y1
number	lineWidth
string	color
string	altColor
number	dashWidth
number	altDashWidth
number	opacity

Returns

Type	Description
void

drawImage(ctx, image, rotatedRectangle, scaleX, scaleY, disableSmoothing, maskColor, opacity, imageRect, increaseImageRect)

Declaration

static drawImage(ctx: CanvasRenderingContext2D, image: HTMLImageElement | HTMLCanvasElement, rotatedRectangle: RotatedRectangleF, scaleX: number, scaleY: number, disableSmoothing?: boolean, maskColor?: any, opacity?: number, imageRect?: RectangleF, increaseImageRect?: number): void;

Parameters

Type	Name	Description
CanvasRenderingContext2D	ctx
HTMLImageElement | HTMLCanvasElement	image
RotatedRectangleF	rotatedRectangle
number	scaleX
number	scaleY
boolean	disableSmoothing
any	maskColor
number	opacity
RectangleF	imageRect
number	increaseImageRect

Returns

Type	Description
void

drawLine(ctx, x, y, x1, y1, lineWidth, lineColor, opacity, dashWidth)

Declaration

static drawLine(ctx: CanvasRenderingContext2D, x: number, y: number, x1: number, y1: number, lineWidth: number, lineColor: string, opacity?: number, dashWidth?: number[]): void;

Parameters

Type	Name	Description
CanvasRenderingContext2D	ctx
number	x
number	y
number	x1
number	y1
number	lineWidth
string	lineColor
number	opacity
number[]	dashWidth

Returns

Type	Description
void

drawPath(ctx, path, center, transform, borderWidth, borderColor, opacity, dashWidth, altBorderColor)

Declaration

static drawPath(ctx: CanvasRenderingContext2D, path: any, center: PointF, transform: Transform, borderWidth: number, borderColor: string, opacity: number, dashWidth?: number[], altBorderColor?: string): void;

Parameters

Type	Name	Description
CanvasRenderingContext2D	ctx
any	path
PointF	center
Transform	transform
number	borderWidth
string	borderColor
number	opacity
number[]	dashWidth
string	altBorderColor

Returns

Type	Description
void

drawPolyline(ctx, points, lineWidth, lineColor, opacity)

Declaration

static drawPolyline(ctx: CanvasRenderingContext2D, points: PointF[], lineWidth: number, lineColor: string, opacity: number): void;

Parameters

Type	Name	Description
CanvasRenderingContext2D	ctx
PointF[]	points
number	lineWidth
string	lineColor
number	opacity

Returns

Type	Description
void

drawRectangle(ctx, rotatedRectangle, borderWidth, borderColor, opacity)

Declaration

static drawRectangle(ctx: CanvasRenderingContext2D, rotatedRectangle: RotatedRectangleF, borderWidth: number, borderColor: string, opacity: number): void;

Parameters

Type	Name	Description
CanvasRenderingContext2D	ctx
RotatedRectangleF	rotatedRectangle
number	borderWidth
string	borderColor
number	opacity

Returns

Type	Description
void

drawRoundedRectangle(ctx, rect, rounded)

Declaration

static drawRoundedRectangle(ctx: CanvasRenderingContext2D, rect: RectangleF, rounded: number): void;

Parameters

Type	Name	Description
CanvasRenderingContext2D	ctx
RectangleF	rect
number	rounded

Returns

Type	Description
void

drawStroke(ctx, path, center, transform, borderWidth, borderColor, altBorderColor, opacity, dash)

Declaration

static drawStroke(ctx: CanvasRenderingContext2D, path: any, center: PointF, transform: Transform, borderWidth: number, borderColor: string, altBorderColor: string, opacity: number, dash: number[]): void;

Parameters

Type	Name	Description
CanvasRenderingContext2D	ctx
any	path
PointF	center
Transform	transform
number	borderWidth
string	borderColor
string	altBorderColor
number	opacity
number[]	dash

Returns

Type	Description
void

fillPath(ctx, path, center, transform, fillColor, opacity)

Declaration

static fillPath(ctx: CanvasRenderingContext2D, path: any, center: PointF, transform: Transform, fillColor: string, opacity?: number): void;

Parameters

Type	Name	Description
CanvasRenderingContext2D	ctx
any	path
PointF	center
Transform	transform
string	fillColor
number	opacity

Returns

Type	Description
void

fillRectangle(ctx, rotatedRectangle, fillColor, opacity)

Declaration

static fillRectangle(ctx: CanvasRenderingContext2D, rotatedRectangle: RotatedRectangleF, fillColor: any, opacity?: number): void;

Parameters

Type	Name	Description
CanvasRenderingContext2D	ctx
RotatedRectangleF	rotatedRectangle
any	fillColor
number	opacity

Returns

Type	Description
void

isFullTransparentColor(color)

Declaration

static isFullTransparentColor(color: any): boolean;

Parameters

Type	Name	Description
any	color

Returns

Type	Description
boolean

measureText(ctx, text, point, font, fillColor, strokeColor, angle)

Declaration

static measureText(ctx: CanvasRenderingContext2D, text: string, point: PointF, font: string, fillColor?: string, strokeColor?: string, angle?: number): TextMetrics;

Parameters

Type	Name	Description
CanvasRenderingContext2D	ctx
string	text
PointF	point
string	font
string	fillColor
string	strokeColor
number	angle

Returns

Type	Description
TextMetrics

path(ctx, path, center, transform, fillColor, borderWidth, borderColor, opacity, dashWidth, altBorderColor)

Declaration

static path(ctx: CanvasRenderingContext2D, path: any, center: PointF, transform: Transform, fillColor: string, borderWidth: number, borderColor: string, opacity: number, dashWidth: number[], altBorderColor?: string): void;

Parameters

Type	Name	Description
CanvasRenderingContext2D	ctx
any	path
PointF	center
Transform	transform
string	fillColor
number	borderWidth
string	borderColor
number	opacity
number[]	dashWidth
string	altBorderColor

Returns

Type	Description
void

rectangle(ctx, rotatedRectangle, borderWidth, borderColor, fillColor, opacity, strokeDash)

Declaration

static rectangle(ctx: CanvasRenderingContext2D, rotatedRectangle: RotatedRectangleF, borderWidth: number, borderColor: string, fillColor?: any, opacity?: number, strokeDash?: number[]): void;

Parameters

Type	Name	Description
CanvasRenderingContext2D	ctx
RotatedRectangleF	rotatedRectangle
number	borderWidth
string	borderColor
any	fillColor
number	opacity
number[]	strokeDash

Returns

Type	Description
void

text(ctx, text, point, font, fillColor, strokeColor, angle, maxWidth, textAlign, textBaseline, background, border, borderWidth, backgroundMargin, backgroundCornerRadius)

Declaration

static text(ctx: CanvasRenderingContext2D, text: string, point: PointF, font: string, fillColor?: string, strokeColor?: string, angle?: number, maxWidth?: any, textAlign?: CanvasTextAlign, textBaseline?: CanvasTextBaseline, background?: string, border?: string, borderWidth?: number, backgroundMargin?: Margin, backgroundCornerRadius?: number): void;

Parameters

Type	Name	Description
CanvasRenderingContext2D	ctx
string	text
PointF	point
string	font
string	fillColor
string	strokeColor
number	angle
any	maxWidth
CanvasTextAlign	textAlign
CanvasTextBaseline	textBaseline
string	background
string	border
number	borderWidth
Margin	backgroundMargin
number	backgroundCornerRadius

Returns

Type	Description
void