EnxDev commented on code in PR #45648: URL: https://github.com/apache/superset/pull/45648#discussion_r4403001387
########## superset-frontend/plugins/plugin-chart-echarts/src/Timeseries/TimeseriesLegendIcon.tsx: ########## @@ -0,0 +1,208 @@ +/** + * 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 { styled, useTheme } from '@apache-superset/core/theme'; +import type { + TimeseriesLegendIcon as TimeseriesLegendIconData, + TimeseriesLegendLineType, +} from './types'; + +// ECharts legend defaults: itemWidth 25, itemHeight 14, and a line icon's +// symbol at 80% of the item height. +const WIDTH = 25; +const HEIGHT = 14; +const HOLLOW_STROKE_WIDTH = 2; + +const round = (value: number) => Math.round(value * 100) / 100; + +const LINE_SYMBOL_SIZE = round(HEIGHT * 0.8); + +// Same expansion zrender applies to a dashed or dotted line of this width. +function getDashArray( + lineType: TimeseriesLegendLineType, + lineWidth: number, +): string | undefined { + if (lineType === 'dashed') { + return `${4 * lineWidth} ${2 * lineWidth}`; + } + if (lineType === 'dotted') { + return `${lineWidth}`; + } + return Array.isArray(lineType) ? lineType.join(' ') : undefined; +} + +type PaintProps = { + fill: string; + stroke?: string; + strokeWidth?: number; +}; + +function Symbol({ Review Comment: Nit, take it or leave it: this shadows the global `Symbol` for the whole module. Nothing here uses the built-in today, but `LegendSymbol` would save someone a confusing moment later. ########## superset-frontend/plugins/plugin-chart-echarts/src/Timeseries/transformProps.ts: ########## @@ -146,11 +148,75 @@ import { safeParseEChartOptions } from '../utils/safeEChartOptionsParser'; import { mergeCustomEChartOptions } from '../utils/mergeCustomEChartOptions'; type LegendSeriesVisual = { - itemStyle?: { color?: unknown }; - lineStyle?: { color?: unknown }; + itemStyle?: { color?: unknown; opacity?: unknown }; + lineStyle?: { + color?: unknown; + opacity?: unknown; + type?: unknown; + width?: unknown; + }; name?: string | number; + symbol?: unknown; + type?: string; }; +// ECharts draws a circle for `none` and falls back to the series default when unset. +function normalizeLegendSymbol(symbol: unknown, fallback: string): string { + if (symbol === 'none') { + return 'circle'; + } + return typeof symbol === 'string' ? symbol : fallback; +} + +// The legend inherits the series opacity; a fully transparent line (a forecast +// confidence band) still gets a visible icon. +function normalizeLegendOpacity(opacity: unknown): number { + return typeof opacity === 'number' && opacity > 0 && opacity < 1 + ? opacity + : 1; +} + +/** + * The icon the ECharts legend would draw for a series: its line in the series' + * dash style with its symbol, the symbol alone for scatter, a box otherwise. + * The legend line is 2px like ECharts' `lineStyle.width: 'auto'`, or hidden + * when the series hides its own line. + */ +export function getLegendSeriesIcon( + series: SeriesOption | undefined, +): TimeseriesLegendIcon { + const visual = series as LegendSeriesVisual | undefined; + if (visual?.type === 'scatter') { + return { + shape: 'symbol', + opacity: normalizeLegendOpacity(visual.itemStyle?.opacity), + symbol: normalizeLegendSymbol(visual.symbol, 'circle'), + }; + } + if (visual?.type !== 'line') { + return { + shape: 'box', + opacity: normalizeLegendOpacity(visual?.itemStyle?.opacity), + }; + } + const { opacity, type, width } = visual.lineStyle ?? {}; Review Comment: The line icon takes its opacity only from `lineStyle`, but ECharts inherits `itemStyle.opacity` for the symbol separately. On a line chart with rich tooltip and markers both off, `transformSeries` sets `itemStyle.opacity = 0` for the click hack, so Scroll shows a bare line while this legend shows the hollow circle. Pretty narrow, so fine to leave if that's intended. Otherwise a separate symbol opacity on the `line` shape would close the gap. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
