Interface: ILeaferFilm ​
Hierarchy ​
↳
ILeaferFilm
Implemented by ​
Table of contents ​
Properties ​
- innerId
- url
- lod
- crossOrigin
- view
- width
- height
- isSVG
- hasAlphaPixel
- completed
- ready
- error
- loading
- isPlacehold
- parent
- childrenMap
- filter
- 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
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:86
url ​
• Readonly url: string
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:87
lod ​
• Optional lod: IImageLOD
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:88
crossOrigin ​
• Readonly crossOrigin: IImageCrossOrigin
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:89
view ​
• view: any
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:91
width ​
• width: number
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:92
height ​
• height: number
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:93
isSVG ​
• isSVG: boolean
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:95
hasAlphaPixel ​
• hasAlphaPixel: boolean
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:96
completed ​
• Readonly completed: boolean
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:98
ready ​
• ready: boolean
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:99
error ​
• error: IObject
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:100
loading ​
• loading: boolean
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:101
isPlacehold ​
• Optional isPlacehold: boolean
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:103
parent ​
• Optional parent: ILeaferImage
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:106
childrenMap ​
• Optional childrenMap: ILeaferImageMap
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:107
filter ​
• Optional filter: any[]
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:109
filterKey ​
• Optional filterKey: string
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:110
largeThumb ​
• Optional largeThumb: ILeaferImageLevel
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:113
thumb ​
• Optional thumb: ILeaferImageLevel
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:114
levels ​
• Optional levels: ILeaferImageLevel[]
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:115
levelsRange ​
• Optional levelsRange: IRangeSize
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:116
minLevel ​
• Optional minLevel: number
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:117
loadId ​
• Optional loadId: ITaskItem
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:118
progress ​
• Optional progress: IProgressData
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:120
use ​
• use: number
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:122
config ​
• config: ILeaferImageConfig
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:123
Methods ​
load ​
â–¸ load(onSuccess?, onError?, thumbSize?): number
Parameters ​
| Name | Type |
|---|---|
onSuccess? | ILeaferImageOnLoaded |
onError? | ILeaferImageOnError |
thumbSize? | ISizeData |
Returns ​
number
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:125
unload ​
â–¸ unload(index, stopEvent?): void
Parameters ​
| Name | Type |
|---|---|
index | number |
stopEvent? | boolean |
Returns ​
void
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:126
getFull ​
â–¸ getFull(filters?): any
Parameters ​
| Name | Type |
|---|---|
filters? | IObject |
Returns ​
any
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:127
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
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:128
getPattern ​
â–¸ getPattern(canvas, repeat, transform?, paint?): CanvasPattern
Parameters ​
| Name | Type |
|---|---|
canvas | any |
repeat | string |
transform? | IMatrixData |
paint? | IObject |
Returns ​
CanvasPattern
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:129
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
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:131
getLoadUrl ​
â–¸ getLoadUrl(thumbSize?): string
Parameters ​
| Name | Type |
|---|---|
thumbSize? | ISizeData |
Returns ​
string
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:133
setThumbView ​
â–¸ setThumbView(view): void
Parameters ​
| Name | Type |
|---|---|
view | number |
Returns ​
void
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:134
getThumbSize ​
â–¸ getThumbSize(lod?): ISizeData
Parameters ​
| Name | Type |
|---|---|
lod? | IImageLOD |
Returns ​
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:135
getMinLevel ​
â–¸ getMinLevel(): number
Returns ​
number
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:137
getLevelData ​
â–¸ getLevelData(level, width?, height?): ILeaferImageLevel
Parameters ​
| Name | Type |
|---|---|
level | number |
width? | number |
height? | number |
Returns ​
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:138
clearLevels ​
â–¸ clearLevels(checkUse?): void
Parameters ​
| Name | Type |
|---|---|
checkUse? | boolean |
Returns ​
void
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:139
destroyFilter ​
â–¸ destroyFilter(): void
Returns ​
void
Inherited from ​
Defined in ​
src/leafer/packages/interface/src/image/ILeaferImage.ts:141
destroy ​
â–¸ destroy(): void
Returns ​
void