Class TeiaQuantityTakeoffWidget

Widget displaying the quantity take-off of Twin objects: a table of their property values, which can be grouped by a property to aggregate the others (count, sum, min, max, average) and exported as an xlsx file.

Hierarchy (View Summary)

StandardWidget
- TeiaQuantityTakeoffWidget

Constructors

constructor

new TeiaQuantityTakeoffWidget(
viewer: Viewer,
options?: TeiaQuantityTakeoffWidgetOptions,
): TeiaQuantityTakeoffWidget
Parameters
- viewer: Viewer
  The viewer the widget belongs to
- options: TeiaQuantityTakeoffWidgetOptions = {}
  The widget options
Returns TeiaQuantityTakeoffWidget
Overrides StandardWidget.constructor
- Defined in legacy-plugins/src/QuantityTakeoffPlugin/widgets/TeiaQuantityTakeoffWidget.tsx:85

Properties

Content

Content: () => Element | null = TeiaQuantityTakeoffWidgetBody

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

ExtraContent

ExtraContent: FunctionComponent = ...

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

Footer: () => Element = TeiaQuantityTakeoffWidgetFooter

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

Header: () => Element = TeiaQuantityTakeoffWidgetHeader

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

`Readonly`id

id: string = ...

`Readonly`ignoreLastPosition

ignoreLastPosition: boolean = false

`Readonly`isStandardWidget

isStandardWidget: true

`Readonly`searchRules

searchRules: TeiaSearchFilter

Filter of the objects the widget was opened with

`Readonly`signals

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

`Readonly`type

type: "TeiaQuantityTakeoff" = 'TeiaQuantityTakeoff'

`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

ContextProvider

ContextProvider(props: WidgetContextProviderProps): Element
Parameters
- props: WidgetContextProviderProps
Returns Element
Overrides StandardWidget.ContextProvider
- Defined in legacy-plugins/src/QuantityTakeoffPlugin/widgets/TeiaQuantityTakeoffWidget.tsx:104

dispose

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

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 TeiaQuantityTakeoffWidget

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns TeiaQuantityTakeoffWidget

Properties

Content

ExtraContent

Footer

Header

Readonlyid

ReadonlyignoreLastPosition

ReadonlyisStandardWidget

ReadonlysearchRules

Readonlysignals

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

ContextProvider

Parameters

Returns Element

dispose

Returns void

maximize

Parameters

Returns void

minimize

Parameters

`Readonly`id

`Readonly`ignoreLastPosition

`Readonly`isStandardWidget

`Readonly`searchRules

`Readonly`signals

`Readonly`type

`Protected`viewer

`Static` `Readonly`DragHandleClassName