@univerjs/engine-render v0.1.17 • Docs

Class: UniverPrintingContext

Extends

UniverRenderingContext2D

Constructors

new UniverPrintingContext()

new UniverPrintingContext(context): UniverPrintingContext

Parameters

Parameter	Type
`context`	`CanvasRenderingContext2D`

Properties

Property	Modifier	Type	Default value	Description	Overrides	Inherited from	Defined in
`__mode`	`public`	`string`	`'printing'`	-	`UniverRenderingContext2D`.`__mode`	-	submodules/univer/packages/engine-render/src/context.ts:973 (opens in a new tab)
`_context`	`public`	`CanvasRenderingContext2D`	`undefined`	-	-	`UniverRenderingContext2D`.`_context`	submodules/univer/packages/engine-render/src/context.ts:25 (opens in a new tab)
`canvas`	`readonly`	`HTMLCanvasElement`	`undefined`	MDN Reference (opens in a new tab)	-	`UniverRenderingContext2D`.`canvas`	submodules/univer/packages/engine-render/src/context.ts:23 (opens in a new tab)

Accessors

direction

get direction(): CanvasDirection

MDN Reference (opens in a new tab)

set direction(val): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`val`	`CanvasDirection`

Returns

CanvasDirection

Inherited from

UniverRenderingContext2D.direction

Defined in

submodules/univer/packages/engine-render/src/context.ts:183 (opens in a new tab)

fillStyle

get fillStyle(): string | CanvasGradient | CanvasPattern

MDN Reference (opens in a new tab)

set fillStyle(val): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`val`	`string` \| `CanvasGradient` \| `CanvasPattern`

Returns

string | CanvasGradient | CanvasPattern

Inherited from

UniverRenderingContext2D.fillStyle

Defined in

submodules/univer/packages/engine-render/src/context.ts:51 (opens in a new tab)

filter

get filter(): string

MDN Reference (opens in a new tab)

set filter(val): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`val`	`string`

Returns

string

Inherited from

UniverRenderingContext2D.filter

Defined in

submodules/univer/packages/engine-render/src/context.ts:69 (opens in a new tab)

font

get font(): string

MDN Reference (opens in a new tab)

set font(val): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`val`	`string`

Returns

string

Inherited from

UniverRenderingContext2D.font

Defined in

submodules/univer/packages/engine-render/src/context.ts:192 (opens in a new tab)

fontKerning

get fontKerning(): CanvasFontKerning

MDN Reference (opens in a new tab)

set fontKerning(val): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`val`	`CanvasFontKerning`

Returns

CanvasFontKerning

Inherited from

UniverRenderingContext2D.fontKerning

Defined in

submodules/univer/packages/engine-render/src/context.ts:201 (opens in a new tab)

fontStretch

get fontStretch(): CanvasFontStretch

MDN Reference (opens in a new tab)

set fontStretch(val): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`val`	`CanvasFontStretch`

Returns

CanvasFontStretch

Inherited from

UniverRenderingContext2D.fontStretch

Defined in

submodules/univer/packages/engine-render/src/context.ts:210 (opens in a new tab)

fontVariantCaps

get fontVariantCaps(): CanvasFontVariantCaps

MDN Reference (opens in a new tab)

set fontVariantCaps(val): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`val`	`CanvasFontVariantCaps`

Returns

CanvasFontVariantCaps

Inherited from

UniverRenderingContext2D.fontVariantCaps

Defined in

submodules/univer/packages/engine-render/src/context.ts:221 (opens in a new tab)

globalAlpha

get globalAlpha(): number

MDN Reference (opens in a new tab)

set globalAlpha(val): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`val`	`number`

Returns

number

Inherited from

UniverRenderingContext2D.globalAlpha

Defined in

submodules/univer/packages/engine-render/src/context.ts:33 (opens in a new tab)

globalCompositeOperation

get globalCompositeOperation(): GlobalCompositeOperation

MDN Reference (opens in a new tab)

set globalCompositeOperation(val): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`val`	`GlobalCompositeOperation`

Returns

GlobalCompositeOperation

Inherited from

UniverRenderingContext2D.globalCompositeOperation

Defined in

submodules/univer/packages/engine-render/src/context.ts:42 (opens in a new tab)

