Interface: ILeaferImage

Hierarchy

• ILeaferImage

  ↳ ILeaferFilm

  ↳ ILeaferVideo

Implemented by

• LeaferImage

Table of contents

Properties

• innerId
• url
• lod
• crossOrigin
• view
• width
• height
• isSVG
• hasAlphaPixel
• completed
• ready
• error
• loading
• isPlacehold
• parent
• childrenMap
• filterKey
• largeThumb
• thumb
• levels
• levelsRange
• minLevel
• loadId
• progress
• use
• config

Methods

• load
• unload
• getFull
• getCanvas
• getPattern
• render
• getLoadUrl
• setThumbView
• getThumbSize
• getMinLevel
• getLevelData
• clearLevels
• destroyFilter
• destroy

Properties

innerId

• Readonly innerId: number

Defined in

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

---

url

• Readonly url: string

Defined in

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

---

lod

• Optional lod: IImageLOD

Defined in

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

---

crossOrigin

• Readonly crossOrigin: IImageCrossOrigin

Defined in

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

---

view

• view: any

Defined in

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

---

width

• width: number

Defined in

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

---

height

• height: number

Defined in

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

---

isSVG

• isSVG: boolean

Defined in

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

---

hasAlphaPixel

• hasAlphaPixel: boolean

Defined in

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

---

completed

• Readonly completed: boolean

Defined in

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

---

ready

• ready: boolean

Defined in

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

---

error

• error: IObject

Defined in

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

---

loading

• loading: boolean

Defined in

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

---

isPlacehold

• Optional isPlacehold: boolean

Defined in

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

---

parent

• Optional parent: ILeaferImage

Defined in

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

---

childrenMap

• Optional childrenMap: ILeaferImageMap

Defined in

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

---

filterKey

• Optional filterKey: string

Defined in

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

---

largeThumb

• Optional largeThumb: ILeaferImageLevel

Defined in

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

---

thumb

• Optional thumb: ILeaferImageLevel

Defined in

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

---

levels

• Optional levels: ILeaferImageLevel[]

Defined in

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

---

levelsRange

• Optional levelsRange: IRangeSize

Defined in

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

---

minLevel

• Optional minLevel: number

Defined in

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

---

loadId

• Optional loadId: ITaskItem

Defined in

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

---

progress

• Optional progress: IProgressData

Defined in

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

---

use

• use: number

Defined in

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

---

config

• config: ILeaferImageConfig

Defined in

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

Methods

load

▸ load(onSuccess?, onError?, thumbSize?): number

Parameters

Name	Type
onSuccess?	ILeaferImageOnLoaded
onError?	ILeaferImageOnError
thumbSize?	ISizeData

Returns

number

Defined in

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

---

unload

▸ unload(index, stopEvent?): void

Parameters

Name	Type
index	number
stopEvent?	boolean

Returns

void

Defined in

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

---

getFull

▸ getFull(filters?): any

Parameters

Name	Type
filters?	IObject

Returns

any

Defined in

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

---

getCanvas

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

Parameters

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

Returns

any

Defined in

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

---

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:127

---

render

▸ render(canvas, x, y, width, height, leaf, paint, imageScaleX, imageScaleY): void

Parameters

Name	Type
canvas	any
x	number
y	number
width	number
height	number
leaf	ILeaf
paint	any
imageScaleX	number
imageScaleY	number

Returns

void

Defined in

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

---

getLoadUrl

▸ getLoadUrl(thumbSize?): string

Parameters

Name	Type
thumbSize?	ISizeData

Returns

string

Defined in

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

---

setThumbView

▸ setThumbView(view): void

Parameters

Name	Type
view	number

Returns

void

Defined in

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

---

getThumbSize

▸ getThumbSize(lod?): ISizeData

Parameters

Name	Type
lod?	IImageLOD

Returns

ISizeData

Defined in

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

---

getMinLevel

▸ getMinLevel(): number

Returns

number

Defined in

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

---

getLevelData

▸ getLevelData(level, width?, height?): ILeaferImageLevel

Parameters

Name	Type
level	number
width?	number
height?	number

Returns

ILeaferImageLevel

Defined in

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

---

clearLevels

▸ clearLevels(checkUse?): void

Parameters

Name	Type
checkUse?	boolean

Returns

void

Defined in

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

---

destroyFilter

▸ destroyFilter(): void

Returns

void

Defined in

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

---

destroy

▸ destroy(): void

Returns

void

Defined in

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