pluto_grid_export library

Classes

AbstractTextExport<T>
Abstract class for converting PlutoGrid's metadata.
Align
A widget that aligns its child within itself and optionally sizes itself based on the child's size.
Alignment
AlignmentDirectional
An offset that's expressed as a fraction of a Size, but whose horizontal component is dependent on the writing direction.
AlignmentGeometry
Base class for Alignment that allows for text-direction aware resolution.
Anchor
Annotation
AnnotationBuilder
AnnotationCircle
AnnotationInk
AnnotationPolygon
AnnotationSquare
AnnotationTextField
AnnotationUrl
AspectRatio
Barcode
Barcode generation class
BarcodeBar
Rectangle drawing operation
BarcodeEan
Base class to generate EAN Barcodes
BarcodeElement
Barcode drawing operation
BarcodeText
Text drawing operation
BarcodeWidget
Draw a barcode using String data
BarDataSet<T extends PointChartValue>
Border
A border of a box, comprised of four sides: top, right, bottom, left.
BorderRadius
An immutable set of radii for each corner of a rectangle.
BorderRadiusDirectional
An immutable set of radii for each corner of a rectangle, but with the corners specified in a manner dependent on the writing direction.
BorderRadiusGeometry
Base class for BorderRadius that allows for text-direction aware resolution.
BorderSide
A side of a border of a box.
BorderStyle
BoxBorder
BoxConstraints
BoxDecoration
BoxShadow
Builder
A platonic widget that calls a closure to obtain its child widget.
Bullet
CartesianGrid
Center
Chart
This widget is in preview and the API is subject to change
ChartGrid
ChartLegend
ChartValue
Checkbox
ChoiceField
Circle
CircleAnnotation
CircularProgressIndicator
ClipOval
ClipRect
ClipRRect
Column
ColumnLayout
ConstrainedBox
A widget that imposes additional constraints on its child.
Container
Context
CustomPaint
DataMatrixEncoder
Encode DataMatrix messages
Dataset
DecoratedBox
DecorationGraphic
DecorationImage
DecorationSvgImage
DefaultTextStyle
DelayedWidget
Directionality
Divider
Document
EdgeInsets
EdgeInsetsDirectional
An immutable set of offsets in each of the four cardinal directions, but whose horizontal components are dependent on the writing direction.
EdgeInsetsGeometry
Expanded
FittedBox
Scales and positions its child within itself according to fit.
FittedSizes
The pair of sizes returned by applyBoxFit.
FixedAxis<T extends num>
FixedColumnWidth
FlatButton
Flex
FlexColumnWidth
FlexContext
Flexible
A widget that controls how a child of a Row, Column, or Flex flexes.
Font
Lazy font declaration, registers the font in the document only if needed. Tries to register a font only once
FractionalOffset
An offset that's expressed as a fraction of a PdfPoint.
FractionColumnWidth
FullPage
GenericPdfController
GenericPdfController
Gradient
A 2D gradient.
GridAxis
GridPaper
A widget that draws a rectilinear grid of lines. The grid is drawn over the child widget.
GridView
GridViewContext
Icon
A graphical icon widget drawn with a glyph from a font described in an IconData such as material's predefined IconDatas in Icons.
IconData
A description of an icon fulfilled by a font glyph.
IconThemeData
Defines the color, opacity, and size of icons.
Image
ImageImage
ImageProvider
Identifies an image without committing to the precise final asset
ImageProxy
Inherited
InheritedDirectionality
InheritedWidget
InkAnnotation
InkList
InlineSpan
Inseparable
IntrinsicColumnWidth
LayoutBuilder
Builds a widget tree that can depend on the parent widget's size.
LimitedBox
LinearGradient
A 2D linear gradient.
LinearProgressIndicator
A material design linear progress indicator, also known as a progress bar.
LineChartValue
LineDataSet<T extends PointChartValue>
ListView
Lorem
LoremText
MeCard
MeCard is a data file similar to vCard but used by NTT DoCoMo in Japan in QR code format for use with Cellular Phones. https://github.com/zxing/zxing/wiki/Barcode-Contents
MemoryImage
MeTuple
Tuple key/value for MeCard elements
MultiChildWidget
MultiPage
Create a multi-page section, with automatic overflow from one page to another
NewPage
Opacity
Outline
OverflowBox
Padding
Page
PageTheme
Paragraph
Partition
Partitions
PartitionsContext
PdfActionBarTheme
PdfAnnot
PdfAnnotBase
PdfAnnotCircle
PdfAnnotInk
PdfAnnotPolygon
PdfAnnotSign
PdfAnnotSquare
PdfAnnotText
PdfAnnotWidget
PdfBaseCache
Store data in a cache
PdfBaseFunction
PdfBaseImageCache
Store network images in a cache
PdfBorder
Defines a border object
PdfButtonField
PdfChoiceField
PdfColor
Represents an RGB color
PdfColorCmyk
Represents an CMYK color
PdfColorGrey
PdfColorHsl
Represents an HSL color
PdfColorHsv
Same as HSB, Cylindrical geometries with hue, their angular dimension, starting at the red primary at 0°, passing through the green primary at 120° and the blue primary at 240°, and then wrapping back to red at 360°
PdfColors
Material design colors
PdfController
Abstract class for PDF conversion.
PdfDocument
This class is the base of the Pdf generator. A PdfDocument class is created for a document, and each page, object, annotation, etc is added to the document. Once complete, the document can be written to a Stream, and the Pdf document's internal structures are kept in sync.
PdfDocumentParserBase
Base class for loading an existing PDF document.
PdfEncryption
Encryption object
PdfFont
Pdf font object
PdfFontMetrics
Describe dimensions for glyphs in a font
PdfFormField
PdfFunction
PdfGoogleFonts
Google Fonts
PdfGraphics
Pdf drawing operations
PdfGraphicState
Graphic state
PdfGraphicStates
Stores all the graphic states used in the document
PdfImage
Image object stored in the Pdf document
PdfInfo
Information object
PdfJpegInfo
Jpeg metadata extraction
PdfMemoryCache
Memory cache
PdfMemoryImageCache
Memory image cache
PdfMetadata
Pdf Metadata
PdfName
PdfOutline
Pdf Outline object
PdfPage
Page object, which will hold any contents for this page.
PdfPageFormat
PdfPageFormatAction
PdfPageLabel
PdfPageLabels
Pdf PageLabels object
PdfPageOrientationAction
PdfPattern
PdfPoint
PdfPreview
Flutter widget that uses the rasterized pdf pages to display a document.
PdfPreviewAction
Action to add the the PdfPreview widget
PdfPreviewCustom
Flutter widget that uses the rasterized pdf pages to display a document.
PdfPreviewCustomState
PdfPreviewPageData
A class that holds rasterized pdf data
PdfPreviewState
PdfPrintAction
PdfRaster
Represents a bitmap image
PdfRasterBase
Represents a bitmap image
PdfRasterImage
Image provider for a PdfRaster
PdfRect
PdfShading
PdfShadingPattern
PdfShareAction
PdfSignature
PdfSignatureBase
PdfSoftMask
PdfStitchingFunction
PdfTextField
PdfTtfFont
PieDataSet
PieGrid
Placeholder
PlutoGridDefaultCsvExport
Csv exporter for PlutoGrid
PlutoGridDefaultPdfExport
PDF exporter for PlutoGrid
PlutoGridExport
Export to CSV from PlutoGrid
PointChartValue
PointDataSet<T extends PointChartValue>
Polygon
PolygonAnnotation
PolyLineAnnotation
Positioned
A widget that controls where a child of a Stack is positioned.
PositionedDirectional
A widget that controls where a child of a Stack is positioned without committing to a specific TextDirection.
Printer
Information about a printer
PrintingInfo
Capabilities supported for the current platform
RadialGradient
A 2D radial gradient.
RadialGrid
Radius
A radius for either circular or elliptical shapes.
RawImage
Rectangle
RichText
RichTextContext
Row
Shape
Signature
SingleChildWidget
SizedBox
A box with a specified size.
Spacer
Spacer creates an adjustable, empty spacer that can be used to tune the spacing between widgets in a Flex container, like Row or Column.
SquareAnnotation
Stack
A widget that positions its children relative to the edges of its box.
StatelessWidget
SvgImage
Table
A widget that uses the table layout algorithm for its children.
TableBorder
TableColumnWidth
TableContext
TableOfContent
TableRow
A horizontal group of cells in a Table.
Text
TextDecoration
A linear decoration to draw near the text.
TextField
TextSpan
TextStyle
Theme
ThemeData
Transform
TtfBitmapInfo
TtfFont
TtfGlyphInfo
TtfParser
VerticalDivider
Watermark
Widget
WidgetContext
WidgetSpan
WidgetWrapper
ImageProvider that draws a Flutter Widget on a PDF document
Wrap
A widget that displays its children in multiple horizontal or vertical runs.
WrapContext

