LiPdfViewerComponent class

Annotations

• @Component.new(selector: 'li-pdf-viewer', templateUrl: 'pdf_viewer_component.html', styleUrls: ['pdf_viewer_component.css'], directives: [coreDirectives, formDirectives, LiDropdownMenuComponent, LiModalComponent], changeDetection: ChangeDetectionStrategy.onPush)

Constructors

LiPdfViewerComponent(ChangeDetectorRef _changeDetectorRef, HtmlElement _hostElement)

Properties

allowKeyboardShortcuts ↔ bool

getter/setter pair

bytes ← Uint8List?

no getter

cMapPacked ↔ bool

getter/setter pair

cMapUrl ↔ String

getter/setter pair

currentPage ↔ int

getter/setter pair

currentScaleLabel → String

no setter

currentScaleValueForSelect → String

no setter

customScaleValue ↔ String

getter/setter pair

customToolbarActions ↔ List<LiPdfViewerToolbarAction>

getter/setter pair

debug ↔ bool

getter/setter pair

documentLoaded → Stream<int>

no setter

downloadFileName ↔ String

getter/setter pair

enableDownloadAction ↔ bool

getter/setter pair

enableFitWidthAction ↔ bool

getter/setter pair

enableFullscreenAction ↔ bool

getter/setter pair

enableGoToPageAction ↔ bool

getter/setter pair

enablePanModeAction ↔ bool

getter/setter pair

enablePrintAction ↔ bool

getter/setter pair

enableRotateAction ↔ bool

getter/setter pair

enableSidePanelCloseButton ↔ bool

getter/setter pair

errorMessage ↔ String?

getter/setter pair

fullscreenButtonLabel → String

no setter

fullscreenIconClass → String

no setter

goToPageInputText ↔ String

getter/setter pair

goToPageModal ↔ LiModalComponent?

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

hasSidePanelHeader → bool

no setter

hasSidePanelTemplate → bool

no setter

hasToolbarActionsTemplate → bool

no setter

initialScale ← String

no getter

isCustomScale ↔ bool

getter/setter pair

isFullscreenActive → bool

no setter

isLoading ↔ bool

getter/setter pair

isMobileViewport → bool

no setter

isPanModeEnabled → bool

no setter

labels ↔ LiPdfViewerLabels

getter/setter pair

leadingCustomToolbarActions ↔ List<LiPdfViewerToolbarAction>

getter/setter pair

linkSanitizer ↔ LiPdfViewerLinkSanitizer?

getter/setter pair

loadError → Stream<String>

no setter

pageChange → Stream<int>

no setter

pageCounterLabel → String

no setter

pageInputSize → int

no setter

pageInputSizeAttr → String

no setter

pageInputWidth → String

no setter

panModeButtonLabel → String

no setter

panModeIconClass → String

no setter

passwordVisible → bool

no setter

pdfDesktopOverflowActionOptions ↔ List<LiDropdownMenuOption>

getter/setter pair

pdfDocument → PDFDocumentProxy?

no setter

pdfJsBasePath ↔ String

getter/setter pair

pdfMobileActionOptions ↔ List<LiDropdownMenuOption>

getter/setter pair

projectedSidePanelTemplate ↔ LiPdfViewerSidePanelDirective?

getter/setter pair

projectedToolbarActionsTemplate ↔ LiPdfViewerToolbarActionsDirective?

getter/setter pair

requestHeaders ↔ Map<String, String>

getter/setter pair

resolvedSidePanelTemplate → TemplateRef?

no setter

resolvedSidePanelTitle → String?

no setter

resolvedSidePanelWidth → String

no setter

resolvedToolbarActionsTemplate → TemplateRef?

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

scale → double

no setter

scaleChange → Stream<double>

no setter

shouldShowInlineSidePanel → bool

no setter

showEmptyState → bool

no setter

showTitle ↔ bool

getter/setter pair

sidePanelModal ↔ LiModalComponent?

getter/setter pair

sidePanelModalOnMobile ↔ bool

getter/setter pair

sidePanelOpen ↔ bool

getter/setter pair

sidePanelOpenChange → Stream<bool>

no setter

sidePanelTemplate ↔ TemplateRef?

getter/setter pair

sidePanelTitle ↔ String

getter/setter pair

sidePanelWidth ↔ String

getter/setter pair

standardFontDataUrl ↔ String

getter/setter pair

templateContext → LiPdfViewerTemplateContext

late, final

title ↔ String

getter/setter pair

toolbarAction → Stream<LiPdfViewerToolbarActionEvent>

no setter

toolbarActionsTemplate ↔ TemplateRef?

getter/setter pair

toolbarContainer ↔ DivElement?

getter/setter pair

toolbarVisible ↔ bool

getter/setter pair

totalPages → int

no setter

totalPagesMinWidth → String

no setter

trailingCustomToolbarActions ↔ List<LiPdfViewerToolbarAction>

getter/setter pair

url ← String?

no getter

useDesktopOverflowMenu → bool

no setter

viewer ↔ DivElement?

getter/setter pair

viewerContainer ↔ DivElement?

getter/setter pair

visibilityController → PdfViewerVisibilityController

final

workerSource ↔ String

getter/setter pair

zoomOptions ↔ List<LiDropdownMenuOption>

getter/setter pair

zoomPercentage → String

no setter

Methods

closeGoToPageModal() → void

closeSidePanel() → void

confirmGoToPage() → void

downloadDocument() → Future<void>

extractAllPagesText({bool includeMarkedContent = false, bool disableNormalization = false, bool trim = true}) → Future<List<LiPdfViewerPageText>>

extractDocumentText({String pageSeparator = '\n\n', bool includeMarkedContent = false, bool disableNormalization = false, bool trimPages = true}) → Future<String>

extractPageText(int pageNum, {bool includeMarkedContent = false, bool disableNormalization = false, bool trim = true}) → Future<LiPdfViewerPageText>

fitContent() → void

getAllPageInfo() → Future<List<LiPdfViewerPageInfo>>

getPageInfo(int pageNum) → Future<LiPdfViewerPageInfo>

isCustomToolbarActionActive(LiPdfViewerToolbarAction action) → bool

isCustomToolbarActionDisabled(LiPdfViewerToolbarAction action) → bool

nextPage() → void

ngAfterChanges() → void

ngAfterViewInit() → void

ngOnDestroy() → void

Executed before the directive is removed from the DOM and destroyed.

ngOnInit() → void

Executed after the first change detection run for a directive.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

onActionMenuSelect(String action) → void

onChangePageHandle(Event event) → void

onCustomToolbarActionClick(LiPdfViewerToolbarAction action) → void

onGoToPageModalClose() → void

onScaleDropdownChange(String value) → void

onSidePanelModalClose() → void

openGoToPageModal() → void

openSidePanel() → void

previousPage() → void

printDocument() → Future<void>

resolveCustomToolbarActionButtonClass(LiPdfViewerToolbarAction action) → String

resolveCustomToolbarActionIconClass(LiPdfViewerToolbarAction action) → String

resolveCustomToolbarActionLabel(LiPdfViewerToolbarAction action) → String

resolveCustomToolbarActionTitle(LiPdfViewerToolbarAction action) → String

rotate() → void

scrollToPage(int pageNum) → void

toggleFullscreen() → Future<void>

togglePanMode() → void

toggleSidePanel() → void

toString() → String

A string representation of this object.

inherited

zoomIn([MouseEvent? event]) → void

zoomInBtnClick() → void

zoomOut([MouseEvent? event]) → void

zoomOutBtnClick() → void

Operators

operator ==(Object other) → bool

The equality operator.

inherited