Skip to content

Interface: ILeaferVideo โ€‹

Hierarchy โ€‹

Implemented by โ€‹

Table of contents โ€‹

Properties โ€‹

Methods โ€‹

Properties โ€‹

innerId โ€‹

โ€ข Readonly innerId: number

Inherited from โ€‹

ILeaferImage.innerId

Defined in โ€‹

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


url โ€‹

โ€ข Readonly url: string

Inherited from โ€‹

ILeaferImage.url

Defined in โ€‹

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


lod โ€‹

โ€ข Optional lod: IImageLOD

Inherited from โ€‹

ILeaferImage.lod

Defined in โ€‹

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


crossOrigin โ€‹

โ€ข Readonly crossOrigin: IImageCrossOrigin

Inherited from โ€‹

ILeaferImage.crossOrigin

Defined in โ€‹

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


view โ€‹

โ€ข view: any

Inherited from โ€‹

ILeaferImage.view

Defined in โ€‹

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


width โ€‹

โ€ข width: number

Inherited from โ€‹

ILeaferImage.width

Defined in โ€‹

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


height โ€‹

โ€ข height: number

Inherited from โ€‹

ILeaferImage.height

Defined in โ€‹

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


isSVG โ€‹

โ€ข isSVG: boolean

Inherited from โ€‹

ILeaferImage.isSVG

Defined in โ€‹

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


hasAlphaPixel โ€‹

โ€ข hasAlphaPixel: boolean

Inherited from โ€‹

ILeaferImage.hasAlphaPixel

Defined in โ€‹

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


completed โ€‹

โ€ข Readonly completed: boolean

Inherited from โ€‹

ILeaferImage.completed

Defined in โ€‹

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


ready โ€‹

โ€ข ready: boolean

Inherited from โ€‹

ILeaferImage.ready

Defined in โ€‹

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


error โ€‹

โ€ข error: IObject

Inherited from โ€‹

ILeaferImage.error

Defined in โ€‹

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


loading โ€‹

โ€ข loading: boolean

Inherited from โ€‹

ILeaferImage.loading

Defined in โ€‹

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


isPlacehold โ€‹

โ€ข Optional isPlacehold: boolean

Inherited from โ€‹

ILeaferImage.isPlacehold

Defined in โ€‹

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


parent โ€‹

โ€ข Optional parent: ILeaferImage

Inherited from โ€‹

ILeaferImage.parent

Defined in โ€‹

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


childrenMap โ€‹

โ€ข Optional childrenMap: ILeaferImageMap

Inherited from โ€‹

ILeaferImage.childrenMap

Defined in โ€‹

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


filterKey โ€‹

โ€ข Optional filterKey: string

Inherited from โ€‹

ILeaferImage.filterKey

Defined in โ€‹

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


largeThumb โ€‹

โ€ข Optional largeThumb: ILeaferImageLevel

Inherited from โ€‹

ILeaferImage.largeThumb

Defined in โ€‹

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


thumb โ€‹

โ€ข Optional thumb: ILeaferImageLevel

Inherited from โ€‹

ILeaferImage.thumb

Defined in โ€‹

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


levels โ€‹

โ€ข Optional levels: ILeaferImageLevel[]

Inherited from โ€‹

ILeaferImage.levels

Defined in โ€‹

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


levelsRange โ€‹

โ€ข Optional levelsRange: IRangeSize

Inherited from โ€‹

ILeaferImage.levelsRange

Defined in โ€‹

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


minLevel โ€‹

โ€ข Optional minLevel: number

Inherited from โ€‹

ILeaferImage.minLevel

Defined in โ€‹

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


loadId โ€‹

โ€ข Optional loadId: ITaskItem

Inherited from โ€‹

ILeaferImage.loadId

Defined in โ€‹

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


progress โ€‹

โ€ข Optional progress: IProgressData

Inherited from โ€‹

ILeaferImage.progress

Defined in โ€‹

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


use โ€‹

โ€ข use: number

Inherited from โ€‹

ILeaferImage.use

Defined in โ€‹

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


config โ€‹

โ€ข config: ILeaferImageConfig