imageSmoothingEnabled

get imageSmoothingEnabled(): boolean

MDN Reference (opens in a new tab)

set imageSmoothingEnabled(val): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`val`	`boolean`

Returns

boolean

Inherited from

UniverRenderingContext2D.imageSmoothingEnabled

Defined in

submodules/univer/packages/engine-render/src/context.ts:78 (opens in a new tab)

imageSmoothingQuality

get imageSmoothingQuality(): ImageSmoothingQuality

MDN Reference (opens in a new tab)

set imageSmoothingQuality(val): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`val`	`ImageSmoothingQuality`

Returns

ImageSmoothingQuality

Inherited from

UniverRenderingContext2D.imageSmoothingQuality

Defined in

submodules/univer/packages/engine-render/src/context.ts:87 (opens in a new tab)

letterSpacing

get letterSpacing(): string

MDN Reference (opens in a new tab)

set letterSpacing(val): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`val`	`string`

Returns

string

Inherited from

UniverRenderingContext2D.letterSpacing

Defined in

submodules/univer/packages/engine-render/src/context.ts:232 (opens in a new tab)

lineCap

get lineCap(): CanvasLineCap

MDN Reference (opens in a new tab)

set lineCap(val): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`val`	`CanvasLineCap`

Returns

CanvasLineCap

Inherited from

UniverRenderingContext2D.lineCap

Defined in

submodules/univer/packages/engine-render/src/context.ts:96 (opens in a new tab)

lineDashOffset

get lineDashOffset(): number

MDN Reference (opens in a new tab)

set lineDashOffset(val): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`val`	`number`

Returns

number

Inherited from

UniverRenderingContext2D.lineDashOffset

Defined in

submodules/univer/packages/engine-render/src/context.ts:105 (opens in a new tab)

lineJoin

get lineJoin(): CanvasLineJoin

MDN Reference (opens in a new tab)

set lineJoin(val): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`val`	`CanvasLineJoin`

Returns

CanvasLineJoin

Inherited from

UniverRenderingContext2D.lineJoin

Defined in

submodules/univer/packages/engine-render/src/context.ts:114 (opens in a new tab)

lineWidth

get lineWidth(): number

MDN Reference (opens in a new tab)

set lineWidth(val): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`val`	`number`

Returns

number

Inherited from

UniverRenderingContext2D.lineWidth

Defined in

submodules/univer/packages/engine-render/src/context.ts:123 (opens in a new tab)

miterLimit

get miterLimit(): number

MDN Reference (opens in a new tab)

set miterLimit(val): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`val`	`number`

Returns

number

Inherited from

UniverRenderingContext2D.miterLimit

Defined in

submodules/univer/packages/engine-render/src/context.ts:138 (opens in a new tab)

shadowBlur

get shadowBlur(): number

MDN Reference (opens in a new tab)

set shadowBlur(val): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`val`	`number`

Returns

number

Inherited from

UniverRenderingContext2D.shadowBlur

Defined in

submodules/univer/packages/engine-render/src/context.ts:147 (opens in a new tab)

shadowColor

get shadowColor(): string

MDN Reference (opens in a new tab)

set shadowColor(val): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`val`	`string`

Returns

string

Inherited from

UniverRenderingContext2D.shadowColor

Defined in

submodules/univer/packages/engine-render/src/context.ts:156 (opens in a new tab)

shadowOffsetX

get shadowOffsetX(): number

MDN Reference (opens in a new tab)

set shadowOffsetX(val): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`val`	`number`

Returns

number

Inherited from

UniverRenderingContext2D.shadowOffsetX

Defined in

submodules/univer/packages/engine-render/src/context.ts:165 (opens in a new tab)

shadowOffsetY

get shadowOffsetY(): number

MDN Reference (opens in a new tab)

set shadowOffsetY(val): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`val`	`number`

Returns

number

Inherited from

UniverRenderingContext2D.shadowOffsetY

Defined in

submodules/univer/packages/engine-render/src/context.ts:174 (opens in a new tab)

strokeStyle

get strokeStyle(): string | CanvasGradient | CanvasPattern

MDN Reference (opens in a new tab)

set strokeStyle(val): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`val`	`string` \| `CanvasGradient` \| `CanvasPattern`

Returns

