Package pdfa provides abstraction to optimize and verify documents with respect to the PDF/A standards.

Package sighandler implements digital signature handlers for PDF signature validation and signing.

Package xmputil provides abstraction used by the pdf document XMP Metadata.

DefaultFont returns the default font, which is currently the built in Helvetica.

DetermineColorspaceNameFromPdfObject determines PDF colorspace from a PdfObject.

GetAlphabet returns a map of the runes in `text` and their frequencies.

NewBorderStyle returns an initialized PdfBorderStyle.

NewCompliancePdfReader creates a PdfReader or an input io.ReadSeeker that during reading will scan the files for the metadata details.

NewCompositePdfFontFromTTF loads a composite TTF font.

NewCompositePdfFontFromTTFFile loads a composite font from a TTF font file.

NewCustomPdfOutputIntent creates a new custom PdfOutputIntent.

NewDSS returns a new DSS dictionary.

NewEmbeddedFile constructs a new EmbeddedFile object from supplied file.

NewEmbeddedFileFromContent construct a new EmbeddedFile from supplied file content.

NewEmbeddedFileFromObject construct a new EmbeddedFile from supplied object.

NewKDictionary creates a new K dictionary object.

NewKValue creates a new K value object.

NewLTV returns a new LTV client.

NewMultipleFontEncoder returns instantiates a new *MultipleFontEncoder.

NewOutline returns a new outline instance.

NewOutlineBookmark returns an initialized PdfOutlineItem for a given bookmark title and page.

NewOutlineDest returns a new outline destination which can be used with outline items.

NewOutlineItem returns a new outline item instance.

NewPdfAcroForm returns a new PdfAcroForm with an initialized container (indirect object).

NewPdfAction returns an initialized generic PDF action model.

NewPdfActionGoTo returns a new "go to" action.

NewPdfActionGoTo3DView returns a new "goTo3DView" action.

NewPdfActionGoToE returns a new "go to embedded" action.

NewPdfActionGoToR returns a new "go to remote" action.

NewPdfActionHide returns a new "hide" action.

NewPdfActionImportData returns a new "import data" action.

NewPdfActionJavaScript returns a new "javaScript" action.

NewPdfActionLaunch returns a new "launch" action.

NewPdfActionMovie returns a new "movie" action.

NewPdfActionNamed returns a new "named" action.

NewPdfActionRendition returns a new "rendition" action.

NewPdfActionResetForm returns a new "reset form" action.

NewPdfActionSetOCGState returns a new "named" action.

NewPdfActionSound returns a new "sound" action.

NewPdfActionSubmitForm returns a new "submit form" action.

NewPdfActionThread returns a new "thread" action.

NewPdfActionTrans returns a new "trans" action.

NewPdfActionURI returns a new "Uri" action.

NewPdfAnnotation returns an initialized generic PDF annotation model.

NewPdfAnnotation3D returns a new 3d annotation.

NewPdfAnnotationCaret returns a new caret annotation.

NewPdfAnnotationCircle returns a new circle annotation.

NewPdfAnnotationFileAttachment returns a new file attachment annotation.

NewPdfAnnotationFreeText returns a new free text annotation.

NewPdfAnnotationHighlight returns a new text highlight annotation.

NewPdfAnnotationInk returns a new ink annotation.

NewPdfAnnotationLine returns a new line annotation.

NewPdfAnnotationLink returns a new link annotation.

NewPdfAnnotationMovie returns a new movie annotation.

NewPdfAnnotationPolygon returns a new polygon annotation.

NewPdfAnnotationPolyLine returns a new polyline annotation.

NewPdfAnnotationPopup returns a new popup annotation.

NewPdfAnnotationPrinterMark returns a new printermark annotation.

NewPdfAnnotationProjection returns a new projection annotation.

NewPdfAnnotationRedact returns a new redact annotation.

NewPdfAnnotationRichMedia returns a new rich media annotation.

