Class Image<TNative, TProps>`Abstract`

Since

4.5.0

Type Parameters

TNative extends { [key: string]: any } = any
TProps extends MobileOSProps<ImageIOSProps, ImageAndroidProps> = MobileOSProps<ImageIOSProps, ImageAndroidProps>

Hierarchy

NativeMobileComponent<TNative, TProps>
- Image

Implements

IImage<TNative, TProps>

Index

Properties

`Protected` _nativeObject

_nativeObject: any

`Static` android

android: { createRoundedImage: any; createSystemIcon: any }

Type declaration

createRoundedImage:function
- createRoundedImage(params: undefined | string | number): null | IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>>
- Creates rounded image of given systemicon
  
  Android
  
  Static
  
  Method
  createSystemIcon
  
  See
  https://developer.android.com/reference/android/R.drawable
  
  Since
  4.0.2
  Parameters
  - params: undefined | string | number
  Returns null | IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>>
  - Defined in ui/image/image.ts:398
createSystemIcon:function
- createSystemIcon(icon: string | number): IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>>
- Creates an Image object which built-in icon is created corresponding systemIcon value. This method is Android only.
  
  Android
  
  Static
  
  Method
  createSystemIcon
  
  See
  https://developer.android.com/reference/android/R.drawable
  
  Since
  4.0.2
  Parameters
  - icon: string | number
  Returns IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>>
  - Defined in ui/image/image.ts:410

`Static` Format

Format: typeof Format

`Static` `Readonly` iOS

iOS: { RenderingMode: typeof RenderingMode; Format: typeof Format } = ...

iOS Specific Properties.

Since

3.1.3

Type declaration

RenderingMode: typeof RenderingMode
Format: typeof Format

Accessors

nativeObject

get nativeObject(): any
Returns any
Implementation of IImage.nativeObject

Inherited from NativeMobileComponent.nativeObject
- Defined in core/native-component.ts:11
set nativeObject(value: any): void
Parameters
- value: any
Returns void
Implementation of IImage.nativeObject

Inherited from NativeMobileComponent.nativeObject
- Defined in core/native-component.ts:15

ios

get ios(): TProps["ios"]
Returns TProps["ios"]
Implementation of IImage.ios

Inherited from NativeMobileComponent.ios
- Defined in core/native-mobile-component.ts:49

android

get android(): TProps["android"]
Returns TProps["android"]
Implementation of IImage.android

Inherited from NativeMobileComponent.android
- Defined in core/native-mobile-component.ts:52

height

get height(): number
Gets the height of image in pixels.

Android

Ios

Property

Since
0.1

Returns number
Implementation of IImage.height
- Defined in ui/image/image.ts:351

width

get width(): number
Gets the width of image in pixels.

Android

Ios

Property

Since
0.1

Returns number
Implementation of IImage.width
- Defined in ui/image/image.ts:354

autoMirrored

get autoMirrored(): boolean
Gets/Sets the autoMirrored of image. This property sets direction of Image automatically related to system or application direction.

Ios

Android

Property

Since
3.1.3

Returns boolean
Implementation of IImage.autoMirrored
- Defined in ui/image/image.ts:365
set autoMirrored(value: boolean): void
Gets/Sets the autoMirrored of image. This property sets direction of Image automatically related to system or application direction.

Ios

Android

Property

Since
3.1.3
Parameters
- value: boolean
Returns void
Implementation of IImage.autoMirrored
- Defined in ui/image/image.ts:376

Methods

`Protected` preConstruct

preConstruct(params?: Partial<Record<string, any>>): void
Parameters
- Optional params: Partial<Record<string, any>>
Returns void
Inherited from NativeMobileComponent.preConstruct
- Defined in core/native-mobile-component.ts:33

`Protected` addAndroidProps

addAndroidProps(props: TProps["android"]): void
Parameters
- props: TProps["android"]
Returns void
Inherited from NativeMobileComponent.addAndroidProps
- Defined in core/native-mobile-component.ts:43

