@gooddata/sdk-code-schemas 11.59.0-alpha.1 → 11.59.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.
- package/esm/sdk-code-schemas.d.ts +2574 -847
- package/esm/tsdoc-metadata.json +1 -1
- package/esm/v1/metadata.d.ts +656 -13
- package/esm/v1/metadata.d.ts.map +1 -1
- package/esm/v1/metadata.json +778 -2
- package/esm/v1/schema.d.ts +1134 -206
- package/esm/v1/schema.d.ts.map +1 -1
- package/package.json +4 -4
package/esm/v1/metadata.d.ts
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
* JSON schema for Gooddata Analytics
|
|
8
8
|
*/
|
|
9
9
|
export type Metadata = Metadata1 & Metadata2;
|
|
10
|
-
export type Metadata2 = Metadata3 | Metadata6 | Metadata9 | Metadata12 | Metadata15 | Metadata18 | Metadata21 | Metadata24 | Metadata27 | Metadata30;
|
|
10
|
+
export type Metadata2 = Metadata3 | Metadata6 | Metadata9 | Metadata12 | Metadata15 | Metadata18 | Metadata21 | Metadata24 | Metadata27 | Metadata30 | Metadata33 | Metadata36 | Metadata39;
|
|
11
11
|
/**
|
|
12
12
|
* JSON schema for Gooddata Analytics
|
|
13
13
|
*/
|
|
@@ -1128,15 +1128,187 @@ export type Tags36 = string[];
|
|
|
1128
1128
|
* JSON schema for Gooddata Analytics
|
|
1129
1129
|
*/
|
|
1130
1130
|
export type Metadata30 = Metadata31 & Metadata32;
|
|
1131
|
-
export type Metadata32 =
|
|
1131
|
+
export type Metadata32 = Report;
|
|
1132
|
+
/**
|
|
1133
|
+
* A unique identifier of the report.
|
|
1134
|
+
*/
|
|
1135
|
+
export type Id45 = string;
|
|
1136
|
+
/**
|
|
1137
|
+
* A list of strings - metadata tags of this report.
|
|
1138
|
+
*/
|
|
1139
|
+
export type Tags37 = string[];
|
|
1140
|
+
/**
|
|
1141
|
+
* An id for this page, unique within the document.
|
|
1142
|
+
*/
|
|
1143
|
+
export type Id46 = string;
|
|
1144
|
+
/**
|
|
1145
|
+
* Editor hint only, for template galleries, default styling and AI context. Geometry always comes from the layout.
|
|
1146
|
+
*/
|
|
1147
|
+
export type ReportPageKind = "cover" | "section" | "content";
|
|
1148
|
+
/**
|
|
1149
|
+
* Page proportions the layout was authored for. Defaults to widescreen.
|
|
1150
|
+
*/
|
|
1151
|
+
export type ReportPageFormat = "widescreen" | "a4Portrait" | "letterPortrait";
|
|
1152
|
+
/**
|
|
1153
|
+
* What the box paints behind its content.
|
|
1154
|
+
*/
|
|
1155
|
+
export type ReportBackground = ReportBackground1 | ReportBackground2;
|
|
1156
|
+
/**
|
|
1157
|
+
* CSS color value painted behind the content.
|
|
1158
|
+
*/
|
|
1159
|
+
export type ReportBackground1 = string;
|
|
1160
|
+
/**
|
|
1161
|
+
* Image painted behind the content.
|
|
1162
|
+
*/
|
|
1163
|
+
export type ReportBackgroundImage = ReportBackgroundImage1 | ReportBackgroundImage2;
|
|
1164
|
+
/**
|
|
1165
|
+
* An id of an image already written down elsewhere on this page, drawn here as well.
|
|
1166
|
+
*/
|
|
1167
|
+
export type Id47 = string;
|
|
1168
|
+
/**
|
|
1169
|
+
* An id for this area, unique within the page. It is what a report fills when it takes this page from a template, so an id written down here survives edits to the layout around it.
|
|
1170
|
+
*/
|
|
1171
|
+
export type Id48 = string;
|
|
1172
|
+
/**
|
|
1173
|
+
* Backend-managed asset rendered as the image. Mutually exclusive with url.
|
|
1174
|
+
*/
|
|
1175
|
+
export type Id49 = string;
|
|
1176
|
+
export type ReportContentAlignment = "start" | "center" | "end";
|
|
1177
|
+
/**
|
|
1178
|
+
* Metadata of a slot intentionally left unfilled. A bare true marks it required; a bare string is the authoring hint.
|
|
1179
|
+
*/
|
|
1180
|
+
export type ReportSlotPlaceholder = ReportSlotPlaceholder1 | ReportSlotPlaceholder2 | ReportSlotPlaceholder3;
|
|
1181
|
+
/**
|
|
1182
|
+
* True marks the slot required: the report is not complete until it is filled.
|
|
1183
|
+
*/
|
|
1184
|
+
export type ReportSlotPlaceholder1 = boolean;
|
|
1185
|
+
/**
|
|
1186
|
+
* Authoring hint shown in the empty slot.
|
|
1187
|
+
*/
|
|
1188
|
+
export type ReportSlotPlaceholder2 = string;
|
|
1189
|
+
/**
|
|
1190
|
+
* Root of the page layout.
|
|
1191
|
+
*/
|
|
1192
|
+
export type ReportLayoutNode = ReportLayoutNode1 | ReportLayoutNode3 | ReportLayoutNode4 | ReportLayoutNode5 | ReportLayoutNode6 | ReportLayoutNode7;
|
|
1193
|
+
/**
|
|
1194
|
+
* A node of the page layout. A node carrying column or row splits its area along that direction; every other node draws content, told apart by the content key it carries.
|
|
1195
|
+
*/
|
|
1196
|
+
export type ReportLayoutNode1 = ReportLayoutColumn;
|
|
1197
|
+
/**
|
|
1198
|
+
* Fractional weight of this node inside its parent. Defaults to 1; sibling weights [2, 1] render a 2/3 + 1/3 split.
|
|
1199
|
+
*/
|
|
1200
|
+
export type ReportLayoutWeight = number;
|
|
1201
|
+
/**
|
|
1202
|
+
* A node of the page layout. A node carrying column or row splits its area along that direction; every other node draws content, told apart by the content key it carries.
|
|
1203
|
+
*/
|
|
1204
|
+
export type ReportLayoutNode2 = ReportLayoutNode1 | ReportLayoutNode3 | ReportLayoutNode4 | ReportLayoutNode5 | ReportLayoutNode6 | ReportLayoutNode7;
|
|
1205
|
+
/**
|
|
1206
|
+
* A node of the page layout. A node carrying column or row splits its area along that direction; every other node draws content, told apart by the content key it carries.
|
|
1207
|
+
*/
|
|
1208
|
+
export type ReportLayoutNode3 = ReportLayoutRow;
|
|
1209
|
+
/**
|
|
1210
|
+
* A node of the page layout. A node carrying column or row splits its area along that direction; every other node draws content, told apart by the content key it carries.
|
|
1211
|
+
*/
|
|
1212
|
+
export type ReportLayoutNode4 = ReportVisualizationSlot;
|
|
1213
|
+
/**
|
|
1214
|
+
* An id of the date dataset the report's period is applied to as an absolute date filter. Omitted leaves the backend date dataset resolution to decide.
|
|
1215
|
+
*/
|
|
1216
|
+
export type Id50 = string;
|
|
1217
|
+
/**
|
|
1218
|
+
* A node of the page layout. A node carrying column or row splits its area along that direction; every other node draws content, told apart by the content key it carries.
|
|
1219
|
+
*/
|
|
1220
|
+
export type ReportLayoutNode5 = ReportHeadingSlot;
|
|
1221
|
+
/**
|
|
1222
|
+
* A line of display text. It carries no markup of its own: what is typed in it is what it renders.
|
|
1223
|
+
*/
|
|
1224
|
+
export type ReportText = ReportText1 | ReportText2;
|
|
1225
|
+
/**
|
|
1226
|
+
* Markdown with \{variable\} placeholders, resolved at render time.
|
|
1227
|
+
*/
|
|
1228
|
+
export type ReportText1 = string;
|
|
1229
|
+
/**
|
|
1230
|
+
* A bare string is the text type. Anything more is written as a mapping.
|
|
1231
|
+
*/
|
|
1232
|
+
export type ReportTextStyle = ReportTextStyle1 | ReportTextStyle2;
|
|
1233
|
+
/**
|
|
1234
|
+
* A bare string is the text type. Anything more is written as a mapping.
|
|
1235
|
+
*/
|
|
1236
|
+
export type ReportTextStyle1 = "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "largeText" | "normalText" | "smallText";
|
|
1237
|
+
/**
|
|
1238
|
+
* Size the text is rendered at. Headings default to h1, paragraphs to normalText. The size owns the typography that goes with it; the rest of the style overrides ink and placement on top of it.
|
|
1239
|
+
*/
|
|
1240
|
+
export type ReportTextType = "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "largeText" | "normalText" | "smallText";
|
|
1241
|
+
/**
|
|
1242
|
+
* A bare string is a color. An image is written as a mapping.
|
|
1243
|
+
*/
|
|
1244
|
+
export type ReportBackground3 = ReportBackground1 | ReportBackground2;
|
|
1245
|
+
/**
|
|
1246
|
+
* A node of the page layout. A node carrying column or row splits its area along that direction; every other node draws content, told apart by the content key it carries.
|
|
1247
|
+
*/
|
|
1248
|
+
export type ReportLayoutNode6 = ReportParagraphSlot;
|
|
1249
|
+
/**
|
|
1250
|
+
* Prose, written as markdown.
|
|
1251
|
+
*/
|
|
1252
|
+
export type ReportText3 = ReportText1 | ReportText2;
|
|
1253
|
+
/**
|
|
1254
|
+
* A node of the page layout. A node carrying column or row splits its area along that direction; every other node draws content, told apart by the content key it carries.
|
|
1255
|
+
*/
|
|
1256
|
+
export type ReportLayoutNode7 = ReportImageSlot;
|
|
1257
|
+
/**
|
|
1258
|
+
* A bare string is the image URL. Anything more is written as a mapping. The id belongs to whatever draws the image, not to the image itself.
|
|
1259
|
+
*/
|
|
1260
|
+
export type ReportImage = ReportImage1 | ReportImage2;
|
|
1261
|
+
/**
|
|
1262
|
+
* Image URL, supporting \{variables\} - a logo uses \{logo\}.
|
|
1263
|
+
*/
|
|
1264
|
+
export type ReportImage1 = string;
|
|
1265
|
+
/**
|
|
1266
|
+
* Backend-managed asset rendered as the image. Mutually exclusive with url.
|
|
1267
|
+
*/
|
|
1268
|
+
export type Id51 = string;
|
|
1269
|
+
/**
|
|
1270
|
+
* JSON schema for Gooddata Analytics
|
|
1271
|
+
*/
|
|
1272
|
+
export type Metadata33 = Metadata34 & Metadata35;
|
|
1273
|
+
export type Metadata35 = ReportTemplate;
|
|
1274
|
+
/**
|
|
1275
|
+
* A unique identifier of the report template.
|
|
1276
|
+
*/
|
|
1277
|
+
export type Id52 = string;
|
|
1278
|
+
/**
|
|
1279
|
+
* A list of strings - metadata tags of this report template.
|
|
1280
|
+
*/
|
|
1281
|
+
export type Tags38 = string[];
|
|
1282
|
+
/**
|
|
1283
|
+
* JSON schema for Gooddata Analytics
|
|
1284
|
+
*/
|
|
1285
|
+
export type Metadata36 = Metadata37 & Metadata38;
|
|
1286
|
+
export type Metadata38 = ReportPageLayout;
|
|
1287
|
+
/**
|
|
1288
|
+
* A unique identifier of the report page layout.
|
|
1289
|
+
*/
|
|
1290
|
+
export type Id53 = string;
|
|
1291
|
+
/**
|
|
1292
|
+
* A list of strings - metadata tags of this report page layout.
|
|
1293
|
+
*/
|
|
1294
|
+
export type Tags39 = string[];
|
|
1295
|
+
/**
|
|
1296
|
+
* A node of the page layout. A node carrying column or row splits its area along that direction; every other node draws content, told apart by the content key it carries.
|
|
1297
|
+
*/
|
|
1298
|
+
export type ReportLayoutNode8 = ReportLayoutNode1 | ReportLayoutNode3 | ReportLayoutNode4 | ReportLayoutNode5 | ReportLayoutNode6 | ReportLayoutNode7;
|
|
1299
|
+
/**
|
|
1300
|
+
* JSON schema for Gooddata Analytics
|
|
1301
|
+
*/
|
|
1302
|
+
export type Metadata39 = Metadata40 & Metadata41;
|
|
1303
|
+
export type Metadata41 = {
|
|
1132
1304
|
[k: string]: unknown;
|
|
1133
1305
|
};
|
|
1134
1306
|
export interface Metadata1 {
|
|
1135
|
-
type: "dataset" | "date" | "metric" | "computed_attribute" | "dashboard" | "plugin" | "table" | "bar_chart" | "column_chart" | "line_chart" | "area_chart" | "scatter_chart" | "bubble_chart" | "pie_chart" | "donut_chart" | "treemap_chart" | "pyramid_chart" | "funnel_chart" | "heatmap_chart" | "bullet_chart" | "waterfall_chart" | "dependency_wheel_chart" | "sankey_chart" | "headline_chart" | "combo_chart" | "geo_chart" | "geo_area_chart" | "repeater_chart" | "radar_chart" | "attribute_hierarchy" | "parameter";
|
|
1307
|
+
type: "dataset" | "date" | "metric" | "computed_attribute" | "dashboard" | "plugin" | "table" | "bar_chart" | "column_chart" | "line_chart" | "area_chart" | "scatter_chart" | "bubble_chart" | "pie_chart" | "donut_chart" | "treemap_chart" | "pyramid_chart" | "funnel_chart" | "heatmap_chart" | "bullet_chart" | "waterfall_chart" | "dependency_wheel_chart" | "sankey_chart" | "headline_chart" | "combo_chart" | "geo_chart" | "geo_area_chart" | "repeater_chart" | "radar_chart" | "attribute_hierarchy" | "parameter" | "report" | "report_template" | "report_page_layout";
|
|
1136
1308
|
[k: string]: unknown;
|
|
1137
1309
|
}
|
|
1138
1310
|
export interface Metadata4 {
|
|
1139
|
-
type: "dataset" | "date" | "metric" | "computed_attribute" | "dashboard" | "plugin" | "table" | "bar_chart" | "column_chart" | "line_chart" | "area_chart" | "scatter_chart" | "bubble_chart" | "pie_chart" | "donut_chart" | "treemap_chart" | "pyramid_chart" | "funnel_chart" | "heatmap_chart" | "bullet_chart" | "waterfall_chart" | "dependency_wheel_chart" | "sankey_chart" | "headline_chart" | "combo_chart" | "geo_chart" | "geo_area_chart" | "repeater_chart" | "radar_chart" | "attribute_hierarchy" | "parameter";
|
|
1311
|
+
type: "dataset" | "date" | "metric" | "computed_attribute" | "dashboard" | "plugin" | "table" | "bar_chart" | "column_chart" | "line_chart" | "area_chart" | "scatter_chart" | "bubble_chart" | "pie_chart" | "donut_chart" | "treemap_chart" | "pyramid_chart" | "funnel_chart" | "heatmap_chart" | "bullet_chart" | "waterfall_chart" | "dependency_wheel_chart" | "sankey_chart" | "headline_chart" | "combo_chart" | "geo_chart" | "geo_area_chart" | "repeater_chart" | "radar_chart" | "attribute_hierarchy" | "parameter" | "report" | "report_template" | "report_page_layout";
|
|
1140
1312
|
[k: string]: unknown;
|
|
1141
1313
|
}
|
|
1142
1314
|
export interface NormalDataset {
|
|
@@ -1539,7 +1711,7 @@ export interface Fields2 {
|
|
|
1539
1711
|
};
|
|
1540
1712
|
}
|
|
1541
1713
|
export interface Metadata7 {
|
|
1542
|
-
type: "dataset" | "date" | "metric" | "computed_attribute" | "dashboard" | "plugin" | "table" | "bar_chart" | "column_chart" | "line_chart" | "area_chart" | "scatter_chart" | "bubble_chart" | "pie_chart" | "donut_chart" | "treemap_chart" | "pyramid_chart" | "funnel_chart" | "heatmap_chart" | "bullet_chart" | "waterfall_chart" | "dependency_wheel_chart" | "sankey_chart" | "headline_chart" | "combo_chart" | "geo_chart" | "geo_area_chart" | "repeater_chart" | "radar_chart" | "attribute_hierarchy" | "parameter";
|
|
1714
|
+
type: "dataset" | "date" | "metric" | "computed_attribute" | "dashboard" | "plugin" | "table" | "bar_chart" | "column_chart" | "line_chart" | "area_chart" | "scatter_chart" | "bubble_chart" | "pie_chart" | "donut_chart" | "treemap_chart" | "pyramid_chart" | "funnel_chart" | "heatmap_chart" | "bullet_chart" | "waterfall_chart" | "dependency_wheel_chart" | "sankey_chart" | "headline_chart" | "combo_chart" | "geo_chart" | "geo_area_chart" | "repeater_chart" | "radar_chart" | "attribute_hierarchy" | "parameter" | "report" | "report_template" | "report_page_layout";
|
|
1543
1715
|
[k: string]: unknown;
|
|
1544
1716
|
}
|
|
1545
1717
|
export interface DateDataset {
|
|
@@ -1565,7 +1737,7 @@ export interface DateDataset {
|
|
|
1565
1737
|
granularities?: ("SECOND" | "MINUTE" | "HOUR" | "DAY" | "WEEK" | "WEEK_US" | "MONTH" | "QUARTER" | "YEAR" | "SECOND_OF_MINUTE" | "SECOND_OF_DAY" | "MINUTE_OF_HOUR" | "MINUTE_OF_DAY" | "HOUR_OF_DAY" | "DAY_OF_WEEK" | "DAY_OF_WEEK_EU" | "DAY_OF_MONTH" | "DAY_OF_YEAR" | "DAY_OF_QUARTER" | "WEEK_OF_YEAR" | "WEEK_OF_YEAR_EU" | "WEEK_OF_QUARTER_EU" | "WEEK_OF_QUARTER" | "MONTH_OF_YEAR" | "MONTH_OF_QUARTER" | "QUARTER_OF_YEAR" | "FISCAL_YEAR" | "FISCAL_QUARTER" | "FISCAL_MONTH")[];
|
|
1566
1738
|
}
|
|
1567
1739
|
export interface Metadata10 {
|
|
1568
|
-
type: "dataset" | "date" | "metric" | "computed_attribute" | "dashboard" | "plugin" | "table" | "bar_chart" | "column_chart" | "line_chart" | "area_chart" | "scatter_chart" | "bubble_chart" | "pie_chart" | "donut_chart" | "treemap_chart" | "pyramid_chart" | "funnel_chart" | "heatmap_chart" | "bullet_chart" | "waterfall_chart" | "dependency_wheel_chart" | "sankey_chart" | "headline_chart" | "combo_chart" | "geo_chart" | "geo_area_chart" | "repeater_chart" | "radar_chart" | "attribute_hierarchy" | "parameter";
|
|
1740
|
+
type: "dataset" | "date" | "metric" | "computed_attribute" | "dashboard" | "plugin" | "table" | "bar_chart" | "column_chart" | "line_chart" | "area_chart" | "scatter_chart" | "bubble_chart" | "pie_chart" | "donut_chart" | "treemap_chart" | "pyramid_chart" | "funnel_chart" | "heatmap_chart" | "bullet_chart" | "waterfall_chart" | "dependency_wheel_chart" | "sankey_chart" | "headline_chart" | "combo_chart" | "geo_chart" | "geo_area_chart" | "repeater_chart" | "radar_chart" | "attribute_hierarchy" | "parameter" | "report" | "report_template" | "report_page_layout";
|
|
1569
1741
|
[k: string]: unknown;
|
|
1570
1742
|
}
|
|
1571
1743
|
export interface Metric {
|
|
@@ -1599,7 +1771,7 @@ export interface Metric {
|
|
|
1599
1771
|
is_hidden?: boolean;
|
|
1600
1772
|
}
|
|
1601
1773
|
export interface Metadata13 {
|
|
1602
|
-
type: "dataset" | "date" | "metric" | "computed_attribute" | "dashboard" | "plugin" | "table" | "bar_chart" | "column_chart" | "line_chart" | "area_chart" | "scatter_chart" | "bubble_chart" | "pie_chart" | "donut_chart" | "treemap_chart" | "pyramid_chart" | "funnel_chart" | "heatmap_chart" | "bullet_chart" | "waterfall_chart" | "dependency_wheel_chart" | "sankey_chart" | "headline_chart" | "combo_chart" | "geo_chart" | "geo_area_chart" | "repeater_chart" | "radar_chart" | "attribute_hierarchy" | "parameter";
|
|
1774
|
+
type: "dataset" | "date" | "metric" | "computed_attribute" | "dashboard" | "plugin" | "table" | "bar_chart" | "column_chart" | "line_chart" | "area_chart" | "scatter_chart" | "bubble_chart" | "pie_chart" | "donut_chart" | "treemap_chart" | "pyramid_chart" | "funnel_chart" | "heatmap_chart" | "bullet_chart" | "waterfall_chart" | "dependency_wheel_chart" | "sankey_chart" | "headline_chart" | "combo_chart" | "geo_chart" | "geo_area_chart" | "repeater_chart" | "radar_chart" | "attribute_hierarchy" | "parameter" | "report" | "report_template" | "report_page_layout";
|
|
1603
1775
|
[k: string]: unknown;
|
|
1604
1776
|
}
|
|
1605
1777
|
export interface ComputedAttribute {
|
|
@@ -1649,7 +1821,7 @@ export interface ComputedAttribute {
|
|
|
1649
1821
|
locale?: Locale3;
|
|
1650
1822
|
}
|
|
1651
1823
|
export interface Metadata16 {
|
|
1652
|
-
type: "dataset" | "date" | "metric" | "computed_attribute" | "dashboard" | "plugin" | "table" | "bar_chart" | "column_chart" | "line_chart" | "area_chart" | "scatter_chart" | "bubble_chart" | "pie_chart" | "donut_chart" | "treemap_chart" | "pyramid_chart" | "funnel_chart" | "heatmap_chart" | "bullet_chart" | "waterfall_chart" | "dependency_wheel_chart" | "sankey_chart" | "headline_chart" | "combo_chart" | "geo_chart" | "geo_area_chart" | "repeater_chart" | "radar_chart" | "attribute_hierarchy" | "parameter";
|
|
1824
|
+
type: "dataset" | "date" | "metric" | "computed_attribute" | "dashboard" | "plugin" | "table" | "bar_chart" | "column_chart" | "line_chart" | "area_chart" | "scatter_chart" | "bubble_chart" | "pie_chart" | "donut_chart" | "treemap_chart" | "pyramid_chart" | "funnel_chart" | "heatmap_chart" | "bullet_chart" | "waterfall_chart" | "dependency_wheel_chart" | "sankey_chart" | "headline_chart" | "combo_chart" | "geo_chart" | "geo_area_chart" | "repeater_chart" | "radar_chart" | "attribute_hierarchy" | "parameter" | "report" | "report_template" | "report_page_layout";
|
|
1653
1825
|
[k: string]: unknown;
|
|
1654
1826
|
}
|
|
1655
1827
|
export interface Dashboard {
|
|
@@ -1977,6 +2149,16 @@ export interface DashboardFilters {
|
|
|
1977
2149
|
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
1978
2150
|
* This interface was referenced by `DashboardFilters1`'s JSON-Schema definition
|
|
1979
2151
|
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
2152
|
+
* This interface was referenced by `DashboardFilters2`'s JSON-Schema definition
|
|
2153
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
2154
|
+
* This interface was referenced by `DashboardFilters3`'s JSON-Schema definition
|
|
2155
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
2156
|
+
* This interface was referenced by `DashboardFilters4`'s JSON-Schema definition
|
|
2157
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
2158
|
+
* This interface was referenced by `DashboardFilters5`'s JSON-Schema definition
|
|
2159
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
2160
|
+
* This interface was referenced by `DashboardFilters6`'s JSON-Schema definition
|
|
2161
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
1980
2162
|
*/
|
|
1981
2163
|
[k: string]: DashboardAbsoluteDateFilter | DashboardRelativeDateFilter | DashboardAttributeFilter | DashboardTextFilter | DashboardMetricValueFilter | DashboardFilterGroup;
|
|
1982
2164
|
}
|
|
@@ -2145,6 +2327,16 @@ export interface DashboardFilters1 {
|
|
|
2145
2327
|
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
2146
2328
|
* This interface was referenced by `DashboardFilters1`'s JSON-Schema definition
|
|
2147
2329
|
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
2330
|
+
* This interface was referenced by `DashboardFilters2`'s JSON-Schema definition
|
|
2331
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
2332
|
+
* This interface was referenced by `DashboardFilters3`'s JSON-Schema definition
|
|
2333
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
2334
|
+
* This interface was referenced by `DashboardFilters4`'s JSON-Schema definition
|
|
2335
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
2336
|
+
* This interface was referenced by `DashboardFilters5`'s JSON-Schema definition
|
|
2337
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
2338
|
+
* This interface was referenced by `DashboardFilters6`'s JSON-Schema definition
|
|
2339
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
2148
2340
|
*/
|
|
2149
2341
|
[k: string]: DashboardAbsoluteDateFilter | DashboardRelativeDateFilter | DashboardAttributeFilter | DashboardTextFilter | DashboardMetricValueFilter | DashboardFilterGroup;
|
|
2150
2342
|
}
|
|
@@ -2158,7 +2350,7 @@ export interface Permission {
|
|
|
2158
2350
|
[k: string]: unknown;
|
|
2159
2351
|
}
|
|
2160
2352
|
export interface Metadata19 {
|
|
2161
|
-
type: "dataset" | "date" | "metric" | "computed_attribute" | "dashboard" | "plugin" | "table" | "bar_chart" | "column_chart" | "line_chart" | "area_chart" | "scatter_chart" | "bubble_chart" | "pie_chart" | "donut_chart" | "treemap_chart" | "pyramid_chart" | "funnel_chart" | "heatmap_chart" | "bullet_chart" | "waterfall_chart" | "dependency_wheel_chart" | "sankey_chart" | "headline_chart" | "combo_chart" | "geo_chart" | "geo_area_chart" | "repeater_chart" | "radar_chart" | "attribute_hierarchy" | "parameter";
|
|
2353
|
+
type: "dataset" | "date" | "metric" | "computed_attribute" | "dashboard" | "plugin" | "table" | "bar_chart" | "column_chart" | "line_chart" | "area_chart" | "scatter_chart" | "bubble_chart" | "pie_chart" | "donut_chart" | "treemap_chart" | "pyramid_chart" | "funnel_chart" | "heatmap_chart" | "bullet_chart" | "waterfall_chart" | "dependency_wheel_chart" | "sankey_chart" | "headline_chart" | "combo_chart" | "geo_chart" | "geo_area_chart" | "repeater_chart" | "radar_chart" | "attribute_hierarchy" | "parameter" | "report" | "report_template" | "report_page_layout";
|
|
2162
2354
|
[k: string]: unknown;
|
|
2163
2355
|
}
|
|
2164
2356
|
export interface Plugin {
|
|
@@ -2179,7 +2371,7 @@ export interface Plugin {
|
|
|
2179
2371
|
url: string;
|
|
2180
2372
|
}
|
|
2181
2373
|
export interface Metadata22 {
|
|
2182
|
-
type: "dataset" | "date" | "metric" | "computed_attribute" | "dashboard" | "plugin" | "table" | "bar_chart" | "column_chart" | "line_chart" | "area_chart" | "scatter_chart" | "bubble_chart" | "pie_chart" | "donut_chart" | "treemap_chart" | "pyramid_chart" | "funnel_chart" | "heatmap_chart" | "bullet_chart" | "waterfall_chart" | "dependency_wheel_chart" | "sankey_chart" | "headline_chart" | "combo_chart" | "geo_chart" | "geo_area_chart" | "repeater_chart" | "radar_chart" | "attribute_hierarchy" | "parameter";
|
|
2374
|
+
type: "dataset" | "date" | "metric" | "computed_attribute" | "dashboard" | "plugin" | "table" | "bar_chart" | "column_chart" | "line_chart" | "area_chart" | "scatter_chart" | "bubble_chart" | "pie_chart" | "donut_chart" | "treemap_chart" | "pyramid_chart" | "funnel_chart" | "heatmap_chart" | "bullet_chart" | "waterfall_chart" | "dependency_wheel_chart" | "sankey_chart" | "headline_chart" | "combo_chart" | "geo_chart" | "geo_area_chart" | "repeater_chart" | "radar_chart" | "attribute_hierarchy" | "parameter" | "report" | "report_template" | "report_page_layout";
|
|
2183
2375
|
[k: string]: unknown;
|
|
2184
2376
|
}
|
|
2185
2377
|
export interface AttributeHierarchy {
|
|
@@ -2200,7 +2392,7 @@ export interface AttributeHierarchy {
|
|
|
2200
2392
|
attributes: [AttributeIdentifier6, ...AttributeIdentifier6[]];
|
|
2201
2393
|
}
|
|
2202
2394
|
export interface Metadata25 {
|
|
2203
|
-
type: "dataset" | "date" | "metric" | "computed_attribute" | "dashboard" | "plugin" | "table" | "bar_chart" | "column_chart" | "line_chart" | "area_chart" | "scatter_chart" | "bubble_chart" | "pie_chart" | "donut_chart" | "treemap_chart" | "pyramid_chart" | "funnel_chart" | "heatmap_chart" | "bullet_chart" | "waterfall_chart" | "dependency_wheel_chart" | "sankey_chart" | "headline_chart" | "combo_chart" | "geo_chart" | "geo_area_chart" | "repeater_chart" | "radar_chart" | "attribute_hierarchy" | "parameter";
|
|
2395
|
+
type: "dataset" | "date" | "metric" | "computed_attribute" | "dashboard" | "plugin" | "table" | "bar_chart" | "column_chart" | "line_chart" | "area_chart" | "scatter_chart" | "bubble_chart" | "pie_chart" | "donut_chart" | "treemap_chart" | "pyramid_chart" | "funnel_chart" | "heatmap_chart" | "bullet_chart" | "waterfall_chart" | "dependency_wheel_chart" | "sankey_chart" | "headline_chart" | "combo_chart" | "geo_chart" | "geo_area_chart" | "repeater_chart" | "radar_chart" | "attribute_hierarchy" | "parameter" | "report" | "report_template" | "report_page_layout";
|
|
2204
2396
|
[k: string]: unknown;
|
|
2205
2397
|
}
|
|
2206
2398
|
export interface Parameter {
|
|
@@ -2280,7 +2472,7 @@ export interface NumberParameterConstraints {
|
|
|
2280
2472
|
max?: number;
|
|
2281
2473
|
}
|
|
2282
2474
|
export interface Metadata28 {
|
|
2283
|
-
type: "dataset" | "date" | "metric" | "computed_attribute" | "dashboard" | "plugin" | "table" | "bar_chart" | "column_chart" | "line_chart" | "area_chart" | "scatter_chart" | "bubble_chart" | "pie_chart" | "donut_chart" | "treemap_chart" | "pyramid_chart" | "funnel_chart" | "heatmap_chart" | "bullet_chart" | "waterfall_chart" | "dependency_wheel_chart" | "sankey_chart" | "headline_chart" | "combo_chart" | "geo_chart" | "geo_area_chart" | "repeater_chart" | "radar_chart" | "attribute_hierarchy" | "parameter";
|
|
2475
|
+
type: "dataset" | "date" | "metric" | "computed_attribute" | "dashboard" | "plugin" | "table" | "bar_chart" | "column_chart" | "line_chart" | "area_chart" | "scatter_chart" | "bubble_chart" | "pie_chart" | "donut_chart" | "treemap_chart" | "pyramid_chart" | "funnel_chart" | "heatmap_chart" | "bullet_chart" | "waterfall_chart" | "dependency_wheel_chart" | "sankey_chart" | "headline_chart" | "combo_chart" | "geo_chart" | "geo_area_chart" | "repeater_chart" | "radar_chart" | "attribute_hierarchy" | "parameter" | "report" | "report_template" | "report_page_layout";
|
|
2284
2476
|
[k: string]: unknown;
|
|
2285
2477
|
}
|
|
2286
2478
|
export interface Table {
|
|
@@ -10930,7 +11122,458 @@ export interface VisualisationConfig23 {
|
|
|
10930
11122
|
[k: string]: unknown;
|
|
10931
11123
|
}
|
|
10932
11124
|
export interface Metadata31 {
|
|
10933
|
-
type: "dataset" | "date" | "metric" | "computed_attribute" | "dashboard" | "plugin" | "table" | "bar_chart" | "column_chart" | "line_chart" | "area_chart" | "scatter_chart" | "bubble_chart" | "pie_chart" | "donut_chart" | "treemap_chart" | "pyramid_chart" | "funnel_chart" | "heatmap_chart" | "bullet_chart" | "waterfall_chart" | "dependency_wheel_chart" | "sankey_chart" | "headline_chart" | "combo_chart" | "geo_chart" | "geo_area_chart" | "repeater_chart" | "radar_chart" | "attribute_hierarchy" | "parameter";
|
|
11125
|
+
type: "dataset" | "date" | "metric" | "computed_attribute" | "dashboard" | "plugin" | "table" | "bar_chart" | "column_chart" | "line_chart" | "area_chart" | "scatter_chart" | "bubble_chart" | "pie_chart" | "donut_chart" | "treemap_chart" | "pyramid_chart" | "funnel_chart" | "heatmap_chart" | "bullet_chart" | "waterfall_chart" | "dependency_wheel_chart" | "sankey_chart" | "headline_chart" | "combo_chart" | "geo_chart" | "geo_area_chart" | "repeater_chart" | "radar_chart" | "attribute_hierarchy" | "parameter" | "report" | "report_template" | "report_page_layout";
|
|
11126
|
+
[k: string]: unknown;
|
|
11127
|
+
}
|
|
11128
|
+
export interface Report {
|
|
11129
|
+
id: Id45;
|
|
11130
|
+
type: "report";
|
|
11131
|
+
/**
|
|
11132
|
+
* A human readable title for the report.
|
|
11133
|
+
*/
|
|
11134
|
+
title: string;
|
|
11135
|
+
/**
|
|
11136
|
+
* An optional description of the report.
|
|
11137
|
+
*/
|
|
11138
|
+
description?: string;
|
|
11139
|
+
tags?: Tags37;
|
|
11140
|
+
period: ReportPeriod;
|
|
11141
|
+
/**
|
|
11142
|
+
* Ordered pages of the report. A page is a deep copy taken when it was added, and never changes with the page layout or template it came from.
|
|
11143
|
+
*/
|
|
11144
|
+
pages: ReportPageBody[];
|
|
11145
|
+
filters?: DashboardFilters4;
|
|
11146
|
+
/**
|
|
11147
|
+
* Custom variables the report's text can interpolate as \{name\}. Built-in variable names win a collision.
|
|
11148
|
+
*/
|
|
11149
|
+
variables?: ReportVariable[];
|
|
11150
|
+
/**
|
|
11151
|
+
* Values for the declared variables, keyed by variable name. A variable with no value here falls back to its default.
|
|
11152
|
+
*/
|
|
11153
|
+
variable_values?: {
|
|
11154
|
+
[k: string]: string;
|
|
11155
|
+
};
|
|
11156
|
+
}
|
|
11157
|
+
/**
|
|
11158
|
+
* The finished period the report covers. It is not a filter: at execution time it materializes as an absolute date filter on each visualization's date dataset, at the lowest precedence, which a visualization opts out of with ignore_report_period.
|
|
11159
|
+
*/
|
|
11160
|
+
export interface ReportPeriod {
|
|
11161
|
+
/**
|
|
11162
|
+
* Reported period start, ISO 8601 date (YYYY-MM-DD), inclusive.
|
|
11163
|
+
*/
|
|
11164
|
+
start: string;
|
|
11165
|
+
/**
|
|
11166
|
+
* Reported period end, ISO 8601 date (YYYY-MM-DD), inclusive.
|
|
11167
|
+
*/
|
|
11168
|
+
end: string;
|
|
11169
|
+
}
|
|
11170
|
+
export interface ReportPageBody {
|
|
11171
|
+
id: Id46;
|
|
11172
|
+
kind?: ReportPageKind;
|
|
11173
|
+
format?: ReportPageFormat;
|
|
11174
|
+
style?: ReportBoxStyle;
|
|
11175
|
+
layout: ReportLayoutNode;
|
|
11176
|
+
filters?: DashboardFilters3;
|
|
11177
|
+
}
|
|
11178
|
+
/**
|
|
11179
|
+
* Paint of the page itself, behind everything the layout places.
|
|
11180
|
+
*/
|
|
11181
|
+
export interface ReportBoxStyle {
|
|
11182
|
+
background?: ReportBackground;
|
|
11183
|
+
/**
|
|
11184
|
+
* Corner radius in percent of the page width. Content reaching into a rounded corner is clipped.
|
|
11185
|
+
*/
|
|
11186
|
+
border_radius?: number;
|
|
11187
|
+
/**
|
|
11188
|
+
* Inset of the box's own content, in percent of the page width. Insets only inward.
|
|
11189
|
+
*/
|
|
11190
|
+
padding?: number;
|
|
11191
|
+
}
|
|
11192
|
+
/**
|
|
11193
|
+
* A bare string is a color. An image is written as a mapping.
|
|
11194
|
+
*/
|
|
11195
|
+
export interface ReportBackground2 {
|
|
11196
|
+
image: ReportBackgroundImage;
|
|
11197
|
+
}
|
|
11198
|
+
/**
|
|
11199
|
+
* The image a box paints behind its content. It is drawn from a slot of its own, which is what keeps a backdrop fillable and gives it placeholder metadata, so it is written down with an id - or it names an image another box on the page already wrote down.
|
|
11200
|
+
*/
|
|
11201
|
+
export interface ReportBackgroundImage1 {
|
|
11202
|
+
ref: Id47;
|
|
11203
|
+
}
|
|
11204
|
+
/**
|
|
11205
|
+
* The image a box paints behind its content. It is drawn from a slot of its own, which is what keeps a backdrop fillable and gives it placeholder metadata, so it is written down with an id - or it names an image another box on the page already wrote down.
|
|
11206
|
+
*/
|
|
11207
|
+
export interface ReportBackgroundImage2 {
|
|
11208
|
+
id: Id48;
|
|
11209
|
+
/**
|
|
11210
|
+
* Image URL, supporting \{variables\} - a logo uses \{logo\}. Mutually exclusive with asset.
|
|
11211
|
+
*/
|
|
11212
|
+
url?: string;
|
|
11213
|
+
asset?: Id49;
|
|
11214
|
+
alt_text?: string;
|
|
11215
|
+
/**
|
|
11216
|
+
* How the image fills its area: kept whole inside it, filling it and cropped to do so, or stretched to its shape. Defaults to contain.
|
|
11217
|
+
*/
|
|
11218
|
+
fit?: "contain" | "cover" | "fill";
|
|
11219
|
+
style?: ReportImageStyle;
|
|
11220
|
+
placeholder?: ReportSlotPlaceholder;
|
|
11221
|
+
}
|
|
11222
|
+
/**
|
|
11223
|
+
* Placement overrides for the drawn image; centered on both axes by default.
|
|
11224
|
+
*/
|
|
11225
|
+
export interface ReportImageStyle {
|
|
11226
|
+
horizontal_align?: ReportContentAlignment;
|
|
11227
|
+
vertical_align?: ReportContentAlignment;
|
|
11228
|
+
}
|
|
11229
|
+
/**
|
|
11230
|
+
* Metadata of a slot intentionally left unfilled. A bare true marks it required; a bare string is the authoring hint.
|
|
11231
|
+
*/
|
|
11232
|
+
export interface ReportSlotPlaceholder3 {
|
|
11233
|
+
/**
|
|
11234
|
+
* Authoring hint shown in the empty slot.
|
|
11235
|
+
*/
|
|
11236
|
+
hint?: string;
|
|
11237
|
+
/**
|
|
11238
|
+
* When true, a report is not considered complete until this slot is filled.
|
|
11239
|
+
*/
|
|
11240
|
+
required?: boolean;
|
|
11241
|
+
}
|
|
11242
|
+
export interface ReportLayoutColumn {
|
|
11243
|
+
weight?: ReportLayoutWeight;
|
|
11244
|
+
/**
|
|
11245
|
+
* Children laid out vertically.
|
|
11246
|
+
*/
|
|
11247
|
+
column: ReportLayoutNode2[];
|
|
11248
|
+
style?: ReportBoxStyle2;
|
|
11249
|
+
}
|
|
11250
|
+
export interface ReportLayoutRow {
|
|
11251
|
+
weight?: ReportLayoutWeight;
|
|
11252
|
+
/**
|
|
11253
|
+
* Children laid out horizontally.
|
|
11254
|
+
*/
|
|
11255
|
+
row: ReportLayoutNode2[];
|
|
11256
|
+
style?: ReportBoxStyle1;
|
|
11257
|
+
}
|
|
11258
|
+
/**
|
|
11259
|
+
* Paint of this container's box. Never affects how children are laid out.
|
|
11260
|
+
*/
|
|
11261
|
+
export interface ReportBoxStyle1 {
|
|
11262
|
+
background?: ReportBackground;
|
|
11263
|
+
/**
|
|
11264
|
+
* Corner radius in percent of the page width. Content reaching into a rounded corner is clipped.
|
|
11265
|
+
*/
|
|
11266
|
+
border_radius?: number;
|
|
11267
|
+
/**
|
|
11268
|
+
* Inset of the box's own content, in percent of the page width. Insets only inward.
|
|
11269
|
+
*/
|
|
11270
|
+
padding?: number;
|
|
11271
|
+
}
|
|
11272
|
+
export interface ReportVisualizationSlot {
|
|
11273
|
+
id: Id48;
|
|
11274
|
+
weight?: ReportLayoutWeight;
|
|
11275
|
+
/**
|
|
11276
|
+
* An id of the visualization to be rendered in this area. Null leaves the area declared but empty, which renders a placeholder.
|
|
11277
|
+
*/
|
|
11278
|
+
visualization: string | null;
|
|
11279
|
+
/**
|
|
11280
|
+
* Title rendered above the visualization; supports \{variables\}. False hides it.
|
|
11281
|
+
*/
|
|
11282
|
+
title?: string | false;
|
|
11283
|
+
/**
|
|
11284
|
+
* Whether the title is rendered. Only needed to hide a title that is kept written down; a title of false hides it and drops the text.
|
|
11285
|
+
*/
|
|
11286
|
+
show_title?: boolean;
|
|
11287
|
+
/**
|
|
11288
|
+
* Visualization properties overriding the insight's own.
|
|
11289
|
+
*/
|
|
11290
|
+
properties?: {
|
|
11291
|
+
[k: string]: unknown;
|
|
11292
|
+
};
|
|
11293
|
+
date?: Id50;
|
|
11294
|
+
/**
|
|
11295
|
+
* When true, the implicit date filter derived from the report's period is not applied here.
|
|
11296
|
+
*/
|
|
11297
|
+
ignore_report_period?: boolean;
|
|
11298
|
+
filters?: DashboardFilters2;
|
|
11299
|
+
/**
|
|
11300
|
+
* A list of report and page filters ignored here.
|
|
11301
|
+
*/
|
|
11302
|
+
ignored_filters?: string[];
|
|
11303
|
+
placeholder?: ReportSlotPlaceholder;
|
|
11304
|
+
}
|
|
11305
|
+
/**
|
|
11306
|
+
* Filters applied on top of the effective page and report filters. A filter targeting the same object replaces the inherited one.
|
|
11307
|
+
*/
|
|
11308
|
+
export interface DashboardFilters2 {
|
|
11309
|
+
/**
|
|
11310
|
+
* This interface was referenced by `DashboardFilters`'s JSON-Schema definition
|
|
11311
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11312
|
+
* This interface was referenced by `DashboardFilters1`'s JSON-Schema definition
|
|
11313
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11314
|
+
* This interface was referenced by `DashboardFilters2`'s JSON-Schema definition
|
|
11315
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11316
|
+
* This interface was referenced by `DashboardFilters3`'s JSON-Schema definition
|
|
11317
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11318
|
+
* This interface was referenced by `DashboardFilters4`'s JSON-Schema definition
|
|
11319
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11320
|
+
* This interface was referenced by `DashboardFilters5`'s JSON-Schema definition
|
|
11321
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11322
|
+
* This interface was referenced by `DashboardFilters6`'s JSON-Schema definition
|
|
11323
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11324
|
+
*/
|
|
11325
|
+
[k: string]: DashboardAbsoluteDateFilter | DashboardRelativeDateFilter | DashboardAttributeFilter | DashboardTextFilter | DashboardMetricValueFilter | DashboardFilterGroup;
|
|
11326
|
+
}
|
|
11327
|
+
export interface ReportHeadingSlot {
|
|
11328
|
+
id: Id48;
|
|
11329
|
+
weight?: ReportLayoutWeight;
|
|
11330
|
+
heading: ReportText;
|
|
11331
|
+
style?: ReportTextStyle;
|
|
11332
|
+
placeholder?: ReportSlotPlaceholder;
|
|
11333
|
+
}
|
|
11334
|
+
/**
|
|
11335
|
+
* A bare string is the text itself. AI-written text is a mapping carrying the prompt and the generation it produced.
|
|
11336
|
+
*/
|
|
11337
|
+
export interface ReportText2 {
|
|
11338
|
+
/**
|
|
11339
|
+
* Markdown with \{variable\} placeholders. Alongside a prompt this is the materialized generation, stored so the report renders without re-invoking AI.
|
|
11340
|
+
*/
|
|
11341
|
+
text?: string;
|
|
11342
|
+
/**
|
|
11343
|
+
* Instruction for the generator. Its presence makes this an AI-written text; supports \{variables\}.
|
|
11344
|
+
*/
|
|
11345
|
+
prompt?: string;
|
|
11346
|
+
/**
|
|
11347
|
+
* ISO 8601 timestamp of the stored generation. Only meaningful alongside a prompt.
|
|
11348
|
+
*/
|
|
11349
|
+
generated_at?: string;
|
|
11350
|
+
}
|
|
11351
|
+
/**
|
|
11352
|
+
* A bare string is the text type. Anything more is written as a mapping.
|
|
11353
|
+
*/
|
|
11354
|
+
export interface ReportTextStyle2 {
|
|
11355
|
+
type?: ReportTextType;
|
|
11356
|
+
/**
|
|
11357
|
+
* CSS color value of the text.
|
|
11358
|
+
*/
|
|
11359
|
+
color?: string;
|
|
11360
|
+
horizontal_align?: ReportContentAlignment;
|
|
11361
|
+
vertical_align?: ReportContentAlignment;
|
|
11362
|
+
background?: ReportBackground3;
|
|
11363
|
+
border_radius?: number;
|
|
11364
|
+
padding?: number;
|
|
11365
|
+
}
|
|
11366
|
+
export interface ReportParagraphSlot {
|
|
11367
|
+
id: Id48;
|
|
11368
|
+
weight?: ReportLayoutWeight;
|
|
11369
|
+
paragraph: ReportText3;
|
|
11370
|
+
style?: ReportTextStyle;
|
|
11371
|
+
placeholder?: ReportSlotPlaceholder;
|
|
11372
|
+
}
|
|
11373
|
+
export interface ReportImageSlot {
|
|
11374
|
+
id: Id48;
|
|
11375
|
+
weight?: ReportLayoutWeight;
|
|
11376
|
+
image: ReportImage;
|
|
11377
|
+
placeholder?: ReportSlotPlaceholder;
|
|
11378
|
+
}
|
|
11379
|
+
/**
|
|
11380
|
+
* A bare string is the image URL. Anything more is written as a mapping. The id belongs to whatever draws the image, not to the image itself.
|
|
11381
|
+
*/
|
|
11382
|
+
export interface ReportImage2 {
|
|
11383
|
+
/**
|
|
11384
|
+
* Image URL, supporting \{variables\} - a logo uses \{logo\}. Mutually exclusive with asset.
|
|
11385
|
+
*/
|
|
11386
|
+
url?: string;
|
|
11387
|
+
asset?: Id51;
|
|
11388
|
+
alt_text?: string;
|
|
11389
|
+
/**
|
|
11390
|
+
* How the image fills its area: kept whole inside it, filling it and cropped to do so, or stretched to its shape. Defaults to contain.
|
|
11391
|
+
*/
|
|
11392
|
+
fit?: "contain" | "cover" | "fill";
|
|
11393
|
+
style?: ReportImageStyle;
|
|
11394
|
+
placeholder?: ReportSlotPlaceholder;
|
|
11395
|
+
}
|
|
11396
|
+
/**
|
|
11397
|
+
* Paint of this container's box. Never affects how children are laid out.
|
|
11398
|
+
*/
|
|
11399
|
+
export interface ReportBoxStyle2 {
|
|
11400
|
+
background?: ReportBackground;
|
|
11401
|
+
/**
|
|
11402
|
+
* Corner radius in percent of the page width. Content reaching into a rounded corner is clipped.
|
|
11403
|
+
*/
|
|
11404
|
+
border_radius?: number;
|
|
11405
|
+
/**
|
|
11406
|
+
* Inset of the box's own content, in percent of the page width. Insets only inward.
|
|
11407
|
+
*/
|
|
11408
|
+
padding?: number;
|
|
11409
|
+
}
|
|
11410
|
+
/**
|
|
11411
|
+
* Page filters, merged over the report's own. A filter targeting the same object replaces the inherited one; a visualization's own filters apply on top.
|
|
11412
|
+
*/
|
|
11413
|
+
export interface DashboardFilters3 {
|
|
11414
|
+
/**
|
|
11415
|
+
* This interface was referenced by `DashboardFilters`'s JSON-Schema definition
|
|
11416
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11417
|
+
* This interface was referenced by `DashboardFilters1`'s JSON-Schema definition
|
|
11418
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11419
|
+
* This interface was referenced by `DashboardFilters2`'s JSON-Schema definition
|
|
11420
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11421
|
+
* This interface was referenced by `DashboardFilters3`'s JSON-Schema definition
|
|
11422
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11423
|
+
* This interface was referenced by `DashboardFilters4`'s JSON-Schema definition
|
|
11424
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11425
|
+
* This interface was referenced by `DashboardFilters5`'s JSON-Schema definition
|
|
11426
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11427
|
+
* This interface was referenced by `DashboardFilters6`'s JSON-Schema definition
|
|
11428
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11429
|
+
*/
|
|
11430
|
+
[k: string]: DashboardAbsoluteDateFilter | DashboardRelativeDateFilter | DashboardAttributeFilter | DashboardTextFilter | DashboardMetricValueFilter | DashboardFilterGroup;
|
|
11431
|
+
}
|
|
11432
|
+
/**
|
|
11433
|
+
* Report filters; pages and visualizations may extend or override them.
|
|
11434
|
+
*/
|
|
11435
|
+
export interface DashboardFilters4 {
|
|
11436
|
+
/**
|
|
11437
|
+
* This interface was referenced by `DashboardFilters`'s JSON-Schema definition
|
|
11438
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11439
|
+
* This interface was referenced by `DashboardFilters1`'s JSON-Schema definition
|
|
11440
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11441
|
+
* This interface was referenced by `DashboardFilters2`'s JSON-Schema definition
|
|
11442
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11443
|
+
* This interface was referenced by `DashboardFilters3`'s JSON-Schema definition
|
|
11444
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11445
|
+
* This interface was referenced by `DashboardFilters4`'s JSON-Schema definition
|
|
11446
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11447
|
+
* This interface was referenced by `DashboardFilters5`'s JSON-Schema definition
|
|
11448
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11449
|
+
* This interface was referenced by `DashboardFilters6`'s JSON-Schema definition
|
|
11450
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11451
|
+
*/
|
|
11452
|
+
[k: string]: DashboardAbsoluteDateFilter | DashboardRelativeDateFilter | DashboardAttributeFilter | DashboardTextFilter | DashboardMetricValueFilter | DashboardFilterGroup;
|
|
11453
|
+
}
|
|
11454
|
+
export interface ReportVariable {
|
|
11455
|
+
/**
|
|
11456
|
+
* Name the variable is referenced by from text, as \{name\}.
|
|
11457
|
+
*/
|
|
11458
|
+
name: string;
|
|
11459
|
+
title?: string;
|
|
11460
|
+
description?: string;
|
|
11461
|
+
/**
|
|
11462
|
+
* Value used when the report gives the variable none.
|
|
11463
|
+
*/
|
|
11464
|
+
default?: string;
|
|
11465
|
+
}
|
|
11466
|
+
export interface Metadata34 {
|
|
11467
|
+
type: "dataset" | "date" | "metric" | "computed_attribute" | "dashboard" | "plugin" | "table" | "bar_chart" | "column_chart" | "line_chart" | "area_chart" | "scatter_chart" | "bubble_chart" | "pie_chart" | "donut_chart" | "treemap_chart" | "pyramid_chart" | "funnel_chart" | "heatmap_chart" | "bullet_chart" | "waterfall_chart" | "dependency_wheel_chart" | "sankey_chart" | "headline_chart" | "combo_chart" | "geo_chart" | "geo_area_chart" | "repeater_chart" | "radar_chart" | "attribute_hierarchy" | "parameter" | "report" | "report_template" | "report_page_layout";
|
|
11468
|
+
[k: string]: unknown;
|
|
11469
|
+
}
|
|
11470
|
+
export interface ReportTemplate {
|
|
11471
|
+
id: Id52;
|
|
11472
|
+
type: "report_template";
|
|
11473
|
+
/**
|
|
11474
|
+
* A human readable title for the report template.
|
|
11475
|
+
*/
|
|
11476
|
+
title: string;
|
|
11477
|
+
/**
|
|
11478
|
+
* An optional description of the report template.
|
|
11479
|
+
*/
|
|
11480
|
+
description?: string;
|
|
11481
|
+
tags?: Tags38;
|
|
11482
|
+
/**
|
|
11483
|
+
* Ordered pages of the template. A report created from the template deep-copies them and keeps no reference back, so the report stays frozen while the template evolves.
|
|
11484
|
+
*/
|
|
11485
|
+
pages: ReportPageBody[];
|
|
11486
|
+
filters?: DashboardFilters5;
|
|
11487
|
+
/**
|
|
11488
|
+
* Custom variables the template's text can interpolate as \{name\}. A report created from it gives them values.
|
|
11489
|
+
*/
|
|
11490
|
+
variables?: ReportVariable[];
|
|
11491
|
+
}
|
|
11492
|
+
/**
|
|
11493
|
+
* Template filters; pages and visualizations may extend or override them.
|
|
11494
|
+
*/
|
|
11495
|
+
export interface DashboardFilters5 {
|
|
11496
|
+
/**
|
|
11497
|
+
* This interface was referenced by `DashboardFilters`'s JSON-Schema definition
|
|
11498
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11499
|
+
* This interface was referenced by `DashboardFilters1`'s JSON-Schema definition
|
|
11500
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11501
|
+
* This interface was referenced by `DashboardFilters2`'s JSON-Schema definition
|
|
11502
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11503
|
+
* This interface was referenced by `DashboardFilters3`'s JSON-Schema definition
|
|
11504
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11505
|
+
* This interface was referenced by `DashboardFilters4`'s JSON-Schema definition
|
|
11506
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11507
|
+
* This interface was referenced by `DashboardFilters5`'s JSON-Schema definition
|
|
11508
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11509
|
+
* This interface was referenced by `DashboardFilters6`'s JSON-Schema definition
|
|
11510
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11511
|
+
*/
|
|
11512
|
+
[k: string]: DashboardAbsoluteDateFilter | DashboardRelativeDateFilter | DashboardAttributeFilter | DashboardTextFilter | DashboardMetricValueFilter | DashboardFilterGroup;
|
|
11513
|
+
}
|
|
11514
|
+
export interface Metadata37 {
|
|
11515
|
+
type: "dataset" | "date" | "metric" | "computed_attribute" | "dashboard" | "plugin" | "table" | "bar_chart" | "column_chart" | "line_chart" | "area_chart" | "scatter_chart" | "bubble_chart" | "pie_chart" | "donut_chart" | "treemap_chart" | "pyramid_chart" | "funnel_chart" | "heatmap_chart" | "bullet_chart" | "waterfall_chart" | "dependency_wheel_chart" | "sankey_chart" | "headline_chart" | "combo_chart" | "geo_chart" | "geo_area_chart" | "repeater_chart" | "radar_chart" | "attribute_hierarchy" | "parameter" | "report" | "report_template" | "report_page_layout";
|
|
11516
|
+
[k: string]: unknown;
|
|
11517
|
+
}
|
|
11518
|
+
/**
|
|
11519
|
+
* A reusable page. Its content fields are the same page body a report and a report template carry inline, so a field added to /gaac/reportPageBody belongs here too: JSON Schema cannot compose the two, because the page body closes itself to the entity's own id, title and tags.
|
|
11520
|
+
*/
|
|
11521
|
+
export interface ReportPageLayout {
|
|
11522
|
+
id: Id53;
|
|
11523
|
+
type: "report_page_layout";
|
|
11524
|
+
/**
|
|
11525
|
+
* A human readable title for the report page layout.
|
|
11526
|
+
*/
|
|
11527
|
+
title: string;
|
|
11528
|
+
/**
|
|
11529
|
+
* An optional description of the report page layout.
|
|
11530
|
+
*/
|
|
11531
|
+
description?: string;
|
|
11532
|
+
tags?: Tags39;
|
|
11533
|
+
kind?: ReportPageKind;
|
|
11534
|
+
format?: ReportPageFormat;
|
|
11535
|
+
style?: ReportBoxStyle3;
|
|
11536
|
+
layout: ReportLayoutNode8;
|
|
11537
|
+
filters?: DashboardFilters6;
|
|
11538
|
+
}
|
|
11539
|
+
/**
|
|
11540
|
+
* Paint of the page itself, behind everything the layout places.
|
|
11541
|
+
*/
|
|
11542
|
+
export interface ReportBoxStyle3 {
|
|
11543
|
+
background?: ReportBackground;
|
|
11544
|
+
/**
|
|
11545
|
+
* Corner radius in percent of the page width. Content reaching into a rounded corner is clipped.
|
|
11546
|
+
*/
|
|
11547
|
+
border_radius?: number;
|
|
11548
|
+
/**
|
|
11549
|
+
* Inset of the box's own content, in percent of the page width. Insets only inward.
|
|
11550
|
+
*/
|
|
11551
|
+
padding?: number;
|
|
11552
|
+
}
|
|
11553
|
+
/**
|
|
11554
|
+
* Page filters, carried into the template and report content this page is copied into.
|
|
11555
|
+
*/
|
|
11556
|
+
export interface DashboardFilters6 {
|
|
11557
|
+
/**
|
|
11558
|
+
* This interface was referenced by `DashboardFilters`'s JSON-Schema definition
|
|
11559
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11560
|
+
* This interface was referenced by `DashboardFilters1`'s JSON-Schema definition
|
|
11561
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11562
|
+
* This interface was referenced by `DashboardFilters2`'s JSON-Schema definition
|
|
11563
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11564
|
+
* This interface was referenced by `DashboardFilters3`'s JSON-Schema definition
|
|
11565
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11566
|
+
* This interface was referenced by `DashboardFilters4`'s JSON-Schema definition
|
|
11567
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11568
|
+
* This interface was referenced by `DashboardFilters5`'s JSON-Schema definition
|
|
11569
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11570
|
+
* This interface was referenced by `DashboardFilters6`'s JSON-Schema definition
|
|
11571
|
+
* via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
|
|
11572
|
+
*/
|
|
11573
|
+
[k: string]: DashboardAbsoluteDateFilter | DashboardRelativeDateFilter | DashboardAttributeFilter | DashboardTextFilter | DashboardMetricValueFilter | DashboardFilterGroup;
|
|
11574
|
+
}
|
|
11575
|
+
export interface Metadata40 {
|
|
11576
|
+
type: "dataset" | "date" | "metric" | "computed_attribute" | "dashboard" | "plugin" | "table" | "bar_chart" | "column_chart" | "line_chart" | "area_chart" | "scatter_chart" | "bubble_chart" | "pie_chart" | "donut_chart" | "treemap_chart" | "pyramid_chart" | "funnel_chart" | "heatmap_chart" | "bullet_chart" | "waterfall_chart" | "dependency_wheel_chart" | "sankey_chart" | "headline_chart" | "combo_chart" | "geo_chart" | "geo_area_chart" | "repeater_chart" | "radar_chart" | "attribute_hierarchy" | "parameter" | "report" | "report_template" | "report_page_layout";
|
|
10934
11577
|
[k: string]: unknown;
|
|
10935
11578
|
}
|
|
10936
11579
|
//# sourceMappingURL=metadata.d.ts.map
|