Enums

Axis
BarcodeCodabarStartStop
Start and Stop symbols for BCodabar
BarcodeQRCorrectionLevel
QR Code Correction Level
BarcodeTextAlign
Text alignement inside the BarcodeText zone
BarcodeType
Supported barcode types
BoxFit
BoxShape
CrossAxisAlignment
DecorationPosition
FlexFit
FontStyle
FontWeight
MainAxisAlignment
MainAxisSize
Overflow
Whether overflowing children should be clipped, or their overflow be visible.
PageOrientation
PaintPhase
Pdf417SecurityLevel
Error correction levels
PdfAnnotAppearance
PdfAnnotFlags
PdfAnnotHighlighting
PdfBlendMode
PdfBorderStyle
Border style
PdfExifTag
Possible Exif tags
PdfFieldFlags
PdfImageOrientation
Represents the position of the first pixel in the data stream This corresponds to the exif orientations
PdfLineCap
Specify the shape that shall be used at the ends of open sub paths and dashes, when they are stroked.
PdfLineJoin
Shape to be used at the corners of paths that are stroked
PdfOutlineMode
Outline mode
PdfOutlineStyle
Outline style
PdfPageLabelStyle
PdfPageMode
Display hint for the PDF viewer
PdfPageRotation
Page rotation
PdfShadingType
PdfSigFlags
Signature flags
PdfTextFieldAlign
PdfTextRenderingMode
Text rendering mode
PdfVersion
PDF version to generate
PieLegendPosition
StackFit
How to size the non-positioned children of a Stack.
TableCellVerticalAlignment
TableWidth
TextAlign
TextDecorationStyle
TextDirection
TextOverflow
How overflowing text should be handled.
TileMode
Defines what happens at the edge of the gradient.
TtfParserName
Type1Fonts
ValuePosition
VerticalDirection
WrapAlignment
How Wrap should align objects.
WrapCrossAlignment
Who Wrap should align children within a run in the cross axis.