NewPdfAnnotationScreen returns a new screen annotation.

NewPdfAnnotationSound returns a new sound annotation.

NewPdfAnnotationSquare returns a new square annotation.

NewPdfAnnotationSquiggly returns a new text squiggly annotation.

NewPdfAnnotationStamp returns a new stamp annotation.

NewPdfAnnotationStrikeOut returns a new text strikeout annotation.

NewPdfAnnotationText returns a new text annotation.

NewPdfAnnotationTrapNet returns a new trapnet annotation.

NewPdfAnnotationUnderline returns a new text underline annotation.

NewPdfAnnotationWatermark returns a new watermark annotation.

NewPdfAnnotationWidget returns an initialized annotation widget.

NewPdfAppender creates a new Pdf appender from a Pdf reader.

NewPdfAppenderWithOpts creates a new Pdf appender from a Pdf reader with options.

NewPdfColorCalGray returns a new CalGray color.

NewPdfColorCalRGB returns a new CalRBG color.

NewPdfColorDeviceCMYK returns a new CMYK32 color.

NewPdfColorDeviceGray returns a new grayscale color based on an input grayscale float value in range [0-1].

NewPdfColorDeviceRGB returns a new PdfColorDeviceRGB based on the r,g,b component values.

NewPdfColorLab returns a new Lab color.

NewPdfColorPattern returns an empty color pattern.

NewPdfColorPatternType2 returns an empty color shading pattern type 2 (Axial).

NewPdfColorPatternType3 returns an empty color shading pattern type 3 (Radial).

NewPdfColorspaceCalGray returns a new CalGray colorspace object.

NewPdfColorspaceCalRGB returns a new CalRGB colorspace object.

NewPdfColorspaceDeviceCMYK returns a new CMYK32 colorspace object.

NewPdfColorspaceDeviceGray returns a new grayscale colorspace.

NewPdfColorspaceDeviceN returns an initialized PdfColorspaceDeviceN.

NewPdfColorspaceDeviceRGB returns a new RGB colorspace object.

NewPdfColorspaceFromPdfObject loads a PdfColorspace from a PdfObject.

NewPdfColorspaceICCBased returns a new ICCBased colorspace object.

NewPdfColorspaceLab returns a new Lab colorspace object.

NewPdfColorspaceSpecialIndexed returns a new Indexed color.

NewPdfColorspaceSpecialPattern returns a new pattern color.

NewPdfColorspaceSpecialSeparation returns a new separation color.

NewPdfDate returns a new PdfDate object from a PDF date string (see 7.9.4 Dates).

NewPdfDateFromTime will create a PdfDate based on the given time.

NewPdfField returns an initialized PdfField.

NewPdfFieldSignature returns an initialized signature field.

NewPdfFilespec returns an initialized generic PDF filespec model.

NewPdfFileSpecFromEmbeddedFile construct a new PdfFileSpec that contains an embedded file.

NewPdfFilespecFromObj creates and returns a new PdfFilespec object.

NewPdfFontFromPdfObject loads a PdfFont from the dictionary `fontObj`.

NewPdfFontFromTTF loads a TTF font and returns a PdfFont type that can be used in text styling functions.

NewPdfFontFromTTFFile loads a TTF font file and returns a PdfFont type that can be used in text styling functions.

NewPdfInfoFromObject creates a new PdfInfo from the input core.PdfObject.

NewPdfOutline returns an initialized PdfOutline.

NewPdfOutlineItem returns an initialized PdfOutlineItem.

NewPdfOutlineTree returns an initialized PdfOutline tree.

NewPdfOutputIntentFromPdfObject creates a new PdfOutputIntent from the input core.PdfObject.

NewPdfPage returns a new PDF page.

NewPdfPageResources returns a new PdfPageResources object.

NewPdfPageResourcesColorspaces returns a new PdfPageResourcesColorspaces object.

NewPdfPageResourcesFromDict creates and returns a new PdfPageResources object from the input dictionary.

