IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

API to fix/update properties before load

Browse Source
This commit is contained in:
ryan
2019-03-12 16:10:14 -07:00
parent 54f92514d5
commit 7311b14da1
3 changed files with 41 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
packages/grafana-ui/src/types/panel.ts
View File

@@ -26,9 +26,18 @@ export interface PanelEditorProps<T = any> {
onOptionsChange: (options: T) => void;
}
/**
* Checks the existing model before the component is loaded
* This is useful for fixing options as configuration changes
* The object passed in is the panel model.... but not typed
* since that is not in grafana ui
*/
export type PanelOptionsValidator<T = any> = (panelModel: any) => T;
export class ReactPanelPlugin<TOptions = any> {
panel: ComponentClass<PanelProps<TOptions>>;
editor?: ComponentClass<PanelEditorProps<TOptions>>;
optionsValidator?: PanelOptionsValidator<TOptions>;
defaults?: TOptions;
constructor(panel: ComponentClass<PanelProps<TOptions>>) {
@@ -39,6 +48,10 @@ export class ReactPanelPlugin<TOptions = any> {
this.editor = editor;
}
setOptionsValidator(validator: PanelOptionsValidator<TOptions>) {
this.optionsValidator = validator;
}
setDefaults(defaults: TOptions) {
this.defaults = defaults;
}