@univerjs/engine-render v0.1.17 • Docs
Class: SceneCanvas
View Renderer constructor. It is a wrapper around native canvas element. Usually you don't need to use it manually.
Abstract
Param
Param
Param
Param
Extends
Constructors
new SceneCanvas()
new SceneCanvas(props): SceneCanvas
Parameters
Parameter | Type |
---|---|
props | ICanvasProps |
Returns
Overrides
Defined in
submodules/univer/packages/engine-render/src/canvas.ts:199 (opens in a new tab)
Properties
Property | Type | Default value | Inherited from | Defined in |
---|---|---|---|---|
isCache | boolean | false | Canvas .isCache | submodules/univer/packages/engine-render/src/canvas.ts:56 (opens in a new tab) |
Methods
clear()
clear(): void
Returns
void
Inherited from
Defined in
submodules/univer/packages/engine-render/src/canvas.ts:167 (opens in a new tab)
dispose()
dispose(): void
Returns
void
Inherited from
Defined in
submodules/univer/packages/engine-render/src/canvas.ts:160 (opens in a new tab)
getCanvasEle()
getCanvasEle(): HTMLCanvasElement
Returns
HTMLCanvasElement
Inherited from
Defined in
submodules/univer/packages/engine-render/src/canvas.ts:104 (opens in a new tab)
getContext()
getContext(): UniverRenderingContext
get canvas context
Returns
context
Inherited from
Method
Defined in
submodules/univer/packages/engine-render/src/canvas.ts:113 (opens in a new tab)
getHeight()
getHeight(): number
Returns
number
Inherited from
Defined in
submodules/univer/packages/engine-render/src/canvas.ts:125 (opens in a new tab)
getPixelRatio()
getPixelRatio(): number
Returns
number
Inherited from
Defined in
submodules/univer/packages/engine-render/src/canvas.ts:117 (opens in a new tab)
getWidth()
getWidth(): number
Returns
number
Inherited from
Defined in
submodules/univer/packages/engine-render/src/canvas.ts:121 (opens in a new tab)
setPixelRatio()
setPixelRatio(pixelRatio): void
Parameters
Parameter | Type |
---|---|
pixelRatio | number |
Returns
void
Inherited from
Defined in
submodules/univer/packages/engine-render/src/canvas.ts:150 (opens in a new tab)
setSize()
setSize(
width?,
height?,
pixelRatioParam?): void
Parameters
Parameter | Type |
---|---|
width ? | number |
height ? | number |
pixelRatioParam ? | number |
Returns
void
Inherited from
Defined in
submodules/univer/packages/engine-render/src/canvas.ts:129 (opens in a new tab)
toDataURL()
toDataURL(mimeType, quality): string
to data url
Parameters
Parameter | Type | Description |
---|---|---|
mimeType | string | - |
quality | number | between 0 and 1 for jpg mime types |
Returns
string
data url string
Inherited from
Method
Defined in
submodules/univer/packages/engine-render/src/canvas.ts:179 (opens in a new tab)