浏览代码

Plugins: rename vizPlugin to panelPlugin (#16802)

Ryan McKinley 6 年之前
父节点
当前提交
7dbe719fda

+ 1 - 1
packages/grafana-ui/src/types/panel.ts

@@ -10,7 +10,7 @@ export interface PanelPluginMeta extends PluginMeta {
   hideFromList?: boolean;
   sort: number;
   angularPlugin: AngularPanelPlugin | null;
-  vizPlugin: PanelPlugin | null;
+  panelPlugin: PanelPlugin | null;
   hasBeenImported?: boolean;
 
   // if length>0 the query tab will show up

+ 2 - 2
public/app/features/dashboard/dashgrid/DashboardPanel.tsx

@@ -101,7 +101,7 @@ export class DashboardPanel extends PureComponent<Props, State> {
       if (importedPlugin instanceof AngularPanelPlugin) {
         plugin.angularPlugin = importedPlugin as AngularPanelPlugin;
       } else if (importedPlugin instanceof PanelPlugin) {
-        plugin.vizPlugin = importedPlugin as PanelPlugin;
+        plugin.panelPlugin = importedPlugin as PanelPlugin;
       }
     } catch (e) {
       plugin = getPanelPluginNotFound(plugin.id);
@@ -209,7 +209,7 @@ export class DashboardPanel extends PureComponent<Props, State> {
               onMouseLeave={this.onMouseLeave}
               style={styles}
             >
-              {plugin.vizPlugin && this.renderReactPanel()}
+              {plugin.panelPlugin && this.renderReactPanel()}
               {plugin.angularPlugin && this.renderAngularPanel()}
             </div>
           )}

+ 2 - 2
public/app/features/dashboard/dashgrid/PanelChrome.tsx

@@ -215,7 +215,7 @@ export class PanelChrome extends PureComponent<Props, State> {
   renderPanel(width: number, height: number): JSX.Element {
     const { panel, plugin } = this.props;
     const { renderCounter, data, isFirstLoad } = this.state;
-    const PanelComponent = plugin.vizPlugin.panel;
+    const PanelComponent = plugin.panelPlugin.panel;
 
     // This is only done to increase a counter that is used by backend
     // image rendering (phantomjs/headless chrome) to know when to capture image
@@ -236,7 +236,7 @@ export class PanelChrome extends PureComponent<Props, State> {
           <PanelComponent
             data={data}
             timeRange={data.request ? data.request.range : this.timeSrv.timeRange()}
-            options={panel.getOptions(plugin.vizPlugin.defaults)}
+            options={panel.getOptions(plugin.panelPlugin.defaults)}
             width={width - 2 * config.theme.panelPadding.horizontal}
             height={height - PANEL_HEADER_HEIGHT - config.theme.panelPadding.vertical}
             renderCounter={renderCounter}

+ 1 - 1
public/app/features/dashboard/dashgrid/PanelPluginNotFound.tsx

@@ -63,7 +63,7 @@ export function getPanelPluginNotFound(id: string): PanelPluginMeta {
       updated: '',
       version: '',
     },
-    vizPlugin: new PanelPlugin(NotFound),
+    panelPlugin: new PanelPlugin(NotFound),
     angularPlugin: null,
   };
 }

+ 3 - 3
public/app/features/dashboard/panel_editor/VisualizationTab.tsx

@@ -54,7 +54,7 @@ export class VisualizationTab extends PureComponent<Props, State> {
 
   getReactPanelOptions = () => {
     const { panel, plugin } = this.props;
-    return panel.getOptions(plugin.vizPlugin.defaults);
+    return panel.getOptions(plugin.panelPlugin.defaults);
   };
 
   renderPanelOptions() {
@@ -64,8 +64,8 @@ export class VisualizationTab extends PureComponent<Props, State> {
       return <div ref={element => (this.element = element)} />;
     }
 
-    if (plugin.vizPlugin) {
-      const PanelEditor = plugin.vizPlugin.editor;
+    if (plugin.panelPlugin) {
+      const PanelEditor = plugin.panelPlugin.editor;
 
       if (PanelEditor) {
         return <PanelEditor options={this.getReactPanelOptions()} onOptionsChange={this.onPanelOptionsChanged} />;

+ 1 - 1
public/app/features/dashboard/state/PanelModel.test.ts

@@ -129,7 +129,7 @@ describe('PanelModel', () => {
         model.changePlugin(
           getPanelPlugin({
             id: 'react',
-            vizPlugin: reactPlugin,
+            panelPlugin: reactPlugin,
           })
         );
       });

+ 3 - 3
public/app/features/dashboard/state/PanelModel.ts

@@ -255,10 +255,10 @@ export class PanelModel {
   pluginLoaded(plugin: PanelPluginMeta) {
     this.plugin = plugin;
 
-    if (plugin.vizPlugin && plugin.vizPlugin.onPanelMigration) {
+    if (plugin.panelPlugin && plugin.panelPlugin.onPanelMigration) {
       const version = this.getPluginVersion(plugin);
       if (version !== this.pluginVersion) {
-        this.options = plugin.vizPlugin.onPanelMigration(this);
+        this.options = plugin.panelPlugin.onPanelMigration(this);
         this.pluginVersion = version;
       }
     }
@@ -291,7 +291,7 @@ export class PanelModel {
     this.plugin = newPlugin;
 
     // Let panel plugins inspect options from previous panel and keep any that it can use
-    const reactPanel = newPlugin.vizPlugin;
+    const reactPanel = newPlugin.panelPlugin;
 
     if (reactPanel) {
       if (reactPanel.onPanelTypeChanged) {

+ 1 - 1
public/app/features/plugins/__mocks__/pluginMocks.ts

@@ -57,7 +57,7 @@ export const getPanelPlugin = (options: Partial<PanelPluginMeta>): PanelPluginMe
     hideFromList: options.hideFromList === true,
     module: '',
     baseUrl: '',
-    vizPlugin: options.vizPlugin,
+    panelPlugin: options.panelPlugin,
     angularPlugin: options.angularPlugin,
   };
 };