@synergy-design-system/components
Version:
87 lines (86 loc) • 5.41 kB
TypeScript
import { type ConfigModifier } from '../utilities.js';
import type { AxesUpdateOptions, AxisLabelIconOptions, AxisUpdateOptions } from './types.js';
/**
* Shows horizontal split lines at each y-axis tick.
*
* @param {AxisUpdateOptions} options Preset options.
* @param {number | number[]} [options.axisIndex] Axis index or indices to update. If omitted, applies to the preset default axis selection.
* @see https://echarts.apache.org/en/option.html#yAxis.splitLine
*/
export declare const axesShowYSplitLines: ({ axisIndex }?: AxisUpdateOptions) => ConfigModifier;
/**
* Shows vertical split lines at each x-axis tick.
*
* @param {AxisUpdateOptions} options Preset options.
* @param {number | number[]} [options.axisIndex] Axis index or indices to update. If omitted, applies to the preset default axis selection.
* @see https://echarts.apache.org/en/option.html#xAxis.splitLine
*/
export declare const axesShowXSplitLines: ({ axisIndex }?: AxisUpdateOptions) => ConfigModifier;
/**
* Shows split lines on both xAxis and yAxis.
*
* @param {AxesUpdateOptions} options Preset options.
* @param {number | number[]} [options.xAxisIndex] X-axis index or indices to update. If omitted, applies to the preset default x-axis selection.
* @param {number | number[]} [options.yAxisIndex] Y-axis index or indices to update. If omitted, applies to the preset default y-axis selection.
* @see https://echarts.apache.org/en/option.html#xAxis.axisLine
* @see https://echarts.apache.org/en/option.html#yAxis.axisLine
* @see https://echarts.apache.org/en/option.html#xAxis.splitLine
* @see https://echarts.apache.org/en/option.html#yAxis.splitLine
*/
export declare const axesShowSplitLines: ({ xAxisIndex, yAxisIndex }?: AxesUpdateOptions) => ConfigModifier;
/**
* Hides axis labels on x-axis.
*
* @param {AxisUpdateOptions} options Preset options.
* @param {number | number[]} [options.axisIndex] Axis index or indices to update. If omitted, applies to the preset default axis selection.
* @see https://echarts.apache.org/en/option.html#xAxis.axisLabel
* @see https://echarts.apache.org/en/option.html#xAxis.nameGap
*/
export declare const axesHideXLabels: ({ axisIndex }?: AxisUpdateOptions) => ConfigModifier;
/**
* Hides axis labels on y-axis.
*
* @param {AxisUpdateOptions} options Preset options.
* @param {number | number[]} [options.axisIndex] Axis index or indices to update. If omitted, applies to the preset default axis selection.
* @see https://echarts.apache.org/en/option.html#yAxis.axisLabel
* @see https://echarts.apache.org/en/option.html#yAxis.nameTextStyle
*/
export declare const axesHideYLabels: ({ axisIndex }?: AxisUpdateOptions) => ConfigModifier;
/**
* Hides axis labels on x-axis and y-axis.
*
* @param {AxesUpdateOptions} options Preset options.
* @param {number | number[]} [options.xAxisIndex] X-axis index or indices to update. If omitted, applies to the preset default x-axis selection.
* @param {number | number[]} [options.yAxisIndex] Y-axis index or indices to update. If omitted, applies to the preset default y-axis selection.
*/
export declare const axesHideLabels: ({ xAxisIndex, yAxisIndex }?: AxesUpdateOptions) => ConfigModifier;
/**
* Adds icons to x-axis labels.
*
* @param {AxisLabelIconOptions<'xAxis'>} options Preset options.
* @param {string[]} options.iconUrls SVG data URLs applied to labels in label order.
* @param {number | number[]} [options.axisIndex] Axis index or indices to update. If omitted, applies to the preset default axis selection.
* @param {'top' | 'bottom'} [options.iconPosition] Position of the icon relative to labels. Defaults to `'top'`.
* @param {string} [options.iconColor] Icon color. Should be a valid CSS color string (e.g. `#ff0000`, `rgb(255, 0, 0)`, `red`). Uses a Synergy default when omitted.
* @param {AxisLabelRich} [options.iconsStyle] Rich style object applied to all icons.
* @param {AxisLabelRich} [options.labelsStyle] Rich style object applied to all labels.
* @see https://echarts.apache.org/en/option.html#xAxis.axisLabel
* @see https://echarts.apache.org/en/option.html#xAxis.axisLabel.rich
* @see https://echarts.apache.org/en/option.html#xAxis.axisLabel.formatter
*/
export declare const axesAddXLabelIcons: (options: AxisLabelIconOptions<"xAxis">) => ConfigModifier;
/**
* Adds icons to y-axis labels.
*
* @param {AxisLabelIconOptions<'yAxis'>} options Preset options.
* @param {string[]} options.iconUrls SVG data URLs applied to labels in label order.
* @param {number | number[]} [options.axisIndex] Axis index or indices to update. If omitted, applies to the preset default axis selection.
* @param {'left' | 'right'} [options.iconPosition] Position of the icon relative to labels. Defaults to `'left'`.
* @param {string} [options.iconColor] Icon color. Should be a valid CSS color string (e.g. `#ff0000`, `rgb(255, 0, 0)`, `red`). Uses a Synergy default when omitted.
* @param {AxisLabelRich} [options.iconsStyle] Rich style object applied to all icons.
* @param {AxisLabelRich} [options.labelsStyle] Rich style object applied to all labels.
* @see https://echarts.apache.org/en/option.html#yAxis.axisLabel
* @see https://echarts.apache.org/en/option.html#yAxis.axisLabel.rich
* @see https://echarts.apache.org/en/option.html#yAxis.axisLabel.formatter
*/
export declare const axesAddYLabelIcons: (options: AxisLabelIconOptions<"yAxis">) => ConfigModifier;