`Protected` addIOSProps

addIOSProps(props: TProps["ios"]): void
Parameters
- props: TProps["ios"]
Returns void
Inherited from NativeMobileComponent.addIOSProps
- Defined in core/native-mobile-component.ts:46

compress

compress(format: Format, quality: number, onSuccess?: ((e: { blob: IBlob<any, MobileOSProps<{}, IBlobAndroidProps>> }) => void), onFailure?: ((e?: { message: string }) => void)): null | void | IBlob<any, MobileOSProps<{}, IBlobAndroidProps>>
Returns a compressed blob from existing image with given quality. onSuccess and onFailure are optional parameters.

Example
```
import Image from '@smartface/native/ui/image';
    var myImage = Image.createFromFile("images://smartface.png")
    var myBlob = myImage.compress(Image.Format.JPEG, 50);
    var myCompressedImage = Image.createFromBlob(myBlob);
```
Method
compress

Returns
Blob

Android

Ios

Since
0.1
Parameters
- format: Format
  
  Image format.
- quality: number
  
  Image quality is between 0 and 100.
- Optional onSuccess: ((e: { blob: IBlob<any, MobileOSProps<{}, IBlobAndroidProps>> }) => void)
  
  Callback for success situation.
  - - (e: { blob: IBlob<any, MobileOSProps<{}, IBlobAndroidProps>> }): void
    - Parameters
      
      e: { blob: IBlob<any, MobileOSProps<{}, IBlobAndroidProps>> }
      
      blob: IBlob<any, MobileOSProps<{}, IBlobAndroidProps>>
      
      Returns void
- Optional onFailure: ((e?: { message: string }) => void)
  
  Callback for failure situation.
  - - (e?: { message: string }): void
    - Parameters
      
      Optional e: { message: string }
      
      message: string
      
      Returns void
Returns null | void | IBlob<any, MobileOSProps<{}, IBlobAndroidProps>>
Implementation of IImage.compress
- Defined in ui/image/image.ts:338

rotate

rotate(angle: number, onSuccess?: ((e: { image: IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>> }) => void), onFailure?: ((e?: { message: string }) => void)): null | void | IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>>
Returns a rotated image with given angle. Rotate direction is clockwise and angle is between 0-360. onSuccess and onFailure are optional parameters.

Method
rotate

Returns
UI.Image

Android

Ios

Since
0.1
Parameters
- angle: number
  
  The angle value of the rectangle top-left corner.
- Optional onSuccess: ((e: { image: IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>> }) => void)
  
  Callback for success situation.
  - - (e: { image: IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>> }): void
    - Parameters
      
      e: { image: IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>> }
      
      image: IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>>
      
      Returns void
- Optional onFailure: ((e?: { message: string }) => void)
  
  Callback for failure situation.
  - - (e?: { message: string }): void
    - Parameters
      
      Optional e: { message: string }
      
      message: string
      
      Returns void
Returns null | void | IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>>
Implementation of IImage.rotate
- Defined in ui/image/image.ts:341

resize

resize(width: number, height: number, onSuccess?: ((e: { image: IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>> }) => void), onFailure?: ((e?: { message: string }) => void)): null | void | IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>>
Creates a new image from existing image with specified width and height. onSuccess and onFailure are optional parameters.

Example
```
import Image from '@smartface/native/ui/image';
    import ImageView from '@smartface/native/ui/imageview';
    var myImage = Image.createFromFile("images://smartface.png")
    var myImageView = new ImageView();
    myImageView.image = myImage.resize(myImage.width/2, myImage.height/2); // resize example without callback


    import Image from '@smartface/native/ui/image';
    import ImageView from '@smartface/native/ui/imageview';
    var myImage = Image.createFromFile("images://smartface.png")
    var myImageView = new ImageView();
    myImage.resize(myImage.width/2, myImage.height/2, onSuccess);

    function onSuccess(e) {
        myImageView.image = e.image
    }
```
Method
resize

