Pdfx

https://pub.dev/packages/pdfx
Admin
Pdfx is a Flutter plugin designed to render and display PDF documents as images across multiple...
Tokens:15,319
Snippets:103
Trust Score:9.9
Update:2 days ago
Show doc for...
Tokens:
Raw
### Installation Commands

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Commands to add the pdfx dependency and run setup tools for web and Windows platforms.

```APIDOC
## Installation

### Add dependency
```shell
flutter pub add pdfx
```

### Setup for web
```shell
dart run pdfx:install_web
```

### Setup for Windows
```shell
dart run pdfx:install_windows
```
```

--------------------------------

### Usage Example

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Example code demonstrating how to create PdfControllerPinch and PdfController instances and use them with PdfViewPinch and PdfView widgets.

```APIDOC
## Usage Example

```dart
import 'package:pdfx/pdfx.dart';

final pdfPinchController = PdfControllerPinch(
  document: PdfDocument.openAsset('assets/sample.pdf'),
);

// Pdf view with re-render pdf texture on zoom (not loose quality on zoom)
// Not supported on windows
PdfViewPinch(
  controller: pdfPinchController,
);

//-- or --//

final pdfController = PdfController(
  document: PdfDocument.openAsset('assets/sample.pdf'),
);

// Simple Pdf view with one render of page (loose quality on zoom)
PdfView(
  controller: pdfController,
);
```
```

--------------------------------

### Install web pdfjs library

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Run this tool to automatically add the pdfjs library (CDN) to index.html for web support.

```shell
dart run pdfx:install_web
```

--------------------------------

### Install internet_file package for network document

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Command to add the internet_file package, which supports all platforms and is required for opening network documents.

```shell
flutter pub add internet_file
```

--------------------------------

### Install Windows pdfium override

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Run this tool to automatically add an override for the pdfium version property in CMakeLists.txt for Windows support.

```shell
dart run pdfx:install_windows
```

--------------------------------

### Page control methods: jumpTo, animateToPage, nextPage, previousPage, documentProgress

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Shows how to control page navigation and get document progress. jumpTo jumps to a page, animateToPage animates to a page, nextPage/previousPage animate to adjacent pages, and documentProgress returns a value from 0.0 (start) to 1.0 (end).

```dart
// Jump to specified page
pdfController.jumpTo(3);

// Animate to specified page
_pdfController.animateToPage(3, duration: Duration(milliseconds: 250), curve: Curves.ease);

// Animate to next page
_pdfController.nextPage(duration: Duration(milliseconds: 250), curve: Curves.easeIn);

// Animate to previous page
_pdfController.previousPage(duration: Duration(milliseconds: 250), curve: Curves.easeOut);

// Get document progrees 0.0 - start, 1.0 - end
_pdfController.documentProgress;
```

--------------------------------

### Custom builders for PdfViewPinch and PdfView

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Shows how to define custom builders for loading, error, and success states, and how to pass them to PdfViewPinch and PdfView. The example includes a static builder method, a transition builder, and a page builder for gallery options.

