@datarailsshared/dr_renderer 1.5.107 → 1.5.116

package/src/types/options/index.d.ts

@@ -0,0 +1,178 @@
+declare namespace _exports {
+    export { FeatureChecker, CreateDefaultSuboptionsConfig };
+}
+declare namespace _exports {
+    export let CHART_COLORS: {
+        BACKGROUND: string;
+        TEXT: string;
+        LABEL: string;
+        LABEL_SECOND: string;
+        DRILL_UP_FILL: string;
+        DRILL_BUTTON_COLOR_FILL: string;
+        DRILL_BUTTON_COLOR: string;
+        DRILL_BUTTON_COLOR_HOVER: string;
+        PLOT_BORDER: string;
+        MINOR_GRID_LINE: string;
+        TICK_COLOR: string;
+        LABELS_OLD: string;
+        DATA_LABELS: string;
+        CONTRAST_TEXT: string;
+        LEGEND_BACKGROUND: string;
+        MASK: string;
+    };
+    export let SUBOPTIONS_FONTS: string[];
+    export let HIGHCHARTS_FONT_FAMILY: string;
+    export let HIGHCHARTS_FONT_FAMILY_CSS: string;
+    export let TOOLTIP_DEFAULT_SETTINGS: constants.TooltipDefaultSettings;
+    export let TOOLTIP_DEFAULT_OPTIONS: {
+        borderColor: string;
+        shadow: Object;
+        style: Object;
+        enabled: boolean;
+    };
+    export let LABEL_DEFAULT_SETTINGS: constants.LabelDefaultSettings;
+    export let LABEL_DEFAULT_OPTIONS: {
+        style: {
+            fontSize: string;
+            fontFamily: string;
+            fontWeight: string;
+        };
+        color: string;
+    };
+    export let SUBOPTIONS_FONT_SIZE_VALUES: {
+        label: number;
+        value: number;
+    }[];
+    export let DEFAULT_CATEGORY_CLASS: string;
+    export let createToggle: (valueName: string, label: string, defaultValue?: boolean, options?: ToggleElementOptions) => SuboptionElement;
+    export let createCheckbox: (valueName: string, label: string, defaultValue?: boolean, options?: CheckboxElementOptions) => SuboptionElement;
+    export let createInput: (valueName: string, label: string, defaultValue?: string | number | null, options?: InputElementOptions) => SuboptionElement;
+    export let createSelect: (valueName: string, label: string, elementOptions: Array<ElementOption> | string[], defaultValue?: string | number, options?: SelectElementOptions) => SuboptionElement;
+    export let createRadio: (valueName: string, label: string, elementOptions: Array<ElementOption>, defaultValue?: string, options?: RadioElementOptions) => SuboptionElement;
+    export let createColorPicker: (valueName: string, label: string, defaultValue?: string, options?: ColorPickerElementOptions) => SuboptionElement;
+    export let createDivider: (label?: string) => SuboptionElement;
+    export let createTextarea: (valueName: string, label: string, defaultValue?: string, options?: TextareaElementOptions) => SuboptionElement;
+    export let createTag: (valueName: string, label: string, defaultValue?: Array<string | number>, tagOptions?: TagElementOptions, options?: TagAdditionalOptions) => SuboptionElement;
+    export let createFontStylingGroup: (defaults?: FontStylingDefaults) => SuboptionElement[];
+    export let createLabelStyleGroup: (defaults?: FontStylingDefaults) => SuboptionElement[];
+    export let createTooltipStyleGroup: (defaults?: FontStylingDefaults) => SuboptionElement[];
+    export let withLabel: () => SuboptionDefinition;
+    export let withLabelPie: () => SuboptionDefinition;
+    export let withLabelGauge: (config?: LabelGaugeConfig) => SuboptionDefinition;
+    export let withLabelWithPercentage: () => SuboptionDefinition;
+    export let withLabelWithPercentagePercentStacked: () => SuboptionDefinition;
+    export let withTooltip: () => SuboptionDefinition;
+    export let withTooltipPie: () => SuboptionDefinition;
+    export let withTooltipGauge: () => SuboptionDefinition;
+    export let withAxisY: () => SuboptionDefinition;
+    export let withAxisYPercentStacked: () => SuboptionDefinition;
+    export let withAxisX: () => SuboptionDefinition;
+    export let withTableOptions: () => SuboptionDefinition;
+    export let withTableOptionsTranspose: (config?: TableOptionsConfig) => SuboptionDefinition;
+    export let withTableOptionsGauge: () => SuboptionDefinition;
+    export let withTableDesignOptions: () => SuboptionDefinition;
+    export let withChart: () => SuboptionDefinition;
+    export let withChartGrid: () => SuboptionDefinition;
+    export let withChartForecast: () => SuboptionDefinition;
+    export let withChartPosition: () => SuboptionDefinition;
+    export let withWidgetLibrary: () => SuboptionDefinition;
+    export let withSubtitle: () => SuboptionDefinition;
+    export let withName: () => SuboptionDefinition;
+    export let withNegativeNumberFormat: () => SuboptionDefinition;
+    export let withValue: () => SuboptionDefinition;
+    export let withRange: () => SuboptionDefinition;
+    export let withTicks: () => SuboptionDefinition;
+    export let withLegends: () => SuboptionDefinition;
+    export let withDeltaColumn: () => SuboptionDefinition;
+    export let withDeltaColumnForDrillDown: () => SuboptionDefinition;
+    export let withAdvanced: () => SuboptionDefinition;
+    export let withTotalValueLabelDonut: () => SuboptionDefinition;
+    export let withGaugeGoal: () => SuboptionDefinition;
+    export let withGaugeSegments: (config?: GaugeSegmentsConfig) => SuboptionDefinition;
+    export let withGaugeIsAbsolute: () => SuboptionDefinition;
+    export let createSuboption: (categoryType: string, categoryLabel: string, elements: import("./elements").SuboptionElement[], options?: Object) => SuboptionDefinition;
+    export let LABEL_DISABLED_CONDITION: {
+        disabled_str: string;
+        disabled_fn: (arg0: builders.LabelOptions) => boolean;
+    };
+    export let LABEL_PIE_DISABLED_CONDITION: {
+        disabled_str: string;
+        disabled_fn: (arg0: builders.LabelPieOptions) => boolean;
+    };
+    export let TOOLTIP_DISABLED_CONDITION: {
+        disabled_str: string;
+        disabled_fn: (arg0: builders.TooltipOptions) => boolean;
+    };
+    export let TOOLTIP_PIE_DISABLED_CONDITION: {
+        disabled_str: string;
+        disabled_fn: (arg0: builders.TooltipPieOptions) => boolean;
+    };
+    export let LABEL_SHOW_TOGGLE: elements.SuboptionElement;
+    export let LABEL_PIE_SHOW_TOGGLE: elements.SuboptionElement;
+    export let LABEL_OVERLAP_TOGGLE: elements.SuboptionElement;
+    export let TOOLTIP_SHOW_TOGGLE: elements.SuboptionElement;
+    export let TOOLTIP_PIE_SHOW_TOGGLE: elements.SuboptionElement;
+    export let GAUGE_SHOW_TOGGLE: elements.SuboptionElement;
+    export let CHART_TYPES: constants.ChartTypesMap;
+    export let CHART_PRESETS: Record<constants.ChartTypeValue, presets.BuilderFunction[]>;
+    export let BUILDER_KEY_MAP: Map<presets.BuilderFunction, presets.SuboptionKey>;
+    export let getBuilderKey: (builder: BuilderFunction) => SuboptionKey | undefined;
+    export let getPresetForChart: (chartType: import("./constants").ChartTypeValue) => BuilderFunction[] | undefined;
+    export let buildSuboptionsForChart: (chartType: string, config?: BuilderConfig) => Record<string, import("./builders").SuboptionDefinition>;
+    export let buildSuboptions: (builders: BuilderFunction[], config?: BuilderConfig) => Record<string, import("./builders").SuboptionDefinition>;
+    export let getChartTypes: () => import("./constants").ChartTypeValue[];
+    export let hasPreset: (chartType: string) => boolean;
+    export let chartHasVerticalDataLabelsOption: (type: string) => boolean;
+    export { createDefaultSuboptions };
+}
+export = _exports;
+/**
+ * Feature flag checker callback.
+ */
+type FeatureChecker = (featureName: string) => boolean;
+/**
+ * Configuration for createDefaultSuboptions.
+ */
+type CreateDefaultSuboptionsConfig = {
+    /**
+     * - Chart types enum (for table options)
+     */
+    CHART_TYPES?: constants.ChartTypesMap | undefined;
+    /**
+     * - Feature flag checker function
+     */
+    hasFeature?: FeatureChecker | undefined;
+    /**
+     * - Feature flag name for gauge dynamic goal
+     */
+    ENABLE_GAUGE_DYNAMIC_GOAL?: string | undefined;
+    /**
+     * - Default gauge segments array
+     */
+    defaultGaugeSegments?: builders.GaugeSegment[] | undefined;
+};
+import constants = require("./constants");
+import elements = require("./elements");
+import builders = require("./builders");
+import presets = require("./presets");
+/**
+ * Feature flag checker callback.
+ * @callback FeatureChecker
+ * @param {string} featureName - The feature flag name to check
+ * @returns {boolean} Whether the feature is enabled
+ */
+/**
+ * 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 {import('./builders').GaugeSegment[]} [defaultGaugeSegments] - Default gauge segments array
+ */
+/**
+ * Creates the default suboptions object for highchartsRenderer.
+ * This generates the complete suboptions object with all chart options.
+ * @param {CreateDefaultSuboptionsConfig} [config={}] - Configuration options
+ * @returns {Record<string, import('./builders').SuboptionDefinition>} Complete suboptions object
+ */
+declare function createDefaultSuboptions(config?: CreateDefaultSuboptionsConfig): Record<string, import("./builders").SuboptionDefinition>;

