mdt-client 1.0.26 → 1.0.29

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

@@ -0,0 +1,460 @@
+export declare type Orientation = "horizontal" | "vertical";
+declare type AxisPosition = "start" | "end";
+export declare type AxisLabelPosition = "vertical" | "horizontal";
+export declare type Field = string;
+export declare type TwoDimensionalValueField = Field | {
+    name: string;
+    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 Параметры оси ключей
+     */
+    key?: {
+        /**
+         * @title Позиция оси ключей
+         * @description По умолчанию равна "end", если диаграма вертикальная и "start" - если диаграмма горизонтальная
+         */
+        position?: AxisPosition;
+        /**
+         * @title Отображение оси
+         * @description По умолчанию всегда отображается
+         */
+        visible?: boolean;
+        /**
+         * @title Отображение линий сетки оси
+         * @description По умолчанию всегда скрывается
+         */
+        gridLine?: boolean;
+        /**
+         * @title Настройка подписей оси
+         */
+        labels?: {
+            /**
+             * @title Настройки позиции оси
+             * @description Настраивается при вертикальном расположении. По умолчанию позиция определяется по количеству свободного места для одной подписи.
+             */
+            position?: AxisLabelPosition;
+        };
+    };
+    /**
+     * @title Параметры оси значений
+     */
+    value?: {
+        /**
+         * @title Позиция оси значений
+         * @description По умолчанию равна "start", если диаграмма вертикальная и "end" - если диаграмма горизонтальная
+         */
+        position?: AxisPosition;
+        /**
+         * @title Отображение оси
+         * @description По умолчанию не отображается только тогда, когда все диаграммы имеют встроенные лейблы, показывающие значения
+         */
+        visible?: boolean;
+        /**
+         * @title Отображение линий сетки оси
+         * @description По умолчанию всегда отображается
+         */
+        gridLine?: boolean;
+    };
+}
+interface BaseChartBlockOptions {
+    /**
+     * @title Высота блока графика (px)
+     * @description По умолчанию равна 510px для 2d и polar диаграмм и 150px для card. Минимально возможная высота: 100px. Максимально возможная: 800px.
+     */
+    height?: number;
+}
+interface GraphicChartBlockOptions extends BaseChartBlockOptions {
+    /**
+     * @title Заголовок диаграммы
+     */
+    title?: string;
+    /**
+     * @title Наименование поля-ключа
+     */
+    keyField: Field;
+    /**
+     * @title Маркдаун тултипа
+     */
+    tooltipMarkdown?: string;
+    /** @title Логический тип поля значений */
+    valueFieldType?: string;
+    /**
+     * @title Максимальное количество отображаемых записей
+     * @description По умолчанию равно `50`
+     * @default 50
+     */
+    maxRecordCount?: number;
+    /**
+     * @title Отображение легенды
+     * @description По умолчанию для круговых диаграмм отображается всегда, а для двумерных диаграмм - когда количество полей значений больше одного
+     */
+    legend?: boolean;
+}
+/**
+ * @title Двумерная диаграмма
+ */
+export interface TwoDimensionalOptions extends GraphicChartBlockOptions {
+    /**
+     * @title Тип исчисления диаграммы
+     */
+    type: "2d";
+    /**
+     * @title Параметры осей двумерной диаграммы
+     *
+     */
+    axes?: Axes;
+    /**
+     * @title Параметры двумерных диаграмм
+     */
+    charts: TwoDimensionalChart[];
+}
+/**
+ * @title Круговая диаграмма
+ */
+export interface PolarOptions extends GraphicChartBlockOptions {
+    /**
+     * @title Тип исчисления диаграммы
+     */
+    type: "polar";
+    /**
+     * @title Параметры круговой диаграммы
+     */
+    chart: PolarChart;
+    /**
+     * @title Наименование поля с цветом
+     * @description Наименование поля, в котором хранится цвет для сегментов диаграммы.
+     */
+    colorField?: string;
+}
+export declare type TwoDimensionalChart = BarChart | LineAreaChart;
+interface TwoDimensionalChartOptions {
+    /**
+     * @title Параметры данных, привязанных к диаграмме
+     */
+    data: {
+        /**
+         * @title Наименования отображаемых полей-значений
+         */
+        valueFields: TwoDimensionalValueField[];
+    };
+    /**
+     * @title Отображение диаграммы в сегментированном виде
+     */
+    isSegmented?: boolean;
+}
+/**
+ * @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 Линейная диаграмма
+ */
+interface LineAreaChart extends TwoDimensionalChartOptions {
+    /**
+     * @title Тип 2D-диаграммы
+     */
+    type: "line" | "area";
+    /**
+     * @title Отображение маркеров
+     * @description По умолчанию всегда скрыты
+     */
+    markers?: boolean;
+}
+export interface PolarChart {
+    /**
+     * @title Наименование отображаемого поля-значения
+     */
+    valueField: Field;
+    /**
+     * @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 Опции блока с изменением показателя */
+    change?: CardChartChangePublicOptions;
+    /** @title Цвет текста карточки */
+    color?: CardColorOptions;
+}
+export interface CardChartValueOptions {
+    /** @title Наименование поля */
+    field: Field;
+    /** @title Логический тип поля */
+    dataType?: string;
+    /** @title Шаблон выводимого значения */
+    template?: string;
+}
+export interface CardChartChangePublicOptions {
+    /** @title Значение блока */
+    value: CardChartValueOptions;
+    /** @title Описание блока */
+    description?: string;
+    /** @title Цвет текста */
+    color?: CardColorOptions;
+}
+interface CardColorOptions {
+    /** @title Набор цветов */
+    range: ColorRangeItem[];
+}
+export interface ColorRangeItem {
+    /** @title Значение с которого начинается цвет */
+    value?: number;
+    /** @title Название цвета */
+    color: string;
+}
+export {};

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

