Interface Plugin

The main interface for interacting with the plugin.

Hierarchy

Plugin

Index

Methods

getDefaultConfig getFullConfig getSelectedDesign selectDesign setDesignSelectionChanged updateConfig

Methods

getDefaultConfig

getDefaultConfig(): PluginConfig
Returns a config that is completely filled with defaults.

Returns PluginConfig
- Defined in plugin-interface.ts:65

getFullConfig

getFullConfig(): PluginConfig
Returns a copy of the current configuration, with all defaults filled in.

Returns PluginConfig
- Defined in plugin-interface.ts:60

getSelectedDesign

getSelectedDesign(): SelectedDesign
Returns the currently selected design, or null if the design view is currently not visible

Returns SelectedDesign
- Defined in plugin-interface.ts:77

selectDesign

selectDesign(targetDesign): void
Selects the specified design.
Parameters
- targetDesign: TargetDesign
Returns void
- Defined in plugin-interface.ts:89

setDesignSelectionChanged

setDesignSelectionChanged(callback): void
Get notified when the design selection changes (i.e. a design is selected, design selection is closed, or changed, the colors or the scale change) Use getSelectedDesign to retrieve the current state.
Parameters
- callback: (() => void)
  - - (): void
    - Returns void
Returns void
- Defined in plugin-interface.ts:84

updateConfig

updateConfig(config): void
Supplies a new config to the plugin. The new config will immediately be reflected by the UI
Parameters
- config: PluginConfig
Returns void
- Defined in plugin-interface.ts:71

Generated using TypeDoc