Returns
UI.Image

Android

Ios

Since
0.1
Parameters
- width: number
  
  Width pixels of the new bitmap.
- height: number
  
  Height pixels of the new bitmap.
- Optional onSuccess: ((e: { image: IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>> }) => void)
  
  Callback for success situation.
  - - (e: { image: IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>> }): void
    - Parameters
      
      e: { image: IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>> }
      
      image: IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>>
      
      Returns void
- Optional onFailure: ((e?: { message: string }) => void)
  
  Callback for failure situation.
  - - (e?: { message: string }): void
    - Parameters
      
      Optional e: { message: string }
      
      message: string
      
      Returns void
Returns null | void | IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>>
Implementation of IImage.resize
- Defined in ui/image/image.ts:344

crop

crop(x: number, y: number, width: number, height: number, onSuccess: ((e: { image: IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>> }) => void), onFailure: ((e?: { message: string }) => void)): null | void | IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>>
Returns a cropped image from existing image with specified rectangle. onSuccess and onFailure are optional parameters.

Method
crop

Returns
UI.Image

Android

Ios

Since
0.1
Parameters
- x: number
  
  The x pixels of the rectangle top-left corner.
- y: number
  
  The y pixels of the rectangle top-left corner.
- width: number
  
  Width pixels of the new bitmap.
- height: number
  
  Height pixels of the new bitmap.
- onSuccess: ((e: { image: IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>> }) => void)
  
  Callback for success situation.
  - - (e: { image: IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>> }): void
    - Parameters
      
      e: { image: IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>> }
      
      image: IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>>
      
      Returns void
- onFailure: ((e?: { message: string }) => void)
  
  Callback for failure situation.
  - - (e?: { message: string }): void
    - Parameters
      
      Optional e: { message: string }
      
      message: string
      
      Returns void
Returns null | void | IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>>
Implementation of IImage.crop
- Defined in ui/image/image.ts:347

toBlob

toBlob(): null | IBlob<any, MobileOSProps<{}, IBlobAndroidProps>>
Returns a Blob instance.

Android

Ios

Method
toBlob

Returns
Blob

Since
0.1

Returns null | IBlob<any, MobileOSProps<{}, IBlobAndroidProps>>
Implementation of IImage.toBlob
- Defined in ui/image/image.ts:380

toString

toString(): string
Returns string
- Defined in ui/image/image.ts:384

`Static` createFromBlob

createFromBlob(blob: IBlob<any, MobileOSProps<{}, IBlobAndroidProps>>): null | IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>>
Creates an image object from given a blob.

Method
createFromBlob

Returns
UI.Image

Static

Android

Ios

Since
0.1
Parameters
- blob: IBlob<any, MobileOSProps<{}, IBlobAndroidProps>>
  
  Contains image datas.
Returns null | IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>>
- Defined in ui/image/image.ts:424

`Static` createFromImage

createFromImage(image: any): IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>>
Used privately inside framework Creates an image object from image.nativeobject.

Method
createFromImage

Returns
UI.Image

Static

Android

Ios

Since
0.1
Parameters
- image: any
  
  Contains image datas.
Returns IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>>
- Defined in ui/image/image.ts:440

`Static` createImageFromPath

createImageFromPath(path: string | IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>>): IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>>
Used privately inside framework Creates an image object from file path or image.

Method
createImageFromPath

Returns
UI.Image

Static

Android

Ios

Since
0.1
Parameters
- path: string | IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>>
  
  Contains image datas.
Returns IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>>
- Defined in ui/image/image.ts:458

`Static` createRoundedImage

createRoundedImage(params: { path: string; radius?: number }): IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>>
Creates a rounded image object from given path. This method works for only Android. It returns undefined for iOS.

Method
createRoundedImage