@@ -0,0 +1,35 @@
+import { FormContextParam } from "mdtScripts/views/form/formContextParam";
+import { Query } from "mdtServices/api/Query";
+import { IExp } from "mdtServices/schema/IExp.schema";
+import { ChartControlOptions } from "./ChartControlOptions.schema";
+export interface ChartQuery extends Query {
+    filter$?: IExp;
+}
+export interface ChartData {
+    /**
+     * Автообновление в ms. Если не задано или 0, автообновление не происходит
+     * @minimum 0
+     */
+    refresh?: number;
+    /** Наименование таблицы */
+    table: string;
+    /** Запрос */
+    query: ChartQuery;
+    /** Тип источника данных */
+    type?: "mdt" | "tabular";
+}
+export interface ChartFormControlOptions {
+    /**
+     * @title Настройка диаграммы
+     */
+    controlOptions: ChartControlOptions;
+    /**
+     * @title Запрос на получение данных
+     */
+    data: ChartData;
+    /**
+     * Настройка контекста формы
+     * @title Настройка контекста
+     * */
+    contextParam?: FormContextParam;
+}

package/types/_core/scripts/views/page/charts/chartControl.d.ts

@@ -0,0 +1,19 @@
+/// <reference types="mithril" />
+import { FilterCallback } from "mdt-charts";
+import "mdt-charts/lib/style/charts-main.less";
+import { ExpressionedFilter } from "mdtServices/Filter";
+import "./charts.less";
+import { ChartModel } from "./configAdapter/chartModel";
+import { ChartDataRow } from "./chartControlDataService";
+export declare class ChartControl {
+    private chart;
+    filter: ExpressionedFilter;
+    onSegmentSelect: FilterCallback;
+    chartContext: () => number[];
+    private error;
+    constructor(chart: ChartModel, filter: ExpressionedFilter, onSegmentSelect: FilterCallback, chartContext: () => number[]);
+    updateData(data: ChartDataRow[]): void;
+    resetFilter(filter: ExpressionedFilter): void;
+    setError(e: any): void;
+    $view: () => _mithril.MithrilVirtualElement;
+}

package/types/_core/scripts/views/page/charts/chartControlDataService.d.ts

