Interface: ILeaferImage

Implemented by

• LeaferImage

Table of contents

Properties

• innerId
• url
• view
• width
• height
• isSVG
• hasAlphaPixel
• completed
• ready
• error
• loading
• isPlacehold
• progress
• use
• config

Methods

• load
• unload
• getFull
• getCanvas
• getPattern
• destroy

Properties

innerId

• Readonly innerId: number

Defined in

src/leafer/packages/interface/src/image/ILeaferImage.ts:35

---

url

• Readonly url: string

Defined in

src/leafer/packages/interface/src/image/ILeaferImage.ts:36

---

view

• view: any

Defined in

src/leafer/packages/interface/src/image/ILeaferImage.ts:38

---

width

• width: number

Defined in

src/leafer/packages/interface/src/image/ILeaferImage.ts:39

---

height

• height: number

Defined in

src/leafer/packages/interface/src/image/ILeaferImage.ts:40

---

isSVG

• isSVG: boolean

Defined in

src/leafer/packages/interface/src/image/ILeaferImage.ts:42

---

hasAlphaPixel

• hasAlphaPixel: boolean

Defined in

src/leafer/packages/interface/src/image/ILeaferImage.ts:43

---

completed

• Readonly completed: boolean

Defined in

src/leafer/packages/interface/src/image/ILeaferImage.ts:45

---

ready

• ready: boolean

Defined in

src/leafer/packages/interface/src/image/ILeaferImage.ts:46

---

error

• error: IObject

Defined in

src/leafer/packages/interface/src/image/ILeaferImage.ts:47

---

loading

• loading: boolean

Defined in

src/leafer/packages/interface/src/image/ILeaferImage.ts:48

---

isPlacehold

• Optional isPlacehold: boolean

Defined in

src/leafer/packages/interface/src/image/ILeaferImage.ts:49

---

progress

• progress: IProgressData

Defined in

src/leafer/packages/interface/src/image/ILeaferImage.ts:50

---

use

• use: number

Defined in

src/leafer/packages/interface/src/image/ILeaferImage.ts:52

---

config

• config: ILeaferImageConfig

Defined in

src/leafer/packages/interface/src/image/ILeaferImage.ts:53

Methods

load

▸ load(onSuccess?, onError?): number

Parameters

Name	Type
onSuccess?	ILeaferImageOnLoaded
onError?	ILeaferImageOnError

Returns

number

Defined in

src/leafer/packages/interface/src/image/ILeaferImage.ts:55

---

unload

▸ unload(index, stopEvent?): void

Parameters

Name	Type
index	number
stopEvent?	boolean

Returns

void

Defined in

src/leafer/packages/interface/src/image/ILeaferImage.ts:56

---

getFull

▸ getFull(filters?): any

Parameters

Name	Type
filters?	IObject

Returns

any

Defined in

src/leafer/packages/interface/src/image/ILeaferImage.ts:57

---

getCanvas

▸ getCanvas(width, height, opacity?, filters?, xGap?, yGap?, smooth?): any

Parameters

Name	Type
width	number
height	number
opacity?	number
filters?	IObject
xGap?	number
yGap?	number
smooth?	boolean

Returns

any

Defined in

src/leafer/packages/interface/src/image/ILeaferImage.ts:58

---

getPattern

▸ getPattern(canvas, repeat, transform?, paint?): CanvasPattern

Parameters

Name	Type
canvas	any
repeat	string
transform?	IMatrixData
paint?	IObject

Returns

CanvasPattern

Defined in

src/leafer/packages/interface/src/image/ILeaferImage.ts:59

---

destroy

▸ destroy(): void

Returns

void

Defined in

src/leafer/packages/interface/src/image/ILeaferImage.ts:60