string | CanvasGradient | CanvasPattern

Inherited from

UniverRenderingContext2D.strokeStyle

Defined in

submodules/univer/packages/engine-render/src/context.ts:60 (opens in a new tab)

textAlign

get textAlign(): CanvasTextAlign

MDN Reference (opens in a new tab)

set textAlign(val): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`val`	`CanvasTextAlign`

Returns

CanvasTextAlign

Inherited from

UniverRenderingContext2D.textAlign

Defined in

submodules/univer/packages/engine-render/src/context.ts:265 (opens in a new tab)

textBaseline

get textBaseline(): CanvasTextBaseline

MDN Reference (opens in a new tab)

set textBaseline(val): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`val`	`CanvasTextBaseline`

Returns

CanvasTextBaseline

Inherited from

UniverRenderingContext2D.textBaseline

Defined in

submodules/univer/packages/engine-render/src/context.ts:274 (opens in a new tab)

textRendering

get textRendering(): CanvasTextRendering

MDN Reference (opens in a new tab)

set textRendering(val): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`val`	`CanvasTextRendering`

Returns

CanvasTextRendering

Inherited from

UniverRenderingContext2D.textRendering

Defined in

submodules/univer/packages/engine-render/src/context.ts:243 (opens in a new tab)

wordSpacing

get wordSpacing(): string

MDN Reference (opens in a new tab)

set wordSpacing(val): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`val`	`string`

Returns

string

Inherited from

UniverRenderingContext2D.wordSpacing

Defined in

submodules/univer/packages/engine-render/src/context.ts:254 (opens in a new tab)

Methods

arc()

arc(
   x, 
   y, 
   radius, 
   startAngle, 
   endAngle, 
   counterClockwise?): void

arc function.

Parameters

Parameter	Type
`x`	`number`
`y`	`number`
`radius`	`number`
`startAngle`	`number`
`endAngle`	`number`
`counterClockwise`?	`boolean`

Returns

void

Inherited from

UniverRenderingContext2D.arc

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:365 (opens in a new tab)

arcByPrecision()

arcByPrecision(
   x, 
   y, 
   radius, 
   startAngle, 
   endAngle, 
   counterClockwise?): void

arc function.

Parameters

Parameter	Type
`x`	`number`
`y`	`number`
`radius`	`number`
`startAngle`	`number`
`endAngle`	`number`
`counterClockwise`?	`boolean`

Returns

void

Inherited from

UniverRenderingContext2D.arcByPrecision

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:373 (opens in a new tab)

arcTo()

arcTo(
   x1, 
   y1, 
   x2, 
   y2, 
   radius): void

arcTo function.

Parameters

Parameter	Type
`x1`	`number`
`y1`	`number`
`x2`	`number`
`y2`	`number`
`radius`	`number`

Returns

void

Inherited from

UniverRenderingContext2D.arcTo

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:386 (opens in a new tab)

arcToByPrecision()

arcToByPrecision(
   x1, 
   y1, 
   x2, 
   y2, 
   radius): void

arcTo function.

Parameters

Parameter	Type
`x1`	`number`
`y1`	`number`
`x2`	`number`
`y2`	`number`
`radius`	`number`

Returns

void

Inherited from

UniverRenderingContext2D.arcToByPrecision

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:395 (opens in a new tab)

beginPath()

beginPath(): void

beginPath function.

Returns

void

Inherited from

UniverRenderingContext2D.beginPath

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:409 (opens in a new tab)

bezierCurveTo()

bezierCurveTo(
   cp1x, 
   cp1y, 
   cp2x, 
   cp2y, 
   x, 
   y): void

bezierCurveTo function.

Parameters

Parameter	Type
`cp1x`	`number`
`cp1y`	`number`
`cp2x`	`number`
`cp2y`	`number`
`x`	`number`
`y`	`number`

Returns

void

Inherited from

UniverRenderingContext2D.bezierCurveTo

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:417 (opens in a new tab)

bezierCurveToByPrecision()

bezierCurveToByPrecision(
   cp1x, 
   cp1y, 
   cp2x, 
   cp2y, 
   x, 
   y): void

bezierCurveTo function precision.

Parameters

Parameter	Type
`cp1x`	`number`
`cp1y`	`number`
`cp2x`	`number`
`cp2y`	`number`
`x`	`number`
`y`	`number`

