PDFAnnotationConfig class

Optional configuration for the PDF annotation editor.

Pass an instance to any FlutterPdfAnnotations method via the config parameter to pre-configure the editor's initial state.

FlutterPdfAnnotations.openPDF(
  filePath: path,
  config: PDFAnnotationConfig(
    title: 'Review Contract',
    initialPenColor: Colors.red,
    initialHighlightColor: Colors.yellow.withOpacity(0.5),
    initialStrokeWidth: 3.0,
  ),
);

Constructors

PDFAnnotationConfig({String? title, Color? initialPenColor, Color? initialHighlightColor, double? initialStrokeWidth, List<Uint8List>? imagesToInsert, int initialPage = 0})

const

Properties

hashCode → int

The hash code for this object.

no setter, inherited

imagesToInsert → List<Uint8List>?

Images that the user can stamp onto PDF pages.

final

initialHighlightColor → Color?

Initial highlight colour.

final

initialPage → int

Zero-based page index to open initially.

final

initialPenColor → Color?

Initial pen colour. Include the desired alpha channel in the value.

final

initialStrokeWidth → double?

Initial stroke width.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

title → String?

Title displayed in the editor's navigation bar.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toMap() → Map<String, dynamic>

Serialises config fields to pass over the method channel.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited