Interface: IPlatform

Table of contents

Properties

• name
• os
• canvas
• renderCanvas
• canvasType
• isWorker
• isMobile
• devicePixelRatio
• intWheelDeltaY
• conicGradientSupport
• conicGradientRotate90
• fullImageShadow
• syncDomFont
• selector
• origin
• roundRectPatch
• ellipseToCurve
• backgrounder
• event
• miniapp
• image

Methods

• toURL
• requestRender
• getSelector
• layout
• render

Properties

name

• Optional name: "miniapp" | "web" | "node"

Defined in

src/leafer/packages/interface/src/platform/IPlatform.ts:14

---

os

• Optional os: "Mac" | "Windows" | "Linux"

Defined in

src/leafer/packages/interface/src/platform/IPlatform.ts:15

---

canvas

• Optional canvas: ILeaferCanvas

Defined in

src/leafer/packages/interface/src/platform/IPlatform.ts:19

---

renderCanvas

• Optional renderCanvas: ILeaferCanvas

Defined in

src/leafer/packages/interface/src/platform/IPlatform.ts:20

---

canvasType

• Optional canvasType: ICanvasType

Defined in

src/leafer/packages/interface/src/platform/IPlatform.ts:21

---

isWorker

• Optional isWorker: boolean

Defined in

src/leafer/packages/interface/src/platform/IPlatform.ts:23

---

isMobile

• Optional isMobile: boolean

Defined in

src/leafer/packages/interface/src/platform/IPlatform.ts:24

---

devicePixelRatio

• Optional Readonly devicePixelRatio: number

Defined in

src/leafer/packages/interface/src/platform/IPlatform.ts:26

---

intWheelDeltaY

• Optional intWheelDeltaY: boolean

Defined in

src/leafer/packages/interface/src/platform/IPlatform.ts:28

---

conicGradientSupport

• Optional conicGradientSupport: boolean

Defined in

src/leafer/packages/interface/src/platform/IPlatform.ts:29

---

conicGradientRotate90

• Optional conicGradientRotate90: boolean

Defined in

src/leafer/packages/interface/src/platform/IPlatform.ts:30

---

fullImageShadow

• Optional fullImageShadow: boolean

Defined in

src/leafer/packages/interface/src/platform/IPlatform.ts:31

---

syncDomFont

• Optional syncDomFont: boolean

Defined in

src/leafer/packages/interface/src/platform/IPlatform.ts:32

---

selector

• Optional selector: ISelector

Defined in

src/leafer/packages/interface/src/platform/IPlatform.ts:34

---

origin

• Optional origin: Object

Type declaration

Name	Type
createCanvas	(width: number, height: number, format?: "svg" | "pdf") => any
canvasToDataURL	(canvas: any, type?: IExportImageType, quality?: number) => string | Promise<string>
canvasToBolb	(canvas: any, type?: IExportFileType, quality?: number) => Promise<any>
canvasSaveAs	(canvas: any, filename: string, quality?: number) => Promise<void>
download	(url: string, filename: string) => Promise<void>
loadImage	(url: string, progressFn?: IProgressFunction) => Promise<any>
loadImageWithProgress?	(url: string, progressFn?: IProgressFunction) => Promise<any>
noRepeat?	string
Image?	any
PointerEvent?	any
DragEvent?	any

Defined in

src/leafer/packages/interface/src/platform/IPlatform.ts:39

---

roundRectPatch

• Optional roundRectPatch: boolean

Defined in

src/leafer/packages/interface/src/platform/IPlatform.ts:53

---

ellipseToCurve

• Optional ellipseToCurve: boolean

Defined in

src/leafer/packages/interface/src/platform/IPlatform.ts:54

---

backgrounder

• Optional backgrounder: boolean

Defined in

src/leafer/packages/interface/src/platform/IPlatform.ts:55

---

event

• Optional event: Object

Type declaration

Name	Type
stopDefault	(origin: IObject) => void
stopNow	(origin: IObject) => void
stop	(origin: IObject) => void

Defined in

src/leafer/packages/interface/src/platform/IPlatform.ts:57

---

miniapp

• Optional miniapp: IMiniapp

Defined in

src/leafer/packages/interface/src/platform/IPlatform.ts:63

---

image

• image: Object

Type declaration

Name	Type
hitCanvasSize	number
maxCacheSize	number
maxPatternSize	number
prefix?	string
suffix?	string
crossOrigin	string | false
getRealURL	IStringFunction

Defined in

src/leafer/packages/interface/src/platform/IPlatform.ts:65

Methods

toURL

▸ toURL(text, fileType?): string

Parameters

Name	Type
text	string
fileType?	"svg" | "text"

Returns

string

Defined in

src/leafer/packages/interface/src/platform/IPlatform.ts:16

---

requestRender

▸ requestRender(render): void

Parameters

Name	Type
render	IFunction

Returns

void

Defined in

src/leafer/packages/interface/src/platform/IPlatform.ts:18

---

getSelector

▸ getSelector(leaf): ISelector

Parameters

Name	Type
leaf	ILeaf

Returns

ISelector

Defined in

src/leafer/packages/interface/src/platform/IPlatform.ts:35

---

layout

▸ layout(target): void

Parameters

Name	Type
target	ILeaf

Returns

void

Defined in

src/leafer/packages/interface/src/platform/IPlatform.ts:36

---

render

▸ render(target, canvas, options): void

Parameters

Name	Type
target	ILeaf
canvas	ILeaferCanvas
options	IRenderOptions

Returns

void

Defined in

src/leafer/packages/interface/src/platform/IPlatform.ts:37