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

[Vis Builder] Rename wizard on save modal and visualization table #2645

Merged
merged 3 commits into from
Oct 27, 2022
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
- [Multi DataSource] Address UX comments on Data source list and create page ([#2625](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2625))
- [Vis Builder] Rename wizard to visBuilder in i18n id and formatted message id ([#2635](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2635))
- [Vis Builder] Rename wizard to visBuilder in class name, type name and function name ([#2639](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2639))
- [Vis Builder] Rename wizard on save modal and visualization table ([#2645](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2645))

### 🐛 Bug Fixes

Expand Down
2 changes: 2 additions & 0 deletions src/plugins/vis_builder/common/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ export const PLUGIN_ID = 'wizard';
export const PLUGIN_NAME = 'Wizard';
export const VISUALIZE_ID = 'visualize';
export const EDIT_PATH = '/edit';
export const VIS_BUILDER_STATE = 'experimental';
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we need this?

export const VIS_BUILDER_CHART_TYPE = 'VisBuilder';

export {
VisBuilderSavedObjectAttributes,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ export const getTopNavConfig = (
dispatch,
services
)}
objectType={'wizard'}
objectType={'visualization'}
onClose={() => {}}
originatingApp={originatingApp}
getAppNameFromId={stateTransfer.getAppNameFromId}
Expand Down
10 changes: 8 additions & 2 deletions src/plugins/vis_builder/public/plugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,13 @@ import {
import { VisBuilderEmbeddableFactoryDefinition, VISBUILDER_EMBEDDABLE } from './embeddable';
import visBuilderIconSecondaryFill from './assets/wizard_icon_secondary_fill.svg';
import visBuilderIcon from './assets/wizard_icon.svg';
import { EDIT_PATH, PLUGIN_ID, PLUGIN_NAME, VISBUILDER_SAVED_OBJECT } from '../common';
import {
EDIT_PATH,
PLUGIN_ID,
PLUGIN_NAME,
VISBUILDER_SAVED_OBJECT,
VIS_BUILDER_CHART_TYPE,
} from '../common';
import { TypeService } from './services/type_service';
import { getPreloadedStore } from './application/utils/state_management';
import {
Expand Down Expand Up @@ -134,7 +140,7 @@ export class VisBuilderPlugin
savedObjectType: VISBUILDER_SAVED_OBJECT,
stage: 'experimental',
title: attributes?.title,
typeTitle: PLUGIN_NAME,
typeTitle: VIS_BUILDER_CHART_TYPE,
updated_at: updatedAt,
}),
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import { ColorModes, ColorSchemas } from '../../../../charts/public';
import { MetricVizOptions } from './components/metric_viz_options';
import { VisualizationTypeOptions } from '../../services/type_service';
import { toExpression } from './to_expression';
import { VIS_BUILDER_STATE } from '../../../common';

export interface MetricOptionsDefaults {
addTooltip: boolean;
Expand Down Expand Up @@ -40,6 +41,7 @@ export const createMetricConfig = (): VisualizationTypeOptions<MetricOptionsDefa
title: 'Metric',
icon: 'visMetric',
description: 'Display metric visualizations',
stage: VIS_BUILDER_STATE,
toExpression,
ui: {
containerConfig: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import { AreaVisOptions } from './components/area_vis_options';
import { VisualizationTypeOptions } from '../../../services/type_service';
import { toExpression } from './to_expression';
import { BasicOptionsDefaults } from '../common/types';
import { VIS_BUILDER_STATE } from '../../../../common';

export interface AreaOptionsDefaults extends BasicOptionsDefaults {
type: 'area';
Expand All @@ -21,6 +22,7 @@ export const createAreaConfig = (): VisualizationTypeOptions<AreaOptionsDefaults
title: 'Area',
icon: 'visArea',
description: 'Display area chart',
stage: VIS_BUILDER_STATE,
Copy link
Member Author

@abbyhu2000 abbyhu2000 Oct 26, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was from a previous discussion with the experimental flag, do we want to set the stage as 'experimental' for each viz type? Since I see there is a stage field in the VisualizationTypeOptions<T = any> interface, so i set the stage to experimental for all four viz type in vis builder. If not, i think we can get rid of the VIS_BUILDER_STATE = 'experimental' @ashwin-pc However, i do not think we are using or referencing this stage field anywhere in vis builder app

 export interface VisualizationTypeOptions<T = any> {
  readonly name: string;
  readonly title: string;
  readonly description?: string;
  readonly icon: IconType;
  readonly stage?: 'experimental' | 'production';

toExpression,
ui: {
containerConfig: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import { BasicOptionsDefaults } from '../common/types';
import { HistogramVisOptions } from './components/histogram_vis_options';
import { VisualizationTypeOptions } from '../../../services/type_service';
import { toExpression } from './to_expression';
import { VIS_BUILDER_STATE } from '../../../../common';

export interface HistogramOptionsDefaults extends BasicOptionsDefaults {
type: 'histogram';
Expand All @@ -21,6 +22,7 @@ export const createHistogramConfig = (): VisualizationTypeOptions<HistogramOptio
title: 'Bar',
icon: 'visBarVertical',
description: 'Display histogram visualizations',
stage: VIS_BUILDER_STATE,
toExpression,
ui: {
containerConfig: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import { LineVisOptions } from './components/line_vis_options';
import { VisualizationTypeOptions } from '../../../services/type_service';
import { toExpression } from './to_expression';
import { BasicOptionsDefaults } from '../common/types';
import { VIS_BUILDER_STATE } from '../../../../common';

export interface LineOptionsDefaults extends BasicOptionsDefaults {
type: 'line';
Expand All @@ -21,6 +22,7 @@ export const createLineConfig = (): VisualizationTypeOptions<LineOptionsDefaults
title: 'Line',
icon: 'visLine',
description: 'Display line chart',
stage: VIS_BUILDER_STATE,
toExpression,
ui: {
containerConfig: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

.visListingTable__experimentalIcon {
width: $euiSizeL;
vertical-align: baseline;
vertical-align: middle;
padding: 0 $euiSizeS;
margin-left: $euiSizeS;
}
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,10 @@ const getBadge = (item: VisualizationListItem) => {
return (
<EuiBetaBadge
className="visListingTable__experimentalIcon"
label="E"
label="Lab"
size="s"
color="subdued"
iconType={'beaker'}
title={i18n.translate('visualize.listing.experimentalTitle', {
defaultMessage: 'Experimental',
})}
Expand Down