Returns
UI.Image

Static

Android

Since
2.0.10
Parameters
- params: { path: string; radius?: number }
  - path: string
    
    Image path
  - Optional radius?: number
    
    Image corner radius
Returns IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>>
- Defined in ui/image/image.ts:474

`Static` createFromFile

createFromFile(path: string, width?: number, height?: number): null | IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>>
Creates an Image instance from given file path. Large bitmap loading causes OutOfMemory exception on Android. width and height parameters works for only Android. No-op for iOS. These parameters are used loading large bitmaps efficiently. If you pass these parameters, the bitmap will scaled down.

Example
```
import Image from '@smartface/native/ui/image';
    var myImage = Image.createFromFile("images://smartface.png");
```
Method
createFromFile

Returns
An Image instance.

Android

Ios

Static

Since
0.1

See
https://developer.android.com/topic/performance/graphics/load-bitmap.html
Parameters
- path: string
  
  Image file path
- Optional width: number
  
  Width in pixels
- Optional height: number
  
  Height in pixels
Returns null | IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>>
- Defined in ui/image/image.ts:498

`Protected` createNativeObject

createNativeObject(): void
Returns void
Overrides NativeMobileComponent.createNativeObject
- Defined in ui/image/image.ts:509

Constructors

constructor

new AbstractImage<TNative, TProps>(params?: ImageParams): Image<TNative, TProps>
Type Parameters
- TNative extends { [key: string]: any } = any
- TProps extends MobileOSProps<ImageIOSProps, ImageAndroidProps> = MobileOSProps<ImageIOSProps, ImageAndroidProps>
Parameters
- Optional params: ImageParams
Returns Image<TNative, TProps>
Overrides NativeMobileComponent<TNative, TProps>.constructor
- Defined in ui/image/image.ts:335

Class Image<TNative, TProps>Abstract

Since

Type Parameters

TNative extends { [key: string]: any } = any

TProps extends MobileOSProps<ImageIOSProps, ImageAndroidProps> = MobileOSProps<ImageIOSProps, ImageAndroidProps>

Hierarchy

Implements

Index

Properties

Accessors

Methods

Constructors

Properties

Protected _nativeObject

Static android

Type declaration

createRoundedImage:function

Android

Static

Method

See

Since

Parameters

params: undefined | string | number

Returns null | IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>>

createSystemIcon:function

Android

Static

Method

See

Since

Parameters

icon: string | number

Returns IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>>

Static Format

Static Readonly iOS

Since

Type declaration

RenderingMode: typeof RenderingMode

Format: typeof Format

Accessors

nativeObject

Returns any

Parameters

value: any

Returns void

ios

Returns TProps["ios"]

android

Returns TProps["android"]

height

Android

Ios

Property

Since

Returns number

width

Android

Ios

Property

Since

Returns number

autoMirrored

Ios

Android

Property

Since

Returns boolean

Ios

Android

Property

Since

Parameters

value: boolean

Returns void

Methods

Protected preConstruct

Parameters

Optional params: Partial<Record<string, any>>

Returns void

Class Image<TNative, TProps>`Abstract`

`Protected` _nativeObject

`Static` android

`Static` Format

`Static` `Readonly` iOS

`Protected` preConstruct

`Optional` params: Partial<Record<string, any>>

`Protected` addAndroidProps

`Protected` addIOSProps

`Optional` onSuccess: ((e: { blob: IBlob<any, MobileOSProps<{}, IBlobAndroidProps>> }) => void)

`Optional` onFailure: ((e?: { message: string }) => void)

`Optional` e: { message: string }

`Optional` onSuccess: ((e: { image: IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>> }) => void)

`Optional` onFailure: ((e?: { message: string }) => void)

`Optional` e: { message: string }

`Optional` onSuccess: ((e: { image: IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>> }) => void)

`Optional` onFailure: ((e?: { message: string }) => void)

`Optional` e: { message: string }