UIConsts

UIConsts module is an Object, All current available constants of UIExtension module are mount to this object. You can access the constant like this examples in the following: More...

Enumerations
enum	COMPONENT_EVENTS {   DISABLE, ENABLE, ACTIVE, DEACTIVE,   SHOWN, HIDDEN, DESTROYED, REMOVED,   INSERTED, MOUNTED, CLOSED, EXPAND,   RESIZESTART, RESIZE, COLLAPSE }
	component events More...
enum	FRAGMENT_ACTION {   BEFORE, AFTER, APPEND, PREPEND,   INSERT, FILL, REPLACE, EXT,   REMOVE }
	fragment action enumeration More...
enum	Loading_Mode { fromFileObject, fromMemory }
	Loading mode of UIExtension. More...

Variables
export const	WEBPDF_VIEWER_COMPONENT_NAME = 'pdf-viewer'
	This variable is used to get the PDFViewerComponent instance from a PDFUI instance.

Detailed Description

UIConsts module is an Object, All current available constants of UIExtension module are mount to this object. You can access the constant like this examples in the following:

const FRAGMENT_ACTION = UIExtension.UIConsts.FRGMENT_ACTION;
new PDFUI({
 //...
 fragments: [{
     action: FRAGMENT_ACTION.EXT,
     config: {
         // ...
     }
 }]
})

Enumeration Type Documentation

COMPONENT_EVENTS

enum COMPONENT_EVENTS

component events

Enumerator
DISABLE	Triggered after a component has been disabled. component.on(UIExtension.UIConsts.COMPONENT_EVENTS.DISABLE, function(){ })
ENABLE	Triggered after a component has been enabled. component.on(UIExtension.UIConsts.COMPONENT_EVENTS.ENABLE, function(){ })
ACTIVE	Triggered after a component has been activated. component.on(UIExtension.UIConsts.COMPONENT_EVENTS.ACTIVE, function(){ })
DEACTIVE	Triggered after a component has been deactivated. component.on(UIExtension.UIConsts.COMPONENT_EVENTS.DEACTIVE, function(){ })
SHOWN	Triggered after a component is showing on screen. component.on(UIExtension.UIConsts.COMPONENT_EVENTS.SHOWN, function(){ })
HIDDEN	Triggered after a component has been hidden. component.on(UIExtension.UIConsts.COMPONENT_EVENTS.HIDDEN, function(){ })
DESTROYED	Triggered after a component is destroyed. component.on(UIExtension.UIConsts.COMPONENT_EVENTS.DESTROYED, function(){ })
REMOVED	Triggered after a component has been removed from it's parent. component.on(UIExtension.UIConsts.COMPONENT_EVENTS.REMOVED, function(){ })
INSERTED	Triggered after a component has been inserted into a component . component.on(UIExtension.UIConsts.COMPONENT_EVENTS.INSERTED, function(){ })
MOUNTED	Triggered after a component's element has been inserted into DOM tree . component.on(UIExtension.UIConsts.COMPONENT_EVENTS.MOUNTED, function(){ })
CLOSED	Triggered after a LayerComponent has been closed. component.on(UIExtension.UIConsts.COMPONENT_EVENTS.CLOSED, function(){ })
EXPAND	Triggered after a SidebarComponent has been expanded. component.on(UIExtension.UIConsts.COMPONENT_EVENTS.EXPAND, function(){ })
RESIZESTART	Triggered when a SidebarComponent start to resize. component.on(UIExtension.UIConsts.COMPONENT_EVENTS.RESIZESTART, function(){ })
RESIZE	Triggered when a SidebarComponent is resizing. component.on(UIExtension.UIConsts.COMPONENT_EVENTS.RESIZE, function(){ })
COLLAPSE	Triggered after a SidebarComponent has been collapsed. component.on(UIExtension.UIConsts.COMPONENT_EVENTS.COLLAPSE, function(){ })

FRAGMENT_ACTION

enum FRAGMENT_ACTION

fragment action enumeration

Enumerator
BEFORE	insert before the target component
AFTER	insert after the target component
APPEND	append into the target component
PREPEND	prepend into the target component
INSERT	insert at the specified index of the target component
FILL	clear all children of the target component and append to it
REPLACE	remove target component and replace it
EXT	extend the configuration of target component
REMOVE	remove target component

Loading_Mode

enum Loading_Mode

Loading mode of UIExtension.

Enumerator
fromFileObject	Web SDK will load PDF document from File, Blob object or remote file. Refer to PDFViewer.openPDFByFile().
fromMemory	Web SDK will load PDF document from memory. Refer to PDFViewer.openPDFByFile().