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:70

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: {
onUpdateRect: ViewerSignal<(...args: any[]) => any>;
onUpdateRectContent: 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:531

fitDirection

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

isDraggable

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

isLocked

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

isMaximizable

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

isMinimizable

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

isResizable

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

isScrollable

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

maxHeight

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

maxWidth

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

minHeight

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

minWidth

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

zIndex

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

Methods

close

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

ContextProvider

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

dispose

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

ExtraContent

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

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

maximize

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

Render

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

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:335

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:319

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: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 StandardWidget.setRect
- Defined in src/viewer/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 StandardWidget.setSize
- Defined in src/viewer/widgets/base/Widget.tsx:268

setUuids

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

unmaximize

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

unminimize

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

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

updateRect

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

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

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

ContextProvider

Parameters

Returns Element

dispose

Returns void

ExtraContent

Returns Element

Header

Returns Element

maximize

Parameters

Returns void

minimize

Parameters

Returns void

`Readonly`icon

`Readonly`id

`Readonly`ignoreLastPosition

`Readonly`isStandardWidget

`Readonly`signals

`Readonly`type

`Static` `Readonly`DragHandleClassName