Skip to content

Commit

Permalink
Adding custom control overrides (apache#6956)
Browse files Browse the repository at this point in the history
* Adding extraOverrides to line chart

* Updating extraOverrides to fit with more cases

* Moving extraOverrides to index.js

* Removing webpack-merge in package.json

* Fixing metrics control clearing metric
  • Loading branch information
michellethomas authored Mar 6, 2019
1 parent c1ba914 commit e619405
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 6 deletions.
31 changes: 27 additions & 4 deletions superset/assets/src/explore/components/controls/MetricsControl.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,21 @@ function isDictionaryForAdhocMetric(value) {
return value && !(value instanceof AdhocMetric) && value.expressionType;
}

function columnsContainAllMetrics(value, nextProps) {
const columnNames = new Set(
[...nextProps.columns, ...nextProps.savedMetrics]
// eslint-disable-next-line camelcase
.map(({ column_name, metric_name }) => (column_name || metric_name)),
);

return (Array.isArray(value) ? value : [value])
.filter(metric => metric)
// find column names
.map(metric => metric.column ? metric.column.column_name : metric.column_name || metric)
.filter(name => name)
.every(name => columnNames.has(name));
}

// adhoc metrics are stored as dictionaries in URL params. We convert them back into the
// AdhocMetric class for typechecking, consistency and instance method access.
function coerceAdhocMetrics(value) {
Expand Down Expand Up @@ -135,14 +150,22 @@ export default class MetricsControl extends React.PureComponent {
}

componentWillReceiveProps(nextProps) {
const { value } = this.props;
if (
isEqual(this.props.columns) !== isEqual(nextProps.columns) ||
isEqual(this.props.savedMetrics) !== isEqual(nextProps.savedMetrics)
!isEqual(this.props.columns, nextProps.columns) ||
!isEqual(this.props.savedMetrics, nextProps.savedMetrics)
) {

this.setState({ options: this.optionsForSelect(nextProps) });
this.props.onChange([]);

// Remove metrics if selected value no longer a column
const containsAllMetrics = columnsContainAllMetrics(value, nextProps);

if (!containsAllMetrics) {
this.props.onChange([]);
}
}
if (this.props.value !== nextProps.value) {
if (value !== nextProps.value) {
this.setState({ value: coerceAdhocMetrics(nextProps.value) });
}
}
Expand Down
22 changes: 22 additions & 0 deletions superset/assets/src/explore/controlPanels/extraOverrides.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
// For individual deployments to add custom overrides
export default function extraOverrides(controlPanelConfigs) {
return controlPanelConfigs;
}
5 changes: 3 additions & 2 deletions superset/assets/src/explore/controlPanels/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
*/
import { isFeatureEnabled, FeatureFlag } from 'src/featureFlags';
import * as sections from './sections';
import extraOverrides from './extraOverrides';

import Area from './Area';
import Bar from './Bar';
Expand Down Expand Up @@ -72,7 +73,7 @@ import DeckPolygon from './DeckPolygon';
import DeckScatter from './DeckScatter';
import DeckScreengrid from './DeckScreengrid';

export const controlPanelConfigs = {
export const controlPanelConfigs = extraOverrides({
area: Area,
bar: Bar,
big_number: BigNumber,
Expand Down Expand Up @@ -122,7 +123,7 @@ export const controlPanelConfigs = {
deck_scatter: DeckScatter,
deck_screengrid: DeckScreengrid,

};
});

export default controlPanelConfigs;

Expand Down

0 comments on commit e619405

Please sign in to comment.