Interface WidgetConfig

Widget configuration

interface WidgetConfig {
    name: string;
    reduceViewportChange?: Debounce;
    destroy?(this): void;
    externalize?(this): Record<string, any>;
    externalizeAsProvider?(this): Record<string, any>;
    initialize(this): void;
}

Index

Properties

name reduceViewportChange?

Methods

destroy? externalize? externalizeAsProvider? initialize

Properties

name

name: string

Unique widget name

`Optional` reduceViewportChange

reduceViewportChange?: Debounce

Function to slow down the processing of Viewport changes, if it is absent, the standard debounce is used

Methods

`Optional` destroy

destroy(this): void
Widget deletion function, this function should be called by the user when deleting the widget
Parameters
- this: Widget
Returns void
- Defined in src/widget.ts:43

`Optional` externalize

externalize(this): Record<string, any>
A factory that exports the facade available to the user. By default, exports properties passed to the widget and properties that the iframe exports
Parameters
- this: Widget
Returns Record<string, any>
- Defined in src/widget.ts:48

`Optional` externalizeAsProvider

externalizeAsProvider(this): Record<string, any>
A factory that exports the facade available in the iframe
Parameters
- this: Widget
Returns Record<string, any>
- Defined in src/widget.ts:50

initialize

initialize(this): void
Widget initialization function, should render the widget
Parameters
- this: Widget
Returns void
- Defined in src/widget.ts:41

Generated using TypeDoc