DOCSEARCHbyAlgolia
Submit Docs

Apryse Web SDK API Reference

website·Indexed 38 days ago

https://sdk.apryse.com/api/web/index.html

API documentation for the Apryse Web SDK, featuring the Core.PDFNet namespace for PDF manipulation, text extraction, and annotation management (including TextAnnot, SquareAnnot, and SignatureWidget), as well as Core.SpreadsheetEditor for spreadsheet cell and chart management and UI components like Panel and ModularHeader.

Tokens
544.5K
Snippets
4.1K
Records
5.3K
Agent score
59%

What's inside Apryse

  1. Overview of PDF Actions in Apryse Web SDK

    The Core.Actions namespace manages PDF actions and their dispatching. Actions are defined using JavaScript objects containing a name property (which specifies the action subtype) and other properties specific to that action type.

  2. Overview of the Core.PDFNet.Page class

    The Core.PDFNet.Page class is a high-level representation of a PDF page object. It manages the page tree and contains associated objects such as elements drawn on the page, resources used for drawing, annotations, beads, private metadata, and optional thumbnail images.

  3. Overview of PDFNet.NameTree

    A NameTree is a PDF data structure used to associate keys (strings) with values (objects). It is similar to a dictionary but is optimized for very large collections of associations, allowing for more entries than a standard SDF/Cos dictionary. NameTrees support Unicode encoding and are typically located within the /Root/Names dictionary of a PDF document.

  4. Overview of Apryse WebViewer

    WebViewer is a JavaScript Document SDK and UI Component Library used to view, annotate, and edit various file formats including PDF, DOCX, XLSX, PPTX, images, videos, audio, and CAD. It provides a responsive out-of-the-box UI and is compatible with major JS frameworks such as React, Angular, Vue, Next.js, Nuxt, Electron, and Svelte, as well as platforms like Salesforce, Mendix, Appian, OutSystems, and SharePoint.

  5. Overview of the Convert utility class

    The Convert class is used to convert documents and files to PDF. Conversion of XPS, EMF, and image files is performed internally. Other document formats are converted using native applications and printing.

  6. Overview of PDFDocInfo for document metadata

    PDFDocInfo is a high-level utility class used to read and modify a PDF document's metadata. While it can be instantiated via a static create method, it is typically obtained more easily using PDFDoc.GetDocInfo().

  7. Overview of PDFNet.MarkupAnnot

    MarkupAnnot is the base class for various PDF markup annotation types used to mark up documents. These annotations typically include text that appears in the annotation or a pop-up window (specified in the Contents entry).

    Markup annotations are categorized as:

    • Free text annotations: Display text directly on the page.
    • Pop-up based annotations: Use a pop-up window for text (e.g., text, line, square, circle, polygon, polyline, highlight, underline, squiggly-underline, strikeout, rubber stamp, caret, ink, and file attachment).
    • Sound annotations: Do not have pop-ups but may have associated text.
    • TextMarkup: A subset specifically for marking up document text (e.g., highlight, strikeout, jagged, underline).

    Note: When separating text into paragraphs within the Contents entry, a CARRIAGE RETURN (0Dh) must be used.

  8. Overview of FDFDoc

    The FDFDoc class represents Forms Data Format (FDF) documents. FDF is used to submit form data to a server, receive responses to incorporate into interactive forms, or export form data to stand-alone files for electronic transmission and import back into PDF interactive forms. Starting with PDF 1.3, FDF can also serve as a container for annotations separate from the PDF document. Note that certain methods in FDFDoc may count as a document for consumption-based licensing if the object was not created via PDFDoc::FDFExtract().

  9. Overview of RedactionAnnot

    The RedactionAnnot class (extending MarkupAnnot) is used to identify content intended for removal from a PDF 1.7 document. Redaction is a two-step process: first, a user applies redaction annotations to mark regions for removal (non-destructive identification); second, the application applies these annotations to permanently remove the content and replace it with a marking. Conforming readers must destroy the actual data (including image portions, XFA, and XMP content) rather than simply masking it.

  10. Overview of OCMD (Optional Content Membership Dictionary)

    The OCMD object represents an Optional Content Membership Dictionary. It is used to make the visibility of optional content depend on the states of a set of optional-content groups (OCG::Group). By defining a visibility policy, you can create complex dependencies—for example, making an object visible only if all associated layers are ON, or if at least one is OFF.

  11. Overview of PDF Shading types in PDFNet

    The Shading class represents a flat interface for all PDF shading types. The supported types include:

    • Function-based (Type 1): Color is defined by a mathematical function over a domain.
    • Axial (Type 2): Color blend along a line between two points.
    • Radial (Type 3): Color blend between two circles, often used for 3D spheres/cones.
    • Free-form Gouraud-shaded triangle mesh (Type 4) and Lattice Gouraud (Type 5): Used for complex 3D shapes using triangle meshes and Gouraud interpolation.
    • Coons patch mesh (Type 6): Constructed from color patches bounded by four cubic Bezier curves.
    • Tensor-product patch mesh (Type 7): Similar to Coons patches but based on a bicubic tensor-product patch with 16 control points for greater color mapping control.

  12. Overview of Core.PDFNet.Action

    The Core.PDFNet.Action class defines actions performed by viewer applications when interacting with links, bookmarks, or annotations. Common actions include jumping to a destination, launching an application, playing a sound, or changing an annotation's appearance state. While the Action class provides utility functions for common types, any action type can be read, written, or edited using the SDF API and dictionary entries.