ComPDF React Native - v3.0.0
    Preparing search index...

    Class CPDFImageData

    Represents different types of image data for inserting into PDF.

    This class provides factory methods to create image data from various sources such as file paths, base64 strings, assets, or Android content URIs.

    Index

    Methods

    • Create image data from a file path.

      Parameters

      • filePath: string

        The absolute file path to the image

      Returns CPDFImageData

      CPDFImageData instance

      - Android:
      const imageData = CPDFImageData.fromPath('/data/user/0/com.example.app/cache/image.png');
      // file://
      const imageData = CPDFImageData.fromPath('file:///data/user/0/com.example.app/cache/image.png');
    • Create image data from a base64 encoded string.

      Parameters

      • base64String: string

        The base64 encoded image string

      Returns CPDFImageData

      CPDFImageData instance

      const imageData = CPDFImageData.fromBase64('iVBORw0KGgoAAAANSUhEUgAAAAUA...');
      
    • Create image data from a data URI string.

      Parameters

      • dataUri: string

        The data URI string

      Returns CPDFImageData

      CPDFImageData instance

      const imageData = CPDFImageData.fromDataUri('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA...');
      
    • Create image data from an asset path.

      Parameters

      • assetPath: string

        The asset path to the image (relative path in assets directory)

      Returns CPDFImageData

      CPDFImageData instance

      const imageData = CPDFImageData.fromAsset('logo.png');
      
    • Create image data from an Android content Uri. This method is only applicable on Android platform.

      Parameters

      • uri: string

        The Android content Uri to the image

      Returns CPDFImageData

      CPDFImageData instance

      const imageData = CPDFImageData.fromUri('content://media/external/images/media/1000');
      
    • Create image data from serialized JSON.

      Parameters

      • json: unknown

        Serialized image data object

      Returns CPDFImageData

      CPDFImageData instance

    • Convert the image data to a JSON object for native communication.

      Returns Record<string, any>

      JSON object containing type and data

    Properties

    data: string