EnxDev commented on code in PR #45223: URL: https://github.com/apache/superset/pull/45223#discussion_r4255952339
########## superset-frontend/plugins/plugin-chart-echarts/src/Bubble/crossFilter.ts: ########## @@ -0,0 +1,180 @@ +/** + * 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 { + DataRecordValue, + QueryFormColumn, + QueryObjectFilterClause, +} from '@superset-ui/core'; +import { NULL_STRING } from '../constants'; + +/** Scatter point payload: [x, y, size, entity, series]. */ +export type BubbleDatum = [ + DataRecordValue, + DataRecordValue, + DataRecordValue, + DataRecordValue, + DataRecordValue, +]; + +export const ENTITY_INDEX = 3; +export const SERIES_INDEX = 4; + +/** Display text for an empty-string dimension value. */ +export const EMPTY_STRING = '""'; Review Comment: The app already has a display convention for this: `EMPTY_STRING = '<empty string>'` in `src/utils/common.ts`, used by `optionLabel` next to `<NULL>`. A plugin can't import from there, but matching the text would keep a bubble legend from reading `""` while the rest of the app says `<empty string>`. ########## superset-frontend/plugins/plugin-chart-echarts/src/Bubble/crossFilter.ts: ########## @@ -0,0 +1,180 @@ +/** + * 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 { + DataRecordValue, + QueryFormColumn, + QueryObjectFilterClause, +} from '@superset-ui/core'; +import { NULL_STRING } from '../constants'; + +/** Scatter point payload: [x, y, size, entity, series]. */ +export type BubbleDatum = [ + DataRecordValue, + DataRecordValue, + DataRecordValue, + DataRecordValue, + DataRecordValue, +]; + +export const ENTITY_INDEX = 3; +export const SERIES_INDEX = 4; + +/** Display text for an empty-string dimension value. */ +export const EMPTY_STRING = '""'; + +/** + * Human-readable text for a dimension value, used for series names, tooltips + * and the cross-filter chip. `null` and `''` stay distinguishable because they + * produce different filters (`IS NULL` vs `IN ['']`). + */ +export function formatBubbleValue(value: DataRecordValue): string { + if (value == null) { + return NULL_STRING; + } + const text = String(value); + return text === '' ? EMPTY_STRING : text; +} + +export function isBubbleDatum(value: unknown): value is BubbleDatum { + return Array.isArray(value) && value.length > SERIES_INDEX; +} + +function toKeyPart( + value: DataRecordValue | undefined, +): string | number | boolean | null { + if (value == null) { + return null; + } + if (typeof value === 'bigint') { + return value.toString(); + } + return value instanceof Date ? value.toISOString() : value; +} + +/** + * Stable identifier of a bubble, stored in `filterState.selectedValues`. + * A JSON array keeps entity and series unambiguous (including `null` vs `''` + * and `1` vs `'1'`) and survives serialization into dashboard state. + */ +export function getBubbleCrossFilterKey( + entityValue: DataRecordValue, + seriesValue: DataRecordValue | undefined, + hasSeries: boolean, +): string { + const parts = hasSeries + ? [toKeyPart(entityValue), toKeyPart(seriesValue)] + : [toKeyPart(entityValue)]; + return JSON.stringify(parts); +} + +export function getBubbleCrossFilterLabel( + entityValue: DataRecordValue, + seriesValue: DataRecordValue | undefined, + hasSeries: boolean, +): string { + const entityPart = formatBubbleValue(entityValue); Review Comment: If I'm reading it right, a temporal entity or series arrives here as the raw epoch, so the cross-filter chip would read something like `1704067200000`. The drill filters in `EchartsBubble.tsx` already go through `formatSeriesName` with the column type. Could the chip label use the same formatter? `coltypeMapping` and `dateFormat` are both in scope where the data mask is built. -- 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]