```dart
// Need static methods for builders arguments
class SomeWidget {
  static Widget builder(
    BuildContext context,
    PdfViewPinchBuilders builders,
    PdfLoadingState state,
    WidgetBuilder loadedBuilder,
    PdfDocument? document,
    Exception? loadingError,
  ) {
    final Widget content = () {
      switch (state) {
        case PdfLoadingState.loading:
          return KeyedSubtree(
            key: const Key('pdfx.root.loading'),
            child: builders.documentLoaderBuilder?.call(context) ??
                const SizedBox(),
          );
        case PdfLoadingState.error:
          return KeyedSubtree(
            key: const Key('pdfx.root.error'),
            child: builders.errorBuilder?.call(context, loadingError!) ??
                Center(child: Text(loadingError.toString())),
          );
        case PdfLoadingState.success:
          return KeyedSubtree(
            key: Key('pdfx.root.success.${document!.id}'),
            child: loadedBuilder(context),
          );
      }
    }();

    final defaultBuilder =
        builders as PdfViewPinchBuilders<DefaultBuilderOptions>;
    final options = defaultBuilder.options;

    return AnimatedSwitcher(
      duration: options.loaderSwitchDuration,
      transitionBuilder: options.transitionBuilder,
      child: content,
    );
  }

  static Widget transitionBuilder(Widget child, Animation<double> animation) =>
      FadeTransition(opacity: animation, child: child);

  static PhotoViewGalleryPageOptions pageBuilder(
    BuildContext context,
    Future<PdfPageImage> pageImage,
    int index,
    PdfDocument document,
  ) =>
      PhotoViewGalleryPageOptions(
        imageProvider: PdfPageImageProvider(
          pageImage,
          index,
          document.id,
        ),
        minScale: PhotoViewComputedScale.contained * 1,
        maxScale: PhotoViewComputedScale.contained * 3.0,
        initialScale: PhotoViewComputedScale.contained * 1.0,
        heroAttributes: PhotoViewHeroAttributes(tag: '${document.id}-$index'),
      );
}

PdfViewPinch(
  controller: pdfPinchController,
  builders: PdfViewPinchBuilders<DefaultBuilderOptions>(
    options: const DefaultBuilderOptions(
      loaderSwitchDuration: const Duration(seconds: 1),
      transitionBuilder: SomeWidget.transitionBuilder,
    ),
    documentLoaderBuilder: (_) =>
        const Center(child: CircularProgressIndicator()),
    pageLoaderBuilder: (_) =>
        const Center(child: CircularProgressIndicator()),
    errorBuilder: (_, error) => Center(child: Text(error.toString())),
    builder: SomeWidget.builder,
  ),
)

PdfView(
  controller: pdfController,
  builders: PdfViewBuilders<DefaultBuilderOptions>(
    // All from `PdfViewPinch` and:
    pageBuilder: SomeWidget.pageBuilder,
  ),
);
```

--------------------------------

### Usage example with PdfControllerPinch and PdfController

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Shows two ways to display a PDF: PdfViewPinch re-renders the PDF texture on zoom (not supported on Windows), while PdfView renders once per page and loses quality on zoom.

```dart
import 'package:pdfx/pdfx.dart';

final pdfPinchController = PdfControllerPinch(
  document: PdfDocument.openAsset('assets/sample.pdf'),
);

// Pdf view with re-render pdf texture on zoom (not loose quality on zoom)
// Not supported on windows
PdfViewPinch(
  controller: pdfPinchController,
);

//-- or --//

final pdfController = PdfController(
  document: PdfDocument.openAsset('assets/sample.pdf'),
);

// Simple Pdf view with one render of page (loose quality on zoom)
PdfView(
  controller: pdfController,
);
```

--------------------------------

### PdfDocument.getPage

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Gets a page from the document by page number (starting from 1).

```APIDOC
## PdfDocument.getPage

### Description
Gets a page from the document by page number (starting from 1).

### Method
getPage

### Parameters
- **pageNumber** (int) - Required - The page number, starting from 1.

### Request Example
```dart
final page = document.getPage(pageNumber);
```

### Response
Returns a `PdfPage` instance.

```

--------------------------------

### Open network PDF document using internet_file

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Imports internet_file and uses PdfDocument.openData with InternetFile.get to open a PDF from a URL. Requires the internet_file package installed.

```dart
import 'package:internet_file/internet_file.dart';

PdfDocument.openData(InternetFile.get('https://github.com/ScerIO/packages.flutter/raw/fd0c92ac83ee355255acb306251b1adfeb2f2fd6/packages/native_pdf_renderer/example/assets/sample.pdf'))
```

--------------------------------

### Open a page from a PDF document

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Retrieves a PdfPage object using getPage with a page number starting from 1.

```dart
final page = document.getPage(pageNumber); // Starts from 1
```

--------------------------------

### Get current page and pages count

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Access the currently displayed page and the total number of pages in the document via the PdfController.

```dart
// Actual showed page
pdfController.page;

// Count of all pages in document
pdfController.pagesCount;
```

