import React from 'react'; import { Legend, ScaleConfig, SeriesConfig, EventAnnotation, EventAnnotationRendererProps } from '@splunk/visualization-canvas'; import type { LegendTruncation } from '@splunk/visualization-canvas'; import type { JsonColumnData } from './interfaces/DataSource'; interface ChartOptions { [key: string]: any; } interface TransformAxisChartOptionsParams { originalOptions: Record; optionsSchema: Record; chart: string; convertToSCProps: (options: Record) => Record; preservedProps: string[]; } interface Y2ScaleConfigOptions { axisScale?: 'linear' | 'log'; roundAxisLabelsToInteger?: boolean; y2AxisLabelVisibility?: AxisLabelVisibility; y2AxisMin?: number; y2AxisMax?: number; preserveAutoBoundAsNull?: boolean; } export declare const SHARED_AXIS_CHART_CANVAS_SPECIFIC_PROPS: string[]; export declare const transformAxisChartOptions: ({ originalOptions, optionsSchema, chart, convertToSCProps, preservedProps, }: TransformAxisChartOptionsParams) => Record; export declare const DEFAULT_LINE_WIDTH = 2; export declare const DEFAULT_COLUMN_BORDER_WIDTH = 1; /** * Get formatted annotations - highcharts expects annotations in a specific format * @method getAnnotations * @param {Object} options * @param {Array} options.annotationX * @param {Array} options.annotationColor * @param {Array} options.annotationLabel * @returns {Array} */ export declare const getAnnotations: ({ annotationX, annotationColor, annotationLabel }: { annotationX: any; annotationColor: any; annotationLabel: any; }) => any; /** * Get formatted annotations for canvas - viz-canvas timeseries expects annotations in a specific format * @method getAnnotationsForCanvas * @param {Object} options * @param {Array} options.annotationX * @param {Array} options.annotationColor * @param {Array} options.annotationLabel * @returns {Array} */ export declare const getAnnotationsForCanvas: ({ annotationX, annotationColor, annotationLabel, }: { annotationX: any; annotationColor: any; annotationLabel: any; }) => EventAnnotation[]; /** * Custom event annotation renderer using Triangle icon from @splunk/react-icons * @method triangleEventAnnotationRenderer * @param {EventAnnotationRendererProps} props * @returns {ReactElement} */ export declare const triangleEventAnnotationRenderer: React.FC; /** * Truncate the result set to given limit * @method truncateData * @param {Object} dataSet - dataSources.primary.data * @param {Number|String} truncationLimit - options['chart.resultTruncationLimit'] * @returns {Object} */ export declare const truncateData: (dataSet: any, truncationLimit: any) => Record; /** * Helper method to update the option values into the values that SC accepts * @method mapToValues * @param {Object} options * @returns {Object} */ export declare const mapToValues: (optionValuesSCMapping: Record) => (options: any) => Record; interface Y2AxisOptions extends ChartOptions { y2Fields?: string | string[]; } /** * Helper method to process options related to y2Fields * @method convertY2AxisOptions * @param {Object} originalOptions * @returns {Object} */ export declare const convertY2AxisOptions: ({ y2Fields, ...originalOptions }: Y2AxisOptions) => Record; /** * Helper method to format value for overlayFields * @method convertOverlayFields * @param {Object} originalOptions * @returns {Object} */ export declare const convertOverlayFields: (originalOptions: ChartOptions) => ChartOptions; /** * checks whether data is multi series data * @param {array} data array * @return {Boolean} */ export declare const isMultiSeriesData: (data: string[] | string[][]) => boolean; /** * checks whether data is multi series data and returns value as array * @param {array} data array * @param {*} value to return as array * @return {array} */ export declare const toArrayForSeries: (data: any, value: any) => any[]; interface ConstructFieldsAndColumnsParams { x: string[]; y: string[] | string[][]; xField: string; yFields: string | string[]; y2?: string[] | string[][]; y2Fields?: string | string[]; } export declare const constructFieldsAndColumns: ({ x, y, xField, yFields, y2, y2Fields, }: ConstructFieldsAndColumnsParams) => JsonColumnData; export declare function constructAdditionalTooltipFieldsMap({ fields, columns, additionalTooltipFields }: { fields: any; columns: any; additionalTooltipFields: any; }): {}; /** * Extracts additional tooltip values from columns and fields into an array of objects. * Each object in the array represents the values at a specific data point index. * This follows the same pattern used by Timeline visualization. * * @param columns - Array of column data * @param fields - Array of field definitions with name property * @param additionalTooltipFields - Array of field names to extract * @returns Array of objects, where each object maps field names to values at that index */ type TooltipFieldRecord = Record; export declare function extractAdditionalTooltipValues(columns: (string | number | null)[][], fields: { name: string; }[], additionalTooltipFields: string[]): TooltipFieldRecord[]; export type AdditionalTooltipResult = TooltipFieldRecord[]; export declare const areStringArraysEqual: (a: string[] | undefined, b: string[] | undefined) => boolean; export declare const createAdditionalTooltipValuesMemoizer: () => (columns: (string | number | null)[][], fields: { name: string; }[], additionalTooltipFields: string[] | undefined) => AdditionalTooltipResult | undefined; interface OptionsProps { events?: string[]; selectedItemId?: string; [key: string]: unknown; } interface EventHandler { type: string; options: OptionsProps; } export declare const shouldEnableSearchZoom: (eventHandlers?: EventHandler[], xField?: string) => boolean; export declare const isTimeSeriesCanvasRenderSupported: (vizConfigKey: string) => boolean; type ChartData = { fields: (string | { name: string; })[]; columns: (string | number)[][]; }; export declare const filterChartDataFromInternalFields: (chartData: ChartData) => ChartData; export declare const isTimeField: (field: any) => boolean; export declare const convert2DArrayToNumbers: (arr: any) => any; export declare const convertTimeStringToUnix: (arr: any) => any; /** * Parses an axis value that may be 'auto', null, undefined, empty string, or a numeric value. * Returns undefined for non-numeric values, allowing the renderer to auto-calculate the range. * @param {any} val - The value to parse (string, number, null, undefined) * @returns {number | undefined} - Parsed number or undefined */ export declare const parseAxisValue: (val: any) => number | undefined; /** * Parses X-axis line visibility option from string to boolean or undefined. * @param {string | undefined} visibility - The visibility option ('hide', 'show', or other) * @returns {boolean | undefined} - false for 'hide', true for 'show', undefined otherwise */ export declare const parseXAxisLineVisibility: (visibility?: string) => boolean | undefined; export declare const getLegend: (props: { legendDisplay: string; isSeriesCompare: boolean; legendTruncation?: LegendTruncation; }) => Legend | false; export declare const getComputedAxisTitles: (inputAxisTitle: string, fields: string[], axisTitleVisibility: "show" | "collapsed") => string; /** * Truncates Y-axis title based on available container height and font metrics * @param axisTitle - The title text to potentially truncate * @param containerSpacing - Available height/ width in pixels depending on axis orientation * @param fontSize - Font size in pixels (default: 12) * @returns Truncated title with ellipsis if needed */ export declare const ellipsisAxisTitle: (axisTitle: string, containerSpacing: number, fontSize?: number) => string; export type FieldObject = { name: string; }; export declare const getFieldName: (field: string | FieldObject) => string; export declare const getFieldNames: (fields: (string | FieldObject)[]) => string[]; /** * Type alias for axis label visibility options */ export type AxisLabelVisibility = 'hide' | 'show' | 'auto'; /** * Returns X scale config for viz-canvas charts * @param label * @param xAxisLabelVisibility * @returns */ export declare const getXScaleConfig: (label: string, xAxisLabelVisibility?: AxisLabelVisibility, xAxisLabelRotation?: -90 | -45 | 0 | 45 | 90) => ScaleConfig; /** * Returns Y scale config for viz-canvas charts * @param label * @param yAxisAbbreviation * @param yAxisScale * @param yAxisLabelVisibility * @param yAxisMin * @param yAxisMax * @returns */ export declare const getYScaleConfig: (label: string, yAxisAbbreviation: string, yAxisScale?: "linear" | "log", yAxisLabelVisibility?: AxisLabelVisibility, yAxisMin?: number, yAxisMax?: number, preserveAutoBoundAsNull?: boolean) => ScaleConfig; /** * Returns Y2 scale config for viz-canvas charts * @param label * @param axisAbbreviation * @param options * @param options.axisScale * @param options.roundAxisLabelsToInteger * @param options.y2AxisLabelVisibility * @param options.y2AxisMin * @param options.y2AxisMax * @param options.preserveAutoBoundAsNull * @returns */ export declare const getY2ScaleConfig: (label: string, axisAbbreviation: string, { axisScale, roundAxisLabelsToInteger, y2AxisLabelVisibility, y2AxisMin, y2AxisMax, preserveAutoBoundAsNull, }?: Y2ScaleConfigOptions) => ScaleConfig; /** Step interpolation position for line/area series. */ type StepPosition = 'off' | 'before' | 'after'; export declare const getSeriesOverrides: (opts: { yfields: string[]; y2fields?: string[]; lineWidth?: number; overlayFields?: string[]; y2Enabled?: boolean; nullValueMode?: "gaps" | "connect" | "zero"; markerDisplay?: "off" | "filled" | "outlined"; lineDashStyle?: string; lineDashStylesByField?: Record; stepPosition?: StepPosition; stepPositionsByField?: Record; type?: "line" | "area" | "column"; stackMode?: "auto" | "stacked" | "stacked100"; showLines?: boolean; }) => SeriesConfig; /** * Finds the start and end indices in time series data for a given range. * @param xData - Array of time values (can be ISO strings or epoch timestamps) * @param startValue - Start value of the range (epoch timestamp) * @param endValue - End value of the range (epoch timestamp) * @returns Object with startXIndex (first index where time >= startValue) and endXIndex (last index where time <= endValue) */ export declare const findRangeIndices: (xData: (string | number)[], startValue: number, endValue: number) => { startXIndex: number; endXIndex: number; }; export {}; //# sourceMappingURL=chartingUtils.d.ts.map