pageOverlaysBuilder property

PdfPageOverlaysBuilder? pageOverlaysBuilder
final

Add overlays to each page.

This function is used to decorate each page with overlay widgets. The most typical use case is to add page number footer to each page.

The following fragment illustrates how to add page number footer to each page:

pageOverlaysBuilder: (context, pageRect, page) {
  return [Align(
     alignment: Alignment.bottomCenter,
     child: Text(page.pageNumber.toString(),
     style: const TextStyle(color: Colors.red)))];
},

Implementation

final PdfPageOverlaysBuilder? pageOverlaysBuilder;