Returns

void

Inherited from

UniverRenderingContext2D.bezierCurveToByPrecision

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:425 (opens in a new tab)

clearRect()

clearRect(
   x, 
   y, 
   width, 
   height): void

clearRect function.

Parameters

Parameter	Type
`x`	`number`
`y`	`number`
`width`	`number`
`height`	`number`

Returns

void

Overrides

UniverRenderingContext2D.clearRect

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:983 (opens in a new tab)

clearRectByPrecision()

clearRectByPrecision(
   x, 
   y, 
   width, 
   height): void

clearRect function.

Parameters

Parameter	Type
`x`	`number`
`y`	`number`
`width`	`number`
`height`	`number`

Returns

void

Inherited from

UniverRenderingContext2D.clearRectByPrecision

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:449 (opens in a new tab)

clearRectForTexture()

clearRectForTexture(
   x, 
   y, 
   width, 
   height): void

Parameters

Parameter	Type
`x`	`number`
`y`	`number`
`width`	`number`
`height`	`number`

Returns

void

Overrides

UniverRenderingContext2D.clearRectForTexture

Defined in

submodules/univer/packages/engine-render/src/context.ts:996 (opens in a new tab)

clip()

clip(undefined)

clip(): void

clip function.

Returns

void

Inherited from

UniverRenderingContext2D.clip

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:463 (opens in a new tab)

clip(path)

clip(path): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`path`	`Path2D`

Returns

void

Inherited from

UniverRenderingContext2D.clip

Defined in

submodules/univer/packages/engine-render/src/context.ts:465 (opens in a new tab)

clip(fillRule)

clip(fillRule?): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`fillRule`?	`CanvasFillRule`

Returns

void

Inherited from

UniverRenderingContext2D.clip

Defined in

submodules/univer/packages/engine-render/src/context.ts:467 (opens in a new tab)

clip(path, fillRule)

clip(path, fillRule?): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`path`	`Path2D`
`fillRule`?	`CanvasFillRule`

Returns

void

Inherited from

UniverRenderingContext2D.clip

Defined in

submodules/univer/packages/engine-render/src/context.ts:469 (opens in a new tab)

closePath()

closePath(): void

closePath function.

Returns

void

Inherited from

UniverRenderingContext2D.closePath

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:479 (opens in a new tab)

closePathByEnv()

closePathByEnv(): void

Chrome hardware acceleration causes canvas stroke to fail to draw lines on Mac.

Returns

void

Inherited from

UniverRenderingContext2D.closePathByEnv

Defined in

submodules/univer/packages/engine-render/src/context.ts:486 (opens in a new tab)

createConicGradient()

createConicGradient(
   startAngle, 
   x, 
   y): CanvasGradient

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`startAngle`	`number`
`x`	`number`
`y`	`number`

Returns

CanvasGradient

Inherited from

UniverRenderingContext2D.createConicGradient

Defined in

submodules/univer/packages/engine-render/src/context.ts:309 (opens in a new tab)

createImageData()

createImageData(width, height, settings)

createImageData(
   width, 
   height, 
   settings?): ImageData

createImageData function.

Parameters

Parameter	Type
`width`	`number`
`height`	`number`
`settings`?	`ImageDataSettings`

Returns

ImageData

Inherited from

UniverRenderingContext2D.createImageData

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:503 (opens in a new tab)

createImageData(imagedata)

createImageData(imagedata): ImageData

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`imagedata`	`ImageData`

Returns

ImageData

Inherited from

UniverRenderingContext2D.createImageData

Defined in

submodules/univer/packages/engine-render/src/context.ts:505 (opens in a new tab)

createLinearGradient()

createLinearGradient(
   x0, 
   y0, 
   x1, 
   y1): CanvasGradient

createLinearGradient function.

Parameters

Parameter	Type
`x0`	`number`
`y0`	`number`
`x1`	`number`
`y1`	`number`

Returns

CanvasGradient

Inherited from

UniverRenderingContext2D.createLinearGradient

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:524 (opens in a new tab)

createPattern()

createPattern(image, repetition): null | CanvasPattern

createPattern function.

Parameters

