Class: LeaferImage

Implements

• ILeaferImage

Table of contents

Constructors

• constructor

Properties

• innerId
• view
• width
• height
• isSVG
• hasAlphaPixel
• ready
• error
• loading
• progress
• use
• config
• waitComplete
• cache

Accessors

• url
• completed

Methods

• load
• unload
• setView
• onProgress
• onComplete
• getFull
• getCanvas
• getPattern
• destroy

Constructors

constructor

• new LeaferImage(config): LeaferImage

Parameters

Name	Type
config	ILeaferImageConfig

Returns

LeaferImage

Defined in

src/leafer/packages/image/image/src/LeaferImage.ts:42

Properties

innerId

• Readonly innerId: number

Implementation of

ILeaferImage.innerId

Defined in

src/leafer/packages/image/image/src/LeaferImage.ts:15

---

view

• view: any

Implementation of

ILeaferImage.view

Defined in

src/leafer/packages/image/image/src/LeaferImage.ts:18

---

width

• width: number

Implementation of

ILeaferImage.width

Defined in

src/leafer/packages/image/image/src/LeaferImage.ts:20

---

height

• height: number

Implementation of

ILeaferImage.height

Defined in

src/leafer/packages/image/image/src/LeaferImage.ts:21

---

isSVG

• isSVG: boolean

Implementation of

ILeaferImage.isSVG

Defined in

src/leafer/packages/image/image/src/LeaferImage.ts:23

---

hasAlphaPixel

• hasAlphaPixel: boolean

Implementation of

ILeaferImage.hasAlphaPixel

Defined in

src/leafer/packages/image/image/src/LeaferImage.ts:24

---

ready

• ready: boolean

Implementation of

ILeaferImage.ready

Defined in

src/leafer/packages/image/image/src/LeaferImage.ts:28

---

error

• error: IObject

Implementation of

ILeaferImage.error

Defined in

src/leafer/packages/image/image/src/LeaferImage.ts:29

---

loading

• loading: boolean

Implementation of

ILeaferImage.loading

Defined in

src/leafer/packages/image/image/src/LeaferImage.ts:30

---

progress

• progress: IProgressData

Implementation of

ILeaferImage.progress

Defined in

src/leafer/packages/image/image/src/LeaferImage.ts:32

---

use

• use: number = 0

Implementation of

ILeaferImage.use

Defined in

src/leafer/packages/image/image/src/LeaferImage.ts:34

---

config

• config: ILeaferImageConfig

Implementation of

ILeaferImage.config

Defined in

src/leafer/packages/image/image/src/LeaferImage.ts:36

---

waitComplete

• Protected waitComplete: IFunction[] = []

Defined in

src/leafer/packages/image/image/src/LeaferImage.ts:38

---

cache

• Protected cache: ILeaferImageCacheCanvas

Defined in

src/leafer/packages/image/image/src/LeaferImage.ts:40

Accessors

url

• get url(): string

Returns

string

Implementation of

ILeaferImage.url

Defined in

src/leafer/packages/image/image/src/LeaferImage.ts:16

---

completed

• get completed(): boolean

Returns

boolean

Implementation of

ILeaferImage.completed

Defined in

src/leafer/packages/image/image/src/LeaferImage.ts:26

Methods

load

▸ load(onSuccess?, onError?): number

Parameters

Name	Type
onSuccess?	IFunction
onError?	IFunction

Returns

number

Implementation of

ILeaferImage.load

Defined in

src/leafer/packages/image/image/src/LeaferImage.ts:54

---

unload

▸ unload(index, stopEvent?): void

Parameters

Name	Type
index	number
stopEvent?	boolean

Returns

void

Implementation of

ILeaferImage.unload

Defined in

src/leafer/packages/image/image/src/LeaferImage.ts:68

---

setView

▸ setView(img): void

Parameters

Name	Type
img	any

Returns

void

Defined in

src/leafer/packages/image/image/src/LeaferImage.ts:77

---

onProgress

▸ onProgress(progress): void

Parameters

Name	Type
progress	IProgressData

Returns

void

Defined in

src/leafer/packages/image/image/src/LeaferImage.ts:85

---

onComplete

▸ onComplete(isSuccess): void

Parameters

Name	Type
isSuccess	boolean

Returns

void

Defined in

src/leafer/packages/image/image/src/LeaferImage.ts:89

---

getFull

▸ getFull(_filters?): any

Parameters

Name	Type
_filters?	IObject

Returns

any

Implementation of

ILeaferImage.getFull

Defined in

src/leafer/packages/image/image/src/LeaferImage.ts:105

---

getCanvas

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

Parameters

Name	Type
width	number
height	number
opacity?	number
_filters?	IObject
xGap?	number
yGap?	number

Returns

any

Implementation of

ILeaferImage.getCanvas

Defined in

src/leafer/packages/image/image/src/LeaferImage.ts:109

---

getPattern

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

Parameters

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

Returns

CanvasPattern

Implementation of

ILeaferImage.getPattern

Defined in

src/leafer/packages/image/image/src/LeaferImage.ts:129

---

destroy

▸ destroy(): void

Returns

void

Implementation of

ILeaferImage.destroy

Defined in

src/leafer/packages/image/image/src/LeaferImage.ts:141