@ic3/reporting-api 9.0.0 → 9.1.0

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.
Files changed (292) hide show
  1. package/README.md +1 -1
  2. package/dist/index.cjs +1906 -0
  3. package/dist/index.cjs.map +1 -0
  4. package/dist/index.d.ts +11280 -81
  5. package/dist/index.js +1782 -96
  6. package/dist/index.js.map +1 -1
  7. package/package.json +51 -19
  8. package/dist/ApiUtils.d.ts +0 -57
  9. package/dist/ApiUtils.js +0 -79
  10. package/dist/ApiUtils.js.map +0 -1
  11. package/dist/ILocalizationManager.d.ts +0 -3
  12. package/dist/ILocalizationManager.js +0 -3
  13. package/dist/ILocalizationManager.js.map +0 -1
  14. package/dist/IMigrationManager.d.ts +0 -4
  15. package/dist/IMigrationManager.js +0 -3
  16. package/dist/IMigrationManager.js.map +0 -1
  17. package/dist/INotification.d.ts +0 -84
  18. package/dist/INotification.js +0 -3
  19. package/dist/INotification.js.map +0 -1
  20. package/dist/IOnNewEventJsContext.d.ts +0 -85
  21. package/dist/IOnNewEventJsContext.js +0 -3
  22. package/dist/IOnNewEventJsContext.js.map +0 -1
  23. package/dist/IPluginDefinition.d.ts +0 -41
  24. package/dist/IPluginDefinition.js +0 -3
  25. package/dist/IPluginDefinition.js.map +0 -1
  26. package/dist/IRemotePluginName.d.ts +0 -5
  27. package/dist/IRemotePluginName.js +0 -3
  28. package/dist/IRemotePluginName.js.map +0 -1
  29. package/dist/IThemeManager.d.ts +0 -87
  30. package/dist/IThemeManager.js +0 -8
  31. package/dist/IThemeManager.js.map +0 -1
  32. package/dist/ITidyTableTransformation.d.ts +0 -44
  33. package/dist/ITidyTableTransformation.js +0 -3
  34. package/dist/ITidyTableTransformation.js.map +0 -1
  35. package/dist/ITidyTableTransformationManager.d.ts +0 -4
  36. package/dist/ITidyTableTransformationManager.js +0 -3
  37. package/dist/ITidyTableTransformationManager.js.map +0 -1
  38. package/dist/ITypes.d.ts +0 -43
  39. package/dist/ITypes.js +0 -38
  40. package/dist/ITypes.js.map +0 -1
  41. package/dist/IUserMenuOptionManager.d.ts +0 -13
  42. package/dist/IUserMenuOptionManager.js +0 -3
  43. package/dist/IUserMenuOptionManager.js.map +0 -1
  44. package/dist/IVersionedPluginDefinition.d.ts +0 -8
  45. package/dist/IVersionedPluginDefinition.js +0 -3
  46. package/dist/IVersionedPluginDefinition.js.map +0 -1
  47. package/dist/IWidgetDefaultsManager.d.ts +0 -4
  48. package/dist/IWidgetDefaultsManager.js +0 -3
  49. package/dist/IWidgetDefaultsManager.js.map +0 -1
  50. package/dist/IWidgetManager.d.ts +0 -7
  51. package/dist/IWidgetManager.js +0 -3
  52. package/dist/IWidgetManager.js.map +0 -1
  53. package/dist/IWidgetVariantManager.d.ts +0 -22
  54. package/dist/IWidgetVariantManager.js +0 -3
  55. package/dist/IWidgetVariantManager.js.map +0 -1
  56. package/dist/IcEvent.d.ts +0 -59
  57. package/dist/IcEvent.js +0 -27
  58. package/dist/IcEvent.js.map +0 -1
  59. package/dist/LazyTreeView.d.ts +0 -130
  60. package/dist/LazyTreeView.js +0 -3
  61. package/dist/LazyTreeView.js.map +0 -1
  62. package/dist/Logger.d.ts +0 -13
  63. package/dist/Logger.js +0 -3
  64. package/dist/Logger.js.map +0 -1
  65. package/dist/PublicAmCharts4Base.d.ts +0 -91
  66. package/dist/PublicAmCharts4Base.js +0 -3
  67. package/dist/PublicAmCharts4Base.js.map +0 -1
  68. package/dist/PublicAmchartsData.d.ts +0 -116
  69. package/dist/PublicAmchartsData.js +0 -170
  70. package/dist/PublicAmchartsData.js.map +0 -1
  71. package/dist/PublicCommon.d.ts +0 -1
  72. package/dist/PublicCommon.js +0 -3
  73. package/dist/PublicCommon.js.map +0 -1
  74. package/dist/PublicContext.d.ts +0 -389
  75. package/dist/PublicContext.js +0 -19
  76. package/dist/PublicContext.js.map +0 -1
  77. package/dist/PublicDateShortcutUtils.d.ts +0 -41
  78. package/dist/PublicDateShortcutUtils.js +0 -3
  79. package/dist/PublicDateShortcutUtils.js.map +0 -1
  80. package/dist/PublicI18n.d.ts +0 -8
  81. package/dist/PublicI18n.js +0 -3
  82. package/dist/PublicI18n.js.map +0 -1
  83. package/dist/PublicLayout.d.ts +0 -247
  84. package/dist/PublicLayout.js +0 -3
  85. package/dist/PublicLayout.js.map +0 -1
  86. package/dist/PublicTemplate.d.ts +0 -630
  87. package/dist/PublicTemplate.js +0 -33
  88. package/dist/PublicTemplate.js.map +0 -1
  89. package/dist/PublicTemplateExprForm.d.ts +0 -30
  90. package/dist/PublicTemplateExprForm.js +0 -3
  91. package/dist/PublicTemplateExprForm.js.map +0 -1
  92. package/dist/PublicTemplateForm.d.ts +0 -866
  93. package/dist/PublicTemplateForm.js +0 -122
  94. package/dist/PublicTemplateForm.js.map +0 -1
  95. package/dist/PublicTemplates.d.ts +0 -70
  96. package/dist/PublicTemplates.js +0 -3
  97. package/dist/PublicTemplates.js.map +0 -1
  98. package/dist/PublicTheme.d.ts +0 -1013
  99. package/dist/PublicTheme.js +0 -14
  100. package/dist/PublicTheme.js.map +0 -1
  101. package/dist/PublicTidyColumn.d.ts +0 -755
  102. package/dist/PublicTidyColumn.js +0 -100
  103. package/dist/PublicTidyColumn.js.map +0 -1
  104. package/dist/PublicTidyHistogram.d.ts +0 -81
  105. package/dist/PublicTidyHistogram.js +0 -105
  106. package/dist/PublicTidyHistogram.js.map +0 -1
  107. package/dist/PublicTidyMath.d.ts +0 -175
  108. package/dist/PublicTidyMath.js +0 -3
  109. package/dist/PublicTidyMath.js.map +0 -1
  110. package/dist/PublicTidyTable.d.ts +0 -534
  111. package/dist/PublicTidyTable.js +0 -3
  112. package/dist/PublicTidyTable.js.map +0 -1
  113. package/dist/PublicTidyTableInteractions.d.ts +0 -317
  114. package/dist/PublicTidyTableInteractions.js +0 -31
  115. package/dist/PublicTidyTableInteractions.js.map +0 -1
  116. package/dist/PublicTidyTableTypeGuards.d.ts +0 -6
  117. package/dist/PublicTidyTableTypeGuards.js +0 -36
  118. package/dist/PublicTidyTableTypeGuards.js.map +0 -1
  119. package/dist/PublicTidyTableTypes.d.ts +0 -480
  120. package/dist/PublicTidyTableTypes.js +0 -154
  121. package/dist/PublicTidyTableTypes.js.map +0 -1
  122. package/dist/PublicTidyTree.d.ts +0 -71
  123. package/dist/PublicTidyTree.js +0 -89
  124. package/dist/PublicTidyTree.js.map +0 -1
  125. package/dist/RemoteContainerUtils.d.ts +0 -9
  126. package/dist/RemoteContainerUtils.js +0 -49
  127. package/dist/RemoteContainerUtils.js.map +0 -1
  128. package/dist/ReportingVersion.d.ts +0 -9
  129. package/dist/ReportingVersion.js +0 -13
  130. package/dist/ReportingVersion.js.map +0 -1
  131. package/dist/ThemeAugmentation.d.ts +0 -35
  132. package/dist/ThemeAugmentation.js +0 -3
  133. package/dist/ThemeAugmentation.js.map +0 -1
  134. package/dist/theme/ThemeAIWidgetChatBot.d.ts +0 -49
  135. package/dist/theme/ThemeAIWidgetChatBot.js +0 -19
  136. package/dist/theme/ThemeAIWidgetChatBot.js.map +0 -1
  137. package/dist/theme/ThemeAlertDialog.d.ts +0 -13
  138. package/dist/theme/ThemeAlertDialog.js +0 -17
  139. package/dist/theme/ThemeAlertDialog.js.map +0 -1
  140. package/dist/theme/ThemeAmCharts4.d.ts +0 -1634
  141. package/dist/theme/ThemeAmCharts4.js +0 -84
  142. package/dist/theme/ThemeAmCharts4.js.map +0 -1
  143. package/dist/theme/ThemeApp.d.ts +0 -66
  144. package/dist/theme/ThemeApp.js +0 -64
  145. package/dist/theme/ThemeApp.js.map +0 -1
  146. package/dist/theme/ThemeAppMenuIcon.d.ts +0 -7
  147. package/dist/theme/ThemeAppMenuIcon.js +0 -8
  148. package/dist/theme/ThemeAppMenuIcon.js.map +0 -1
  149. package/dist/theme/ThemeBaseTable.d.ts +0 -122
  150. package/dist/theme/ThemeBaseTable.js +0 -10
  151. package/dist/theme/ThemeBaseTable.js.map +0 -1
  152. package/dist/theme/ThemeCodeMirror.d.ts +0 -4
  153. package/dist/theme/ThemeCodeMirror.js +0 -8
  154. package/dist/theme/ThemeCodeMirror.js.map +0 -1
  155. package/dist/theme/ThemeDatePicker.d.ts +0 -214
  156. package/dist/theme/ThemeDatePicker.js +0 -37
  157. package/dist/theme/ThemeDatePicker.js.map +0 -1
  158. package/dist/theme/ThemeEditorTopBar.d.ts +0 -39
  159. package/dist/theme/ThemeEditorTopBar.js +0 -43
  160. package/dist/theme/ThemeEditorTopBar.js.map +0 -1
  161. package/dist/theme/ThemeEmbeddedReport.d.ts +0 -37
  162. package/dist/theme/ThemeEmbeddedReport.js +0 -9
  163. package/dist/theme/ThemeEmbeddedReport.js.map +0 -1
  164. package/dist/theme/ThemeErrorRenderer.d.ts +0 -51
  165. package/dist/theme/ThemeErrorRenderer.js +0 -55
  166. package/dist/theme/ThemeErrorRenderer.js.map +0 -1
  167. package/dist/theme/ThemeFilter.d.ts +0 -28
  168. package/dist/theme/ThemeFilter.js +0 -3
  169. package/dist/theme/ThemeFilter.js.map +0 -1
  170. package/dist/theme/ThemeFilterAutocomplete.d.ts +0 -58
  171. package/dist/theme/ThemeFilterAutocomplete.js +0 -15
  172. package/dist/theme/ThemeFilterAutocomplete.js.map +0 -1
  173. package/dist/theme/ThemeFilterButtons.d.ts +0 -74
  174. package/dist/theme/ThemeFilterButtons.js +0 -23
  175. package/dist/theme/ThemeFilterButtons.js.map +0 -1
  176. package/dist/theme/ThemeFilterCheckboxRadio.d.ts +0 -52
  177. package/dist/theme/ThemeFilterCheckboxRadio.js +0 -23
  178. package/dist/theme/ThemeFilterCheckboxRadio.js.map +0 -1
  179. package/dist/theme/ThemeFilterPanel.d.ts +0 -243
  180. package/dist/theme/ThemeFilterPanel.js +0 -127
  181. package/dist/theme/ThemeFilterPanel.js.map +0 -1
  182. package/dist/theme/ThemeFilterPanelViewsMenu.d.ts +0 -8
  183. package/dist/theme/ThemeFilterPanelViewsMenu.js +0 -12
  184. package/dist/theme/ThemeFilterPanelViewsMenu.js.map +0 -1
  185. package/dist/theme/ThemeFilterSlider.d.ts +0 -92
  186. package/dist/theme/ThemeFilterSlider.js +0 -41
  187. package/dist/theme/ThemeFilterSlider.js.map +0 -1
  188. package/dist/theme/ThemeFilterSwitch.d.ts +0 -41
  189. package/dist/theme/ThemeFilterSwitch.js +0 -15
  190. package/dist/theme/ThemeFilterSwitch.js.map +0 -1
  191. package/dist/theme/ThemeFilterTree.d.ts +0 -112
  192. package/dist/theme/ThemeFilterTree.js +0 -23
  193. package/dist/theme/ThemeFilterTree.js.map +0 -1
  194. package/dist/theme/ThemeGlobal.d.ts +0 -4
  195. package/dist/theme/ThemeGlobal.js +0 -9
  196. package/dist/theme/ThemeGlobal.js.map +0 -1
  197. package/dist/theme/ThemeGoogle.d.ts +0 -132
  198. package/dist/theme/ThemeGoogle.js +0 -64
  199. package/dist/theme/ThemeGoogle.js.map +0 -1
  200. package/dist/theme/ThemeGoogleHeatMap.d.ts +0 -58
  201. package/dist/theme/ThemeGoogleHeatMap.js +0 -3
  202. package/dist/theme/ThemeGoogleHeatMap.js.map +0 -1
  203. package/dist/theme/ThemeGoogleKmlLayer.d.ts +0 -40
  204. package/dist/theme/ThemeGoogleKmlLayer.js +0 -3
  205. package/dist/theme/ThemeGoogleKmlLayer.js.map +0 -1
  206. package/dist/theme/ThemeGoogleMarker.d.ts +0 -147
  207. package/dist/theme/ThemeGoogleMarker.js +0 -3
  208. package/dist/theme/ThemeGoogleMarker.js.map +0 -1
  209. package/dist/theme/ThemeHomeCard.d.ts +0 -9
  210. package/dist/theme/ThemeHomeCard.js +0 -10
  211. package/dist/theme/ThemeHomeCard.js.map +0 -1
  212. package/dist/theme/ThemeHomeConsole.d.ts +0 -16
  213. package/dist/theme/ThemeHomeConsole.js +0 -20
  214. package/dist/theme/ThemeHomeConsole.js.map +0 -1
  215. package/dist/theme/ThemeHtmlBox.d.ts +0 -33
  216. package/dist/theme/ThemeHtmlBox.js +0 -11
  217. package/dist/theme/ThemeHtmlBox.js.map +0 -1
  218. package/dist/theme/ThemeIc3CustomDrilldownMenu.d.ts +0 -7
  219. package/dist/theme/ThemeIc3CustomDrilldownMenu.js +0 -11
  220. package/dist/theme/ThemeIc3CustomDrilldownMenu.js.map +0 -1
  221. package/dist/theme/ThemeIc3TableCell.d.ts +0 -10
  222. package/dist/theme/ThemeIc3TableCell.js +0 -7
  223. package/dist/theme/ThemeIc3TableCell.js.map +0 -1
  224. package/dist/theme/ThemeIc3TableCellDrilldown.d.ts +0 -12
  225. package/dist/theme/ThemeIc3TableCellDrilldown.js +0 -11
  226. package/dist/theme/ThemeIc3TableCellDrilldown.js.map +0 -1
  227. package/dist/theme/ThemeIc3WidgetBoxSpinner.d.ts +0 -15
  228. package/dist/theme/ThemeIc3WidgetBoxSpinner.js +0 -13
  229. package/dist/theme/ThemeIc3WidgetBoxSpinner.js.map +0 -1
  230. package/dist/theme/ThemeImage.d.ts +0 -30
  231. package/dist/theme/ThemeImage.js +0 -12
  232. package/dist/theme/ThemeImage.js.map +0 -1
  233. package/dist/theme/ThemeKpiBox.d.ts +0 -33
  234. package/dist/theme/ThemeKpiBox.js +0 -3
  235. package/dist/theme/ThemeKpiBox.js.map +0 -1
  236. package/dist/theme/ThemeKpiCard.d.ts +0 -133
  237. package/dist/theme/ThemeKpiCard.js +0 -19
  238. package/dist/theme/ThemeKpiCard.js.map +0 -1
  239. package/dist/theme/ThemeLayout.d.ts +0 -10
  240. package/dist/theme/ThemeLayout.js +0 -14
  241. package/dist/theme/ThemeLayout.js.map +0 -1
  242. package/dist/theme/ThemeLayoutPage.d.ts +0 -24
  243. package/dist/theme/ThemeLayoutPage.js +0 -28
  244. package/dist/theme/ThemeLayoutPage.js.map +0 -1
  245. package/dist/theme/ThemeLazyTreeClasses.d.ts +0 -29
  246. package/dist/theme/ThemeLazyTreeClasses.js +0 -31
  247. package/dist/theme/ThemeLazyTreeClasses.js.map +0 -1
  248. package/dist/theme/ThemeListCounter.d.ts +0 -15
  249. package/dist/theme/ThemeListCounter.js +0 -17
  250. package/dist/theme/ThemeListCounter.js.map +0 -1
  251. package/dist/theme/ThemeMarkdownText.d.ts +0 -27
  252. package/dist/theme/ThemeMarkdownText.js +0 -3
  253. package/dist/theme/ThemeMarkdownText.js.map +0 -1
  254. package/dist/theme/ThemePivotTable.d.ts +0 -93
  255. package/dist/theme/ThemePivotTable.js +0 -31
  256. package/dist/theme/ThemePivotTable.js.map +0 -1
  257. package/dist/theme/ThemePrintButton.d.ts +0 -29
  258. package/dist/theme/ThemePrintButton.js +0 -10
  259. package/dist/theme/ThemePrintButton.js.map +0 -1
  260. package/dist/theme/ThemeQueryBuilderNode.d.ts +0 -13
  261. package/dist/theme/ThemeQueryBuilderNode.js +0 -13
  262. package/dist/theme/ThemeQueryBuilderNode.js.map +0 -1
  263. package/dist/theme/ThemeRegexFilter.d.ts +0 -24
  264. package/dist/theme/ThemeRegexFilter.js +0 -26
  265. package/dist/theme/ThemeRegexFilter.js.map +0 -1
  266. package/dist/theme/ThemeRepetitionWidget.d.ts +0 -57
  267. package/dist/theme/ThemeRepetitionWidget.js +0 -3
  268. package/dist/theme/ThemeRepetitionWidget.js.map +0 -1
  269. package/dist/theme/ThemeReportAppBar.d.ts +0 -17
  270. package/dist/theme/ThemeReportAppBar.js +0 -21
  271. package/dist/theme/ThemeReportAppBar.js.map +0 -1
  272. package/dist/theme/ThemeReportAppLeftPanel.d.ts +0 -8
  273. package/dist/theme/ThemeReportAppLeftPanel.js +0 -12
  274. package/dist/theme/ThemeReportAppLeftPanel.js.map +0 -1
  275. package/dist/theme/ThemeSeparator.d.ts +0 -13
  276. package/dist/theme/ThemeSeparator.js +0 -3
  277. package/dist/theme/ThemeSeparator.js.map +0 -1
  278. package/dist/theme/ThemeSinglePanelFilter.d.ts +0 -18
  279. package/dist/theme/ThemeSinglePanelFilter.js +0 -3
  280. package/dist/theme/ThemeSinglePanelFilter.js.map +0 -1
  281. package/dist/theme/ThemeTable.d.ts +0 -160
  282. package/dist/theme/ThemeTable.js +0 -157
  283. package/dist/theme/ThemeTable.js.map +0 -1
  284. package/dist/theme/ThemeWidgetBox.d.ts +0 -164
  285. package/dist/theme/ThemeWidgetBox.js +0 -124
  286. package/dist/theme/ThemeWidgetBox.js.map +0 -1
  287. package/dist/theme/ThemeWidgetBoxContentMessage.d.ts +0 -11
  288. package/dist/theme/ThemeWidgetBoxContentMessage.js +0 -15
  289. package/dist/theme/ThemeWidgetBoxContentMessage.js.map +0 -1
  290. package/dist/theme/ThemeWidgetFilteredBy.d.ts +0 -5
  291. package/dist/theme/ThemeWidgetFilteredBy.js +0 -9
  292. package/dist/theme/ThemeWidgetFilteredBy.js.map +0 -1