Parameter	Type
`image`	`CanvasImageSource`
`repetition`	`null` \| `string`

Returns

null | CanvasPattern

Inherited from

UniverRenderingContext2D.createPattern

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:532 (opens in a new tab)

createRadialGradient()

createRadialGradient(
   x0, 
   y0, 
   r0, 
   x1, 
   y1, 
   r1): CanvasGradient

createRadialGradient function.

Parameters

Parameter	Type
`x0`	`number`
`y0`	`number`
`r0`	`number`
`x1`	`number`
`y1`	`number`
`r1`	`number`

Returns

CanvasGradient

Inherited from

UniverRenderingContext2D.createRadialGradient

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:540 (opens in a new tab)

drawFocusIfNeeded()

drawFocusIfNeeded(element)

drawFocusIfNeeded(element): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`element`	`Element`

Returns

void

Inherited from

UniverRenderingContext2D.drawFocusIfNeeded

Defined in

submodules/univer/packages/engine-render/src/context.ts:347 (opens in a new tab)

drawFocusIfNeeded(path, element)

drawFocusIfNeeded(path, element): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`path`	`Path2D`
`element`	`Element`

Returns

void

Inherited from

UniverRenderingContext2D.drawFocusIfNeeded

Defined in

submodules/univer/packages/engine-render/src/context.ts:348 (opens in a new tab)

drawImage()

drawImage(
   image, 
   sx, 
   sy, 
   sWidth?, 
   sHeight?, 
   dx?, 
   dy?, 
   dWidth?, 
   dHeight?): void

drawImage function.

Parameters

Parameter	Type
`image`	`CanvasImageSource`
`sx`	`number`
`sy`	`number`
`sWidth`?	`number`
`sHeight`?	`number`
`dx`?	`number`
`dy`?	`number`
`dWidth`?	`number`
`dHeight`?	`number`

Returns

void

Inherited from

UniverRenderingContext2D.drawImage

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:548 (opens in a new tab)

ellipse()

ellipse(
   x, 
   y, 
   radiusX, 
   radiusY, 
   rotation, 
   startAngle, 
   endAngle, 
   counterclockwise?): void

ellipse function.

Parameters

Parameter	Type
`x`	`number`
`y`	`number`
`radiusX`	`number`
`radiusY`	`number`
`rotation`	`number`
`startAngle`	`number`
`endAngle`	`number`
`counterclockwise`?	`boolean`

Returns

void

Inherited from

UniverRenderingContext2D.ellipse

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:588 (opens in a new tab)

fill()

fill(fillRule)

fill(fillRule?): void

fill function.

Parameters

Parameter	Type
`fillRule`?	`CanvasFillRule`

Returns

void

Inherited from

UniverRenderingContext2D.fill

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:624 (opens in a new tab)

fill(path, fillRule)

fill(path, fillRule?): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`path`	`Path2D`
`fillRule`?	`CanvasFillRule`

Returns

void

Inherited from

UniverRenderingContext2D.fill

Defined in

submodules/univer/packages/engine-render/src/context.ts:626 (opens in a new tab)

fillRect()

fillRect(
   x, 
   y, 
   width, 
   height): void

fillRect function.

Parameters

Parameter	Type
`x`	`number`
`y`	`number`
`width`	`number`
`height`	`number`

Returns

void

Inherited from

UniverRenderingContext2D.fillRect

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:638 (opens in a new tab)

fillRectByPrecision()

fillRectByPrecision(
   x, 
   y, 
   width, 
   height): void

fillRect function precision.

Parameters

Parameter	Type
`x`	`number`
`y`	`number`
`width`	`number`
`height`	`number`

Returns

void

Inherited from

UniverRenderingContext2D.fillRectByPrecision

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:646 (opens in a new tab)

fillText()

fillText(
   text, 
   x, 
   y, 
   maxWidth?): void

fillText function.

Parameters

Parameter	Type
`text`	`string`
`x`	`number`
`y`	`number`
`maxWidth`?	`number`

Returns

void

Inherited from

UniverRenderingContext2D.fillText

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:682 (opens in a new tab)

fillTextPrecision()

fillTextPrecision(
   text, 
   x, 
   y, 
   maxWidth?): void

fillText function.

Parameters

