@datarailsshared/dr_renderer 1.5.131 → 1.5.146

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datarailsshared/dr_renderer",
-  "version": "1.5.131",
+  "version": "1.5.146",
   "description": "DataRails charts and tables renderer",
   "keywords": [
     "datarails",

package/src/charts/dr_gauge_chart.js

@@ -771,7 +771,7 @@ DrGaugeChart.getGoalTitleText = function(options) {
 }
 
 DrGaugeChart.dynamicGoalFeatureEnabled = function() {
-    return DrGaugeChart.highchartsRenderer.hasFeature(helpers.FEATURES.ENABLE_GAUGE_DYNAMIC_GOAL);
+    return DrGaugeChart.highchartsRenderer.environment.enableGaugeDynamicGoal;
 }
 
 module.exports = { DrGaugeChart, GAUGE_OPTIONS_DEFAULT };

package/src/dr-renderer-helpers.js

@@ -70,12 +70,6 @@ function isShowingEmptyValues(additionOptions) {
 }
 
 const DELIMER = ' , '
-const FEATURES = {
-    ENABLE_NEW_WIDGET_VALUE_FORMATTING: 'enable_new_widget_value_formatting',
-    MULTIPLE_DIMENSION_TAGS: 'multiple_dimension_tags',
-    USE_NEW_SCENARIO_TAG: 'use_new_scenario_tag',
-    ENABLE_GAUGE_DYNAMIC_GOAL: 'enable_gauge_dynamic_goal',
-}
 
 module.exports = {
     capitalize,
@@ -85,6 +79,5 @@ module.exports = {
     removeSVGTextCorrection,
     disableLegendInteractionIfRequired,
     isShowingEmptyValues,
-    FEATURES,
     DELIMER
 }

package/src/highcharts_renderer.js

@@ -72,10 +72,11 @@ const CHART_AXIS_DEFAULT_LABEL = 'Axis (Category)';
 
 const CHART_LEGEND_DEFAULT_LABEL = 'Legend (Series)';
 
-const FEATURES = helpers.FEATURES;
-
 const TICKS_COUNT = 5;
 
+/**
+ * @param {EnvironmentOptions} envOptions
+ */
 let getHighchartsRenderer = function ($, document, Highcharts, default_colors, highchartsRenderer,
                                       DataFormatter, lodash, moment_lib, isNewAngular, envOptions) {
 
@@ -116,7 +117,6 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
     DrGaugeChart.highchartsRenderer = highchartsRenderer;
     lodash.assign(highchartsRenderer, HIGHCHARTS_CONSTANTS);
 
-    highchartsRenderer.enabledNewWidgetValueFormatting = false;
     let disableAnimation = false;
     const environment = envOptions || {};
     highchartsRenderer.environment = environment;
@@ -327,14 +327,6 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         };
     };
 
-    highchartsRenderer.hasFeature = function(featureFlagKey) {
-        return lodash.includes(highchartsRenderer.features || [], featureFlagKey);
-    }
-    highchartsRenderer.setFeatures = function(features) {
-        highchartsRenderer.features = features || [];
-        highchartsRenderer.enabledNewWidgetValueFormatting = highchartsRenderer.hasFeature(FEATURES.ENABLE_NEW_WIDGET_VALUE_FORMATTING);
-    }
-    highchartsRenderer.setFeatures(lodash.get(environment, 'features', []));
     disableAnimation = !!lodash.get(environment, 'disable_animation', false);
 
     // fix issue of use tootip.stickOnContact with tooltip.outside , source: https://github.com/highcharts/highcharts/pull/15960
@@ -4006,7 +3998,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                 calculated_formats: calculated_info.formats,
                 isChangeable: false,
                 push: function (record) {
-                    if (highchartsRenderer.enabledNewWidgetValueFormatting) {
+                    if (highchartsRenderer.environment.enabledNewWidgetValueFormatting) {
                         record.formats = highchartsRenderer.getRecordFormats(render_options, record['DR_Values']);
                     }
 
@@ -4175,7 +4167,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                     var val = parseFloat(record[attr]);
 
                     if (!isNaN(val)) {
-                        if (highchartsRenderer.enabledNewWidgetValueFormatting) {
+                        if (highchartsRenderer.environment.enabledNewWidgetValueFormatting) {
                             record.formats = highchartsRenderer.getRecordFormats(render_options, record['DR_Values']);
                         }
 
@@ -4270,7 +4262,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                     var ref, x;
                     x = parseFloat(record[attr]);
                     if (!isNaN(x)) {
-                        if (highchartsRenderer.enabledNewWidgetValueFormatting) {
+                        if (highchartsRenderer.environment.enabledNewWidgetValueFormatting) {
                             record.formats = highchartsRenderer.getRecordFormats(render_options, record['DR_Values']);
                         }
 
@@ -4363,7 +4355,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                     var ref, x;
                     x = parseFloat(record[attr]);
                     if (!isNaN(x)) {
-                        if (highchartsRenderer.enabledNewWidgetValueFormatting) {
+                        if (highchartsRenderer.environment.enabledNewWidgetValueFormatting) {
                             record.formats = highchartsRenderer.getRecordFormats(render_options, record['DR_Values']);
                         }
 
@@ -4457,7 +4449,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                     var ref, x;
                     x = parseFloat(record[attr]);
                     if (!isNaN(x)) {
-                        if (highchartsRenderer.enabledNewWidgetValueFormatting) {
+                        if (highchartsRenderer.environment.enabledNewWidgetValueFormatting) {
                             record.formats = highchartsRenderer.getRecordFormats(render_options, record['DR_Values']);
                         }
 
@@ -5164,7 +5156,6 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         ob.is_calculated = template_field.is_calculated;
         ob.values = [];
         ob.new_name = highchartsRenderer.getFieldName(ob.name);
-        ob.name_class = highchartsRenderer.getFieldColorClass(template_field);
         ob.date_field_before_split = template_field.date_field_before_split;
         ob.mandatory = template_field.mandatory;
         ob.category = template_field.category;
@@ -5185,35 +5176,6 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         return tooltip.length ? tooltip.join('\n\n') : highchartsRenderer.getFieldName(highchartsRenderer.decodeFunc(field.name));
     };
 
-    highchartsRenderer.isSystemField = function (field) {
-        const dynamicSystemFields = [];
-
-        const areMultipleAndScenarioTags = highchartsRenderer.hasFeature(FEATURES.MULTIPLE_DIMENSION_TAGS)
-            && highchartsRenderer.hasFeature(FEATURES.USE_NEW_SCENARIO_TAG);
-
-        if (areMultipleAndScenarioTags) {
-            dynamicSystemFields.push('Scenario', 'Budget Cycle');
-        }
-
-        const regexDelimer = '|';
-        const dynamicSystemFieldsRegex = dynamicSystemFields.length ? dynamicSystemFields.join(regexDelimer) + regexDelimer : '';
-        var regex = new RegExp(`^(${dynamicSystemFieldsRegex}Calc_Model_Name|Calc_Model_ID|Parent_Name|Parent_Id|FileBox_ID|FileBox_Name|DataMapper_Name|Doc_ID|Doc_version|Label|Submission_Date|User|table_id|Latest_In_Dim|Tab_name|CP_Name|DT_.+|VT_.+|System_.+)$`, "m");
-
-        return (field.category && field.category.includes("")) || regex.test(field.name)
-    };
-
-    highchartsRenderer.getFieldColorClass = function (field) {
-        let ret = "green_field"
-        if (highchartsRenderer.isSystemField(field)) {
-            ret = "blue_filed";
-        }
-        if (field.mandatory) {
-            ret += ' mandatoryfieldborder ';
-
-        }
-        return ret;
-    };
-
     highchartsRenderer.decodeTemplates = function (templates) {
         lodash.forEach(templates, function (template) {
             template.name = highchartsRenderer.decodeFunc(template.name);
@@ -6143,8 +6105,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
 
     highchartsRenderer.suboptions = optionsBuilders.createDefaultSuboptions({
         CHART_TYPES: highchartsRenderer.CHART_TYPES,
-        hasFeature: highchartsRenderer.hasFeature,
-        ENABLE_GAUGE_DYNAMIC_GOAL: FEATURES.ENABLE_GAUGE_DYNAMIC_GOAL,
+        enableGaugeDynamicGoal: highchartsRenderer.environment.enableGaugeDynamicGoal,
         defaultGaugeSegments: GAUGE_OPTIONS_DEFAULT.segments,
     });
 
@@ -6404,9 +6365,9 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         [highchartsRenderer.CHART_TYPES.GAUGE_CHART_ENHANCED]: {
             name: 'Gauge chart',
             categoryLabel: 'Gauge',
-            displayLabelInEditor: highchartsRenderer.hasFeature(FEATURES.ENABLE_GAUGE_DYNAMIC_GOAL),
-            label: highchartsRenderer.hasFeature(FEATURES.ENABLE_GAUGE_DYNAMIC_GOAL) ? 'Static goal' : 'Gauge',
-            title: highchartsRenderer.hasFeature(FEATURES.ENABLE_GAUGE_DYNAMIC_GOAL)
+            displayLabelInEditor: highchartsRenderer.environment.enableGaugeDynamicGoal,
+            label: highchartsRenderer.environment.enableGaugeDynamicGoal ? 'Static goal' : 'Gauge',
+            title: highchartsRenderer.environment.enableGaugeDynamicGoal
                 ? 'Measures progress toward a goal or a KPI.'
                 : 'Track actual performance against targets from your budget or forecast files.',
             axisName: 'X-Axis',
@@ -6929,7 +6890,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                             highchartsRenderer.suboptions["gauge_segments"],
                             highchartsRenderer.suboptions["gauge_is_absolute"],
                         ],
-                        hidden: !highchartsRenderer.hasFeature(FEATURES.ENABLE_GAUGE_DYNAMIC_GOAL),
+                        hidden: !highchartsRenderer.environment.enableGaugeDynamicGoal,
                     },
                 ]
             },
@@ -8222,7 +8183,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
     // In all other cases we are applying format from editor panel to both of them (specification: DR-20955)
     highchartsRenderer.isUsingWidgetValuesFormat = function (pivotData, render_options, widget_values_format) {
         const { isSecondaryAxis, isCustomFormat } = highchartsRenderer.checkFormats(render_options, widget_values_format);
-        return !highchartsRenderer.enabledNewWidgetValueFormatting || !highchartsRenderer.isChartWithMultiValues(pivotData) || !isSecondaryAxis || isCustomFormat;
+        return !highchartsRenderer.environment.enabledNewWidgetValueFormatting || !highchartsRenderer.isChartWithMultiValues(pivotData) || !isSecondaryAxis || isCustomFormat;
     }
 
     highchartsRenderer.isFormattingNumberAxis = function (pivotData) {

package/src/index.d.ts

@@ -39,6 +39,12 @@ declare namespace DrRenderFactory {
         fiscal_year_starts_from?: number;
         fiscal_year_back?: boolean;
         enableStackedPercentCharts?: boolean;
+
+        /** TODO: remove in DR-42736 */
+        enabledNewWidgetValueFormatting?: boolean;
+
+        /** Allow specifying custom gauge goal title */
+        enableGaugeDynamicGoal?: boolean;
     }
 
     interface Factory {

package/src/options/builders.js

@@ -56,10 +56,10 @@ const LABEL_PIE_DISABLED_CONDITION = {
  */
 const TOOLTIP_DISABLED_CONDITION = {
     disabled_str: '!{var}.show_out_of_x_axis && !{var}.show_out_of_data_series && !{var}.show_value && !{var}.show_x_axis && !{var}.show_data_series',
-    disabled_fn: (value) => !value.show_out_of_x_axis 
-        && !value.show_out_of_data_series 
-        && !value.show_value 
-        && !value.show_x_axis 
+    disabled_fn: (value) => !value.show_out_of_x_axis
+        && !value.show_out_of_data_series
+        && !value.show_value
+        && !value.show_x_axis
         && !value.show_data_series,
 };
 
@@ -217,8 +217,8 @@ const createSuboption = (categoryType, categoryLabel, elements, options = {}) =>
  * @param {LabelOptions} value - Current option values
  */
 const labelValueClickFn = (value) => {
-    value.show = value.show 
-        ? value.show_out_of_x_axis || value.show_out_of_data_series || value.show_value 
+    value.show = value.show
+        ? value.show_out_of_x_axis || value.show_out_of_data_series || value.show_value
         : value.show;
 };
 
@@ -227,8 +227,8 @@ const labelValueClickFn = (value) => {
  * @param {LabelPieOptions} value - Current option values
  */
 const labelPieClickFn = (value) => {
-    value.show = value.show 
-        ? value.show_percentage_in_labels || value.show_value_in_labels 
+    value.show = value.show
+        ? value.show_percentage_in_labels || value.show_value_in_labels
         : value.show;
 };
 
@@ -247,8 +247,8 @@ const tooltipClickFn = (value) => {
  * @param {TooltipPieOptions} value - Current option values
  */
 const tooltipPieClickFn = (value) => {
-    value.show = value.show 
-        ? value.show_percentage || value.show_value 
+    value.show = value.show
+        ? value.show_percentage || value.show_value
         : value.show;
 };
 
@@ -299,8 +299,7 @@ const withLabelPie = () => createSuboption('label_pie', 'Label', [
 /**
  * Label gauge configuration options.
  * @typedef {Object} LabelGaugeConfig
- * @property {FeatureChecker} [hasFeature] - Feature flag checker function
- * @property {string} [ENABLE_GAUGE_DYNAMIC_GOAL] - Feature flag name
+ * @property {boolean} [enableGaugeDynamicGoal] - Allow specifying custom gauge goal title
  */
 
 /**
@@ -309,8 +308,8 @@ const withLabelPie = () => createSuboption('label_pie', 'Label', [
  * @returns {SuboptionDefinition}
  */
 const withLabelGauge = (config = {}) => {
-    const { hasFeature, ENABLE_GAUGE_DYNAMIC_GOAL } = config;
-    
+    const { enableGaugeDynamicGoal } = config;
+
     return createSuboption('label', 'Label', [
         GAUGE_SHOW_TOGGLE,
         ...createLabelStyleGroup({ fontSize: 16, fontColor: '#333' }),
@@ -320,7 +319,7 @@ const withLabelGauge = (config = {}) => {
         createCheckbox('show_goal_name', 'Show Goal label', true),
         createInput('goal_name', 'Goal name', 'Goal', {
             show_in_one_row: true,
-            showFn: () => !!(hasFeature && ENABLE_GAUGE_DYNAMIC_GOAL && hasFeature(ENABLE_GAUGE_DYNAMIC_GOAL)),
+            showFn: () => !!enableGaugeDynamicGoal,
         }),
     ]);
 };
@@ -491,7 +490,7 @@ const withTableOptions = () => {
  */
 const withTableOptionsTranspose = (config = {}) => {
     const { CHART_TYPES } = config;
-    
+
     return createSuboption('table_options', 'Table', [
         createInput('table_colors_offset', 'Colors offset', 0),
         createCheckbox('show_column_total', 'Column totals', true),
@@ -878,7 +877,7 @@ module.exports = {
     LABEL_PIE_DISABLED_CONDITION,
     TOOLTIP_DISABLED_CONDITION,
     TOOLTIP_PIE_DISABLED_CONDITION,
-    
+
     // Reusable elements
     LABEL_SHOW_TOGGLE,
     LABEL_PIE_SHOW_TOGGLE,
@@ -886,39 +885,39 @@ module.exports = {
     TOOLTIP_SHOW_TOGGLE,
     TOOLTIP_PIE_SHOW_TOGGLE,
     GAUGE_SHOW_TOGGLE,
-    
+
     // Helper
     createSuboption,
-    
+
     // Label builders
     withLabel,
     withLabelPie,
     withLabelGauge,
     withLabelWithPercentage,
     withLabelWithPercentagePercentStacked,
-    
+
     // Tooltip builders
     withTooltip,
     withTooltipPie,
     withTooltipGauge,
-    
+
     // Axis builders
     withAxisY,
     withAxisYPercentStacked,
     withAxisX,
-    
+
     // Table builders
     withTableOptions,
     withTableOptionsTranspose,
     withTableOptionsGauge,
     withTableDesignOptions,
-    
+
     // Chart config builders
     withChart,
     withChartGrid,
     withChartForecast,
     withChartPosition,
-    
+
     // Other builders
     withWidgetLibrary,
     withSubtitle,
@@ -935,7 +934,7 @@ module.exports = {
     withGaugeGoal,
     withGaugeSegments,
     withGaugeIsAbsolute,
-    
+
     // Click handlers (exported for testing)
     labelValueClickFn,
     labelPieClickFn,

package/src/options/index.js

@@ -1,23 +1,23 @@
 /**
  * @fileoverview Chart Options Builder API
- * 
+ *
  * This module provides a functional builder pattern for creating chart suboption
  * configurations. It allows for composable, reusable option definitions with
  * full type support.
- * 
+ *
  * @module @datarailsshared/dr_renderer/options
- * 
+ *
  * @example
  * // Import builders
  * const { withLabel, withTooltip, buildSuboptions } = require('@datarailsshared/dr_renderer').options;
- * 
+ *
  * // Build custom suboptions
  * const suboptions = buildSuboptions([withLabel, withTooltip]);
- * 
+ *
  * @example
  * // Get preset for a chart type
  * const { getPresetForChart, buildSuboptionsForChart } = require('@datarailsshared/dr_renderer').options;
- * 
+ *
  * const columnChartOptions = buildSuboptionsForChart('column-chart');
  */
 
@@ -51,8 +51,7 @@ const helpers = require('./helpers');
  * Configuration for createDefaultSuboptions.
  * @typedef {Object} CreateDefaultSuboptionsConfig
  * @property {import('./constants').ChartTypesMap} [CHART_TYPES] - Chart types enum (for table options)
- * @property {FeatureChecker} [hasFeature] - Feature flag checker function
- * @property {string} [ENABLE_GAUGE_DYNAMIC_GOAL] - Feature flag name for gauge dynamic goal
+ * @property {boolean} [enableGaugeDynamicGoal] - Allow specifying custom gauge goal title
  * @property {import('./builders').GaugeSegment[]} [defaultGaugeSegments] - Default gauge segments array
  */
 
@@ -79,10 +78,7 @@ const createDefaultSuboptions = (config = {}) => ({
     'chart_position': builders.withChartPosition(),
     'label': builders.withLabel(),
     'label_pie': builders.withLabelPie(),
-    'label_gauge': builders.withLabelGauge({ 
-        hasFeature: config.hasFeature, 
-        ENABLE_GAUGE_DYNAMIC_GOAL: config.ENABLE_GAUGE_DYNAMIC_GOAL 
-    }),
+    'label_gauge': builders.withLabelGauge({ enableGaugeDynamicGoal: config.enableGaugeDynamicGoal }),
     'label_with_percentage': builders.withLabelWithPercentage(),
     'label_with_percentage_percent_stacked': builders.withLabelWithPercentagePercentStacked(),
     'axisY': builders.withAxisY(),
@@ -118,7 +114,7 @@ module.exports = {
     LABEL_DEFAULT_OPTIONS: constants.LABEL_DEFAULT_OPTIONS,
     SUBOPTIONS_FONT_SIZE_VALUES: constants.SUBOPTIONS_FONT_SIZE_VALUES,
     DEFAULT_CATEGORY_CLASS: constants.DEFAULT_CATEGORY_CLASS,
-    
+
     // Element factories
     createToggle: elements.createToggle,
     createCheckbox: elements.createCheckbox,
@@ -132,36 +128,36 @@ module.exports = {
     createFontStylingGroup: elements.createFontStylingGroup,
     createLabelStyleGroup: elements.createLabelStyleGroup,
     createTooltipStyleGroup: elements.createTooltipStyleGroup,
-    
+
     // Label builders
     withLabel: builders.withLabel,
     withLabelPie: builders.withLabelPie,
     withLabelGauge: builders.withLabelGauge,
     withLabelWithPercentage: builders.withLabelWithPercentage,
     withLabelWithPercentagePercentStacked: builders.withLabelWithPercentagePercentStacked,
-    
+
     // Tooltip builders
     withTooltip: builders.withTooltip,
     withTooltipPie: builders.withTooltipPie,
     withTooltipGauge: builders.withTooltipGauge,
-    
+
     // Axis builders
     withAxisY: builders.withAxisY,
     withAxisYPercentStacked: builders.withAxisYPercentStacked,
     withAxisX: builders.withAxisX,
-    
+
     // Table builders
     withTableOptions: builders.withTableOptions,
     withTableOptionsTranspose: builders.withTableOptionsTranspose,
     withTableOptionsGauge: builders.withTableOptionsGauge,
     withTableDesignOptions: builders.withTableDesignOptions,
-    
+
     // Chart config builders
     withChart: builders.withChart,
     withChartGrid: builders.withChartGrid,
     withChartForecast: builders.withChartForecast,
     withChartPosition: builders.withChartPosition,
-    
+
     // Other builders
     withWidgetLibrary: builders.withWidgetLibrary,
     withSubtitle: builders.withSubtitle,
@@ -178,16 +174,16 @@ module.exports = {
     withGaugeGoal: builders.withGaugeGoal,
     withGaugeSegments: builders.withGaugeSegments,
     withGaugeIsAbsolute: builders.withGaugeIsAbsolute,
-    
+
     // Helper function
     createSuboption: builders.createSuboption,
-    
+
     // Reusable disabled conditions
     LABEL_DISABLED_CONDITION: builders.LABEL_DISABLED_CONDITION,
     LABEL_PIE_DISABLED_CONDITION: builders.LABEL_PIE_DISABLED_CONDITION,
     TOOLTIP_DISABLED_CONDITION: builders.TOOLTIP_DISABLED_CONDITION,
     TOOLTIP_PIE_DISABLED_CONDITION: builders.TOOLTIP_PIE_DISABLED_CONDITION,
-    
+
     // Reusable elements
     LABEL_SHOW_TOGGLE: builders.LABEL_SHOW_TOGGLE,
     LABEL_PIE_SHOW_TOGGLE: builders.LABEL_PIE_SHOW_TOGGLE,
@@ -195,7 +191,7 @@ module.exports = {
     TOOLTIP_SHOW_TOGGLE: builders.TOOLTIP_SHOW_TOGGLE,
     TOOLTIP_PIE_SHOW_TOGGLE: builders.TOOLTIP_PIE_SHOW_TOGGLE,
     GAUGE_SHOW_TOGGLE: builders.GAUGE_SHOW_TOGGLE,
-    
+
     // Presets and utilities
     CHART_TYPES: constants.CHART_TYPES,
     CHART_PRESETS: presets.CHART_PRESETS,
@@ -206,10 +202,10 @@ module.exports = {
     buildSuboptions: presets.buildSuboptions,
     getChartTypes: presets.getChartTypes,
     hasPreset: presets.hasPreset,
-    
+
     // Helpers
     chartHasVerticalDataLabelsOption: helpers.chartHasVerticalDataLabelsOption,
-    
+
     // Factory functions
     createDefaultSuboptions,
 };