Options
All
  • Public
  • Public/Protected
  • All
Menu

GcDocs PDF Viewer - v1.2.88

Index

Type aliases

AnnotationMarkedStateType

AnnotationMarkedStateType: "Marked" | "Unmarked"

Marked states.

AnnotationReviewStateType

AnnotationReviewStateType: "None" | "Accepted" | "Cancelled" | "Completed" | "Rejected"

Review states.

AnnotationStateModel

AnnotationStateModel: "Marked" | "Review"

Annotation state model.

AnnotationTypeName

AnnotationTypeName: "Text" | "Link" | "FreeText" | "Line" | "Square" | "Circle" | "Polygon" | "PolyLine" | "Highlight" | "Underline" | "Squiggly" | "Strikeout" | "Stamp" | "Caret" | "Ink" | "Popup" | "FileAttachment" | "Sound" | "Movie" | "Widget" | "Screen" | "PrinterMark" | "TrapNet" | "WaterMark" | "Redact" | "Signature" | "ThreadBead" | "RadioButton" | "Checkbox" | "PushButton" | "Choice" | "TextWidget"

Annotation type.

GcRightSidebarState

GcRightSidebarState: "collapsed" | "expanded" | "hidden"

Right sidebar state.

GcRightSidebarTool

GcRightSidebarTool: "none" | "reply-tool"

Right sidebar tool.

LineEndStyle

LineEndStyle: "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash"

Line end style.

WidgetFieldTypeName

WidgetFieldTypeName: "Tx" | "Btn" | "Ch"

Field widget type.

Functions

applyInverseTransform

  • applyInverseTransform(p: number[], m: number[]): number[]
  • Apply inverse matrix transformation.

    Parameters

    • p: number[]

      x, y point

    • m: number[]

      transform matrix

    Returns number[]

applyTransform

  • applyTransform(p: number[], m: number[]): number[]
  • Apply matrix transform.

    Parameters

    • p: number[]

      x, y point

    • m: number[]

      transform matrix

    Returns number[]

buildAudioFile

  • buildAudioFile(audioData: Uint8Array, audioOptions: { bytesPerSample: number; numChannels: number; sampleRate: number; subchunk2Size: number }): Uint8Array
  • Build sound file using audio data provided by parameter audioData and audioOptions used to generate RIFF header.

    Parameters

    • audioData: Uint8Array
    • audioOptions: { bytesPerSample: number; numChannels: number; sampleRate: number; subchunk2Size: number }
      • bytesPerSample: number
      • numChannels: number
      • sampleRate: number
      • subchunk2Size: number

    Returns Uint8Array

buildWaveHeader

  • buildWaveHeader(opts: { bytesPerSample: number; numChannels: number; sampleRate: number; subchunk2Size: number }): ArrayBuffer
  • Build a header for the WAVE audio format.

    Parameters

    • opts: { bytesPerSample: number; numChannels: number; sampleRate: number; subchunk2Size: number }
      • bytesPerSample: number
      • numChannels: number
      • sampleRate: number
      • subchunk2Size: number

    Returns ArrayBuffer

changeRectangleOrigin

  • changeRectangleOrigin(bounds: number[], viewBox: number[], destOrigin?: "TopLeft" | "BottomLeft"): number[]
  • Change bounds origin.

    Parameters

    • bounds: number[]
    • viewBox: number[]
    • Default value destOrigin: "TopLeft" | "BottomLeft" = "BottomLeft"

    Returns number[]

classListContains

  • classListContains(element: HTMLElement, className: string): boolean
  • Cross-browser element.classList.contains

    Parameters

    • element: HTMLElement

      HTML DOM element

    • className: string

      Class name without dot.

    Returns boolean

convertToPdfPoint

  • convertToPdfPoint(x: number, y: number, transform: number[]): number[]
  • Converts viewport coordinates to the PDF location. For examples, useful for converting canvas pixel location into PDF one.

    see

    convertToViewportPoint

    Parameters

    • x: number

      The x-coordinate.

    • y: number

      The y-coordinate.

    • transform: number[]

    Returns number[]

    Array containing x and y properties of the point in the PDF coordinate space.

convertToViewportPoint

  • convertToViewportPoint(x: number, y: number, transform: number[]): number[]
  • Converts PDF point to the viewport coordinates. For examples, useful for converting PDF location into canvas pixel coordinates.

    see

    convertToPdfPoint

    see

    {@link convertToViewportRectangle}

    Parameters

    • x: number

      The x-coordinate.

    • y: number

      The y-coordinate.

    • transform: number[]

    Returns number[]

    Array containing x and y properties of the point in the viewport coordinate space.

