Copilot commented on code in PR #43863: URL: https://github.com/apache/superset/pull/43863#discussion_r3934963730
########## superset-frontend/plugins/plugin-chart-echarts/src/Candlestick/transformProps.ts: ########## @@ -0,0 +1,519 @@ +/** + * 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 { + AxisType, + CurrencyFormatter, + DataRecord, + ensureIsArray, + getColumnLabel, + getMetricLabel, + getNumberFormatter, + getTimeFormatter, + NumberFormatter, + rgbToHex, + tooltipHtml, +} from '@superset-ui/core'; +import { GenericDataType } from '@apache-superset/core/common'; +import type { EChartsCoreOption } from 'echarts/core'; +import type { CandlestickSeriesOption, LineSeriesOption } from 'echarts/charts'; +import type { CallbackDataParams } from 'echarts/types/src/util/types'; +import { + CandlestickChartTransformedProps, + EchartsCandlestickChartProps, +} from './types'; +import { + CANDLESTICK_SERIES_NAME, + DEFAULT_DECREASE_COLOR, + DEFAULT_FORM_DATA, + DEFAULT_INCREASE_COLOR, + DIRECTION_LABELS, + OHLC_LABELS, +} from './constants'; +import { defaultGrid, defaultYAxis } from '../defaults'; +import { getDefaultTooltip } from '../utils/tooltip'; +import { + extractGroupbyLabel, + getChartPadding, + getColtypesMapping, + getLegendProps, +} from '../utils/series'; +import { convertInteger } from '../utils/convertInteger'; +import { mergeCustomEChartOptions } from '../utils/mergeCustomEChartOptions'; +import { safeParseEChartOptions } from '../utils/safeEChartOptionsParser'; +import { NULL_STRING, TIMESERIES_CONSTANTS } from '../constants'; +import { LegendOrientation, LegendType, Refs } from '../types'; +import { resolveLegendLayout } from '../utils/legendLayout'; +import { + calculateMA, + MA_LINE_OPACITY, + movingAverageName, + parseMovingAveragePeriods, +} from './utils'; + +type OhlcValue = [number, number, number, number]; +type CandlestickDatum = NonNullable<CandlestickSeriesOption['data']>[number]; + +function toNumber(value: unknown): number | null { + if (value === null || value === undefined || value === '') { + return null; + } + const numeric = Number(value); + return Number.isFinite(numeric) ? numeric : null; +} + +function getOhlc( + datum: DataRecord, + openLabel: string, + closeLabel: string, + lowLabel: string, + highLabel: string, +): OhlcValue | null { + const open = toNumber(datum[openLabel]); + const close = toNumber(datum[closeLabel]); + const low = toNumber(datum[lowLabel]); + const high = toNumber(datum[highLabel]); + if (open === null || close === null || low === null || high === null) { + return null; + } + return [open, close, low, high]; +} + +function toCandlestickDatum( + datum: DataRecord | undefined, + openLabel: string, + closeLabel: string, + lowLabel: string, + highLabel: string, +): CandlestickDatum { + if (!datum) { + return []; + } + return getOhlc(datum, openLabel, closeLabel, lowLabel, highLabel) ?? []; +} + +function extractOhlc(value: unknown): OhlcValue | null { + if (!Array.isArray(value)) { + return null; + } + const raw = value.length >= 5 ? value.slice(1, 5) : value.slice(0, 4); + if (raw.length !== 4) { + return null; + } + const [open, close, low, high] = raw.map(item => Number(item)); + if ([open, close, low, high].some(item => !Number.isFinite(item))) { + return null; + } + return [open, close, low, high]; +} + +function formatTooltip({ + params, + numberFormatter, + title, + increaseLabel, + decreaseLabel, +}: { + params: CallbackDataParams[]; + numberFormatter: NumberFormatter | CurrencyFormatter; + title: string; + increaseLabel: string; + decreaseLabel: string; +}) { + const rows: string[][] = []; + let heading = title; + const candle = params.find(item => extractOhlc(item.value ?? item.data)); + if (candle) { + const ohlc = extractOhlc(candle.value ?? candle.data); + if (ohlc) { + const [open, close, low, high] = ohlc; + const direction = close >= open ? increaseLabel : decreaseLabel; + heading = title ? `${title} (${direction})` : direction; + rows.push( + [OHLC_LABELS.OPEN, numberFormatter(open)], + [OHLC_LABELS.CLOSE, numberFormatter(close)], + [OHLC_LABELS.LOW, numberFormatter(low)], + [OHLC_LABELS.HIGH, numberFormatter(high)], + ); + } + } + params.forEach(item => { + if (item.seriesType !== 'line') { + return; + } + const value = Number(item.value); + if (!Number.isFinite(value)) { + return; + } + rows.push([String(item.seriesName ?? ''), numberFormatter(value)]); + }); + if (!rows.length) { + return ''; + } + return tooltipHtml(rows, heading); +} + +export default function transformProps( + chartProps: EchartsCandlestickChartProps, +): CandlestickChartTransformedProps { + const { + width, + height, + formData: { echartOptions: customEchartOptionsInput, ...rawFormData }, + hooks, + queriesData, + inContextMenu, + theme, + legendState = {}, + } = chartProps; + const formData = { + ...DEFAULT_FORM_DATA, + ...rawFormData, + }; + const [queryData] = queriesData; + const { data = [] } = queryData; + const { onLegendStateChanged } = hooks; + const refs: Refs = {}; + const coltypeMapping = getColtypesMapping(queryData); + + const { + xAxis, + open, + close, + high, + low, + series: seriesControl, + increaseColor = DEFAULT_INCREASE_COLOR, + decreaseColor = DEFAULT_DECREASE_COLOR, + increaseLabel, + decreaseLabel, + showXAxis, + showYAxis, + xAxisTimeFormat, + xAxisTitle, + xAxisTitleMargin, + xAxisLabelRotation, + xAxisLabelInterval, + yAxisTitle, + yAxisTitleMargin, + yAxisTitlePosition, + yAxisFormat, + currencyFormat, + tooltipTimeFormat, + tooltipValuesFormat, + showLegend, + legendMargin, + legendOrientation = LegendOrientation.Top, + legendType = LegendType.Scroll, + legendSort, + zoomable, + movingAverages, + } = formData; + + const xAxisName = xAxis ? getColumnLabel(xAxis) : ''; + const seriesColumns = ensureIsArray(seriesControl).map(getColumnLabel); + const [seriesName] = seriesColumns; + const openLabel = open ? getMetricLabel(open) : ''; + const closeLabel = close ? getMetricLabel(close) : ''; + const highLabel = high ? getMetricLabel(high) : ''; + const lowLabel = low ? getMetricLabel(low) : ''; + const timeFormatter = getTimeFormatter(tooltipTimeFormat || xAxisTimeFormat); + const axisTimeFormatter = getTimeFormatter(xAxisTimeFormat); + const numberFormatter = currencyFormat?.symbol + ? new CurrencyFormatter({ + d3Format: tooltipValuesFormat || yAxisFormat, + currency: currencyFormat, + }) + : getNumberFormatter(tooltipValuesFormat || yAxisFormat); + const yAxisFormatter = currencyFormat?.symbol + ? new CurrencyFormatter({ + d3Format: yAxisFormat, + currency: currencyFormat, + }) + : getNumberFormatter(yAxisFormat); + + const increaseHex = rgbToHex( + increaseColor.r, + increaseColor.g, + increaseColor.b, + ); + const decreaseHex = rgbToHex( + decreaseColor.r, + decreaseColor.g, + decreaseColor.b, + ); + const upLabel = increaseLabel || DIRECTION_LABELS.INCREASE; + const downLabel = decreaseLabel || DIRECTION_LABELS.DECREASE; + + const xKeys: string[] = []; + const xLabels: string[] = []; + const xRecords: DataRecord[] = []; + const xKeySet = new Set<string>(); + data.forEach(datum => { + const raw = datum[xAxisName]; + const key = raw == null ? NULL_STRING : String(raw); Review Comment: Using the display placeholder as the identity key collapses a real null x value with a literal `"<NULL>"` value. The second category is skipped by `xKeySet`, so one candle is silently lost; retain the raw value or a unique null sentinel for lookup and format only the displayed label. This issue also appears on line 295 of the same file. ########## superset-frontend/plugins/plugin-chart-echarts/src/Candlestick/utils.ts: ########## @@ -0,0 +1,78 @@ +/** + * 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 { ensureIsArray } from '@superset-ui/core'; + +export const MOVING_AVERAGE_PERIODS = [5, 10, 15, 20, 30, 60]; +export const MA_LINE_OPACITY = 0.5; + +export function movingAverageName(period: number, seriesName?: string): string { + const label = `MA${period}`; + return seriesName ? `${seriesName} ${label}` : label; +} + +function parseMovingAveragePeriod(item: unknown): number | null { + if (typeof item === 'number') { + return Number.isInteger(item) && item > 1 ? item : null; + } + const match = String(item) + .trim() + .match(/^(?:MA)?(\d+)$/i); + if (!match) { + return null; + } + const period = Number(match[1]); + return Number.isInteger(period) && period > 1 ? period : null; +} + +export function parseMovingAveragePeriods(value: unknown): number[] { + const periods = ensureIsArray(value) + .map(parseMovingAveragePeriod) + .filter((period): period is number => period !== null); + return [...new Set(periods)].sort((left, right) => left - right); +} + +/** + * Simple moving average of close prices, matching the ECharts candlestick + * example: the first `period` points are omitted, then each value is the + * mean of the current close and the previous `period - 1` closes. + */ +export function calculateMA( + closes: Array<number | null>, + period: number, +): Array<number | '-'> { + const result: Array<number | '-'> = []; + for (let i = 0; i < closes.length; i += 1) { + if (i < period) { Review Comment: A period-N moving average should become available after N observations, so only the first `period - 1` points should be omitted. This condition makes exactly N samples produce no MA and shifts every result by one category (for example, MA5 first averages rows 2–6 instead of 1–5). Change the boundary and update the test expectations accordingly. -- 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]
