/** * 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. */ import { List } from 'src/components/List'; import { connect } from 'react-redux'; import { PureComponent } from 'react'; import { HandlerFunction, JsonObject, Payload, QueryFormData, SupersetTheme, t, withTheme, } from '@superset-ui/core'; import { InfoTooltipWithTrigger } from '@superset-ui/chart-controls'; import AsyncEsmComponent from 'src/components/AsyncEsmComponent'; import { getChartKey } from 'src/explore/exploreUtils'; import { runAnnotationQuery } from 'src/components/Chart/chartAction'; import CustomListItem from 'src/explore/components/controls/CustomListItem'; import { ChartState, ExplorePageState } from 'src/explore/types'; import { AnyAction } from 'redux'; import { ThunkDispatch } from 'redux-thunk'; import ControlPopover, { getSectionContainerElement, } from '../ControlPopover/ControlPopover'; const AnnotationLayer = AsyncEsmComponent( () => import('./AnnotationLayer'), // size of overlay inner content () =>
, ); export interface Annotation { name: string; show?: boolean; annotation: string; timeout: Date; key: string; formData: QueryFormData | null; isDashboardRequest?: boolean; force?: boolean; } export interface Props { colorScheme: string; annotationError: Record; annotationQuery: Record; vizType: string; validationErrors: JsonObject[]; name: string; actions: { setControlValue: HandlerFunction; }; value: Annotation[]; onChange: (annotations: Annotation[]) => void; refreshAnnotationData: (payload: Payload) => void; theme: SupersetTheme; } export interface PopoverState { popoverVisible: Record; addedAnnotationIndex: number | null; } const defaultProps = { vizType: '', value: [], annotationError: {}, annotationQuery: {}, onChange: () => {}, }; class AnnotationLayerControl extends PureComponent { static defaultProps = defaultProps; constructor(props: Props) { super(props); this.state = { popoverVisible: {}, addedAnnotationIndex: null, }; this.addAnnotationLayer = this.addAnnotationLayer.bind(this); this.removeAnnotationLayer = this.removeAnnotationLayer.bind(this); this.handleVisibleChange = this.handleVisibleChange.bind(this); } componentDidMount() { // preload the AnnotationLayer component and dependent libraries i.e. mathjs AnnotationLayer.preload(); } UNSAFE_componentWillReceiveProps(nextProps: Props) { const { name, annotationError, validationErrors, value } = nextProps; if (Object.keys(annotationError).length && !validationErrors.length) { this.props.actions.setControlValue( name, value, Object.keys(annotationError), ); } if (!Object.keys(annotationError).length && validationErrors.length) { this.props.actions.setControlValue(name, value, []); } } addAnnotationLayer = ( originalAnnotation: Annotation | null, newAnnotation: Annotation, ) => { let annotations = this.props.value; if (originalAnnotation && annotations.includes(originalAnnotation)) { annotations = annotations.map(anno => anno === originalAnnotation ? newAnnotation : anno, ); } else { annotations = [...annotations, newAnnotation]; this.setState({ addedAnnotationIndex: annotations.length - 1 }); } this.props.refreshAnnotationData({ annotation: newAnnotation, force: true, }); this.props.onChange(annotations); }; handleVisibleChange = (visible: boolean, popoverKey: number | string) => { this.setState(prevState => ({ popoverVisible: { ...prevState.popoverVisible, [popoverKey]: visible }, })); }; removeAnnotationLayer(annotation: Annotation | null) { const annotations = this.props.value.filter(anno => anno !== annotation); // So scrollbar doesnt get stuck on hidden const element = getSectionContainerElement(); if (element) { element.style.setProperty('overflow-y', 'auto', 'important'); } this.props.onChange(annotations); } renderPopover = ( popoverKey: number | string, annotation: Annotation | null, error: string, ) => { const id = annotation?.name || '_new'; return (
this.addAnnotationLayer(annotation, newAnnotation) } removeAnnotationLayer={() => this.removeAnnotationLayer(annotation)} close={() => { this.handleVisibleChange(false, popoverKey); this.setState({ addedAnnotationIndex: null }); }} />
); }; renderInfo(anno: Annotation) { const { annotationError, annotationQuery, theme } = this.props; if (annotationQuery[anno.name]) { return ( ); } if (annotationError[anno.name]) { return ( ); } if (!anno.show) { return Hidden ; } return ''; } render() { const { addedAnnotationIndex } = this.state; const addedAnnotation = addedAnnotationIndex !== null ? this.props.value[addedAnnotationIndex] : null; const annotations = this.props.value.map((anno, i) => ( ({ '&:hover': { cursor: 'pointer', backgroundColor: theme.colors.grayscale.light4, }, })} content={this.renderPopover( i, anno, this.props.annotationError[anno.name], )} visible={this.state.popoverVisible[i]} onVisibleChange={visible => this.handleVisibleChange(visible, i)} > {anno.name} {this.renderInfo(anno)} )); const addLayerPopoverKey = 'add'; return (
({ borderRadius: theme.gridUnit })}> {annotations} this.handleVisibleChange(visible, addLayerPopoverKey) } > {' '}   {t('Add annotation layer')}
); } } // Tried to hook this up through stores/control.jsx instead of using redux // directly, could not figure out how to get access to the color_scheme function mapStateToProps({ charts, explore, }: Pick) { const chartKey = getChartKey(explore); const defaultChartState: Partial = { annotationError: {}, annotationQuery: {}, }; const chart = chartKey && charts[chartKey] ? charts[chartKey] : defaultChartState; return { // eslint-disable-next-line camelcase colorScheme: explore.controls?.color_scheme?.value, annotationError: chart.annotationError ?? {}, annotationQuery: chart.annotationQuery ?? {}, vizType: explore.controls?.viz_type.value, }; } function mapDispatchToProps( dispatch: ThunkDispatch, ) { return { refreshAnnotationData: (annotationObj: Annotation) => dispatch(runAnnotationQuery(annotationObj)), }; } const themedAnnotationLayerControl = withTheme(AnnotationLayerControl); export default connect( mapStateToProps, mapDispatchToProps, )(themedAnnotationLayerControl);