Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Plugins: rename vizPlugin to panelPlugin #16802

Merged
merged 3 commits into from
Apr 29, 2019
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/grafana-ui/src/types/panel.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions public/app/features/dashboard/dashgrid/DashboardPanel.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down Expand Up @@ -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>
)}
Expand Down
4 changes: 2 additions & 2 deletions public/app/features/dashboard/dashgrid/PanelChrome.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ export function getPanelPluginNotFound(id: string): PanelPluginMeta {
updated: '',
version: '',
},
vizPlugin: new PanelPlugin(NotFound),
panelPlugin: new PanelPlugin(NotFound),
angularPlugin: null,
};
}
Original file line number Diff line number Diff line change
Expand Up @@ -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() {
Expand All @@ -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} />;
Expand Down
2 changes: 1 addition & 1 deletion public/app/features/dashboard/state/PanelModel.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ describe('PanelModel', () => {
model.changePlugin(
getPanelPlugin({
id: 'react',
vizPlugin: reactPlugin,
panelPlugin: reactPlugin,
})
);
});
Expand Down
6 changes: 3 additions & 3 deletions public/app/features/dashboard/state/PanelModel.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
}
Expand Down Expand Up @@ -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) {
Expand Down
2 changes: 1 addition & 1 deletion public/app/features/plugins/__mocks__/pluginMocks.ts
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ export const getPanelPlugin = (options: Partial<PanelPluginMeta>): PanelPluginMe
hideFromList: options.hideFromList === true,
module: '',
baseUrl: '',
vizPlugin: options.vizPlugin,
panelPlugin: options.panelPlugin,
angularPlugin: options.angularPlugin,
};
};
Expand Down