Parameter	Type
`text`	`string`
`x`	`number`
`y`	`number`
`maxWidth`?	`number`

Returns

void

Inherited from

UniverRenderingContext2D.fillTextPrecision

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:700 (opens in a new tab)

getContextAttributes()

getContextAttributes(): CanvasRenderingContext2DSettings

MDN Reference (opens in a new tab)

Returns

CanvasRenderingContext2DSettings

Inherited from

UniverRenderingContext2D.getContextAttributes

Defined in

submodules/univer/packages/engine-render/src/context.ts:297 (opens in a new tab)

getImageData()

getImageData(
   sx, 
   sy, 
   sw, 
   sh): ImageData

getImageData function.

Parameters

Parameter	Type
`sx`	`number`
`sy`	`number`
`sw`	`number`
`sh`	`number`

Returns

ImageData

Inherited from

UniverRenderingContext2D.getImageData

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:726 (opens in a new tab)

getLineDash()

getLineDash(): number[]

getLineDash function.

Returns

number[]

Inherited from

UniverRenderingContext2D.getLineDash

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:866 (opens in a new tab)

getScale()

getScale(): {
  scaleX: number;
  scaleY: number;
}

Returns

{
  scaleX: number;
  scaleY: number;
}

Name	Type	Defined in
`scaleX`	`number`	submodules/univer/packages/engine-render/src/context.ts:288 (opens in a new tab)
`scaleY`	`number`	submodules/univer/packages/engine-render/src/context.ts:289 (opens in a new tab)

Inherited from

UniverRenderingContext2D.getScale

Defined in

submodules/univer/packages/engine-render/src/context.ts:293 (opens in a new tab)

getTransform()

getTransform(): DOMMatrix

MDN Reference (opens in a new tab)

Returns

DOMMatrix

Inherited from

UniverRenderingContext2D.getTransform

Defined in

submodules/univer/packages/engine-render/src/context.ts:339 (opens in a new tab)

isPointInPath()

isPointInPath(x, y, fillRule)

isPointInPath(
   x, 
   y, 
   fillRule?): boolean

isPointInPath function.

Parameters

Parameter	Type
`x`	`number`
`y`	`number`
`fillRule`?	`CanvasFillRule`

Returns

boolean

Inherited from

UniverRenderingContext2D.isPointInPath

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:612 (opens in a new tab)

isPointInPath(path, x, y, fillRule)

isPointInPath(
   path, 
   x, 
   y, 
   fillRule?): boolean

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`path`	`Path2D`
`x`	`number`
`y`	`number`
`fillRule`?	`CanvasFillRule`

Returns

boolean

Inherited from

UniverRenderingContext2D.isPointInPath

Defined in

submodules/univer/packages/engine-render/src/context.ts:614 (opens in a new tab)

isPointInStroke()

isPointInStroke(x, y)

isPointInStroke(x, y): boolean

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`x`	`number`
`y`	`number`

Returns

boolean

Inherited from

UniverRenderingContext2D.isPointInStroke

Defined in

submodules/univer/packages/engine-render/src/context.ts:301 (opens in a new tab)

isPointInStroke(path, x, y)

isPointInStroke(
   path, 
   x, 
   y): boolean

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`path`	`Path2D`
`x`	`number`
`y`	`number`

Returns

boolean

Inherited from

UniverRenderingContext2D.isPointInStroke

Defined in

submodules/univer/packages/engine-render/src/context.ts:303 (opens in a new tab)

lineTo()

lineTo(x, y): void

lineTo function.

Parameters

Parameter	Type
`x`	`number`
`y`	`number`

Returns

void

Inherited from

UniverRenderingContext2D.lineTo

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:734 (opens in a new tab)

lineToByPrecision()

lineToByPrecision(x, y): void

lineTo function precision.

Parameters

Parameter	Type
`x`	`number`
`y`	`number`

Returns

void

Inherited from

UniverRenderingContext2D.lineToByPrecision

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:742 (opens in a new tab)

measureText()

measureText(text): TextMetrics

measureText function.

Parameters

Parameter	Type
`text`	`string`

Returns

TextMetrics

Inherited from

UniverRenderingContext2D.measureText

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:718 (opens in a new tab)

moveTo()

moveTo(x, y): void

moveTo function.

Parameters