@@ -0,0 +1,38 @@
+/// <reference types="mithril" />
+import { ChartData } from "./ChartFormControlOptions.schema";
+import { ApiRequestOptions } from "mdtServices/api/ApiRequestOptions";
+import { Query } from "mdtServices/api/Query";
+import { Table } from "mdtScripts/common/Table";
+import { HandledResult } from "mdtServices/api/QueryResultHandler";
+import { Record } from "mdtScripts/common/Record";
+interface ChartControlDataServiceEvents {
+    onfetch: ((dataset: ChartDataRow[]) => void)[];
+    onautoRefresh: (() => void)[];
+}
+declare type FormatFetchedRecordFn = (dataRow: ChartDataRow) => ChartDataRow;
+export interface UsedDatasource {
+    fetch(query: Query, table: string | Table, options: ApiRequestOptions): _mithril.MithrilPromise<HandledResult>;
+}
+interface DatasourceInfo {
+    datasourceImpl: UsedDatasource;
+    formatRecordFn?: FormatFetchedRecordFn;
+    table?: string | Table;
+}
+export declare type ChartDataRow = Record;
+export declare class ChartControlDataService {
+    private options;
+    private datasourceInfo;
+    events: ChartControlDataServiceEvents;
+    private request;
+    private autoRefreshTimeout;
+    constructor(options: ChartData, datasourceInfo: DatasourceInfo);
+    fetchDataAndStartAutoRefresh(): void;
+    fetchData(): _mithril.MithrilPromise<ChartDataRow[]>;
+    abortAndStop(): void;
+    private getQueryWithoutExpFilter;
+    private abortRequest;
+    private startAutoRefresh;
+    private fetchAndPrepare;
+    private prepareDataset;
+}
+export {};

package/types/_core/scripts/views/page/charts/chartFormControl.d.ts

@@ -0,0 +1,27 @@
+/// <reference types="mithril" />
+import { FormCtrl } from "mdtScripts/views/form/form";
+import { ChartFormControlOptions } from "./ChartFormControlOptions.schema";
+export interface FormChartCol {
+    type: "chart";
+    options: ChartFormControlOptions;
+}
+export declare class ChartFormControl {
+    private form;
+    private options;
+    private chartCtrl;
+    private error;
+    private configAdapter;
+    private dataService;
+    private selectedFields;
+    constructor(form: FormCtrl, options: ChartFormControlOptions);
+    private validateOptions;
+    private setError;
+    private getSelectedFields;
+    private createChart;
+    private createChartOnFormBound;
+    private evaluateExpressionedFilter;
+    private initChartCtrl;
+    private initDataService;
+    private compareExpressionedFilterAndReset;
+    $view: () => _mithril.MithrilVirtualElement;
+}

package/types/_core/scripts/views/page/charts/configAdapter/cardChart.d.ts

@@ -0,0 +1,17 @@
+/// <reference types="mithril" />
+import { ChartFormControlOptions } from "../ChartFormControlOptions.schema";
+import { ChartDataRow } from "../chartControlDataService";
+import { ChartModel } from "./chartModel";
+export declare class CardChart implements ChartModel {
+    private publicChartConfig;
+    private config;
+    private configAdapter;
+    private ctrl;
+    private fieldsAdapter;
+    prepareConfig(publicOptions: ChartFormControlOptions): void;
+    updateData(dataRows: ChartDataRow[]): void;
+    getView(): _mithril.MithrilVirtualElement;
+    private setFieldDataType;
+    private isPreparedForRender;
+    private updatePublicConfig;
+}

package/types/_core/scripts/views/page/charts/configAdapter/cardServices/cardOptionsService.d.ts

