mirror of
https://github.com/apache/superset.git
synced 2026-04-13 21:24:28 +00:00
240 lines
7.6 KiB
TypeScript
240 lines
7.6 KiB
TypeScript
/**
|
|
* 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 { CategoricalColorScale, ChartProps } from '@superset-ui/core';
|
|
import { GenericDataType } from '@apache-superset/core/api/core';
|
|
import { supersetTheme } from '@apache-superset/core/ui';
|
|
import type { SeriesOption } from 'echarts';
|
|
import { EchartsTimeseriesSeriesType } from '../../src';
|
|
import {
|
|
transformSeries,
|
|
transformNegativeLabelsPosition,
|
|
} from '../../src/Timeseries/transformers';
|
|
import transformProps from '../../src/Timeseries/transformProps';
|
|
import { EchartsTimeseriesChartProps } from '../../src/types';
|
|
|
|
// Mock the colorScale function
|
|
const mockColorScale = jest.fn(
|
|
(key: string, sliceId?: number) => `color-for-${key}-${sliceId}`,
|
|
) as unknown as CategoricalColorScale;
|
|
|
|
describe('transformSeries', () => {
|
|
const series = { name: 'test-series' };
|
|
|
|
it('should use the colorScaleKey if timeShiftColor is enabled', () => {
|
|
const opts = {
|
|
timeShiftColor: true,
|
|
colorScaleKey: 'test-key',
|
|
sliceId: 1,
|
|
};
|
|
|
|
const result = transformSeries(series, mockColorScale, 'test-key', opts);
|
|
|
|
expect((result as any)?.itemStyle.color).toBe('color-for-test-key-1');
|
|
});
|
|
|
|
it('should use seriesKey if timeShiftColor is not enabled', () => {
|
|
const opts = {
|
|
timeShiftColor: false,
|
|
seriesKey: 'series-key',
|
|
sliceId: 2,
|
|
};
|
|
|
|
const result = transformSeries(series, mockColorScale, 'test-key', opts);
|
|
|
|
expect((result as any)?.itemStyle.color).toBe('color-for-series-key-2');
|
|
});
|
|
|
|
it('should apply border styles for bar series with connectNulls', () => {
|
|
const opts = {
|
|
seriesType: EchartsTimeseriesSeriesType.Bar,
|
|
connectNulls: true,
|
|
timeShiftColor: false,
|
|
};
|
|
|
|
const result = transformSeries(series, mockColorScale, 'test-key', opts);
|
|
|
|
expect((result as any).itemStyle.borderWidth).toBe(1.5);
|
|
expect((result as any).itemStyle.borderType).toBe('dotted');
|
|
expect((result as any).itemStyle.borderColor).toBe(
|
|
(result as any).itemStyle.color,
|
|
);
|
|
});
|
|
|
|
it('should not apply border styles for non-bar series', () => {
|
|
const opts = {
|
|
seriesType: EchartsTimeseriesSeriesType.Line,
|
|
connectNulls: true,
|
|
timeShiftColor: false,
|
|
};
|
|
|
|
const result = transformSeries(series, mockColorScale, 'test-key', opts);
|
|
|
|
expect((result as any).itemStyle.borderWidth).toBe(0);
|
|
expect((result as any).itemStyle.borderType).toBeUndefined();
|
|
expect((result as any).itemStyle.borderColor).toBeUndefined();
|
|
});
|
|
});
|
|
|
|
describe('transformNegativeLabelsPosition', () => {
|
|
it('label position bottom of negative value no Horizontal', () => {
|
|
const isHorizontal = false;
|
|
const series: SeriesOption = {
|
|
data: [
|
|
[2020, 1],
|
|
[2021, 3],
|
|
[2022, -2],
|
|
[2023, -5],
|
|
[2024, 4],
|
|
],
|
|
type: EchartsTimeseriesSeriesType.Bar,
|
|
stack: undefined,
|
|
};
|
|
const result =
|
|
Array.isArray(series.data) && series.type === 'bar' && !series.stack
|
|
? transformNegativeLabelsPosition(series, isHorizontal)
|
|
: series.data;
|
|
expect((result as any)[0].label).toBe(undefined);
|
|
expect((result as any)[1].label).toBe(undefined);
|
|
expect((result as any)[2].label.position).toBe('outside');
|
|
expect((result as any)[3].label.position).toBe('outside');
|
|
expect((result as any)[4].label).toBe(undefined);
|
|
});
|
|
|
|
it('label position left of negative value is Horizontal', () => {
|
|
const isHorizontal = true;
|
|
const series: SeriesOption = {
|
|
data: [
|
|
[1, 2020],
|
|
[-3, 2021],
|
|
[2, 2022],
|
|
[-4, 2023],
|
|
[-6, 2024],
|
|
],
|
|
type: EchartsTimeseriesSeriesType.Bar,
|
|
stack: undefined,
|
|
};
|
|
|
|
const result =
|
|
Array.isArray(series.data) && series.type === 'bar' && !series.stack
|
|
? transformNegativeLabelsPosition(series, isHorizontal)
|
|
: series.data;
|
|
expect((result as any)[0].label).toBe(undefined);
|
|
expect((result as any)[1].label.position).toBe('outside');
|
|
expect((result as any)[2].label).toBe(undefined);
|
|
expect((result as any)[3].label.position).toBe('outside');
|
|
expect((result as any)[4].label.position).toBe('outside');
|
|
});
|
|
|
|
it('label position to line type', () => {
|
|
const isHorizontal = false;
|
|
const series: SeriesOption = {
|
|
data: [
|
|
[2020, 1],
|
|
[2021, 3],
|
|
[2022, -2],
|
|
[2023, -5],
|
|
[2024, 4],
|
|
],
|
|
type: EchartsTimeseriesSeriesType.Line,
|
|
stack: undefined,
|
|
};
|
|
|
|
const result =
|
|
Array.isArray(series.data) &&
|
|
!series.stack &&
|
|
series.type !== 'line' &&
|
|
series.type === 'bar'
|
|
? transformNegativeLabelsPosition(series, isHorizontal)
|
|
: series.data;
|
|
expect((result as any)[0].label).toBe(undefined);
|
|
expect((result as any)[1].label).toBe(undefined);
|
|
expect((result as any)[2].label).toBe(undefined);
|
|
expect((result as any)[3].label).toBe(undefined);
|
|
expect((result as any)[4].label).toBe(undefined);
|
|
});
|
|
|
|
it('label position to bar type and stack', () => {
|
|
const isHorizontal = false;
|
|
const series: SeriesOption = {
|
|
data: [
|
|
[2020, 1],
|
|
[2021, 3],
|
|
[2022, -2],
|
|
[2023, -5],
|
|
[2024, 4],
|
|
],
|
|
type: EchartsTimeseriesSeriesType.Bar,
|
|
stack: 'obs',
|
|
};
|
|
|
|
const result =
|
|
Array.isArray(series.data) && series.type === 'bar' && !series.stack
|
|
? transformNegativeLabelsPosition(series, isHorizontal)
|
|
: series.data;
|
|
expect((result as any)[0].label).toBe(undefined);
|
|
expect((result as any)[1].label).toBe(undefined);
|
|
expect((result as any)[2].label).toBe(undefined);
|
|
expect((result as any)[3].label).toBe(undefined);
|
|
expect((result as any)[4].label).toBe(undefined);
|
|
});
|
|
});
|
|
|
|
test('should configure time axis labels to show max label for last month visibility', () => {
|
|
const formData = {
|
|
colorScheme: 'bnbColors',
|
|
datasource: '3__table',
|
|
granularity_sqla: 'ds',
|
|
metric: 'sum__num',
|
|
viz_type: 'my_viz',
|
|
};
|
|
const queriesData = [
|
|
{
|
|
data: [
|
|
{ sum__num: 100, __timestamp: new Date('2026-01-01').getTime() },
|
|
{ sum__num: 200, __timestamp: new Date('2026-02-01').getTime() },
|
|
{ sum__num: 300, __timestamp: new Date('2026-03-01').getTime() },
|
|
{ sum__num: 400, __timestamp: new Date('2026-04-01').getTime() },
|
|
{ sum__num: 500, __timestamp: new Date('2026-05-01').getTime() },
|
|
],
|
|
colnames: ['sum__num', '__timestamp'],
|
|
coltypes: [GenericDataType.Numeric, GenericDataType.Temporal],
|
|
},
|
|
];
|
|
const chartProps = new ChartProps({
|
|
formData,
|
|
width: 800,
|
|
height: 600,
|
|
queriesData,
|
|
theme: supersetTheme,
|
|
});
|
|
|
|
const result = transformProps(
|
|
chartProps as unknown as EchartsTimeseriesChartProps,
|
|
);
|
|
|
|
expect(result.echartOptions.xAxis).toEqual(
|
|
expect.objectContaining({
|
|
axisLabel: expect.objectContaining({
|
|
showMaxLabel: true,
|
|
alignMaxLabel: 'right',
|
|
}),
|
|
}),
|
|
);
|
|
});
|