@univerjs/engine-render v0.5.0-beta.1 • Docs
Class: abstract Canvas
View Renderer constructor. It is a wrapper around native canvas element. Usually you don’t need to use it manually.
Param
Param
Param
Param
Extended by
Constructors
new Canvas()
new Canvas(props?): CanvasParameters
| Parameter | Type |
|---|---|
props? | ICanvasProps |
Returns
Defined in
packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/canvas.ts:69
Properties
| Property | Type | Default value | Defined in |
|---|---|---|---|
isCache | boolean | false | packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/canvas.ts:57 |
Methods
clear()
clear(): voidReturns
void
Defined in
packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/canvas.ts:174
dispose()
dispose(): voidReturns
void
Defined in
packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/canvas.ts:167
getCanvasEle()
getCanvasEle(): HTMLCanvasElementReturns
HTMLCanvasElement
Defined in
packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/canvas.ts:105
getContext()
getContext(): UniverRenderingContextget canvas context
Returns
context
Method
Defined in
packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/canvas.ts:114
getHeight()
getHeight(): numberReturns
number
Defined in
packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/canvas.ts:126
getPixelRatio()
getPixelRatio(): numberReturns
number
Defined in
packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/canvas.ts:118
getWidth()
getWidth(): numberReturns
number
Defined in
packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/canvas.ts:122
setId()
setId(id): voidParameters
| Parameter | Type |
|---|---|
id | string |
Returns
void
Defined in
packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/canvas.ts:130
setPixelRatio()
setPixelRatio(pixelRatio): voidParameters
| Parameter | Type |
|---|---|
pixelRatio | number |
Returns
void
Defined in
packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/canvas.ts:157
setSize()
setSize(
width?,
height?,
pixelRatioParam?): voidParameters
| Parameter | Type |
|---|---|
width? | number |
height? | number |
pixelRatioParam? | number |
Returns
void
Defined in
packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/canvas.ts:134
toDataURL()
toDataURL(mimeType, quality): stringto data url
Parameters
| Parameter | Type | Description |
|---|---|---|
mimeType | string | - |
quality | number | between 0 and 1 for jpg mime types |
Returns
string
data url string
Method
Defined in
packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/canvas.ts:186