@datarailsshared/dr_renderer 1.5.107 → 1.5.116

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

@@ -0,0 +1,615 @@
+/**
+ * Pie tooltip options configuration.
+ */
+export type TooltipPieOptions = {
+    /**
+     * - Whether tooltips are shown
+     */
+    show?: boolean | undefined;
+    /**
+     * - Show percentage
+     */
+    show_percentage?: boolean | undefined;
+    /**
+     * - Show value
+     */
+    show_value?: boolean | undefined;
+};
+/**
+ * Suboption definition structure.
+ */
+export type SuboptionDefinition = {
+    /**
+     * - CSS class for the category
+     */
+    category_class: string;
+    /**
+     * - Display label for the category
+     */
+    category_label: string;
+    /**
+     * - Type identifier for the category
+     */
+    category_type: string;
+    /**
+     * - UI elements
+     */
+    elements?: import("./elements").SuboptionElement[] | undefined;
+    /**
+     * - Whether category is hidden in UI
+     */
+    is_hidden?: boolean | undefined;
+    /**
+     * - Default value for simple suboptions
+     */
+    default_value?: any;
+};
+/**
+ * Label options configuration.
+ */
+export type LabelOptions = {
+    /**
+     * - Whether labels are shown
+     */
+    show?: boolean | undefined;
+    /**
+     * - Whether labels can overlap
+     */
+    overlap?: boolean | undefined;
+    /**
+     * - Whether labels are vertical
+     */
+    vertical?: boolean | undefined;
+    /**
+     * - Font family
+     */
+    font_style?: string | undefined;
+    /**
+     * - Font size
+     */
+    font_size?: string | number | undefined;
+    /**
+     * - Font color
+     */
+    font_color?: string | undefined;
+    /**
+     * - Show value in label
+     */
+    show_value?: boolean | undefined;
+    /**
+     * - Show percentage of x-axis
+     */
+    show_out_of_x_axis?: boolean | undefined;
+    /**
+     * - Show percentage of data series
+     */
+    show_out_of_data_series?: boolean | undefined;
+};
+/**
+ * Label pie options configuration.
+ */
+export type LabelPieOptions = {
+    /**
+     * - Whether labels are shown
+     */
+    show?: boolean | undefined;
+    /**
+     * - Whether labels can overlap
+     */
+    overlap?: boolean | undefined;
+    /**
+     * - Use area color for labels
+     */
+    use_area_color?: boolean | undefined;
+    /**
+     * - Font family
+     */
+    font_style?: string | undefined;
+    /**
+     * - Font size
+     */
+    font_size?: string | number | undefined;
+    /**
+     * - Font color
+     */
+    font_color?: string | undefined;
+    /**
+     * - Show value in labels
+     */
+    show_value_in_labels?: boolean | undefined;
+    /**
+     * - Show percentage in labels
+     */
+    show_percentage_in_labels?: boolean | undefined;
+};
+/**
+ * Tooltip options configuration.
+ */
+export type TooltipOptions = {
+    /**
+     * - Whether tooltips are shown
+     */
+    show?: boolean | undefined;
+    /**
+     * - Font family
+     */
+    font_style?: string | undefined;
+    /**
+     * - Font size
+     */
+    font_size?: string | number | undefined;
+    /**
+     * - Font color
+     */
+    font_color?: string | undefined;
+    /**
+     * - Show x-axis value
+     */
+    show_x_axis?: boolean | undefined;
+    /**
+     * - Show data series
+     */
+    show_data_series?: boolean | undefined;
+    /**
+     * - Show value
+     */
+    show_value?: boolean | undefined;
+    /**
+     * - Show percentage of x-axis
+     */
+    show_out_of_x_axis?: boolean | undefined;
+    /**
+     * - Show percentage of data series
+     */
+    show_out_of_data_series?: boolean | undefined;
+};
+/**
+ * Axis options configuration.
+ */
+export type AxisOptions = {
+    /**
+     * - Auto label Y axis
+     */
+    autoylabel?: boolean | undefined;
+    /**
+     * - Auto label X axis
+     */
+    autoxlabel?: boolean | undefined;
+    /**
+     * - Axis label
+     */
+    name?: string | undefined;
+    /**
+     * - Minimum value
+     */
+    min?: number | null | undefined;
+    /**
+     * - Maximum value
+     */
+    max?: number | null | undefined;
+    /**
+     * - Label step interval
+     */
+    label_step?: number | null | undefined;
+    /**
+     * - Enable x-axis zoom
+     */
+    zoom_x?: boolean | undefined;
+};
+/**
+ * Feature flag checker callback.
+ */
+export type FeatureChecker = (featureName: string) => boolean;
+/**
+ * Label gauge configuration options.
+ */
+export type LabelGaugeConfig = {
+    /**
+     * - Feature flag checker function
+     */
+    hasFeature?: FeatureChecker | undefined;
+    /**
+     * - Feature flag name
+     */
+    ENABLE_GAUGE_DYNAMIC_GOAL?: string | undefined;
+};
+/**
+ * Table options configuration.
+ */
+export type TableOptionsConfig = {
+    /**
+     * - Chart types enum
+     */
+    CHART_TYPES?: import("./constants").ChartTypesMap | undefined;
+};
+/**
+ * Gauge segment definition.
+ */
+export type GaugeSegment = {
+    /**
+     * - Start value of segment
+     */
+    from: number;
+    /**
+     * - End value of segment
+     */
+    to: number;
+    /**
+     * - Color of the segment
+     */
+    color: string;
+    /**
+     * - Title of the segment
+     */
+    title: string;
+};
+/**
+ * Gauge segments configuration.
+ */
+export type GaugeSegmentsConfig = {
+    /**
+     * - Default segment values
+     */
+    defaultSegments?: GaugeSegment[] | undefined;
+};
+/**
+ * Disabled condition for standard labels (when no display option is selected).
+ * Used by: withLabel, withLabelWithPercentage, withLabelWithPercentagePercentStacked
+ * @type {{disabled_str: string, disabled_fn: function(LabelOptions): boolean}}
+ */
+export const LABEL_DISABLED_CONDITION: {
+    disabled_str: string;
+    disabled_fn: (arg0: LabelOptions) => boolean;
+};
+/**
+ * Disabled condition for pie chart labels.
+ * @type {{disabled_str: string, disabled_fn: function(LabelPieOptions): boolean}}
+ */
+export const LABEL_PIE_DISABLED_CONDITION: {
+    disabled_str: string;
+    disabled_fn: (arg0: LabelPieOptions) => boolean;
+};
+/**
+ * Disabled condition for standard tooltips (when no display option is selected).
+ * @type {{disabled_str: string, disabled_fn: function(TooltipOptions): boolean}}
+ */
+export const TOOLTIP_DISABLED_CONDITION: {
+    disabled_str: string;
+    disabled_fn: (arg0: TooltipOptions) => boolean;
+};
+/**
+ * Pie tooltip options configuration.
+ * @typedef {Object} TooltipPieOptions
+ * @property {boolean} [show] - Whether tooltips are shown
+ * @property {boolean} [show_percentage] - Show percentage
+ * @property {boolean} [show_value] - Show value
+ */
+/**
+ * Disabled condition for pie chart tooltips.
+ * @type {{disabled_str: string, disabled_fn: function(TooltipPieOptions): boolean}}
+ */
+export const TOOLTIP_PIE_DISABLED_CONDITION: {
+    disabled_str: string;
+    disabled_fn: (arg0: TooltipPieOptions) => boolean;
+};
+/**
+ * Show toggle for standard labels with disabled condition.
+ * @type {import('./elements').SuboptionElement}
+ */
+export const LABEL_SHOW_TOGGLE: import("./elements").SuboptionElement;
+/**
+ * Show toggle for pie labels with disabled condition.
+ * @type {import('./elements').SuboptionElement}
+ */
+export const LABEL_PIE_SHOW_TOGGLE: import("./elements").SuboptionElement;
+/**
+ * Overlap toggle for labels.
+ * @type {import('./elements').SuboptionElement}
+ */
+export const LABEL_OVERLAP_TOGGLE: import("./elements").SuboptionElement;
+/**
+ * Show toggle for standard tooltips with disabled condition.
+ * @type {import('./elements').SuboptionElement}
+ */
+export const TOOLTIP_SHOW_TOGGLE: import("./elements").SuboptionElement;
+/**
+ * Show toggle for pie tooltips with disabled condition.
+ * @type {import('./elements').SuboptionElement}
+ */
+export const TOOLTIP_PIE_SHOW_TOGGLE: import("./elements").SuboptionElement;
+/**
+ * Show toggle for gauge (no disabled condition).
+ * @type {import('./elements').SuboptionElement}
+ */
+export const GAUGE_SHOW_TOGGLE: import("./elements").SuboptionElement;
+/**
+ * Suboption definition structure.
+ * @typedef {Object} SuboptionDefinition
+ * @property {string} category_class - CSS class for the category
+ * @property {string} category_label - Display label for the category
+ * @property {string} category_type - Type identifier for the category
+ * @property {import('./elements').SuboptionElement[]} [elements] - UI elements
+ * @property {boolean} [is_hidden] - Whether category is hidden in UI
+ * @property {*} [default_value] - Default value for simple suboptions
+ */
+/**
+ * Label options configuration.
+ * @typedef {Object} LabelOptions
+ * @property {boolean} [show] - Whether labels are shown
+ * @property {boolean} [overlap] - Whether labels can overlap
+ * @property {boolean} [vertical] - Whether labels are vertical
+ * @property {string} [font_style] - Font family
+ * @property {string|number} [font_size] - Font size
+ * @property {string} [font_color] - Font color
+ * @property {boolean} [show_value] - Show value in label
+ * @property {boolean} [show_out_of_x_axis] - Show percentage of x-axis
+ * @property {boolean} [show_out_of_data_series] - Show percentage of data series
+ */
+/**
+ * Label pie options configuration.
+ * @typedef {Object} LabelPieOptions
+ * @property {boolean} [show] - Whether labels are shown
+ * @property {boolean} [overlap] - Whether labels can overlap
+ * @property {boolean} [use_area_color] - Use area color for labels
+ * @property {string} [font_style] - Font family
+ * @property {string|number} [font_size] - Font size
+ * @property {string} [font_color] - Font color
+ * @property {boolean} [show_value_in_labels] - Show value in labels
+ * @property {boolean} [show_percentage_in_labels] - Show percentage in labels
+ */
+/**
+ * Tooltip options configuration.
+ * @typedef {Object} TooltipOptions
+ * @property {boolean} [show] - Whether tooltips are shown
+ * @property {string} [font_style] - Font family
+ * @property {string|number} [font_size] - Font size
+ * @property {string} [font_color] - Font color
+ * @property {boolean} [show_x_axis] - Show x-axis value
+ * @property {boolean} [show_data_series] - Show data series
+ * @property {boolean} [show_value] - Show value
+ * @property {boolean} [show_out_of_x_axis] - Show percentage of x-axis
+ * @property {boolean} [show_out_of_data_series] - Show percentage of data series
+ */
+/**
+ * Axis options configuration.
+ * @typedef {Object} AxisOptions
+ * @property {boolean} [autoylabel] - Auto label Y axis
+ * @property {boolean} [autoxlabel] - Auto label X axis
+ * @property {string} [name] - Axis label
+ * @property {number|null} [min] - Minimum value
+ * @property {number|null} [max] - Maximum value
+ * @property {number|null} [label_step] - Label step interval
+ * @property {boolean} [zoom_x] - Enable x-axis zoom
+ */
+/**
+ * Creates a base suboption definition.
+ * @param {string} categoryType - The category type identifier
+ * @param {string} categoryLabel - Display label
+ * @param {import('./elements').SuboptionElement[]} elements - UI elements
+ * @param {Object} [options={}] - Additional options
+ * @returns {SuboptionDefinition}
+ */
+export function createSuboption(categoryType: string, categoryLabel: string, elements: import("./elements").SuboptionElement[], options?: Object): SuboptionDefinition;
+/**
+ * Creates a standard label suboption definition.
+ * @returns {SuboptionDefinition}
+ */
+export function withLabel(): SuboptionDefinition;
+/**
+ * Creates a label suboption for pie charts.
+ * @returns {SuboptionDefinition}
+ */
+export function withLabelPie(): SuboptionDefinition;
+/**
+ * Feature flag checker callback.
+ * @callback FeatureChecker
+ * @param {string} featureName - The feature flag name to check
+ * @returns {boolean} Whether the feature is enabled
+ */
+/**
+ * Label gauge configuration options.
+ * @typedef {Object} LabelGaugeConfig
+ * @property {FeatureChecker} [hasFeature] - Feature flag checker function
+ * @property {string} [ENABLE_GAUGE_DYNAMIC_GOAL] - Feature flag name
+ */
+/**
+ * Creates a label suboption for gauge charts.
+ * @param {LabelGaugeConfig} [config={}] - Configuration
+ * @returns {SuboptionDefinition}
+ */
+export function withLabelGauge(config?: LabelGaugeConfig): SuboptionDefinition;
+/**
+ * Creates a label suboption with percentage options for stacked charts.
+ * @returns {SuboptionDefinition}
+ */
+export function withLabelWithPercentage(): SuboptionDefinition;
+/**
+ * Creates a label suboption for percent stacked charts (no total options).
+ * @returns {SuboptionDefinition}
+ */
+export function withLabelWithPercentagePercentStacked(): SuboptionDefinition;
+/**
+ * Creates a standard tooltip suboption definition.
+ * @returns {SuboptionDefinition}
+ */
+export function withTooltip(): SuboptionDefinition;
+/**
+ * Creates a tooltip suboption for pie charts.
+ * @returns {SuboptionDefinition}
+ */
+export function withTooltipPie(): SuboptionDefinition;
+/**
+ * Creates a tooltip suboption for gauge charts.
+ * @returns {SuboptionDefinition}
+ */
+export function withTooltipGauge(): SuboptionDefinition;
+/**
+ * Creates a Y-axis suboption definition.
+ * @returns {SuboptionDefinition}
+ */
+export function withAxisY(): SuboptionDefinition;
+/**
+ * Creates a Y-axis suboption for percent stacked charts (no min/max).
+ * @returns {SuboptionDefinition}
+ */
+export function withAxisYPercentStacked(): SuboptionDefinition;
+/**
+ * Creates an X-axis suboption definition.
+ * @returns {SuboptionDefinition}
+ */
+export function withAxisX(): SuboptionDefinition;
+/**
+ * Table options configuration.
+ * @typedef {Object} TableOptionsConfig
+ * @property {import('./constants').ChartTypesMap} [CHART_TYPES] - Chart types enum
+ */
+/**
+ * Creates a table options suboption definition.
+ * @returns {SuboptionDefinition}
+ */
+export function withTableOptions(): SuboptionDefinition;
+/**
+ * Creates a table options with transpose for certain chart types.
+ * @param {TableOptionsConfig} [config={}] - Configuration
+ * @returns {SuboptionDefinition}
+ */
+export function withTableOptionsTranspose(config?: TableOptionsConfig): SuboptionDefinition;
+/**
+ * Creates table options for gauge charts (simplified).
+ * @returns {SuboptionDefinition}
+ */
+export function withTableOptionsGauge(): SuboptionDefinition;
+/**
+ * Creates table design options suboption.
+ * @returns {SuboptionDefinition}
+ */
+export function withTableDesignOptions(): SuboptionDefinition;
+/**
+ * Creates a chart configuration suboption.
+ * @returns {SuboptionDefinition}
+ */
+export function withChart(): SuboptionDefinition;
+/**
+ * Creates a chart grid configuration suboption.
+ * @returns {SuboptionDefinition}
+ */
+export function withChartGrid(): SuboptionDefinition;
+/**
+ * Creates a chart forecast configuration suboption.
+ * @returns {SuboptionDefinition}
+ */
+export function withChartForecast(): SuboptionDefinition;
+/**
+ * Creates a chart position configuration suboption.
+ * @returns {SuboptionDefinition}
+ */
+export function withChartPosition(): SuboptionDefinition;
+/**
+ * Creates a widget library suboption (hidden).
+ * @returns {SuboptionDefinition}
+ */
+export function withWidgetLibrary(): SuboptionDefinition;
+/**
+ * Creates a subtitle suboption.
+ * @returns {SuboptionDefinition}
+ */
+export function withSubtitle(): SuboptionDefinition;
+/**
+ * Creates a name suboption.
+ * @returns {SuboptionDefinition}
+ */
+export function withName(): SuboptionDefinition;
+/**
+ * Creates a negative number format suboption.
+ * @returns {SuboptionDefinition}
+ */
+export function withNegativeNumberFormat(): SuboptionDefinition;
+/**
+ * Creates a value suboption for KPI widgets.
+ * @returns {SuboptionDefinition}
+ */
+export function withValue(): SuboptionDefinition;
+/**
+ * Creates a range suboption.
+ * @returns {SuboptionDefinition}
+ */
+export function withRange(): SuboptionDefinition;
+/**
+ * Creates a ticks suboption.
+ * @returns {SuboptionDefinition}
+ */
+export function withTicks(): SuboptionDefinition;
+/**
+ * Creates a legends position suboption.
+ * @returns {SuboptionDefinition}
+ */
+export function withLegends(): SuboptionDefinition;
+/**
+ * Creates a delta column (variance) suboption.
+ * @returns {SuboptionDefinition}
+ */
+export function withDeltaColumn(): SuboptionDefinition;
+/**
+ * Creates a delta column for drill down charts.
+ * @returns {SuboptionDefinition}
+ */
+export function withDeltaColumnForDrillDown(): SuboptionDefinition;
+/**
+ * Creates an advanced options suboption.
+ * @returns {SuboptionDefinition}
+ */
+export function withAdvanced(): SuboptionDefinition;
+/**
+ * Creates a total value label suboption for donut charts.
+ * @returns {SuboptionDefinition}
+ */
+export function withTotalValueLabelDonut(): SuboptionDefinition;
+/**
+ * Creates gauge goal suboption (hidden).
+ * @returns {SuboptionDefinition}
+ */
+export function withGaugeGoal(): SuboptionDefinition;
+/**
+ * Gauge segment definition.
+ * @typedef {Object} GaugeSegment
+ * @property {number} from - Start value of segment
+ * @property {number} to - End value of segment
+ * @property {string} color - Color of the segment
+ * @property {string} title - Title of the segment
+ */
+/**
+ * Gauge segments configuration.
+ * @typedef {Object} GaugeSegmentsConfig
+ * @property {GaugeSegment[]} [defaultSegments] - Default segment values
+ */
+/**
+ * Creates gauge segments suboption (hidden).
+ * @param {GaugeSegmentsConfig} [config={}] - Configuration
+ * @returns {SuboptionDefinition}
+ */
+export function withGaugeSegments(config?: GaugeSegmentsConfig): SuboptionDefinition;
+/**
+ * Creates gauge is absolute value suboption (hidden).
+ * @returns {SuboptionDefinition}
+ */
+export function withGaugeIsAbsolute(): SuboptionDefinition;
+/**
+ * Click handler for label value checkboxes.
+ * @param {LabelOptions} value - Current option values
+ */
+export function labelValueClickFn(value: LabelOptions): void;
+/**
+ * Click handler for pie label checkboxes.
+ * @param {LabelPieOptions} value - Current option values
+ */
+export function labelPieClickFn(value: LabelPieOptions): void;
+/**
+ * Click handler for tooltip checkboxes.
+ * @param {TooltipOptions} value - Current option values
+ */
+export function tooltipClickFn(value: TooltipOptions): void;
+/**
+ * Click handler for pie tooltip checkboxes.
+ * @param {TooltipPieOptions} value - Current option values
+ */
+export function tooltipPieClickFn(value: TooltipPieOptions): void;