Parameter	Type
`x`	`number`
`y`	`number`

Returns

void

Inherited from

UniverRenderingContext2D.moveTo

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:754 (opens in a new tab)

moveToByPrecision()

moveToByPrecision(x, y): void

moveTo function precision.

Parameters

Parameter	Type
`x`	`number`
`y`	`number`

Returns

void

Inherited from

UniverRenderingContext2D.moveToByPrecision

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:762 (opens in a new tab)

putImageData()

putImageData(
   imageData, 
   dx, 
   dy): void

putImageData function.

Parameters

Parameter	Type
`imageData`	`ImageData`
`dx`	`number`
`dy`	`number`

Returns

void

Inherited from

UniverRenderingContext2D.putImageData

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:796 (opens in a new tab)

quadraticCurveTo()

quadraticCurveTo(
   cpx, 
   cpy, 
   x, 
   y): void

quadraticCurveTo function.

Parameters

Parameter	Type
`cpx`	`number`
`cpy`	`number`
`x`	`number`
`y`	`number`

Returns

void

Inherited from

UniverRenderingContext2D.quadraticCurveTo

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:804 (opens in a new tab)

rect()

rect(
   x, 
   y, 
   width, 
   height): void

rect function.

Parameters

Parameter	Type
`x`	`number`
`y`	`number`
`width`	`number`
`height`	`number`

Returns

void

Inherited from

UniverRenderingContext2D.rect

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:774 (opens in a new tab)

rectByPrecision()

rectByPrecision(
   x, 
   y, 
   width, 
   height): void

rect function.

Parameters

Parameter	Type
`x`	`number`
`y`	`number`
`width`	`number`
`height`	`number`

Returns

void

Inherited from

UniverRenderingContext2D.rectByPrecision

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:782 (opens in a new tab)

reset()

reset(): void

reset canvas context transform

Returns

void

Inherited from

UniverRenderingContext2D.reset

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:357 (opens in a new tab)

resetTransform()

resetTransform(): void

MDN Reference (opens in a new tab)

Returns

void

Inherited from

UniverRenderingContext2D.resetTransform

Defined in

submodules/univer/packages/engine-render/src/context.ts:343 (opens in a new tab)

restore()

restore(): void

restore function.

Returns

void

Inherited from

UniverRenderingContext2D.restore

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:812 (opens in a new tab)

rotate()

rotate(angle): void

rotate function.

Parameters

Parameter	Type
`angle`	`number`

Returns

void

Inherited from

UniverRenderingContext2D.rotate

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:820 (opens in a new tab)

roundRect()

roundRect(
   x, 
   y, 
   w, 
   h, 
   radii?): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`x`	`number`
`y`	`number`
`w`	`number`
`h`	`number`
`radii`?	`number` \| `DOMPointInit` \| (`number` \| `DOMPointInit`)[]

Returns

void

Inherited from

UniverRenderingContext2D.roundRect

Defined in

submodules/univer/packages/engine-render/src/context.ts:313 (opens in a new tab)

roundRectByPrecision()

roundRectByPrecision(
   x, 
   y, 
   w, 
   h, 
   radii?): void

Parameters

Parameter	Type
`x`	`number`
`y`	`number`
`w`	`number`
`h`	`number`
`radii`?	`number` \| `DOMPointInit` \| (`number` \| `DOMPointInit`)[]

Returns

void

Inherited from

UniverRenderingContext2D.roundRectByPrecision

Defined in

submodules/univer/packages/engine-render/src/context.ts:323 (opens in a new tab)

save()

save(): void

save function.

Returns

void

Inherited from

UniverRenderingContext2D.save

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:828 (opens in a new tab)

scale()

scale(x, y): void

scale function.

Parameters

Parameter	Type
`x`	`number`
`y`	`number`

Returns

void

Inherited from

UniverRenderingContext2D.scale

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:836 (opens in a new tab)

setGlobalCompositeOperation()

setGlobalCompositeOperation(val): void

Parameters

Parameter	Type
`val`	`GlobalCompositeOperation`

Returns

void

Overrides

UniverRenderingContext2D.setGlobalCompositeOperation

Defined in

submodules/univer/packages/engine-render/src/context.ts:1000 (opens in a new tab)

setLineDash()

setLineDash(segments): void

