@ic3/reporting-api 9.0.1 → 9.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/index.cjs +1906 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.ts +11284 -81
- package/dist/index.js +1782 -96
- package/dist/index.js.map +1 -1
- package/package.json +51 -19
- package/dist/ApiUtils.d.ts +0 -57
- package/dist/ApiUtils.js +0 -79
- package/dist/ApiUtils.js.map +0 -1
- package/dist/ILocalizationManager.d.ts +0 -3
- package/dist/ILocalizationManager.js +0 -3
- package/dist/ILocalizationManager.js.map +0 -1
- package/dist/IMigrationManager.d.ts +0 -4
- package/dist/IMigrationManager.js +0 -3
- package/dist/IMigrationManager.js.map +0 -1
- package/dist/INotification.d.ts +0 -84
- package/dist/INotification.js +0 -3
- package/dist/INotification.js.map +0 -1
- package/dist/IOnNewEventJsContext.d.ts +0 -85
- package/dist/IOnNewEventJsContext.js +0 -3
- package/dist/IOnNewEventJsContext.js.map +0 -1
- package/dist/IPluginDefinition.d.ts +0 -41
- package/dist/IPluginDefinition.js +0 -3
- package/dist/IPluginDefinition.js.map +0 -1
- package/dist/IRemotePluginName.d.ts +0 -5
- package/dist/IRemotePluginName.js +0 -3
- package/dist/IRemotePluginName.js.map +0 -1
- package/dist/IThemeManager.d.ts +0 -87
- package/dist/IThemeManager.js +0 -8
- package/dist/IThemeManager.js.map +0 -1
- package/dist/ITidyTableTransformation.d.ts +0 -44
- package/dist/ITidyTableTransformation.js +0 -3
- package/dist/ITidyTableTransformation.js.map +0 -1
- package/dist/ITidyTableTransformationManager.d.ts +0 -4
- package/dist/ITidyTableTransformationManager.js +0 -3
- package/dist/ITidyTableTransformationManager.js.map +0 -1
- package/dist/ITypes.d.ts +0 -43
- package/dist/ITypes.js +0 -38
- package/dist/ITypes.js.map +0 -1
- package/dist/IUserMenuOptionManager.d.ts +0 -13
- package/dist/IUserMenuOptionManager.js +0 -3
- package/dist/IUserMenuOptionManager.js.map +0 -1
- package/dist/IVersionedPluginDefinition.d.ts +0 -8
- package/dist/IVersionedPluginDefinition.js +0 -3
- package/dist/IVersionedPluginDefinition.js.map +0 -1
- package/dist/IWidgetDefaultsManager.d.ts +0 -4
- package/dist/IWidgetDefaultsManager.js +0 -3
- package/dist/IWidgetDefaultsManager.js.map +0 -1
- package/dist/IWidgetManager.d.ts +0 -7
- package/dist/IWidgetManager.js +0 -3
- package/dist/IWidgetManager.js.map +0 -1
- package/dist/IWidgetVariantManager.d.ts +0 -22
- package/dist/IWidgetVariantManager.js +0 -3
- package/dist/IWidgetVariantManager.js.map +0 -1
- package/dist/IcEvent.d.ts +0 -59
- package/dist/IcEvent.js +0 -27
- package/dist/IcEvent.js.map +0 -1
- package/dist/LazyTreeView.d.ts +0 -130
- package/dist/LazyTreeView.js +0 -3
- package/dist/LazyTreeView.js.map +0 -1
- package/dist/Logger.d.ts +0 -13
- package/dist/Logger.js +0 -3
- package/dist/Logger.js.map +0 -1
- package/dist/PublicAmCharts4Base.d.ts +0 -91
- package/dist/PublicAmCharts4Base.js +0 -3
- package/dist/PublicAmCharts4Base.js.map +0 -1
- package/dist/PublicAmchartsData.d.ts +0 -116
- package/dist/PublicAmchartsData.js +0 -170
- package/dist/PublicAmchartsData.js.map +0 -1
- package/dist/PublicCommon.d.ts +0 -1
- package/dist/PublicCommon.js +0 -3
- package/dist/PublicCommon.js.map +0 -1
- package/dist/PublicContext.d.ts +0 -389
- package/dist/PublicContext.js +0 -19
- package/dist/PublicContext.js.map +0 -1
- package/dist/PublicDateShortcutUtils.d.ts +0 -41
- package/dist/PublicDateShortcutUtils.js +0 -3
- package/dist/PublicDateShortcutUtils.js.map +0 -1
- package/dist/PublicI18n.d.ts +0 -8
- package/dist/PublicI18n.js +0 -3
- package/dist/PublicI18n.js.map +0 -1
- package/dist/PublicLayout.d.ts +0 -247
- package/dist/PublicLayout.js +0 -3
- package/dist/PublicLayout.js.map +0 -1
- package/dist/PublicTemplate.d.ts +0 -630
- package/dist/PublicTemplate.js +0 -33
- package/dist/PublicTemplate.js.map +0 -1
- package/dist/PublicTemplateExprForm.d.ts +0 -30
- package/dist/PublicTemplateExprForm.js +0 -3
- package/dist/PublicTemplateExprForm.js.map +0 -1
- package/dist/PublicTemplateForm.d.ts +0 -866
- package/dist/PublicTemplateForm.js +0 -122
- package/dist/PublicTemplateForm.js.map +0 -1
- package/dist/PublicTemplates.d.ts +0 -70
- package/dist/PublicTemplates.js +0 -3
- package/dist/PublicTemplates.js.map +0 -1
- package/dist/PublicTheme.d.ts +0 -1013
- package/dist/PublicTheme.js +0 -14
- package/dist/PublicTheme.js.map +0 -1
- package/dist/PublicTidyColumn.d.ts +0 -755
- package/dist/PublicTidyColumn.js +0 -100
- package/dist/PublicTidyColumn.js.map +0 -1
- package/dist/PublicTidyHistogram.d.ts +0 -81
- package/dist/PublicTidyHistogram.js +0 -105
- package/dist/PublicTidyHistogram.js.map +0 -1
- package/dist/PublicTidyMath.d.ts +0 -175
- package/dist/PublicTidyMath.js +0 -3
- package/dist/PublicTidyMath.js.map +0 -1
- package/dist/PublicTidyTable.d.ts +0 -534
- package/dist/PublicTidyTable.js +0 -3
- package/dist/PublicTidyTable.js.map +0 -1
- package/dist/PublicTidyTableInteractions.d.ts +0 -317
- package/dist/PublicTidyTableInteractions.js +0 -31
- package/dist/PublicTidyTableInteractions.js.map +0 -1
- package/dist/PublicTidyTableTypeGuards.d.ts +0 -6
- package/dist/PublicTidyTableTypeGuards.js +0 -36
- package/dist/PublicTidyTableTypeGuards.js.map +0 -1
- package/dist/PublicTidyTableTypes.d.ts +0 -480
- package/dist/PublicTidyTableTypes.js +0 -154
- package/dist/PublicTidyTableTypes.js.map +0 -1
- package/dist/PublicTidyTree.d.ts +0 -71
- package/dist/PublicTidyTree.js +0 -89
- package/dist/PublicTidyTree.js.map +0 -1
- package/dist/RemoteContainerUtils.d.ts +0 -9
- package/dist/RemoteContainerUtils.js +0 -49
- package/dist/RemoteContainerUtils.js.map +0 -1
- package/dist/ReportingVersion.d.ts +0 -9
- package/dist/ReportingVersion.js +0 -13
- package/dist/ReportingVersion.js.map +0 -1
- package/dist/ThemeAugmentation.d.ts +0 -35
- package/dist/ThemeAugmentation.js +0 -3
- package/dist/ThemeAugmentation.js.map +0 -1
- package/dist/theme/ThemeAIWidgetChatBot.d.ts +0 -49
- package/dist/theme/ThemeAIWidgetChatBot.js +0 -19
- package/dist/theme/ThemeAIWidgetChatBot.js.map +0 -1
- package/dist/theme/ThemeAlertDialog.d.ts +0 -13
- package/dist/theme/ThemeAlertDialog.js +0 -17
- package/dist/theme/ThemeAlertDialog.js.map +0 -1
- package/dist/theme/ThemeAmCharts4.d.ts +0 -1634
- package/dist/theme/ThemeAmCharts4.js +0 -84
- package/dist/theme/ThemeAmCharts4.js.map +0 -1
- package/dist/theme/ThemeApp.d.ts +0 -66
- package/dist/theme/ThemeApp.js +0 -64
- package/dist/theme/ThemeApp.js.map +0 -1
- package/dist/theme/ThemeAppMenuIcon.d.ts +0 -7
- package/dist/theme/ThemeAppMenuIcon.js +0 -8
- package/dist/theme/ThemeAppMenuIcon.js.map +0 -1
- package/dist/theme/ThemeBaseTable.d.ts +0 -122
- package/dist/theme/ThemeBaseTable.js +0 -10
- package/dist/theme/ThemeBaseTable.js.map +0 -1
- package/dist/theme/ThemeCodeMirror.d.ts +0 -4
- package/dist/theme/ThemeCodeMirror.js +0 -8
- package/dist/theme/ThemeCodeMirror.js.map +0 -1
- package/dist/theme/ThemeDatePicker.d.ts +0 -214
- package/dist/theme/ThemeDatePicker.js +0 -37
- package/dist/theme/ThemeDatePicker.js.map +0 -1
- package/dist/theme/ThemeEditorTopBar.d.ts +0 -39
- package/dist/theme/ThemeEditorTopBar.js +0 -43
- package/dist/theme/ThemeEditorTopBar.js.map +0 -1
- package/dist/theme/ThemeEmbeddedReport.d.ts +0 -37
- package/dist/theme/ThemeEmbeddedReport.js +0 -9
- package/dist/theme/ThemeEmbeddedReport.js.map +0 -1
- package/dist/theme/ThemeErrorRenderer.d.ts +0 -51
- package/dist/theme/ThemeErrorRenderer.js +0 -55
- package/dist/theme/ThemeErrorRenderer.js.map +0 -1
- package/dist/theme/ThemeFilter.d.ts +0 -28
- package/dist/theme/ThemeFilter.js +0 -3
- package/dist/theme/ThemeFilter.js.map +0 -1
- package/dist/theme/ThemeFilterAutocomplete.d.ts +0 -58
- package/dist/theme/ThemeFilterAutocomplete.js +0 -15
- package/dist/theme/ThemeFilterAutocomplete.js.map +0 -1
- package/dist/theme/ThemeFilterButtons.d.ts +0 -74
- package/dist/theme/ThemeFilterButtons.js +0 -23
- package/dist/theme/ThemeFilterButtons.js.map +0 -1
- package/dist/theme/ThemeFilterCheckboxRadio.d.ts +0 -52
- package/dist/theme/ThemeFilterCheckboxRadio.js +0 -23
- package/dist/theme/ThemeFilterCheckboxRadio.js.map +0 -1
- package/dist/theme/ThemeFilterPanel.d.ts +0 -243
- package/dist/theme/ThemeFilterPanel.js +0 -127
- package/dist/theme/ThemeFilterPanel.js.map +0 -1
- package/dist/theme/ThemeFilterPanelViewsMenu.d.ts +0 -8
- package/dist/theme/ThemeFilterPanelViewsMenu.js +0 -12
- package/dist/theme/ThemeFilterPanelViewsMenu.js.map +0 -1
- package/dist/theme/ThemeFilterSlider.d.ts +0 -92
- package/dist/theme/ThemeFilterSlider.js +0 -41
- package/dist/theme/ThemeFilterSlider.js.map +0 -1
- package/dist/theme/ThemeFilterSwitch.d.ts +0 -41
- package/dist/theme/ThemeFilterSwitch.js +0 -15
- package/dist/theme/ThemeFilterSwitch.js.map +0 -1
- package/dist/theme/ThemeFilterTree.d.ts +0 -112
- package/dist/theme/ThemeFilterTree.js +0 -23
- package/dist/theme/ThemeFilterTree.js.map +0 -1
- package/dist/theme/ThemeGlobal.d.ts +0 -4
- package/dist/theme/ThemeGlobal.js +0 -9
- package/dist/theme/ThemeGlobal.js.map +0 -1
- package/dist/theme/ThemeGoogle.d.ts +0 -132
- package/dist/theme/ThemeGoogle.js +0 -64
- package/dist/theme/ThemeGoogle.js.map +0 -1
- package/dist/theme/ThemeGoogleHeatMap.d.ts +0 -58
- package/dist/theme/ThemeGoogleHeatMap.js +0 -3
- package/dist/theme/ThemeGoogleHeatMap.js.map +0 -1
- package/dist/theme/ThemeGoogleKmlLayer.d.ts +0 -40
- package/dist/theme/ThemeGoogleKmlLayer.js +0 -3
- package/dist/theme/ThemeGoogleKmlLayer.js.map +0 -1
- package/dist/theme/ThemeGoogleMarker.d.ts +0 -147
- package/dist/theme/ThemeGoogleMarker.js +0 -3
- package/dist/theme/ThemeGoogleMarker.js.map +0 -1
- package/dist/theme/ThemeHomeCard.d.ts +0 -9
- package/dist/theme/ThemeHomeCard.js +0 -10
- package/dist/theme/ThemeHomeCard.js.map +0 -1
- package/dist/theme/ThemeHomeConsole.d.ts +0 -16
- package/dist/theme/ThemeHomeConsole.js +0 -20
- package/dist/theme/ThemeHomeConsole.js.map +0 -1
- package/dist/theme/ThemeHtmlBox.d.ts +0 -33
- package/dist/theme/ThemeHtmlBox.js +0 -11
- package/dist/theme/ThemeHtmlBox.js.map +0 -1
- package/dist/theme/ThemeIc3CustomDrilldownMenu.d.ts +0 -7
- package/dist/theme/ThemeIc3CustomDrilldownMenu.js +0 -11
- package/dist/theme/ThemeIc3CustomDrilldownMenu.js.map +0 -1
- package/dist/theme/ThemeIc3TableCell.d.ts +0 -10
- package/dist/theme/ThemeIc3TableCell.js +0 -7
- package/dist/theme/ThemeIc3TableCell.js.map +0 -1
- package/dist/theme/ThemeIc3TableCellDrilldown.d.ts +0 -12
- package/dist/theme/ThemeIc3TableCellDrilldown.js +0 -11
- package/dist/theme/ThemeIc3TableCellDrilldown.js.map +0 -1
- package/dist/theme/ThemeIc3WidgetBoxSpinner.d.ts +0 -15
- package/dist/theme/ThemeIc3WidgetBoxSpinner.js +0 -13
- package/dist/theme/ThemeIc3WidgetBoxSpinner.js.map +0 -1
- package/dist/theme/ThemeImage.d.ts +0 -30
- package/dist/theme/ThemeImage.js +0 -12
- package/dist/theme/ThemeImage.js.map +0 -1
- package/dist/theme/ThemeKpiBox.d.ts +0 -33
- package/dist/theme/ThemeKpiBox.js +0 -3
- package/dist/theme/ThemeKpiBox.js.map +0 -1
- package/dist/theme/ThemeKpiCard.d.ts +0 -133
- package/dist/theme/ThemeKpiCard.js +0 -19
- package/dist/theme/ThemeKpiCard.js.map +0 -1
- package/dist/theme/ThemeLayout.d.ts +0 -10
- package/dist/theme/ThemeLayout.js +0 -14
- package/dist/theme/ThemeLayout.js.map +0 -1
- package/dist/theme/ThemeLayoutPage.d.ts +0 -24
- package/dist/theme/ThemeLayoutPage.js +0 -28
- package/dist/theme/ThemeLayoutPage.js.map +0 -1
- package/dist/theme/ThemeLazyTreeClasses.d.ts +0 -29
- package/dist/theme/ThemeLazyTreeClasses.js +0 -31
- package/dist/theme/ThemeLazyTreeClasses.js.map +0 -1
- package/dist/theme/ThemeListCounter.d.ts +0 -15
- package/dist/theme/ThemeListCounter.js +0 -17
- package/dist/theme/ThemeListCounter.js.map +0 -1
- package/dist/theme/ThemeMarkdownText.d.ts +0 -27
- package/dist/theme/ThemeMarkdownText.js +0 -3
- package/dist/theme/ThemeMarkdownText.js.map +0 -1
- package/dist/theme/ThemePivotTable.d.ts +0 -93
- package/dist/theme/ThemePivotTable.js +0 -31
- package/dist/theme/ThemePivotTable.js.map +0 -1
- package/dist/theme/ThemePrintButton.d.ts +0 -29
- package/dist/theme/ThemePrintButton.js +0 -10
- package/dist/theme/ThemePrintButton.js.map +0 -1
- package/dist/theme/ThemeQueryBuilderNode.d.ts +0 -13
- package/dist/theme/ThemeQueryBuilderNode.js +0 -13
- package/dist/theme/ThemeQueryBuilderNode.js.map +0 -1
- package/dist/theme/ThemeRegexFilter.d.ts +0 -24
- package/dist/theme/ThemeRegexFilter.js +0 -26
- package/dist/theme/ThemeRegexFilter.js.map +0 -1
- package/dist/theme/ThemeRepetitionWidget.d.ts +0 -57
- package/dist/theme/ThemeRepetitionWidget.js +0 -3
- package/dist/theme/ThemeRepetitionWidget.js.map +0 -1
- package/dist/theme/ThemeReportAppBar.d.ts +0 -17
- package/dist/theme/ThemeReportAppBar.js +0 -21
- package/dist/theme/ThemeReportAppBar.js.map +0 -1
- package/dist/theme/ThemeReportAppLeftPanel.d.ts +0 -8
- package/dist/theme/ThemeReportAppLeftPanel.js +0 -12
- package/dist/theme/ThemeReportAppLeftPanel.js.map +0 -1
- package/dist/theme/ThemeSeparator.d.ts +0 -13
- package/dist/theme/ThemeSeparator.js +0 -3
- package/dist/theme/ThemeSeparator.js.map +0 -1
- package/dist/theme/ThemeSinglePanelFilter.d.ts +0 -18
- package/dist/theme/ThemeSinglePanelFilter.js +0 -3
- package/dist/theme/ThemeSinglePanelFilter.js.map +0 -1
- package/dist/theme/ThemeTable.d.ts +0 -160
- package/dist/theme/ThemeTable.js +0 -157
- package/dist/theme/ThemeTable.js.map +0 -1
- package/dist/theme/ThemeWidgetBox.d.ts +0 -164
- package/dist/theme/ThemeWidgetBox.js +0 -124
- package/dist/theme/ThemeWidgetBox.js.map +0 -1
- package/dist/theme/ThemeWidgetBoxContentMessage.d.ts +0 -11
- package/dist/theme/ThemeWidgetBoxContentMessage.js +0 -15
- package/dist/theme/ThemeWidgetBoxContentMessage.js.map +0 -1
- package/dist/theme/ThemeWidgetFilteredBy.d.ts +0 -5
- package/dist/theme/ThemeWidgetFilteredBy.js +0 -9
- package/dist/theme/ThemeWidgetFilteredBy.js.map +0 -1
|
@@ -1,866 +0,0 @@
|
|
|
1
|
-
import { IPublicContext, IWidgetEditorPublicContext } from "./PublicContext";
|
|
2
|
-
import { ITidyColumn } from "./PublicTidyColumn";
|
|
3
|
-
import * as React from "react";
|
|
4
|
-
import { ChartTemplateDataMapping, IFormFieldGranularityItem, TidyColumnsType, TidyTableColumnSelector } from "./PublicTidyTableTypes";
|
|
5
|
-
import { ITidyTable } from "./PublicTidyTable";
|
|
6
|
-
import { Theme } from "@mui/material/styles";
|
|
7
|
-
import { AutocompleteProps, AutocompleteRenderInputParams, AutocompleteRenderOptionState } from "@mui/material/Autocomplete";
|
|
8
|
-
import { IFormTidyTableExprFieldDef } from "./PublicTemplateExprForm";
|
|
9
|
-
export type Hook<T, P> = {
|
|
10
|
-
hook: (value: T, options: P) => void;
|
|
11
|
-
};
|
|
12
|
-
export declare function formFieldIsSelection(field: IFormFieldDef<any>): boolean;
|
|
13
|
-
export interface IFormFieldDef<DEFAULT_VALUE_TYPE> {
|
|
14
|
-
/**
|
|
15
|
-
* The path of the field within the edited bean.
|
|
16
|
-
*/
|
|
17
|
-
fieldPath: string;
|
|
18
|
-
/**
|
|
19
|
-
* Default: false ,
|
|
20
|
-
*
|
|
21
|
-
* If defaultValue is defined,
|
|
22
|
-
*/
|
|
23
|
-
mandatory?: boolean;
|
|
24
|
-
/**
|
|
25
|
-
* The default value defined at field level (note: can be defined at Theme level as well).
|
|
26
|
-
*/
|
|
27
|
-
defaultValue?: DEFAULT_VALUE_TYPE;
|
|
28
|
-
/**
|
|
29
|
-
* Override fieldPath to search for a default value in the Theme.
|
|
30
|
-
*/
|
|
31
|
-
defaultValuePath?: string;
|
|
32
|
-
/**
|
|
33
|
-
* The optional group a field belongs too
|
|
34
|
-
*
|
|
35
|
-
* @see IFormGroupsFieldDef
|
|
36
|
-
* @see IFormBooleanFieldDef
|
|
37
|
-
*/
|
|
38
|
-
group?: string;
|
|
39
|
-
/**
|
|
40
|
-
* When defined, the value is added as a prefix to the fieldPath to define the localization tag.
|
|
41
|
-
*/
|
|
42
|
-
fieldPrefixTag?: IFormFieldGroupTypes | string;
|
|
43
|
-
/**
|
|
44
|
-
* When defined, this tag is used for localization
|
|
45
|
-
*/
|
|
46
|
-
localizationTag?: string;
|
|
47
|
-
/**
|
|
48
|
-
* Default: "string".
|
|
49
|
-
*/
|
|
50
|
-
fieldType: FormFieldType;
|
|
51
|
-
/**
|
|
52
|
-
* Override default localization.
|
|
53
|
-
*/
|
|
54
|
-
fieldDescription?: string;
|
|
55
|
-
/**
|
|
56
|
-
* Default: false
|
|
57
|
-
*/
|
|
58
|
-
readOnly?: boolean;
|
|
59
|
-
/**
|
|
60
|
-
* An optional field path value. The value of this field depends on the value of the dependsOn field.
|
|
61
|
-
*/
|
|
62
|
-
dependsOn?: string | string[];
|
|
63
|
-
/**
|
|
64
|
-
* Clear the field if the value in the depends-on field changes.
|
|
65
|
-
*/
|
|
66
|
-
dependsOnReset?: true;
|
|
67
|
-
/**
|
|
68
|
-
* When defined a function that returns the visibility of the field according to the dependsOn value.
|
|
69
|
-
*/
|
|
70
|
-
dependsOnVisibility?: boolean | ((dependsOnValue?: any) => boolean);
|
|
71
|
-
valueFromDependsOnValue?: (dependsOnValue?: string) => any;
|
|
72
|
-
/**
|
|
73
|
-
* When defined a function that returns the visibility of the field.
|
|
74
|
-
*/
|
|
75
|
-
visibility?: boolean | ((context: IWidgetEditorPublicContext) => boolean);
|
|
76
|
-
/**
|
|
77
|
-
* When defined the content of the field is translated (using context.translateContent).
|
|
78
|
-
*
|
|
79
|
-
* Only works for chart/widgetOptions !!
|
|
80
|
-
*/
|
|
81
|
-
translated?: boolean;
|
|
82
|
-
/**
|
|
83
|
-
* Allow for group of fields, disabled help in form wrapper
|
|
84
|
-
*/
|
|
85
|
-
disableHelpInWrapper?: boolean;
|
|
86
|
-
onValueSet?: (value: any) => void;
|
|
87
|
-
}
|
|
88
|
-
/**
|
|
89
|
-
* The options (possibly edited and/or from the theme) of a widget.
|
|
90
|
-
*
|
|
91
|
-
* Aka Props
|
|
92
|
-
*/
|
|
93
|
-
export interface FormFieldObject {
|
|
94
|
-
readonly '0242ac130003': '0242ac130003';
|
|
95
|
-
}
|
|
96
|
-
export type FormFields<T extends FormFieldObject> = {
|
|
97
|
-
[key in keyof Omit<T, '0242ac130003'>]-?: // make the key mandatory even though the field is optional
|
|
98
|
-
(Required<T>[key] extends FormFieldObject ? {
|
|
99
|
-
defaultValue?: any;
|
|
100
|
-
} : undefined extends NonNullable<T>[key] ? {
|
|
101
|
-
defaultValue?: any;
|
|
102
|
-
} : {
|
|
103
|
-
defaultValue: unknown;
|
|
104
|
-
} | {
|
|
105
|
-
mandatory: true;
|
|
106
|
-
}) & (Required<T>[key] extends FormFieldObject ? unknown : {
|
|
107
|
-
defaultValue?: any;
|
|
108
|
-
mandatory?: true;
|
|
109
|
-
} | {
|
|
110
|
-
defaultValue?: any;
|
|
111
|
-
mandatory?: false;
|
|
112
|
-
}) & (Required<T>[key] extends FormFieldObject ? Omit<IFormEmbeddedFieldDef<Required<T>[key]>, 'fieldPath'> : Required<T>[key] extends IPaletteDef ? Omit<IFormPaletteEditorFieldDef, 'fieldPath'> : Required<T>[key] extends IFormConditionalColorRule[] ? Omit<IFormConditionalColorRulesFieldDef, 'fieldPath'> : Required<T>[key] extends IColorDef ? Omit<IFormColorEditorFieldDef, 'fieldPath'> : Required<T>[key] extends TidyTableColumnSelector[] ? Omit<IFormColumnChooserMultipleFieldDef, 'fieldPath'> : Required<T>[key] extends TidyTableColumnSelector ? Omit<IFormColumnChooserSingleFieldDef, 'fieldPath'> : Required<T>[key] extends IFormEventMappingArrayFieldDefType ? Omit<IFormEventMappingArrayFieldDef, 'fieldPath'> : Required<T>[key] extends IFormEventArrayFieldDefType ? Omit<IFormEventArrayFieldDef, 'fieldPath'> : Required<T>[key] extends IFormSearchAndReplaceArrayFieldDefType ? Omit<IFormSearchAndReplaceArrayFieldDef, 'fieldPath'> : Required<T>[key] extends Hook<any, any> ? Omit<IFormHookFieldDef<any>, 'fieldPath'> : Required<T>[key] extends boolean ? Omit<IFormBooleanFieldDef, 'fieldPath'> : Required<T>[key] extends number ? Omit<IFormNumberFieldDef, 'fieldPath'> : Required<T>[key] extends number ? Omit<IFormMaskFieldDef, 'fieldPath'> : Required<T>[key] extends string ? Omit<IFormOptionFieldSingleDef, 'fieldPath'> | Omit<IFormStringFieldDef, 'fieldPath'> | Omit<IFormFormatterPickerFieldDef, 'fieldPath'> | Omit<IFormWidgetVariantFieldDef, 'fieldPath'> | Omit<IFormTidyTableTextExprFieldDef, 'fieldPath'> | Omit<IFormTidyTableTextRowExprFieldDef, 'fieldPath'> | Omit<IFormTidyTableNumericStringColumnExprFieldDef, 'fieldPath'> | Omit<IFormTidyTableHtmlRowExprFieldDef, 'fieldPath'> | Omit<IFormTidyTableHtmlExprFieldDef, 'fieldPath'> | Omit<IFormTidyTableNumericExprFieldDef, 'fieldPath'> | Omit<IFormTidyTableNumericRowExprFieldDef, 'fieldPath'> | Omit<IFormTidyTableNumericJSColumnExprFieldDef, 'fieldPath'> | Omit<IFormTidyTableColorRowExprFieldDef, 'fieldPath'> | Omit<IFormTidyTableStringRowExprFieldDef, 'fieldPath'> | Omit<IFormTidyTableScaleRowExprFieldDef, 'fieldPath'> | Omit<IFormJsFieldDef, 'fieldPath'> | Omit<IFormJsonFieldDef, 'fieldPath'> | Omit<IFormMarkdownFieldDef, 'fieldPath'> | Omit<IFormOptionFieldReportPathDef, 'fieldPath'> | Omit<IFormPropertyChooserBaseDef, 'fieldPath'> | Omit<IFormLayoutFieldDef, 'fieldPath'> | Omit<IFormLayoutFieldDef, 'fieldPath'> | Omit<IFormFilterPanelModelSelectorFieldDef, 'fieldPath'> | Omit<IFormShortcutChooserDef<string>, 'fieldPath'> : Required<T>[key] extends string[] ? Omit<IFormOptionFieldMultipleDef, 'fieldPath'> | Omit<IFormGroupsFieldDef, 'fieldPath'> | Omit<IFormShortcutChooserDef<string[]>, 'fieldPath'> : never);
|
|
113
|
-
};
|
|
114
|
-
export declare enum IFormFieldGroupTypes {
|
|
115
|
-
Selection = "groupSelection",
|
|
116
|
-
FilterGeneralOption = "filterGeneralOptionsGroup",
|
|
117
|
-
FilterItem = "filterItemGroup"
|
|
118
|
-
}
|
|
119
|
-
export type FormFieldType =
|
|
120
|
-
/**
|
|
121
|
-
* @see IFormReportPathFieldDef
|
|
122
|
-
*/
|
|
123
|
-
"appPath" |
|
|
124
|
-
/**
|
|
125
|
-
* @see IFormAutocompleteFieldDef
|
|
126
|
-
*/
|
|
127
|
-
"autocomplete" |
|
|
128
|
-
/**
|
|
129
|
-
* @see IFormBooleanFieldDef
|
|
130
|
-
*/
|
|
131
|
-
"boolean" |
|
|
132
|
-
/**
|
|
133
|
-
* @see IFormColorEditorFieldDef
|
|
134
|
-
*/
|
|
135
|
-
"color" |
|
|
136
|
-
/**
|
|
137
|
-
* @see IFormColumnChooserFieldDef
|
|
138
|
-
*/
|
|
139
|
-
"columnsChooser" |
|
|
140
|
-
/**
|
|
141
|
-
* @see IFormColumnSelectionFieldDef
|
|
142
|
-
*/
|
|
143
|
-
"columnSelection" |
|
|
144
|
-
/**
|
|
145
|
-
* @see IFormConstantsFieldDef
|
|
146
|
-
*/
|
|
147
|
-
"constants" |
|
|
148
|
-
/**
|
|
149
|
-
* @see IFormArrayStringRecordsFieldDef
|
|
150
|
-
*/
|
|
151
|
-
"eventMappingArray" | "eventArray" |
|
|
152
|
-
/**
|
|
153
|
-
* @see IFormEmbeddedFieldDef
|
|
154
|
-
*/
|
|
155
|
-
"embedded" |
|
|
156
|
-
/**
|
|
157
|
-
* @see IFormFileUploaderFieldDef
|
|
158
|
-
*/
|
|
159
|
-
"fileUploader" |
|
|
160
|
-
/**
|
|
161
|
-
* @see IFormFormatterPickerFieldDef
|
|
162
|
-
*/
|
|
163
|
-
"formatterPicker" |
|
|
164
|
-
/**
|
|
165
|
-
* @see IFormBooleanFieldDef
|
|
166
|
-
*/
|
|
167
|
-
"fixedBoolean" |
|
|
168
|
-
/**
|
|
169
|
-
* @see IFormBooleanFieldDef
|
|
170
|
-
*/
|
|
171
|
-
"groupBoolean" |
|
|
172
|
-
/**
|
|
173
|
-
* @see IFormGroupsFieldDef
|
|
174
|
-
*/
|
|
175
|
-
"groups" |
|
|
176
|
-
/**
|
|
177
|
-
* @see IFormFunctionFieldDef
|
|
178
|
-
*/
|
|
179
|
-
"hook" |
|
|
180
|
-
/**
|
|
181
|
-
* @see IFormJsFieldDef
|
|
182
|
-
*/
|
|
183
|
-
"js" |
|
|
184
|
-
/**
|
|
185
|
-
* @see IFormJsonFieldDef
|
|
186
|
-
*/
|
|
187
|
-
"json" |
|
|
188
|
-
/**
|
|
189
|
-
* @see IFormMarkdownFieldDef
|
|
190
|
-
*/
|
|
191
|
-
"markdown" |
|
|
192
|
-
/**
|
|
193
|
-
* @see IFormMaskFieldDef
|
|
194
|
-
*/
|
|
195
|
-
"mask" |
|
|
196
|
-
/**
|
|
197
|
-
* @see IFormMdxFieldDef
|
|
198
|
-
*/
|
|
199
|
-
"mdxExpression" |
|
|
200
|
-
/**
|
|
201
|
-
* @see IFormMuiVariantFieldDef
|
|
202
|
-
*/
|
|
203
|
-
"number" |
|
|
204
|
-
/**
|
|
205
|
-
* @see IFormOptionFieldDef
|
|
206
|
-
*/
|
|
207
|
-
"option" |
|
|
208
|
-
/**
|
|
209
|
-
* @see IFormColorEditorFieldDef
|
|
210
|
-
*/
|
|
211
|
-
"palette" |
|
|
212
|
-
/**
|
|
213
|
-
* @see IFormReportPathFieldDef
|
|
214
|
-
*/
|
|
215
|
-
"reportFolder" |
|
|
216
|
-
/**
|
|
217
|
-
* @see IFormReportPathFieldDef
|
|
218
|
-
*/
|
|
219
|
-
"reportPath" |
|
|
220
|
-
/**
|
|
221
|
-
* @see IFormReportPermaLinkFieldDef
|
|
222
|
-
*/
|
|
223
|
-
"reportPermaLink" |
|
|
224
|
-
/**
|
|
225
|
-
* @see IFormStringFieldDef
|
|
226
|
-
*/
|
|
227
|
-
"string" |
|
|
228
|
-
/**
|
|
229
|
-
* @see IFormTextFieldDef
|
|
230
|
-
*/
|
|
231
|
-
"text" | FormFieldTidyTableExprType |
|
|
232
|
-
/**
|
|
233
|
-
* @see IFormUrlFieldDef
|
|
234
|
-
*/
|
|
235
|
-
"url" |
|
|
236
|
-
/**
|
|
237
|
-
* @see IFormWidgetVariantFieldDef
|
|
238
|
-
*/
|
|
239
|
-
"widgetVariant" |
|
|
240
|
-
/**
|
|
241
|
-
* @see IFormGranularitySelectionFieldDef
|
|
242
|
-
*/
|
|
243
|
-
"granularityChooser" |
|
|
244
|
-
/**
|
|
245
|
-
* @see IFormSearchAndReplaceArrayFieldDefType
|
|
246
|
-
*/
|
|
247
|
-
"searchAndReplaceArray" |
|
|
248
|
-
/**
|
|
249
|
-
* @see IFormPropertyChooserBaseDef
|
|
250
|
-
*/
|
|
251
|
-
"propertyChooser" |
|
|
252
|
-
/**
|
|
253
|
-
* @see IFormLayoutFieldDef
|
|
254
|
-
*/
|
|
255
|
-
"layout" |
|
|
256
|
-
/**
|
|
257
|
-
* @see IFormConditionalColorRulesFieldDef
|
|
258
|
-
*/
|
|
259
|
-
"conditionalColorRules" |
|
|
260
|
-
/**
|
|
261
|
-
* @see IFormFilterPanelModelSelectorFieldDef
|
|
262
|
-
*/
|
|
263
|
-
"filterPanelModelSelector" |
|
|
264
|
-
/**
|
|
265
|
-
* @see IFormShortcutChooserDef
|
|
266
|
-
*/
|
|
267
|
-
"shortcutChooser";
|
|
268
|
-
export type FormFieldTidyTableExprType =
|
|
269
|
-
/**
|
|
270
|
-
* @see IFormTidyTableColorRowExprFieldDef
|
|
271
|
-
*/
|
|
272
|
-
"tidyTableColorRowExpr" |
|
|
273
|
-
/**
|
|
274
|
-
* @see IFormTidyTableHtmlExprFieldDef
|
|
275
|
-
*/
|
|
276
|
-
"tidyTableHtmlExpr" |
|
|
277
|
-
/**
|
|
278
|
-
* @see IFormTidyTableHtmlRowExprFieldDef
|
|
279
|
-
*/
|
|
280
|
-
"tidyTableHtmlRowExpr" |
|
|
281
|
-
/**
|
|
282
|
-
* @see IFormTidyTableNumericExprFieldDef
|
|
283
|
-
*/
|
|
284
|
-
"tidyTableNumericExpr" |
|
|
285
|
-
/**
|
|
286
|
-
* @see IFormTidyTableNumericJSColumnExprFieldDef
|
|
287
|
-
*/
|
|
288
|
-
"tidyTableNumericJSColumnExpr" |
|
|
289
|
-
/**
|
|
290
|
-
* @see IFormTidyTableNumericRowExprFieldDef
|
|
291
|
-
*/
|
|
292
|
-
"tidyTableNumericRowExpr" |
|
|
293
|
-
/**
|
|
294
|
-
* @see IFormTidyTableNumericStringColumnExprFieldDef
|
|
295
|
-
*/
|
|
296
|
-
"tidyTableNumericStringColumnExpr" |
|
|
297
|
-
/**
|
|
298
|
-
* @see IFormTidyTableScaleRowExprFieldDef
|
|
299
|
-
*/
|
|
300
|
-
"tidyTableScaleRowExpr" |
|
|
301
|
-
/**
|
|
302
|
-
* @see IFormTidyTableTextExprFieldDef
|
|
303
|
-
*/
|
|
304
|
-
"tidyTableTextExpr" |
|
|
305
|
-
/**
|
|
306
|
-
* @see IFormTidyTableTextRowExprFieldDef
|
|
307
|
-
*/
|
|
308
|
-
"tidyTableTextRowExpr" |
|
|
309
|
-
/**
|
|
310
|
-
* @see IFormTidyTableStringRowExprFieldDef
|
|
311
|
-
*/
|
|
312
|
-
"tidyTableStringRowExpr";
|
|
313
|
-
export declare function isTidyTableExpr(type: FormFieldType): type is FormFieldTidyTableExprType;
|
|
314
|
-
export declare function isTidyTableExprJS(type: FormFieldType): boolean;
|
|
315
|
-
export declare function isTidyTableExprTable(type: FormFieldType): type is "tidyTableHtmlExpr" | "tidyTableNumericExpr" | "tidyTableTextExpr";
|
|
316
|
-
export declare function isTidyTableExprColumn(type: FormFieldType): boolean;
|
|
317
|
-
export declare function isTidyTableExprRow(type: FormFieldType): boolean;
|
|
318
|
-
export declare function isTidyTableExprNumericString(type: FormFieldType): type is "tidyTableColorRowExpr" | "tidyTableStringRowExpr" | "tidyTableNumericStringColumnExpr";
|
|
319
|
-
export declare function isTidyTableExprNumericJS(type: FormFieldType): type is "tidyTableNumericJSColumnExpr";
|
|
320
|
-
export declare function isTidyTableExprText(type: FormFieldType): type is "tidyTableTextExpr" | "tidyTableTextRowExpr";
|
|
321
|
-
export declare function isTidyTableExprTextHtml(type: FormFieldType): type is "tidyTableHtmlExpr" | "tidyTableHtmlRowExpr";
|
|
322
|
-
export declare function isTidyTableExprNumeric(type: FormFieldType): type is "tidyTableNumericExpr" | "tidyTableNumericRowExpr";
|
|
323
|
-
export declare function isTidyTableExprScale(type: FormFieldType): type is "tidyTableScaleRowExpr";
|
|
324
|
-
/**
|
|
325
|
-
* Error messages for field suggestions and value candidates.
|
|
326
|
-
* Put translations in ReportLocalization.csv.
|
|
327
|
-
*/
|
|
328
|
-
export declare enum AutocompleteNoOptionsText {
|
|
329
|
-
NO_OPTIONS = "NO_OPTIONS",
|
|
330
|
-
NO_COLUMNS = "NO_COLUMNS",
|
|
331
|
-
NO_QUERY_RESULT = "NO_QUERY_RESULT",
|
|
332
|
-
QUERY_HAS_ERROR = "QUERY_HAS_ERROR",
|
|
333
|
-
TRANSFORMATION_HAS_ERROR = "TRANSFORMATION_HAS_ERROR",
|
|
334
|
-
QUERY_OUTDATED = "QUERY_OUTDATED"
|
|
335
|
-
}
|
|
336
|
-
/**
|
|
337
|
-
* Show an action button below the options
|
|
338
|
-
*/
|
|
339
|
-
export declare enum AutocompleteActions {
|
|
340
|
-
ADD_COLOR = "ADD_COLOR",
|
|
341
|
-
REFRESH_QUERY = "REFRESH_QUERY"
|
|
342
|
-
}
|
|
343
|
-
export type CodeMirrorMode = "plain" | "mdx" | "sql" | "js" | "json" | "csv" | "md" | FormFieldTidyTableExprType;
|
|
344
|
-
export type FormFieldDialogEditorModelType = "unknown" | "markdown" | "mdxExpression" | FormFieldTidyTableExprType;
|
|
345
|
-
export interface IColorDef {
|
|
346
|
-
/**
|
|
347
|
-
* aka. name
|
|
348
|
-
*/
|
|
349
|
-
path: string;
|
|
350
|
-
}
|
|
351
|
-
export interface IPaletteDef {
|
|
352
|
-
/**
|
|
353
|
-
* aka. name
|
|
354
|
-
*/
|
|
355
|
-
path: string;
|
|
356
|
-
reversed: boolean;
|
|
357
|
-
}
|
|
358
|
-
export interface IOption {
|
|
359
|
-
id: string;
|
|
360
|
-
caption: string;
|
|
361
|
-
}
|
|
362
|
-
/**
|
|
363
|
-
* A generic object.
|
|
364
|
-
*
|
|
365
|
-
* Use the editorConf to provide the list of options to choose from and the function that is displaying
|
|
366
|
-
* the label/caption of the options. Check the editorConf for more configuration.
|
|
367
|
-
*
|
|
368
|
-
* This is quite a generic editor that should not be used directly.
|
|
369
|
-
*
|
|
370
|
-
* @see FormFieldDef
|
|
371
|
-
*/
|
|
372
|
-
export interface IFormAutocompleteFieldDef<OPTION> extends IFormFieldDef<OPTION> {
|
|
373
|
-
fieldType: "autocomplete";
|
|
374
|
-
editorConf: {
|
|
375
|
-
multiple?: boolean;
|
|
376
|
-
groupBy?: (option: OPTION | undefined) => string;
|
|
377
|
-
getOptionLabel?: (option: OPTION | undefined | null) => string;
|
|
378
|
-
isOptionEqualToValue?: (option: OPTION | undefined | null, value: OPTION | undefined | null) => boolean;
|
|
379
|
-
freeSolo?: boolean;
|
|
380
|
-
optionValues?: OPTION[] | ((callback: ((suggestions: OPTION[]) => void), dependsOnValue?: any, param?: {
|
|
381
|
-
theme: Theme;
|
|
382
|
-
}) => void);
|
|
383
|
-
noOptionsText?: AutocompleteNoOptionsText;
|
|
384
|
-
/**
|
|
385
|
-
* Show an action button below the options.
|
|
386
|
-
*
|
|
387
|
-
* If the query is outdated or not run yet, it shows a refresh action instead.
|
|
388
|
-
*/
|
|
389
|
-
action?: AutocompleteActions;
|
|
390
|
-
renderInput?: (params: AutocompleteRenderInputParams) => React.ReactNode;
|
|
391
|
-
renderOption?: (props: React.HTMLAttributes<HTMLLIElement>, option: OPTION, state: AutocompleteRenderOptionState, onClose: () => void) => React.ReactNode;
|
|
392
|
-
disableClearable?: boolean;
|
|
393
|
-
renderTags?: AutocompleteProps<OPTION, any, any, any>['renderTags'];
|
|
394
|
-
};
|
|
395
|
-
}
|
|
396
|
-
/**
|
|
397
|
-
* The "groupBoolean" allows for using that field as a group header and as a way
|
|
398
|
-
* to enable/disable the options in the group.
|
|
399
|
-
*
|
|
400
|
-
* @see FormFieldDef
|
|
401
|
-
* @see IFormGroupsFieldDef
|
|
402
|
-
*/
|
|
403
|
-
export interface IFormBooleanFieldDef extends IFormFieldDef<boolean> {
|
|
404
|
-
fieldType: "boolean" | "fixedBoolean" | "groupBoolean";
|
|
405
|
-
}
|
|
406
|
-
export interface IFormLayoutFieldDef extends IFormFieldDef<string> {
|
|
407
|
-
fieldType: "layout";
|
|
408
|
-
}
|
|
409
|
-
/**
|
|
410
|
-
* @see FormFieldDef
|
|
411
|
-
*/
|
|
412
|
-
export interface IFormColorEditorFieldDef extends IFormFieldDef<IColorDef> {
|
|
413
|
-
fieldType: "color";
|
|
414
|
-
}
|
|
415
|
-
/**
|
|
416
|
-
* @see FormFieldDef
|
|
417
|
-
*
|
|
418
|
-
* Use the fieldPath to access the column directly in the tidy table with table.getColumnByAlias(...).
|
|
419
|
-
* If multiple columns are in this field, it returns the first column.
|
|
420
|
-
*
|
|
421
|
-
* If the columns chooser is mandatory, the widget or transformation returns an error if there is no column either
|
|
422
|
-
* selected by the user or in the fallback.
|
|
423
|
-
*
|
|
424
|
-
*/
|
|
425
|
-
export type IFormColumnChooserFieldDef = IFormColumnChooserSingleFieldDef | IFormColumnChooserMultipleFieldDef;
|
|
426
|
-
export type IFormColumnChooserSingleFieldDef = IFormColumnChooserBaseDef<TidyTableColumnSelector>;
|
|
427
|
-
export type IFormColumnChooserMultipleFieldDef = IFormColumnChooserBaseDef<TidyTableColumnSelector[]>;
|
|
428
|
-
interface IFormColumnChooserBaseDef<T extends TidyTableColumnSelector | TidyTableColumnSelector[]> extends IFormFieldDef<T> {
|
|
429
|
-
fieldType: "columnsChooser";
|
|
430
|
-
editorConf?: {
|
|
431
|
-
/**
|
|
432
|
-
* The user can select multiple columns / selectors
|
|
433
|
-
*/
|
|
434
|
-
multiple?: boolean;
|
|
435
|
-
/**
|
|
436
|
-
* The user can select the same column more than once
|
|
437
|
-
*/
|
|
438
|
-
allowDuplicate?: boolean;
|
|
439
|
-
/**
|
|
440
|
-
* Only columns of this/these type(s) are allowed.
|
|
441
|
-
*/
|
|
442
|
-
allowedTypes?: TidyColumnsType[];
|
|
443
|
-
/**
|
|
444
|
-
* The user can select properties of columns
|
|
445
|
-
*/
|
|
446
|
-
includeProperties?: boolean;
|
|
447
|
-
/**
|
|
448
|
-
* The user can choose a selector, see TidyTableMappingColumnSelectorOptions
|
|
449
|
-
*/
|
|
450
|
-
includeSelectors?: boolean;
|
|
451
|
-
/**
|
|
452
|
-
* The user can select columns based on their role
|
|
453
|
-
*/
|
|
454
|
-
includeRoles?: boolean;
|
|
455
|
-
/**
|
|
456
|
-
* Search the table for a default column.
|
|
457
|
-
*
|
|
458
|
-
* Set to true to use the default fallback logic:
|
|
459
|
-
*
|
|
460
|
-
* Fallback to a column that has a type that is allowed. Note, properties of columns are not considered.
|
|
461
|
-
*
|
|
462
|
-
* It finds the column to fallback on by
|
|
463
|
-
* 1. role equal to fieldPath and type is allowed,
|
|
464
|
-
* 2. role equal to editorConfig.alias and type is allowed,
|
|
465
|
-
* 3. type is allowed.
|
|
466
|
-
*
|
|
467
|
-
* Already mapped columns are skipped.
|
|
468
|
-
*
|
|
469
|
-
* You can also use your own fallback logic. The currentMapping is the object used when building the mapping
|
|
470
|
-
* from the options meta. It contains the mapped options from metas defined before this meta. Note, the order
|
|
471
|
-
* is important here.
|
|
472
|
-
*/
|
|
473
|
-
fallback?: boolean | ((table: ITidyTable, currentMapping: ChartTemplateDataMapping) => ITidyColumn[] | undefined);
|
|
474
|
-
/**
|
|
475
|
-
* In the expression editor, use the alias to reference the column. Use the alias in table.getColumnByAlias(...).
|
|
476
|
-
*/
|
|
477
|
-
alias?: string;
|
|
478
|
-
};
|
|
479
|
-
}
|
|
480
|
-
export interface IFormPropertyChooserBaseDef extends IFormFieldDef<string> {
|
|
481
|
-
fieldType: "propertyChooser";
|
|
482
|
-
editorConf?: {
|
|
483
|
-
/**
|
|
484
|
-
* Only columns of this/these type(s) are allowed.
|
|
485
|
-
*/
|
|
486
|
-
allowedTypes?: TidyColumnsType[];
|
|
487
|
-
};
|
|
488
|
-
}
|
|
489
|
-
/**
|
|
490
|
-
* @see FormFieldDef
|
|
491
|
-
*/
|
|
492
|
-
export interface IFormGranularitySelectionFieldDef extends IFormFieldDef<IFormFieldGranularityItem> {
|
|
493
|
-
fieldType: "granularityChooser";
|
|
494
|
-
editorConf: {
|
|
495
|
-
options: (table: ITidyTable) => IFormFieldGranularityItem[];
|
|
496
|
-
};
|
|
497
|
-
}
|
|
498
|
-
/**
|
|
499
|
-
* @see FormFieldDef
|
|
500
|
-
*/
|
|
501
|
-
export interface IFormColumnSelectionFieldDef extends IFormFieldDef<any> {
|
|
502
|
-
fieldType: "columnSelection";
|
|
503
|
-
editorConf: {
|
|
504
|
-
multiple?: boolean;
|
|
505
|
-
};
|
|
506
|
-
}
|
|
507
|
-
/**
|
|
508
|
-
* @see FormFieldDef
|
|
509
|
-
*/
|
|
510
|
-
export interface IFormConstantsFieldDef extends IFormFieldDef<any> {
|
|
511
|
-
fieldType: "constants";
|
|
512
|
-
}
|
|
513
|
-
/**
|
|
514
|
-
* @see FormFieldDef
|
|
515
|
-
*/
|
|
516
|
-
export type IFormEventMappingArrayFieldDefType = {
|
|
517
|
-
toEvent: string;
|
|
518
|
-
fromEvent: string;
|
|
519
|
-
}[];
|
|
520
|
-
export interface IFormEventMappingArrayFieldDef extends IFormFieldDef<IFormEventMappingArrayFieldDefType> {
|
|
521
|
-
fieldType: "eventMappingArray";
|
|
522
|
-
}
|
|
523
|
-
/**
|
|
524
|
-
* @see FormFieldDef
|
|
525
|
-
*/
|
|
526
|
-
export type IFormSearchAndReplaceArrayFieldDefType = {
|
|
527
|
-
from?: string;
|
|
528
|
-
to?: string;
|
|
529
|
-
}[];
|
|
530
|
-
export interface IFormSearchAndReplaceArrayFieldDef extends IFormFieldDef<IFormSearchAndReplaceArrayFieldDefType> {
|
|
531
|
-
fieldType: "searchAndReplaceArray";
|
|
532
|
-
}
|
|
533
|
-
/**
|
|
534
|
-
* @see FormFieldDef
|
|
535
|
-
*/
|
|
536
|
-
export type IFormEventArrayFieldDefType = {
|
|
537
|
-
event: string;
|
|
538
|
-
}[];
|
|
539
|
-
export interface IFormEventArrayFieldDef extends IFormFieldDef<IFormEventArrayFieldDefType> {
|
|
540
|
-
fieldType: "eventArray";
|
|
541
|
-
arrayField: string;
|
|
542
|
-
}
|
|
543
|
-
/**
|
|
544
|
-
* Contains the ordering of the groups.
|
|
545
|
-
*
|
|
546
|
-
* An optional (and invisible) field that is defining how the groups are ordered (does not need to contain all
|
|
547
|
-
* the groups). When none defined, the groups order depends on the field order themselves.
|
|
548
|
-
*
|
|
549
|
-
* @see FormFieldDef
|
|
550
|
-
* @see IFormBooleanFieldDef
|
|
551
|
-
*/
|
|
552
|
-
export interface IFormGroupsFieldDef extends IFormFieldDef<string[]> {
|
|
553
|
-
fieldType: "groups";
|
|
554
|
-
groups: string[];
|
|
555
|
-
}
|
|
556
|
-
/**
|
|
557
|
-
* @see FormFieldDef
|
|
558
|
-
*/
|
|
559
|
-
export interface IFormHookFieldDef<T> extends IFormFieldDef<Hook<T, any>> {
|
|
560
|
-
fieldType: "hook";
|
|
561
|
-
}
|
|
562
|
-
/**
|
|
563
|
-
* @see FormFieldDef
|
|
564
|
-
*/
|
|
565
|
-
export interface IFormJsFieldDef extends IFormFieldDef<string> {
|
|
566
|
-
fieldType: "js";
|
|
567
|
-
editorConf?: {
|
|
568
|
-
helpMdFile: string;
|
|
569
|
-
doNotCompleteEventNames?: true;
|
|
570
|
-
};
|
|
571
|
-
}
|
|
572
|
-
/**
|
|
573
|
-
* @see FormFieldDef
|
|
574
|
-
*/
|
|
575
|
-
export interface IFormJsonFieldDef extends IFormFieldDef<string> {
|
|
576
|
-
fieldType: "json";
|
|
577
|
-
editorConf?: {
|
|
578
|
-
helpMdFile: string;
|
|
579
|
-
};
|
|
580
|
-
}
|
|
581
|
-
/**
|
|
582
|
-
* @see FormFieldDef
|
|
583
|
-
*/
|
|
584
|
-
export interface IFormFileUploaderFieldDef extends IFormFieldDef<any> {
|
|
585
|
-
fieldType: "fileUploader";
|
|
586
|
-
editorConf: {
|
|
587
|
-
acceptedFileExt?: string;
|
|
588
|
-
dropMessage: string;
|
|
589
|
-
};
|
|
590
|
-
}
|
|
591
|
-
/**
|
|
592
|
-
* @see FormFieldDef
|
|
593
|
-
*/
|
|
594
|
-
export interface IFormMarkdownFieldDef extends IFormFieldDef<string> {
|
|
595
|
-
fieldType: "markdown";
|
|
596
|
-
editorConf?: {
|
|
597
|
-
singleLine: false;
|
|
598
|
-
};
|
|
599
|
-
}
|
|
600
|
-
export type MdxExpressionType = "calcMeasure" | "drilldown";
|
|
601
|
-
/**
|
|
602
|
-
* @see FormFieldDef
|
|
603
|
-
*/
|
|
604
|
-
export interface IFormMdxFieldDef extends IFormFieldDef<string> {
|
|
605
|
-
fieldType: "mdxExpression";
|
|
606
|
-
editorConf: {
|
|
607
|
-
mdxExpressionType: MdxExpressionType;
|
|
608
|
-
metaReadOnly?: boolean;
|
|
609
|
-
schemaName?: string;
|
|
610
|
-
cubeName?: string;
|
|
611
|
-
};
|
|
612
|
-
}
|
|
613
|
-
/**
|
|
614
|
-
* @see FormFieldDef
|
|
615
|
-
*/
|
|
616
|
-
export interface IFormNumberFieldDef extends IFormFieldDef<number> {
|
|
617
|
-
fieldType: "number";
|
|
618
|
-
}
|
|
619
|
-
/**
|
|
620
|
-
* @see FormFieldDef
|
|
621
|
-
*/
|
|
622
|
-
export interface IFormMaskFieldDef extends IFormFieldDef<number> {
|
|
623
|
-
fieldType: "mask";
|
|
624
|
-
editorConf: {
|
|
625
|
-
items: [number, string][];
|
|
626
|
-
name: string;
|
|
627
|
-
};
|
|
628
|
-
}
|
|
629
|
-
/**
|
|
630
|
-
* A string that is chosen from the list of available values (aka. options).
|
|
631
|
-
*
|
|
632
|
-
* Typically used to edit an "enum" where the user can select the value from a list of "localized" options.
|
|
633
|
-
* The editorConf is setup as following:
|
|
634
|
-
* <pre>
|
|
635
|
-
* editorConf: {
|
|
636
|
-
* optionValues: Object.values(SortingType),
|
|
637
|
-
* optionName: "SortingType" -- localization purpose
|
|
638
|
-
* }
|
|
639
|
-
* </pre>
|
|
640
|
-
*
|
|
641
|
-
* This editor is not limited to enum as the editorConf.optionValues is accepting a function resolving the
|
|
642
|
-
* actual list of options as an array of {id,caption} objects. E.g., editing a locale, theme, etc...
|
|
643
|
-
*
|
|
644
|
-
* Editing a list of strings is supported using the editorConf.multiple flag.
|
|
645
|
-
*
|
|
646
|
-
* @see FormFieldDef
|
|
647
|
-
*/
|
|
648
|
-
export type IFormOptionFieldDef = IFormOptionFieldMultipleDef | IFormOptionFieldSingleDef;
|
|
649
|
-
export interface IFormOptionFieldMultipleDef extends IFormFieldDef<string[]> {
|
|
650
|
-
fieldType: "option";
|
|
651
|
-
editorConf: {
|
|
652
|
-
freeSolo?: boolean;
|
|
653
|
-
multiple: true;
|
|
654
|
-
allowDuplicate?: boolean;
|
|
655
|
-
optionValues?: string[] | IOption[] | ((callback: ((suggestions: string[] | IOption[]) => void), dependsOnValue?: any) => void);
|
|
656
|
-
optionName?: string;
|
|
657
|
-
getCaption?: (id: string) => string;
|
|
658
|
-
};
|
|
659
|
-
}
|
|
660
|
-
export interface IFormOptionFieldReportPathDef extends IFormFieldDef<string> {
|
|
661
|
-
fieldType: "reportPath";
|
|
662
|
-
}
|
|
663
|
-
export interface IFormOptionFieldSingleDef extends IFormFieldDef<string> {
|
|
664
|
-
fieldType: "option";
|
|
665
|
-
editorConf: {
|
|
666
|
-
freeSolo?: boolean;
|
|
667
|
-
multiple?: false;
|
|
668
|
-
allowDuplicate?: boolean;
|
|
669
|
-
optionValues?: string[] | IOption[] | ((callback: ((suggestions: string[] | IOption[]) => void), dependsOnValue?: any) => void);
|
|
670
|
-
optionName?: string;
|
|
671
|
-
getCaption?: (id: string) => string;
|
|
672
|
-
};
|
|
673
|
-
}
|
|
674
|
-
export interface IFormEmbeddedFieldDef<T extends FormFieldObject> extends IFormFieldDef<T> {
|
|
675
|
-
fieldType: "embedded";
|
|
676
|
-
editorConf: {
|
|
677
|
-
fieldPathPrefix: string;
|
|
678
|
-
meta: FormFields<T>;
|
|
679
|
-
};
|
|
680
|
-
}
|
|
681
|
-
/**
|
|
682
|
-
* @see FormFieldDef
|
|
683
|
-
*/
|
|
684
|
-
export interface IFormPaletteEditorFieldDef extends IFormFieldDef<IPaletteDef> {
|
|
685
|
-
fieldType: "palette";
|
|
686
|
-
editorConfig?: {
|
|
687
|
-
path: string;
|
|
688
|
-
reversed: boolean;
|
|
689
|
-
};
|
|
690
|
-
}
|
|
691
|
-
/**
|
|
692
|
-
* @see FormFieldDef
|
|
693
|
-
*/
|
|
694
|
-
export interface IFormReportPathFieldDef extends IFormFieldDef<string> {
|
|
695
|
-
fieldType: "appPath" | "reportFolder" | "reportPath";
|
|
696
|
-
}
|
|
697
|
-
/**
|
|
698
|
-
* @see FormFieldDef
|
|
699
|
-
*/
|
|
700
|
-
export interface IFormReportPermaLinkFieldDef extends IFormFieldDef<string> {
|
|
701
|
-
fieldType: "reportPermaLink";
|
|
702
|
-
}
|
|
703
|
-
/**
|
|
704
|
-
* Use editorConf.suggestions to provide a list of possible values. Then the editor is an autocomplete
|
|
705
|
-
* displaying the suggestions using the freeSolo mode to enter any kind of value.
|
|
706
|
-
*
|
|
707
|
-
* @see FormFieldDef
|
|
708
|
-
*/
|
|
709
|
-
export interface IFormStringFieldDef extends IFormFieldDef<string> {
|
|
710
|
-
fieldType: "string" | "url" | "text";
|
|
711
|
-
editorConf?: {
|
|
712
|
-
/**
|
|
713
|
-
* A list of possible strings...
|
|
714
|
-
*/
|
|
715
|
-
suggestions?: string[] | ((callback: ((candidates: string[]) => void), dependsOnValue?: any) => void);
|
|
716
|
-
copyToClipboard?: boolean;
|
|
717
|
-
/**
|
|
718
|
-
* Show an error if the value is not valid. Return an empty string if the value is valid.
|
|
719
|
-
*/
|
|
720
|
-
valueValidator?: (value: any) => string;
|
|
721
|
-
};
|
|
722
|
-
}
|
|
723
|
-
export interface IFormTextFieldDef extends IFormFieldDef<string> {
|
|
724
|
-
fieldType: "text";
|
|
725
|
-
}
|
|
726
|
-
/**
|
|
727
|
-
* A Markdown text expression containing tidy table value accessor (e.g., Donut's center text).
|
|
728
|
-
* The evaluation context is the table.
|
|
729
|
-
*
|
|
730
|
-
* @see FormFieldDef
|
|
731
|
-
*/
|
|
732
|
-
export interface IFormTidyTableHtmlExprFieldDef extends IFormTidyTableExprFieldDef<"tidyTableHtmlExpr"> {
|
|
733
|
-
}
|
|
734
|
-
/**
|
|
735
|
-
* An Markdown text expression containing tidy table value accessor (e.g., chart's tooltip).
|
|
736
|
-
* The evaluation context is a row.
|
|
737
|
-
*
|
|
738
|
-
* @see FormFieldDef
|
|
739
|
-
*/
|
|
740
|
-
export interface IFormTidyTableHtmlRowExprFieldDef extends IFormTidyTableExprFieldDef<"tidyTableHtmlRowExpr"> {
|
|
741
|
-
}
|
|
742
|
-
/**
|
|
743
|
-
* A numeric expression containing tidy table value accessor (e.g., chart's value axis minimum).
|
|
744
|
-
* The evaluation context is the table.
|
|
745
|
-
*
|
|
746
|
-
* @see FormFieldDef
|
|
747
|
-
*/
|
|
748
|
-
export interface IFormTidyTableNumericExprFieldDef extends IFormTidyTableExprFieldDef<"tidyTableNumericExpr"> {
|
|
749
|
-
}
|
|
750
|
-
/**
|
|
751
|
-
* A string expression containing tidy table value accessor (e.g., chart's value axis minimum).
|
|
752
|
-
* The evaluation context is the table.
|
|
753
|
-
*
|
|
754
|
-
* @see FormFieldDef
|
|
755
|
-
*/
|
|
756
|
-
export interface IFormTidyTableStringRowExprFieldDef extends IFormTidyTableExprFieldDef<"tidyTableStringRowExpr"> {
|
|
757
|
-
}
|
|
758
|
-
/**
|
|
759
|
-
* A color (i.e., string) expression containing tidy table value accessor (e.g., chart's value axis minimum).
|
|
760
|
-
* The evaluation context is the table.
|
|
761
|
-
*
|
|
762
|
-
* @see FormFieldDef
|
|
763
|
-
*/
|
|
764
|
-
export interface IFormTidyTableColorRowExprFieldDef extends IFormTidyTableExprFieldDef<"tidyTableColorRowExpr"> {
|
|
765
|
-
}
|
|
766
|
-
/**
|
|
767
|
-
* A numeric expression containing tidy table value accessor (e.g., chart's value axis minimum).
|
|
768
|
-
* The evaluation context is a row.
|
|
769
|
-
*
|
|
770
|
-
* @see FormFieldDef
|
|
771
|
-
*/
|
|
772
|
-
export interface IFormTidyTableNumericRowExprFieldDef extends IFormTidyTableExprFieldDef<"tidyTableNumericRowExpr"> {
|
|
773
|
-
}
|
|
774
|
-
/**
|
|
775
|
-
* A numeric expression containing tidy table value accessor (e.g., chart's value axis minimum).
|
|
776
|
-
* The evaluation context is a column.
|
|
777
|
-
*
|
|
778
|
-
* @see FormFieldDef
|
|
779
|
-
*/
|
|
780
|
-
export interface IFormTidyTableNumericJSColumnExprFieldDef extends IFormTidyTableExprFieldDef<"tidyTableNumericJSColumnExpr"> {
|
|
781
|
-
}
|
|
782
|
-
/**
|
|
783
|
-
* A numeric expression containing tidy table value accessor (e.g., chart's value axis minimum).
|
|
784
|
-
* The evaluation context is a row.
|
|
785
|
-
*
|
|
786
|
-
* @see FormFieldDef
|
|
787
|
-
*/
|
|
788
|
-
export interface IFormTidyTableScaleRowExprFieldDef extends IFormTidyTableExprFieldDef<"tidyTableScaleRowExpr"> {
|
|
789
|
-
}
|
|
790
|
-
/**
|
|
791
|
-
* A text expression containing tidy table value accessor (e.g., Donut's center text).
|
|
792
|
-
* The evaluation context is the table.
|
|
793
|
-
*
|
|
794
|
-
* @see FormFieldDef
|
|
795
|
-
*/
|
|
796
|
-
export interface IFormTidyTableTextExprFieldDef extends IFormTidyTableExprFieldDef<"tidyTableTextExpr"> {
|
|
797
|
-
}
|
|
798
|
-
/**
|
|
799
|
-
* A text expression containing tidy table value accessor (e.g., cell renderer link).
|
|
800
|
-
* The evaluation context is a row.
|
|
801
|
-
*
|
|
802
|
-
* @see FormFieldDef
|
|
803
|
-
*/
|
|
804
|
-
export interface IFormTidyTableTextRowExprFieldDef extends IFormTidyTableExprFieldDef<"tidyTableTextRowExpr"> {
|
|
805
|
-
}
|
|
806
|
-
/**
|
|
807
|
-
* A text expression containing tidy table value accessor (e.g., cell renderer link).
|
|
808
|
-
* The evaluation context is a column.
|
|
809
|
-
*
|
|
810
|
-
* @see FormFieldDef
|
|
811
|
-
*/
|
|
812
|
-
export interface IFormTidyTableNumericStringColumnExprFieldDef extends IFormTidyTableExprFieldDef<"tidyTableNumericStringColumnExpr"> {
|
|
813
|
-
}
|
|
814
|
-
/**
|
|
815
|
-
* icCube variants (defined in the theme's ic3.widgetVariants).
|
|
816
|
-
*
|
|
817
|
-
* @see FormFieldDef
|
|
818
|
-
*/
|
|
819
|
-
export interface IFormWidgetVariantFieldDef extends IFormFieldDef<string> {
|
|
820
|
-
fieldType: "widgetVariant";
|
|
821
|
-
editorConf?: {
|
|
822
|
-
componentName: string;
|
|
823
|
-
predefinedVariants?: string[];
|
|
824
|
-
};
|
|
825
|
-
}
|
|
826
|
-
export interface IFormFormatterPickerFieldDef extends IFormFieldDef<string> {
|
|
827
|
-
fieldType: "formatterPicker";
|
|
828
|
-
}
|
|
829
|
-
/**
|
|
830
|
-
* @see FormFieldDef
|
|
831
|
-
*/
|
|
832
|
-
export declare enum ConditionalRuleOperators {
|
|
833
|
-
EQUALS = "EQUALS",
|
|
834
|
-
NOT_EQUALS = "NOT_EQUALS",
|
|
835
|
-
GREATER_THAN = "GREATER_THAN",
|
|
836
|
-
GREATER_EQUAL_THAN = "GREATER_EQUAL_THAN",
|
|
837
|
-
SMALLER_THAN = "SMALLER_THAN",
|
|
838
|
-
SMALLER_EQUAL_THAN = "SMALLER_EQUAL_THAN",
|
|
839
|
-
CONTAINS = "CONTAINS",
|
|
840
|
-
NOT_CONTAINS = "NOT_CONTAINS",
|
|
841
|
-
STARTS_WITH = "STARTS_WITH",
|
|
842
|
-
ENDS_WITH = "ENDS_WITH"
|
|
843
|
-
}
|
|
844
|
-
export interface IFormConditionalColorRule {
|
|
845
|
-
operator: ConditionalRuleOperators;
|
|
846
|
-
value?: string;
|
|
847
|
-
color?: IColorDef;
|
|
848
|
-
}
|
|
849
|
-
export interface IFormConditionalColorRulesFieldDef extends IFormFieldDef<IFormConditionalColorRule[]> {
|
|
850
|
-
fieldType: "conditionalColorRules";
|
|
851
|
-
}
|
|
852
|
-
/**
|
|
853
|
-
* @see FormFieldDef
|
|
854
|
-
*/
|
|
855
|
-
export interface IFormFilterPanelModelSelectorFieldDef extends IFormFieldDef<string> {
|
|
856
|
-
fieldType: "filterPanelModelSelector";
|
|
857
|
-
}
|
|
858
|
-
export type LocalizeContext = Pick<IPublicContext, 'localize'>;
|
|
859
|
-
export interface IFormShortcutChooserDef<T extends string | string[]> extends IFormFieldDef<T> {
|
|
860
|
-
fieldType: "shortcutChooser";
|
|
861
|
-
editorConf?: {
|
|
862
|
-
getOptions: (deps: any, theme: Theme, context: LocalizeContext) => IOption[];
|
|
863
|
-
};
|
|
864
|
-
}
|
|
865
|
-
export type FormFieldDef = IFormAutocompleteFieldDef<any> | IFormBooleanFieldDef | IFormColorEditorFieldDef | IFormColumnChooserFieldDef | IFormColumnSelectionFieldDef | IFormConstantsFieldDef | IFormEventArrayFieldDef | IFormEventMappingArrayFieldDef | IFormFileUploaderFieldDef | IFormGroupsFieldDef | IFormJsFieldDef | IFormMarkdownFieldDef | IFormMaskFieldDef | IFormMdxFieldDef | IFormNumberFieldDef | IFormOptionFieldDef | IFormOptionFieldSingleDef | IFormOptionFieldMultipleDef | IFormPaletteEditorFieldDef | IFormReportPathFieldDef | IFormReportPermaLinkFieldDef | IFormStringFieldDef | IFormTidyTableHtmlExprFieldDef | IFormTidyTableHtmlRowExprFieldDef | IFormTidyTableNumericExprFieldDef | IFormTidyTableNumericRowExprFieldDef | IFormTidyTableStringRowExprFieldDef | IFormTidyTableColorRowExprFieldDef | IFormTidyTableScaleRowExprFieldDef | IFormTidyTableTextExprFieldDef | IFormTidyTableTextRowExprFieldDef | IFormWidgetVariantFieldDef | IFormFormatterPickerFieldDef | IFormGranularitySelectionFieldDef | IFormSearchAndReplaceArrayFieldDef | IFormPropertyChooserBaseDef | IFormLayoutFieldDef | IFormConditionalColorRulesFieldDef | IFormFilterPanelModelSelectorFieldDef | IFormShortcutChooserDef<any>;
|
|
866
|
-
export {};
|