Class InfoBoxWidget

Hierarchy (View Summary)

StandardWidget
- InfoBoxWidget
  - TeiaInfoBoxWidget

Constructors

constructor

new InfoBoxWidget(viewer: Viewer, options?: InfoBoxWidgetOptions): InfoBoxWidget
Parameters
- viewer: Viewer
- options: InfoBoxWidgetOptions = {}
Returns InfoBoxWidget
Overrides StandardWidget.constructor
- Defined in src/viewer/widgets/infobox/InfoBoxWidget.tsx:69

Properties

Content

Content: () => Element = InfoBoxWidgetContent

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

drawArrow

drawArrow: boolean = false

Footer: () => Element = InfoBoxWidgetFooter

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

`Readonly`icon

icon: {
    heroIcon: ForwardRefExoticComponent<
        Omit<SVGProps<SVGSVGElement>, "ref"> & {} & RefAttributes<
            SVGSVGElement,
        >,
    >;
} = ...

`Readonly`id

id: string = ...

`Readonly`ignoreLastPosition

ignoreLastPosition: boolean = false

`Readonly`isStandardWidget

isStandardWidget: true

`Readonly`signals

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

`Readonly`type

type: keyof ViewerWidgetRegistry = 'Infobox'

uuids

uuids: string[]

`Static` `Readonly`DragHandleClassName

DragHandleClassName: string = ...

Accessors

fitContent

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

fitDirection

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

isDraggable

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

isLocked

get isLocked(): boolean
Returns boolean
Overrides StandardWidget.isLocked
- Defined in src/viewer/widgets/infobox/InfoBoxWidget.tsx:138
set isLocked(value: boolean): void
Parameters
- value: boolean
Returns void
Overrides StandardWidget.isLocked
- Defined in src/viewer/widgets/infobox/InfoBoxWidget.tsx:142

isMinimizable

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

isResizable

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

maxHeight

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

maxWidth

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

minHeight

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

minWidth

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

zIndex

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

Methods

close

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

ContextProvider

ContextProvider(props: StandardWidgetContextProviderProps): Element
Parameters
- props: StandardWidgetContextProviderProps
Returns Element
Overrides StandardWidget.ContextProvider
- Defined in src/viewer/widgets/infobox/InfoBoxWidget.tsx:96

dispose

dispose(): void
Returns void
Overrides StandardWidget.dispose
- Defined in src/viewer/widgets/infobox/InfoBoxWidget.tsx:158

ExtraContent

ExtraContent(): Element
Returns Element
Overrides StandardWidget.ExtraContent
- Defined in src/viewer/widgets/infobox/InfoBoxWidget.tsx:131

Header(): Element
Returns Element
Overrides StandardWidget.Header
- Defined in src/viewer/widgets/infobox/InfoBoxWidget.tsx:115

maximize

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

Returns void
Inherited from StandardWidget.maximize
- Defined in src/viewer/widgets/base/Widget.tsx:207

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 src/viewer/widgets/base/Widget.tsx:195

Render

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

setMaxSize

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

setMinSize

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

setPosition

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

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 src/viewer/widgets/base/Widget.tsx:231

setSize

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

setUuids

setUuids(uuids: Iterable<string>): void
Parameters
- uuids: Iterable<string>
Returns void
- Defined in src/viewer/widgets/infobox/InfoBoxWidget.tsx:153

updateRect

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

Class InfoBoxWidget

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns InfoBoxWidget

Properties

Content

drawArrow

Footer

Readonlyicon

Readonlyid

ReadonlyignoreLastPosition

ReadonlyisStandardWidget

Readonlysignals

Readonlytype

uuids

Static ReadonlyDragHandleClassName

Accessors

fitContent

Returns boolean

fitDirection

Returns Direction

isDraggable

Returns boolean

Parameters

Returns void

isLocked

Returns boolean

Parameters

Returns void

isMinimizable

Returns boolean

Parameters

Returns void

isResizable

Returns boolean

Parameters

Returns void

maxHeight

Returns number

maxWidth

Returns number

minHeight

Returns number

minWidth

Returns number

zIndex

Returns WidgetZIndex

Parameters

Returns void

Methods

close

Returns void

ContextProvider

Parameters

Returns Element

dispose

Returns void

ExtraContent

Returns Element

Header

Returns Element

maximize

Returns void

minimize

Parameters

Returns void

Render

Parameters

Returns Element

setMaxSize

Parameters

Returns void

setMinSize

`Readonly`icon

`Readonly`id

`Readonly`ignoreLastPosition

`Readonly`isStandardWidget

`Readonly`signals

`Readonly`type

`Static` `Readonly`DragHandleClassName