Class ImageRef

Optional Readonly uniqueId

buffer

• get buffer(): undefined | string

• Returns undefined | string

clear

• clear(): Promise<void>

• Releases native resources stored by the ref. If two different ImageRef objects have the same uniqueId both of them become cleared. If uniqueId is not set or the image is already released, an exception will be thrown.

  Returns Promise<void>

encodeImage

• encodeImage(options?): Promise<null | string>

• Returns the stored image as base64.

  Parameters

  • Optional options: EncodeImageOptions

  Returns Promise<null | string>

encodeInPlace

• encodeInPlace(): Promise<void>

• Encode image.

  Returns Promise<void>

hibernate

• hibernate(): Promise<void>

• Compresses ImageRef and stores it either on disk or in memory according to global settings. If uniqueId is not set or the image is already released, an exception will be thrown.

  Returns Promise<void>

info

• info(): Promise<null | ImageInfo>

• Information about stored image as reference. If uniqueId is not set or the image is already released, an exception will be thrown.

  Returns Promise<null | ImageInfo>

release

• release(): void

• Releases strong reference to the image. If uniqueId to the image is not set, an exception will be thrown.

  Returns void

saveImage

• saveImage(path, options?): Promise<boolean>

• Saves the stored image with the given options. Returns true if the operation was successful, false otherwise. If uniqueId is not set or the image is already released, an exception will be thrown.

  Parameters

  • path: string
  • Optional options: SaveImageOptions

  Returns Promise<boolean>

serialize

• serialize(imageSerializationMode): Promise<{
      buffer: undefined | string;
      uniqueId?: string;
      clear?(): Promise<void>;
      encodeImage?(options?): Promise<null | string>;
      encodeInPlace?(): Promise<void>;
      hibernate?(): Promise<void>;
      info?(): Promise<null | ImageInfo>;
      isRetained?(): boolean;
      release?(): void;
      retain?(): void;
      saveImage?(path, options?): Promise<boolean>;
      serialize?(imageSerializationMode): Promise<{ readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<...>) | undefined; ... 8 more ...; retain?: (() => void) | undefined; }>;
  }>

• Converts the Image Ref to Json representation or throws an exception if serialization fails.

  Parameters

  • imageSerializationMode: ImageSerializationMode

  Returns Promise<{
      buffer: undefined | string;
      uniqueId?: string;
      clear?(): Promise<void>;
      encodeImage?(options?): Promise<null | string>;
      encodeInPlace?(): Promise<void>;
      hibernate?(): Promise<void>;
      info?(): Promise<null | ImageInfo>;
      isRetained?(): boolean;
      release?(): void;
      retain?(): void;
      saveImage?(path, options?): Promise<boolean>;
      serialize?(imageSerializationMode): Promise<{ readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<...>) | undefined; ... 8 more ...; retain?: (() => void) | undefined; }>;
  }>

Static deserialize

• deserialize(serializedRef): ImageRef

• This method is used to deserialize an ImageRef from a serialized representation with a uniqueId. If the uniqueId is not present, it throws an InvalidImageRefError.

  Parameters

  • serializedRef: {
        buffer: undefined | string;
        uniqueId?: string;
        clear?(): Promise<void>;
        encodeImage?(options?): Promise<null | string>;
        encodeInPlace?(): Promise<void>;
        hibernate?(): Promise<void>;
        info?(): Promise<null | ImageInfo>;
        isRetained?(): boolean;
        release?(): void;
        retain?(): void;
        saveImage?(path, options?): Promise<boolean>;
        serialize?(imageSerializationMode): Promise<({ readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<...>) | undefined; ... 8 more ...; retain?: (() => void) | undefined; })>;
    }

    • buffer: undefined | string

    • Optional Readonly uniqueId?: string

    • clear?:function

      • clear(): Promise<void>

      • Releases native resources stored by the ref. If two different ImageRef objects have the same uniqueId both of them become cleared. If uniqueId is not set or the image is already released, an exception will be thrown.

        Returns Promise<void>

    • encodeImage?:function

      • encodeImage(options?): Promise<null | string>

      • Returns the stored image as base64.

        Parameters

        • Optional options: EncodeImageOptions

        Returns Promise<null | string>

    • encodeInPlace?:function

      • encodeInPlace(): Promise<void>

      • Encode image.

        Returns Promise<void>

    • hibernate?:function

      • hibernate(): Promise<void>

      • Compresses ImageRef and stores it either on disk or in memory according to global settings. If uniqueId is not set or the image is already released, an exception will be thrown.

        Returns Promise<void>

    • info?:function

      • info(): Promise<null | ImageInfo>

      • Information about stored image as reference. If uniqueId is not set or the image is already released, an exception will be thrown.

        Returns Promise<null | ImageInfo>

    • isRetained?:function

      • isRetained(): boolean

      • Returns boolean

    • release?:function

      • release(): void

      • Releases strong reference to the image. If uniqueId to the image is not set, an exception will be thrown.

        Returns void

    • retain?:function

      • retain(): void

      • Returns void

    • saveImage?:function

      • saveImage(path, options?): Promise<boolean>

      • Saves the stored image with the given options. Returns true if the operation was successful, false otherwise. If uniqueId is not set or the image is already released, an exception will be thrown.

        Parameters

        • path: string
        • Optional options: SaveImageOptions

        Returns Promise<boolean>

    • serialize?:function

      • serialize(imageSerializationMode): Promise<({ readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<...>) | undefined; ... 8 more ...; retain?: (() => void) | undefined; })>

      • Converts the Image Ref to Json representation or throws an exception if serialization fails.

        Parameters

        • imageSerializationMode: ImageSerializationMode

        Returns Promise<({ readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<...>) | undefined; ... 8 more ...; retain?: (() => void) | undefined; })>

  Returns ImageRef

