fix(interactions): remove the option for pixelRatio with png snapshot (…

…#1431) BREAKING CHANGE: The getPNGSnapshot function no longer has an option for pixelRatio
elastic · Nov 17, 2021 · eebb069 · eebb069
1 parent c5ea600
commit eebb069
Show file tree

Hide file tree

Showing 4 changed files with 1 addition and 4 deletions.
diff --git a/packages/charts/api/charts.api.md b/packages/charts/api/charts.api.md
@@ -421,7 +421,6 @@ export class Chart extends React_2.Component<ChartProps, ChartState> {
     // (undocumented)
     getPNGSnapshot(options?: {
         backgroundColor: string;
-        pixelRatio: number;
     }): {
         blobOrDataUrl: any;
         browser: 'IE11' | 'other';

diff --git a/packages/charts/src/components/chart.snap.test.ts b/packages/charts/src/components/chart.snap.test.ts
@@ -13,7 +13,7 @@ describe('test getPNGSnapshot in Chart class', () => {
   it('should be called', () => {
     const chart = new Chart({});
     const spy = jest.spyOn(chart, 'getPNGSnapshot');
-    chart.getPNGSnapshot({ backgroundColor: 'white', pixelRatio: 1 });
+    chart.getPNGSnapshot({ backgroundColor: 'white' });
 
     expect(spy).toBeCalled();
   });

diff --git a/packages/charts/src/components/chart.tsx b/packages/charts/src/components/chart.tsx
@@ -120,7 +120,6 @@ export class Chart extends React.Component<ChartProps, ChartState> {
     // eslint-disable-next-line unicorn/no-object-as-default-parameter
     options = {
       backgroundColor: Colors.Transparent.keyword,
-      pixelRatio: 2,
     },
   ): {
     blobOrDataUrl: any;

diff --git a/storybook/stories/interactions/17_png_export.story.tsx b/storybook/stories/interactions/17_png_export.story.tsx
@@ -44,7 +44,6 @@ export const Example = () => {
     const snapshot = chartRef.current.getPNGSnapshot({
       // you can set the background and pixel ratio for the PNG export
       backgroundColor: 'white',
-      pixelRatio: 2,
     });
     if (!snapshot) {
       return;