--------------------------------

### Page control

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Shows methods to control page navigation: jump to a specific page, animate to a page, go to next/previous page, and get document progress.

```APIDOC
## Page Control Methods

### Description
Methods to navigate and control the current page in the PDF view.

### Methods
- **jumpTo(int page)** - Jumps to the specified page instantly.
- **animateToPage(int page, {Duration duration, Curve curve})** - Animates to the specified page.
- **nextPage({Duration duration, Curve curve})** - Animates to the next page.
- **previousPage({Duration duration, Curve curve})** - Animates to the previous page.
- **documentProgress** - Gets the document progress (0.0 - start, 1.0 - end).

### Example
```dart
// Jump to specified page
pdfController.jumpTo(3);

// Animate to specified page
_pdfController.animateToPage(3, duration: Duration(milliseconds: 250), curve: Curves.ease);

// Animate to next page
_pdfController.nextPage(duration: Duration(milliseconds: 250), curve: Curves.easeIn);

// Animate to previous page
_pdfController.previousPage(duration: Duration(milliseconds: 250), curve: Curves.easeOut);

// Get document progrees 0.0 - start, 1.0 - end
_pdfController.documentProgress;
```
```

--------------------------------

### Main app entry point with platform-based page selection

Source: https://pub.dev/packages/pdfx/example

Sets up the MaterialApp and selects SimplePage on Windows, PinchPage otherwise. Imports from pdfx_example package.

```dart
import 'package:flutter/material.dart';
import 'package:pdfx_example/pinch.dart';
import 'package:pdfx_example/simple.dart';

import 'package:universal_platform/universal_platform.dart';

void main() => runApp(const MyApp());

class MyApp extends StatefulWidget {
  const MyApp({Key? key}) : super(key: key);

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  @override
  Widget build(BuildContext context) => MaterialApp(
        debugShowCheckedModeBanner: false,
        theme: ThemeData(primaryColor: Colors.white),
        darkTheme: ThemeData.dark(),
        home: UniversalPlatform.isWindows
            ? const SimplePage()
            : const PinchPage(),
      );
}
```

--------------------------------

### Custom builders

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Demonstrates how to provide custom builders for loading, error, and page building in PdfView and PdfViewPinch.

```APIDOC
## Custom Builders

### Description
Customize the UI of the PDF view by providing builders for loading, error, and page content.

### Parameters
- **builders** (PdfViewBuilders or PdfViewPinchBuilders) - Required - Configuration object with builder functions.
- **options** (DefaultBuilderOptions) - Optional - Options for loader switch duration and transition.
- **documentLoaderBuilder** (Function) - Optional - Builder for the loading state.
- **pageLoaderBuilder** (Function) - Optional - Builder for page loading.
- **errorBuilder** (Function) - Optional - Builder for error state.
- **builder** (Function) - Required - Main builder for the content.
- **pageBuilder** (Function) - Optional - Builder for individual pages (PdfView only).

### Example
```dart
// Need static methods for builders arguments
class SomeWidget {
  static Widget builder(
    BuildContext context,
    PdfViewPinchBuilders builders,
    PdfLoadingState state,
    WidgetBuilder loadedBuilder,
    PdfDocument? document,
    Exception? loadingError,
  ) {
    final Widget content = () {
      switch (state) {
        case PdfLoadingState.loading:
          return KeyedSubtree(
            key: const Key('pdfx.root.loading'),
            child: builders.documentLoaderBuilder?.call(context) ??
                const SizedBox(),
          );
        case PdfLoadingState.error:
          return KeyedSubtree(
            key: const Key('pdfx.root.error'),
            child: builders.errorBuilder?.call(context, loadingError!) ??
                Center(child: Text(loadingError.toString())),
          );
        case PdfLoadingState.success:
          return KeyedSubtree(
            key: Key('pdfx.root.success.${document!.id}'),
            child: loadedBuilder(context),
          );
      }
    }();

    final defaultBuilder =
        builders as PdfViewPinchBuilders<DefaultBuilderOptions>;
    final options = defaultBuilder.options;

    return AnimatedSwitcher(
      duration: options.loaderSwitchDuration,
      transitionBuilder: options.transitionBuilder,
      child: content,
    );
  }

