Module: alfresco/preview/PdfJs/Outline

alfresco/preview/PdfJs/Outline

This module was extracted from the PdfJs previewer plugin that was originally a Share Extras (http://share-extras.github.io/) project and later integrated into Alfresco Share 5.0. It was created exclusively to support the Aikau PdfJs module.

This module is responsible for retrieving and rendering an outline of the previewed PDF document.

Author:
  • Dave Draper
  • Will Abson
  • Kevin Roast
License:
Source:

Members

cssRequirements :object[]

An array of the CSS files to use with this widget.
Type:
  • object[]
Default Value:
  • [{cssFile:"./css/Outline.css"}]
Source:

Methods

onOutlineClick(dest)

Handles click events on any element within the outline.
Parameters:
Name Type Description
dest object The destination to navigate to within the PDF
Source:

postCreate()

If a PDF Plugin has been provided then this function will request an outline for it and call [renderOutline] module:alfresco/preview/PdfJs/Outline#renderOutline when it is provided.
Source:

renderNoOutline(dest)

Renders a message indicating that no outline is available.
Parameters:
Name Type Description
dest object The destination to navigate to within the PDF
Source:

renderOutline(outline)

Renders the outline of the PDF.
Parameters:
Name Type Description
outline object The outline to render.
Source: