Class: LeaferFilm

Hierarchy

• LeaferImage

  ↳ LeaferFilm

Implements

• ILeaferFilm

Table of contents

Constructors

• constructor

Properties

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

Accessors

• tag
• url
• crossOrigin
• completed

Methods

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

Constructors

constructor

• new LeaferFilm(config): LeaferFilm

Parameters

Name	Type
config	ILeaferImageConfig

Returns

LeaferFilm

Inherited from

LeaferImage.constructor

Defined in

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

Properties

innerId

• Readonly innerId: number

Implementation of

ILeaferFilm.innerId

Inherited from

LeaferImage.innerId

Defined in

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

---

lod

• Optional lod: IImageLOD

Implementation of

ILeaferFilm.lod

Inherited from

LeaferImage.lod

Defined in

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

---

view

• view: any

Implementation of

ILeaferFilm.view

Inherited from

LeaferImage.view

Defined in

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

---

width

• width: number

Implementation of

ILeaferFilm.width

Inherited from

LeaferImage.width

Defined in

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

---

height

• height: number

Implementation of

ILeaferFilm.height

Inherited from

LeaferImage.height

Defined in

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

---

isSVG

• isSVG: boolean

Implementation of

ILeaferFilm.isSVG

Inherited from

LeaferImage.isSVG

Defined in

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

---

hasAlphaPixel

• hasAlphaPixel: boolean

Implementation of

ILeaferFilm.hasAlphaPixel

Inherited from

LeaferImage.hasAlphaPixel

Defined in

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

---

ready

• ready: boolean

Implementation of

ILeaferFilm.ready

Inherited from

LeaferImage.ready

Defined in

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

---

error

• error: IObject

Implementation of

ILeaferFilm.error

Inherited from

LeaferImage.error

Defined in

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

---

loading

• loading: boolean

Implementation of

ILeaferFilm.loading

Inherited from

LeaferImage.loading

Defined in

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

---

use

• use: number = 0

Implementation of

ILeaferFilm.use

Inherited from

LeaferImage.use

Defined in

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

---

config

• config: ILeaferImageConfig

Implementation of

ILeaferFilm.config

Inherited from

LeaferImage.config

Defined in

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

---

waitComplete

• Protected waitComplete: IFunction[] = []

Inherited from

LeaferImage.waitComplete

Defined in

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

---

cache

• Protected cache: ILeaferImageCacheCanvas

Inherited from

LeaferImage.cache

Defined in

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

Accessors

tag

• get tag(): string

Returns

string

Overrides

LeaferImage.tag

Defined in

src/leafer/packages/image/image/src/LeaferFilm.ts:8

---

url

• get url(): string

Returns

string

Implementation of

ILeaferFilm.url

Inherited from

LeaferImage.url

Defined in

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

---

crossOrigin

• get crossOrigin(): IImageCrossOrigin

Returns

IImageCrossOrigin

Implementation of

ILeaferFilm.crossOrigin

Inherited from

LeaferImage.crossOrigin

Defined in

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

---

completed

• get completed(): boolean

Returns

boolean

Implementation of

ILeaferFilm.completed

Inherited from

LeaferImage.completed

Defined in

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

Methods

load

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

Parameters

Name	Type
onSuccess?	IFunction
onError?	IFunction
thumbSize?	ISizeData

Returns

number

Implementation of

ILeaferFilm.load

Inherited from

LeaferImage.load

Defined in

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

---

unload

▸ unload(index, stopEvent?): void

Parameters

Name	Type
index	number
stopEvent?	boolean

Returns

void

Implementation of

ILeaferFilm.unload

Inherited from

LeaferImage.unload

Defined in

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

---

setView

▸ setView(img): void

Parameters

Name	Type
img	any

Returns

void

Inherited from

LeaferImage.setView

Defined in

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

---

onComplete

▸ onComplete(isSuccess): void

Parameters

Name	Type
isSuccess	boolean

Returns

void

Inherited from

LeaferImage.onComplete

Defined in

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

---

getFull

▸ getFull(_filters?): any

Parameters

Name	Type
_filters?	IObject

Returns

any

Implementation of

ILeaferFilm.getFull

Inherited from

LeaferImage.getFull

Defined in

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

---

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

Implementation of

ILeaferFilm.getCanvas

Inherited from

LeaferImage.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

ILeaferFilm.getPattern

Inherited from

LeaferImage.getPattern

Defined in

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

---

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

Implementation of

ILeaferFilm.render

Inherited from

LeaferImage.render

Defined in

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

---

getLoadUrl

▸ getLoadUrl(_thumbSize?): string

Parameters

Name	Type
_thumbSize?	ISizeData

Returns

string

Implementation of

ILeaferFilm.getLoadUrl

Inherited from

LeaferImage.getLoadUrl

Defined in

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

---

setThumbView

▸ setThumbView(_view): void

Parameters

Name	Type
_view	number

Returns

void

Implementation of

ILeaferFilm.setThumbView

Inherited from

LeaferImage.setThumbView

Defined in

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

---

getThumbSize

▸ getThumbSize(_lod?): ISizeData

Parameters

Name	Type
_lod?	IImageLOD

Returns

ISizeData

Implementation of

ILeaferFilm.getThumbSize

Inherited from

LeaferImage.getThumbSize

Defined in

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

---

getMinLevel

▸ getMinLevel(): number

Returns

number

Implementation of

ILeaferFilm.getMinLevel

Inherited from

LeaferImage.getMinLevel

Defined in

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

---

getLevelData

▸ getLevelData(_level, _width?, _height?): ILeaferImageLevel

Parameters

Name	Type
_level	number
_width?	number
_height?	number

Returns

ILeaferImageLevel

Implementation of

ILeaferFilm.getLevelData

Inherited from

LeaferImage.getLevelData

Defined in

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

---

clearLevels

▸ clearLevels(_checkUse?): void

Parameters

Name	Type
_checkUse?	boolean

Returns

void

Implementation of

ILeaferFilm.clearLevels

Inherited from

LeaferImage.clearLevels

Defined in

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

---

destroyFilter

▸ destroyFilter(): void

Returns

void

Implementation of

ILeaferFilm.destroyFilter

Inherited from

LeaferImage.destroyFilter

Defined in

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

---

destroy

▸ destroy(): void

Returns

void

Implementation of

ILeaferFilm.destroy

Inherited from

LeaferImage.destroy

Defined in

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