@@ -1,755 +0,0 @@
1
- import { AxisCoordinate, ConvertToTypeParseSettings, EntityItem, GroupRowIndices, IMdxAxisSeriesInfo, ITidyColumnIndex, ITidyColumnsSource, MdxInfo, TidyCellError, TidyColumnsSubType, TidyColumnsType } from "./PublicTidyTableTypes";
2
- import { TidyActionEvent } from "./IcEvent";
3
- import { ThemeTextFormatter } from "./PublicTheme";
4
- import { Property } from "csstype";
5
- import { AppNotification } from "./INotification";
6
- import { MdxNodeIdentifier } from "./PublicTidyTable";
7
- import { IPublicContext } from "./PublicContext";
8
- export interface ITidyColumnTypedValue {
9
- value: any;
10
- fValue?: string;
11
- type: TidyColumnsType;
12
- /**
13
- * Insert this mdx value for this row. Leave undefined to set the mdx info of the row to undefined.
14
- */
15
- mdxInfo?: MdxInfo | null;
16
- }
17
- export type ITidyColumnAddValue = ITidyColumnAddValueInsert | ITidyColumnAddValueCopyRow;
18
- export interface ITidyColumnAddValueInsert {
19
- options: "INSERT";
20
- value: ITidyColumnTypedValue;
21
- }
22
- export interface ITidyColumnAddValueCopyRow {
23
- options: "COPY_ROW";
24
- rowIndex: number;
25
- }
26
- /**
27
- * Properties with a special meaning
28
- */
29
- export declare enum ITidyColumnNamedProperties {
30
- /**
31
- * The value of a cell.
32
- */
33
- mdxCellValue = "value",
34
- /**
35
- * The formatted value of a cell. For example, 5003 in euros is formatted as €5,003
36
- */
37
- mdxCellFormattedValue = "formattedValue",
38
- /**
39
- * MDX related colorings
40
- */
41
- mdxCellBackColor = "mdxCellBackColor",
42
- /**
43
- * MDX related colorings
44
- */
45
- mdxCellForeColor = "mdxCellForeColor",
46
- /**
47
- * The format string for the cell value. For example, euros are formatted using €#,###.
48
- * and percentages using #0.00%.
49
- */
50
- mdxCellFormatString = "mdxCellFormatString",
51
- /**
52
- * The main color of the cell
53
- */
54
- mdxCellColor = "color",
55
- /**
56
- * Column defined to fire an app. notification.
57
- *
58
- * The name of the notification (e.g., print-report).
59
- */
60
- appNotificationType = "appNotificationType",
61
- /**
62
- * Column defined to fire an app. notification.
63
- *
64
- * The parameters of the notification (e.g., page size, filename, ...) as a JSON or a string.
65
- */
66
- appNotificationPayload = "appNotificationPayload",
67
- /**
68
- * Column defined to fire events, the name of the event
69
- */
70
- eventName = "eventName",
71
- /**
72
- * Column defined to fire events, the value of the event (e.g. used in title)
73
- */
74
- eventValue = "eventValue",
75
- /**
76
- * Column defined to fire events, the mdx value of the event (e.g. used in queries)
77
- */
78
- eventMdxValue = "eventMdxValue",
79
- /**
80
- * Column defined as an MDX axis, the unique name of the column (the name is the value of the column).
81
- * This value is fired when doing selection events.
82
- * @see {ITidyColumn.getMdxInfo}
83
- */
84
- uniqueName = "uniqueName",
85
- /**
86
- * The caption of the selection event to use. Returned by getMdxInfo(..).
87
- * @see {ITidyColumn.getMdxInfo}
88
- */
89
- mdxInfoCaption = "mdxInfoCaption",
90
- /**
91
- * The MdxInfo
92
- * @see {ITidyColumn.getMdxInfo}
93
- */
94
- mdxInfo = "mdxInfo",
95
- /**
96
- * Column defined as an MDX axis, the caption of the column
97
- */
98
- caption = "caption",
99
- /**
100
- * Column defined as an MDX axis, the key of the column
101
- */
102
- mdxCellKey = "key",
103
- /**
104
- * Show this when hovering over the cell (or the visualisation representing the cell)
105
- */
106
- tooltip = "tooltip",
107
- /**
108
- * Name for datetime properties for levels of type Year, Month, Day, Hour, etc..
109
- */
110
- datetime = "datetime"
111
- }
112
- export declare const CharacterTidyColumnProperties: Set<string>;
113
- /**
114
- * A copy from XLSX CellObject (we don't want the link to the library !)
115
- */
116
- export interface ITidyColumnXlsxCell {
117
- /** The raw value of the cell. Can be omitted if a formula is specified */
118
- v?: string | number | boolean | Date;
119
- /** Formatted text (if applicable) */
120
- w?: string;
121
- /**
122
- * The Excel Data Type of the cell.
123
- * b Boolean, n Number, e Error, s String, d Date, z Empty
124
- */
125
- t: 'b' | 'n' | 'e' | 's' | 'd' | 'z';
126
- /** Cell formula (if applicable) */
127
- f?: string;
128
- /** Range of enclosing array if formula is array formula (if applicable) */
129
- F?: string;
130
- /** Rich text encoding (if applicable) */
131
- r?: any;
132
- /** HTML rendering of the rich text (if applicable) */
133
- h?: string;
134
- /** Number format string associated with the cell (if requested) */
135
- z?: string | number;
136
- /** Cell hyperlink object (.Target holds link, .tooltip is tooltip) */
137
- l?: {
138
- /** Target of the link (HREF) */
139
- Target: string;
140
- /** Plaintext tooltip to display when mouse is over cell */
141
- Tooltip?: string;
142
- };
143
- /** The style/theme of the cell (if applicable) */
144
- s?: any;
145
- }
146
- type NonNullable<T> = Exclude<T, null | undefined>;
147
- export type AllowedColumnType<T> = TidyColumnsType.UNKNOWN | TidyColumnsType.MIXED | (NonNullable<T> extends Property.Color ? TidyColumnsType.COLOR : TidyColumnsType.UNKNOWN) | (NonNullable<T> extends string ? TidyColumnsType.CHARACTER : TidyColumnsType.UNKNOWN) | (NonNullable<T> extends number ? TidyColumnsType.NUMERIC | TidyColumnsType.LATITUDE | TidyColumnsType.LONGITUDE : TidyColumnsType.UNKNOWN) | (NonNullable<T> extends boolean ? TidyColumnsType.LOGICAL : TidyColumnsType.UNKNOWN) | (NonNullable<T> extends any[] ? TidyColumnsType.LIST : TidyColumnsType.UNKNOWN) | (NonNullable<T> extends Date ? TidyColumnsType.DATETIME : TidyColumnsType.UNKNOWN) | (NonNullable<T> extends unknown ? TidyColumnsType : TidyColumnsType.UNKNOWN) | (T extends null ? TidyColumnsType.NULL : TidyColumnsType.UNKNOWN);
148
- export interface ITidyBaseColumnReadonly<T> {
149
- /**
150
- * Returns the length of the value array.
151
- */
152
- length(): number;
153
- /**
154
- * Returns true if and only if the column has zero rows.
155
- */
156
- isEmpty(): boolean;
157
- getSource(): ITidyColumnsSource;
158
- /**
159
- * Get the MDX role of the column
160
- */
161
- getRole(): string | undefined;
162
- /**
163
- * Return the type of the column
164
- */
165
- getType(): AllowedColumnType<T>;
166
- /**
167
- * e.g., List<T>.
168
- */
169
- getTypeParam(): TidyColumnsType | undefined;
170
- /**
171
- * E.g., datetime column: YEAR, ...
172
- */
173
- getSubType(): TidyColumnsSubType | undefined;
174
- /**
175
- * Check if column is of type
176
- * @param type check this type
177
- */
178
- is<T extends TidyColumnsType>(type: T): this is ITidyColumnIsType<T>;
179
- /**
180
- * Returns true if and only if the column is of the type(s) specified
181
- * @param typesToCheck one or more types to check this column against
182
- */
183
- isOfType(...typesToCheck: TidyColumnsType[]): boolean;
184
- /**
185
- * Returns the name of the column.
186
- */
187
- getName(): string;
188
- /**
189
- * Get the display name of the column. Both the name and the caption form the display name of the column.
190
- */
191
- getDisplayName(): string;
192
- /**
193
- * Returns the caption of the column. The caption is used for displaying localised
194
- * or custom captions for the axis, header, etc.
195
- */
196
- getCaption(): string;
197
- /**
198
- * Returns the formatter of the column.
199
- */
200
- getNumberFormat(): ThemeTextFormatter | undefined;
201
- /**
202
- * Returns true if the column is a hierarchical structure
203
- */
204
- isHierarchy(): boolean;
205
- /**
206
- * For hierarchical structures the tree depth (starts at zero).
207
- */
208
- getLevelDepthR(idx: number): number;
209
- /**
210
- * Returns the column values.
211
- */
212
- getValues(): ReadonlyArray<T>;
213
- /**
214
- * Get the value of the column at position idx.
215
- * @param idx the position to return the value of.
216
- */
217
- getValue(idx: number): T;
218
- /**
219
- * Function used for value comparison in sorting and ranking. Return a positive number if a > b, a negative
220
- * number if a < b and 0 otherwise.
221
- * @param a value 1
222
- * @param b value 2
223
- */
224
- compare(a: T, b: T): number;
225
- /**
226
- * Apply a function to the groups of unique values in this column
227
- *
228
- * @param useMdx If true, use MDX-unique names to construct groups. If false, use the columns values.
229
- * Default = false.
230
- *
231
- * @returns a map with indexes for each group. Key -> row indeces
232
- */
233
- groupBy(useMdx?: boolean): Map<string, GroupRowIndices>;
234
- /**
235
- * Same as reIndex but creating a new column leaving this column untouched.
236
- *
237
- * @see ITidyBaseColumn.reIndex
238
- */
239
- reIndexN(index: number[]): ITidyBaseColumn<T>;
240
- /**
241
- * Returns the color of this columns header.
242
- */
243
- getHeaderColor(hierarchyIdx?: number): string | undefined;
244
- /**
245
- * Returns the colors of this columns header.
246
- */
247
- getHeaderColors(): (string | undefined)[] | string | undefined;
248
- }
249
- /**
250
- * Base interface for nullable column.
251
- */
252
- export interface ITidyBaseColumn<T> extends ITidyBaseColumnReadonly<T> {
253
- /**
254
- * Set the color for the columns header
255
- */
256
- setHeaderColor(color: (string | undefined)[] | string | undefined): void;
257
- isSameDimensionality(other: ITidyBaseColumn<any>): boolean;
258
- getErrors(): (TidyCellError | undefined)[];
259
- /**
260
- * If an error occurred in the calculation of cells for a column, then the error can be
261
- * retrieved using this function.
262
- * @param idx the row index of the cell to retrieve the error of.
263
- */
264
- getError(idx: number): TidyCellError | undefined;
265
- /**
266
- * Returns first value where callback does not return undefined.
267
- * @param callback given the row index, outputs a value or undefined.
268
- */
269
- findFirst<P>(callback: (idx: number) => P | undefined): P | undefined;
270
- /**
271
- * returns true if the column as a property defining the formatted value.
272
- */
273
- hasFormattedValue(): boolean;
274
- /**
275
- * Get the formatted value of the column at position idx.
276
- *
277
- * undefined - if the formatted_value is not available
278
- *
279
- * @param idx the position to return the value of.
280
- */
281
- getFormattedValue(idx: number): string | undefined;
282
- /**
283
- * Return the formatted value. Returns undefined if the value is undefined.
284
- * If the value has no format, then it uses the default format from the theme.
285
- *
286
- * @param idx row index
287
- * @param context the widget context. Used to access the default formatters. Leave undefined to not use the theme
288
- * default formatters.
289
- */
290
- getFormattedValueOrValue(idx: number, context?: IPublicContext): string | undefined;
291
- getNumberFormatInfo(): string | undefined;
292
- /**
293
- * Get cell as expected by XLSX library (do not include the interface as it is lazy loaded!).
294
- * Does not return the format string.
295
- *
296
- * @param idx the position to return the value of.
297
- */
298
- getExcelCell(idx: number): ITidyColumnXlsxCell | undefined;
299
- /**
300
- * Returns excel format, best effort
301
- */
302
- getExcelFormat(): string | undefined;
303
- /**
304
- * Returns the type for Material-UI Table/Grid
305
- */
306
- getXGridType(): "string" | "number" | "date" | "dateTime" | "boolean" | undefined;
307
- /**
308
- * Return the cell decoration of the column at `rowIdx`. If the cell has multiple renderers, this method returns
309
- * the last added one.
310
- */
311
- getCellDecoration(rowIdx: number): PublicTidyColumnCellDecorationRendered | undefined;
312
- /**
313
- * Returns true if the column has a property of requested name.
314
- */
315
- hasProperty(name: ITidyColumnNamedProperties | string): boolean;
316
- /**
317
- * Returns the color column (if defined).
318
- *
319
- * If the column has type 'color', then it returns itself. Else it returns the
320
- * column of the first property(1) with type 'color' (if it is defined).
321
- *
322
- * (1) the fore color property is excluded.
323
- */
324
- getColorColumn(): ITidyColorColumn | undefined;
325
- /**
326
- * Returns the color of a cell (if defined).
327
- *
328
- * If the column has type 'color', then it returns the cell value. Else it returns the
329
- * value at rowIdx of the first property(1) with type 'color' (if it is defined).
330
- *
331
- * (1) the fore color property is excluded.
332
- */
333
- getColor(rowIdx: number): Property.Color | undefined;
334
- /**
335
- * Returns the property at the specified property coordinate.
336
- * @param name name of the property.
337
- */
338
- getProperty(name: ITidyColumnNamedProperties | string): ITidyUnknownColumn;
339
- /**
340
- * Returns the property at the specified property coordinate.
341
- * @param name name of the property.
342
- */
343
- getOptionalProperty(name: ITidyColumnNamedProperties | string): ITidyUnknownColumn | undefined;
344
- /**
345
- * Get the value of the property for the given property coordinate, and the given row (undefined if the property
346
- * does not exist).
347
- * @param name name of the property.
348
- * @param rowIdx row index for the value to return.
349
- */
350
- getPropertyAt(name: ITidyColumnNamedProperties | string, rowIdx: number): any;
351
- /**
352
- * Return available properties for this column as a list of columns.
353
- */
354
- getPropertiesAsColumns(): ITidyUnknownColumn[];
355
- isWithEntityItem(): boolean;
356
- /**
357
- * Create and return the entity item at position idx for generating events.
358
- */
359
- getEntityItem(idx: number): EntityItem | undefined;
360
- /**
361
- * Get the entity item for the column. Used in column selection.
362
- * Returns an empty array if no entityItems.
363
- * @param hierarchyIndices only include these hierarchies for generating the EntityItem. Leave undefined to include
364
- * all.
365
- */
366
- getColumnEntityItem(hierarchyIndices?: number[]): EntityItem[];
367
- /**
368
- * Get the index of the parent. Returns -1 if the parent is the root.
369
- * @param idx the index to find the parent of.
370
- */
371
- getParentIdx(idx: number): number;
372
- /**
373
- * Return the descendants of the node in the hierarchy at the index.
374
- * Returned set excludes the node itself.
375
- * @param index
376
- */
377
- getDescendants(index: number): number[];
378
- /**
379
- * Returns true if and only if the node in the hierarchy has children.
380
- */
381
- hasChildren(index: number): boolean;
382
- /**
383
- * Returns the children of the node at `index`.
384
- */
385
- getChildren(index: number): number[];
386
- /**
387
- * Return the siblings of the node in the hierarchy at the index.
388
- * Including the node itself.
389
- * @param index
390
- */
391
- getSiblings(index: number): number[];
392
- /**
393
- * Get the default member of the dimension that the column represents. Returns undefined
394
- * if the column is not a MDX dimension.
395
- */
396
- getHierarchyDefaultMember(): EntityItem | undefined;
397
- /**
398
- * Get the array of MDX info in the column.
399
- * Returns an empty array if no MDX info.
400
- */
401
- getMdxInfos(): (MdxInfo | undefined)[];
402
- /**
403
- * Returns the MDX info at a row index.
404
- */
405
- getMdxInfo(idx: number): MdxInfo | undefined;
406
- /**
407
- * Returns the key from the model. Values with the same key are the same in the underlying model. Rows
408
- * with the same value but with a different key, are treated as different values.
409
- * @param rowIdx
410
- */
411
- getUid(rowIdx: number): string;
412
- /**
413
- * Get extra information of the MDX axis used for this column, if available.
414
- */
415
- getAxisInfo(): IMdxAxisSeriesInfo | undefined;
416
- /**
417
- * Get the MDX axis coordinate, if available.
418
- * @see AxisCoordinate
419
- */
420
- getAxisCoordinate(): AxisCoordinate | undefined;
421
- /**
422
- * Get the axis values in this column.
423
- *
424
- * If it is an MDX Axis, the potentially sorted MDX axis (e.g., pivot table sort)
425
- *
426
- * If it is not, return undefined
427
- */
428
- mdxAxis(): ReadonlyArray<T> | undefined;
429
- /**
430
- * Get the unique values in this column.
431
- */
432
- unique(ignoreNull: boolean): T[];
433
- /**
434
- * Set the name of the column.
435
- * @param name set this as the caption of the column.
436
- *
437
- * Note, do not use this for columns that are in tables as it can cause duplicate columns in a table.
438
- * Use setCaption to change the name visible to the user.
439
- */
440
- setName(name: string): void;
441
- /**
442
- * Set the number/date formatter of the column, calculating and adding the 'formattedValue' property.
443
- */
444
- setNumberFormat(format: ThemeTextFormatter | undefined): void;
445
- /**
446
- * Set the caption of the column. The caption is used for displaying localised
447
- * or custom captions for the axis, header, etc.
448
- * @param caption set this as the caption of the column.
449
- */
450
- setCaption(caption: string): void;
451
- /**
452
- * Returns true if and only if the column has a caption different from the default. The default caption is the
453
- * columns name.
454
- */
455
- hasCaption(): boolean;
456
- /**
457
- * Convert the column to another type. This modifies the values to be of that type.
458
- *
459
- * If type is datetime, then the settings contain the date locale (default='en_US'), and
460
- * the dateformat (default = 'yyyy-MM-dd').
461
- */
462
- convertToType(type: TidyColumnsType, settings?: ConvertToTypeParseSettings): void;
463
- /**
464
- * Same as convertToType but creating a new column.
465
- */
466
- convertToTypeN(type: TidyColumnsType, settings?: ConvertToTypeParseSettings): ITidyBaseColumn<T>;
467
- /**
468
- * Create a new column with the content of this column changing both its name and its caption.
469
- */
470
- duplicate(name: string, caption: string): ITidyBaseColumn<T>;
471
- /**
472
- * Change the values of the column.
473
- * @param values the new values for the column.
474
- * @param newType the new type for the column. Leave undefined for automatic inference.
475
- */
476
- setValues<P>(values: P[], newType?: AllowedColumnType<P>): void;
477
- /**
478
- * Apply a transformation to all values in the column. Note, this functions alters the values in the column.
479
- * @param fun function with one parameter. Describes the transformation. In the function, index represents the
480
- * index of the internal data structure.
481
- * @param newType new type for the column. Leave blank for auto inference of the type.
482
- */
483
- apply<P>(fun: (value: T, index: number) => P, newType?: AllowedColumnType<P>): void;
484
- /**
485
- * Insert values at a row index.
486
- * Structure: Map: row idx -> values to insert
487
- *
488
- * e.g., add totals.
489
- */
490
- insertValues(inserts: Map<number, ITidyColumnAddValue[]>): void;
491
- /**
492
- * Repeat the values in the column.
493
- *
494
- * Examples:
495
- * column.getValues() --> ['a','b','c']
496
- * column.repeat(6,1) --> ['a','b','c','a','b','c']
497
- * column.repeat(6,2) --> ['a','a','b','b','c','c']
498
- * column.repeat(12,2) --> ['a','a','b','b','c','c','a','a','b','b','c','c']
499
- *
500
- * @param newLength new length of the array.
501
- * @param repetition how many times to repeat each value.
502
- */
503
- repeat(newLength: number, repetition?: number): void;
504
- /**
505
- * Same as repeat but creating a new column leaving this column untouched.
506
- *
507
- * @see repeat
508
- */
509
- repeatN(newLength: number, repetition?: number): ITidyBaseColumn<T>;
510
- /**
511
- * Push a value to the end of the column's values.
512
- */
513
- pushValue(pushValue: ITidyColumnTypedValue): void;
514
- /**
515
- * Apply a new index to the column and its properties (e.g., limiting rows, reordering rows, copying rows).
516
- *
517
- * Examples:
518
- * <pre>
519
- * initial values -> [ 'a', 'b', 'c']
520
- * reIndex: [2,1,0] -> [ 'c', 'b', 'a']
521
- * reIndex: [2,2,1] -> [ 'c', 'c', 'b']
522
- * reIndex: [0,1,2,2] -> [ 'a', 'b', 'c','c']
523
- * reIndex: [0] -> [ 'a' ]
524
- * reIndex: [0,5] -> [ 'a', null ]
525
- * </pre>
526
- *
527
- * @param index new row indices
528
- *
529
- * @see ITidyColumn.reIndexN
530
- */
531
- reIndex(index: number[]): void;
532
- /**
533
- * Reset the index set using `reIndex`.
534
- */
535
- resetIndex(): void;
536
- /**
537
- * Set the formatted values. Use this if you have the formatted values pre-calculated,
538
- * or a function to calculate the formatted values.
539
- * @param caption the caption for the added property.
540
- */
541
- setFormattedValues(formattedValues: (string | null)[] | ((value: T | undefined) => string), caption?: string): void;
542
- /**
543
- * Resets the formatted value
544
- *
545
- * @see setFormattedValues
546
- */
547
- resetFormat(context: IPublicContext, format: ThemeTextFormatter): void;
548
- /**
549
- * Set the colors for the column.
550
- * @param caption the caption for the added property.
551
- */
552
- setColors(colors: (Property.Color | null)[], caption?: string): void;
553
- /**
554
- * Return a new column with transformed values.
555
- * @param fun function with one parameter. Describes the transformation.
556
- * @param columnName the name of the new column.
557
- * @param newType new type for the column. Leave blank for auto inference of the type.
558
- */
559
- mapToColumn<P>(fun: (value: T, index: number) => P, columnName: string, newType: AllowedColumnType<P>): ITidyBaseColumn<P>;
560
- /**
561
- *
562
- * if it's an mdx axis, for each row of the undelying mdx Axis
563
- * if no, for each row
564
- *
565
- * @see mdxAxis
566
- */
567
- mapAxisOrRows<K>(callbackfn: (rowIdx: number, column: ITidyBaseColumn<T>) => K): K[];
568
- /**
569
- * @param callbackFn if the return value of callbackFn is undefined, then it is not included in the returned array.
570
- * @param forceMapAllRows if true, also include values returned by callbackFn that are undefined.
571
- */
572
- mapAllRows<P>(callbackFn: (index: number, column: ITidyBaseColumn<T>) => P | undefined, forceMapAllRows?: boolean): P[];
573
- /**
574
- * Map the rows that are visible given a hierarchical axis, and an array of boolean values
575
- * @param expanded a function indicating for each index if it is expanded or not. If it is collapsed, then all
576
- * children are not visible.
577
- * @param fun function to apply.
578
- */
579
- mapVisibleRows<P>(expanded: (rowIdx: number) => boolean, fun: (index: number) => P): P[];
580
- /**
581
- * Apply a function to all visible nodes in the column. A nodes' children are visible if expanded evaluates to
582
- * true for that node.
583
- * @param filter Possibly filter the nodes.
584
- */
585
- mapTreeVisibleRows<P>(expanded: (rowIdx: number) => boolean, fun: (rowIdx: number, isCollapsed: boolean) => P, filter?: (info: MdxInfo) => boolean): P[];
586
- /**
587
- * Set a property on the column. If the property already exists, it is overwritten.
588
- * @param property the column to set as a property. Ensure that the lengths are the same.
589
- */
590
- setProperty(property: ITidyColumn): void;
591
- /**
592
- * Delete a property on the column
593
- */
594
- deleteProperty(propertyName: ITidyColumn | string): void;
595
- /**
596
- * The ITidyTableSelection row identifier for the row (uniqueName if it is an MDX like column).
597
- */
598
- getSelectionRowIdentifier(idx: number): string;
599
- /**
600
- * Returns the row index of the first occurrence where the values of this column equals value.
601
- * Returns undefined if it did not find the value.
602
- *
603
- * @param value value to search for.
604
- */
605
- getRowIndexOf(value: T): number | undefined;
606
- /**
607
- * For a hierarchical columns returns a list of transformed columns as needed by a pivot table like structure.
608
- * If this column is not hierarchical, return this unchanged.
609
- *
610
- * E.g., a columns with Year, Quarter and Month will be converted into 3 columns [Year, Quarter, Month].
611
- */
612
- toFlatColumns(nullValue: any, rows: number[] | undefined): ITidyUnknownColumn[];
613
- /**
614
- * Returns the tree-path for the node, including the node itself. The path starts at the node at rowIdx and contains
615
- * its parents.
616
- * @param rowIdx column index of the node.
617
- */
618
- getNodePath(rowIdx: number): number[];
619
- /**
620
- * Returns if present a notification as defined by the properties of the columns.
621
- */
622
- getAppNotification(rowIdx: number): AppNotification | undefined;
623
- /**
624
- * Returns if present an action as defined by the properties of the columns.
625
- */
626
- getEventAction(rowIdx: number): [string, TidyActionEvent] | undefined;
627
- mapUniqueNames<T>(uniqueNames: string[], mapper: (idx: number) => T | null | undefined): T[];
628
- /**
629
- * Add the renderer to the column. If a cell has multiple renderers, it uses the last added renderer.
630
- *
631
- * @see {BaseTidyColumnCellDecoration.appliesToCell}.
632
- */
633
- setCellDecoration(decoration: PublicTidyColumnCellDecoration): void;
634
- /**
635
- * Return the index of the column.
636
- * @see tidyTable.
637
- */
638
- getIndex(): ITidyColumnIndex[];
639
- /**
640
- * undefined if it is not an MDX member column
641
- */
642
- getQueryNodeIdentifier(idx: number): MdxNodeIdentifier | undefined;
643
- /**
644
- * Returns the group key at the row index for use with `table.toAmcharts4Data`.
645
- */
646
- getAmcharts4GroupKey(rowIdx: number): string;
647
- /**
648
- * Mark the column as a total column. Total columns have a different styling and css-class in tables and pivot
649
- * tables.
650
- * @param isTotal new value. Set to true to mark this column as a total. Use false to remove the mark.
651
- * @see isTotalColumn
652
- */
653
- setIsTotalColumn(isTotal: boolean): void;
654
- /**
655
- * Returns true if and only if the column contains total values.
656
- * @see setTotalColumn
657
- */
658
- getIsTotalColumn(): boolean;
659
- /**
660
- * return true if the column was created from an MDX axis (i.e., [Geo].[Countries] on 0).
661
- */
662
- isMdxAxis(): boolean;
663
- addRowValue(insert: ITidyColumnAddValueInsert): void;
664
- /**
665
- * Returns true if and only if the all the datetime values in the column are dates (and do not have a time
666
- * component).
667
- */
668
- hasOnlyDates(): boolean;
669
- /**
670
- * Returns the level depth of the column.
671
- *
672
- * E.g., if you have a table with `2018`, `2018 Q1` as columns, then the level depths are 0 and 1.
673
- */
674
- getColumnLevelDepth(): number;
675
- }
676
- export interface BaseTidyColumnCellDecoration {
677
- /**
678
- * If true, the renderer handles errors in the cells. If false, the table/pivot table renders an error if the cell
679
- * has one.
680
- *
681
- * Use `column.getError(tidyRow)` to get the error of a cell.
682
- */
683
- handlesCellsOnError?: boolean;
684
- /**
685
- * Default (i.e., when not defined) is true.
686
- */
687
- handlesBackgroundColor?: boolean;
688
- /**
689
- * A function that determines if the renderer is applied to a cell. Return true if yes, return false if not.
690
- * @param rowIdx row index.
691
- */
692
- appliesToCell?: (rowIdx: number) => boolean;
693
- /**
694
- * If an object is returned the underlying code uses emotion CSS function to convert to a className,
695
- * so you can do className like CSS :
696
- *
697
- * ```TypeScript
698
- * {
699
- * fontSize: "0.7rem",
700
- * ':hover': {
701
- * fontSize: "1.4rem",
702
- * }
703
- * }
704
- * ```
705
- */
706
- cssStyles?: (rowIdx: number) => Record<string, any> | undefined;
707
- }
708
- export interface ReactTidyColumnCellDecoration extends BaseTidyColumnCellDecoration {
709
- /**
710
- * False if your renderer returns a React element or if you have no renderer.
711
- */
712
- stringRenderer?: false;
713
- /**
714
- * The cell renders the returned React element. Note that for the Pivot Table, Emotion CSS and JS does not work.
715
- */
716
- renderer?: (rowIdx: number) => React.ReactElement;
717
- }
718
- export interface HtmlTidyColumnCellDecoration extends BaseTidyColumnCellDecoration {
719
- /**
720
- * True if your renderer returns a HTML string.
721
- */
722
- stringRenderer: true;
723
- /**
724
- * The cell renders the returned string as HTML.
725
- */
726
- renderer: (rowIdx: number) => string;
727
- }
728
- export type PublicTidyColumnCellDecoration = ReactTidyColumnCellDecoration | HtmlTidyColumnCellDecoration;
729
- /**
730
- * The renderer for a cell at a row index.
731
- *
732
- * @see {PublicTidyColumnCellDecoration}
733
- */
734
- export type PublicTidyColumnCellDecorationRendered = ({
735
- stringRenderer: true;
736
- renderer: () => string;
737
- } | {
738
- stringRenderer?: false;
739
- renderer?: () => React.ReactElement;
740
- }) & {
741
- handlesCellsOnError?: boolean;
742
- handlesBackgroundColor?: boolean;
743
- cssStyles?: () => Record<string, any> | undefined;
744
- };
745
- export type ITidyColumn = ITidyBaseColumn<any>;
746
- export type ITidyUnknownColumn = ITidyBaseColumn<unknown>;
747
- export type ITidyNullColumn = ITidyBaseColumn<null>;
748
- export type ITidyNumericColumn = ITidyBaseColumn<number | null>;
749
- export type ITidyCharacterColumn = ITidyBaseColumn<string | null>;
750
- export type ITidyColorColumn = ITidyBaseColumn<Property.Color | null>;
751
- export type ITidyDateColumn = ITidyBaseColumn<Date | null>;
752
- export type ITidyLogicalColumn = ITidyBaseColumn<boolean | null>;
753
- export type ITidyListColumn = ITidyBaseColumn<any[] | null>;
754
- export type ITidyColumnIsType<T extends TidyColumnsType> = T extends TidyColumnsType.ANY ? ITidyColumn : T extends TidyColumnsType.COLOR ? ITidyColorColumn : T extends TidyColumnsType.LONGITUDE ? ITidyBaseColumn<number | null> : T extends TidyColumnsType.LATITUDE ? ITidyBaseColumn<number | null> : T extends TidyColumnsType.ISO2_LOCATION_CODE ? ITidyCharacterColumn : T extends TidyColumnsType.DATETIME ? ITidyDateColumn : T extends TidyColumnsType.NUMERIC ? ITidyNumericColumn : T extends TidyColumnsType.CHARACTER ? ITidyCharacterColumn : T extends TidyColumnsType.LOGICAL ? ITidyLogicalColumn : T extends TidyColumnsType.LIST ? ITidyListColumn : T extends TidyColumnsType.MIXED ? ITidyColumn : T extends TidyColumnsType.NULL ? ITidyNullColumn : ITidyUnknownColumn;
755
- export {};