adjusting dashEnableCharts -> dashChartMode

Author: BSd3v

src/lib/components/AgGrid.react.js

@@ -66,42 +66,35 @@ function DashAgGrid(props) {
 
     const {
         enableEnterpriseModules,
-        dashEnableCharts,
+        dashChartMode,
         dashGridOptions = {},
     } = props;
-    const normalizedDashEnableCharts =
-        typeof dashEnableCharts === 'undefined' || dashEnableCharts === null
+    const normalizedDashChartMode =
+        typeof dashChartMode === 'undefined' || dashChartMode === null
             ? false
-            : dashEnableCharts;
+            : dashChartMode;
     const hasConflictingEnableChartsSetting =
-        normalizedDashEnableCharts && dashGridOptions.enableCharts === false;
-    const gridDashOptions = normalizedDashEnableCharts
+        normalizedDashChartMode && dashGridOptions.enableCharts === false;
+    const gridDashOptions = normalizedDashChartMode
         ? {...dashGridOptions, enableCharts: true}
         : dashGridOptions;
     const hasEnableCharts = gridDashOptions?.enableCharts;
 
-    if (normalizedDashEnableCharts && !enableEnterpriseModules) {
+    if (normalizedDashChartMode && !enableEnterpriseModules) {
         throw new Error(
-            'dashEnableCharts is only supported when enableEnterpriseModules is true.'
+            'dashChartMode is only supported when enableEnterpriseModules is true.'
         );
     }
 
-    if (
-        normalizedDashEnableCharts &&
-        normalizedDashEnableCharts !== 'enterprise'
-    ) {
-        throw new Error("dashEnableCharts must be set to 'enterprise'.");
-    }
-
     if (hasConflictingEnableChartsSetting) {
         throw new Error(
-            'dashEnableCharts cannot be combined with dashGridOptions.enableCharts=false.'
+            'dashChartMode cannot be combined with dashGridOptions.enableCharts=false.'
         );
     }
 
-    if (hasEnableCharts && !normalizedDashEnableCharts) {
+    if (hasEnableCharts && !normalizedDashChartMode) {
         throw new Error(
-            "enableCharts is set, but chart modules are not loaded. Set enableEnterpriseModules=true and dashEnableCharts='enterprise'."
+            "enableCharts is set, but chart modules are not loaded. Set enableEnterpriseModules=true and dashChartMode='community' or 'enterprise'."
         );
     }
 
@@ -540,7 +533,7 @@ DashAgGrid.propTypes = {
     licenseKey: PropTypes.string,
 
     /**
-     * License key for AG Charts Enterprise when dashEnableCharts is "enterprise".
+     * License key for AG Charts Enterprise when dashChartMode is "enterprise".
      * If not provided, licenseKey is used.
      */
     chartsLicenseKey: PropTypes.string,
@@ -552,9 +545,9 @@ DashAgGrid.propTypes = {
 
     /**
      * Load enterprise AG Charts modules for integrated charts.
-     * Set to "enterprise" to load enterprise chart modules and set dashGridOptions.enableCharts=true.
+     * Set to "enterprise" to load enterprise chart modules or use "community" for community chart modules and set dashGridOptions.enableCharts=true.
      */
-    dashEnableCharts: PropTypes.oneOf(['enterprise']),
+    dashChartMode: PropTypes.oneOf(['enterprise', 'community']),
 
     /**
      * The rowData in the grid after inline filters are applied.

src/lib/fragments/AgGridEnterprise.react.js

@@ -6,6 +6,7 @@ import {
     LicenseManager,
     SparklinesModule,
 } from 'ag-grid-enterprise';
+import {AgChartsCommunityModule} from 'ag-charts-community';
 import {
     AgChartsEnterpriseModule,
     LicenseManager as AgChartsLicenseManager,
@@ -19,18 +20,24 @@ ModuleRegistry.registerModules([
 ]);
 
 export default function DashAgGridEnterprise(props) {
-    const {licenseKey, chartsLicenseKey, dashEnableCharts} = props;
+    const {licenseKey, chartsLicenseKey, dashChartMode} = props;
     if (licenseKey) {
         LicenseManager.setLicenseKey(licenseKey);
     }
-    if (dashEnableCharts) {
-        const effectiveChartsLicenseKey = chartsLicenseKey || licenseKey;
-        if (effectiveChartsLicenseKey) {
-            AgChartsLicenseManager.setLicenseKey(effectiveChartsLicenseKey);
+    if (dashChartMode) {
+        if (dashChartMode === 'enterprise') {
+            const effectiveChartsLicenseKey = chartsLicenseKey || licenseKey;
+            if (effectiveChartsLicenseKey) {
+                AgChartsLicenseManager.setLicenseKey(effectiveChartsLicenseKey);
+            }
+            ModuleRegistry.registerModules([
+                IntegratedChartsModule.with(AgChartsEnterpriseModule),
+            ]);
+        } else {
+            ModuleRegistry.registerModules([
+                IntegratedChartsModule.with(AgChartsCommunityModule),
+            ]);
         }
-        ModuleRegistry.registerModules([
-            IntegratedChartsModule.with(AgChartsEnterpriseModule),
-        ]);
     }
     return <MemoizedAgGrid {...props} />;
 }

src/lib/utils/propCategories.js

@@ -343,7 +343,7 @@ export const PROPS_NOT_FOR_AG_GRID = [
     'setProps',
     'loading_state',
     'enableEnterpriseModules',
-    'dashEnableCharts',
+    'dashChartMode',
     'parentState',
     'persistence',
     'persisted_props',

tests/test_charts.py

@@ -39,7 +39,7 @@ def _make_basic_grid(**extra_props):
 def test_charts001_enables_enterprise_charts_modules_with_true(dash_duo):
     app = Dash(__name__)
     app.layout = html.Div(
-        _make_chart_grid(enableEnterpriseModules=True, dashEnableCharts="enterprise")
+        _make_chart_grid(enableEnterpriseModules=True, dashChartMode="enterprise")
     )
 
     dash_duo.start_server(app)
@@ -58,7 +58,7 @@ def test_charts002_enables_enterprise_charts_modules(dash_duo):
     app.layout = html.Div(
         _make_chart_grid(
             enableEnterpriseModules=True,
-            dashEnableCharts="enterprise",
+            dashChartMode="enterprise",
         )
     )
 
@@ -85,13 +85,13 @@ def test_charts003_keeps_enterprise_grid_without_charts(dash_duo):
 
 def test_charts004_rejects_charts_on_community_grid(dash_duo):
     app = Dash(__name__)
-    app.layout = html.Div(_make_chart_grid(dashEnableCharts="enterprise"))
+    app.layout = html.Div(_make_chart_grid(dashChartMode="enterprise"))
 
     dash_duo.start_server(app)
     until(lambda: dash_duo.find_element('#loaded').text == 'true', 10)
 
     assert any(
-        "dashEnableCharts is only supported when enableEnterpriseModules is true."
+        "dashChartMode is only supported when enableEnterpriseModules is true."
         in entry.get("message", "")
         for entry in dash_duo.get_logs()
     )
@@ -118,7 +118,7 @@ def test_charts006_rejects_conflicting_enablecharts_false(dash_duo):
     app.layout = html.Div(
         _make_chart_grid(
             enableEnterpriseModules=True,
-            dashEnableCharts="enterprise",
+            dashChartMode="enterprise",
             dashGridOptions={"enableCharts": False},
         )
     )
@@ -127,7 +127,7 @@ def test_charts006_rejects_conflicting_enablecharts_false(dash_duo):
     until(lambda: dash_duo.find_element('#loaded').text == 'true', 10)
 
     assert any(
-        "dashEnableCharts cannot be combined with dashGridOptions.enableCharts=false."
+        "dashChartMode cannot be combined with dashGridOptions.enableCharts=false."
         in entry.get("message", "")
         for entry in dash_duo.get_logs()
     )
@@ -138,7 +138,7 @@ def test_charts007_accepts_charts_license_key_prop(dash_duo):
     app.layout = html.Div(
         _make_chart_grid(
             enableEnterpriseModules=True,
-            dashEnableCharts="enterprise",
+            dashChartMode="enterprise",
             licenseKey="grid-key",
             chartsLicenseKey="charts-key",
         )