Static from

• from(source): ImageRef

• Parameters

  • source: {
        buffer: undefined | string;
        uniqueId?: string;
        clear?(): Promise<void>;
        encodeImage?(options?): Promise<null | string>;
        encodeInPlace?(): Promise<void>;
        hibernate?(): Promise<void>;
        info?(): Promise<null | ImageInfo>;
        isRetained?(): boolean;
        release?(): void;
        retain?(): void;
        saveImage?(path, options?): Promise<boolean>;
        serialize?(imageSerializationMode): Promise<({ readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<...>) | undefined; ... 8 more ...; retain?: (() => void) | undefined; })>;
    }

    • buffer: undefined | string

    • Optional Readonly uniqueId?: string

    • clear?:function

      • clear(): Promise<void>

      • Releases native resources stored by the ref. If two different ImageRef objects have the same uniqueId both of them become cleared. If uniqueId is not set or the image is already released, an exception will be thrown.

        Returns Promise<void>

    • encodeImage?:function

      • encodeImage(options?): Promise<null | string>

      • Returns the stored image as base64.

        Parameters

        • Optional options: EncodeImageOptions

        Returns Promise<null | string>

    • encodeInPlace?:function

      • encodeInPlace(): Promise<void>

      • Encode image.

        Returns Promise<void>

    • hibernate?:function

      • hibernate(): Promise<void>

      • Compresses ImageRef and stores it either on disk or in memory according to global settings. If uniqueId is not set or the image is already released, an exception will be thrown.

        Returns Promise<void>

    • info?:function

      • info(): Promise<null | ImageInfo>

      • Information about stored image as reference. If uniqueId is not set or the image is already released, an exception will be thrown.

        Returns Promise<null | ImageInfo>

    • isRetained?:function

      • isRetained(): boolean

      • Returns boolean

    • release?:function

      • release(): void

      • Releases strong reference to the image. If uniqueId to the image is not set, an exception will be thrown.

        Returns void

    • retain?:function

      • retain(): void

      • Returns void

    • saveImage?:function

      • saveImage(path, options?): Promise<boolean>

      • Saves the stored image with the given options. Returns true if the operation was successful, false otherwise. If uniqueId is not set or the image is already released, an exception will be thrown.

        Parameters

        • path: string
        • Optional options: SaveImageOptions

        Returns Promise<boolean>

    • serialize?:function

      • serialize(imageSerializationMode): Promise<({ readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<...>) | undefined; ... 8 more ...; retain?: (() => void) | undefined; })>

      • Converts the Image Ref to Json representation or throws an exception if serialization fails.

        Parameters

        • imageSerializationMode: ImageSerializationMode

        Returns Promise<({ readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<...>) | undefined; ... 8 more ...; retain?: (() => void) | undefined; })>

  Returns ImageRef

Static fromEncodedBuffer

• fromEncodedBuffer(buffer, options?): Promise<null | ImageRef>

• Creates ImageRef with uniqueId from base64 encoded buffer, e.g. from jpeg.

  Parameters

  • buffer: string
  • Optional options: BufferImageLoadOptions

  Returns Promise<null | ImageRef>

Static fromImageFileUri

• fromImageFileUri(uri, options?): Promise<null | ImageRef>

• Creates ImageRef with uniqueId from the file uri to an image.

  Parameters

  • uri: string
  • Optional options: PathImageLoadOptions

  Returns Promise<null | ImageRef>

Static makeSnapshot

• makeSnapshot(): Promise<null | ImageRefPoolSnapshot>

• Returns a snapshot of all alive ImageRefs. The snapshot contains a list of ImageRefs with information such as in-memory size.

  Returns Promise<null | ImageRefPoolSnapshot>

Static releaseAll

• releaseAll(): void

• Releases all alive images despite any existing references.

  Returns void