createBlob

  • createBlob(data: any, contentType?: string): Blob
  • Creates a Blob object which represents a file-like object of immutable, raw data.

    Parameters

    • data: any

      ArrayBuffer, ArrayBufferView, Blob or DOMString object

    • Default value contentType: string = ""

      The content type to assign to the new Blob; this will be the value of its type property. The default value is an empty string.

    Returns Blob

createObjectURLClosure

  • createObjectURLClosure(): createObjectURL
  • Creates ObjectURL closure. Used when Blob/createObjectURL is not available, falling back to data schema.

    Returns createObjectURL

downloadData

  • downloadData(data: Blob | BlobPart | Uint8Array | ArrayBuffer | ArrayBufferView | string, filename?: undefined | string, contentType?: string): boolean
  • Download binary data.

    Parameters

    • data: Blob | BlobPart | Uint8Array | ArrayBuffer | ArrayBufferView | string
    • Optional filename: undefined | string
    • Default value contentType: string = "application/octet-stream"

    Returns boolean

downloadUrl

  • downloadUrl(fileUrl: string, filename?: undefined | string): boolean
  • Download file using specified URL.

    Parameters

    • fileUrl: string
    • Optional filename: undefined | string

    Returns boolean

ensureResizableDialogBehavior

  • ensureResizableDialogBehavior(dialog: HTMLElement, dragHandleClass?: string, allowResize?: boolean, minHeight?: number, minWidth?: number): void
  • Ensure ResizableDialogBehavior is attached.

    Parameters

    • dialog: HTMLElement

      dialog element to be dragged and resized.

    • Default value dragHandleClass: string = "draghandle"

      class name for drag handle(s)

    • Default value allowResize: boolean = true

      allow resize dialog

    • Default value minHeight: number = 200

      minimum dialog height

    • Default value minWidth: number = 300

      minimum dialog width

    Returns void

findElementIndex

  • findElementIndex(el: Element): number
  • Get element's numerical index in its parent element.

    Parameters

    • el: Element

      HTML DOM element

    Returns number

findSelfOrAncestor

  • findSelfOrAncestor(el: HTMLElement | null, className: string): HTMLElement | null
  • Search parent element by class name.

    Parameters

    • el: HTMLElement | null

      HTML DOM element

    • className: string

      Class name without dot.

    Returns HTMLElement | null

findSelfOrAncestorAttr

  • findSelfOrAncestorAttr(el: HTMLElement | null, attrName: string): HTMLElement | null
  • Search parent element by attribute name.

    Parameters

    • el: HTMLElement | null

      HTML DOM element

    • attrName: string

    Returns HTMLElement | null

getCharacterType

  • getCharacterType(charCode: any): number

getEventTarget

  • getEventTarget(e: any): any
  • Find correct event target.

    Parameters

    • e: any

    Returns any

isDescendant

  • isDescendant(child: Element, parent: Element): boolean
  • Checks if element is nested within parent element on any level.

    Parameters

    • child: Element
    • parent: Element

    Returns boolean

makeAbsoluteUrl

  • makeAbsoluteUrl(relativeUrl: string, baseUrl?: undefined | string): string
  • Make absolute url from relative one.

    Parameters

    • relativeUrl: string

      Relative url.

    • Optional baseUrl: undefined | string

      Optional, base url for result url concatenation

    Returns string

pdfDateStringToDate

  • pdfDateStringToDate(input?: string | Date): Date | null
  • Convert a PDF date string to a JavaScript Date object.

    The PDF date string format is described in section 7.9.4 of the official PDF 32000-1:2008 specification. However, in the PDF 1.7 reference (sixth edition) Adobe describes the same format including a trailing apostrophe. This syntax in incorrect, but Adobe Acrobat creates PDF files that contain them. We ignore all apostrophes as they are not necessary for date parsing.

    Moreover, Adobe Acrobat doesn't handle changing the date to universal time and doesn't use the user's time zone (effectively ignoring the HH' and mm' parts of the date string).

    Parameters

    • Optional input: string | Date

    Returns Date | null

scrollIntoView

  • scrollIntoView(element: HTMLElement, spot: { left?: undefined | number; top?: undefined | number }, skipOverflowHiddenElements?: boolean, parent?: any | null): void
  • Scrolls specified element into view of its parent. Note, by default scrolling is done according offsetParent, so, check parent position style if needed.

    Parameters

    • element: HTMLElement

      The element to be visible.

    • spot: { left?: undefined | number; top?: undefined | number }

      An object with optional top and left properties, specifying the offset from the top left edge.

      • Optional left?: undefined | number
      • Optional top?: undefined | number
    • Default value skipOverflowHiddenElements: boolean = false

      Ignore elements that have the CSS rule overflow: hidden; set. The default is false.

    • Default value parent: any | null = null

    Returns void