@@ -0,0 +1,37 @@
+import { CardChartChangePublicOptions, CardChartPublicOptions, CardChartValueOptions } from "mdtScripts/views/page/charts/ChartControlOptions.schema";
+import { CardChartOptions, CardChartValue } from "../../../../../components/cardChart/cardChart";
+import { CardChangeOptions } from "../../../../../components/cardChart/cardChartChange";
+import { ChartFieldsAdapter } from "../chartFieldsAdapter";
+declare type DataRow<V = number | string> = Record<string, V>;
+export declare const DEFAULT_CARD_FONT_COLOR = "#000";
+export declare const DEFAULT_CARD_CHANGE_COLOR: CardOptionByValue<string>;
+declare type CardValueGetter = (valueOptions: CardChartValueOptions, dataRow: DataRow) => CardChartValue;
+export declare class CardOptionsService {
+    private fieldsAdapter;
+    private baseOptionsService;
+    private changeOptionsService;
+    constructor(fieldsAdapter: ChartFieldsAdapter);
+    parseOptions(publicOptions: CardChartPublicOptions, dataRow: DataRow): CardChartOptions;
+    private getValue;
+}
+export declare class CardBaseOptionsService {
+    private valueGetter;
+    constructor(valueGetter: CardValueGetter);
+    parseOptions(publicOptions: CardChartPublicOptions, dataRow: DataRow): CardChartOptions;
+    private getCardColor;
+}
+interface CardOptionByValue<T> {
+    belowZero?: T;
+    equalZero?: T;
+    aboveZero?: T;
+}
+export declare class CardChangeOptionsService {
+    private valueGetter;
+    constructor(valueGetter: CardValueGetter);
+    getChangeModel(options: CardChartChangePublicOptions, dataRow: DataRow<number>): CardChangeOptions;
+    private getValuePrefix;
+    private getColor;
+    private getIcon;
+    private getOptionsByValue;
+}
+export {};

package/types/_core/scripts/views/page/charts/configAdapter/cardServices/colorRangeManager.d.ts

@@ -0,0 +1,7 @@
+import { ColorRangeItem } from "mdtScripts/views/page/charts/ChartControlOptions.schema";
+export declare class ColorRangeManager {
+    private sortedRange;
+    constructor(range: ColorRangeItem[]);
+    getColorByValue(value: number): string;
+}
+export declare function sortColorRange(colorRange: ColorRangeItem[]): ColorRangeItem[];

package/types/_core/scripts/views/page/charts/configAdapter/chartBaseOptionsAdapter.d.ts

@@ -0,0 +1,3 @@
+export declare const ChartBaseOptionsAdapter: {
+    getChartBlockHeight(heightFromConfig?: number, defaultHeightPx?: number): number;
+};

package/types/_core/scripts/views/page/charts/configAdapter/chartConfigAdapter.d.ts

@@ -0,0 +1,13 @@
+import { MdtChartsConfig } from "mdt-charts";
+import { ChartControlOptions, TwoDimensionalOptions, PolarOptions } from "../ChartControlOptions.schema";
+export declare class ChartConfigAdapter {
+    getChartConfigInLibFormat(configOptions: TwoDimensionalOptions | PolarOptions, dataSource: string, contextParam?: string): MdtChartsConfig;
+    validateChartOptions(chartOptions: ChartControlOptions): boolean;
+    private getAxisInLibFormat;
+    private getPolarChartInLibFormat;
+    private get2DChartsInLibFormat;
+    private get2DValueFieldsInLibFormat;
+    private getLegendDefaultParam;
+    private getValueAxisVisibility;
+    private getKeyAxisLabelsPosition;
+}

package/types/_core/scripts/views/page/charts/configAdapter/chartFieldsAdapter.d.ts

@@ -0,0 +1,25 @@
+import { MdtChartsValueField, TooltipHtml } from "mdt-charts";
+import { ChartDataRow } from "../chartControlDataService";
+import { PolarOptions, TwoDimensionalOptions } from "../ChartControlOptions.schema";
+import { ChartData } from "../ChartFormControlOptions.schema";
+export interface FieldsFormats {
+    [fieldName: string]: string;
+}
+interface MarkdownFormatterOptions {
+    dataRow: ChartDataRow;
+    markedFn?: (text: string) => string;
+    fieldsFormats: FieldsFormats;
+}
+export declare class ChartFieldsAdapter {
+    private tableName;
+    constructor(tableName: string);
+    getStringByTemplate(str: string, options: MarkdownFormatterOptions): string;
+    getHtmlGetterFunction(markdown: string, markedFn: (text: string) => string, fieldsFormats?: FieldsFormats): TooltipHtml;
+    getFieldsFormats(controlOptions: TwoDimensionalOptions | PolarOptions, dataOptions: ChartData): FieldsFormats;
+    setFieldTitle(field: MdtChartsValueField): void;
+    getField(fieldName: string, check?: boolean): import("../../../../common/Field").Field;
+    private getDefaultFieldsFormats;
+    private getValueFieldsFormats;
+    private getTableFieldsFormats;
+}
+export {};