Skip to content

Class: LeaferImage

Implements

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new LeaferImage(config)

Parameters

NameType
configILeaferImageConfig

Defined in

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

Properties

innerId

Readonly innerId: number

Implementation of

ILeaferImage.innerId

Defined in

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


view

view: any

Implementation of

ILeaferImage.view

Defined in

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


width

width: number

Implementation of

ILeaferImage.width

Defined in

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


height

height: number

Implementation of

ILeaferImage.height

Defined in

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


isSVG

isSVG: boolean

Implementation of

ILeaferImage.isSVG

Defined in

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


hasAlphaPixel

hasAlphaPixel: boolean

Implementation of

ILeaferImage.hasAlphaPixel

Defined in

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


ready

ready: boolean

Implementation of

ILeaferImage.ready

Defined in

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


error

error: IObject

Implementation of

ILeaferImage.error

Defined in

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


loading

loading: boolean

Implementation of

ILeaferImage.loading

Defined in

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


progress

progress: IProgressData

Implementation of

ILeaferImage.progress

Defined in

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


use

use: number = 0

Implementation of

ILeaferImage.use

Defined in

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


config

config: ILeaferImageConfig

Implementation of

ILeaferImage.config

Defined in

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


waitComplete

Protected waitComplete: IFunction[] = []

Defined in

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


cache

Protected cache: ILeaferImageCacheCanvas

Defined in

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

Accessors

url

get url(): string

Returns

string

Implementation of

ILeaferImage.url

Defined in

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


completed

get completed(): boolean

Returns

boolean

Implementation of

ILeaferImage.completed

Defined in

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

Methods

load

load(onSuccess?, onError?): number

Parameters

NameType
onSuccess?IFunction
onError?IFunction

Returns

number

Implementation of

ILeaferImage.load

Defined in

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


unload

unload(index, stopEvent?): void

Parameters

NameType
indexnumber
stopEvent?boolean

Returns

void

Implementation of

ILeaferImage.unload

Defined in

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


setView

Protected setView(img): void

Parameters

NameType
imgany

Returns

void

Defined in

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


onProgress

Protected onProgress(progress): void

Parameters

NameType
progressIProgressData

Returns

void

Defined in

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


onComplete

Protected onComplete(isSuccess): void

Parameters

NameType
isSuccessboolean

Returns

void

Defined in

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


getFull

getFull(_filters?): any

Parameters

NameType
_filters?IObject

Returns

any

Implementation of

ILeaferImage.getFull

Defined in

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


getCanvas

getCanvas(width, height, opacity?, _filters?): any

Parameters

NameType
widthnumber
heightnumber
opacity?number
_filters?IObject

Returns

any

Implementation of

ILeaferImage.getCanvas

Defined in

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


getPattern

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

Parameters

NameType
canvasany
repeatstring
transform?IMatrixData
paint?ILeaferImagePatternPaint

Returns

CanvasPattern

Implementation of

ILeaferImage.getPattern

Defined in

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


destroy

destroy(): void

Returns

void

Implementation of

ILeaferImage.destroy

Defined in

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

Released under the MIT License.