  static Widget transitionBuilder(Widget child, Animation<double> animation) =>
      FadeTransition(opacity: animation, child: child);

  static PhotoViewGalleryPageOptions pageBuilder(
    BuildContext context,
    Future<PdfPageImage> pageImage,
    int index,
    PdfDocument document,
  ) =>
      PhotoViewGalleryPageOptions(
        imageProvider: PdfPageImageProvider(
          pageImage,
          index,
          document.id,
        ),
        minScale: PhotoViewComputedScale.contained * 1,
        maxScale: PhotoViewComputedScale.contained * 3.0,
        initialScale: PhotoViewComputedScale.contained * 1.0,
        heroAttributes: PhotoViewHeroAttributes(tag: '${document.id}-$index'),
      );
}

PdfViewPinch(
  controller: pdfPinchController,
  builders: PdfViewPinchBuilders<DefaultBuilderOptions>(
    options: const DefaultBuilderOptions(
      loaderSwitchDuration: const Duration(seconds: 1),
      transitionBuilder: SomeWidget.transitionBuilder,
    ),
    documentLoaderBuilder: (_) =>
        const Center(child: CircularProgressIndicator()),
    pageLoaderBuilder: (_) =>
        const Center(child: CircularProgressIndicator()),
    errorBuilder: (_, error) => Center(child: Text(error.toString())),
    builder: SomeWidget.builder,
  ),
)

PdfView(
  controller: pdfController,
  builders: PdfViewBuilders<DefaultBuilderOptions>(
    // All from `PdfViewPinch` and:
    pageBuilder: SomeWidget.pageBuilder,
  ),
);
```
```

--------------------------------

### PdfViewBuilders & PdfViewPinchBuilders Parameters

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Parameters for the PdfViewBuilders and PdfViewPinchBuilders classes, including options and builder callbacks.

```APIDOC
## PdfViewBuilders & PdfViewPinchBuilders

### Parameters

| Parameter | Description | PdfViewPinchBuilders / PdfViewBuilders |
| --- | --- | --- |
| options | Additional options for builder | + / + |
| documentLoaderBuilder | Widget showing when pdf document loading | + / + |
| pageLoaderBuilder | Widget showing when pdf page loading | + / + |
| errorBuilder | Show document loading error message | + / + |
| builder | Root view builder for animate pdf loading state | + / + |
| pageBuilder | Callback called to render a widget for each page. See [custom page builder] | - / + |
```

--------------------------------

### PdfViewPinch with builders argument

Source: https://pub.dev/packages/pdfx/changelog

Shows how to configure `PdfViewPinch` with custom builders for document loading, page loading, errors, and a custom transition. The `builders` argument was added in version 2.0.0.

```dart
PdfViewPinch(
  builders: PdfViewPinchBuilders<DefaultBuilderOptions>(
    options: const DefaultBuilderOptions(
      loaderSwitchDuration: const Duration(seconds: 1),
      transitionBuilder: SomeWidget.transitionBuilder,
    ),
    documentLoaderBuilder: (_) =>
        const Center(child: CircularProgressIndicator()),
    pageLoaderBuilder: (_) =>
        const Center(child: CircularProgressIndicator()),
    errorBuilder: (_, error) => Center(child: Text(error.toString())),
    builder: SomeWidget.builder,
  ),
)
```

--------------------------------

### Open local PDF document from asset, file, or data

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Shows three ways to open a PDF document locally: from assets (Android, iOS, macOS, Web), from a file (Android, iOS, macOS), and from data (Android, iOS, macOS, Web). Each method returns a PdfDocument instance.

```dart
// From assets (Android, Ios, MacOs, Web)
final document = await PdfDocument.openAsset('assets/sample.pdf')

// From file (Android, Ios, MacOs)
final document = await PdfDocument.openFile('path/to/file/on/device')

// From data (Android, Ios, MacOs, Web)
final document = await PdfDocument.openData((FutureOr<Uint8List>) data)
```

