Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(react-charting): strongly type plotly schema and bug fixes #33621

Merged
merged 23 commits into from
Jan 20, 2025
Merged

feat(react-charting): strongly type plotly schema and bug fixes #33621

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
0419eac
Make plotly schema strongly typed
AtishayMsft Jan 12, 2025
d36c6be
Remove explicit type checking
AtishayMsft Jan 12, 2025
437be6d
Fix compilation errors
AtishayMsft Jan 13, 2025
ab36c15
Fix lint errors
AtishayMsft Jan 13, 2025
ddaa435
Update snapshot
AtishayMsft Jan 13, 2025
ffa1da0
Add change file
AtishayMsft Jan 13, 2025
6b9432e
Sankey and gauge chart fix (#33628)
Anush2303 Jan 13, 2025
0e0d631
Refactor code
AtishayMsft Jan 15, 2025
1dde2d9
Refactor legend naming
AtishayMsft Jan 15, 2025
4ac87d0
Adding secondary y axis for declarative charts (#33625)
srmukher Jan 15, 2025
54d722b
Adding fallback and fixes for test app crashes for 12 schema data (#…
srmukher Jan 16, 2025
b301ec9
Merge branch 'master' into user/atisjai/stronglyTypePlotly
AtishayMsft Jan 16, 2025
2d1d3bc
Refactor to remove duplicate code
AtishayMsft Jan 17, 2025
03455a4
fix(react-charting): resolve bugs in declarative chart (#33564)
krkshitij Jan 17, 2025
fac7280
fix(declarative charts): Add check in Date parsing method (#33674)
Anush2303 Jan 17, 2025
379df8e
Fix gauge value label
atisjai Jan 18, 2025
5309685
feat(declarative-chart): Add default colorScale in heatmap chart (#33…
Anush2303 Jan 20, 2025
e6f03f8
fix: [BUG 12161] handle scatter plot with markers mode in plotly (#33…
srmukher Jan 20, 2025
3e4fdb7
fix: [BUG 12159] default legend selection for Horizontal Bar Chart (#…
srmukher Jan 20, 2025
047c115
Merge master
atisjai Jan 20, 2025
f90a4a1
Merge branch 'user/atisjai/stronglyTypePlotly' of https://github.com/…
atisjai Jan 20, 2025
465a1cd
Format error
atisjai Jan 20, 2025
a19d189
Update snapshot
atisjai Jan 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions packages/charts/react-charting/bundle-size/DeclarativeChart.fixture.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import { DeclarativeChart } from '@fluentui/react-charting';
AtishayMsft marked this conversation as resolved.
Show resolved Hide resolved

console.log(DeclarativeChart);

export default {
name: 'DeclarativeChart',
};
43 changes: 26 additions & 17 deletions packages/charts/react-charting/src/components/DeclarativeChart/DeclarativeChart.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
/* eslint-disable @typescript-eslint/naming-convention */
/* eslint-disable @typescript-eslint/no-explicit-any */
import * as React from 'react';
import { useTheme } from '@fluentui/react';
import { IRefObject } from '@fluentui/react/lib/Utilities';
import { DonutChart } from '../DonutChart/index';
import { VerticalStackedBarChart } from '../VerticalStackedBarChart/index';
import { PlotData, PlotlySchema } from './PlotlySchema';
//import type { Data, Layout } from './PlotlySchema';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can remove this comment.

import {
isArrayOrTypedArray,
isDateArray,
Expand All @@ -22,9 +23,9 @@ import {
transformPlotlyJsonToGVBCProps,
transformPlotlyJsonToVBCProps,
} from './PlotlySchemaAdapter';
import { LineChart } from '../LineChart/index';
import { LineChart, ILineChartProps } from '../LineChart/index';
import { HorizontalBarChartWithAxis } from '../HorizontalBarChartWithAxis/index';
import { AreaChart } from '../AreaChart/index';
import { AreaChart, IAreaChartProps } from '../AreaChart/index';
import { HeatMapChart } from '../HeatMapChart/index';
import { SankeyChart } from '../SankeyChart/SankeyChart';
import { GaugeChart } from '../GaugeChart/index';
Expand All @@ -41,6 +42,7 @@ export interface Schema {
/**
* Plotly schema represented as JSON object
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
plotlySchema: any;
}

Expand Down Expand Up @@ -87,12 +89,8 @@ export const DeclarativeChart: React.FunctionComponent<DeclarativeChartProps> =
DeclarativeChartProps
>((props, forwardedRef) => {
const { plotlySchema } = sanitizeJson(props.chartSchema);
const { data, layout } = plotlySchema;
const plotlyInput = plotlySchema as PlotlySchema;
let { selectedLegends } = plotlySchema;
const xValues = data[0].x;
const isXDate = isDateArray(xValues);
const isXNumber = isNumberArray(xValues);
const isXMonth = isMonthArray(xValues);
const colorMap = useColorMapping();
const theme = useTheme();
const isDarkTheme = theme?.isInverted ?? false;
Expand All @@ -106,7 +104,7 @@ export const DeclarativeChart: React.FunctionComponent<DeclarativeChartProps> =
const onActiveLegendsChange = (keys: string[]) => {
setActiveLegends(keys);
if (props.onSchemaChange) {
props.onSchemaChange({ plotlySchema: { data, layout, selectedLegends: keys } });
props.onSchemaChange({ plotlySchema: { plotlyInput, selectedLegends: keys } });
}
};

Expand Down Expand Up @@ -148,7 +146,7 @@ export const DeclarativeChart: React.FunctionComponent<DeclarativeChartProps> =
selectedLegends: activeLegends,
};

switch (data[0].type) {
switch (plotlyInput.data[0].type) {
case 'pie':
return (
<DonutChart
Expand All @@ -160,7 +158,7 @@ export const DeclarativeChart: React.FunctionComponent<DeclarativeChartProps> =
/>
);
case 'bar':
const orientation = data[0].orientation;
const orientation = plotlyInput.data[0].orientation;
if (orientation === 'h') {
return (
<HorizontalBarChartWithAxis
Expand Down Expand Up @@ -191,8 +189,14 @@ export const DeclarativeChart: React.FunctionComponent<DeclarativeChartProps> =
);
}
case 'scatter':
const isAreaChart = data.some((series: any) => series.fill === 'tonexty' || series.fill === 'tozeroy');
const renderChart = (chartProps: any) => {
const xValues = (plotlyInput.data[0] as PlotData).x;
const isXDate = isDateArray(xValues);
const isXNumber = isNumberArray(xValues);
const isXMonth = isMonthArray(xValues);
const isAreaChart = plotlyInput.data.some(
(series: PlotData) => series.fill === 'tonexty' || series.fill === 'tozeroy',
);
const renderChart = (chartProps: ILineChartProps | IAreaChartProps) => {
if (isAreaChart) {
return (
<AreaChart
Expand All @@ -216,19 +220,24 @@ export const DeclarativeChart: React.FunctionComponent<DeclarativeChartProps> =
};
if (isXDate || isXNumber) {
const chartProps = {
...transformPlotlyJsonToScatterChartProps({ data, layout }, isAreaChart, colorMap, isDarkTheme),
...transformPlotlyJsonToScatterChartProps(plotlyInput, isAreaChart, colorMap, isDarkTheme),
legendProps,
componentRef: chartRef,
calloutProps: { layerProps: { eventBubblingEnabled: true } },
};
return renderChart(chartProps);
} else if (isXMonth) {
const updatedData = data.map((dataPoint: any) => ({
const updatedData = plotlyInput.data.map((dataPoint: PlotData) => ({
...dataPoint,
x: updateXValues(dataPoint.x),
}));
const chartProps = {
...transformPlotlyJsonToScatterChartProps({ data: updatedData, layout }, isAreaChart, colorMap, isDarkTheme),
...transformPlotlyJsonToScatterChartProps(
{ data: updatedData, layout: plotlyInput.layout },
isAreaChart,
colorMap,
isDarkTheme,
),
legendProps,
componentRef: chartRef,
calloutProps: { layerProps: { eventBubblingEnabled: true } },
Expand Down Expand Up @@ -260,7 +269,7 @@ export const DeclarativeChart: React.FunctionComponent<DeclarativeChartProps> =
/>
);
case 'indicator':
if (data?.[0]?.mode?.includes('gauge')) {
if (plotlyInput.data?.[0]?.mode?.includes('gauge')) {
return (
<GaugeChart
{...transformPlotlyJsonToGaugeProps(plotlySchema, colorMap, isDarkTheme)}
Expand Down
Loading
Loading