Inherited from โ€‹

ILeaferImage.config

Defined in โ€‹

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

Methods โ€‹

load โ€‹

โ–ธ load(onSuccess?, onError?, thumbSize?): number

Parameters โ€‹

NameType
onSuccess?ILeaferImageOnLoaded
onError?ILeaferImageOnError
thumbSize?ISizeData

Returns โ€‹

number

Inherited from โ€‹

ILeaferImage.load

Defined in โ€‹

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


unload โ€‹

โ–ธ unload(index, stopEvent?): void

Parameters โ€‹

NameType
indexnumber
stopEvent?boolean

Returns โ€‹

void

Inherited from โ€‹

ILeaferImage.unload

Defined in โ€‹

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


getFull โ€‹

โ–ธ getFull(filters?): any

Parameters โ€‹

NameType
filters?IObject

Returns โ€‹

any

Inherited from โ€‹

ILeaferImage.getFull

Defined in โ€‹

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


getCanvas โ€‹

โ–ธ getCanvas(width, height, opacity?, filters?, xGap?, yGap?, smooth?, interlace?): any

Parameters โ€‹

NameType
widthnumber
heightnumber
opacity?number
filters?IObject
xGap?number
yGap?number
smooth?boolean
interlace?IInterlace

Returns โ€‹

any

Inherited from โ€‹

ILeaferImage.getCanvas

Defined in โ€‹

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


getPattern โ€‹

โ–ธ getPattern(canvas, repeat, transform?, paint?): CanvasPattern

Parameters โ€‹

NameType
canvasany
repeatstring
transform?IMatrixData
paint?IObject

Returns โ€‹

CanvasPattern

Inherited from โ€‹

ILeaferImage.getPattern

Defined in โ€‹

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


render โ€‹

โ–ธ render(canvas, x, y, width, height, leaf, paint, imageScaleX, imageScaleY): void

Parameters โ€‹

NameType
canvasany
xnumber
ynumber
widthnumber
heightnumber
leafILeaf
paintany
imageScaleXnumber
imageScaleYnumber

Returns โ€‹

void

Inherited from โ€‹

ILeaferImage.render

Defined in โ€‹

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


getLoadUrl โ€‹

โ–ธ getLoadUrl(thumbSize?): string

Parameters โ€‹

NameType
thumbSize?ISizeData

Returns โ€‹

string

Inherited from โ€‹

ILeaferImage.getLoadUrl

Defined in โ€‹

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


setThumbView โ€‹

โ–ธ setThumbView(view): void

Parameters โ€‹

NameType
viewnumber

Returns โ€‹

void

Inherited from โ€‹

ILeaferImage.setThumbView

Defined in โ€‹

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


getThumbSize โ€‹

โ–ธ getThumbSize(lod?): ISizeData

Parameters โ€‹

NameType
lod?IImageLOD

Returns โ€‹

ISizeData

Inherited from โ€‹

ILeaferImage.getThumbSize

Defined in โ€‹

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


getMinLevel โ€‹

โ–ธ getMinLevel(): number

Returns โ€‹

number

Inherited from โ€‹

ILeaferImage.getMinLevel

Defined in โ€‹

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


getLevelData โ€‹

โ–ธ getLevelData(level, width?, height?): ILeaferImageLevel

Parameters โ€‹

NameType
levelnumber
width?number
height?number

Returns โ€‹

ILeaferImageLevel

Inherited from โ€‹

ILeaferImage.getLevelData

Defined in โ€‹

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


clearLevels โ€‹

โ–ธ clearLevels(checkUse?): void

Parameters โ€‹

NameType
checkUse?boolean

Returns โ€‹

void

Inherited from โ€‹

ILeaferImage.clearLevels

Defined in โ€‹

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


destroyFilter โ€‹

โ–ธ destroyFilter(): void

Returns โ€‹

void

Inherited from โ€‹

ILeaferImage.destroyFilter

Defined in โ€‹

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


destroy โ€‹

โ–ธ destroy(): void

Returns โ€‹

void

Inherited from โ€‹

ILeaferImage.destroy

Defined in โ€‹

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

Released under the MIT License.