Class Widget`Abstract`

Base class for all widgets displayed in the viewport

Hierarchy (View Summary)

Widget
- IconWidget
- StandardWidget

Constructors

constructor

new Widget(viewer: Viewer, options?: WidgetOptions): Widget
Parameters
- viewer: Viewer
- options: WidgetOptions = {}
Returns Widget
- Defined in packages/viewport/src/widgets/base/Widget.tsx:130

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

ExtraContent

ExtraContent: FunctionComponent = ...

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

`Readonly`id

id: string = ...

`Readonly`ignoreLastPosition

ignoreLastPosition: boolean = false

`Abstract`Render

Render: FunctionComponent<WidgetRenderProps>

Renders the widget with a react component

`Readonly`signals

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

`Abstract` `Readonly`type

type: keyof WidgetRegistry

`Protected`viewer

viewer: Viewer

`Static` `Readonly`DragHandleClassName

DragHandleClassName: string = ...

Accessors

fitContent

get fitContent(): boolean
Returns boolean
- Defined in packages/viewport/src/widgets/base/Widget.tsx:531

fitDirection

get fitDirection(): Direction
Returns Direction
- Defined in packages/viewport/src/widgets/base/Widget.tsx:535

isDraggable

get isDraggable(): boolean
Returns boolean
- Defined in packages/viewport/src/widgets/base/Widget.tsx:527
set isDraggable(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/viewport/src/widgets/base/Widget.tsx:522

isLocked

get isLocked(): boolean
Returns boolean
- Defined in packages/viewport/src/widgets/base/Widget.tsx:539
set isLocked(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/viewport/src/widgets/base/Widget.tsx:543

isMaximizable

get isMaximizable(): boolean
Returns boolean
- Defined in packages/viewport/src/widgets/base/Widget.tsx:518
set isMaximizable(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/viewport/src/widgets/base/Widget.tsx:513

isMinimizable

get isMinimizable(): boolean
Returns boolean
- Defined in packages/viewport/src/widgets/base/Widget.tsx:509
set isMinimizable(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/viewport/src/widgets/base/Widget.tsx:504

isResizable

get isResizable(): boolean
Returns boolean
- Defined in packages/viewport/src/widgets/base/Widget.tsx:500
set isResizable(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/viewport/src/widgets/base/Widget.tsx:495

isScrollable

get isScrollable(): boolean
Returns boolean
- Defined in packages/viewport/src/widgets/base/Widget.tsx:375

maxHeight

get maxHeight(): number
Returns number
- Defined in packages/viewport/src/widgets/base/Widget.tsx:491

maxWidth

get maxWidth(): number
Returns number
- Defined in packages/viewport/src/widgets/base/Widget.tsx:487

minHeight

get minHeight(): number
Returns number
- Defined in packages/viewport/src/widgets/base/Widget.tsx:479

minWidth

get minWidth(): number
Returns number
- Defined in packages/viewport/src/widgets/base/Widget.tsx:475

zIndex

get zIndex(): WidgetZIndex
Returns WidgetZIndex
- Defined in packages/viewport/src/widgets/base/Widget.tsx:402
set zIndex(value: WidgetZIndex): void
Parameters
- value: WidgetZIndex
Returns void
- Defined in packages/viewport/src/widgets/base/Widget.tsx:395

Methods

close

close(): void
Returns void
- Defined in packages/viewport/src/widgets/base/Widget.tsx:178

dispose

dispose(): void
Returns void
- Defined in packages/viewport/src/widgets/base/Widget.tsx:183

maximize

maximize(width: number, height: number): void
Parameters
- width: number
- height: number
Returns void
- Defined in packages/viewport/src/widgets/base/Widget.tsx:246

minimize

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

setMaxSize

setMaxSize(maxWidth: number, maxHeight: number): void
Parameters
- maxWidth: number
- maxHeight: number
Returns void
- Defined in packages/viewport/src/widgets/base/Widget.tsx:335

setMinSize

setMinSize(minWidth: number, minHeight: number): void
Parameters
- minWidth: number
- minHeight: number
Returns void
- Defined in packages/viewport/src/widgets/base/Widget.tsx:319

setPosition

setPosition(x: number, y: number): void
Parameters
- x: number
- y: number
Returns void
- Defined in packages/viewport/src/widgets/base/Widget.tsx:213

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
- Defined in packages/viewport/src/widgets/base/Widget.tsx:278

setSize

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

unmaximize

unmaximize(): void
Returns void
- Defined in packages/viewport/src/widgets/base/Widget.tsx:254

unminimize

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

Returns void
- Defined in packages/viewport/src/widgets/base/Widget.tsx:237

updateRect

updateRect(saveConfig?: boolean): void
Parameters
- saveConfig: boolean = true
Returns void
- Defined in packages/viewport/src/widgets/base/Widget.tsx:311

Class WidgetAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Widget

Properties

ProtectedContextProvider

Param: props

Returns

ExtraContent

Readonlyid

ReadonlyignoreLastPosition

AbstractRender

Readonlysignals

Abstract Readonlytype

Protectedviewer

Static ReadonlyDragHandleClassName

Accessors

fitContent

Returns boolean

fitDirection

Returns Direction

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

dispose

Returns void

maximize

Parameters

Returns void

minimize

Parameters

Returns void

setMaxSize

Parameters

Returns void

setMinSize

Parameters

Returns void

setPosition

Class Widget`Abstract`

`Protected`ContextProvider

`Readonly`id

`Readonly`ignoreLastPosition

`Abstract`Render

`Readonly`signals

`Abstract` `Readonly`type

`Protected`viewer

`Static` `Readonly`DragHandleClassName