Aspose.PDF FOSS for TypeScript

API reference for Aspose.Pdf FOSS for TypeScript v0.1.0. 360 public types organized by module.

Core API

ClassDescription
BackgroundA bare RGB tuple, or the object form when padding is wanted.
BarcodeModelClass in the Pdf TYPESCRIPT API.
BarcodeSpecWhich barcode to draw.
BorderSidesWhich edges of a border box are painted: every edge, no edge, or exactly the ones flagged true (an omitted flag is false, so { bottom: true } is a bottom rule only).
BorderStyleClass in the Pdf TYPESCRIPT API.
ButtonIconPositionWhere a push button’s icon sits relative to its caption — all seven layouts PDF 32000-1 table 189 defines.
CellBuilderOne cell in a table row: a text string, optional per-cell style, and how many columns it spans.
CellHeaderHow a cell is marked in a tagged table: a /TH carrying the given /Scope, or a /TD.
ChoiceOptionOne option of a choice field.
CollectionFieldTypeA schema column: built-in fields derive from the filespec; custom fields (string/date/number) read their value from each file’s /CI.
CollectionViewHow a viewer presents the portfolio.
ColumnWidthA column-width spec: an absolute width in points (fixed), or a share of the leftover space after fixed columns are allotted (fraction).
CommitmentTypeStandard CAdES commitment-type identifiers, or a custom dotted OID string.
ContentItemA marked-content reference owned by a structure element.
ConvertCategoryClass in the Pdf TYPESCRIPT API.
Decoration-svgtextClass in the Pdf TYPESCRIPT API.
Decoration-textdecortrue uses the font’s metrics and the text’s own colour; false is off.
DigestAlgorithmClass in the Pdf TYPESCRIPT API.
DocumentClass with 109 methods and 26 properties.
EdgedA single value, or one-per-edge [top, right, bottom, left].
EditableContentEditable per-stream view of a page’s content (Phase 4 foundation, F1).
EmbeddedFontAn opaque handle to a font program registered with AddFont.
FieldActionsUpdateA field-actions update: an action to set, null to remove that trigger, and an absent key to leave it as it is — the same shape SetStyle takes.
FieldBorderStyleHow a widget’s border is drawn (/BS /S).
FloatingBoxA padded/bordered/filled box of paragraphs and/or an image, floated into a Flow column by flow.AddFloatBox.
FlowA flow layout container.
FlowClearWhich side’s floats an element must clear before it places.
FlowListNodeA list node: a bare string leaf or a FlowListItem that may nest.
FormThe document’s interactive form: terminal fields of the /AcroForm tree.
GoToActionA GoTo action: jump to a page in this document.
GradientClass in the Pdf TYPESCRIPT API.
ImageInfoA single embedded image XObject: a live, read-only handle over its stream.
InlineImageInfoA single BI … EI image drawn on a page, addressed by its position in the content stream that draws it.
InvalidPasswordErrorClass with 1 method.
JavaScriptActionA JavaScript action.
LayerA single optional-content group (layer): a live handle over its /OCG dict.
LayerConfigA viewing configuration (/D or a /Configs entry).
MdAlignGFM table alignment, from the : markers on the delimiter row.
MdBlockClass in the Pdf TYPESCRIPT API.
MdInlineClass in the Pdf TYPESCRIPT API.
MdNodeClass in the Pdf TYPESCRIPT API.
OpenActionWhat a document does when it is opened: go to a view, or run an action.
OptionalContentThe document’s optional-content properties (/OCProperties).
Padding-floatboxClass with 4 properties.
Padding-tableauthorInner cell padding: one value for every side, or an object naming the sides that differ.
PageA single PDF page: a live, mutable handle over its real page dict.
PageFormatA page size in points (1/72").
PageGraphicsA buffered builder for drawing vector content onto a page.
PathSegmentClass with 8 properties.
PdfALevelConformance target: part (1/2/3) + level (b/u/a).
PdfActionAny action this library models, for an annotation’s /A.
PdfParseErrorClass with 1 method.
PdfXLevelPDF/X conformance target.
PubSecRecipientClass with 4 properties.
QrEccClass in the Pdf TYPESCRIPT API.
RGB-annotdrawClass in the Pdf TYPESCRIPT API.
RGB-structattrClass in the Pdf TYPESCRIPT API.
Rect-tablemodelClass extending TextRect.
Rect-textA page-space rectangle [x0,y0,x1,y1] (corners in any order).
ResetActionA ResetForm action: clear the named fields, or every field.
RevocationFetcherA fetcher for revocation material: given the target and its issuer (DER), return the OCSP response / CRL bytes, or undefined when none is available.
RevocationStatusA revocation verdict for one certificate.
RowBuilderOne row: an ordered list of cells plus an optional row-level style.
SaveOptionsOptions for Save/WriteTo.
SeverityClass in the Pdf TYPESCRIPT API.
SignerAny accepted signer: a credential source, or a pre-resolved CmsSigner (certificate DER + KeyObject) for callers that already hold a key.
StdFontClass in the Pdf TYPESCRIPT API.
StreamFilterNameByte-filters this pass can re-encode a stream into.
StructElementA node in the structure tree: a live handle over its real /StructElem dict.
StructTreeRootThe document’s logical structure tree: a live handle over /StructTreeRoot.
SubmitActionA SubmitForm action: send the form’s field values to url.
TableA reconstructed table: a rows×cells model with page-space quads and text, serializable to HTML or Markdown.
TableBuilderA page-independent table: ordered rows over shared text defaults.
TemplateA reusable piece of drawn content, placed on any number of pages from a single Form XObject.
TextFontClass with 6 methods and 10 properties.
TilingPattern-tilingA handle returned by Document.NewTilingPattern.
TimestampProviderA timestamp provider: given a DER TimeStampReq, return either the bare TimeStampToken (a CMS ContentInfo) or a full TimeStampResp.
UnsupportedFeatureErrorClass with 1 method.
UriActionA URI action: open an external URL.
ValidationReportThe result of a validation pass (PDF/UA or PDF/A).
VectorGraphicsA buffered builder for vector content: every path constructor, paint operator, graphics-state setting and marked-content bracket, accumulated in memory as operator text.
XmpUpdateA partial XMP update: each known field may be set, or null to delete.

Interfaces

InterfaceDescription
AddBarcodeOptionsInterface with 8 properties.
AddImageOptionsInterface with 5 properties.
AddImagePagesOptionsInterface with 3 properties.
AddImagePagesResultInterface with 2 properties.
AddLayerOptionsOptions for AddLayer.
AddSVGOptionsOptions for AddSVGObject.
AddSVGResultThe outcome of AddSVGObject.
AddTableOptionsOptions for drawTable / page.AddTable.
AddTableResultThe outcome of drawTable / page.AddTable.
AutoTagOptionsOptions for AutoTag.
AutoTagReportCounts of the elements AutoTag produced.
BackgroundStyleA fill painted behind the glyphs.
BatesOptionsOptions for AddBatesNumbering.
BookletOptionsOptions for Booklet.
BorderEdgesThe four edge flags, resolved from a BorderSides.
BorderInfoA cell/table border: stroke width (pt), RGB colour (0..1), optional dash, and which edges to paint.
CadesAttributesOptional CAdES signed attributes for a PAdES signature.
CellOptionsaddCell options: the per-cell text style plus an optional horizontal span.
CellTextOptionsPer-cell/row text + visual style; each field falls back through the cascade (cell ??.
CertInfoSummary of the signer’s X.509 certificate.
ChainOptionsInterface with 2 properties.
ChainResultInterface with 3 properties.
ChangeOne object that changed in a revision added after a signature.
CheckboxInitOptions for Form.AddCheckbox / Page.AddCheckbox.
ChoiceInitOptions common to both choice field types.
CollectionFieldDefInterface with 6 properties.
CollectionSettingsInterface with 5 properties.
ColoredTilingPatternA tiling pattern that carries its own colours.
ComboBoxInitOptions for Form.AddComboBox / Page.AddComboBox.
ContentAddrAddress of an operator within a page’s content.
ContentOpInterface with 5 properties.
ContentVisitorInterface with 3 methods.
ConvertOptionsInterface with 5 properties.
CrlInterface with 7 properties.
CrlEntryInterface with 2 properties.
DecorationOptionsThe decoration options shared by every text-authoring options type.
DecorationStyleA rule drawn beneath (underline) or through (strikethrough) the text.
DocumentJavaScriptOne entry of the document-level JavaScript name tree.
DocumentTimestampReportVerdict for one document timestamp (/DocTimeStamp): the RFC 3161 token’s time and imprint/TSA-signature checks, plus coverage and the TSA cert.
DrPruneResultInterface with 3 properties.
DssEntryPer-signature validation data to embed under one /VRI entry.
ElemOptsOptions for creating a structure element.
ExportFormDataOptionsInterface with 3 properties.
ExternalSignerSign via an external callback (HSM/KMS/smartcard) — the key never leaves the device.
ExtractPagesOptionsInterface with 1 property.
Field-structattrOne field: its PDF key plus a decode/encode pair.
FieldActionsA field’s additional-actions (/AA), PDF 32000-1 table 197.
FieldInitOptions common to every field-creation entry point.
FieldStyleWidgetStyle plus the /DA text half.
FloatBoxImageOptionsOptions for AddImage.
FloatBoxOptionsOptions for NewFloatingBox.
FlowCodeOptionsOptions for codeBlock / Flow.AddCodeBlock.
FlowElementA unit of flow content.
FlowHeadingOptionsOptions for AddHeading.
FlowImageOptionsOptions for AddImage.
FlowListItemOne nested-list item.
FlowListOptionsOptions for AddList.
FlowOptionsOptions for NewFlow.
FlowParagraphOptionsTypographic options for AddParagraph (a subset of the text-block options; flow content is always laid top-down, so valign is not offered).
FlowQuoteBarThe bar drawn down a quote’s gutter.
FlowQuoteOptionsOptions for quote / Flow.AddQuote.
FlowRuleOptionsOptions for rule / Flow.AddRule.
FlowTableOptionsOptions for table / Flow.AddTable.
FontFamilyThe four faces emphasis selects between, loaded from disk.
FontMatchWhat a name resolves to – reported without loading or embedding anything.
FontOptimizationInterface with 4 properties.
FormDataInterface with 5 properties.
FormDataFieldOne field’s data, format-neutral.
G4EncodeOptionsInterface with 1 property.
GradientStopOne gradient stop.
GrayImageResultInterface with 4 properties.
GraySkippedInterface with 3 properties.
GrayscaleOptionsDocument-wide grayscale conversion.
GrayscaleReportInterface with 8 properties.
HeaderFooterBandOne band of a header/footer: up to three independently-positioned cells.
HeaderFooterOptionsOptions for AddHeaderFooter.
HtmlOptionsOptions for ToHtml and ToHtml.
ImageEventA placed image with provenance.
ImageOptimizationInterface with 7 properties.
ImportOptionsOptions for the four import methods.
ImportReportInterface with 8 properties.
InsertPagesOptionsInterface with 1 property.
LayoutAttributesInterface with 32 properties.
LinearBarcode1D barcode geometry: alternating bar/space run widths in unit modules.
LinearGradientAn axial (linear) gradient: a colour ramp along the axis from (x1, y1) to (x2, y2), in the default user space of the content stream it paints into — see the /Matrix note on PageGraphics.setFillGradient.
LinearizationCheckInterface with 2 properties.
ListAttributesInterface with 1 property.
ListBoxInitOptions for Form.AddListBox / Page.AddListBox.
LoadFontOptionsA style request alongside the ordinary font options.
MatrixBarcode2D barcode geometry: a square matrix of dark/light modules, row-major.
MdBlockQuoteInterface with 2 properties.
MdCodeInterface with 2 properties.
MdCodeBlockinfo is the raw info string of a fenced block, entity-decoded and backslash-unescaped but not split on whitespace; ’’ for an indented block.
MdDocumentThe CommonMark abstract syntax tree, per CommonMark 0.31.2.
MdEmphInterface with 2 properties.
MdHardBreakInterface with 1 property.
MdHeadingLevel 1..6, identical for the ATX (# x) and setext (x\n=) spellings.
MdHtmlBlockRaw HTML, verbatim.
MdHtmlInlineInterface with 2 properties.
MdImageInterface with 4 properties.
MdItemInterface with 3 properties.
MdLinkInline and reference links are indistinguishable here: both carry a resolved destination and title, which is what gl6o.3 wants.
MdListtight decides whether an item’s paragraphs render as paragraphs (loose) or as bare content (tight).
MdParagraphInterface with 2 properties.
MdSoftBreakInterface with 1 property.
MdStrikethroughGFM strikethrough.
MdStrongInterface with 2 properties.
MdTablealign carries one entry per column, null where the delimiter row gave none — which is not the same as ’left’, since a renderer may have its own default.
MdTableCellHolds inlines, like a paragraph does.
MdTableRowInterface with 3 properties.
MdTextInterface with 2 properties.
MdThematicBreakInterface with 1 property.
MetadataInterface with 9 properties.
MetadataUpdateInterface with 9 properties.
NUpOptionsInterface with 5 properties.
ObjStmDamageWhat one /ObjStm container yielded, and what it cost.
OcspResponseInterface with 7 properties.
OcspSingleResponseInterface with 8 properties.
OoxmlPartOne part of an OPC package.
OoxmlRelationshipOne entry of a .rels file.
OpenOptionsInterface with 2 properties.
OptimizeImageOptionsTarget for the lossy image pass.
OptimizeOptionsWhich concerns to run.
OptimizeReportInterface with 13 properties.
OverlayOptionsInterface with 5 properties.
PageLabelA logical page-label range in the /Root /PageLabels number tree.
PagePathInterface with 11 properties.
PathEventA painted vector path, its subpaths flattened to page-space segments.
PathPaintInterface with 2 properties.
PathSubpathInterface with 2 properties.
PdfUaConvertOptionsInterface with 3 properties.
PdfXConvertOptionsInterface with 9 properties.
PemSignerSign from a PEM private key plus its PEM/DER certificate chain (leaf first).
Pkcs12SignerSign from a PKCS#12 (.pfx/.p12) blob; the key and chain are extracted.
PlaceContextWhere an element is being placed.
PlaceElementsOptionsOptions for placeElements.
PlaceElementsResultResult of placeElements.
PlaceOptionsOptions for PlaceOn.
PlaceResultOutcome of place.
PrunePolicyInterface with 1 method and 1 property.
PushButtonInitOptions for Form.AddPushButton / Page.AddPushButton.
QrOptionsInterface with 2 properties.
QuantizedThe result of quantizing an image.
RadialGradientA radial gradient: the ramp runs from the focal point out to the circle (cx, cy, r).
RadioGroupInitOptions for Form.AddRadioGroup.
RadioOptionOne button of a radio group.
RecoveryReportHow Open obtained its cross-reference data.
Rect-barcodeplaceA dark rectangle in PDF user space.
RegionHitsGlyph and image events intersecting a set of regions.
RemoveImageOptionsOptions for removeImage / ImageInfo.Remove.
ReplaceImageOptionsOptions for replaceImage / ImageInfo.Replace.
ResizeOptionsInterface with 1 property.
ResolvedFamilyA family with all four faces filled.
ResolvedPaddingPadding with every side settled to a number.
RevocationMaterialRaw revocation material for one certificate (DER bytes, as fetched).
RevocationResultInterface with 2 properties.
RowOptionsaddRow options: the row-level text style plus row-only geometry.
SearchOptionsScope for a text search.
SigAlgSignature algorithm passed to an external signer callback: the public-key scheme plus the message-digest algorithm to hash the data with.
SignerLocationCAdES signer-location signed attribute (all fields optional).
SignerOptionsOptions common to the credential-source signer variants.
SkippedFontInterface with 2 properties.
SkippedFrameInterface with 2 properties.
SkippedImageInterface with 3 properties.
SplitOptionsInterface with 2 properties.
SvgOptionsInterface with 2 properties.
TableAttributesInterface with 5 properties.
TableCellInterface with 13 properties.
TableDefaultsTable-level defaults; the cascade root, plus table-only fields.
TableExtractOptionsInterface with 2 properties.
TableMetricsMeasurement result for a table at given resolved column widths.
TableRowInterface with 3 properties.
TableStitchOptionsInterface with 1 property.
TextBlockA paragraph-like cluster of consecutive lines, ordered top-to-bottom.
TextFieldInitOptions for Form.AddTextField / Page.AddTextField.
TextFragmentA positioned text run sharing one font, size, and baseline — the public unit of structured extraction (Page.GetTextFragments).
TextLineInterface with 4 properties.
TextMatchA positioned text match.
TextRunOne styled span of a rich text block.
TilingPattern-pagerenderA resolved PatternType 1 (tiling) pattern.
TilingPatternOptionsPlacement and repetition for a tiling pattern.
TimestampInfoVerdict on a signature timestamp: the asserted time plus whether the token binds to the signature (imprint) and whether the TSA’s signature is valid.
TrailerChoiceWhat trailer synthesis chose.
TstInfoInterface with 6 properties.
UncoloredTilingPatternA tiling pattern whose colour is supplied at use time.
ValidationDataOptionsOptions for AddValidationData: callbacks that fetch the OCSP response / CRL for each signer, plus any extra certificates to embed (e.g.
ValidationIssueA single validation finding.
VerifyOptionsOptions for VerifySignatures.
WatermarkOptionsOptions for AddWatermark.
WidgetStyle/MK + /BS: what a widget’s box looks like.
XmpMetadataStructured view of a document’s XMP packet (read side).
ZipEntryOne file in an archive.

Annotations

ClassDescription
AnnotationA live, mutable handle over an annotation dictionary.
AnnotationTextKeyThe annotation entries that count as carried text.
AuthoringFontA font for the text-authoring API: one of the 12 Latin Standard-14 faces (by name) or an embedded font handle from AddFont.
CaretAnnotationA /Caret annotation (PDF 32000-1 §12.5.6.11): a text-insertion mark, drawn as a wedge at the point where text should be added, optionally with a paragraph sign.
FileAttachmentAnnotationA /FileAttachment annotation: an icon on the page whose /FS embeds a file.
LinkAction@deprecated Use PdfAction.
LinkAnnotationA /Link annotation.
MarkupAnnotationA text-markup annotation (/Highlight, /Underline, /StrikeOut, /Squiggly) positioned by /QuadPoints (8 numbers per marked quad).
MarkupTypeThe four text-markup subtypes, lower-cased.
RedactAnnotationA /Redact annotation (PDF 32000-1 §12.5.6.23): a mark over a region, plus the overlay to paint when it is applied.
StampAnnotationA /Stamp (rubber-stamp) annotation.
StampPositionWhere a stamp anchors in the page’s visual frame.
TextAnnotationA /Text (sticky-note) annotation: an icon-and-popup markup with no appearance stream.

Interfaces

InterfaceDescription
AnnotDataInterface with 4 properties.
AnnotationMatchA match in the text one annotation’s appearance stream draws.
AnnotationTextMatchA match in the text an annotation CARRIES, rather than the text it draws.
CaretOptionsOptions for Page.AddCaret.
FileAttachmentOptionsOptions for AddFileAttachment.
ImportedAnnotAn annotation that was applied to the document.
LinkOptionsOptions for Page.AddLink.
MarkupOptionsOptions for the Page.Add{Highlight,Underline,StrikeOut,Squiggly} methods.
RedactAnnotationOptionsOptions for Page.AddRedact.
SkippedAnnotAn annotation that was present in the data file but not applied.
StampAnnotationOptionsOptions for Page.AddStamp.
StampOptionsOptions for stamping text onto a page.
StampWithOptionsInterface with 4 properties.
TextBlockOptionsOptions for flowing wrapped text into a rectangle.
TextNoteOptionsOptions for Page.AddTextNote.
TimeStampRequestInfoInterface with 3 properties.
TimeStampRequestOptionsInterface with 3 properties.
TimeStampTokenOptionsInterface with 3 properties.

Attachments

ClassDescription
AttachmentA live handle over one embedded file’s /Filespec.

Interfaces

InterfaceDescription
AttachmentOptionsOptions shared by document-level attachments and FileAttachment annotations.

Conversion

ClassDescription
ImageFormatWhat ImageOptions.format accepts.
MarkdownFontSpecA single face (whose family is derived when it is Standard-14) or an explicit family.

Interfaces

InterfaceDescription
AddMarkdownResultWhat AddMarkdown reports.
ConversionReportThe result of a conversion run: what was applied, what still fails, pass flag.
ConvertActionOne remediation performed by a converter (PDF/A or PDF/UA).
DocxExtrasParts and relationships a caller adds beside the minimal set — styles, numbering, images.
DocxOptionsOptions for ToDocx and ToDocx.
EpubOptionsOptions for ToEpub.
ImageOptionsInterface with 9 properties.
MarkdownAssetOne image file an external-image export expects to be written.
MarkdownElementsWhat markdownElements produced.
MarkdownExportOptionsOptions for ToMarkdown and ToMarkdown.
MarkdownExportResultMarkdown plus the image files it references.
MarkdownFlowOptionsOptions for the Markdown entry points.
MarkdownFontFamilyThe four faces emphasis selects between.
MarkdownOptionsOptions for parseMarkdown.
MarkdownResultWhat a Markdown entry point reports.
MarkdownStyleHow Markdown renders.
TiffEncodeOptionsInterface with 1 property.
TiffExportOptionsOptions for renderDocumentToTiff.
TiffFrameOne page of a TIFF.

Forms

ClassDescription
ButtonFieldA push button (/FT /Btn with the Pushbutton flag).
CheckboxFieldA checkbox (/FT /Btn, neither Pushbutton nor Radio).
ChoiceFieldA combo box or list box (/FT /Ch).
Field-formfieldA terminal AcroForm field: a live, mutable handle over its field dict.
FieldTypeClass in the Pdf TYPESCRIPT API.
RadioFieldA radio group (/FT /Btn with the Radio flag).
TextFieldA text field (/FT /Tx).

Redaction

ClassDescription
MarkRedactTextOptionsOptions for Page.MarkRedactText — everything AddRedact takes except the geometry, which comes from the search hit, plus the search scope.

Interfaces

InterfaceDescription
ApplyRedactionsOptionsOptions for Page.ApplyRedactions / Document.ApplyRedactions.
RedactOptionsOptions for redactPage / page.Redact / doc.Redact.

Security

ClassDescription
DocMdpPermissionDocMDP permitted-changes level for a certification signature (PDF 32000-1 §12.8.2.2): the /P value in the DocMDP /TransformParams.
SignatureSchemeClass in the Pdf TYPESCRIPT API.

Interfaces

InterfaceDescription
CertifyOptionsOptions for Certify: a SignOptions plus the DocMDP permitted-changes level (default no-changes).
DocumentTimestampOptionsOptions for AddDocumentTimestamp.
EncryptOptionsInterface with 5 properties.
PermissionsInterface with 8 properties.
PubSecEncryptOptionsInterface with 6 properties.
PubSecRecipientCertInterface with 2 properties.
SignOptionsInterface with 12 properties.
SignatureAppearanceA visible signature appearance request.
SignatureFieldRead-side view of a signature field (always available, like doc.Form).
SignatureReportInterface with 13 properties.

Structure

ClassDescription
OutlineDestAn outline or link target: an explicit page, or a named destination.
OutlineViewA PDF 32000-1 §12.3.2.2 destination view.

Interfaces

InterfaceDescription
AddTOCResultThe outcome of drawTOC / page.AddTOC.
NamedDestA destination given by name, resolved by the viewer through the document’s named-destination tables rather than at write time.
NamedDestinationA named destination: a name plus its resolved target.
OutlineItemA node in the document outline (bookmark) tree.
PageDestA page destination: 1-based page number plus an optional view.
TOCEntryOne row of a table of contents.
TOCOptionsOptions for AddTOC.

Text

InterfaceDescription
GlyphEventA positioned glyph with provenance back to the operator that drew it.