--------------------------------

### PdfView & PdfViewPinch Parameters

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Parameters for the PdfView and PdfViewPinch widgets, including controller, callbacks, builders, and view options.

```APIDOC
## PdfView & PdfViewPinch

### Parameters

| Parameter | Description | PdfViewPinch / PdfView |
| --- | --- | --- |
| controller | Pages control. See [page control] and [additional pdf info] | + / + |
| onPageChanged | Called whenever the page in the center of the viewport changes. See [Document callbacks] | + / + |
| onDocumentLoaded | Called when a document is loaded. See [Document callbacks] | + / + |
| onDocumentError | Called when a document loading error. Exception is passed in the attributes | + / + |
| builders | Set of pdf view builders. See [Custom builders] | + / + |
| scrollDirection | Page turning direction | + / + |
| reverse | Reverse scroll direction, useful for RTL support | - / + |
| renderer | Custom PdfRenderer options. See [custom renderer options] | - / + |
| pageSnapping | Set to false for mouse wheel scroll on web | - / + |
| physics | How the widgets should respond to user input | - / + |
| padding | Padding for the every page. | + / - |
| minScale | The minimum document zoom scale. | + / - |
| maxScale | The maximum document zoom scale. | + / - |
```

--------------------------------

### PdfController & PdfControllerPinch Parameters

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Parameters for the PdfController and PdfControllerPinch classes, including document, initialPage, and viewportFraction.

```APIDOC
## PdfController & PdfControllerPinch

### Parameters

| Parameter | Description | Default |
| --- | --- | --- |
| document | The document to be displayed | - |
| initialPage | The page to show when first creating the [PdfView] | 1 |
| viewportFraction | The fraction of the viewport that each page should occupy. | 1.0 |
```

--------------------------------

### Render a page image with options

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Renders a page to an image with configurable width, height, format (JPEG, PNG, WEBP), background color, and crop rectangle. Web does not support format, backgroundColor, or cropRect. Default format is PNG.

```dart
final pageImage = page.render(
  // rendered image width resolution, required
  width: page.width * 2,
  // rendered image height resolution, required
  height: page.height * 2,

  // Rendered image compression format, also can be PNG, WEBP*
  // Optional, default: PdfPageImageFormat.PNG
  // Web not supported
  format: PdfPageImageFormat.JPEG,

  // Image background fill color for JPEG
  // Optional, default '#ffffff'
  // Web not supported
  backgroundColor: '#ffffff',

  // Crop rect in image for render
  // Optional, default null
  // Web not supported
  cropRect: Rect.fromLTRB(left, top, right, bottom),
);
```

--------------------------------

### Document callbacks

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Shows how to use callbacks in the PdfView widget to handle document loading and page changes.

```APIDOC
## PdfView Callbacks

### Description
Callbacks for the PdfView widget to react to document load and page changes.

### Parameters
- **onDocumentLoaded** (Function(PdfDocument)) - Called when the document is loaded.
- **onPageChanged** (Function(int)) - Called when the current page changes.

### Example
```dart
PdfView(
  controller: pdfController,
  onDocumentLoaded: (document) {},
  onPageChanged: (page) {},
);
```
```

--------------------------------

### Open another document

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Demonstrates how to open a different PDF document using the PdfController's openDocument method.

```APIDOC
## openDocument

### Description
Opens a new PDF document from an asset file.

### Method
openDocument

### Parameters
- **document** (PdfDocument) - Required - The document to open, typically created via `PdfDocument.openAsset`.

### Example
```dart
pdfController.openDocument(PdfDocument.openAsset('assets/sample.pdf'));
```
```

--------------------------------

### Add pdfx dependency

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Run this command in your Flutter project to add the pdfx package as a dependency.

```shell
flutter pub add pdfx
```

--------------------------------

### Listening to loading state with loadingState

Source: https://pub.dev/packages/pdfx/changelog

