Class DocumentViewerWidget

Widget displaying a document (pdf, image, video, audio) with the design system DocumentViewer.

Hierarchy (View Summary)

StandardWidget
- DocumentViewerWidget

Constructors

constructor

new DocumentViewerWidget(
viewer: Viewer,
options: DocumentViewerWidgetOptions,
): DocumentViewerWidget
Parameters
- viewer: Viewer
  The viewer the widget belongs to
- options: DocumentViewerWidgetOptions
  The document to display and the standard widget options
Returns DocumentViewerWidget
Overrides StandardWidget.constructor
- Defined in legacy-plugins/src/DocumentViewerPlugin/widgets/DocumentViewerWidget.tsx:57

Properties

`Protected`ContextProvider

ContextProvider: FunctionComponent<WidgetContextProviderProps> = ...

React context provider around content Called internally by the widget renderer method.

Param: props

The children to render inside the provider.

Returns

`Readonly`documentViewerProps

documentViewerProps: DocumentViewerProps

Props forwarded to the design system DocumentViewer

ExtraContent

ExtraContent: FunctionComponent = ...

React Component displaying the extra content of the widget. Called internally by the widget container method.

`Protected`Footer

Footer: FunctionComponent = ...

React Component displayed in the widget footer. Called internally by the widget renderer method.

Param: props

`Readonly`id

id: string = ...

`Readonly`ignoreLastPosition

ignoreLastPosition: boolean = false

`Readonly`isStandardWidget

isStandardWidget: true

`Readonly`signals

signals: {
onUpdateRect: ViewerSignal<(...args: any[]) => any>;
onUpdateRectContent: ViewerSignal<(...args: any[]) => any>;
} = ...

`Readonly`title

title: string

Title displayed in the widget header

`Readonly`type

type: "DocumentViewer" = 'DocumentViewer'

`Protected`viewer

viewer: Viewer

`Static` `Readonly`DragHandleClassName

DragHandleClassName: string = ...

Accessors

fitContent

get fitContent(): boolean
Returns boolean
Inherited from StandardWidget.fitContent
- Defined in viewport/src/widgets/base/Widget.tsx:560

fitDirection

get fitDirection(): Direction
Returns Direction
Inherited from StandardWidget.fitDirection
- Defined in viewport/src/widgets/base/Widget.tsx:564

isClosable

