@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
package/dist/PublicTemplate.d.ts
DELETED
|
@@ -1,630 +0,0 @@
|
|
|
1
|
-
import { ITidyTable } from "./PublicTidyTable";
|
|
2
|
-
import { ITidyTableInteraction } from "./PublicTidyTableInteractions";
|
|
3
|
-
import { IWidgetPublicContext } from "./PublicContext";
|
|
4
|
-
import { FormFieldObject, FormFields, IFormColumnChooserFieldDef } from "./PublicTemplateForm";
|
|
5
|
-
import { IWidgetVariantManager } from "./IWidgetVariantManager";
|
|
6
|
-
import { ReactElement } from "react";
|
|
7
|
-
import { Theme } from "@mui/material/styles";
|
|
8
|
-
import { WidgetTemplateChartOptions, WidgetTemplateIDs } from "./PublicTemplates";
|
|
9
|
-
import { ChartTemplateDataMapping, IFormFieldGranularityItem } from "./PublicTidyTableTypes";
|
|
10
|
-
import { PositionModeOptions, ResizingConstraintOptions } from "./theme/ThemeWidgetBox";
|
|
11
|
-
import { QueryType } from "./ITypes";
|
|
12
|
-
import { ILogger } from "./Logger";
|
|
13
|
-
export interface IRectanglePosition {
|
|
14
|
-
top: number;
|
|
15
|
-
left: number;
|
|
16
|
-
}
|
|
17
|
-
export interface IRectangleSize {
|
|
18
|
-
height: number;
|
|
19
|
-
width: number;
|
|
20
|
-
}
|
|
21
|
-
export interface IRectangle extends IRectanglePosition, IRectangleSize {
|
|
22
|
-
}
|
|
23
|
-
/**
|
|
24
|
-
* Widget box configuration when the widget is rendered in the responsive grid layout.
|
|
25
|
-
* This is used instead of the regular rectangle and positionOrder configuration.
|
|
26
|
-
*/
|
|
27
|
-
export interface IWidgetBoxGridLayoutInfo {
|
|
28
|
-
/**
|
|
29
|
-
* Handy (same as in IWidgetDefinition).
|
|
30
|
-
*/
|
|
31
|
-
widgetId: string;
|
|
32
|
-
/**
|
|
33
|
-
* The responsive grid layout is made of a single flex (row) box.
|
|
34
|
-
* The index in the only row of the 'flex' layout.
|
|
35
|
-
*/
|
|
36
|
-
position: number;
|
|
37
|
-
/**
|
|
38
|
-
* A part of the total number of columns in the 'flex' layout.
|
|
39
|
-
*/
|
|
40
|
-
colSpan: number;
|
|
41
|
-
/**
|
|
42
|
-
* The actual physical height.
|
|
43
|
-
*/
|
|
44
|
-
height: number;
|
|
45
|
-
/**
|
|
46
|
-
* The group (i.e., nested grid layout) this widget belongs to.
|
|
47
|
-
*/
|
|
48
|
-
group?: IWidgetBoxGroupGridLayoutInfo;
|
|
49
|
-
}
|
|
50
|
-
/**
|
|
51
|
-
* Support for nested grid layout : a grid item can be a group of widgets rendered as a grid layout.
|
|
52
|
-
*
|
|
53
|
-
* The actual number of columns of this nested grid layout is the colSpan of the group seen as a regular
|
|
54
|
-
* item of the containing grid layout. The group inherit both the column and row spacing of its containing
|
|
55
|
-
* grid layout and has no margin.
|
|
56
|
-
*
|
|
57
|
-
* For the sake of simplicity a group cannot contain a group.
|
|
58
|
-
*/
|
|
59
|
-
export interface IWidgetBoxGroupGridLayoutInfo {
|
|
60
|
-
groupId: string;
|
|
61
|
-
/**
|
|
62
|
-
* A group is a regular item of its containing grid layout.
|
|
63
|
-
* @see IWidgetBoxGridLayoutInfo
|
|
64
|
-
*/
|
|
65
|
-
position: number;
|
|
66
|
-
/**
|
|
67
|
-
* A group is a regular item of its containing grid layout.
|
|
68
|
-
* @see IWidgetBoxGridLayoutInfo
|
|
69
|
-
*/
|
|
70
|
-
colSpan: number;
|
|
71
|
-
/**
|
|
72
|
-
* A group is a regular item of its containing grid layout.
|
|
73
|
-
* @see IWidgetBoxGridLayoutInfo
|
|
74
|
-
*/
|
|
75
|
-
height: number;
|
|
76
|
-
}
|
|
77
|
-
export interface IWidgetLayoutData {
|
|
78
|
-
/**
|
|
79
|
-
* Keep box header settings for additional (i.e., generated) pages.
|
|
80
|
-
*/
|
|
81
|
-
keepBoxHeader: boolean;
|
|
82
|
-
/**
|
|
83
|
-
* Keep box header settings for additional (i.e., generated) pages.
|
|
84
|
-
*/
|
|
85
|
-
keepTableHeader: boolean;
|
|
86
|
-
startRow: number;
|
|
87
|
-
endRow: number;
|
|
88
|
-
}
|
|
89
|
-
export interface IWidgetLayoutInfo extends IRectangle {
|
|
90
|
-
pageNb: number;
|
|
91
|
-
positionOrder: number;
|
|
92
|
-
gridLayoutInfo?: IWidgetBoxGridLayoutInfo;
|
|
93
|
-
data?: IWidgetLayoutData;
|
|
94
|
-
resizingConstraint?: ResizingConstraintOptions;
|
|
95
|
-
positionMode?: PositionModeOptions;
|
|
96
|
-
/**
|
|
97
|
-
* When _ printing _, the widget's layout has been converted and this scale has been applied to compute
|
|
98
|
-
* the new widget size.
|
|
99
|
-
*/
|
|
100
|
-
widgetContentScaled?: number;
|
|
101
|
-
}
|
|
102
|
-
export type IPublicWidgetTemplateDefinition<T extends FormFieldObject> = IPublicWidgetReactTemplateDefinition<T> | IPublicWidgetJsTemplateDefinition<T>;
|
|
103
|
-
export declare enum IWidgetTemplateMdxBuilderAxisPropsConstraint {
|
|
104
|
-
DateType = "DateType",
|
|
105
|
-
GeoLatLong = "GeoLatLong",
|
|
106
|
-
GeoIso2Code = "GeoIso2Code"
|
|
107
|
-
}
|
|
108
|
-
export interface IWidgetTemplateMdxBuilderAxisProps {
|
|
109
|
-
/**
|
|
110
|
-
* Unique name used in the UI and if mdxAxisName not defined for building the query.
|
|
111
|
-
* If name is 'rows' for example, then in the query it will use 'ON "rows"'.
|
|
112
|
-
*/
|
|
113
|
-
name: string;
|
|
114
|
-
/**
|
|
115
|
-
* The axis can be empty
|
|
116
|
-
*/
|
|
117
|
-
isOptional?: true;
|
|
118
|
-
/**
|
|
119
|
-
* All axes with the same (not null) value for mdxAxisName are put as a tuple on the same axis. And the roles are
|
|
120
|
-
* comma separated.
|
|
121
|
-
*/
|
|
122
|
-
mdxAxisName?: string;
|
|
123
|
-
/**
|
|
124
|
-
* Disable empty
|
|
125
|
-
*/
|
|
126
|
-
disableNonEmpty?: true;
|
|
127
|
-
/**
|
|
128
|
-
* For filters add lazy load feature to the axis.
|
|
129
|
-
*/
|
|
130
|
-
withLazySearch?: true;
|
|
131
|
-
/**
|
|
132
|
-
* Allow only a single member
|
|
133
|
-
*/
|
|
134
|
-
singleMember?: true;
|
|
135
|
-
/**
|
|
136
|
-
* Allow a multiple hierarchies to build a crossjoin
|
|
137
|
-
*/
|
|
138
|
-
multipleHierarchy?: true;
|
|
139
|
-
/**
|
|
140
|
-
* Additional constraints for the set/members
|
|
141
|
-
*/
|
|
142
|
-
constraint?: IWidgetTemplateMdxBuilderAxisPropsConstraint;
|
|
143
|
-
decoration?: {
|
|
144
|
-
with?: string;
|
|
145
|
-
set: string;
|
|
146
|
-
};
|
|
147
|
-
/**
|
|
148
|
-
* Show the mdxAxis names in this order in the builder
|
|
149
|
-
*/
|
|
150
|
-
showOrder?: number;
|
|
151
|
-
/**
|
|
152
|
-
* Allows to overwrite the ON "rows"in the MDX query (to be used on modifyDefinition function)
|
|
153
|
-
*/
|
|
154
|
-
overwriteAxisName?: string;
|
|
155
|
-
/**
|
|
156
|
-
* This is used to give end customers information on the limit of the query (column have 1000 by default, rows 100'000)
|
|
157
|
-
*/
|
|
158
|
-
infoForSizing?: "TIDY_ROW" | "TIDY_COL";
|
|
159
|
-
}
|
|
160
|
-
export interface IWidgetTemplateMdxBuilderMapping {
|
|
161
|
-
/**
|
|
162
|
-
* The order determines the order of the statements in the query. E.g., the first position is ON 0, the second ON 1,
|
|
163
|
-
* etc., where '0' and '1' are replaced by the name.
|
|
164
|
-
*/
|
|
165
|
-
mdxAxis: Readonly<IWidgetTemplateMdxBuilderAxisProps[]>;
|
|
166
|
-
/**
|
|
167
|
-
* The generated MDX is for a filter (the cell values are not of interest).
|
|
168
|
-
*/
|
|
169
|
-
mdxIsForFilter?: true;
|
|
170
|
-
/**
|
|
171
|
-
* The cell values are not needed.
|
|
172
|
-
*/
|
|
173
|
-
withoutCellValues?: true;
|
|
174
|
-
/**
|
|
175
|
-
* The cell values are not needed if there is a single axis in the query.
|
|
176
|
-
*/
|
|
177
|
-
withoutCellValuesSingleAxis?: true;
|
|
178
|
-
/**
|
|
179
|
-
* An MDX query if the builder is empty.
|
|
180
|
-
*/
|
|
181
|
-
mdxQueryIfEmpty?: boolean;
|
|
182
|
-
/**
|
|
183
|
-
* model is a IMdxQueryBuilderModel, that is not shared publicly yet
|
|
184
|
-
*
|
|
185
|
-
* returns a modified definition or an MDX statement in a string
|
|
186
|
-
*
|
|
187
|
-
* If we return a string (MDX Statement), the Filters are still going to be appended to the end
|
|
188
|
-
*/
|
|
189
|
-
modifyDefinition?: (model: any, definition: IWidgetTemplateMdxBuilderMapping) => IWidgetTemplateMdxBuilderMapping | string;
|
|
190
|
-
}
|
|
191
|
-
/**
|
|
192
|
-
* A widget that renders using React.
|
|
193
|
-
*
|
|
194
|
-
* @see FormFieldObject
|
|
195
|
-
*/
|
|
196
|
-
export interface IPublicReactChartTemplate<T extends FormFieldObject> {
|
|
197
|
-
/**
|
|
198
|
-
* @param data the actual result of the widget's query
|
|
199
|
-
* @param options the options (possibly edited and/or from the theme) of this widget
|
|
200
|
-
* @param header aka. widget title
|
|
201
|
-
*/
|
|
202
|
-
reactElement: (data: IWidgetTemplateTidyData, options: T, header: string) => ReactElement;
|
|
203
|
-
}
|
|
204
|
-
/**
|
|
205
|
-
* A widget that renders using plain Javascript/Typescript.
|
|
206
|
-
*
|
|
207
|
-
* @see FormFieldObject
|
|
208
|
-
*/
|
|
209
|
-
export interface IPublicJsChartTemplate<T extends FormFieldObject> {
|
|
210
|
-
/**
|
|
211
|
-
* @param data the actual result of the widget's query
|
|
212
|
-
* @param options the options (possibly edited and/or from the theme) of this widget
|
|
213
|
-
* @param header aka. widget title
|
|
214
|
-
*/
|
|
215
|
-
renderJS: (data: IWidgetTemplateTidyData, options: T, header: string) => void;
|
|
216
|
-
renderOnResizeJS?: (data: IWidgetTemplateTidyData, options: T, header: string, info: IWidgetLayoutInfo) => void;
|
|
217
|
-
dispose: () => void;
|
|
218
|
-
}
|
|
219
|
-
export interface IPublicWidgetReactProps<OPTIONS> {
|
|
220
|
-
wContext: IWidgetPublicContext;
|
|
221
|
-
data: IWidgetTemplateTidyData;
|
|
222
|
-
options: OPTIONS;
|
|
223
|
-
widgetHeader: string;
|
|
224
|
-
}
|
|
225
|
-
export interface IPublicErrorDefinition {
|
|
226
|
-
/**
|
|
227
|
-
* e.g. a user defined javascript error vs a programming error
|
|
228
|
-
*/
|
|
229
|
-
expected?: boolean;
|
|
230
|
-
name: string;
|
|
231
|
-
args?: any[];
|
|
232
|
-
cause?: any;
|
|
233
|
-
}
|
|
234
|
-
export interface IPublicWidgetReactMdxResultOnErrorProps {
|
|
235
|
-
error: IPublicErrorDefinition;
|
|
236
|
-
}
|
|
237
|
-
/**
|
|
238
|
-
*
|
|
239
|
-
*
|
|
240
|
-
* @see IPublicReactChartTemplate
|
|
241
|
-
* @see FormFieldObject
|
|
242
|
-
*/
|
|
243
|
-
export interface IPublicWidgetReactTemplateDefinition<OPTIONS extends FormFieldObject> extends IPublicCommonWidgetTemplateDefinition<OPTIONS> {
|
|
244
|
-
/**
|
|
245
|
-
* Deprecated: use reactEl instead.
|
|
246
|
-
*/
|
|
247
|
-
jsCode?: (context: IWidgetPublicContext) => IPublicReactChartTemplate<OPTIONS>;
|
|
248
|
-
/**
|
|
249
|
-
* The React Hook component (function with props as parameter)
|
|
250
|
-
*/
|
|
251
|
-
reactEl?: React.FunctionComponent<IPublicWidgetReactProps<OPTIONS>>;
|
|
252
|
-
reactElMdxResultOnError?: React.FunctionComponent<IPublicWidgetReactMdxResultOnErrorProps>;
|
|
253
|
-
reactComponent: true;
|
|
254
|
-
/**
|
|
255
|
-
* Only the widget template meta information is required when starting the application.
|
|
256
|
-
*
|
|
257
|
-
* This method gives the opportunity for a widget template to load (Webpack) its actual jsCode logic when required.
|
|
258
|
-
* For example, AmCharts 4 widgets are loading the AmCharts 4 actual JS libraries once their rendering is actually
|
|
259
|
-
* required.
|
|
260
|
-
*
|
|
261
|
-
* @param definitionW a resolved wrapped widget (extending widget).
|
|
262
|
-
*/
|
|
263
|
-
resolveDefinition?: (definitionW?: IPublicWidgetTemplateDefinition<any>) => Promise<IPublicWidgetTemplateDefinition<OPTIONS>>;
|
|
264
|
-
}
|
|
265
|
-
/**
|
|
266
|
-
* The definition of a widget that renders using plain Javascript/Typescript.
|
|
267
|
-
*
|
|
268
|
-
* @see IPublicJsChartTemplate
|
|
269
|
-
* @see FormFieldObject
|
|
270
|
-
*/
|
|
271
|
-
export interface IPublicWidgetJsTemplateDefinition<OPTIONS extends FormFieldObject> extends IPublicCommonWidgetTemplateDefinition<OPTIONS> {
|
|
272
|
-
/**
|
|
273
|
-
* Actual widget rendering logic.
|
|
274
|
-
*/
|
|
275
|
-
jsCode: (context: IWidgetPublicContext, container: HTMLDivElement) => IPublicJsChartTemplate<OPTIONS>;
|
|
276
|
-
reactComponent?: false;
|
|
277
|
-
/**
|
|
278
|
-
* Only the widget template meta information is required when starting the application.
|
|
279
|
-
*
|
|
280
|
-
* This method gives the opportunity for a widget template to load (Webpack) its actual jsCode logic when required.
|
|
281
|
-
* For example, AmCharts 4 widgets are loading the AmCharts 4 actual JS libraries once their rendering is actually
|
|
282
|
-
* required.
|
|
283
|
-
*
|
|
284
|
-
* @param definitionW a resolved wrapped widget (extending widget).
|
|
285
|
-
*/
|
|
286
|
-
resolveDefinition?: (definitionW?: IPublicWidgetTemplateDefinition<any>) => Promise<IPublicWidgetTemplateDefinition<OPTIONS>>;
|
|
287
|
-
}
|
|
288
|
-
/**
|
|
289
|
-
* Definition - static - of a widget template
|
|
290
|
-
*/
|
|
291
|
-
interface IPublicCommonWidgetTemplateDefinition<OPTIONS extends FormFieldObject> {
|
|
292
|
-
/**
|
|
293
|
-
* [BETA]
|
|
294
|
-
*
|
|
295
|
-
* Introduced to tag a template as part of the AI [BETA] features.
|
|
296
|
-
* Currently used to filter out the template when AI not enabled.
|
|
297
|
-
*/
|
|
298
|
-
ai?: true;
|
|
299
|
-
/**
|
|
300
|
-
* Used for finding the right documentation of `typeForHelp` is not defined.
|
|
301
|
-
* Determine the widget icon in the widget infos.
|
|
302
|
-
*/
|
|
303
|
-
type: WidgetTemplateDefinitionType;
|
|
304
|
-
/**
|
|
305
|
-
* Used for finding the right documentation (override `type`).
|
|
306
|
-
*/
|
|
307
|
-
typeForHelp?: WidgetTemplateDefinitionType;
|
|
308
|
-
/**
|
|
309
|
-
* Unique within the plugin. Must not contain any dot (this is NOT the templateId)
|
|
310
|
-
*
|
|
311
|
-
* The widget chooser is using that id to localize its name and description.
|
|
312
|
-
*
|
|
313
|
-
* <pre>
|
|
314
|
-
* plugin-id.id.$caption, ...
|
|
315
|
-
* plugin-id.id.$caption.description, ...
|
|
316
|
-
* </pre>
|
|
317
|
-
*/
|
|
318
|
-
id: string;
|
|
319
|
-
/**
|
|
320
|
-
* Internal usage: while investigating lazy registration (setup upon registration).
|
|
321
|
-
*/
|
|
322
|
-
debug?: string;
|
|
323
|
-
/**
|
|
324
|
-
* Internal usage: the wrapped pluginId.templateId (setup upon registration).
|
|
325
|
-
*/
|
|
326
|
-
wrapped?: string;
|
|
327
|
-
/**
|
|
328
|
-
* Internal usage: pluginId.templateId (setup upon registration).
|
|
329
|
-
*/
|
|
330
|
-
qualifiedId?: string;
|
|
331
|
-
/**
|
|
332
|
-
* Internal usage: pluginId (setup upon registration).
|
|
333
|
-
*/
|
|
334
|
-
pluginId?: string;
|
|
335
|
-
/**
|
|
336
|
-
* Used for localization right now.
|
|
337
|
-
*
|
|
338
|
-
* The widget chooser is using that id to localize its name.
|
|
339
|
-
*
|
|
340
|
-
* <pre>
|
|
341
|
-
* plugin-id.$groupId, ...
|
|
342
|
-
* </pre>
|
|
343
|
-
*
|
|
344
|
-
* Should you like to reuse an existing group, localize the group using an existing one:
|
|
345
|
-
*
|
|
346
|
-
* <pre>
|
|
347
|
-
* MyPlugin.$myMaps, Maps
|
|
348
|
-
* </pre>
|
|
349
|
-
*
|
|
350
|
-
* then widgets defined ih the group "myMaps" of the plugin whose id=MyPlugin will be shown
|
|
351
|
-
* in the "Maps" group in the widget chooser.
|
|
352
|
-
*/
|
|
353
|
-
groupId: string;
|
|
354
|
-
/**
|
|
355
|
-
* A way to ensure we do not display in the widget chooser templates that cannot
|
|
356
|
-
* be used because the rendering depends on a given theme.
|
|
357
|
-
*/
|
|
358
|
-
dependsOnTheme?: string;
|
|
359
|
-
/**
|
|
360
|
-
* A sort of "preview" of the widget in the widget chooser. Providing an empty string will display a default image.
|
|
361
|
-
*
|
|
362
|
-
* <pre>
|
|
363
|
-
* import donut from "./images/donut.svg";
|
|
364
|
-
*
|
|
365
|
-
* {
|
|
366
|
-
* image: "donut",
|
|
367
|
-
* }
|
|
368
|
-
* </pre>
|
|
369
|
-
*/
|
|
370
|
-
image: string;
|
|
371
|
-
/**
|
|
372
|
-
* No widget box decoration.
|
|
373
|
-
*/
|
|
374
|
-
noDecoration?: boolean;
|
|
375
|
-
/**
|
|
376
|
-
* No widget *** box *** header (aka. title) is rendered. This widget template is taking care of it.
|
|
377
|
-
*/
|
|
378
|
-
withoutHeader?: boolean;
|
|
379
|
-
/**
|
|
380
|
-
* No title is being edited/rendered.
|
|
381
|
-
*/
|
|
382
|
-
withoutTitle?: boolean;
|
|
383
|
-
/**
|
|
384
|
-
* This widget does not require any query for rendering.
|
|
385
|
-
*/
|
|
386
|
-
withoutQuery?: boolean;
|
|
387
|
-
withoutSelection?: boolean;
|
|
388
|
-
withoutInitialSelection?: boolean;
|
|
389
|
-
withoutDrilldown?: boolean;
|
|
390
|
-
withoutEvents?: boolean;
|
|
391
|
-
withoutUserMenu?: boolean;
|
|
392
|
-
withoutGlobalFilter?: boolean;
|
|
393
|
-
/**
|
|
394
|
-
* Otherwise the widget box is rendering a floating icon to mention some data errors.
|
|
395
|
-
*/
|
|
396
|
-
handleCellsOnError?: boolean;
|
|
397
|
-
renderIfNotInViewport?: boolean;
|
|
398
|
-
/**
|
|
399
|
-
* This widget needs to render even if its query has not been executed yet. The default is false.
|
|
400
|
-
*/
|
|
401
|
-
renderIfQueryNotExecuted?: boolean;
|
|
402
|
-
/**
|
|
403
|
-
* Whether or not this widget can expand vertically according to its actual data
|
|
404
|
-
* (e.g., table, repetition widget).
|
|
405
|
-
*/
|
|
406
|
-
withOptionAutoExpand?: boolean;
|
|
407
|
-
/**
|
|
408
|
-
* When auto-expand applies and the layout is multi-page, this options controls whether the table
|
|
409
|
-
* header is repeating on each page.
|
|
410
|
-
*/
|
|
411
|
-
withOptionAutoExpandKeepTableHeader?: boolean;
|
|
412
|
-
withOptionAutoExpandHeightNotDependingOnWidth?: boolean;
|
|
413
|
-
/**
|
|
414
|
-
* If and only if not null, hide option 'Interactions' > 'Drilldown' > 'Pivot Table Like' and set it default value to withDrilldownPivotTableLikeAs.
|
|
415
|
-
*/
|
|
416
|
-
withDrilldownPivotTableLikeAs?: boolean;
|
|
417
|
-
/**
|
|
418
|
-
* Extra options for in the widgets user menu when in viewer mode.
|
|
419
|
-
*/
|
|
420
|
-
userMenuOptions?: string[];
|
|
421
|
-
/**
|
|
422
|
-
* Additional widget user menu options when in editing mode.
|
|
423
|
-
*/
|
|
424
|
-
userMenuOptionsOnEditing?: string[];
|
|
425
|
-
/**
|
|
426
|
-
* Disables the user menu option to switch between selection and drilldown
|
|
427
|
-
*
|
|
428
|
-
* E.g a Pivot table can manage both modes
|
|
429
|
-
*/
|
|
430
|
-
userMenuDisableInteractionMode?: boolean;
|
|
431
|
-
/**
|
|
432
|
-
* This widget knows how to render a result without any data.
|
|
433
|
-
*/
|
|
434
|
-
handlesNoData?: boolean;
|
|
435
|
-
/**
|
|
436
|
-
* This widget knows how to render when it has an empty query result.
|
|
437
|
-
*/
|
|
438
|
-
handlesEmptyQuery?: boolean;
|
|
439
|
-
/**
|
|
440
|
-
* When the widget is just created, it shows an edit widget button. Set true here to show the widget instead.
|
|
441
|
-
*/
|
|
442
|
-
canRenderWithoutUserConfig?: boolean;
|
|
443
|
-
/**
|
|
444
|
-
* This widget is responsible to notify its rendered status. Required with asynchronous rendering
|
|
445
|
-
* (e.g., Google maps).
|
|
446
|
-
*
|
|
447
|
-
* @see IWidgetPublicContext#onWidgetRenderStatusChange
|
|
448
|
-
*/
|
|
449
|
-
handlesWidgetStatus?: boolean;
|
|
450
|
-
eventRoles?: ITemplateEventActionDef;
|
|
451
|
-
selection?: {
|
|
452
|
-
/**
|
|
453
|
-
* The default selection granularity.
|
|
454
|
-
*/
|
|
455
|
-
defaultGranularityItems?: IFormFieldGranularityItem[];
|
|
456
|
-
/**
|
|
457
|
-
* The list of columns/roles that can be part of the selection granularity. The granularity editor shows
|
|
458
|
-
* when there are 2 or more roles.
|
|
459
|
-
*/
|
|
460
|
-
granularityItems?: (table: ITidyTable) => IFormFieldGranularityItem[];
|
|
461
|
-
};
|
|
462
|
-
mdxBuilderSettings?: IWidgetTemplateMdxBuilderMapping;
|
|
463
|
-
/**
|
|
464
|
-
* Setup how to get default mappings from the table and options for this widget.
|
|
465
|
-
* If undefined, it uses the default fallback logic.
|
|
466
|
-
*
|
|
467
|
-
* Note, the mapping keys must be in lower case.
|
|
468
|
-
*/
|
|
469
|
-
defaultMapping?: (data: IWidgetTemplateTidyOptions<OPTIONS>) => ChartTemplateDataMapping;
|
|
470
|
-
/**
|
|
471
|
-
* The meta information required for editing the widget options.
|
|
472
|
-
*/
|
|
473
|
-
chartOptionsMeta?: FormFields<OPTIONS>;
|
|
474
|
-
/**
|
|
475
|
-
* An optional hook that allows for modifying the chart options passed as parameter.
|
|
476
|
-
* Used when extending existing widget definition.
|
|
477
|
-
*/
|
|
478
|
-
hookChartOptions?: (options: any) => any;
|
|
479
|
-
/**
|
|
480
|
-
* When registering a variant add the following field editor meta:
|
|
481
|
-
* <pre>
|
|
482
|
-
* widgetVariant: {
|
|
483
|
-
* fieldType: "widgetVariant",
|
|
484
|
-
* localizationTag: "variant" // icCube localization,
|
|
485
|
-
* },
|
|
486
|
-
* </pre>
|
|
487
|
-
*/
|
|
488
|
-
registerVariants?: (theme: Theme, manager: IWidgetVariantManager) => void;
|
|
489
|
-
/**
|
|
490
|
-
* e.g., amCharts4.
|
|
491
|
-
* */
|
|
492
|
-
lazyLibs?: string;
|
|
493
|
-
/**
|
|
494
|
-
* Whether or not that component is using React for rendering.
|
|
495
|
-
*/
|
|
496
|
-
reactComponent?: boolean;
|
|
497
|
-
/**
|
|
498
|
-
* Only the widget template meta information is required when starting the application.
|
|
499
|
-
*
|
|
500
|
-
* This method gives the opportunity for a widget template to load (Webpack) its actual jsCode logic when required.
|
|
501
|
-
* For example, AmCharts 4 widgets are loading the AmCharts 4 actual JS libraries once their rendering is actually
|
|
502
|
-
* required.
|
|
503
|
-
*
|
|
504
|
-
* @param definitionW a resolved wrapped widget (extending widget).
|
|
505
|
-
*/
|
|
506
|
-
resolveDefinition?: (definitionW?: IPublicWidgetTemplateDefinition<any>) => Promise<IPublicWidgetTemplateDefinition<OPTIONS>>;
|
|
507
|
-
/**
|
|
508
|
-
* When defining new widgets using amCharts 4, this method registers the icCube license.
|
|
509
|
-
*/
|
|
510
|
-
registerAmCharts4?: (logger: ILogger, callback: (am4core: any) => void) => void;
|
|
511
|
-
/**
|
|
512
|
-
* When opening "Use Global Filter" option on Interaction tab
|
|
513
|
-
*/
|
|
514
|
-
enableUseGlobalFilter?: boolean;
|
|
515
|
-
/**
|
|
516
|
-
* Returns true if the widget fires a global event at initialization (start)
|
|
517
|
-
*/
|
|
518
|
-
firesGlobalEventAtStart?: (options: OPTIONS | undefined, templateDef: IPublicWidgetTemplateDefinition<OPTIONS>) => boolean;
|
|
519
|
-
/**
|
|
520
|
-
* Limit on the rows of the tidy result to both prevent the server and the browser to process
|
|
521
|
-
* too many items. Set to -1 to have no limit. Note that the server side is defining a limit as well.
|
|
522
|
-
* See icCube/help?ic3topic=dashboards.gettingstarted.Configuration for more details.
|
|
523
|
-
*
|
|
524
|
-
* Note: can be overridden via Dashboards options (ic3report-config.js).
|
|
525
|
-
*/
|
|
526
|
-
maxTidyRowCount?: number;
|
|
527
|
-
/**
|
|
528
|
-
* List of supported types of query.
|
|
529
|
-
*
|
|
530
|
-
* Defaults: all of them.
|
|
531
|
-
*/
|
|
532
|
-
withQueryTypes?: QueryType[];
|
|
533
|
-
/**
|
|
534
|
-
* Change the data to show when the user presses show-data from the widget menu.
|
|
535
|
-
* @param ownProps
|
|
536
|
-
*/
|
|
537
|
-
getShowHideDataTable?: (table: ITidyTable | undefined, options: OPTIONS, ownProps: any, theme: Theme) => ITidyTable | undefined;
|
|
538
|
-
/**
|
|
539
|
-
* For lazy filters or widgets with selection do not clean initial Selection based on initial tidy table
|
|
540
|
-
*/
|
|
541
|
-
doNotCleanSelectionOnInitialProps?: true;
|
|
542
|
-
}
|
|
543
|
-
/**
|
|
544
|
-
* *********************************************************************************************************************
|
|
545
|
-
* DO NOT CHANGE THEIR VALUE : USED FOR FINDING THE DOCUMENTATION.
|
|
546
|
-
* *********************************************************************************************************************
|
|
547
|
-
*/
|
|
548
|
-
export declare enum WidgetTemplateDefinitionType {
|
|
549
|
-
Chart = "chart",
|
|
550
|
-
Filter = "filter",
|
|
551
|
-
Map = "map",
|
|
552
|
-
Misc = "misc"
|
|
553
|
-
}
|
|
554
|
-
export interface IWidgetTemplateTidyData {
|
|
555
|
-
table: ITidyTable;
|
|
556
|
-
inter: ITidyTableInteraction;
|
|
557
|
-
}
|
|
558
|
-
export interface IWidgetTemplateTidyOptions<T extends FormFieldObject> {
|
|
559
|
-
table: ITidyTable;
|
|
560
|
-
options: T;
|
|
561
|
-
}
|
|
562
|
-
export interface IChartVisualizationTypedInput<T extends FormFieldObject> {
|
|
563
|
-
table: ITidyTable;
|
|
564
|
-
inter: ITidyTableInteraction;
|
|
565
|
-
options: T;
|
|
566
|
-
}
|
|
567
|
-
/**
|
|
568
|
-
* The mapping meta are all the column that the user can select in the chart options. These options are checked for
|
|
569
|
-
* validity. The widget generates an error if columns are selected that are not in the allowed properties, or if
|
|
570
|
-
* columns are mandatory but there is no selection or fallback.
|
|
571
|
-
*/
|
|
572
|
-
export type IWidgetTemplateDataMappingDef = IFormColumnChooserFieldDef;
|
|
573
|
-
/**
|
|
574
|
-
* Predefined roles
|
|
575
|
-
*/
|
|
576
|
-
export declare enum TemplateEventActionNames {
|
|
577
|
-
SELECTION = "Selection",
|
|
578
|
-
DRILLDOWN = "Drilldown",
|
|
579
|
-
ADD_SELECTION = "AddSelection",
|
|
580
|
-
FILTER_TO_DEFAULT = "FilterToDefault"
|
|
581
|
-
}
|
|
582
|
-
/**
|
|
583
|
-
*
|
|
584
|
-
* Definition of the actions supported by a template
|
|
585
|
-
*
|
|
586
|
-
*
|
|
587
|
-
* ( e.g., publish: 'onClick' )
|
|
588
|
-
*/
|
|
589
|
-
export interface ITemplateEventActionDef {
|
|
590
|
-
/**
|
|
591
|
-
* The actions publishing to a channel
|
|
592
|
-
*/
|
|
593
|
-
publish?: string[];
|
|
594
|
-
/**
|
|
595
|
-
* The actions subscribing to a channel (only new events value are sent, state change)
|
|
596
|
-
*/
|
|
597
|
-
subscribe?: string[];
|
|
598
|
-
/**
|
|
599
|
-
* The actions being notified by a channel (on each new event generated)
|
|
600
|
-
*/
|
|
601
|
-
notify?: string[];
|
|
602
|
-
/**
|
|
603
|
-
* The actions publishing to the 'selection' channel (it's internally managed by TidyTableInteraction)
|
|
604
|
-
*/
|
|
605
|
-
selectionPublish?: string;
|
|
606
|
-
/**
|
|
607
|
-
* The actions subscribing to the 'selection' channel
|
|
608
|
-
*/
|
|
609
|
-
selectionSubscribe?: string;
|
|
610
|
-
/**
|
|
611
|
-
* Return true if the widget fires the event on its first render. This forces other widgets that use this event
|
|
612
|
-
* to wait before rendering.
|
|
613
|
-
*/
|
|
614
|
-
isEventFiredAtStart?: (roleName: string, options: any) => boolean;
|
|
615
|
-
}
|
|
616
|
-
export interface IWrappedWidgetTemplateDefinition<WIDGET extends WidgetTemplateIDs> {
|
|
617
|
-
/**
|
|
618
|
-
* Some free text used while registering the wrapper (e.g., error purpose).
|
|
619
|
-
*/
|
|
620
|
-
readonly registrationInfo: string;
|
|
621
|
-
/**
|
|
622
|
-
* e.g., ic3.Table
|
|
623
|
-
*/
|
|
624
|
-
readonly wrappedWidgetTemplateId: WIDGET;
|
|
625
|
-
/**
|
|
626
|
-
* A function generating the widget template definition based on the wrapped widget template definition.
|
|
627
|
-
*/
|
|
628
|
-
readonly wrapper: (wrapped: IPublicWidgetTemplateDefinition<WidgetTemplateChartOptions[WIDGET]>) => IPublicWidgetTemplateDefinition<FormFieldObject>;
|
|
629
|
-
}
|
|
630
|
-
export {};
|
package/dist/PublicTemplate.js
DELETED
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.TemplateEventActionNames = exports.WidgetTemplateDefinitionType = exports.IWidgetTemplateMdxBuilderAxisPropsConstraint = void 0;
|
|
4
|
-
var IWidgetTemplateMdxBuilderAxisPropsConstraint;
|
|
5
|
-
(function (IWidgetTemplateMdxBuilderAxisPropsConstraint) {
|
|
6
|
-
IWidgetTemplateMdxBuilderAxisPropsConstraint["DateType"] = "DateType";
|
|
7
|
-
IWidgetTemplateMdxBuilderAxisPropsConstraint["GeoLatLong"] = "GeoLatLong";
|
|
8
|
-
IWidgetTemplateMdxBuilderAxisPropsConstraint["GeoIso2Code"] = "GeoIso2Code";
|
|
9
|
-
})(IWidgetTemplateMdxBuilderAxisPropsConstraint || (exports.IWidgetTemplateMdxBuilderAxisPropsConstraint = IWidgetTemplateMdxBuilderAxisPropsConstraint = {}));
|
|
10
|
-
/**
|
|
11
|
-
* *********************************************************************************************************************
|
|
12
|
-
* DO NOT CHANGE THEIR VALUE : USED FOR FINDING THE DOCUMENTATION.
|
|
13
|
-
* *********************************************************************************************************************
|
|
14
|
-
*/
|
|
15
|
-
var WidgetTemplateDefinitionType;
|
|
16
|
-
(function (WidgetTemplateDefinitionType) {
|
|
17
|
-
WidgetTemplateDefinitionType["Chart"] = "chart";
|
|
18
|
-
WidgetTemplateDefinitionType["Filter"] = "filter";
|
|
19
|
-
WidgetTemplateDefinitionType["Map"] = "map";
|
|
20
|
-
WidgetTemplateDefinitionType["Misc"] = "misc";
|
|
21
|
-
})(WidgetTemplateDefinitionType || (exports.WidgetTemplateDefinitionType = WidgetTemplateDefinitionType = {}));
|
|
22
|
-
/**
|
|
23
|
-
* Predefined roles
|
|
24
|
-
*/
|
|
25
|
-
var TemplateEventActionNames;
|
|
26
|
-
(function (TemplateEventActionNames) {
|
|
27
|
-
TemplateEventActionNames["SELECTION"] = "Selection";
|
|
28
|
-
TemplateEventActionNames["DRILLDOWN"] = "Drilldown";
|
|
29
|
-
// Notifications
|
|
30
|
-
TemplateEventActionNames["ADD_SELECTION"] = "AddSelection";
|
|
31
|
-
TemplateEventActionNames["FILTER_TO_DEFAULT"] = "FilterToDefault";
|
|
32
|
-
})(TemplateEventActionNames || (exports.TemplateEventActionNames = TemplateEventActionNames = {}));
|
|
33
|
-
//# sourceMappingURL=PublicTemplate.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"PublicTemplate.js","sourceRoot":"","sources":["../src/PublicTemplate.ts"],"names":[],"mappings":";;;AAuIA,IAAY,4CAIX;AAJD,WAAY,4CAA4C;IACpD,qEAAqB,CAAA;IACrB,yEAAyB,CAAA;IACzB,2EAA2B,CAAA;AAC/B,CAAC,EAJW,4CAA4C,4DAA5C,4CAA4C,QAIvD;AA0hBD;;;;GAIG;AACH,IAAY,4BAKX;AALD,WAAY,4BAA4B;IACpC,+CAAe,CAAA;IACf,iDAAiB,CAAA;IACjB,2CAAW,CAAA;IACX,6CAAa,CAAA;AACjB,CAAC,EALW,4BAA4B,4CAA5B,4BAA4B,QAKvC;AA6BD;;GAEG;AACH,IAAY,wBAOX;AAPD,WAAY,wBAAwB;IAChC,mDAAuB,CAAA;IACvB,mDAAuB,CAAA;IAEvB,gBAAgB;IAChB,0DAA8B,CAAA;IAC9B,iEAAqC,CAAA;AACzC,CAAC,EAPW,wBAAwB,wCAAxB,wBAAwB,QAOnC"}
|
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
import { FormFieldType, IFormFieldDef } from "./PublicTemplateForm";
|
|
2
|
-
import { TidyTableColumnSelector } from "./PublicTidyTableTypes";
|
|
3
|
-
export interface IFormTidyTableExprFieldDef<FIELD_TYPE extends FormFieldType> extends IFormFieldDef<string> {
|
|
4
|
-
fieldType: FIELD_TYPE;
|
|
5
|
-
editorConf?: {
|
|
6
|
-
/**
|
|
7
|
-
* If true, user can use select a column in the dialog editor. This column then is the _currentColumn in the
|
|
8
|
-
* expression when evaluating in the dialog editor.
|
|
9
|
-
*/
|
|
10
|
-
userSelectsCurrentColumn?: boolean;
|
|
11
|
-
/**
|
|
12
|
-
* If true, user can use _currentColumn in the expression.
|
|
13
|
-
* The default current column comes from the first dependsOn option.
|
|
14
|
-
*/
|
|
15
|
-
useCurrentColumn?: boolean;
|
|
16
|
-
/**
|
|
17
|
-
* Selector for populating the current column in the editor.
|
|
18
|
-
*/
|
|
19
|
-
initialCurrentColumn?: TidyTableColumnSelector;
|
|
20
|
-
/**
|
|
21
|
-
* If true, user can use _selectedColumns in the expression.
|
|
22
|
-
* The default selected columns come from the second dependsOn option.
|
|
23
|
-
*/
|
|
24
|
-
useSelectedColumns?: boolean;
|
|
25
|
-
/**
|
|
26
|
-
* Set here to override the available columns and roles in the completion meta.
|
|
27
|
-
*/
|
|
28
|
-
completionMeta?: string[];
|
|
29
|
-
};
|
|
30
|
-
}
|