NewPdfReader returns a new PdfReader for an input io.ReadSeeker interface.

NewPdfReaderFromFile creates a new PdfReader from the speficied PDF file.

NewPdfReaderLazy creates a new PdfReader for `rs` in lazy-loading mode.

NewPdfReaderWithOpts creates a new PdfReader for an input io.ReadSeeker interface with a ReaderOpts.

NewPdfRectangle creates a PDF rectangle object based on an input array of 4 integers.

NewPdfShadingPatternType2 creates an empty shading pattern type 2 object.

NewPdfShadingPatternType3 creates an empty shading pattern type 3 object.

NewPdfShadingType2 creates an empty shading type 2 dictionary.

NewPdfShadingType3 creates an empty shading type 3 dictionary.

NewPdfSignature creates a new PdfSignature object.

NewPdfSignatureReferenceDocMDP returns PdfSignatureReference for the transformParams.

NewPdfTransformParamsDocMDP create a PdfTransformParamsDocMDP with the specific permissions.

NewPdfWriter initializes a new PdfWriter.

NewPermissions returns a new permissions object.

NewReaderForText makes a new PdfReader for an input PDF content string.

NewReaderOpts generates a default `ReaderOpts` instance.

NewStandard14Font returns the standard 14 font named `basefont` as a *PdfFont, or an error if it `basefont` is not one of the standard 14 font names.

NewStandard14FontMustCompile returns the standard 14 font named `basefont` as a *PdfFont.

NewStandard14FontWithEncoding returns the standard 14 font named `basefont` as a *PdfFont and a TextEncoder that encodes all the runes in `alphabet`, or an error if this is not possible.

NewStandardPdfOutputIntent creates a new standard PdfOutputIntent.

NewStructTreeRoot creates a new structure tree root dictionary.

NewStructTreeRootFromPdfObject creates a new structure tree root from a PDF object.

NewViewerPreferences returns a new ViewerPreferences object with default empty values.

NewXObjectForm creates a brand new XObject Form.

NewXObjectFormFromStream builds the Form XObject from a stream object.

NewXObjectImage returns a new XObjectImage.

NewXObjectImageFromImage creates a new XObject Image from an image object with default options.

NewXObjectImageFromImageLazy creates a new XObject Image from an image object with default options.

NewXObjectImageFromStream builds the image xobject from a stream object.

SetImageHandler sets the image handler used by the package.

SetPdfAuthor sets the Author attribute of the output PDF.

SetPdfCreationDate sets the CreationDate attribute of the output PDF.

SetPdfCreator sets the Creator attribute of the output PDF.

SetPdfKeywords sets the Keywords attribute of the output PDF.

SetPdfModifiedDate sets the ModDate attribute of the output PDF.

SetPdfProducer sets the Producer attribute of the output PDF.

SetPdfSubject sets the Subject attribute of the output PDF.

SetPdfTitle sets the Title attribute of the output PDF.

UpdateXObjectImageFromImage creates a new XObject Image from an Image object `img` and default masks from xobjIn.

AcroFormRepairOptions contains options for rebuilding the AcroForm.

CompliancePdfReader is a wrapper over PdfReader that is used for verifying if the input Pdf document matches the compliance rules of standards like PDF/A.

DefaultImageHandler is the default implementation of the ImageHandler using the standard go library.

DSS represents a Document Security Store dictionary.

EmbeddedFile represents an embedded file.

EncryptOptions represents encryption options for an output PDF.

FieldFlattenOpts defines a set of options which can be used to configure the field flattening process.

IDTree represents the ID tree dictionary where the format of the content is using Name Trees as described in chapter 7.9.6.

Image interface is a basic representation of an image used in PDF.

KDict represents a K dictionary object.

KValue is a wrapper object to hold various type of K's children objects.

LTV represents an LTV (Long-Term Validation) client.

multiFontEncoder implements a an Encoder that holds a list of fonts provided.

