Class BaseWidget`Abstract`

Implements

IWidgetPlugin

Index

Constructors

Properties

_root displayedWidget help id renderOn

Methods

addContainer addToToolbar calculateHeight defaultParameters getBoxConfigurator hide mergeOptions pluginName render showWidgetSettingEditor unhide updateHideUnHideButton updatePosition

Constructors

constructor

new BaseWidget(): BaseWidget
Returns BaseWidget

Properties

`Abstract` _root

_root: JQuery

`Abstract` displayedWidget

displayedWidget: IDisplayedWidget

`Abstract` help

help: string

`Abstract` id

id: string

`Abstract` renderOn

renderOn: widgetRenderEvent

Methods

addContainer

addContainer(root, displayedWidget): JQuery
Parameters
- root: JQuery
- displayedWidget: IDisplayedWidget
Returns JQuery
- Defined in ts/sdk/common/BaseWidget.ts:62

`Protected` addToToolbar

addToToolbar(iconName, onClick, tooltip?): void
Parameters
- iconName: string
- onClick: (() => void)
  - - (): void
    - Returns void
- tooltip: string = ""
Returns void
- Defined in ts/sdk/common/BaseWidget.ts:151

calculateHeight

calculateHeight(configurator): number
Parameters
- configurator: ILineEditorLine[]
Returns number
- Defined in ts/sdk/common/BaseWidget.ts:230

`Abstract` defaultParameters

defaultParameters(): IWidgetParameters
Returns IWidgetParameters
Implementation of IWidgetPlugin.defaultParameters
- Defined in ts/sdk/common/BaseWidget.ts:21

`Abstract` getBoxConfigurator

getBoxConfigurator(): ILineEditorLine[]
Returns ILineEditorLine[]
- Defined in ts/sdk/common/BaseWidget.ts:23

hide

hide(showConfirm?): void
Parameters
- showConfirm: boolean = false
Returns void
Implementation of IWidgetPlugin.hide
- Defined in ts/sdk/common/BaseWidget.ts:265

mergeOptions

mergeOptions(parameters): IWidgetParameters
Parameters
- parameters: IWidgetParameters
Returns IWidgetParameters
Implementation of IWidgetPlugin.mergeOptions
- Defined in ts/sdk/common/BaseWidget.ts:32

pluginName

pluginName(): string
Returns string
Implementation of IWidgetPlugin.pluginName
- Defined in ts/sdk/common/BaseWidget.ts:28

`Abstract` render

render(root, arg0): void
Parameters
- root: JQuery
- arg0: IDisplayedWidget
Returns void
Implementation of IWidgetPlugin.render
- Defined in ts/sdk/common/BaseWidget.ts:25

showWidgetSettingEditor

showWidgetSettingEditor(displayedWidget): Promise<void>
Parameters
- displayedWidget: IDisplayedWidget
Returns Promise<void>
- Defined in ts/sdk/common/BaseWidget.ts:158

unhide

unhide(showConfirm): void
Parameters
- showConfirm: boolean
Returns void
- Defined in ts/sdk/common/BaseWidget.ts:275

updateHideUnHideButton

updateHideUnHideButton(): void
Returns void
- Defined in ts/sdk/common/BaseWidget.ts:126

updatePosition

updatePosition(w, h, x, y): void
Parameters
- w: number
- h: number
- x: number
- y: number
Returns void
Implementation of IWidgetPlugin.updatePosition
- Defined in ts/sdk/common/BaseWidget.ts:253

Generated using TypeDoc