@eeacms/volto-tableau 4.0.0 → 4.1.0

package/CHANGELOG.md

@@ -4,7 +4,13 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
-### [4.0.0](https://github.com/eea/volto-tableau/compare/3.0.8...4.0.0) - 13 June 2023
+### [4.1.0](https://github.com/eea/volto-tableau/compare/4.0.0...4.1.0) - 15 June 2023
+
+#### :rocket: New Features
+
+- feat: improved tableau [Miu Razvan - [`4189653`](https://github.com/eea/volto-tableau/commit/41896533c23857cc4ffc9517b042b1066dfe590b)]
+
+## [4.0.0](https://github.com/eea/volto-tableau/compare/3.0.8...4.0.0) - 13 June 2023
 
 #### :house: Internal changes
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eeacms/volto-tableau",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "description": "@eeacms/volto-tableau: Volto add-on",
   "main": "src/index.js",
   "author": "European Environment Agency: IDM2 A-Team",

package/src/Blocks/EmbedTableauVisualization/View.jsx

@@ -10,6 +10,7 @@ import { compose } from 'redux';
 
 const View = (props) => {
   const data = props.data;
+  const { with_sources = true, with_download = true, with_share = true } = data;
   const { data_provenance, tableau_visualization } =
     props.tableau_visualization_data || {};
   const tableau_vis_url = flattenToAppURL(data.tableau_vis_url || '');
@@ -28,7 +29,7 @@ const View = (props) => {
         data={{ ...data, url: tableau_visualization?.url }}
       >
         {!tableau_vis_url && (
-          <div>Please select a visualization from block editor.</div>
+          <div>Please select a tableau visualization from block editor.</div>
         )}
         {!!tableau_vis_url && (
           <>
@@ -37,10 +38,12 @@ const View = (props) => {
             )}
             {!!tableau_visualization?.url && (
               <Tableau
-                data={tableau_visualization}
-                with_sources={true}
-                with_download={true}
-                with_share={true}
+                data={{
+                  ...tableau_visualization,
+                  with_sources,
+                  with_download,
+                  with_share,
+                }}
                 sources={data_provenance.data || []}
               />
             )}

package/src/Blocks/EmbedTableauVisualization/index.js

@@ -20,9 +20,9 @@ export default (config) => {
       view: [],
     },
     breakpoints: {
-      desktop: [Infinity, 982],
-      tablet: [981, 768],
-      mobile: [767, 0],
+      desktop: [Infinity, 992],
+      tablet: [991, 768],
+      phone: [767, 0],
     },
   };
 

package/src/Blocks/EmbedTableauVisualization/schema.js

@@ -68,14 +68,17 @@ export default () => {
       with_download: {
         title: 'Show download button',
         type: 'boolean',
+        defaultValue: true,
       },
       with_share: {
         title: 'Show share button',
         type: 'boolean',
+        defaultValue: true,
       },
       with_sources: {
         title: 'Show sources',
         type: 'boolean',
+        defaultValue: true,
       },
       dataprotection: {
         widget: 'object',

package/src/Blocks/TableauBlock/Edit.jsx

@@ -6,11 +6,20 @@ import getSchema from './schema';
 import View from './View';
 
 const Edit = (props) => {
-  const [schema] = React.useState(getSchema(config));
+  const viz = React.useRef();
+  const [vizState, setVizState] = React.useState({
+    loaded: false,
+    loading: false,
+    error: null,
+  });
+
+  const schema = React.useMemo(() => getSchema(config, viz.current, vizState), [
+    vizState,
+  ]);
 
   return (
     <>
-      <View {...props} mode="edit" />
+      <View {...props} mode="edit" setVizState={setVizState} ref={viz} />
       <SidebarPortal selected={props.selected}>
         <BlockDataForm
           block={props.block}

package/src/Blocks/TableauBlock/View.jsx

@@ -1,64 +1,64 @@
 import React from 'react';
 import { connect } from 'react-redux';
-import { compose } from 'redux';
-import { withRouter } from 'react-router';
 import Tableau from '@eeacms/volto-tableau/Tableau/Tableau';
-import config from '@plone/volto/registry';
 import qs from 'querystring';
+import config from '@plone/volto/registry';
 import '@eeacms/volto-tableau/less/tableau.less';
 
-const getDevice = (config, width) => {
-  const breakpoints = config.blocks.blocksConfig.tableau_block.breakpoints;
-  let device = 'default';
-  Object.keys(breakpoints).forEach((breakpoint) => {
-    if (
-      width <= breakpoints[breakpoint][0] &&
-      width >= breakpoints[breakpoint][1]
-    ) {
-      device = breakpoint;
-    }
-  });
-  return device;
-};
-
-const View = (props) => {
+const View = React.forwardRef((props, ref) => {
+  const viz = React.useRef();
   const [vizState, setVizState] = React.useState({
     loaded: false,
     loading: false,
     error: null,
   });
   const [extraFilters, setExtraFilters] = React.useState({});
-  const { data = {}, query = {}, screen = {} } = props;
+  const { block, data = {}, query = {}, onChangeBlock, mode } = props;
   const {
-    breakpointUrls = [],
     urlParameters = [],
+    staticParameters = [],
     title = null,
     description = null,
-    autoScale = false,
     with_sources = true,
     with_download = true,
     with_share = true,
     sources,
   } = data;
-  const device = getDevice(config, screen.page?.width || Infinity);
-  const breakpointUrl = breakpointUrls.filter(
-    (breakpoint) => breakpoint.device === device,
-  )[0]?.url;
-  const url = breakpointUrl || data.url;
+
+  const extraOptions = React.useMemo(() => {
+    const options = {};
+    staticParameters.forEach((parameter) => {
+      if (parameter.field) {
+        options[parameter.field] = parameter.value;
+      }
+    });
+    return options;
+  }, [staticParameters]);
 
   React.useEffect(() => {
-    const newExtraFilters = { ...extraFilters };
+    const newFilters = { ...extraFilters };
     urlParameters.forEach((element) => {
       if (element.field && typeof query[element.urlParam] !== 'undefined') {
-        newExtraFilters[element.field] = query[element.urlParam];
-      } else if (newExtraFilters[element.field]) {
-        delete newExtraFilters[element.field];
+        newFilters[element.field] = query[element.urlParam];
+      } else if (newFilters[element.field]) {
+        delete newFilters[element.field];
       }
     });
-    setExtraFilters(newExtraFilters);
+    setExtraFilters(newFilters);
     /* eslint-disable-next-line */
   }, [JSON.stringify(query), JSON.stringify(urlParameters)]);
 
+  React.useImperativeHandle(ref, () => {
+    return viz.current;
+  });
+
+  React.useEffect(() => {
+    if (props.setVizState) {
+      props.setVizState(vizState);
+    }
+    /* eslint-disable-next-line */
+  }, [vizState]);
+
   return (
     <div className="tableau-block">
       {vizState.loaded && title ? (
@@ -72,27 +72,30 @@ const View = (props) => {
         ''
       )}
       <Tableau
-        {...props}
-        canUpdateUrl={!breakpointUrl}
-        extraFilters={extraFilters}
-        extraOptions={{ device: autoScale ? 'desktop' : device }}
-        url={url}
-        with_sources={with_sources}
-        with_download={with_download}
-        with_share={with_share}
+        ref={viz}
+        mode={mode}
+        block={block}
+        data={{ ...data, with_sources, with_download, with_share }}
         sources={sources}
+        extraFilters={extraFilters}
+        extraOptions={extraOptions}
+        breakpoints={config.blocks.blocksConfig.tableau_block.breakpoints}
         setVizState={setVizState}
+        onChangeBlock={onChangeBlock}
       />
     </div>
   );
-};
+});
 
-export default compose(
-  connect((state, props) => ({
+export default connect(
+  (state) => ({
     query: {
       ...(qs.parse(state.router.location?.search?.replace('?', '')) || {}),
       ...(state.discodata_query?.search || {}),
     },
     screen: state.screen,
-  })),
-)(withRouter(View));
+  }),
+  null,
+  null,
+  { forwardRef: true },
+)(View);

package/src/Blocks/TableauBlock/index.js

@@ -20,9 +20,9 @@ export default (config) => {
       view: [],
     },
     breakpoints: {
-      desktop: [Infinity, 982],
-      tablet: [981, 768],
-      mobile: [767, 0],
+      desktop: [Infinity, 992],
+      tablet: [991, 768],
+      phone: [767, 0],
     },
   };
 

package/src/Blocks/TableauBlock/schema.js

@@ -1,3 +1,8 @@
+import {
+  getSheetnamesChoices,
+  canChangeVizData,
+} from '@eeacms/volto-tableau/Tableau/helpers';
+
 const urlParametersSchema = {
   title: 'Parameter',
   fieldsets: [
@@ -16,6 +21,22 @@ const urlParametersSchema = {
   required: [],
 };
 
+const staticParameters = {
+  title: 'Parameter',
+  fieldsets: [{ id: 'default', title: 'Default', fields: ['field', 'value'] }],
+  properties: {
+    field: {
+      title: 'Tableau fieldname',
+      type: 'text',
+    },
+    value: {
+      title: 'Value',
+      type: 'text',
+    },
+  },
+  required: [],
+};
+
 const breakpointUrlSchema = (config) => {
   const breakpoints = config.blocks.blocksConfig.tableau_block.breakpoints;
 
@@ -25,7 +46,6 @@ const breakpointUrlSchema = (config) => {
     properties: {
       device: {
         title: 'Device',
-        type: 'array',
         choices: Object.keys(breakpoints).map((breakpoint) => [
           breakpoint,
           breakpoint,
@@ -64,109 +84,141 @@ const sourceSchema = {
   required: [],
 };
 
-export default (config) => ({
-  title: 'Tableau',
-  fieldsets: [
-    {
-      id: 'default',
-      title: 'Default',
-      fields: ['url', 'title', 'description', 'with_download', 'with_share'],
-    },
-    {
-      id: 'sources',
-      title: 'Sources',
-      fields: ['with_sources', 'sources'],
-    },
-    {
-      id: 'options',
-      title: 'Options',
-      fields: [
-        'sheetname',
-        'hideTabs',
-        'hideToolbar',
-        'autoScale',
-        'toolbarPosition',
-      ],
-    },
-    {
-      id: 'extra_options',
-      title: 'Extra options',
-      fields: ['urlParameters', 'breakpointUrls'],
-    },
-  ],
-  properties: {
-    url: {
-      title: 'Url',
-      widget: 'textarea',
-    },
-    title: {
-      title: 'Title',
-      widget: 'textarea',
-    },
-    description: {
-      title: 'Description',
-      widget: 'textarea',
-    },
-    with_download: {
-      title: 'Show download button',
-      type: 'boolean',
-      defaultValue: true,
-    },
-    with_share: {
-      title: 'Show share button',
-      type: 'boolean',
-      defaultValue: true,
-    },
-    with_sources: {
-      title: 'Show sources',
-      type: 'boolean',
-      defaultValue: true,
-    },
-    sources: {
-      title: 'Sources',
-      widget: 'object_list',
-      schema: sourceSchema,
-    },
-    sheetname: {
-      title: 'Sheetname',
-      type: 'text',
-    },
-    hideTabs: {
-      title: 'Hide tabs',
-      type: 'boolean',
-      default: false,
-    },
-    hideToolbar: {
-      title: 'Hide toolbar',
-      type: 'boolean',
-      default: false,
-    },
-    autoScale: {
-      title: 'Auto scale',
-      type: 'boolean',
-      default: false,
-      description: 'Scale down tableau according to width',
-    },
-    toolbarPosition: {
-      title: 'Toolbar position',
-      choices: [
-        ['Top', 'Top'],
-        ['Bottom', 'Bottom'],
-      ],
-      default: 'Top',
-    },
-    urlParameters: {
-      title: 'URL parameters',
-      widget: 'object_list',
-      schema: urlParametersSchema,
-      description: 'Set a list of url parameters to filter the tableau',
-    },
-    breakpointUrls: {
-      title: 'Breakpoint urls',
-      widget: 'object_list',
-      schema: breakpointUrlSchema(config),
-      description: 'Set different vizualization for specific breakpoint',
+export default (config, viz, vizState) => {
+  const isDisabled = !canChangeVizData(viz, vizState);
+
+  return {
+    title: 'Tableau',
+    fieldsets: [
+      {
+        id: 'default',
+        title: 'Default',
+        fields: [
+          'url',
+          'title',
+          'description',
+          'with_sources',
+          'with_download',
+          'with_share',
+        ],
+      },
+      {
+        id: 'options',
+        title: 'Options',
+        fields: [
+          'sheetname',
+          'hideTabs',
+          'hideToolbar',
+          'autoScale',
+          'toolbarPosition',
+        ],
+      },
+      {
+        id: 'extra_options',
+        title: 'Extra options',
+        fields: ['urlParameters', 'staticParameters', 'breakpointUrls'],
+      },
+      {
+        id: 'sources',
+        title: 'Sources',
+        fields: ['sources'],
+      },
+    ],
+    properties: {
+      url: {
+        title: 'Url',
+        widget: 'textarea',
+        isDisabled,
+      },
+      title: {
+        title: 'Title',
+        widget: 'textarea',
+      },
+      description: {
+        title: 'Description',
+        widget: 'textarea',
+      },
+      with_download: {
+        title: 'Show download button',
+        type: 'boolean',
+        defaultValue: true,
+      },
+      with_share: {
+        title: 'Show share button',
+        type: 'boolean',
+        defaultValue: true,
+      },
+      with_sources: {
+        title: 'Show sources',
+        type: 'boolean',
+        defaultValue: true,
+      },
+      sources: {
+        title: 'Sources',
+        widget: 'object_list',
+        schema: sourceSchema,
+      },
+      sheetname: {
+        title: 'Sheetname',
+        choices: getSheetnamesChoices(viz),
+        isDisabled,
+      },
+      hideTabs: {
+        title: 'Hide tabs',
+        type: 'boolean',
+        default: false,
+        isDisabled,
+      },
+      hideToolbar: {
+        title: 'Hide toolbar',
+        type: 'boolean',
+        default: false,
+        isDisabled,
+      },
+      autoScale: {
+        title: 'Auto scale',
+        type: 'boolean',
+        default: false,
+        description: 'Scale down tableau according to width',
+        isDisabled,
+      },
+      toolbarPosition: {
+        title: 'Toolbar position',
+        choices: [
+          ['Top', 'Top'],
+          ['Bottom', 'Bottom'],
+        ],
+        default: 'Top',
+        isDisabled,
+      },
+      urlParameters: {
+        title: 'URL parameters',
+        widget: 'object_list',
+        schema: urlParametersSchema,
+        description: 'Set a list of url parameters to filter the tableau',
+        isDisabled,
+      },
+      staticParameters: {
+        title: 'Static parameters',
+        widget: 'object_list',
+        schema: staticParameters,
+        description: (
+          <>
+            Set a list of static parameters.
+            <br />
+            <b>NOTE: You need to trigger a refresh for this to take effect</b>
+          </>
+        ),
+        isDisabled,
+      },
+      breakpointUrls: {
+        title: 'Breakpoint urls',
+        widget: 'object_list',
+        schema: breakpointUrlSchema(config),
+        description: 'Set different vizualization for specific breakpoint',
+        isDisabled,
+      },
     },
-  },
-  required: ['url'],
-});
+    required: ['url'],
+  };
+};