Preview 2.0 is now in Public Beta!
Read the Announcement
ImageSource

Summary

Constructors

constructor

new ImageSource(nativeSource?: any): ImageSource
Parameter Default Description
nativeSource
any

Returns ImageSource

Properties

android

height

rotationAngle

rotationAngle: number

Methods

fromAsset

fromAsset(asset: ImageAsset): Promise<ImageSource>
Parameter Default Description
asset

Returns Promise<ImageSource>

fromBase64

fromBase64(source: string): Promise<boolean>
Parameter Default Description
source
string

Returns Promise<boolean>

fromData

fromData(data: any): Promise<boolean>
Parameter Default Description
data
any

Returns Promise<boolean>

fromFile

fromFile(path: string): Promise<boolean>
Parameter Default Description
path
string

Returns Promise<boolean>

fromResource

fromResource(name: string): Promise<boolean>
Parameter Default Description
name
string

Returns Promise<boolean>

loadFromBase64

loadFromBase64(source: string): boolean
Parameter Default Description
source
string

Returns boolean

loadFromData

loadFromData(data: any): boolean
Parameter Default Description
data
any

Returns boolean

loadFromFile

loadFromFile(path: string): boolean
Parameter Default Description
path
string

Returns boolean

loadFromFontIconCode

loadFromFontIconCode(source: string, font: Font, color: Color): boolean
Parameter Default Description
source
string

font

color

Returns boolean

loadFromResource

loadFromResource(name: string): boolean
Parameter Default Description
name
string

Returns boolean

resize

resize(maxSize: number, options?: any): ImageSource
Parameter Default Description
maxSize
number

options
any

Returns ImageSource

resizeAsync

resizeAsync(maxSize: number, options?: any): Promise<ImageSource>
Parameter Default Description
maxSize
number

options
any

Returns Promise<ImageSource>

saveToFile

saveToFile(
  path: string,
  format: "png" | "jpeg" | "jpg",
  quality?: number
): boolean
Parameter Default Description
path
string

format
"png" | "jpeg" | "jpg"

quality
number

Returns boolean

saveToFileAsync

saveToFileAsync(path: string, format: "png" | "jpeg" | "jpg", quality?: number): Promise<boolean>
Parameter Default Description
path
string

format
"png" | "jpeg" | "jpg"

quality
number

Returns Promise<boolean>

setNativeSource

setNativeSource(nativeSource: any): void
Parameter Default Description
nativeSource
any

Returns void

toBase64String

toBase64String(format: "png" | "jpeg" | "jpg", quality?: number): string
Parameter Default Description
format
"png" | "jpeg" | "jpg"

quality
number

Returns string

toBase64StringAsync

toBase64StringAsync(format: "png" | "jpeg" | "jpg", quality?: number): Promise<string>
Parameter Default Description
format
"png" | "jpeg" | "jpg"

quality
number

Returns Promise<string>

fromAsset

Static
fromAsset(asset: ImageAsset): Promise<ImageSource>
Parameter Default Description
asset

Returns Promise<ImageSource>

fromBase64

Static
fromBase64(source: string): Promise<ImageSource>
Parameter Default Description
source
string

Returns Promise<ImageSource>

fromBase64Sync

Static
fromBase64Sync(source: string): ImageSource
Parameter Default Description
source
string

Returns ImageSource

fromData

Static
fromData(data: any): Promise<ImageSource>
Parameter Default Description
data
any

Returns Promise<ImageSource>

fromDataSync

Static
fromDataSync(data: any): ImageSource
Parameter Default Description
data
any

Returns ImageSource

fromFile

Static
fromFile(path: string): Promise<ImageSource>
Parameter Default Description
path
string

Returns Promise<ImageSource>

fromFileOrResourceSync

Static
fromFileOrResourceSync(path: string): ImageSource
Parameter Default Description
path
string

Returns ImageSource

fromFileSync

Static
fromFileSync(path: string): ImageSource
Parameter Default Description
path
string

Returns ImageSource

fromFontIconCodeSync

Static
fromFontIconCodeSync(source: string, font: Font, color: Color): ImageSource
Parameter Default Description
source
string

font

color

Returns ImageSource

fromResource

Static
fromResource(name: string): Promise<ImageSource>
Parameter Default Description
name
string

Returns Promise<ImageSource>

fromResourceSync

Static
fromResourceSync(name: string): ImageSource
Parameter Default Description
name
string

Returns ImageSource

fromUrl

Static
fromUrl(url: string): Promise<ImageSource>
Parameter Default Description
url
string

Returns Promise<ImageSource>
Previous
ImageCache