Uses `ValueListenableBuilder` with `controller.loadingState` to show different widgets based on the PDF loading state. The `loadingState` was added to `PdfController` and `PdfControllerPinch` in version 2.0.0.

```dart
ValueListenableBuilder<PdfLoadingState>(
  valueListenable: controller.loadingState,
  builder: (context, loadingState, loadingState) => (){
    switch (loadingState) {
      case PdfLoadingState.loading:
        return const CircularProgressIndicator();
      case PdfLoadingState.error:
        return  const Text('Pdf load error');
      case PdfLoadingState.success:
        return const Text('Pdf loaded');
    }
  }(),
)
```

--------------------------------

### Custom renderer options

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Shows how to customize the rendering of PDF pages using the renderer parameter of PdfView.

```APIDOC
## Custom Renderer Options

### Description
Customize how PDF pages are rendered by providing a custom renderer function.

### Parameters
- **renderer** (Function(PdfPage)) - Required - A function that takes a PdfPage and returns a rendered image.

### Example
```dart
PdfView(
  controller: pdfController,
  renderer: (PdfPage page) => page.render(
    width: page.width * 2,
    height: page.height * 2,
    format: PdfPageImageFormat.jpeg,
    backgroundColor: '#FFFFFF',
  ),
);
```
```

--------------------------------

### Document callbacks: onDocumentLoaded and onPageChanged

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Sets up callbacks on PdfView to react when the document is loaded and when the page changes.

```dart
PdfView(
  controller: pdfController,
  onDocumentLoaded: (document) {},
  onPageChanged: (page) {},
);
```

--------------------------------

### Show actual page number & all pages count

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Demonstrates the PdfPageNumber widget to display the current page and total pages.

```APIDOC
## PdfPageNumber Widget

### Description
A widget that displays the current page number and total page count.

### Parameters
- **controller** (PdfController) - Required - The PDF controller.
- **builder** (Function) - Required - A builder function that receives the current page, loading state, and pages count.

### Example
```dart
PdfPageNumber(
  controller: _pdfController,
  // When `loadingState != PdfLoadingState.success`  `pagesCount` equals null_
  builder: (_, state, loadingState, pagesCount) => Container(
    alignment: Alignment.center,
    child: Text(
      '$page/${pagesCount ?? 0}',
      style: const TextStyle(fontSize: 22),
    ),
  ),
)
```
```

--------------------------------

### PdfPage.render

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Renders the page to an image with specified width, height, format, background color, and crop rectangle.

```APIDOC
## PdfPage.render

### Description
Renders the page to an image with specified width, height, format, background color, and crop rectangle.

### Method
render

### Parameters
- **width** (int) - Required - The rendered image width resolution.
- **height** (int) - Required - The rendered image height resolution.
- **format** (PdfPageImageFormat) - Optional - The rendered image compression format (PNG, JPEG, WEBP). Default: PNG. Web not supported.
- **backgroundColor** (String) - Optional - Image background fill color for JPEG. Default: '#ffffff'. Web not supported.
- **cropRect** (Rect) - Optional - Crop rect in image for render. Default: null. Web not supported.

### Request Example
```dart
final pageImage = page.render(
  width: page.width * 2,
  height: page.height * 2,
  format: PdfPageImageFormat.JPEG,
  backgroundColor: '#ffffff',
  cropRect: Rect.fromLTRB(left, top, right, bottom),
);
```

### Response
Returns a `PdfPageImage` instance.

```

--------------------------------

### PdfDocument.openAsset

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Opens a PDF document from an asset. Supported on Android, iOS, macOS, and Web.

```APIDOC
## PdfDocument.openAsset

### Description
Opens a PDF document from an asset. Supported on Android, iOS, macOS, and Web.

### Method
openAsset

### Parameters
- **assetName** (String) - Required - The asset path of the PDF file.

### Request Example
```dart
final document = await PdfDocument.openAsset('assets/sample.pdf');
```

### Response
Returns a `PdfDocument` instance.

```

--------------------------------

### PdfDocument.openFile

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Opens a PDF document from a file path on the device. Supported on Android, iOS, and macOS.

