Class IconWidget`Abstract`

Base class for widgets of type IconWidget displayed in the viewport

Hierarchy (View Summary)

Widget
- IconWidget

Constructors

constructor

new IconWidget(viewer: Viewer, options: { x: number; y: number }): IconWidget
Parameters
- viewer: Viewer
- options: { x: number; y: number }
Returns IconWidget
Overrides Widget.constructor
- Defined in packages/viewport/src/widgets/base/IconWidget.tsx:25

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

`Readonly`isIconWidget

isIconWidget: true

`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
Inherited from Widget.fitContent
- Defined in packages/viewport/src/widgets/base/Widget.tsx:531

fitDirection

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

isDraggable

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

isLocked

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

isMaximizable

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

isMinimizable

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

isResizable

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

isScrollable

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

maxHeight

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

maxWidth

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

minHeight

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

minWidth

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

zIndex

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

Methods

AdditionalContent

AdditionalContent(): Element
Returns Element
- Defined in packages/viewport/src/widgets/base/IconWidget.tsx:43

close

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

dispose

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

`Protected` `Readonly`IconsItems

IconsItems(): IconWidgetItem[]
List of items to create the content of the widget

Returns IconWidgetItem[]
- Defined in packages/viewport/src/widgets/base/IconWidget.tsx:41

maximize

maximize(width: number, height: number): void
Parameters
- width: number
- height: number
Returns void
Inherited from Widget.maximize
- 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
Inherited from Widget.minimize
- Defined in packages/viewport/src/widgets/base/Widget.tsx:224

Render

Render(): Element
Returns Element
Overrides Widget.Render
- Defined in packages/viewport/src/widgets/base/IconWidget.tsx:47

setMaxSize

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

setMinSize

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

setPosition

setPosition(x: number, y: number): void
Parameters
- x: number
- y: number
Returns void
Inherited from Widget.setPosition
- 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
Inherited from Widget.setRect
- 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
Inherited from Widget.setSize
- Defined in packages/viewport/src/widgets/base/Widget.tsx:268

unmaximize

unmaximize(): void
Returns void
Inherited from Widget.unmaximize
- 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
Inherited from Widget.unminimize
- Defined in packages/viewport/src/widgets/base/Widget.tsx:237

updateRect

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

Class IconWidgetAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns IconWidget

Properties

ProtectedContextProvider

Param: props

Returns

ExtraContent

Readonlyid

ReadonlyignoreLastPosition

ReadonlyisIconWidget

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

AdditionalContent

Returns Element

close

Returns void

dispose

Returns void

Protected ReadonlyIconsItems

Returns IconWidgetItem[]

maximize

Parameters

Returns void

minimize

Parameters

Returns void

Render

Returns Element

setMaxSize

Class IconWidget`Abstract`

`Protected`ContextProvider

`Readonly`id

`Readonly`ignoreLastPosition

`Readonly`isIconWidget

`Readonly`signals

`Abstract` `Readonly`type

`Protected`viewer

`Static` `Readonly`DragHandleClassName

`Protected` `Readonly`IconsItems