mdt-client 31.3.38 → 31.3.39

package/types/_core/scripts/views/page/charts/ChartControlOptions.schema.d.ts

@@ -1,759 +0,0 @@
-declare type MdtChartsDataRow = Record<string, any>;
-declare type TitleFunctionParams = {
-    data: MdtChartsDataRow[];
-};
-declare type TitleFunction = (params: TitleFunctionParams) => string;
-declare type Title = string | TitleFunction;
-export declare type Orientation = "horizontal" | "vertical";
-declare type ChartElementPosition = "start" | "end";
-export declare type AxisLabelPosition = "vertical" | "horizontal";
-export declare type TwoDimChartLegendPosition = "top" | "bottom";
-declare type ChartField = string;
-export declare type ChartFieldWithTitle = {
-    title?: string;
-    name: string;
-};
-export declare type TwoDimensionalValueField = ChartField | (ChartFieldWithTitle & {
-    color?: string;
-});
-/**
- * @defaultSnippets
- * [
- *   {
- * 		"label": "Вертикальная гистограмма (bar)",
- * 		"body": {
- * 			"title": "$1",
- * 			"type": "2d",
- * 			"keyField": "$2",
- * 			"charts": [
- * 				{
- * 					"type": "bar",
- * 					"data": {
- * 						"valueFields": [
- * 							"$3"
- * 						]
- * 					}
- * 				}
- * 			]
- * 		}
- * 	 },
- * 	 {
- * 		"label": "Вертикальная линейная диаграмма (line)",
- * 		"body": {
- * 			"title": "$1",
- * 			"type": "2d",
- * 			"keyField": "$2",
- * 			"charts": [
- * 				{
- * 					"type": "line",
- * 					"data": {
- * 						"valueFields": [
- * 							"$3"
- * 						]
- * 					}
- * 				}
- * 			]
- * 		}
- * 	 },
- *   {
- * 		"label": "Вертикальная диаграмма с областями (area)",
- * 		"body": {
- * 			"title": "$1",
- * 			"type": "2d",
- * 			"keyField": "$2",
- * 			"charts": [
- * 				{
- * 					"type": "area",
- * 					"data": {
- * 						"valueFields": [
- * 							"$3"
- * 						]
- * 					}
- * 				}
- * 			]
- * 		}
- * 	 },
- *   {
- * 		"label": "Горизонтальная гистограмма (bar)",
- * 		"body": {
- * 			"title": "$1",
- * 			"type": "2d",
- * 			"keyField": "$2",
- * 			"axes": {
- * 				"orientation": "horizontal"
- * 			},
- * 			"charts": [
- * 				{
- * 					"type": "bar",
- * 					"data": {
- * 						"valueFields": [
- * 							"$3"
- * 						]
- * 					}
- * 				}
- * 			]
- * 		}
- * 	 },
- *   {
- * 		"label": "Кольцевая диаграмма (donut)",
- * 		"body": {
- * 			"title": "$1",
- * 			"type": "polar",
- * 			"keyField": "$2",
- * 			"chart": {
- * 				"valueField": "$3"
- * 			}
- * 		}
- * 	 }
- * ]
- */
-export declare type ChartControlOptions = TwoDimensionalOptions | PolarOptions | CardChartPublicOptions;
-/**
- * @defaultSnippets
- * [
- *   {
- * 		"label": "Вертикальная ориентация, ось ключей снизу, ось значений слева",
- * 		"body": {
- * 			"orientation": "vertical",
- * 			"key": {
- * 				"position": "end"
- * 			},
- * 			"value": {
- * 				"position": "start"
- * 			}
- * 		}
- * 	 },
- *   {
- * 		"label": "Вертикальная ориентация, ось ключей сверху, ось значений слева",
- * 		"body": {
- * 			"orientation": "vertical",
- * 			"key": {
- * 				"position": "start"
- * 			},
- * 			"value": {
- * 				"position": "start"
- * 			}
- * 		}
- * 	 },
- *   {
- * 		"label": "Горизонтальная ориентация, ось ключей слева, ось значений снизу",
- * 		"body": {
- * 			"orientation": "horizontal",
- * 			"key": {
- * 				"position": "start"
- * 			},
- * 			"value": {
- * 				"position": "start"
- * 			}
- * 		}
- * 	 },
- *   {
- * 		"label": "Горизонтальная ориентация, ось ключей справа, ось значений снизу",
- * 		"body": {
- * 			"orientation": "horizontal",
- * 			"key": {
- * 				"position": "end"
- * 			},
- * 			"value": {
- * 				"position": "end"
- * 			}
- * 		}
- * 	 }
- * ]
- */
-export interface Axes {
-    /**
-     * @title Ориентация диаграмм
-     * @description При вертикальной ориентации ось ключей будет расположена сверху или снизу.
-     * При горизонтальной ориентации ось ключей будет расположена слева или справа.
-     * По умолчанию вертикальная.
-     */
-    orientation?: Orientation;
-    /** @title Общая настройка подписей осей */
-    labels?: BaseAxesLabelsOptions;
-    /**
-     * @title Параметры оси ключей
-     */
-    key?: {
-        /**
-         * @title Позиция оси ключей
-         * @description По умолчанию равна "end", если диаграмма вертикальная и "start" - если диаграмма горизонтальная
-         */
-        position?: ChartElementPosition;
-        /**
-         * @title Отображение оси
-         * @description По умолчанию всегда отображается
-         */
-        visible?: boolean;
-        /**
-         * @title Отображение линий сетки оси
-         * @description По умолчанию всегда скрывается
-         */
-        gridLine?: boolean;
-        /**
-         * @title Настройка подписей оси
-         */
-        labels?: {
-            /**
-             * @title Настройки позиции оси
-             * @description Настраивается при вертикальном расположении. По умолчанию позиция определяется по количеству свободного места для одной подписи.
-             */
-            position?: AxisLabelPosition;
-            /**
-             * @title Количество места, выделенного для подписи в px
-             * @default 20
-             */
-            space?: number;
-            /**
-             * @title Функция форматирования подписи
-             * @param options Параметры для форматирования подписи. В поле `key` хранится значение поля оси ключей, в поле `dataRow` - строка с данными для данного ключа.
-             * @returns Строка с форматированной подписью
-             */
-            format?: (options: {
-                key: string;
-                dataRow: MdtChartsDataRow;
-            }) => string;
-        };
-    };
-    /**
-     * @title Параметры оси значений
-     */
-    value?: BaseValueAxisOptions & {
-        /**
-         * @title Позиция оси значений
-         * @description По умолчанию равна "start", если диаграмма вертикальная и "end" - если диаграмма горизонтальная
-         */
-        position?: ChartElementPosition;
-        /**
-         * @title Отображение линий сетки оси
-         * @description По умолчанию всегда отображается
-         */
-        gridLine?: boolean;
-        line?: {
-            visible?: boolean;
-        };
-    };
-    valueSecondary?: BaseValueAxisOptions;
-}
-interface BaseValueAxisOptions {
-    /** @title Размер отступа между подписями в px */
-    stepSize?: number;
-    /**
-     * @title Настройка диапазона осей
-     * @param options Опции с данными диаграммы
-     * @returns Объект с диапазоном осей. Оставить -1 для автоматического определения диапазона
-     */
-    domain?: (options: {
-        data: MdtChartsDataRow[];
-    }) => {
-        start: number;
-        end: number;
-    };
-    /** @title Функция форматирования значений */
-    formatValue?: string;
-    /**
-     * @title Отображение оси
-     * @description По умолчанию не отображается только тогда, когда все диаграммы имеют встроенные лейблы, показывающие значения
-     */
-    visible?: boolean;
-}
-export interface BaseAxesLabelsOptions {
-    /**
-     * @title Максимальный размер подписи в px
-     * @description Для вертикальных осей этот параметр определяет максимальную ширину подписи, а для горизонтальных - максимальную высоту подписи (если подписи расположены вертикально).
-     * @default 80
-     */
-    maxSize?: number;
-}
-interface BaseChartBlockOptions {
-    /**
-     * @title Высота блока графика (px)
-     * @description По умолчанию равна 510 для 2d и polar диаграмм и 150 для card. Минимально возможная высота: 100. Максимально возможная: 800.
-     * @default 510
-     */
-    height?: number;
-    /** @title Настройки стилей */
-    style?: {
-        /** @title Цвет фона */
-        backgroundColor?: string;
-    };
-}
-interface GraphicChartBlockOptions extends BaseChartBlockOptions {
-    /**
-     * @title Заголовок диаграммы
-     */
-    title?: Title;
-    /**
-     * @title Наименование поля-ключа
-     */
-    keyField: ChartField;
-    /**
-     * @title Маркдаун тултипа
-     */
-    tooltipMarkdown?: string;
-    /** @title Логический тип поля значений */
-    valueFieldType?: string;
-    /**
-     * @title Максимальное количество отображаемых записей
-     * @description По умолчанию равно `50`
-     * @default 50
-     */
-    maxRecordCount?: number;
-    /**
-     * @title Настройки отображения тултипа
-     */
-    tooltip?: ChartTooltipOptions;
-}
-export interface ChartTooltipOptions {
-    aggregator?: TooltipAggregator;
-    /**
-     * @title Настройки отображения строк тултипа
-     */
-    rows?: ChartTooltipRowsOptions;
-}
-interface ChartTooltipRowsOptions {
-    /**
-     * @title Функция для сортировки строк
-     * @param aRow Строка с подписью и значением (хранятся в поле `textContent`)
-     * @param bRow Строка с подписью и значением (хранятся в поле `textContent`)
-     * @returns Число, которое будет использоваться для сортировки. Если больше 0, то aRow будет расположена после bRow, если меньше 0, то наоборот, если равно 0, то порядок не изменится
-     * @example Сортировка по значениям от большего к меньшему:
-     *
-     * sortCompareFn: (aRow, bRow) => bRow.textContent.value - aRow.textContent.value
-     */
-    sortCompareFn?: (aRow: ChartTooltipRow, bRow: ChartTooltipRow) => number;
-    /**
-     * @title Предикат для фильтрации строк
-     * @param row Строка с подписью и значением (хранятся в поле `textContent`)
-     * @returns true, если строка должна быть отображена и false - если отображаться не должна
-     * @example Скрытие пустых значений:
-     *
-     * filterPredicate: (row) => row.textContent.value != null
-     */
-    filterPredicate?: (row: ChartTooltipRow) => boolean;
-}
-interface ChartTooltipRow {
-    textContent: {
-        caption: string;
-        value?: number;
-    };
-    valueField: ChartFieldWithTitle;
-}
-interface TooltipAggregator {
-    content?: (options: {
-        row: MdtChartsDataRow;
-    }) => TooltipAggregatorContent;
-    position?: "underKey" | "underValues";
-}
-declare type TooltipAggregatorContent = {
-    type: "plainText";
-    textContent: string;
-} | {
-    type: "captionValue";
-    caption: string;
-    value: any;
-};
-export interface CommonCanvasOptions {
-    bar?: BarCanvasOptions;
-}
-interface BarCanvasOptions {
-    /** @title минимальная ширина столбца в px */
-    minBarWidth?: number;
-    /** @title максимальная ширина столбца в px */
-    maxBarWidth?: number;
-    /** @title минимальный размер расстояния между группами столбцов для разных ключей */
-    groupMinDistance?: number;
-    /** @title максимальный размер расстояния между группами столбцов для разных ключей */
-    groupMaxDistance?: number;
-    /** @title расстояние между столбцами в одной группе */
-    barDistance?: number;
-}
-/**
- * @title Двумерная диаграмма
- */
-export interface TwoDimensionalOptions extends GraphicChartBlockOptions {
-    /**
-     * @title Тип исчисления диаграммы
-     */
-    type: "2d";
-    /**
-     * @title Параметры осей двумерной диаграммы
-     *
-     */
-    axes?: Axes;
-    /**
-     * @title Параметры двумерных диаграмм
-     */
-    charts: TwoDimensionalChart[];
-    /**
-     * @title Общие параметры холста графика
-     */
-    commonCanvasOptions?: CommonCanvasOptions;
-    legend?: boolean | {
-        show?: boolean;
-        position?: TwoDimChartLegendPosition;
-    };
-    valueLabels?: {
-        style?: ValueLabelsStyleOptions;
-        collision?: {
-            otherValueLabels?: "hide" | "none";
-        };
-    };
-    /**
-     * @title Отображения групп записей
-     */
-    grouping?: {
-        /**
-         * @title Уровни группировки
-         */
-        items: {
-            /**
-             * @title Данные, по которым будет настроена группировка
-             */
-            data: {
-                field: ChartFieldWithTitle;
-            };
-            /**
-             * @title Подписи групп. Будут отображать значения поля, по которому задана группировка
-             */
-            labels?: {
-                /**
-                 * @title Позиция подписей.
-                 * @description Может быть равна "start" или "end". Настраивается аналогично позиции оси ключей
-                 */
-                position?: ChartElementPosition;
-            };
-        }[];
-    };
-    events?: TwoDimensionalEvents;
-}
-interface ValueLabelsStyleOptions {
-    cssClassName?: string;
-    /**
-     * @default 10
-     */
-    fontSize?: number;
-    /**
-     * @default rgba(68, 68, 68, 0.5)
-     */
-    color?: string;
-}
-interface TwoDimensionalEvents {
-    drawComplete?: (event: DrawCompleteEvent) => void;
-}
-interface DrawCompleteEvent {
-    canvas: {
-        keyItems: CanvasKeyItemOptions[];
-        plotAreaMargin: BlockMargin;
-    };
-}
-interface BlockMargin {
-    top: number;
-    bottom: number;
-    left: number;
-    right: number;
-}
-interface CanvasKeyItemOptions {
-    totalSize: number;
-}
-/**
- * @title Круговая диаграмма
- */
-export interface PolarOptions extends GraphicChartBlockOptions {
-    /**
-     * @title Тип исчисления диаграммы
-     */
-    type: "polar";
-    /**
-     * @title Параметры круговой диаграммы
-     */
-    chart: PolarChart;
-    /**
-     * @title Наименование поля с цветом
-     * @description Наименование поля, в котором хранится цвет для сегментов диаграммы.
-     */
-    colorField?: string;
-    /**
-     * @title Отображение легенды
-     * @description По умолчанию для круговых диаграмм отображается всегда
-     */
-    legend?: boolean;
-}
-export declare type TwoDimensionalChart = BarChart | LineChart | AreaChart | DotChart;
-interface TwoDimensionalChartOptions {
-    /**
-     * @title Параметры данных, привязанных к диаграмме
-     */
-    data: {
-        /**
-         * @title Наименования отображаемых полей-значений
-         */
-        valueFields: TwoDimensionalValueField[];
-        secondaryValue?: boolean;
-    };
-    /**
-     * @title Отображение диаграммы в сегментированном виде
-     */
-    isSegmented?: boolean;
-    /**
-     * @title Отображение подписей значений на диаграмме
-     */
-    valueLabels?: boolean | ValueLabelsChartOptions;
-}
-export declare type ValueLabelsPositionMode = "center" | "afterElement" | "beforeHead" | "afterStart";
-export interface ValueLabelsChartOptions {
-    on?: boolean;
-    /** @default "afterElement" */
-    position?: ValueLabelsPositionMode;
-    /**
-     * @title Опции смещения подписи
-     */
-    offset?: {
-        /**
-         * @title Смещение подписи относительно вершины элемента в px
-         * @default 10
-         */
-        size?: number;
-    };
-    /**
-     * @title Список полей, для которых будут отображаться подписи
-     * @description По умолчанию подписи отображаются для всех полей
-     */
-    renderForFields?: ChartField[];
-    /**
-     * @title Функция для формирования текста подписи
-     * @param options Параметры для формирования текста подписи
-     * @returns Объект с текстом подписи
-     */
-    content?: (options: {
-        dataRow: MdtChartsDataRow;
-        field: ChartFieldWithTitle;
-    }) => {
-        textContent: string;
-    };
-    rotation?: {
-        angle?: number;
-    };
-    handleElement?: (options: {
-        element: SVGElement;
-        value: number;
-        dataRow: MdtChartsDataRow;
-    }) => void;
-    format?: (options: {
-        value: number;
-    }) => string | number;
-}
-/**
- * @title Гистограмма
- * @defaultSnippets
- * [
- *   {
- * 		"label": "Несегментированная гистограмма (bar)",
- * 		"body": {
- * 			"type": "bar",
- * 			"isSegmented": false,
- * 			"data": {
- * 				"valueFields": [
- * 					"$1"
- * 				]
- * 			}
- * 		}
- * 	 },
- *   {
- * 		"label": "Сегментированная гистограмма (bar)",
- * 		"body": {
- * 			"type": "bar",
- * 			"isSegmented": true,
- * 			"data": {
- * 				"valueFields": [
- * 					"$1"
- * 				]
- * 			}
- * 		}
- * 	 },
- *   {
- * 		"label": "Сегментированная линейная диаграмма (line)",
- * 		"body": {
- * 			"type": "line",
- * 			"isSegmented": true,
- * 			"data": {
- * 				"valueFields": [
- * 					"$1"
- * 				]
- * 			}
- * 		}
- * 	 },
- *   {
- * 		"label": "Несегментированная линейна диаграмма (line)",
- * 		"body": {
- * 			"type": "line",
- * 			"isSegmented": false,
- * 			"data": {
- * 				"valueFields": [
- * 					"$1"
- * 				]
- * 			}
- * 		}
- * 	 },
- *   {
- * 		"label": "Сегментированная диаграмма с областями (area)",
- * 		"body": {
- * 			"type": "area",
- * 			"isSegmented": true,
- * 			"data": {
- * 				"valueFields": [
- * 					"$1"
- * 				]
- * 			}
- * 		}
- * 	 },
- *   {
- * 		"label": "Несегментированная диаграмма с областями (area)",
- * 		"body": {
- * 			"type": "area",
- * 			"isSegmented": false,
- * 			"data": {
- * 				"valueFields": [
- * 					"$1"
- * 				]
- * 			}
- * 		}
- * 	 }
- * ]
- */
-interface BarChart extends TwoDimensionalChartOptions {
-    /**
-     * @title Тип 2D-диаграммы
-     */
-    type: "bar";
-    /**
-     * @title Отображение встроенных надписей со значением
-     * @description Надписи отображаются только при горизонтальном отображении. По умолчанию равно `true`
-     * @default true
-     */
-    labels?: boolean;
-    /** @title Отображать в заштрихованном виде */
-    hatched?: boolean;
-    borderRadius?: BarChartBorderRadius;
-}
-interface BarChartBorderRadius {
-    value?: number;
-}
-/**
- * @title Линейная диаграмма
- */
-interface LineAreaChart extends TwoDimensionalChartOptions {
-    /**
-     * @title Отображение маркеров
-     * @description По умолчанию всегда скрыты
-     */
-    markers?: boolean;
-}
-interface AreaChart extends LineAreaChart {
-    /**
-     * @title Тип 2D-диаграммы
-     */
-    type: "area";
-    /** @title Включить градиент */
-    gradient?: boolean;
-}
-interface LineChart extends LineAreaChart {
-    /**
-     * @title Тип 2D-диаграммы
-     */
-    type: "line";
-    /** @title Управление пунктиром */
-    dash?: LineDash;
-    width?: number;
-}
-interface LineDash {
-    /** @title Включить пунктир */
-    on?: boolean;
-    /** @title Длина одной черты в px */
-    dashSize?: number;
-    /** @title Размер между чертами в px */
-    gapSize?: number;
-}
-export interface DotChart extends TwoDimensionalChartOptions {
-    type: "dot";
-}
-export interface PolarChart {
-    /**
-     * @title Наименование отображаемого поля-значения
-     */
-    valueField: ChartField | ChartFieldWithTitle;
-    /**
-     * @title Управление агрегатором
-     */
-    aggregator?: {
-        /**
-         * @title Контент агрегатора
-         */
-        content?: string;
-    };
-}
-export interface CardChartPublicOptions extends BaseChartBlockOptions {
-    /** @title Тип исчисления диаграммы */
-    type: "card";
-    /** @title Название */
-    title: string;
-    /** @title Описание */
-    description?: string;
-    /** @title Иконка */
-    icon?: string;
-    /** @title Значение */
-    value: CardChartValueOptions;
-    /**
-     * @title Настройки отображения изменения показателя
-     * @deprecated Используйте `changesBlock.items` вместо этого параметра
-     */
-    change?: CardChartChangePublicOptions;
-    /** @title Опции блока с изменениями показателя */
-    changesBlock?: {
-        /** @title Направление отображения изменений */
-        layout?: {
-            /**
-             * @title Направление отображения изменений
-             * @description "row" - отображение изменений в одну строку, "column" - отображение изменений в один столбец
-             * @default "row"
-             */
-            direction?: "row" | "column";
-        };
-        /** @title Опции изменений */
-        items: CardChartChangePublicOptions[];
-    };
-    /** @title Цвет текста карточки */
-    color?: CardColorOptions;
-}
-export interface CardChartValueOptions {
-    /** @title Наименование поля */
-    field: ChartField;
-    /** @title Логический тип поля */
-    dataType?: string;
-    /** @title Шаблон выводимого значения */
-    template?: string;
-}
-export interface CardChartChangePublicOptions {
-    /** @title Значение блока */
-    value: CardChartValueOptions;
-    /** @title Описание блока */
-    description?: string;
-    /** @title Иконки описания */
-    descriptionIcons?: {
-        iconName: string;
-        description?: string;
-    }[];
-    /** @title Цвет текста */
-    color?: CardColorOptions;
-}
-interface CardColorOptions {
-    /** @title Набор цветов */
-    range: ColorRangeItem[];
-}
-export interface ColorRangeItem {
-    /** @title Значение с которого начинается цвет */
-    value?: number;
-    /** @title Название цвета */
-    color: string;
-}
-export {};