```APIDOC
## PdfDocument.openFile

### Description
Opens a PDF document from a file path on the device. Supported on Android, iOS, and macOS.

### Method
openFile

### Parameters
- **filePath** (String) - Required - The path to the PDF file on the device.

### Request Example
```dart
final document = await PdfDocument.openFile('path/to/file/on/device');
```

### Response
Returns a `PdfDocument` instance.

```

--------------------------------

### Additional pdf info

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Shows how to access the currently displayed page and the total number of pages in the document.

```APIDOC
## Additional PDF Info

### Description
Properties to get the current page and total page count.

### Properties
- **page** - The currently displayed page number.
- **pagesCount** - The total number of pages in the document.

### Example
```dart
// Actual showed page
pdfController.page;

// Count of all pages in document
pdfController.pagesCount;
```
```

--------------------------------

### Open another document with pdfController.openDocument

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Opens a PDF asset using the PdfController's openDocument method. Requires a PdfController instance and an asset path.

```dart
pdfController.openDocument(PdfDocument.openAsset('assets/sample.pdf'));
```

--------------------------------

### Custom renderer options with PdfView renderer

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Customizes the rendering of each PDF page by providing a renderer function that sets width, height, format, and background color.

```dart
PdfView(
  controller: pdfController,
  renderer: (PdfPage page) => page.render(
    width: page.width * 2,
    height: page.height * 2,
    format: PdfPageImageFormat.jpeg,
    backgroundColor: '#FFFFFF',
  ),
);
```

--------------------------------

### Listening to page number with pageListenable

Source: https://pub.dev/packages/pdfx/changelog

Uses `ValueListenableBuilder` with `controller.pageListenable` to react to page number changes. The `pageListenable` was added to `PdfController` and `PdfControllerPinch` in version 2.0.0.

```dart
ValueListenableBuilder<int>(
  valueListenable: controller.pageListenable,
  builder: (context, actualPageNumber, child) => Text(actualPageNumber.toString()),
)
```

--------------------------------

### PdfDocument.openData

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Opens a PDF document from data (Uint8List). Supported on Android, iOS, macOS, and Web.

```APIDOC
## PdfDocument.openData

### Description
Opens a PDF document from data (Uint8List). Supported on Android, iOS, macOS, and Web.

### Method
openData

### Parameters
- **data** (FutureOr<Uint8List>) - Required - The PDF data.

### Request Example
```dart
final document = await PdfDocument.openData((FutureOr<Uint8List>) data);
```

### Response
Returns a `PdfDocument` instance.

```

--------------------------------

### Close a PDF document

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Closes the document to free resources.

```dart
document.close();
```

--------------------------------

### PdfPageNumber widget usage

Source: https://pub.dev/packages/pdfx/changelog

Displays the current page number and total pages using the `PdfPageNumber` widget. The `pagesCount` is null when `loadingState != PdfLoadingState.success`.

```dart
PdfPageNumber(
  controller: _pdfController,
  // When `loadingState != PdfLoadingState.success`  `pagesCount` equals null_
  builder: (_, state, loadingState, pagesCount) => Container(
    alignment: Alignment.center,
    child: Text(
      '$page/${pagesCount ?? 0}',
      style: const TextStyle(fontSize: 22),
    ),
  ),
)
```

--------------------------------

### PdfDocument.close

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Closes the document.

```APIDOC
## PdfDocument.close

### Description
Closes the document.

### Method
close

### Request Example
```dart
document.close();
```

### Response
No return value.

```

--------------------------------

### PdfPage.close

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Closes the page. Important to close pages before opening new ones on Android to avoid crashes.

```APIDOC
## PdfPage.close

### Description
Closes the page. Important to close pages before opening new ones on Android to avoid crashes.

### Method
close

### Request Example
```dart
page.close();
```

### Response
No return value.

```

--------------------------------

### Close a PDF page

Source: https://pub.dev/packages/pdfx/versions/2.11.0

Closes the page. Android requires closing the previous page before opening a new one to avoid crashes.

```dart
page.close();
```
Tokens:
Raw