package/src/types/options/presets.d.ts

@@ -0,0 +1,98 @@
+/**
+ * Suboption key string literal.
+ */
+export type SuboptionKey = "label" | "label_pie" | "label_gauge" | "label_with_percentage" | "label_with_percentage_percent_stacked" | "tooltips" | "tooltips_pie" | "tooltips_gauge" | "axisY" | "axisY_percent_stacked" | "axisX" | "table_options" | "table_options_transpose" | "table_options_gauge" | "table_design_options" | "chart" | "chart_grid" | "chart_forecast" | "chart_position" | "widget_library" | "subtitle" | "name" | "negative_number_format" | "value" | "range" | "legends" | "delta_column" | "delta_column_for_drill_down" | "advanced" | "total_value_label_donut" | "gauge_goal" | "gauge_segments" | "gauge_is_absolute" | "ticks";
+/**
+ * Builder configuration options passed to builder functions.
+ */
+export type BuilderConfig = {
+    /**
+     * - Chart types enum
+     */
+    CHART_TYPES?: import("./constants").ChartTypesMap | undefined;
+    /**
+     * - Feature flag checker
+     */
+    hasFeature?: ((featureName: string) => boolean) | undefined;
+    /**
+     * - Feature flag name
+     */
+    ENABLE_GAUGE_DYNAMIC_GOAL?: string | undefined;
+    /**
+     * - Default gauge segments
+     */
+    defaultSegments?: import("./builders").GaugeSegment[] | undefined;
+};
+/**
+ * Builder function type.
+ */
+export type BuilderFunction = (config?: BuilderConfig | undefined) => import("./builders").SuboptionDefinition;
+import { CHART_TYPES } from "./constants";
+/**
+ * Chart presets mapping chart types to their suboption builders.
+ * Each preset defines which builders are used for that chart type.
+ * @type {Record<import('./constants').ChartTypeValue, BuilderFunction[]>}
+ */
+export const CHART_PRESETS: Record<import("./constants").ChartTypeValue, BuilderFunction[]>;
+/**
+ * Suboption key string literal.
+ * @typedef {'label'|'label_pie'|'label_gauge'|'label_with_percentage'|'label_with_percentage_percent_stacked'|'tooltips'|'tooltips_pie'|'tooltips_gauge'|'axisY'|'axisY_percent_stacked'|'axisX'|'table_options'|'table_options_transpose'|'table_options_gauge'|'table_design_options'|'chart'|'chart_grid'|'chart_forecast'|'chart_position'|'widget_library'|'subtitle'|'name'|'negative_number_format'|'value'|'range'|'legends'|'delta_column'|'delta_column_for_drill_down'|'advanced'|'total_value_label_donut'|'gauge_goal'|'gauge_segments'|'gauge_is_absolute'|'ticks'} SuboptionKey
+ */
+/**
+ * Maps builder functions to their suboption keys.
+ * Used to build the suboptions object with correct keys.
+ * @type {Map<BuilderFunction, SuboptionKey>}
+ */
+export const BUILDER_KEY_MAP: Map<BuilderFunction, SuboptionKey>;
+/**
+ * Gets the suboption key for a builder function.
+ * @param {BuilderFunction} builder - The builder function
+ * @returns {SuboptionKey|undefined} The suboption key
+ */
+export function getBuilderKey(builder: BuilderFunction): SuboptionKey | undefined;
+/**
+ * Gets the preset configuration for a chart type.
+ * @param {import('./constants').ChartTypeValue} chartType - The chart type identifier
+ * @returns {BuilderFunction[]|undefined} Array of builder functions or undefined if not found
+ */
+export function getPresetForChart(chartType: import("./constants").ChartTypeValue): BuilderFunction[] | undefined;
+/**
+ * Builder configuration options passed to builder functions.
+ * @typedef {Object} BuilderConfig
+ * @property {import('./constants').ChartTypesMap} [CHART_TYPES] - Chart types enum
+ * @property {(featureName: string) => boolean} [hasFeature] - Feature flag checker
+ * @property {string} [ENABLE_GAUGE_DYNAMIC_GOAL] - Feature flag name
+ * @property {import('./builders').GaugeSegment[]} [defaultSegments] - Default gauge segments
+ */
+/**
+ * Builder function type.
+ * @callback BuilderFunction
+ * @param {BuilderConfig} [config] - Configuration options
+ * @returns {import('./builders').SuboptionDefinition} The suboption definition
+ */
+/**
+ * Builds the suboptions object for a chart type using its preset.
+ * @param {string} chartType - The chart type identifier
+ * @param {BuilderConfig} [config={}] - Configuration to pass to builders
+ * @returns {Record<string, import('./builders').SuboptionDefinition>} The suboptions object
+ */
+export function buildSuboptionsForChart(chartType: string, config?: BuilderConfig): Record<string, import("./builders").SuboptionDefinition>;
+/**
+ * Builds a complete suboptions object from an array of builders.
+ * @param {BuilderFunction[]} builders - Array of builder functions
+ * @param {BuilderConfig} [config={}] - Configuration to pass to builders
+ * @returns {Record<string, import('./builders').SuboptionDefinition>} The suboptions object
+ */
+export function buildSuboptions(builders: BuilderFunction[], config?: BuilderConfig): Record<string, import("./builders").SuboptionDefinition>;
+/**
+ * Gets all available chart types.
+ * @returns {import('./constants').ChartTypeValue[]} Array of chart type identifiers
+ */
+export function getChartTypes(): import("./constants").ChartTypeValue[];
+/**
+ * Checks if a chart type has a preset defined.
+ * @param {string} chartType - The chart type identifier
+ * @returns {boolean} True if preset exists
+ */
+export function hasPreset(chartType: string): boolean;
+export { CHART_TYPES };