Functions

applyBoxFit(BoxFit fit, PdfPoint inputSize, PdfPoint outputSize) → FittedSizes
flutterImageProvider(ImageProvider<Object> image, {ImageConfiguration? configuration, ImageErrorListener? onError}) → Future<ImageProvider>
Loads an image from a Flutter ImageProvider into an ImageProvider instance
fontFromAssetBundle(String key, {AssetBundle? bundle, bool cache = true, PdfBaseCache? pdfCache, bool protect = false}) → Future<TtfFont>
Loads a font from an asset bundle key. If used multiple times with the same font name, it will be included multiple times in the pdf file
imageFromAssetBundle(String key, {AssetBundle? bundle, bool cache = true, PdfImageOrientation? orientation, double? dpi, PdfBaseCache? pdfCache}) → Future<ImageProvider>
Load an image from an asset bundle key.
networkImage(String url, {bool cache = true, Map<String, String>? headers, PdfImageOrientation? orientation, double? dpi, PdfBaseCache? pdfCache}) → Future<ImageProvider>
Download an image from the network.
pdfDefaultTheme() → Future<void>
transformPoint(Matrix4 transform, PdfPoint point) → PdfPoint
transformRect(Matrix4 transform, PdfRect rect) → PdfRect

Typedefs

BuildCallback = Widget Function(Context context)
BuildListCallback = List<Widget> Function(Context context)
CustomPainter = dynamic Function(PdfGraphics canvas, PdfPoint size)
CustomPdfPagesBuilder = Widget Function(BuildContext context, List<PdfPreviewPageData> pages)
Custom widget builder that's used for custom rasterized pdf pages rendering
DefaultThemeDataBuilder = ThemeData Function()
DeflateCallback = List<int> Function(List<int> data)
Callback used to compress the data
GridAxisBuildLabel = Widget Function(num value)
GridAxisFormat = String Function(num value)
Hyphenation = List<String> Function(String word)
IndexedWidgetBuilder = Widget Function(Context context, int index)
LayoutCallback = FutureOr<Uint8List> Function(PdfPageFormat format)
Callback used to generate the Pdf document dynamically when the user changes the page settings: size and margins
LayoutWidgetBuilder = Widget Function(Context context, BoxConstraints? constraints)
The signature of the LayoutBuilder builder function.
OnCellDecoration = BoxDecoration Function(int index, dynamic data, int rowNum)
OnCellFormat = String Function(int index, dynamic data)
OnPdfPreviewActionPressed = void Function(BuildContext context, LayoutCallback build, PdfPageFormat pageFormat)
Base Action callback
VisitorCallback = bool Function(InlineSpan span, TextStyle? parentStyle, AnnotationBuilder? annotation)
WidgetBuilder = Widget Function(Context context)

Exceptions / Errors

BarcodeException
Exception raised if the library cannot generate the Barcode
TooManyPagesException
Exception thrown when generator populates more pages than maxPages.