setLineDash function.

Parameters

Parameter	Type
`segments`	`number`[]

Returns

void

Inherited from

UniverRenderingContext2D.setLineDash

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:844 (opens in a new tab)

setLineWidthByPrecision()

setLineWidthByPrecision(val): void

Parameters

Parameter	Type
`val`	`number`

Returns

void

Inherited from

UniverRenderingContext2D.setLineWidthByPrecision

Defined in

submodules/univer/packages/engine-render/src/context.ts:131 (opens in a new tab)

setTransform()

setTransform(transform)

setTransform(transform?): void

setTransform function.

Parameters

Parameter	Type
`transform`?	`DOMMatrix2DInit`

Returns

void

Inherited from

UniverRenderingContext2D.setTransform

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:874 (opens in a new tab)

setTransform(a, b, c, d, e, f)

setTransform(
   a, 
   b, 
   c, 
   d, 
   e, 
   f): void

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`a`	`number`
`b`	`number`
`c`	`number`
`d`	`number`
`e`	`number`
`f`	`number`

Returns

void

Inherited from

UniverRenderingContext2D.setTransform

Defined in

submodules/univer/packages/engine-render/src/context.ts:876 (opens in a new tab)

stroke()

stroke(path2d?): void

stroke function.

Parameters

Parameter	Type
`path2d`?	`Path2D`

Returns

void

Inherited from

UniverRenderingContext2D.stroke

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:886 (opens in a new tab)

strokeRect()

strokeRect(
   x, 
   y, 
   width, 
   height): void

strokeRect function.

Parameters

Parameter	Type
`x`	`number`
`y`	`number`
`width`	`number`
`height`	`number`

Returns

void

Inherited from

UniverRenderingContext2D.strokeRect

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:660 (opens in a new tab)

strokeRectPrecision()

strokeRectPrecision(
   x, 
   y, 
   width, 
   height): void

strokeRect function precision.

Parameters

Parameter	Type
`x`	`number`
`y`	`number`
`width`	`number`
`height`	`number`

Returns

void

Inherited from

UniverRenderingContext2D.strokeRectPrecision

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:668 (opens in a new tab)

strokeText()

strokeText(
   text, 
   x, 
   y, 
   maxWidth?): void

strokeText function.

Parameters

Parameter	Type
`text`	`string`
`x`	`number`
`y`	`number`
`maxWidth`?	`number`

Returns

void

Inherited from

UniverRenderingContext2D.strokeText

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:898 (opens in a new tab)

strokeTextByPrecision()

strokeTextByPrecision(
   text, 
   x, 
   y, 
   maxWidth?): void

strokeText function precision.

Parameters

Parameter	Type
`text`	`string`
`x`	`number`
`y`	`number`
`maxWidth`?	`number`

Returns

void

Inherited from

UniverRenderingContext2D.strokeTextByPrecision

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:906 (opens in a new tab)

transform()

transform(
   a, 
   b, 
   c, 
   d, 
   e, 
   f): void

transform function.

Parameters

Parameter	Type
`a`	`number`
`b`	`number`
`c`	`number`
`d`	`number`
`e`	`number`
`f`	`number`

Returns

void

Inherited from

UniverRenderingContext2D.transform

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:921 (opens in a new tab)

translate()

translate(x, y): void

translate function.

Parameters

Parameter	Type
`x`	`number`
`y`	`number`

Returns

void

Inherited from

UniverRenderingContext2D.translate

Method

Defined in

submodules/univer/packages/engine-render/src/context.ts:929 (opens in a new tab)

translateWithPrecision()

translateWithPrecision(x, y): void

Parameters

Parameter	Type
`x`	`number`
`y`	`number`

Returns

void

Inherited from

UniverRenderingContext2D.translateWithPrecision

Defined in

submodules/univer/packages/engine-render/src/context.ts:937 (opens in a new tab)

translateWithPrecisionRatio()

translateWithPrecisionRatio(x, y): void

Parameters

Parameter	Type
`x`	`number`
`y`	`number`

Returns

void

Inherited from

UniverRenderingContext2D.translateWithPrecisionRatio

Defined in

submodules/univer/packages/engine-render/src/context.ts:945 (opens in a new tab)

Transform Univerrenderengineplugin