get isClosable(): boolean
Returns boolean
Inherited from StandardWidget.isClosable
- Defined in viewport/src/widgets/base/Widget.tsx:579
set isClosable(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from StandardWidget.isClosable
- Defined in viewport/src/widgets/base/Widget.tsx:583

isDraggable

get isDraggable(): boolean
Returns boolean
Inherited from StandardWidget.isDraggable
- Defined in viewport/src/widgets/base/Widget.tsx:556
set isDraggable(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from StandardWidget.isDraggable
- Defined in viewport/src/widgets/base/Widget.tsx:551

isLocked

get isLocked(): boolean
Returns boolean
Inherited from StandardWidget.isLocked
- Defined in viewport/src/widgets/base/Widget.tsx:568
set isLocked(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from StandardWidget.isLocked
- Defined in viewport/src/widgets/base/Widget.tsx:572

isMaximizable

get isMaximizable(): boolean
Returns boolean
Inherited from StandardWidget.isMaximizable
- Defined in viewport/src/widgets/base/Widget.tsx:547
set isMaximizable(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from StandardWidget.isMaximizable
- Defined in viewport/src/widgets/base/Widget.tsx:542

isMinimizable

get isMinimizable(): boolean
Returns boolean
Inherited from StandardWidget.isMinimizable
- Defined in viewport/src/widgets/base/Widget.tsx:538
set isMinimizable(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from StandardWidget.isMinimizable
- Defined in viewport/src/widgets/base/Widget.tsx:533

isResizable

get isResizable(): boolean
Returns boolean
Inherited from StandardWidget.isResizable
- Defined in viewport/src/widgets/base/Widget.tsx:529
set isResizable(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from StandardWidget.isResizable
- Defined in viewport/src/widgets/base/Widget.tsx:524

isScrollable

get isScrollable(): boolean
Returns boolean
Inherited from StandardWidget.isScrollable
- Defined in viewport/src/widgets/base/Widget.tsx:404

maxHeight

get maxHeight(): number
Returns number
Inherited from StandardWidget.maxHeight
- Defined in viewport/src/widgets/base/Widget.tsx:520

maxWidth

get maxWidth(): number
Returns number
Inherited from StandardWidget.maxWidth
- Defined in viewport/src/widgets/base/Widget.tsx:516

minHeight

get minHeight(): number
Returns number
Inherited from StandardWidget.minHeight
- Defined in viewport/src/widgets/base/Widget.tsx:508

minWidth

get minWidth(): number
Returns number
Inherited from StandardWidget.minWidth
- Defined in viewport/src/widgets/base/Widget.tsx:504

zIndex

get zIndex(): WidgetZIndex
Returns WidgetZIndex
Inherited from StandardWidget.zIndex
- Defined in viewport/src/widgets/base/Widget.tsx:431
set zIndex(value: WidgetZIndex): void
Parameters
- value: WidgetZIndex
Returns void
Inherited from StandardWidget.zIndex
- Defined in viewport/src/widgets/base/Widget.tsx:424

Methods

close

close(): void
Returns void
Inherited from StandardWidget.close
- Defined in viewport/src/widgets/base/Widget.tsx:207

Content

Content(): Element
Returns Element
Overrides StandardWidget.Content
- Defined in legacy-plugins/src/DocumentViewerPlugin/widgets/DocumentViewerWidget.tsx:78

dispose

dispose(): void
Returns void
Inherited from StandardWidget.dispose
- Defined in viewport/src/widgets/base/Widget.tsx:212

Header(): Element
Returns Element
Overrides StandardWidget.Header
- Defined in legacy-plugins/src/DocumentViewerPlugin/widgets/DocumentViewerWidget.tsx:72

maximize

maximize(width: number, height: number): void
Parameters
- width: number
- height: number
Returns void
Inherited from StandardWidget.maximize
- Defined in viewport/src/widgets/base/Widget.tsx:275

minimize

minimize(height?: number): void
Minimizes the widget with to the given height
Parameters
- height: number = 0
  The minimized height
Returns void
Inherited from StandardWidget.minimize
- Defined in viewport/src/widgets/base/Widget.tsx:253

Render

Render(props: WidgetRenderProps): Element
Parameters
- props: WidgetRenderProps
Returns Element
Inherited from StandardWidget.Render
- Defined in viewport/src/widgets/base/StandardWidget.tsx:66

setMaxSize

setMaxSize(maxWidth: number, maxHeight: number): void
Parameters
- maxWidth: number
- maxHeight: number
Returns void
Inherited from StandardWidget.setMaxSize
- Defined in viewport/src/widgets/base/Widget.tsx:364

setMinSize

setMinSize(minWidth: number, minHeight: number): void
Parameters
- minWidth: number
- minHeight: number
Returns void
Inherited from StandardWidget.setMinSize
- Defined in viewport/src/widgets/base/Widget.tsx:348

setPosition

setPosition(x: number, y: number): void
Parameters
- x: number
- y: number
Returns void
Inherited from StandardWidget.setPosition
- Defined in viewport/src/widgets/base/Widget.tsx:242

setRect

setRect(
    x: number,
    y: number,
    width: number,
    height: number,
    saveConfig?: boolean,
): void
Parameters
- x: number
- y: number
- width: number
- height: number
- saveConfig: boolean = true
Returns void
Inherited from StandardWidget.setRect
- Defined in viewport/src/widgets/base/Widget.tsx:307

setSize

setSize(width: number, height: number): void
Sets the widget size
Parameters
- width: number
- height: number
Returns void
Inherited from StandardWidget.setSize
- Defined in viewport/src/widgets/base/Widget.tsx:297

unmaximize

unmaximize(): void
Returns void
Inherited from StandardWidget.unmaximize
- Defined in viewport/src/widgets/base/Widget.tsx:283

unminimize

unminimize(): void
Put back the widget to its original height before minimization

Returns void
Inherited from StandardWidget.unminimize
- Defined in viewport/src/widgets/base/Widget.tsx:266

updateRect

updateRect(saveConfig?: boolean): void
Parameters
- saveConfig: boolean = true
Returns void
Inherited from StandardWidget.updateRect
- Defined in viewport/src/widgets/base/Widget.tsx:340

Class DocumentViewerWidget

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns DocumentViewerWidget

Properties

ProtectedContextProvider

Param: props

Returns

ReadonlydocumentViewerProps

ExtraContent

ProtectedFooter

Param: props

Readonlyid

ReadonlyignoreLastPosition

ReadonlyisStandardWidget

Readonlysignals

Readonlytitle

Readonlytype

Protectedviewer

Static ReadonlyDragHandleClassName

Accessors

fitContent

Returns boolean

fitDirection

Returns Direction

isClosable

Returns boolean

Parameters

Returns void

isDraggable

Returns boolean

Parameters

Returns void

isLocked

Returns boolean

Parameters

Returns void

isMaximizable

Returns boolean

Parameters

Returns void

isMinimizable

Returns boolean

Parameters

Returns void

isResizable

Returns boolean

Parameters

Returns void

isScrollable

Returns boolean

maxHeight

Returns number

maxWidth

Returns number

minHeight

Returns number

minWidth

Returns number

zIndex

Returns WidgetZIndex

Parameters

Returns void

Methods

close

Returns void

Content

Returns Element

dispose

Returns void

Header

Returns Element

maximize

`Protected`ContextProvider

`Readonly`documentViewerProps

`Protected`Footer

`Readonly`id

`Readonly`ignoreLastPosition

`Readonly`isStandardWidget

`Readonly`signals

`Readonly`title

`Readonly`type

`Protected`viewer

`Static` `Readonly`DragHandleClassName