Names represents a PDF name tree.

Outline represents a PDF outline dictionary (Table 152 - p.

OutlineDest represents the destination of an outline item.

OutlineItem represents a PDF outline item dictionary (Table 153 - pp.

PdfAcroForm represents the AcroForm dictionary used for representation of form data in PDF.

PdfAction represents an action in PDF (section 12.6 p.

PdfActionGoTo represents a GoTo action.

PdfActionGoTo3DView represents a GoTo3DView action.

PdfActionGoToE represents a GoToE action.

PdfActionGoToR represents a GoToR action.

PdfActionHide represents a hide action.

PdfActionImportData represents a importData action.

PdfActionJavaScript represents a javaScript action.

PdfActionLaunch represents a launch action.

PdfActionMovie represents a movie action.

PdfActionNamed represents a named action.

PdfActionRendition represents a Rendition action.

PdfActionResetForm represents a resetForm action.

PdfActionSetOCGState represents a SetOCGState action.

PdfActionSound represents a sound action.

PdfActionSubmitForm represents a submitForm action.

PdfActionThread represents a thread action.

PdfActionTrans represents a trans action.

PdfActionURI represents an URI action.

PdfAnnotation represents an annotation in PDF (section 12.5 p.

PdfAnnotation3D represents 3D annotations.

PdfAnnotationCaret represents Caret annotations.

PdfAnnotationCircle represents Circle annotations.

PdfAnnotationFileAttachment represents FileAttachment annotations.

PdfAnnotationFreeText represents FreeText annotations.

PdfAnnotationHighlight represents Highlight annotations.

PdfAnnotationInk represents Ink annotations.

PdfAnnotationLine represents Line annotations.

PdfAnnotationLink represents Link annotations.

PdfAnnotationMarkup represents additional fields for mark-up annotations.

PdfAnnotationMovie represents Movie annotations.

PdfAnnotationPolygon represents Polygon annotations.

PdfAnnotationPolyLine represents PolyLine annotations.

PdfAnnotationPopup represents Popup annotations.

PdfAnnotationPrinterMark represents PrinterMark annotations.

PdfAnnotationProjection represents Projection annotations.

PdfAnnotationRedact represents Redact annotations.

PdfAnnotationRichMedia represents Rich Media annotations.

PdfAnnotationScreen represents Screen annotations.

PdfAnnotationSound represents Sound annotations.

PdfAnnotationSquare represents Square annotations.

PdfAnnotationSquiggly represents Squiggly annotations.

PdfAnnotationStamp represents Stamp annotations.

PdfAnnotationStrikeOut represents StrikeOut annotations.

PdfAnnotationText represents Text annotations.

PdfAnnotationTrapNet represents TrapNet annotations.

PdfAnnotationUnderline represents Underline annotations.

PdfAnnotationWatermark represents Watermark annotations.

PdfAnnotationWidget represents Widget annotations.

PdfAppender appends new PDF content to an existing PDF document via incremental updates.

PdfBorderEffect represents a PDF border effect.

PdfBorderStyle represents a border style dictionary (12.5.4 Border Styles p.

PdfColorPattern represents a pattern color.

PdfColorPatternType2 represents a color shading pattern type 2 (Axial).

PdfColorPatternType3 represents a color shading pattern type 3 (Radial).

PdfColorspaceCalGray represents CalGray color space.

PdfColorspaceCalRGB stores A, B, C components.

PdfColorspaceDeviceCMYK represents a CMYK32 colorspace.

PdfColorspaceDeviceGray represents a grayscale colorspace.

PdfColorspaceDeviceN represents a DeviceN color space.

PdfColorspaceDeviceNAttributes contains additional information about the components of colour space that conforming readers may use.

PdfColorspaceDeviceRGB represents an RGB colorspace.

PdfColorspaceICCBased format [/ICCBased stream] The stream shall contain the ICC profile.

PdfColorspaceLab is a L*, a*, b* 3 component colorspace.

PdfColorspaceSpecialIndexed is an indexed color space is a lookup table, where the input element is an index to the lookup table and the output is a color defined in the lookup table in the Base colorspace.

PdfColorspaceSpecialPattern is a Pattern colorspace.

PdfColorspaceSpecialSeparation is a Separation colorspace.

PdfDate represents a date, which is a PDF string of the form: (D:YYYYMMDDHHmmSSOHH'mm).

PdfField contains the common attributes of a form field.

PdfFieldButton represents a button field which includes push buttons, checkboxes, and radio buttons.

PdfFieldChoice represents a choice field which includes scrollable list boxes and combo boxes.

PdfFieldSignature signature field represents digital signatures and optional data for authenticating the name of the signer and verifying document contents.

PdfFieldText represents a text field where user can enter text.

PdfFilespec represents a file specification which can either refer to an external or embedded file.

PdfFont represents an underlying font structure which can be of type: - Type0 - Type1 - TrueType etc.

PdfFontDescriptor specifies metrics and other attributes of a font and can refer to a FontFile for embedded fonts.

PdfFunctionType0 uses a sequence of sample values (contained in a stream) to provide an approximation for functions whose domains and ranges are bounded.

PdfFunctionType2 defines an exponential interpolation of one input value and n output values: f(x) = y_0, ..., y_(n-1) y_j = C0_j + x^N * (C1_j - C0_j); for 0 <= j < n When N=1 ; linear interpolation between C0 and C1.

PdfFunctionType3 defines stitching of the subdomains of several 1-input functions to produce a single new 1-input function.

PdfFunctionType4 is a Postscript calculator functions.

PdfInfo holds document information that will overwrite document information global variables defined above.

PdfOutline represents a PDF outline dictionary (Table 152 - p.

PdfOutlineItem represents an outline item dictionary (Table 153 - pp.

PdfOutlineTreeNode contains common fields used by the outline and outline item objects.

PdfOutputIntent provides a means for matching the color characteristics of a PDF document with those of a target output device.

PdfPage represents a page in a PDF document.

PdfPageResources is a Page resources model.

PdfPageResourcesColorspaces contains the colorspace in the PdfPageResources.

A PdfPattern can represent a Pattern, either a tiling pattern or a shading pattern.

PdfReader represents a PDF file reader.

PdfRectangle is a definition of a rectangle.

PdfShading represents a shading dictionary.

PdfShadingPattern is a Shading patterns that provide a smooth transition between colors across an area to be painted, i.e.

PdfShadingPatternType2 is shading patterns that will use a Type 2 shading pattern (Axial).

PdfShadingPatternType3 is shading patterns that will use a Type 3 shading pattern (Radial).

PdfShadingType1 is a Function-based shading.

PdfShadingType2 is an Axial shading.

PdfShadingType3 is a Radial shading.

PdfShadingType4 is a Free-form Gouraud-shaded triangle mesh.

PdfShadingType5 is a Lattice-form Gouraud-shaded triangle mesh.

PdfShadingType6 is a Coons patch mesh.

PdfShadingType7 is a Tensor-product patch mesh.

PdfSignature represents a PDF signature dictionary and is used for signing via form signature fields.

PdfSignatureReference represents a PDF signature reference dictionary and is used for signing via form signature fields.

PdfTilingPattern is a Tiling pattern that consists of repetitions of a pattern cell with defined intervals.

PdfTransformParamsDocMDP represents a transform parameters dictionary for the DocMDP method and is used to detect modifications relative to a signature field that is signed by the author of a document.

PdfWriter handles outputing PDF content.

Permissions specify a permissions dictionary (PDF 1.5).

ReaderOpts defines options for creating PdfReader instances.

ReaderToWriterOpts options used to generate a PdfWriter.

SignatureHandlerDocMDPParams describe the specific parameters for the SignatureHandlerEx These parameters describe how to check the difference between revisions.

SignatureValidationResult defines the response from the signature validation handler.

StructTreeRoot represents the structure tree root dictionary.

VariableText contains the common attributes of a variable text.

ViewerPreferences represents the viewer preferences of a PDF document.

VRI represents a Validation-Related Information dictionary.

WatermarkImageOptions contains options for configuring the image watermark process.

WatermarkTextOptions contains options for configuring the text watermark process.

XObjectForm (Table 95 in 8.10.2).

XObjectImage (Table 89 in 8.9.5.1).

ContentStreamWrapper wraps the Page's contentstream into q ..

FieldAppearanceGenerator generates appearance stream for a given field.

FieldImageProvider provides fields images for specified fields.

FieldValueProvider provides field values from a data source such as FDF, JSON or any other.

Hasher is the interface that wraps the basic Write method.

ImageHandler interface implements common image loading and processing tasks.

Optimizer is the interface that performs optimization of PDF object structure for output writing.

PdfColor interface represents a generic color in PDF.

PdfColorspace interface defines the common methods of a PDF colorspace.

PdfFunction interface represents the common methods of a function in PDF.

PdfModel is a higher level PDF construct which can be collapsed into a PdfObject.

SignatureHandler interface defines the common functionality for PDF signature handlers, which need to be capable of validating digital signatures and signing PDF documents.

SignatureHandlerDocMDP extends SignatureHandler with the ValidateWithOpts method for checking the DocMDP policy.

StandardApplier is the interface that performs optimization of the whole PDF document.

StandardImplementer is an interface that defines specified PDF standards like PDF/A-1A (pdfa.Profile1A) NOTE: This implementation is in experimental development state.

StandardValidator is the interface that is used for the PDF StandardImplementer validation for the PDF document.

AlphaMapFunc represents a alpha mapping function: byte -> byte.

AnnotFilterFunc represents a PDF annotation filtering function.

BorderEffect represents a border effect (Table 167 p.

BorderStyle defines border type, typically used for annotations.

ButtonType represents the subtype of a button field, can be one of: - Checkbox (ButtonTypeCheckbox) - PushButton (ButtonTypePushButton) - RadioButton (ButtonTypeRadioButton).

CharMetrics represents width and height metrics of a glyph.

Direction represents the predominant reading order for text.

Duplex represents the paper handling option that shall be used when printing the file from the print dialog.

EncryptionAlgorithm is used in EncryptOptions to change the default algorithm used to encrypt the document.

FieldFilterFunc represents a PDF field filtering function.

FieldFlag represents form field flags.

FileRelationship represents a attachment file relationship type.

NonFullScreenPageMode represents the document’s page mode when exiting full-screen mode.

PageBoundary represents the name of the page boundary representing the visible area.

PageCallback callback function used in page loading that could be used to modify the page content.

PageProcessCallback callback function used in page loading that could be used to modify the page content.

PdfActionType represents an action type in PDF (section 12.6.4 p.

PdfColorCalGray represents a CalGray colorspace.

PdfColorCalRGB represents a color in the Colorimetric CIE RGB colorspace.

PdfColorDeviceCMYK is a CMYK32 color, where each component is defined in the range 0.0 - 1.0 where 1.0 is the primary intensity.

PdfColorDeviceGray represents a grayscale color value that shall be represented by a single number in the range 0.0 to 1.0 where 0.0 corresponds to black and 1.0 to white.

PdfColorDeviceRGB represents a color in DeviceRGB colorspace with R, G, B components, where component is defined in the range 0.0 - 1.0 where 1.0 is the primary intensity.

PdfColorLab represents a color in the L*, a*, b* 3 component colorspace.

PdfInfoTrapped specifies pdf trapped information.

PdfOutputIntentType is the subtype of the given PdfOutputIntent.

PrintScaling represents the page scaling option that shall be selected when a print dialog is displayed for this document.

StdFontName represents name of a standard font.

Tab order types.

XObjectType represents the type of an XObject.