Interface
The extension interface for AppConfigOperations extension point. The methods in this class must return the new appConfig
Properties
| Property | Type | Notes |
|---|---|---|
afterWidgetCopied | (sourceWidgetId: string, sourceAppConfig: IMAppConfig, destWidgetId: string, destAppConfig: IMAppConfig, contentMap?: DuplicateContext) => IMAppConfig | Process the widget's internal config after it is copied if necessary. Only the original widget's extension should get invoked with the new copiedWidgetId. |
anyWidgetWillRemove | (appConfig: IMAppConfig, widgetId: string) => IMAppConfig | This method is invoked when a widget is going to be removed from the app config. This method is invoked before the widget has been removed from the layout. |
appConfigWillChange | (appConfig: IMAppConfig) => IMAppConfig | This method is invoked before the app config is changed. |
dataSourceWillRemove | (appConfig: IMAppConfig, dataSourceId: string) => IMAppConfig | If a widget saves the data source id in its internal config, it should override this method to do the clean ups. Only the widgets that save the data source id in it's useDataSources will get invoked. |
idinherited | string | The unique ID. For widget's provided extension, the id pattern is: widgetId + extensionName |
indexinherited | number | If an extension point supports multiple extensions, the index is used to determine the extension order. |
labelinherited | string | The extension label. |
mapWidgetWillRemove | (appConfig: IMAppConfig, mapWidgetId: string) => IMAppConfig | If a widget saves some map related data its internal config, it should override this method to do the clean ups. Only the widgets that save the map widget id in it's useMapWidgets will get invoked. |
nameinherited | string | The extension name. |
useDataSourceWillChange | (appConfig: IMAppConfig, oldDataSourceId: string, newDataSourceId: string) => IMAppConfig | If a widget saves some config that is related to the data source in its internal config, it should override this method to do the clean ups. In most cases, a widget can just do the clean ups in its setting panel. However, when we remove a used data source from the list, the list internal widgets don't have the chance to do the clean ups. These widgets (Text/Image/Button) should override this method to do the clean ups. Another case is in Express mode, when the map widget de-selects a data source, all related widgets "useDataSources" are cleared. |
utilityWillRemove | (appConfig: IMAppConfig, utilityId: string) => IMAppConfig | If a widget saves the utility id in its internal config, it should override this method to do the clean ups. Only the widgets that save the utility id in it's useUtilities will get invoked. |
widgetIdinherited | string | The widget ID that provides the extension. No widget id means the extension is provided by Jimu. |
widgetWillRemove | (appConfig: IMAppConfig) => IMAppConfig | Do some cleanup operations before current widget is removed. This method is invoked after the widget has been removed from the layout. |