@gooddata/sdk-model 11.61.0 → 11.62.0-alpha.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/esm/genAI/chat.d.ts +9 -9
- package/esm/genAI/chat.d.ts.map +1 -1
- package/esm/index.d.ts +12 -12
- package/esm/index.d.ts.map +1 -1
- package/esm/index.js +10 -10
- package/esm/publisher/builtinPageLayouts.d.ts +45 -0
- package/esm/publisher/builtinPageLayouts.d.ts.map +1 -0
- package/esm/{reports → publisher}/builtinPageLayouts.js +19 -19
- package/esm/{reports → publisher}/content.d.ts +20 -20
- package/esm/publisher/content.d.ts.map +1 -0
- package/esm/{reports → publisher}/content.js +2 -2
- package/esm/{reports/report.d.ts → publisher/document.d.ts} +28 -28
- package/esm/publisher/document.d.ts.map +1 -0
- package/esm/{reports/report.js → publisher/document.js} +10 -10
- package/esm/publisher/factory.d.ts +65 -0
- package/esm/publisher/factory.d.ts.map +1 -0
- package/esm/{reports → publisher}/factory.js +22 -22
- package/esm/{reports → publisher}/layout.d.ts +15 -15
- package/esm/publisher/layout.d.ts.map +1 -0
- package/esm/{reports → publisher}/layout.js +4 -4
- package/esm/publisher/pageFormat.d.ts +38 -0
- package/esm/publisher/pageFormat.d.ts.map +1 -0
- package/esm/publisher/pageFormat.js +33 -0
- package/esm/{reports → publisher}/pageLayout.d.ts +28 -28
- package/esm/publisher/pageLayout.d.ts.map +1 -0
- package/esm/{reports → publisher}/pageLayout.js +18 -18
- package/esm/{reports → publisher}/slot.d.ts +48 -48
- package/esm/publisher/slot.d.ts.map +1 -0
- package/esm/publisher/slot.js +87 -0
- package/esm/{reports → publisher}/styling.d.ts +39 -39
- package/esm/publisher/styling.d.ts.map +1 -0
- package/esm/publisher/styling.js +58 -0
- package/esm/publisher/variables.d.ts +72 -0
- package/esm/publisher/variables.d.ts.map +1 -0
- package/esm/{reports → publisher}/variables.js +7 -7
- package/esm/sdk-model.d.ts +883 -857
- package/esm/settings/settings.d.ts +8 -0
- package/esm/settings/settings.d.ts.map +1 -1
- package/esm/theme/index.d.ts +68 -51
- package/esm/theme/index.d.ts.map +1 -1
- package/package.json +3 -3
- package/esm/reports/builtinPageLayouts.d.ts +0 -45
- package/esm/reports/builtinPageLayouts.d.ts.map +0 -1
- package/esm/reports/content.d.ts.map +0 -1
- package/esm/reports/factory.d.ts +0 -65
- package/esm/reports/factory.d.ts.map +0 -1
- package/esm/reports/layout.d.ts.map +0 -1
- package/esm/reports/pageFormat.d.ts +0 -38
- package/esm/reports/pageFormat.d.ts.map +0 -1
- package/esm/reports/pageFormat.js +0 -33
- package/esm/reports/pageLayout.d.ts.map +0 -1
- package/esm/reports/report.d.ts.map +0 -1
- package/esm/reports/slot.d.ts.map +0 -1
- package/esm/reports/slot.js +0 -87
- package/esm/reports/styling.d.ts.map +0 -1
- package/esm/reports/styling.js +0 -58
- package/esm/reports/variables.d.ts +0 -72
- package/esm/reports/variables.d.ts.map +0 -1
package/esm/sdk-model.d.ts
CHANGED
|
@@ -971,61 +971,61 @@ export declare function bucketsTotals(buckets: IBucket[]): ITotal[];
|
|
|
971
971
|
export declare function bucketTotals(bucket: IBucket): ITotal[];
|
|
972
972
|
|
|
973
973
|
/**
|
|
974
|
-
* Built-in cover page:
|
|
974
|
+
* Built-in cover page: document title and subtitle.
|
|
975
975
|
*
|
|
976
976
|
* @alpha
|
|
977
977
|
*/
|
|
978
|
-
export declare const
|
|
978
|
+
export declare const BuiltInPublisherPageLayoutCover: IPublisherPageLayout;
|
|
979
979
|
|
|
980
980
|
/**
|
|
981
|
-
* Built-in portrait cover page:
|
|
981
|
+
* Built-in portrait cover page: document title and subtitle.
|
|
982
982
|
*
|
|
983
983
|
* @alpha
|
|
984
984
|
*/
|
|
985
|
-
export declare const
|
|
985
|
+
export declare const BuiltInPublisherPageLayoutPortraitCover: IPublisherPageLayout;
|
|
986
986
|
|
|
987
987
|
/**
|
|
988
988
|
* Built-in portrait section divider page.
|
|
989
989
|
*
|
|
990
990
|
* @alpha
|
|
991
991
|
*/
|
|
992
|
-
export declare const
|
|
992
|
+
export declare const BuiltInPublisherPageLayoutPortraitSection: IPublisherPageLayout;
|
|
993
993
|
|
|
994
994
|
/**
|
|
995
995
|
* Built-in portrait page carrying a full-page narrative, with no visualization.
|
|
996
996
|
*
|
|
997
997
|
* @alpha
|
|
998
998
|
*/
|
|
999
|
-
export declare const
|
|
999
|
+
export declare const BuiltInPublisherPageLayoutPortraitSummary: IPublisherPageLayout;
|
|
1000
1000
|
|
|
1001
1001
|
/**
|
|
1002
|
-
* All built-in
|
|
1002
|
+
* All built-in page layouts served by the SPI. Built-ins are read-only: they cannot be
|
|
1003
1003
|
* edited or deleted, and they are never persisted on the backend.
|
|
1004
1004
|
*
|
|
1005
1005
|
* @alpha
|
|
1006
1006
|
*/
|
|
1007
|
-
export declare const
|
|
1007
|
+
export declare const BuiltInPublisherPageLayouts: readonly IPublisherPageLayout[];
|
|
1008
1008
|
|
|
1009
1009
|
/**
|
|
1010
1010
|
* Built-in section divider page.
|
|
1011
1011
|
*
|
|
1012
1012
|
* @alpha
|
|
1013
1013
|
*/
|
|
1014
|
-
export declare const
|
|
1014
|
+
export declare const BuiltInPublisherPageLayoutSection: IPublisherPageLayout;
|
|
1015
1015
|
|
|
1016
1016
|
/**
|
|
1017
1017
|
* Built-in content page with six visualizations and a text column on the left.
|
|
1018
1018
|
*
|
|
1019
1019
|
* @alpha
|
|
1020
1020
|
*/
|
|
1021
|
-
export declare const
|
|
1021
|
+
export declare const BuiltInPublisherPageLayoutViz6TextLeft: IPublisherPageLayout;
|
|
1022
1022
|
|
|
1023
1023
|
/**
|
|
1024
|
-
* List of built-in
|
|
1024
|
+
* List of built-in document slot type names.
|
|
1025
1025
|
*
|
|
1026
1026
|
* @alpha
|
|
1027
1027
|
*/
|
|
1028
|
-
export declare const
|
|
1028
|
+
export declare const BuiltInPublisherSlotTypes: string[];
|
|
1029
1029
|
|
|
1030
1030
|
/**
|
|
1031
1031
|
* List of built-in widget types. These type names are reserved and must not be used by custom widgets.
|
|
@@ -1887,7 +1887,7 @@ export declare const DefaultLocale: ILocale;
|
|
|
1887
1887
|
*
|
|
1888
1888
|
* @alpha
|
|
1889
1889
|
*/
|
|
1890
|
-
export declare const
|
|
1890
|
+
export declare const DefaultPublisherHeadingType: PublisherHeadingType;
|
|
1891
1891
|
|
|
1892
1892
|
/**
|
|
1893
1893
|
* Format assumed by a page that declares none, which keeps pages authored before formats existed
|
|
@@ -1895,14 +1895,14 @@ export declare const DefaultReportHeadingType: ReportHeadingType;
|
|
|
1895
1895
|
*
|
|
1896
1896
|
* @alpha
|
|
1897
1897
|
*/
|
|
1898
|
-
export declare const
|
|
1898
|
+
export declare const DefaultPublisherPageFormat: PublisherPageFormat;
|
|
1899
1899
|
|
|
1900
1900
|
/**
|
|
1901
1901
|
* Size a paragraph slot that states none is rendered at.
|
|
1902
1902
|
*
|
|
1903
1903
|
* @alpha
|
|
1904
1904
|
*/
|
|
1905
|
-
export declare const
|
|
1905
|
+
export declare const DefaultPublisherParagraphType: PublisherParagraphType;
|
|
1906
1906
|
|
|
1907
1907
|
/**
|
|
1908
1908
|
* Calculates fingerprint for the execution definition.
|
|
@@ -2925,7 +2925,7 @@ export declare function getPluggableApplicationLocalizedTitle(app: PluggableAppl
|
|
|
2925
2925
|
*
|
|
2926
2926
|
* @alpha
|
|
2927
2927
|
*/
|
|
2928
|
-
export declare function
|
|
2928
|
+
export declare function getPublisherTextPlaceholders(text: string): string[];
|
|
2929
2929
|
|
|
2930
2930
|
/**
|
|
2931
2931
|
* Returns count of selected elements
|
|
@@ -8326,6 +8326,14 @@ export declare interface IFeatureFlags {
|
|
|
8326
8326
|
* Disabled by default.
|
|
8327
8327
|
*/
|
|
8328
8328
|
enableEmbeddingWriteCommands?: boolean;
|
|
8329
|
+
/**
|
|
8330
|
+
* Enable the localization overview in organization settings: settings split into subpages under an
|
|
8331
|
+
* expandable Settings group in the navigation, and the per-language usage overview.
|
|
8332
|
+
*
|
|
8333
|
+
* @remarks
|
|
8334
|
+
* Disabled by default.
|
|
8335
|
+
*/
|
|
8336
|
+
enableLocalizationOverview?: boolean;
|
|
8329
8337
|
}
|
|
8330
8338
|
|
|
8331
8339
|
/**
|
|
@@ -8777,22 +8785,22 @@ export declare interface IGenAIObjectReferenceGroup {
|
|
|
8777
8785
|
}
|
|
8778
8786
|
|
|
8779
8787
|
/**
|
|
8780
|
-
*
|
|
8788
|
+
* Publisher document context for GenAI.
|
|
8781
8789
|
* @internal
|
|
8782
8790
|
*/
|
|
8783
|
-
export declare interface
|
|
8791
|
+
export declare interface IGenAIPublisherDocumentContext {
|
|
8784
8792
|
/**
|
|
8785
|
-
*
|
|
8793
|
+
* Document object reference. Absent while the document is not saved yet.
|
|
8786
8794
|
*/
|
|
8787
8795
|
ref?: ObjRef;
|
|
8788
8796
|
/**
|
|
8789
|
-
*
|
|
8797
|
+
* Document title.
|
|
8790
8798
|
*/
|
|
8791
8799
|
title?: string;
|
|
8792
8800
|
/**
|
|
8793
|
-
*
|
|
8801
|
+
* Document definition as the user sees it, including edits that are not saved yet.
|
|
8794
8802
|
*/
|
|
8795
|
-
definition?:
|
|
8803
|
+
definition?: IPublisherDocumentDefinition;
|
|
8796
8804
|
/**
|
|
8797
8805
|
* Name of the conversation draft the editor shows, while that draft is not saved yet.
|
|
8798
8806
|
*/
|
|
@@ -8840,9 +8848,9 @@ export declare interface IGenAIUIContext {
|
|
|
8840
8848
|
*/
|
|
8841
8849
|
dashboard?: IGenAIDashboardContext;
|
|
8842
8850
|
/**
|
|
8843
|
-
*
|
|
8851
|
+
* Document the user is currently viewing or editing.
|
|
8844
8852
|
*/
|
|
8845
|
-
|
|
8853
|
+
publisherDocument?: IGenAIPublisherDocumentContext;
|
|
8846
8854
|
}
|
|
8847
8855
|
|
|
8848
8856
|
/**
|
|
@@ -12170,904 +12178,904 @@ export declare interface IProductionFeaturesConfig {
|
|
|
12170
12178
|
}
|
|
12171
12179
|
|
|
12172
12180
|
/**
|
|
12173
|
-
*
|
|
12174
|
-
*/
|
|
12175
|
-
export declare interface IRangeCondition {
|
|
12176
|
-
range: IRangeConditionBody;
|
|
12177
|
-
}
|
|
12178
|
-
|
|
12179
|
-
/**
|
|
12180
|
-
* Object defining the {@link IRangeCondition} object body.
|
|
12181
|
-
*
|
|
12182
|
-
* @public
|
|
12183
|
-
*/
|
|
12184
|
-
export declare interface IRangeConditionBody {
|
|
12185
|
-
operator: RangeConditionOperator;
|
|
12186
|
-
from: number;
|
|
12187
|
-
to: number;
|
|
12188
|
-
treatNullValuesAs?: number;
|
|
12189
|
-
}
|
|
12190
|
-
|
|
12191
|
-
/**
|
|
12192
|
-
* @public
|
|
12193
|
-
*/
|
|
12194
|
-
export declare interface IRankingFilter {
|
|
12195
|
-
rankingFilter: IRankingFilterBody;
|
|
12196
|
-
}
|
|
12197
|
-
|
|
12198
|
-
/**
|
|
12199
|
-
* Object defining the {@link IRankingFilter} object body.
|
|
12181
|
+
* Text generated by AI at document-build time.
|
|
12200
12182
|
*
|
|
12201
|
-
* @
|
|
12183
|
+
* @alpha
|
|
12202
12184
|
*/
|
|
12203
|
-
export declare interface
|
|
12204
|
-
|
|
12205
|
-
attributes?: ObjRefInScope[];
|
|
12206
|
-
operator: RankingFilterOperator;
|
|
12207
|
-
value: number;
|
|
12208
|
-
applyOnResult?: boolean;
|
|
12185
|
+
export declare interface IPublisherAiTextSource {
|
|
12186
|
+
type: "ai";
|
|
12209
12187
|
/**
|
|
12210
|
-
*
|
|
12211
|
-
* additional items that share the boundary value (ties). When false or omitted, the backend default
|
|
12212
|
-
* tie-handling behavior is used.
|
|
12188
|
+
* Instruction for the generator. Supports `{variables}`.
|
|
12213
12189
|
*/
|
|
12214
|
-
|
|
12190
|
+
prompt: string;
|
|
12191
|
+
/**
|
|
12192
|
+
* Materialized generation result (markdown), stored so the document renders
|
|
12193
|
+
* deterministically without re-invoking AI. Absent until first generation.
|
|
12194
|
+
*/
|
|
12195
|
+
content?: string;
|
|
12196
|
+
/**
|
|
12197
|
+
* ISO 8601 timestamp of the stored generation.
|
|
12198
|
+
*/
|
|
12199
|
+
generatedAt?: string;
|
|
12215
12200
|
}
|
|
12216
12201
|
|
|
12217
12202
|
/**
|
|
12218
|
-
*
|
|
12203
|
+
* Configuration of a document's content-level attribute filter: the part of a dashboard attribute
|
|
12204
|
+
* filter's configuration that documents support.
|
|
12219
12205
|
*
|
|
12220
|
-
* @
|
|
12206
|
+
* @alpha
|
|
12221
12207
|
*/
|
|
12222
|
-
export declare
|
|
12223
|
-
boundedFilter: IUpperBoundedFilter | ILowerBoundedFilter;
|
|
12224
|
-
}
|
|
12208
|
+
export declare type IPublisherAttributeFilterConfig = Pick<IDashboardAttributeFilterConfig, "localIdentifier" | "displayAsLabel">;
|
|
12225
12209
|
|
|
12226
12210
|
/**
|
|
12227
|
-
*
|
|
12228
|
-
*
|
|
12229
|
-
* @remarks
|
|
12230
|
-
* The relative filtering is always done on some granularity - this specifies
|
|
12231
|
-
* the units in the 'from' and 'to' fields.
|
|
12211
|
+
* Paint of the box itself. Never affects the geometry of the box or its children —
|
|
12212
|
+
* geometry always comes from layout weights.
|
|
12232
12213
|
*
|
|
12233
|
-
*
|
|
12234
|
-
* @public
|
|
12214
|
+
* @alpha
|
|
12235
12215
|
*/
|
|
12236
|
-
export declare
|
|
12237
|
-
|
|
12238
|
-
|
|
12239
|
-
|
|
12240
|
-
|
|
12241
|
-
|
|
12242
|
-
|
|
12216
|
+
export declare interface IPublisherBoxStyle {
|
|
12217
|
+
background?: PublisherBackground;
|
|
12218
|
+
/**
|
|
12219
|
+
* Corner radius in percent of the page width — the same relative unit the rest of a document page
|
|
12220
|
+
* is sized in, so the corners keep their proportion however large the page is rendered.
|
|
12221
|
+
* Content reaching into a rounded corner is clipped.
|
|
12222
|
+
*/
|
|
12223
|
+
borderRadius?: number;
|
|
12224
|
+
/**
|
|
12225
|
+
* Inset of the box's own content, in percent of the page width like
|
|
12226
|
+
* {@link IPublisherBoxStyle.borderRadius}. Insets only inward — siblings and the layout
|
|
12227
|
+
* gaps around the box are untouched. A box that paints a background usually wants one;
|
|
12228
|
+
* a full-bleed box (an image-backed cover) wants none, which is why no default exists.
|
|
12229
|
+
*/
|
|
12230
|
+
padding?: number;
|
|
12231
|
+
}
|
|
12243
12232
|
|
|
12244
12233
|
/**
|
|
12245
|
-
*
|
|
12234
|
+
* Solid color painted behind a section's or page's content.
|
|
12246
12235
|
*
|
|
12247
|
-
* @
|
|
12236
|
+
* @alpha
|
|
12248
12237
|
*/
|
|
12249
|
-
export declare interface
|
|
12250
|
-
|
|
12251
|
-
granularity: AllTimeGranularity;
|
|
12252
|
-
from: 0;
|
|
12253
|
-
to: 0;
|
|
12238
|
+
export declare interface IPublisherColorBackground {
|
|
12239
|
+
type: "color";
|
|
12254
12240
|
/**
|
|
12255
|
-
*
|
|
12241
|
+
* CSS color value. Absolute: document styling states brand colors directly and does not
|
|
12242
|
+
* follow the workspace theme.
|
|
12256
12243
|
*/
|
|
12257
|
-
|
|
12244
|
+
color: string;
|
|
12258
12245
|
}
|
|
12259
12246
|
|
|
12260
12247
|
/**
|
|
12261
|
-
*
|
|
12248
|
+
* Document metadata object.
|
|
12262
12249
|
*
|
|
12263
|
-
* @
|
|
12250
|
+
* @alpha
|
|
12264
12251
|
*/
|
|
12265
|
-
export declare interface
|
|
12266
|
-
|
|
12267
|
-
granularity: DateAttributeGranularity;
|
|
12268
|
-
from: number;
|
|
12269
|
-
to: number;
|
|
12252
|
+
export declare interface IPublisherDocument extends IPublisherDocumentDefinition, IAuditableDates, IAuditableUsers {
|
|
12253
|
+
ref: ObjRef;
|
|
12270
12254
|
/**
|
|
12271
|
-
*
|
|
12255
|
+
* When true, the object comes from a parent workspace and is not editable
|
|
12256
|
+
* in the current workspace.
|
|
12272
12257
|
*/
|
|
12273
|
-
|
|
12258
|
+
isLocked?: boolean;
|
|
12274
12259
|
}
|
|
12275
12260
|
|
|
12276
12261
|
/**
|
|
12277
|
-
*
|
|
12262
|
+
* Fields shared by document definitions and persisted documents.
|
|
12263
|
+
*
|
|
12278
12264
|
* @alpha
|
|
12279
12265
|
*/
|
|
12280
|
-
export declare interface
|
|
12266
|
+
export declare interface IPublisherDocumentBase {
|
|
12267
|
+
title: string;
|
|
12268
|
+
description?: string;
|
|
12269
|
+
tags?: string[];
|
|
12281
12270
|
/**
|
|
12282
|
-
*
|
|
12271
|
+
* Reported period start, ISO 8601 date (YYYY-MM-DD), inclusive.
|
|
12272
|
+
*
|
|
12273
|
+
* @remarks
|
|
12274
|
+
* At execution time the period materializes as an absolute date filter on each
|
|
12275
|
+
* visualization slot's dateDataSet (lowest precedence, per-slot opt-out via
|
|
12276
|
+
* ignoreReportPeriod). Also available as `{periodStart}` in text.
|
|
12283
12277
|
*/
|
|
12284
|
-
|
|
12278
|
+
periodStart: PublisherDateString;
|
|
12285
12279
|
/**
|
|
12286
|
-
*
|
|
12280
|
+
* Reported period end, ISO 8601 date (YYYY-MM-DD), inclusive.
|
|
12287
12281
|
*/
|
|
12288
|
-
|
|
12282
|
+
periodEnd: PublisherDateString;
|
|
12289
12283
|
/**
|
|
12290
|
-
*
|
|
12284
|
+
* Content of the document. When created from a template the content is deep-copied
|
|
12285
|
+
* and NO reference to the template is kept — the document stays frozen while pages
|
|
12286
|
+
* and templates evolve.
|
|
12291
12287
|
*/
|
|
12292
|
-
|
|
12288
|
+
content: IPublisherDocumentContent;
|
|
12289
|
+
/**
|
|
12290
|
+
* Values for variables declared in content.variables, keyed by variable name.
|
|
12291
|
+
*/
|
|
12292
|
+
variableValues?: Record<string, string>;
|
|
12293
12293
|
}
|
|
12294
12294
|
|
|
12295
12295
|
/**
|
|
12296
|
-
*
|
|
12296
|
+
* Versioned content shared verbatim by document templates and documents.
|
|
12297
|
+
*
|
|
12297
12298
|
* @alpha
|
|
12298
12299
|
*/
|
|
12299
|
-
export declare interface
|
|
12300
|
+
export declare interface IPublisherDocumentContent {
|
|
12300
12301
|
/**
|
|
12301
|
-
*
|
|
12302
|
+
* Content model version, for stored-content evolution.
|
|
12302
12303
|
*/
|
|
12303
|
-
|
|
12304
|
+
version: "1";
|
|
12304
12305
|
/**
|
|
12305
|
-
*
|
|
12306
|
+
* Ordered pages of the document.
|
|
12306
12307
|
*/
|
|
12307
|
-
|
|
12308
|
+
pages: IPublisherDocumentPage[];
|
|
12308
12309
|
/**
|
|
12309
|
-
*
|
|
12310
|
+
* Content-level default filters; pages and slots may extend or override them.
|
|
12311
|
+
* The document period is NOT stored here — it is derived from periodStart/periodEnd
|
|
12312
|
+
* at execution time.
|
|
12310
12313
|
*/
|
|
12311
|
-
|
|
12314
|
+
filters?: FilterContextItem[];
|
|
12312
12315
|
/**
|
|
12313
|
-
*
|
|
12316
|
+
* Configuration of the content-level attribute filters, keyed by the filter's local identifier.
|
|
12317
|
+
*
|
|
12318
|
+
* @remarks
|
|
12319
|
+
* A filter with a `displayAsLabel` must be stored on the attribute's primary label: its selection
|
|
12320
|
+
* is read as primary-label values and shown by `displayAsLabel`.
|
|
12314
12321
|
*/
|
|
12315
|
-
|
|
12322
|
+
attributeFilterConfigs?: IPublisherAttributeFilterConfig[];
|
|
12316
12323
|
/**
|
|
12317
|
-
*
|
|
12324
|
+
* Custom variable declarations. Values live on the document
|
|
12325
|
+
* ({@link IPublisherDocumentBase.variableValues}).
|
|
12318
12326
|
*/
|
|
12319
|
-
|
|
12327
|
+
variables?: IPublisherVariableDefinition[];
|
|
12320
12328
|
/**
|
|
12321
|
-
*
|
|
12329
|
+
* Instructions every AI-written text without instructions of its own is generated with.
|
|
12330
|
+
* Supports `{variables}`.
|
|
12322
12331
|
*/
|
|
12323
|
-
|
|
12332
|
+
takeawaysInstruction?: string;
|
|
12324
12333
|
}
|
|
12325
12334
|
|
|
12326
12335
|
/**
|
|
12327
|
-
*
|
|
12336
|
+
* Payload for creating or updating a document.
|
|
12337
|
+
*
|
|
12328
12338
|
* @alpha
|
|
12329
12339
|
*/
|
|
12330
|
-
export declare interface
|
|
12340
|
+
export declare interface IPublisherDocumentDefinition extends IPublisherDocumentBase {
|
|
12341
|
+
type: "report";
|
|
12331
12342
|
/**
|
|
12332
|
-
*
|
|
12343
|
+
* Present when updating an existing document.
|
|
12333
12344
|
*/
|
|
12334
|
-
|
|
12345
|
+
ref?: ObjRef;
|
|
12335
12346
|
}
|
|
12336
12347
|
|
|
12337
12348
|
/**
|
|
12338
|
-
*
|
|
12349
|
+
* Page instance embedded in template/document content: a deep clone of a page body
|
|
12350
|
+
* plus its own identity.
|
|
12339
12351
|
*
|
|
12340
|
-
* @
|
|
12352
|
+
* @remarks
|
|
12353
|
+
* Cloning a {@link IPublisherPageLayout} into content assigns the localIdentifier and regenerates
|
|
12354
|
+
* slot localIdentifiers (with the layout slotIds) so repeated use of one page stays unique.
|
|
12355
|
+
* Deliberately carries NO reference back to the source page — later page edits never
|
|
12356
|
+
* affect existing templates or documents.
|
|
12357
|
+
*
|
|
12358
|
+
* @alpha
|
|
12341
12359
|
*/
|
|
12342
|
-
export declare interface
|
|
12343
|
-
|
|
12344
|
-
|
|
12345
|
-
|
|
12346
|
-
|
|
12347
|
-
boundedFilter?: IUpperBoundedFilter | ILowerBoundedFilter;
|
|
12348
|
-
emptyValueHandling?: EmptyValues;
|
|
12360
|
+
export declare interface IPublisherDocumentPage extends IPublisherPageBody {
|
|
12361
|
+
/**
|
|
12362
|
+
* Identifier unique within the content; stable across template-to-document copy and reordering.
|
|
12363
|
+
*/
|
|
12364
|
+
localIdentifier: string;
|
|
12349
12365
|
}
|
|
12350
12366
|
|
|
12351
12367
|
/**
|
|
12352
|
-
*
|
|
12353
|
-
* The application is loaded via Module Federation.
|
|
12368
|
+
* Document template metadata object.
|
|
12354
12369
|
*
|
|
12355
12370
|
* @alpha
|
|
12356
12371
|
*/
|
|
12357
|
-
export declare interface
|
|
12358
|
-
|
|
12359
|
-
* Full URL of the remote federated module with the application bundle.
|
|
12360
|
-
*
|
|
12361
|
-
* @example
|
|
12362
|
-
* https://my-remote-federated-module.com/remoteEntry.js
|
|
12363
|
-
*/
|
|
12364
|
-
url: string;
|
|
12365
|
-
/**
|
|
12366
|
-
* Unique module federation scope value (must match the remote module definition during build)
|
|
12367
|
-
* Must be unique within the same remote federation to not share dependencies and scope with another
|
|
12368
|
-
* application.
|
|
12369
|
-
*
|
|
12370
|
-
* @example
|
|
12371
|
-
* "my-remote-federated-module"
|
|
12372
|
-
*/
|
|
12373
|
-
scope: string;
|
|
12374
|
-
/**
|
|
12375
|
-
* Exposed module name. Must match the remote module definition.
|
|
12376
|
-
* Maps to internal application module (e.g. "./src/remote-entry.tsx")
|
|
12377
|
-
*
|
|
12378
|
-
* @example
|
|
12379
|
-
* "./AppModule"
|
|
12380
|
-
*/
|
|
12381
|
-
module: string;
|
|
12372
|
+
export declare interface IPublisherDocumentTemplate extends IPublisherDocumentTemplateDefinition, IAuditableDates, IAuditableUsers {
|
|
12373
|
+
ref: ObjRef;
|
|
12382
12374
|
/**
|
|
12383
|
-
*
|
|
12384
|
-
*
|
|
12385
|
-
*
|
|
12386
|
-
* @example
|
|
12387
|
-
* "/my-application"
|
|
12388
|
-
*
|
|
12389
|
-
* When the application is registered to "organization" scope, the application will be hosted at
|
|
12390
|
-
* /organization/my-application.
|
|
12391
|
-
* When the application is registered to the "workspace" scope, the application will be hosted at
|
|
12392
|
-
* /workspace/\{workspaceId\}/my-application.
|
|
12375
|
+
* When true, the object comes from a parent workspace and is not editable
|
|
12376
|
+
* in the current workspace.
|
|
12393
12377
|
*/
|
|
12394
|
-
|
|
12378
|
+
isLocked?: boolean;
|
|
12395
12379
|
}
|
|
12396
12380
|
|
|
12397
12381
|
/**
|
|
12398
|
-
*
|
|
12399
|
-
* Loaded via Module Federation.
|
|
12382
|
+
* Payload for creating or updating a document template.
|
|
12400
12383
|
*
|
|
12401
12384
|
* @alpha
|
|
12402
12385
|
*/
|
|
12403
|
-
export declare interface
|
|
12386
|
+
export declare interface IPublisherDocumentTemplateDefinition {
|
|
12387
|
+
type: "reportTemplate";
|
|
12404
12388
|
/**
|
|
12405
|
-
*
|
|
12389
|
+
* Present when updating an existing template.
|
|
12406
12390
|
*/
|
|
12407
|
-
|
|
12391
|
+
ref?: ObjRef;
|
|
12392
|
+
title: string;
|
|
12393
|
+
description?: string;
|
|
12394
|
+
tags?: string[];
|
|
12395
|
+
content: IPublisherDocumentContent;
|
|
12408
12396
|
}
|
|
12409
12397
|
|
|
12410
12398
|
/**
|
|
12411
|
-
*
|
|
12399
|
+
* Slot rendering a heading.
|
|
12400
|
+
*
|
|
12401
|
+
* @remarks
|
|
12402
|
+
* A heading is a line of display text, so it carries no markup of its own: what is typed in it is
|
|
12403
|
+
* what it renders.
|
|
12412
12404
|
*
|
|
12413
12405
|
* @alpha
|
|
12414
12406
|
*/
|
|
12415
|
-
export declare interface
|
|
12416
|
-
|
|
12417
|
-
|
|
12418
|
-
*/
|
|
12419
|
-
apiVersion: "1.0";
|
|
12420
|
-
/**
|
|
12421
|
-
* The overrides of the pluggable applications deployed in the shell application by default.
|
|
12422
|
-
*
|
|
12423
|
-
* Each override is mapped to a key that is the well-documented ID of the default pluggable application,
|
|
12424
|
-
* e.g., gdc-analytical-designer, gdc-dashboards, etc. The property can be used, for example, to disable
|
|
12425
|
-
* one of these applications or changing the order under which it is added to the Application Header menu.
|
|
12426
|
-
*/
|
|
12427
|
-
overrides?: {
|
|
12428
|
-
[applicationId: string]: Partial<PluggableApplicationRegistryItem>;
|
|
12429
|
-
};
|
|
12430
|
-
/**
|
|
12431
|
-
* The optional list of allowed standard applications.
|
|
12432
|
-
*
|
|
12433
|
-
* The array of well-documented IDs of the standard applications that are deployed in the shell
|
|
12434
|
-
* application by default. The property can be used to stabilize which of the standard applications
|
|
12435
|
-
* will be available in the Application Header menu. When a new standard application is deployed in
|
|
12436
|
-
* the shell application, it will not appear in the menu until it is added to the list of allowed
|
|
12437
|
-
* standard applications.
|
|
12438
|
-
*/
|
|
12439
|
-
allowedStandardApplications?: string[];
|
|
12407
|
+
export declare interface IPublisherHeadingSlot extends IPublisherSlotBase {
|
|
12408
|
+
type: "heading";
|
|
12409
|
+
style?: IPublisherHeadingStyle;
|
|
12440
12410
|
/**
|
|
12441
|
-
*
|
|
12442
|
-
*
|
|
12443
|
-
* Mainly used to register 3rd party hosted remote module federated applications.
|
|
12411
|
+
* Undefined = declared-but-empty slot.
|
|
12444
12412
|
*/
|
|
12445
|
-
|
|
12413
|
+
source?: PublisherTextSource;
|
|
12414
|
+
}
|
|
12415
|
+
|
|
12416
|
+
/**
|
|
12417
|
+
* Styling of a heading slot.
|
|
12418
|
+
*
|
|
12419
|
+
* @alpha
|
|
12420
|
+
*/
|
|
12421
|
+
export declare interface IPublisherHeadingStyle extends IPublisherTextStyle {
|
|
12446
12422
|
/**
|
|
12447
|
-
*
|
|
12448
|
-
*
|
|
12449
|
-
* @remarks
|
|
12450
|
-
* When set, the shell application loads the UI module from this remote instead of using the
|
|
12451
|
-
* built-in default host UI. The loaded module must conform to the {@link @gooddata/sdk-pluggable-application-model#IHostUiModule}
|
|
12452
|
-
* interface.
|
|
12453
|
-
*
|
|
12454
|
-
* This allows organizations to fully replace the application chrome (header, navigation, layout)
|
|
12455
|
-
* with a custom implementation while keeping the pluggable application loading and lifecycle
|
|
12456
|
-
* management intact.
|
|
12423
|
+
* Defaults to {@link DefaultPublisherHeadingType}. The size owns the semantic typography that goes
|
|
12424
|
+
* with it; the rest of the style overrides ink and placement on top of it.
|
|
12457
12425
|
*/
|
|
12458
|
-
|
|
12426
|
+
type?: PublisherHeadingType;
|
|
12459
12427
|
}
|
|
12460
12428
|
|
|
12461
12429
|
/**
|
|
12462
|
-
*
|
|
12430
|
+
* Image painted behind a section's or page's content.
|
|
12463
12431
|
*
|
|
12464
12432
|
* @alpha
|
|
12465
12433
|
*/
|
|
12466
|
-
export declare interface
|
|
12467
|
-
|
|
12434
|
+
export declare interface IPublisherImageBackground {
|
|
12435
|
+
type: "image";
|
|
12468
12436
|
/**
|
|
12469
|
-
*
|
|
12470
|
-
*
|
|
12437
|
+
* Local identifier of an image slot in {@link IPublisherPageBody.slots}. Routing the image
|
|
12438
|
+
* through a slot keeps it template-fillable and gives it the slot's placeholder metadata.
|
|
12439
|
+
* A reference that is missing or resolves to a non-image slot paints no background.
|
|
12471
12440
|
*/
|
|
12472
|
-
|
|
12441
|
+
slotId: string;
|
|
12473
12442
|
}
|
|
12474
12443
|
|
|
12475
12444
|
/**
|
|
12476
|
-
*
|
|
12445
|
+
* Slot rendering an image.
|
|
12477
12446
|
*
|
|
12478
12447
|
* @alpha
|
|
12479
12448
|
*/
|
|
12480
|
-
export declare interface
|
|
12481
|
-
type: "
|
|
12449
|
+
export declare interface IPublisherImageSlot extends IPublisherSlotBase {
|
|
12450
|
+
type: "image";
|
|
12482
12451
|
/**
|
|
12483
|
-
*
|
|
12452
|
+
* Undefined = declared-but-empty slot.
|
|
12484
12453
|
*/
|
|
12485
|
-
|
|
12454
|
+
source?: PublisherImageSource;
|
|
12455
|
+
altText?: string;
|
|
12486
12456
|
/**
|
|
12487
|
-
*
|
|
12488
|
-
* deterministically without re-invoking AI. Absent until first generation.
|
|
12457
|
+
* How the image fills the slot area. Defaults to "contain".
|
|
12489
12458
|
*/
|
|
12490
|
-
|
|
12459
|
+
fit?: PublisherImageFit;
|
|
12491
12460
|
/**
|
|
12492
|
-
*
|
|
12461
|
+
* Placement overrides for the drawn image; centered on both axes by default.
|
|
12493
12462
|
*/
|
|
12494
|
-
|
|
12463
|
+
style?: IPublisherImageStyle;
|
|
12495
12464
|
}
|
|
12496
12465
|
|
|
12497
12466
|
/**
|
|
12498
|
-
*
|
|
12499
|
-
*
|
|
12467
|
+
* Where the drawn image sits when it does not fill its box, and which part of it is kept when it
|
|
12468
|
+
* is cropped to fill one.
|
|
12500
12469
|
*
|
|
12501
12470
|
* @alpha
|
|
12502
12471
|
*/
|
|
12503
|
-
export declare
|
|
12472
|
+
export declare interface IPublisherImageStyle {
|
|
12473
|
+
horizontalAlign?: PublisherContentAlignment;
|
|
12474
|
+
verticalAlign?: PublisherContentAlignment;
|
|
12475
|
+
}
|
|
12504
12476
|
|
|
12505
12477
|
/**
|
|
12506
|
-
* Fields
|
|
12478
|
+
* Fields common to all page layout nodes.
|
|
12507
12479
|
*
|
|
12508
12480
|
* @alpha
|
|
12509
12481
|
*/
|
|
12510
|
-
export declare interface
|
|
12511
|
-
title: string;
|
|
12512
|
-
description?: string;
|
|
12513
|
-
tags?: string[];
|
|
12514
|
-
/**
|
|
12515
|
-
* Reported period start, ISO 8601 date (YYYY-MM-DD), inclusive.
|
|
12516
|
-
*
|
|
12517
|
-
* @remarks
|
|
12518
|
-
* At execution time the period materializes as an absolute date filter on each
|
|
12519
|
-
* visualization slot's dateDataSet (lowest precedence, per-slot opt-out via
|
|
12520
|
-
* ignoreReportPeriod). Also available as `{periodStart}` in text.
|
|
12521
|
-
*/
|
|
12522
|
-
periodStart: ReportDateString;
|
|
12523
|
-
/**
|
|
12524
|
-
* Reported period end, ISO 8601 date (YYYY-MM-DD), inclusive.
|
|
12525
|
-
*/
|
|
12526
|
-
periodEnd: ReportDateString;
|
|
12527
|
-
/**
|
|
12528
|
-
* Content of the report. When created from a template the content is deep-copied
|
|
12529
|
-
* and NO reference to the template is kept — the report stays frozen while pages
|
|
12530
|
-
* and templates evolve.
|
|
12531
|
-
*/
|
|
12532
|
-
content: IReportContent;
|
|
12482
|
+
export declare interface IPublisherLayoutNodeBase {
|
|
12533
12483
|
/**
|
|
12534
|
-
*
|
|
12484
|
+
* Fractional weight of this node inside its parent (flex-grow semantics).
|
|
12485
|
+
* Defaults to 1. Example: sibling weights [2, 1] render a 2/3 + 1/3 split.
|
|
12535
12486
|
*/
|
|
12536
|
-
|
|
12487
|
+
weight?: number;
|
|
12537
12488
|
}
|
|
12538
12489
|
|
|
12539
12490
|
/**
|
|
12540
|
-
*
|
|
12541
|
-
* geometry always comes from layout weights.
|
|
12491
|
+
* A container splitting its area into children laid out along a direction.
|
|
12542
12492
|
*
|
|
12543
12493
|
* @alpha
|
|
12544
12494
|
*/
|
|
12545
|
-
export declare interface
|
|
12546
|
-
|
|
12495
|
+
export declare interface IPublisherLayoutSection extends IPublisherLayoutNodeBase {
|
|
12496
|
+
type: "section";
|
|
12547
12497
|
/**
|
|
12548
|
-
*
|
|
12549
|
-
* is sized in, so the corners keep their proportion however large the page is rendered.
|
|
12550
|
-
* Content reaching into a rounded corner is clipped.
|
|
12498
|
+
* "row" lays children out horizontally, "column" vertically.
|
|
12551
12499
|
*/
|
|
12552
|
-
|
|
12500
|
+
direction: "row" | "column";
|
|
12501
|
+
children: PublisherPageLayoutNode[];
|
|
12553
12502
|
/**
|
|
12554
|
-
*
|
|
12555
|
-
* {@link IReportBoxStyle.borderRadius}. Insets only inward — siblings and the layout
|
|
12556
|
-
* gaps around the box are untouched. A box that paints a background usually wants one;
|
|
12557
|
-
* a full-bleed box (an image-backed cover) wants none, which is why no default exists.
|
|
12503
|
+
* Paint of this section's box. Never affects how children are laid out.
|
|
12558
12504
|
*/
|
|
12559
|
-
|
|
12505
|
+
style?: IPublisherBoxStyle;
|
|
12560
12506
|
}
|
|
12561
12507
|
|
|
12562
12508
|
/**
|
|
12563
|
-
*
|
|
12509
|
+
* A leaf assigning its area to a slot. The slot fills the area completely.
|
|
12564
12510
|
*
|
|
12565
12511
|
* @alpha
|
|
12566
12512
|
*/
|
|
12567
|
-
export declare interface
|
|
12568
|
-
type: "
|
|
12513
|
+
export declare interface IPublisherLayoutSlotRef extends IPublisherLayoutNodeBase {
|
|
12514
|
+
type: "slotRef";
|
|
12569
12515
|
/**
|
|
12570
|
-
*
|
|
12571
|
-
*
|
|
12516
|
+
* Local identifier of a slot in {@link IPublisherPageBody.slots}.
|
|
12517
|
+
* A slotId with no matching slot renders as an empty area.
|
|
12572
12518
|
*/
|
|
12573
|
-
|
|
12519
|
+
slotId: string;
|
|
12574
12520
|
}
|
|
12575
12521
|
|
|
12576
12522
|
/**
|
|
12577
|
-
*
|
|
12523
|
+
* Body of a document page: geometry (flex split tree) plus the slots it places.
|
|
12524
|
+
*
|
|
12525
|
+
* @remarks
|
|
12526
|
+
* This is both the content of the standalone {@link IPublisherPageLayout} object and the shape
|
|
12527
|
+
* embedded in template/document content ({@link IPublisherDocumentPage}).
|
|
12528
|
+
*
|
|
12529
|
+
* There is no header/footer chrome: page title, description, footer, page numbers and
|
|
12530
|
+
* logos are ordinary slots in the layout tree (text slots with `{currentPageNumber}`/`{totalPages}`,
|
|
12531
|
+
* an image slot with `{logo}`). Every slot fills its layout area completely.
|
|
12578
12532
|
*
|
|
12579
12533
|
* @alpha
|
|
12580
12534
|
*/
|
|
12581
|
-
export declare interface
|
|
12535
|
+
export declare interface IPublisherPageBody {
|
|
12582
12536
|
/**
|
|
12583
|
-
*
|
|
12537
|
+
* Editor hint only (template galleries, default styling, AI context).
|
|
12538
|
+
* Renderers must not branch layout logic on it — geometry always comes from `layout`.
|
|
12584
12539
|
*/
|
|
12585
|
-
|
|
12540
|
+
kind?: "cover" | "section" | "content";
|
|
12586
12541
|
/**
|
|
12587
|
-
*
|
|
12542
|
+
* Page proportions the layout was authored for. Defaults to
|
|
12543
|
+
* {@link DefaultPublisherPageFormat}.
|
|
12588
12544
|
*/
|
|
12589
|
-
|
|
12545
|
+
format?: PublisherPageFormat;
|
|
12590
12546
|
/**
|
|
12591
|
-
*
|
|
12592
|
-
* The report period is NOT stored here — it is derived from periodStart/periodEnd
|
|
12593
|
-
* at execution time.
|
|
12547
|
+
* Paint of the page itself, behind everything the layout places.
|
|
12594
12548
|
*/
|
|
12595
|
-
|
|
12549
|
+
style?: IPublisherBoxStyle;
|
|
12596
12550
|
/**
|
|
12597
|
-
*
|
|
12598
|
-
*
|
|
12599
|
-
* @remarks
|
|
12600
|
-
* A filter with a `displayAsLabel` must be stored on the attribute's primary label: its selection
|
|
12601
|
-
* is read as primary-label values and shown by `displayAsLabel`.
|
|
12551
|
+
* Root of the page layout tree.
|
|
12602
12552
|
*/
|
|
12603
|
-
|
|
12553
|
+
layout: PublisherPageLayoutNode;
|
|
12604
12554
|
/**
|
|
12605
|
-
*
|
|
12606
|
-
* ({@link IReportBase.variableValues}).
|
|
12555
|
+
* All slots referenced by the layout, flat, keyed by localIdentifier.
|
|
12607
12556
|
*/
|
|
12608
|
-
|
|
12557
|
+
slots: PublisherSlot[];
|
|
12609
12558
|
/**
|
|
12610
|
-
*
|
|
12611
|
-
*
|
|
12559
|
+
* Page-level filters: merged over content-level filters (a filter targeting the
|
|
12560
|
+
* same object replaces the inherited one); slot filters apply on top.
|
|
12612
12561
|
*/
|
|
12613
|
-
|
|
12562
|
+
filters?: FilterContextItem[];
|
|
12614
12563
|
}
|
|
12615
12564
|
|
|
12616
12565
|
/**
|
|
12617
|
-
*
|
|
12618
|
-
* plus its own identity.
|
|
12566
|
+
* Validation issue found in a page body.
|
|
12619
12567
|
*
|
|
12620
|
-
* @
|
|
12621
|
-
|
|
12622
|
-
|
|
12623
|
-
|
|
12624
|
-
|
|
12568
|
+
* @alpha
|
|
12569
|
+
*/
|
|
12570
|
+
export declare interface IPublisherPageBodyValidationIssue {
|
|
12571
|
+
severity: "error" | "warning";
|
|
12572
|
+
message: string;
|
|
12573
|
+
}
|
|
12574
|
+
|
|
12575
|
+
/**
|
|
12576
|
+
* Reusable page layout metadata object.
|
|
12625
12577
|
*
|
|
12626
12578
|
* @alpha
|
|
12627
12579
|
*/
|
|
12628
|
-
export declare interface
|
|
12580
|
+
export declare interface IPublisherPageLayout extends IPublisherPageLayoutDefinition, IAuditableDates, IAuditableUsers {
|
|
12581
|
+
ref: ObjRef;
|
|
12629
12582
|
/**
|
|
12630
|
-
*
|
|
12583
|
+
* When true, the object comes from a parent workspace and is not editable
|
|
12584
|
+
* in the current workspace.
|
|
12631
12585
|
*/
|
|
12632
|
-
|
|
12586
|
+
isLocked?: boolean;
|
|
12587
|
+
/**
|
|
12588
|
+
* Predefined page shipped with the product, populated by the SPI. Never sent to or
|
|
12589
|
+
* stored on the backend; UI must disable deletion and editing of built-in pages.
|
|
12590
|
+
*/
|
|
12591
|
+
isBuiltIn?: boolean;
|
|
12633
12592
|
}
|
|
12634
12593
|
|
|
12635
12594
|
/**
|
|
12636
|
-
*
|
|
12595
|
+
* Stored content of the reportPage entity.
|
|
12637
12596
|
*
|
|
12638
12597
|
* @alpha
|
|
12639
12598
|
*/
|
|
12640
|
-
export declare interface
|
|
12641
|
-
type: "report";
|
|
12599
|
+
export declare interface IPublisherPageLayoutContent extends IPublisherPageBody {
|
|
12642
12600
|
/**
|
|
12643
|
-
*
|
|
12601
|
+
* Content model version, for stored-content evolution.
|
|
12644
12602
|
*/
|
|
12645
|
-
|
|
12603
|
+
version: "1";
|
|
12646
12604
|
}
|
|
12647
12605
|
|
|
12648
12606
|
/**
|
|
12649
|
-
*
|
|
12650
|
-
*
|
|
12651
|
-
* @remarks
|
|
12652
|
-
* A heading is a line of display text, so it carries no markup of its own: what is typed in it is
|
|
12653
|
-
* what it renders.
|
|
12607
|
+
* Payload for creating or updating a page layout.
|
|
12654
12608
|
*
|
|
12655
12609
|
* @alpha
|
|
12656
12610
|
*/
|
|
12657
|
-
export declare interface
|
|
12658
|
-
type: "
|
|
12659
|
-
style?: IReportHeadingStyle;
|
|
12611
|
+
export declare interface IPublisherPageLayoutDefinition {
|
|
12612
|
+
type: "reportPageLayout";
|
|
12660
12613
|
/**
|
|
12661
|
-
*
|
|
12614
|
+
* Present when updating an existing page.
|
|
12662
12615
|
*/
|
|
12663
|
-
|
|
12616
|
+
ref?: ObjRef;
|
|
12617
|
+
title: string;
|
|
12618
|
+
description?: string;
|
|
12619
|
+
tags?: string[];
|
|
12620
|
+
content: IPublisherPageLayoutContent;
|
|
12664
12621
|
}
|
|
12665
12622
|
|
|
12666
12623
|
/**
|
|
12667
|
-
*
|
|
12624
|
+
* Slot rendering prose, written as markdown.
|
|
12668
12625
|
*
|
|
12669
12626
|
* @alpha
|
|
12670
12627
|
*/
|
|
12671
|
-
export declare interface
|
|
12628
|
+
export declare interface IPublisherParagraphSlot extends IPublisherSlotBase {
|
|
12629
|
+
type: "paragraph";
|
|
12630
|
+
style?: IPublisherParagraphStyle;
|
|
12672
12631
|
/**
|
|
12673
|
-
*
|
|
12674
|
-
* with it; the rest of the style overrides ink and placement on top of it.
|
|
12632
|
+
* Undefined = declared-but-empty slot.
|
|
12675
12633
|
*/
|
|
12676
|
-
|
|
12634
|
+
source?: PublisherTextSource;
|
|
12677
12635
|
}
|
|
12678
12636
|
|
|
12679
12637
|
/**
|
|
12680
|
-
*
|
|
12638
|
+
* Styling of a paragraph slot.
|
|
12681
12639
|
*
|
|
12682
12640
|
* @alpha
|
|
12683
12641
|
*/
|
|
12684
|
-
export declare interface
|
|
12685
|
-
type: "image";
|
|
12642
|
+
export declare interface IPublisherParagraphStyle extends IPublisherTextStyle {
|
|
12686
12643
|
/**
|
|
12687
|
-
*
|
|
12688
|
-
* through a slot keeps it template-fillable and gives it the slot's placeholder metadata.
|
|
12689
|
-
* A reference that is missing or resolves to a non-image slot paints no background.
|
|
12644
|
+
* Defaults to {@link DefaultPublisherParagraphType}.
|
|
12690
12645
|
*/
|
|
12691
|
-
|
|
12646
|
+
type?: PublisherParagraphType;
|
|
12692
12647
|
}
|
|
12693
12648
|
|
|
12694
12649
|
/**
|
|
12695
|
-
*
|
|
12650
|
+
* Structural base of every document slot.
|
|
12651
|
+
*
|
|
12652
|
+
* @remarks
|
|
12653
|
+
* Parsers written against this base can skip slot types introduced by a newer
|
|
12654
|
+
* content version instead of failing.
|
|
12696
12655
|
*
|
|
12697
12656
|
* @alpha
|
|
12698
12657
|
*/
|
|
12699
|
-
export declare interface
|
|
12700
|
-
type:
|
|
12701
|
-
/**
|
|
12702
|
-
* Undefined = declared-but-empty slot.
|
|
12703
|
-
*/
|
|
12704
|
-
source?: ReportImageSource;
|
|
12705
|
-
altText?: string;
|
|
12658
|
+
export declare interface IPublisherSlotBase {
|
|
12659
|
+
type: string;
|
|
12706
12660
|
/**
|
|
12707
|
-
*
|
|
12661
|
+
* Identifier unique within the page body. The layout tree references it, and it is
|
|
12662
|
+
* the join key when a document fills a template's slots. Regenerated when a page is
|
|
12663
|
+
* cloned into template content so repeated use of one page stays unique.
|
|
12708
12664
|
*/
|
|
12709
|
-
|
|
12665
|
+
localIdentifier: string;
|
|
12710
12666
|
/**
|
|
12711
|
-
*
|
|
12667
|
+
* Present when the slot is an unfilled placeholder.
|
|
12712
12668
|
*/
|
|
12713
|
-
|
|
12669
|
+
placeholder?: IPublisherSlotPlaceholder;
|
|
12714
12670
|
}
|
|
12715
12671
|
|
|
12716
12672
|
/**
|
|
12717
|
-
*
|
|
12718
|
-
* is cropped to fill one.
|
|
12673
|
+
* Metadata of a slot that is intentionally left unfilled in a page layout or template.
|
|
12719
12674
|
*
|
|
12720
12675
|
* @alpha
|
|
12721
12676
|
*/
|
|
12722
|
-
export declare interface
|
|
12723
|
-
|
|
12724
|
-
|
|
12677
|
+
export declare interface IPublisherSlotPlaceholder {
|
|
12678
|
+
/**
|
|
12679
|
+
* Authoring hint shown in the empty slot.
|
|
12680
|
+
*/
|
|
12681
|
+
hint?: string;
|
|
12682
|
+
/**
|
|
12683
|
+
* When true, a document is not considered complete until this slot is filled.
|
|
12684
|
+
*/
|
|
12685
|
+
required?: boolean;
|
|
12725
12686
|
}
|
|
12726
12687
|
|
|
12727
12688
|
/**
|
|
12728
|
-
*
|
|
12689
|
+
* Author-written text.
|
|
12729
12690
|
*
|
|
12730
12691
|
* @alpha
|
|
12731
12692
|
*/
|
|
12732
|
-
export declare interface
|
|
12693
|
+
export declare interface IPublisherStaticTextSource {
|
|
12694
|
+
type: "static";
|
|
12733
12695
|
/**
|
|
12734
|
-
*
|
|
12735
|
-
*
|
|
12696
|
+
* Markdown content with `{variable}` placeholders. Stored raw — placeholders are
|
|
12697
|
+
* resolved only at render/export time.
|
|
12736
12698
|
*/
|
|
12737
|
-
|
|
12699
|
+
content: string;
|
|
12738
12700
|
}
|
|
12739
12701
|
|
|
12740
12702
|
/**
|
|
12741
|
-
*
|
|
12703
|
+
* Slot rendering text of either kind.
|
|
12742
12704
|
*
|
|
12743
12705
|
* @alpha
|
|
12744
12706
|
*/
|
|
12745
|
-
export declare
|
|
12746
|
-
type: "section";
|
|
12747
|
-
/**
|
|
12748
|
-
* "row" lays children out horizontally, "column" vertically.
|
|
12749
|
-
*/
|
|
12750
|
-
direction: "row" | "column";
|
|
12751
|
-
children: ReportPageLayoutNode[];
|
|
12752
|
-
/**
|
|
12753
|
-
* Paint of this section's box. Never affects how children are laid out.
|
|
12754
|
-
*/
|
|
12755
|
-
style?: IReportBoxStyle;
|
|
12756
|
-
}
|
|
12707
|
+
export declare type IPublisherTextSlot = IPublisherHeadingSlot | IPublisherParagraphSlot;
|
|
12757
12708
|
|
|
12758
12709
|
/**
|
|
12759
|
-
*
|
|
12710
|
+
* Styling of a text slot: the paint of its box, plus the ink and placement of the text it owns.
|
|
12760
12711
|
*
|
|
12761
12712
|
* @alpha
|
|
12762
12713
|
*/
|
|
12763
|
-
export declare interface
|
|
12764
|
-
type: "slotRef";
|
|
12714
|
+
export declare interface IPublisherTextStyle extends IPublisherBoxStyle {
|
|
12765
12715
|
/**
|
|
12766
|
-
*
|
|
12767
|
-
* A slotId with no matching slot renders as an empty area.
|
|
12716
|
+
* CSS color value. Absolute, like {@link IPublisherColorBackground.color}.
|
|
12768
12717
|
*/
|
|
12769
|
-
|
|
12718
|
+
color?: string;
|
|
12719
|
+
horizontalAlign?: PublisherContentAlignment;
|
|
12720
|
+
verticalAlign?: PublisherContentAlignment;
|
|
12770
12721
|
}
|
|
12771
12722
|
|
|
12772
12723
|
/**
|
|
12773
|
-
*
|
|
12724
|
+
* A custom variable declared by document content and given a value by a document.
|
|
12774
12725
|
*
|
|
12775
12726
|
* @remarks
|
|
12776
|
-
*
|
|
12777
|
-
*
|
|
12778
|
-
*
|
|
12779
|
-
* There is no header/footer chrome: page title, description, footer, page numbers and
|
|
12780
|
-
* logos are ordinary slots in the layout tree (text slots with `{currentPageNumber}`/`{totalPages}`,
|
|
12781
|
-
* an image slot with `{logo}`). Every slot fills its layout area completely.
|
|
12727
|
+
* Referenced from text as `{name}`. Values come from {@link IPublisherDocumentBase.variableValues},
|
|
12728
|
+
* falling back to {@link IPublisherVariableDefinition.defaultValue}.
|
|
12782
12729
|
*
|
|
12783
12730
|
* @alpha
|
|
12784
12731
|
*/
|
|
12785
|
-
export declare interface
|
|
12732
|
+
export declare interface IPublisherVariableDefinition {
|
|
12786
12733
|
/**
|
|
12787
|
-
*
|
|
12788
|
-
*
|
|
12734
|
+
* Variable name as used inside the `{...}` marker. Must match /^[a-zA-Z][a-zA-Z0-9_]*$/.
|
|
12735
|
+
* Built-in names ({@link PublisherBuiltInVariable}) are reserved.
|
|
12789
12736
|
*/
|
|
12790
|
-
|
|
12737
|
+
name: string;
|
|
12791
12738
|
/**
|
|
12792
|
-
*
|
|
12793
|
-
* {@link DefaultReportPageFormat}.
|
|
12739
|
+
* Human readable label shown in the editor.
|
|
12794
12740
|
*/
|
|
12795
|
-
|
|
12741
|
+
title?: string;
|
|
12742
|
+
description?: string;
|
|
12796
12743
|
/**
|
|
12797
|
-
*
|
|
12744
|
+
* Value used when the document does not provide one. May not contain further
|
|
12745
|
+
* placeholders — there is no recursive expansion.
|
|
12798
12746
|
*/
|
|
12799
|
-
|
|
12747
|
+
defaultValue?: string;
|
|
12748
|
+
}
|
|
12749
|
+
|
|
12750
|
+
/**
|
|
12751
|
+
* Slot rendering an insight, with its own filter context.
|
|
12752
|
+
*
|
|
12753
|
+
* @alpha
|
|
12754
|
+
*/
|
|
12755
|
+
export declare interface IPublisherVisualizationSlot extends IPublisherSlotBase {
|
|
12756
|
+
type: "visualization";
|
|
12800
12757
|
/**
|
|
12801
|
-
*
|
|
12758
|
+
* Insight to render. Undefined = declared-but-empty slot; renderers show a placeholder.
|
|
12802
12759
|
*/
|
|
12803
|
-
|
|
12760
|
+
insight?: ObjRef;
|
|
12804
12761
|
/**
|
|
12805
|
-
*
|
|
12762
|
+
* Optional title rendered above the visualization. Supports `{variables}`.
|
|
12806
12763
|
*/
|
|
12807
|
-
|
|
12764
|
+
title?: string;
|
|
12765
|
+
showTitle?: boolean;
|
|
12808
12766
|
/**
|
|
12809
|
-
*
|
|
12810
|
-
|
|
12767
|
+
* Visualization properties overriding the insight's own.
|
|
12768
|
+
*/
|
|
12769
|
+
properties?: VisualizationProperties;
|
|
12770
|
+
/**
|
|
12771
|
+
* Slot-level filters, applied on top of the effective content and page filters.
|
|
12772
|
+
* A slot filter targeting the same object replaces the inherited one.
|
|
12811
12773
|
*/
|
|
12812
12774
|
filters?: FilterContextItem[];
|
|
12775
|
+
/**
|
|
12776
|
+
* Content- and page-level filters this slot ignores (matched by display form / date dataset).
|
|
12777
|
+
*/
|
|
12778
|
+
ignoredFilters?: IDashboardFilterReference[];
|
|
12779
|
+
/**
|
|
12780
|
+
* Date dataset the document's period (periodStart/periodEnd) is applied to as an
|
|
12781
|
+
* absolute date filter at execution time. Undefined = backend date-dataset
|
|
12782
|
+
* auto-resolution applies.
|
|
12783
|
+
*/
|
|
12784
|
+
dateDataSet?: ObjRef;
|
|
12785
|
+
/**
|
|
12786
|
+
* When true, the implicit date filter derived from the document's period is not
|
|
12787
|
+
* applied to this slot.
|
|
12788
|
+
*/
|
|
12789
|
+
ignoreReportPeriod?: boolean;
|
|
12813
12790
|
}
|
|
12814
12791
|
|
|
12815
12792
|
/**
|
|
12816
|
-
*
|
|
12817
|
-
*
|
|
12818
|
-
* @alpha
|
|
12793
|
+
* @public
|
|
12819
12794
|
*/
|
|
12820
|
-
export declare interface
|
|
12821
|
-
|
|
12822
|
-
message: string;
|
|
12795
|
+
export declare interface IRangeCondition {
|
|
12796
|
+
range: IRangeConditionBody;
|
|
12823
12797
|
}
|
|
12824
12798
|
|
|
12825
12799
|
/**
|
|
12826
|
-
*
|
|
12800
|
+
* Object defining the {@link IRangeCondition} object body.
|
|
12827
12801
|
*
|
|
12828
|
-
* @
|
|
12802
|
+
* @public
|
|
12829
12803
|
*/
|
|
12830
|
-
export declare interface
|
|
12831
|
-
|
|
12832
|
-
|
|
12833
|
-
|
|
12834
|
-
|
|
12835
|
-
*/
|
|
12836
|
-
isLocked?: boolean;
|
|
12837
|
-
/**
|
|
12838
|
-
* Predefined page shipped with the product, populated by the SPI. Never sent to or
|
|
12839
|
-
* stored on the backend; UI must disable deletion and editing of built-in pages.
|
|
12840
|
-
*/
|
|
12841
|
-
isBuiltIn?: boolean;
|
|
12804
|
+
export declare interface IRangeConditionBody {
|
|
12805
|
+
operator: RangeConditionOperator;
|
|
12806
|
+
from: number;
|
|
12807
|
+
to: number;
|
|
12808
|
+
treatNullValuesAs?: number;
|
|
12842
12809
|
}
|
|
12843
12810
|
|
|
12844
12811
|
/**
|
|
12845
|
-
*
|
|
12812
|
+
* @public
|
|
12813
|
+
*/
|
|
12814
|
+
export declare interface IRankingFilter {
|
|
12815
|
+
rankingFilter: IRankingFilterBody;
|
|
12816
|
+
}
|
|
12817
|
+
|
|
12818
|
+
/**
|
|
12819
|
+
* Object defining the {@link IRankingFilter} object body.
|
|
12846
12820
|
*
|
|
12847
|
-
* @
|
|
12821
|
+
* @public
|
|
12848
12822
|
*/
|
|
12849
|
-
export declare interface
|
|
12823
|
+
export declare interface IRankingFilterBody extends IIdentifiableFilter {
|
|
12824
|
+
measure: ObjRefInScope;
|
|
12825
|
+
attributes?: ObjRefInScope[];
|
|
12826
|
+
operator: RankingFilterOperator;
|
|
12827
|
+
value: number;
|
|
12828
|
+
applyOnResult?: boolean;
|
|
12850
12829
|
/**
|
|
12851
|
-
*
|
|
12830
|
+
* When set to true, the filter returns exactly {@link IRankingFilterBody.value} items and excludes
|
|
12831
|
+
* additional items that share the boundary value (ties). When false or omitted, the backend default
|
|
12832
|
+
* tie-handling behavior is used.
|
|
12852
12833
|
*/
|
|
12853
|
-
|
|
12834
|
+
strictLimitOfRows?: boolean;
|
|
12854
12835
|
}
|
|
12855
12836
|
|
|
12856
12837
|
/**
|
|
12857
|
-
*
|
|
12838
|
+
* Object defining the {@link IRelativeDateFilter} object body.
|
|
12858
12839
|
*
|
|
12859
|
-
* @
|
|
12840
|
+
* @public
|
|
12860
12841
|
*/
|
|
12861
|
-
export declare interface
|
|
12862
|
-
|
|
12863
|
-
/**
|
|
12864
|
-
* Present when updating an existing page.
|
|
12865
|
-
*/
|
|
12866
|
-
ref?: ObjRef;
|
|
12867
|
-
title: string;
|
|
12868
|
-
description?: string;
|
|
12869
|
-
tags?: string[];
|
|
12870
|
-
content: IReportPageLayoutContent;
|
|
12842
|
+
export declare interface IRelativeBoundedDateFilterBody extends IRelativeDateFilterBody {
|
|
12843
|
+
boundedFilter: IUpperBoundedFilter | ILowerBoundedFilter;
|
|
12871
12844
|
}
|
|
12872
12845
|
|
|
12873
12846
|
/**
|
|
12874
|
-
*
|
|
12847
|
+
* Filters results to a relative date range.
|
|
12875
12848
|
*
|
|
12876
|
-
* @
|
|
12849
|
+
* @remarks
|
|
12850
|
+
* The relative filtering is always done on some granularity - this specifies
|
|
12851
|
+
* the units in the 'from' and 'to' fields.
|
|
12852
|
+
*
|
|
12853
|
+
* See {@link DateAttributeGranularity}, {@link AllTimeGranularity} and {@link DateGranularity} for further detail.
|
|
12854
|
+
* @public
|
|
12877
12855
|
*/
|
|
12878
|
-
export declare
|
|
12879
|
-
|
|
12880
|
-
|
|
12856
|
+
export declare type IRelativeDateFilter = {
|
|
12857
|
+
relativeDateFilter: IRelativeDateFilterBody;
|
|
12858
|
+
} | {
|
|
12859
|
+
relativeDateFilter: IRelativeDateFilterAllTimeBody;
|
|
12860
|
+
} | {
|
|
12861
|
+
relativeDateFilter: IRelativeBoundedDateFilterBody;
|
|
12862
|
+
};
|
|
12863
|
+
|
|
12864
|
+
/**
|
|
12865
|
+
* Object defining the {@link IRelativeDateFilter} object body.
|
|
12866
|
+
*
|
|
12867
|
+
* @public
|
|
12868
|
+
*/
|
|
12869
|
+
export declare interface IRelativeDateFilterAllTimeBody extends IIdentifiableFilter {
|
|
12870
|
+
dataSet: ObjRef;
|
|
12871
|
+
granularity: AllTimeGranularity;
|
|
12872
|
+
from: 0;
|
|
12873
|
+
to: 0;
|
|
12881
12874
|
/**
|
|
12882
|
-
*
|
|
12875
|
+
* How to treat empty date values.
|
|
12883
12876
|
*/
|
|
12884
|
-
|
|
12877
|
+
emptyValueHandling?: EmptyValues;
|
|
12885
12878
|
}
|
|
12886
12879
|
|
|
12887
12880
|
/**
|
|
12888
|
-
*
|
|
12881
|
+
* Object defining the {@link IRelativeDateFilter} object body.
|
|
12889
12882
|
*
|
|
12890
|
-
* @
|
|
12883
|
+
* @public
|
|
12891
12884
|
*/
|
|
12892
|
-
export declare interface
|
|
12885
|
+
export declare interface IRelativeDateFilterBody extends IIdentifiableFilter {
|
|
12886
|
+
dataSet: ObjRef;
|
|
12887
|
+
granularity: DateAttributeGranularity;
|
|
12888
|
+
from: number;
|
|
12889
|
+
to: number;
|
|
12893
12890
|
/**
|
|
12894
|
-
*
|
|
12891
|
+
* How to treat empty date values.
|
|
12895
12892
|
*/
|
|
12896
|
-
|
|
12893
|
+
emptyValueHandling?: EmptyValues;
|
|
12897
12894
|
}
|
|
12898
12895
|
|
|
12899
12896
|
/**
|
|
12900
|
-
*
|
|
12901
|
-
*
|
|
12902
|
-
* @remarks
|
|
12903
|
-
* Parsers written against this base can skip slot types introduced by a newer
|
|
12904
|
-
* content version instead of failing.
|
|
12905
|
-
*
|
|
12897
|
+
* Customized options for the global relative date filter
|
|
12906
12898
|
* @alpha
|
|
12907
12899
|
*/
|
|
12908
|
-
export declare interface
|
|
12909
|
-
type: string;
|
|
12900
|
+
export declare interface IRelativeDateFilterForm extends IDateFilterOption {
|
|
12910
12901
|
/**
|
|
12911
|
-
*
|
|
12912
|
-
* the join key when a report fills a template's slots. Regenerated when a page is
|
|
12913
|
-
* cloned into template content so repeated use of one page stays unique.
|
|
12902
|
+
* Type to identify the global relative date filter
|
|
12914
12903
|
*/
|
|
12915
|
-
|
|
12904
|
+
type: DateFilterOptionRelativeFormType;
|
|
12916
12905
|
/**
|
|
12917
|
-
*
|
|
12906
|
+
* Available granularities for the global relative date filter
|
|
12918
12907
|
*/
|
|
12919
|
-
|
|
12908
|
+
availableGranularities: DateFilterGranularity[];
|
|
12909
|
+
/**
|
|
12910
|
+
* Optional configuration for how this option should treat empty date values.
|
|
12911
|
+
*/
|
|
12912
|
+
emptyValueHandling?: EmptyValues;
|
|
12920
12913
|
}
|
|
12921
12914
|
|
|
12922
12915
|
/**
|
|
12923
|
-
*
|
|
12924
|
-
*
|
|
12916
|
+
* Custom relative date filter preset
|
|
12925
12917
|
* @alpha
|
|
12926
12918
|
*/
|
|
12927
|
-
export declare interface
|
|
12919
|
+
export declare interface IRelativeDateFilterPreset extends IDateFilterOption {
|
|
12928
12920
|
/**
|
|
12929
|
-
*
|
|
12921
|
+
* Type to identify a relative date filter preset
|
|
12930
12922
|
*/
|
|
12931
|
-
|
|
12923
|
+
type: DateFilterOptionRelativePresetType;
|
|
12932
12924
|
/**
|
|
12933
|
-
*
|
|
12925
|
+
* Relative date filter granularity (day/week/year,etc.)
|
|
12934
12926
|
*/
|
|
12935
|
-
|
|
12936
|
-
}
|
|
12937
|
-
|
|
12938
|
-
/**
|
|
12939
|
-
* Author-written text.
|
|
12940
|
-
*
|
|
12941
|
-
* @alpha
|
|
12942
|
-
*/
|
|
12943
|
-
export declare interface IReportStaticTextSource {
|
|
12944
|
-
type: "static";
|
|
12927
|
+
granularity: DateFilterGranularity;
|
|
12945
12928
|
/**
|
|
12946
|
-
*
|
|
12947
|
-
* resolved only at render/export time.
|
|
12929
|
+
* Relative date filter granularity start offset
|
|
12948
12930
|
*/
|
|
12949
|
-
|
|
12950
|
-
}
|
|
12951
|
-
|
|
12952
|
-
/**
|
|
12953
|
-
* Report template metadata object.
|
|
12954
|
-
*
|
|
12955
|
-
* @alpha
|
|
12956
|
-
*/
|
|
12957
|
-
export declare interface IReportTemplate extends IReportTemplateDefinition, IAuditableDates, IAuditableUsers {
|
|
12958
|
-
ref: ObjRef;
|
|
12931
|
+
from: RelativeDateFilterGranularityOffset;
|
|
12959
12932
|
/**
|
|
12960
|
-
*
|
|
12961
|
-
* in the current workspace.
|
|
12933
|
+
* Relative date filter granularity end offset
|
|
12962
12934
|
*/
|
|
12963
|
-
|
|
12935
|
+
to: RelativeDateFilterGranularityOffset;
|
|
12936
|
+
/**
|
|
12937
|
+
* Additional bound for the relative date filter
|
|
12938
|
+
*/
|
|
12939
|
+
boundedFilter?: IUpperBoundedFilter | ILowerBoundedFilter;
|
|
12940
|
+
/**
|
|
12941
|
+
* Optional configuration for how this preset should treat empty date values.
|
|
12942
|
+
*/
|
|
12943
|
+
emptyValueHandling?: EmptyValues;
|
|
12964
12944
|
}
|
|
12965
12945
|
|
|
12966
12946
|
/**
|
|
12967
|
-
*
|
|
12968
|
-
*
|
|
12947
|
+
* Generic type to express relative date filter preset of a particular granularity
|
|
12969
12948
|
* @alpha
|
|
12970
12949
|
*/
|
|
12971
|
-
export declare interface
|
|
12972
|
-
type: "reportTemplate";
|
|
12950
|
+
export declare interface IRelativeDateFilterPresetOfGranularity<Key extends DateFilterGranularity> extends IRelativeDateFilterPreset {
|
|
12973
12951
|
/**
|
|
12974
|
-
*
|
|
12952
|
+
* Particular relative date filter preset granularity
|
|
12975
12953
|
*/
|
|
12976
|
-
|
|
12977
|
-
title: string;
|
|
12978
|
-
description?: string;
|
|
12979
|
-
tags?: string[];
|
|
12980
|
-
content: IReportContent;
|
|
12954
|
+
granularity: Key;
|
|
12981
12955
|
}
|
|
12982
12956
|
|
|
12983
12957
|
/**
|
|
12984
|
-
*
|
|
12958
|
+
* Represents values of a relative filter.
|
|
12985
12959
|
*
|
|
12986
|
-
* @
|
|
12960
|
+
* @public
|
|
12987
12961
|
*/
|
|
12988
|
-
export declare
|
|
12962
|
+
export declare interface IRelativeDateFilterValues {
|
|
12963
|
+
from: number;
|
|
12964
|
+
to: number;
|
|
12965
|
+
granularity: string;
|
|
12966
|
+
dataSet?: ObjRef;
|
|
12967
|
+
boundedFilter?: IUpperBoundedFilter | ILowerBoundedFilter;
|
|
12968
|
+
emptyValueHandling?: EmptyValues;
|
|
12969
|
+
}
|
|
12989
12970
|
|
|
12990
12971
|
/**
|
|
12991
|
-
*
|
|
12972
|
+
* Definition of the remote pluggable application.
|
|
12973
|
+
* The application is loaded via Module Federation.
|
|
12992
12974
|
*
|
|
12993
12975
|
* @alpha
|
|
12994
12976
|
*/
|
|
12995
|
-
export declare interface
|
|
12977
|
+
export declare interface IRemotePluggableApplicationModule {
|
|
12996
12978
|
/**
|
|
12997
|
-
*
|
|
12979
|
+
* Full URL of the remote federated module with the application bundle.
|
|
12980
|
+
*
|
|
12981
|
+
* @example
|
|
12982
|
+
* https://my-remote-federated-module.com/remoteEntry.js
|
|
12998
12983
|
*/
|
|
12999
|
-
|
|
13000
|
-
horizontalAlign?: ReportContentAlignment;
|
|
13001
|
-
verticalAlign?: ReportContentAlignment;
|
|
13002
|
-
}
|
|
13003
|
-
|
|
13004
|
-
/**
|
|
13005
|
-
* A custom variable declared by report content and given a value by a report.
|
|
13006
|
-
*
|
|
13007
|
-
* @remarks
|
|
13008
|
-
* Referenced from text as `{name}`. Values come from {@link IReportBase.variableValues},
|
|
13009
|
-
* falling back to {@link IReportVariableDefinition.defaultValue}.
|
|
13010
|
-
*
|
|
13011
|
-
* @alpha
|
|
13012
|
-
*/
|
|
13013
|
-
export declare interface IReportVariableDefinition {
|
|
12984
|
+
url: string;
|
|
13014
12985
|
/**
|
|
13015
|
-
*
|
|
13016
|
-
*
|
|
12986
|
+
* Unique module federation scope value (must match the remote module definition during build)
|
|
12987
|
+
* Must be unique within the same remote federation to not share dependencies and scope with another
|
|
12988
|
+
* application.
|
|
12989
|
+
*
|
|
12990
|
+
* @example
|
|
12991
|
+
* "my-remote-federated-module"
|
|
13017
12992
|
*/
|
|
13018
|
-
|
|
12993
|
+
scope: string;
|
|
13019
12994
|
/**
|
|
13020
|
-
*
|
|
12995
|
+
* Exposed module name. Must match the remote module definition.
|
|
12996
|
+
* Maps to internal application module (e.g. "./src/remote-entry.tsx")
|
|
12997
|
+
*
|
|
12998
|
+
* @example
|
|
12999
|
+
* "./AppModule"
|
|
13021
13000
|
*/
|
|
13022
|
-
|
|
13023
|
-
description?: string;
|
|
13001
|
+
module: string;
|
|
13024
13002
|
/**
|
|
13025
|
-
*
|
|
13026
|
-
*
|
|
13003
|
+
* Base route of the application.
|
|
13004
|
+
* It is relative to the shell application route.
|
|
13005
|
+
*
|
|
13006
|
+
* @example
|
|
13007
|
+
* "/my-application"
|
|
13008
|
+
*
|
|
13009
|
+
* When the application is registered to "organization" scope, the application will be hosted at
|
|
13010
|
+
* /organization/my-application.
|
|
13011
|
+
* When the application is registered to the "workspace" scope, the application will be hosted at
|
|
13012
|
+
* /workspace/\{workspaceId\}/my-application.
|
|
13027
13013
|
*/
|
|
13028
|
-
|
|
13014
|
+
routeBase: string;
|
|
13029
13015
|
}
|
|
13030
13016
|
|
|
13031
13017
|
/**
|
|
13032
|
-
*
|
|
13018
|
+
* Remote pluggable application registry item, v1.
|
|
13019
|
+
* Loaded via Module Federation.
|
|
13033
13020
|
*
|
|
13034
13021
|
* @alpha
|
|
13035
13022
|
*/
|
|
13036
|
-
export declare interface
|
|
13037
|
-
type: "visualization";
|
|
13038
|
-
/**
|
|
13039
|
-
* Insight to render. Undefined = declared-but-empty slot; renderers show a placeholder.
|
|
13040
|
-
*/
|
|
13041
|
-
insight?: ObjRef;
|
|
13023
|
+
export declare interface IRemotePluggableApplicationRegistryItemV1 extends IPluggableApplicationMetaV1 {
|
|
13042
13024
|
/**
|
|
13043
|
-
*
|
|
13025
|
+
* Defines how the remote-federated module should be loaded.
|
|
13044
13026
|
*/
|
|
13045
|
-
|
|
13046
|
-
|
|
13027
|
+
remote: IRemotePluggableApplicationModule;
|
|
13028
|
+
}
|
|
13029
|
+
|
|
13030
|
+
/**
|
|
13031
|
+
* Pluggable application remote registry, v1.
|
|
13032
|
+
*
|
|
13033
|
+
* @alpha
|
|
13034
|
+
*/
|
|
13035
|
+
export declare interface IRemotePluggableApplicationsRegistryV1 {
|
|
13047
13036
|
/**
|
|
13048
|
-
*
|
|
13037
|
+
* The version of the API used by the application manifest
|
|
13049
13038
|
*/
|
|
13050
|
-
|
|
13039
|
+
apiVersion: "1.0";
|
|
13051
13040
|
/**
|
|
13052
|
-
*
|
|
13053
|
-
*
|
|
13041
|
+
* The overrides of the pluggable applications deployed in the shell application by default.
|
|
13042
|
+
*
|
|
13043
|
+
* Each override is mapped to a key that is the well-documented ID of the default pluggable application,
|
|
13044
|
+
* e.g., gdc-analytical-designer, gdc-dashboards, etc. The property can be used, for example, to disable
|
|
13045
|
+
* one of these applications or changing the order under which it is added to the Application Header menu.
|
|
13054
13046
|
*/
|
|
13055
|
-
|
|
13047
|
+
overrides?: {
|
|
13048
|
+
[applicationId: string]: Partial<PluggableApplicationRegistryItem>;
|
|
13049
|
+
};
|
|
13056
13050
|
/**
|
|
13057
|
-
*
|
|
13051
|
+
* The optional list of allowed standard applications.
|
|
13052
|
+
*
|
|
13053
|
+
* The array of well-documented IDs of the standard applications that are deployed in the shell
|
|
13054
|
+
* application by default. The property can be used to stabilize which of the standard applications
|
|
13055
|
+
* will be available in the Application Header menu. When a new standard application is deployed in
|
|
13056
|
+
* the shell application, it will not appear in the menu until it is added to the list of allowed
|
|
13057
|
+
* standard applications.
|
|
13058
13058
|
*/
|
|
13059
|
-
|
|
13059
|
+
allowedStandardApplications?: string[];
|
|
13060
13060
|
/**
|
|
13061
|
-
*
|
|
13062
|
-
*
|
|
13063
|
-
*
|
|
13061
|
+
* The list of additional pluggable applications registered to the shell application.
|
|
13062
|
+
*
|
|
13063
|
+
* Mainly used to register 3rd party hosted remote module federated applications.
|
|
13064
13064
|
*/
|
|
13065
|
-
|
|
13065
|
+
applications?: PluggableApplicationRegistryItem[];
|
|
13066
13066
|
/**
|
|
13067
|
-
*
|
|
13068
|
-
*
|
|
13067
|
+
* Optional remote module federation definition for a custom host UI module.
|
|
13068
|
+
*
|
|
13069
|
+
* @remarks
|
|
13070
|
+
* When set, the shell application loads the UI module from this remote instead of using the
|
|
13071
|
+
* built-in default host UI. The loaded module must conform to the {@link @gooddata/sdk-pluggable-application-model#IHostUiModule}
|
|
13072
|
+
* interface.
|
|
13073
|
+
*
|
|
13074
|
+
* This allows organizations to fully replace the application chrome (header, navigation, layout)
|
|
13075
|
+
* with a custom implementation while keeping the pluggable application loading and lifecycle
|
|
13076
|
+
* management intact.
|
|
13069
13077
|
*/
|
|
13070
|
-
|
|
13078
|
+
uiModule?: IRemotePluggableApplicationModule;
|
|
13071
13079
|
}
|
|
13072
13080
|
|
|
13073
13081
|
/**
|
|
@@ -15034,260 +15042,260 @@ export declare function isPreviousPeriodMeasure(obj: unknown): obj is IMeasure<I
|
|
|
15034
15042
|
export declare function isPreviousPeriodMeasureDefinition(obj: unknown): obj is IPreviousPeriodMeasureDefinition;
|
|
15035
15043
|
|
|
15036
15044
|
/**
|
|
15037
|
-
* Type
|
|
15045
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherColorBackground}.
|
|
15038
15046
|
*
|
|
15039
|
-
* @
|
|
15047
|
+
* @alpha
|
|
15040
15048
|
*/
|
|
15041
|
-
export declare function
|
|
15049
|
+
export declare function isPublisherColorBackground(obj: unknown): obj is IPublisherColorBackground;
|
|
15042
15050
|
|
|
15043
15051
|
/**
|
|
15044
|
-
* Type
|
|
15052
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherDocument}.
|
|
15045
15053
|
*
|
|
15046
|
-
* @
|
|
15054
|
+
* @alpha
|
|
15047
15055
|
*/
|
|
15048
|
-
export declare function
|
|
15056
|
+
export declare function isPublisherDocument(obj: unknown): obj is IPublisherDocument;
|
|
15049
15057
|
|
|
15050
15058
|
/**
|
|
15051
|
-
* Type
|
|
15059
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentContent}.
|
|
15052
15060
|
*
|
|
15053
|
-
* @
|
|
15061
|
+
* @alpha
|
|
15054
15062
|
*/
|
|
15055
|
-
export declare function
|
|
15063
|
+
export declare function isPublisherDocumentContentV1(obj: unknown): obj is IPublisherDocumentContent;
|
|
15056
15064
|
|
|
15057
15065
|
/**
|
|
15058
|
-
* Type
|
|
15066
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentDefinition}.
|
|
15059
15067
|
*
|
|
15060
|
-
* @
|
|
15068
|
+
* @alpha
|
|
15061
15069
|
*/
|
|
15062
|
-
export declare function
|
|
15063
|
-
relativeDateFilter: IRelativeBoundedDateFilterBody;
|
|
15064
|
-
};
|
|
15070
|
+
export declare function isPublisherDocumentDefinition(obj: unknown): obj is IPublisherDocumentDefinition;
|
|
15065
15071
|
|
|
15066
15072
|
/**
|
|
15067
|
-
* Type
|
|
15073
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentTemplate}.
|
|
15068
15074
|
*
|
|
15069
|
-
* @public
|
|
15070
|
-
*/
|
|
15071
|
-
export declare function isRelativeBoundedDateFilterBody(obj: unknown): obj is IRelativeBoundedDateFilterBody;
|
|
15072
|
-
|
|
15073
|
-
/**
|
|
15074
|
-
* Returns true when given date filter has type set to relative.
|
|
15075
15075
|
* @alpha
|
|
15076
15076
|
*/
|
|
15077
|
-
export declare function
|
|
15077
|
+
export declare function isPublisherDocumentTemplate(obj: unknown): obj is IPublisherDocumentTemplate;
|
|
15078
15078
|
|
|
15079
15079
|
/**
|
|
15080
|
-
* Type
|
|
15080
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentTemplateDefinition}.
|
|
15081
15081
|
*
|
|
15082
|
-
* @public
|
|
15083
|
-
*/
|
|
15084
|
-
export declare function isRelativeDateFilter(obj: unknown): obj is IRelativeDateFilter;
|
|
15085
|
-
|
|
15086
|
-
/**
|
|
15087
|
-
* Type-guard testing whether the provided object is an instance of {@link IRelativeDateFilterForm}.
|
|
15088
15082
|
* @alpha
|
|
15089
15083
|
*/
|
|
15090
|
-
export declare
|
|
15084
|
+
export declare function isPublisherDocumentTemplateDefinition(obj: unknown): obj is IPublisherDocumentTemplateDefinition;
|
|
15091
15085
|
|
|
15092
15086
|
/**
|
|
15093
|
-
* Type-guard testing whether the provided object is an instance of {@link
|
|
15087
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherHeadingSlot}.
|
|
15088
|
+
*
|
|
15094
15089
|
* @alpha
|
|
15095
15090
|
*/
|
|
15096
|
-
export declare
|
|
15091
|
+
export declare function isPublisherHeadingSlot(obj: unknown): obj is IPublisherHeadingSlot;
|
|
15097
15092
|
|
|
15098
15093
|
/**
|
|
15099
|
-
* Type
|
|
15094
|
+
* Type-guard testing whether the value is a {@link PublisherHeadingType}.
|
|
15100
15095
|
*
|
|
15101
|
-
* @
|
|
15096
|
+
* @alpha
|
|
15102
15097
|
*/
|
|
15103
|
-
export declare function
|
|
15104
|
-
relativeDateFilter: IRelativeBoundedDateFilterBody & {
|
|
15105
|
-
boundedFilter: ILowerBoundedFilter;
|
|
15106
|
-
};
|
|
15107
|
-
};
|
|
15098
|
+
export declare function isPublisherHeadingType(value: unknown): value is PublisherHeadingType;
|
|
15108
15099
|
|
|
15109
15100
|
/**
|
|
15110
|
-
* Type
|
|
15101
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherImageBackground}.
|
|
15111
15102
|
*
|
|
15112
|
-
* @
|
|
15103
|
+
* @alpha
|
|
15113
15104
|
*/
|
|
15114
|
-
export declare function
|
|
15115
|
-
boundedFilter: ILowerBoundedFilter;
|
|
15116
|
-
};
|
|
15105
|
+
export declare function isPublisherImageBackground(obj: unknown): obj is IPublisherImageBackground;
|
|
15117
15106
|
|
|
15118
15107
|
/**
|
|
15119
|
-
* Type
|
|
15108
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherImageSlot}.
|
|
15120
15109
|
*
|
|
15121
|
-
* @
|
|
15110
|
+
* @alpha
|
|
15122
15111
|
*/
|
|
15123
|
-
export declare function
|
|
15124
|
-
relativeDateFilter: IRelativeBoundedDateFilterBody & {
|
|
15125
|
-
boundedFilter: IUpperBoundedFilter;
|
|
15126
|
-
};
|
|
15127
|
-
};
|
|
15112
|
+
export declare function isPublisherImageSlot(obj: unknown): obj is IPublisherImageSlot;
|
|
15128
15113
|
|
|
15129
15114
|
/**
|
|
15130
|
-
* Type
|
|
15115
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherLayoutSection}.
|
|
15131
15116
|
*
|
|
15132
|
-
* @
|
|
15117
|
+
* @alpha
|
|
15133
15118
|
*/
|
|
15134
|
-
export declare function
|
|
15135
|
-
boundedFilter: IUpperBoundedFilter;
|
|
15136
|
-
};
|
|
15119
|
+
export declare function isPublisherLayoutSection(obj: unknown): obj is IPublisherLayoutSection;
|
|
15137
15120
|
|
|
15138
15121
|
/**
|
|
15139
|
-
* Type
|
|
15122
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherLayoutSlotRef}.
|
|
15140
15123
|
*
|
|
15141
15124
|
* @alpha
|
|
15142
15125
|
*/
|
|
15143
|
-
export declare function
|
|
15126
|
+
export declare function isPublisherLayoutSlotRef(obj: unknown): obj is IPublisherLayoutSlotRef;
|
|
15144
15127
|
|
|
15145
15128
|
/**
|
|
15146
|
-
* Type-guard testing whether the provided
|
|
15129
|
+
* Type-guard testing whether the provided value is a {@link PublisherPageFormat}.
|
|
15147
15130
|
*
|
|
15148
15131
|
* @alpha
|
|
15149
15132
|
*/
|
|
15150
|
-
export declare function
|
|
15133
|
+
export declare function isPublisherPageFormat(value: unknown): value is PublisherPageFormat;
|
|
15151
15134
|
|
|
15152
15135
|
/**
|
|
15153
|
-
* Type-guard testing whether the provided object is an instance of {@link
|
|
15136
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayout}.
|
|
15154
15137
|
*
|
|
15155
15138
|
* @alpha
|
|
15156
15139
|
*/
|
|
15157
|
-
export declare function
|
|
15140
|
+
export declare function isPublisherPageLayout(obj: unknown): obj is IPublisherPageLayout;
|
|
15158
15141
|
|
|
15159
15142
|
/**
|
|
15160
|
-
* Type-guard testing whether the provided object is an instance of {@link
|
|
15143
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayoutContent}.
|
|
15161
15144
|
*
|
|
15162
15145
|
* @alpha
|
|
15163
15146
|
*/
|
|
15164
|
-
export declare function
|
|
15147
|
+
export declare function isPublisherPageLayoutContentV1(obj: unknown): obj is IPublisherPageLayoutContent;
|
|
15165
15148
|
|
|
15166
15149
|
/**
|
|
15167
|
-
* Type-guard testing whether the provided object is an instance of {@link
|
|
15150
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayoutDefinition}.
|
|
15168
15151
|
*
|
|
15169
15152
|
* @alpha
|
|
15170
15153
|
*/
|
|
15171
|
-
export declare function
|
|
15154
|
+
export declare function isPublisherPageLayoutDefinition(obj: unknown): obj is IPublisherPageLayoutDefinition;
|
|
15172
15155
|
|
|
15173
15156
|
/**
|
|
15174
|
-
* Type-guard testing whether the provided object is an instance of {@link
|
|
15157
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherParagraphSlot}.
|
|
15175
15158
|
*
|
|
15176
15159
|
* @alpha
|
|
15177
15160
|
*/
|
|
15178
|
-
export declare function
|
|
15161
|
+
export declare function isPublisherParagraphSlot(obj: unknown): obj is IPublisherParagraphSlot;
|
|
15179
15162
|
|
|
15180
15163
|
/**
|
|
15181
|
-
* Type-guard testing whether the value is a {@link
|
|
15164
|
+
* Type-guard testing whether the value is a {@link PublisherParagraphType}.
|
|
15182
15165
|
*
|
|
15183
15166
|
* @alpha
|
|
15184
15167
|
*/
|
|
15185
|
-
export declare function
|
|
15168
|
+
export declare function isPublisherParagraphType(value: unknown): value is PublisherParagraphType;
|
|
15186
15169
|
|
|
15187
15170
|
/**
|
|
15188
|
-
* Type-guard testing whether the provided object is an instance of {@link
|
|
15171
|
+
* Type-guard testing whether the provided object is an instance of {@link PublisherSlot}.
|
|
15189
15172
|
*
|
|
15190
15173
|
* @alpha
|
|
15191
15174
|
*/
|
|
15192
|
-
export declare function
|
|
15175
|
+
export declare function isPublisherSlot(obj: unknown): obj is PublisherSlot;
|
|
15193
15176
|
|
|
15194
15177
|
/**
|
|
15195
|
-
* Type-guard testing whether the provided object is an instance of {@link
|
|
15178
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherTextSlot}.
|
|
15196
15179
|
*
|
|
15197
15180
|
* @alpha
|
|
15198
15181
|
*/
|
|
15199
|
-
export declare function
|
|
15182
|
+
export declare function isPublisherTextSlot(obj: unknown): obj is IPublisherTextSlot;
|
|
15200
15183
|
|
|
15201
15184
|
/**
|
|
15202
|
-
* Type-guard testing whether the provided object is an instance of {@link
|
|
15185
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherVisualizationSlot}.
|
|
15203
15186
|
*
|
|
15204
15187
|
* @alpha
|
|
15205
15188
|
*/
|
|
15206
|
-
export declare function
|
|
15189
|
+
export declare function isPublisherVisualizationSlot(obj: unknown): obj is IPublisherVisualizationSlot;
|
|
15207
15190
|
|
|
15208
15191
|
/**
|
|
15209
|
-
* Type
|
|
15192
|
+
* Type guard checking whether the provided object is a measure value filter's range condition.
|
|
15210
15193
|
*
|
|
15211
|
-
* @
|
|
15194
|
+
* @public
|
|
15212
15195
|
*/
|
|
15213
|
-
export declare function
|
|
15196
|
+
export declare function isRangeCondition(obj: unknown): obj is IRangeCondition;
|
|
15214
15197
|
|
|
15215
15198
|
/**
|
|
15216
|
-
* Type
|
|
15199
|
+
* Type guard checking whether the provided object is a measure value filter's range condition operator.
|
|
15217
15200
|
*
|
|
15218
|
-
* @
|
|
15201
|
+
* @public
|
|
15219
15202
|
*/
|
|
15220
|
-
export declare function
|
|
15203
|
+
export declare function isRangeConditionOperator(obj: unknown): obj is RangeConditionOperator;
|
|
15221
15204
|
|
|
15222
15205
|
/**
|
|
15223
|
-
* Type
|
|
15206
|
+
* Type guard checking whether the provided object is a ranking filter.
|
|
15224
15207
|
*
|
|
15225
|
-
* @
|
|
15208
|
+
* @public
|
|
15226
15209
|
*/
|
|
15227
|
-
export declare function
|
|
15210
|
+
export declare function isRankingFilter(obj: unknown): obj is IRankingFilter;
|
|
15228
15211
|
|
|
15229
15212
|
/**
|
|
15230
|
-
* Type
|
|
15213
|
+
* Type guard checking whether the provided object is a relative date filter with bounded.
|
|
15231
15214
|
*
|
|
15232
|
-
* @
|
|
15215
|
+
* @public
|
|
15233
15216
|
*/
|
|
15234
|
-
export declare function
|
|
15217
|
+
export declare function isRelativeBoundedDateFilter(obj: unknown): obj is IRelativeDateFilter & {
|
|
15218
|
+
relativeDateFilter: IRelativeBoundedDateFilterBody;
|
|
15219
|
+
};
|
|
15235
15220
|
|
|
15236
15221
|
/**
|
|
15237
|
-
* Type
|
|
15222
|
+
* Type guard checking whether the provided object is a relative date filter body with bounded.
|
|
15238
15223
|
*
|
|
15224
|
+
* @public
|
|
15225
|
+
*/
|
|
15226
|
+
export declare function isRelativeBoundedDateFilterBody(obj: unknown): obj is IRelativeBoundedDateFilterBody;
|
|
15227
|
+
|
|
15228
|
+
/**
|
|
15229
|
+
* Returns true when given date filter has type set to relative.
|
|
15239
15230
|
* @alpha
|
|
15240
15231
|
*/
|
|
15241
|
-
export declare function
|
|
15232
|
+
export declare function isRelativeDashboardDateFilter(dateFilter: IDashboardDateFilter): boolean;
|
|
15242
15233
|
|
|
15243
15234
|
/**
|
|
15244
|
-
* Type
|
|
15235
|
+
* Type guard checking whether the provided object is a relative date filter.
|
|
15245
15236
|
*
|
|
15237
|
+
* @public
|
|
15238
|
+
*/
|
|
15239
|
+
export declare function isRelativeDateFilter(obj: unknown): obj is IRelativeDateFilter;
|
|
15240
|
+
|
|
15241
|
+
/**
|
|
15242
|
+
* Type-guard testing whether the provided object is an instance of {@link IRelativeDateFilterForm}.
|
|
15246
15243
|
* @alpha
|
|
15247
15244
|
*/
|
|
15248
|
-
export declare
|
|
15245
|
+
export declare const isRelativeDateFilterForm: (obj: unknown) => obj is IRelativeDateFilterForm;
|
|
15249
15246
|
|
|
15250
15247
|
/**
|
|
15251
|
-
* Type-guard testing whether the
|
|
15252
|
-
*
|
|
15248
|
+
* Type-guard testing whether the provided object is an instance of {@link IRelativeDateFilterPreset}.
|
|
15253
15249
|
* @alpha
|
|
15254
15250
|
*/
|
|
15255
|
-
export declare
|
|
15251
|
+
export declare const isRelativeDateFilterPreset: (obj: unknown) => obj is IRelativeDateFilterPreset;
|
|
15256
15252
|
|
|
15257
15253
|
/**
|
|
15258
|
-
* Type
|
|
15254
|
+
* Type guard checking whether the provided filter is a relative date filter with lower bounded.
|
|
15259
15255
|
*
|
|
15260
|
-
* @
|
|
15256
|
+
* @public
|
|
15261
15257
|
*/
|
|
15262
|
-
export declare function
|
|
15258
|
+
export declare function isRelativeLowerBoundedDateFilter(obj: unknown): obj is IRelativeDateFilter & {
|
|
15259
|
+
relativeDateFilter: IRelativeBoundedDateFilterBody & {
|
|
15260
|
+
boundedFilter: ILowerBoundedFilter;
|
|
15261
|
+
};
|
|
15262
|
+
};
|
|
15263
15263
|
|
|
15264
15264
|
/**
|
|
15265
|
-
* Type
|
|
15265
|
+
* Type guard checking whether the provided filter body has a bounded filter with lower bounded.
|
|
15266
15266
|
*
|
|
15267
|
-
* @
|
|
15267
|
+
* @public
|
|
15268
15268
|
*/
|
|
15269
|
-
export declare function
|
|
15269
|
+
export declare function isRelativeLowerBoundedDateFilterBody(obj: unknown): obj is IRelativeBoundedDateFilterBody & {
|
|
15270
|
+
boundedFilter: ILowerBoundedFilter;
|
|
15271
|
+
};
|
|
15270
15272
|
|
|
15271
15273
|
/**
|
|
15272
|
-
* Type
|
|
15274
|
+
* Type guard checking whether the provided filter is a relative date filter with upper bounded.
|
|
15273
15275
|
*
|
|
15274
|
-
* @
|
|
15276
|
+
* @public
|
|
15275
15277
|
*/
|
|
15276
|
-
export declare function
|
|
15278
|
+
export declare function isRelativeUpperBoundedDateFilter(obj: unknown): obj is IRelativeDateFilter & {
|
|
15279
|
+
relativeDateFilter: IRelativeBoundedDateFilterBody & {
|
|
15280
|
+
boundedFilter: IUpperBoundedFilter;
|
|
15281
|
+
};
|
|
15282
|
+
};
|
|
15277
15283
|
|
|
15278
15284
|
/**
|
|
15279
|
-
* Type
|
|
15285
|
+
* Type guard checking whether the provided filter body has a bounded filter with upper bounded.
|
|
15280
15286
|
*
|
|
15281
|
-
* @
|
|
15287
|
+
* @public
|
|
15282
15288
|
*/
|
|
15283
|
-
export declare function
|
|
15289
|
+
export declare function isRelativeUpperBoundedDateFilterBody(obj: unknown): obj is IRelativeBoundedDateFilterBody & {
|
|
15290
|
+
boundedFilter: IUpperBoundedFilter;
|
|
15291
|
+
};
|
|
15284
15292
|
|
|
15285
15293
|
/**
|
|
15286
|
-
* Type
|
|
15294
|
+
* Type guard for RemotePluggableApplicationRegistryItem
|
|
15287
15295
|
*
|
|
15288
15296
|
* @alpha
|
|
15289
15297
|
*/
|
|
15290
|
-
export declare function
|
|
15298
|
+
export declare function isRemotePluggableApplicationRegistryItem(app: PluggableApplicationRegistryItem): app is RemotePluggableApplicationRegistryItem;
|
|
15291
15299
|
|
|
15292
15300
|
/**
|
|
15293
15301
|
* Type-guard testing whether the provided object is an instance of {@link IResultAttributeHeader}.
|
|
@@ -15823,6 +15831,12 @@ export declare interface ITheme {
|
|
|
15823
15831
|
* Toast message specific properties
|
|
15824
15832
|
*/
|
|
15825
15833
|
toastMessage?: IThemeToastMessage;
|
|
15834
|
+
/**
|
|
15835
|
+
* Toolbar customizable UI properties
|
|
15836
|
+
*
|
|
15837
|
+
* @alpha
|
|
15838
|
+
*/
|
|
15839
|
+
toolbar?: IThemeToolbar;
|
|
15826
15840
|
/**
|
|
15827
15841
|
* Application header (top bar) specific properties
|
|
15828
15842
|
*
|
|
@@ -15830,13 +15844,13 @@ export declare interface ITheme {
|
|
|
15830
15844
|
*/
|
|
15831
15845
|
header?: IThemeHeader;
|
|
15832
15846
|
/**
|
|
15833
|
-
*
|
|
15847
|
+
* Publisher-specific properties
|
|
15834
15848
|
*
|
|
15835
15849
|
* @alpha
|
|
15836
15850
|
*/
|
|
15837
|
-
reports?:
|
|
15851
|
+
reports?: IThemePublisher;
|
|
15838
15852
|
/**
|
|
15839
|
-
* Image assets offered to
|
|
15853
|
+
* Image assets offered to documents
|
|
15840
15854
|
*
|
|
15841
15855
|
* @alpha
|
|
15842
15856
|
*/
|
|
@@ -15868,10 +15882,10 @@ export declare interface IThemeAnalyticalDesignerTitle {
|
|
|
15868
15882
|
}
|
|
15869
15883
|
|
|
15870
15884
|
/**
|
|
15871
|
-
* Externally hosted image the theme offers to
|
|
15885
|
+
* Externally hosted image the theme offers to documents.
|
|
15872
15886
|
*
|
|
15873
15887
|
* @remarks
|
|
15874
|
-
* The `id` is also the
|
|
15888
|
+
* The `id` is also the document variable the asset resolves: document content references it as `{id}`.
|
|
15875
15889
|
* It must match `^[a-zA-Z][a-zA-Z0-9_]*$`.
|
|
15876
15890
|
*
|
|
15877
15891
|
* @alpha
|
|
@@ -16705,31 +16719,31 @@ export declare interface IThemePalette {
|
|
|
16705
16719
|
}
|
|
16706
16720
|
|
|
16707
16721
|
/**
|
|
16708
|
-
*
|
|
16722
|
+
* Publisher-specific theme properties.
|
|
16709
16723
|
*
|
|
16710
16724
|
* @remarks
|
|
16711
|
-
* Consumed by the
|
|
16725
|
+
* Consumed by the publisher application only; the properties are not part of the shared theming
|
|
16712
16726
|
* CSS variable specification.
|
|
16713
16727
|
*
|
|
16714
16728
|
* @alpha
|
|
16715
16729
|
*/
|
|
16716
|
-
export declare interface
|
|
16730
|
+
export declare interface IThemePublisher {
|
|
16717
16731
|
/**
|
|
16718
|
-
* Colors of visualizations in
|
|
16719
|
-
* object. When absent,
|
|
16732
|
+
* Colors of visualizations in documents: stated inline, or a reference to a color palette
|
|
16733
|
+
* object. When absent, documents use the workspace's active color palette.
|
|
16720
16734
|
*/
|
|
16721
16735
|
visualizationPalette?: ThemeColor[] | IThemeColorPaletteRef;
|
|
16722
|
-
page?:
|
|
16723
|
-
colors?:
|
|
16724
|
-
textStyle?:
|
|
16736
|
+
page?: IThemePublisherPage;
|
|
16737
|
+
colors?: IThemePublisherColors;
|
|
16738
|
+
textStyle?: IThemePublisherTextStyle;
|
|
16725
16739
|
}
|
|
16726
16740
|
|
|
16727
16741
|
/**
|
|
16728
|
-
* Colors offered to
|
|
16742
|
+
* Colors offered to document authors as swatches. Each list is exposed as indexed CSS variables.
|
|
16729
16743
|
*
|
|
16730
16744
|
* @alpha
|
|
16731
16745
|
*/
|
|
16732
|
-
export declare interface
|
|
16746
|
+
export declare interface IThemePublisherColors {
|
|
16733
16747
|
/**
|
|
16734
16748
|
* Offered for element backgrounds.
|
|
16735
16749
|
*/
|
|
@@ -16741,13 +16755,13 @@ export declare interface IThemeReportsColors {
|
|
|
16741
16755
|
}
|
|
16742
16756
|
|
|
16743
16757
|
/**
|
|
16744
|
-
* One hosted font file registered as a font face for rendered
|
|
16758
|
+
* One hosted font file registered as a font face for rendered documents.
|
|
16745
16759
|
*
|
|
16746
16760
|
* @alpha
|
|
16747
16761
|
*/
|
|
16748
|
-
export declare interface
|
|
16762
|
+
export declare interface IThemePublisherFontFace {
|
|
16749
16763
|
/**
|
|
16750
|
-
* Font family name the face registers; referenced from {@link
|
|
16764
|
+
* Font family name the face registers; referenced from {@link IThemePublisherTypography.fontFamily}.
|
|
16751
16765
|
*/
|
|
16752
16766
|
family: string;
|
|
16753
16767
|
/**
|
|
@@ -16766,42 +16780,42 @@ export declare interface IThemeReportsFontFace {
|
|
|
16766
16780
|
|
|
16767
16781
|
/**
|
|
16768
16782
|
* Heading levels. Each level takes what it does not state from here, then from
|
|
16769
|
-
* {@link
|
|
16783
|
+
* {@link IThemePublisherTextStyle}.
|
|
16770
16784
|
*
|
|
16771
16785
|
* @alpha
|
|
16772
16786
|
*/
|
|
16773
|
-
export declare interface
|
|
16787
|
+
export declare interface IThemePublisherHeading {
|
|
16774
16788
|
color?: ThemeColor;
|
|
16775
|
-
lineHeight?:
|
|
16776
|
-
h1?:
|
|
16777
|
-
h2?:
|
|
16778
|
-
h3?:
|
|
16779
|
-
h4?:
|
|
16780
|
-
h5?:
|
|
16781
|
-
h6?:
|
|
16789
|
+
lineHeight?: ThemePublisherLength;
|
|
16790
|
+
h1?: IThemePublisherTextLevel;
|
|
16791
|
+
h2?: IThemePublisherTextLevel;
|
|
16792
|
+
h3?: IThemePublisherTextLevel;
|
|
16793
|
+
h4?: IThemePublisherTextLevel;
|
|
16794
|
+
h5?: IThemePublisherTextLevel;
|
|
16795
|
+
h6?: IThemePublisherTextLevel;
|
|
16782
16796
|
}
|
|
16783
16797
|
|
|
16784
16798
|
/**
|
|
16785
|
-
*
|
|
16799
|
+
* Document page properties.
|
|
16786
16800
|
*
|
|
16787
16801
|
* @alpha
|
|
16788
16802
|
*/
|
|
16789
|
-
export declare interface
|
|
16803
|
+
export declare interface IThemePublisherPage {
|
|
16790
16804
|
backgroundColor?: ThemeColor;
|
|
16791
16805
|
}
|
|
16792
16806
|
|
|
16793
16807
|
/**
|
|
16794
16808
|
* Paragraph levels. Each level takes what it does not state from here, then from
|
|
16795
|
-
* {@link
|
|
16809
|
+
* {@link IThemePublisherTextStyle}.
|
|
16796
16810
|
*
|
|
16797
16811
|
* @alpha
|
|
16798
16812
|
*/
|
|
16799
|
-
export declare interface
|
|
16813
|
+
export declare interface IThemePublisherParagraph {
|
|
16800
16814
|
color?: ThemeColor;
|
|
16801
|
-
lineHeight?:
|
|
16802
|
-
largeText?:
|
|
16803
|
-
normalText?:
|
|
16804
|
-
smallText?:
|
|
16815
|
+
lineHeight?: ThemePublisherLength;
|
|
16816
|
+
largeText?: IThemePublisherTextLevel;
|
|
16817
|
+
normalText?: IThemePublisherTextLevel;
|
|
16818
|
+
smallText?: IThemePublisherTextLevel;
|
|
16805
16819
|
}
|
|
16806
16820
|
|
|
16807
16821
|
/**
|
|
@@ -16809,9 +16823,9 @@ export declare interface IThemeReportsParagraph {
|
|
|
16809
16823
|
*
|
|
16810
16824
|
* @alpha
|
|
16811
16825
|
*/
|
|
16812
|
-
export declare interface
|
|
16813
|
-
fontSize?:
|
|
16814
|
-
lineHeight?:
|
|
16826
|
+
export declare interface IThemePublisherTextLevel {
|
|
16827
|
+
fontSize?: ThemePublisherLength;
|
|
16828
|
+
lineHeight?: ThemePublisherLength;
|
|
16815
16829
|
/**
|
|
16816
16830
|
* Overrides the color of the level's group.
|
|
16817
16831
|
*/
|
|
@@ -16819,29 +16833,29 @@ export declare interface IThemeReportsTextLevel {
|
|
|
16819
16833
|
}
|
|
16820
16834
|
|
|
16821
16835
|
/**
|
|
16822
|
-
* Text of rendered
|
|
16836
|
+
* Text of rendered documents.
|
|
16823
16837
|
*
|
|
16824
16838
|
* @alpha
|
|
16825
16839
|
*/
|
|
16826
|
-
export declare interface
|
|
16840
|
+
export declare interface IThemePublisherTextStyle {
|
|
16827
16841
|
color?: ThemeColor;
|
|
16828
|
-
lineHeight?:
|
|
16829
|
-
typography?:
|
|
16830
|
-
heading?:
|
|
16831
|
-
paragraph?:
|
|
16842
|
+
lineHeight?: ThemePublisherLength;
|
|
16843
|
+
typography?: IThemePublisherTypography;
|
|
16844
|
+
heading?: IThemePublisherHeading;
|
|
16845
|
+
paragraph?: IThemePublisherParagraph;
|
|
16832
16846
|
}
|
|
16833
16847
|
|
|
16834
16848
|
/**
|
|
16835
|
-
* Typography of rendered
|
|
16849
|
+
* Typography of rendered documents.
|
|
16836
16850
|
*
|
|
16837
16851
|
* @alpha
|
|
16838
16852
|
*/
|
|
16839
|
-
export declare interface
|
|
16853
|
+
export declare interface IThemePublisherTypography {
|
|
16840
16854
|
/**
|
|
16841
|
-
* CSS font-family stack applied to rendered
|
|
16855
|
+
* CSS font-family stack applied to rendered documents.
|
|
16842
16856
|
*/
|
|
16843
16857
|
fontFamily?: string;
|
|
16844
|
-
fonts?:
|
|
16858
|
+
fonts?: IThemePublisherFontFace[];
|
|
16845
16859
|
}
|
|
16846
16860
|
|
|
16847
16861
|
/**
|
|
@@ -16932,6 +16946,18 @@ export declare interface IThemeToastMessageVariant extends IThemeMessageVariant
|
|
|
16932
16946
|
separatorLineColor?: ThemeColor;
|
|
16933
16947
|
}
|
|
16934
16948
|
|
|
16949
|
+
/**
|
|
16950
|
+
* Toolbar customizable UI properties
|
|
16951
|
+
*
|
|
16952
|
+
* @alpha
|
|
16953
|
+
*/
|
|
16954
|
+
export declare interface IThemeToolbar {
|
|
16955
|
+
/**
|
|
16956
|
+
* Radius of the toolbar container border in px. Controls inside the toolbar keep their own radius.
|
|
16957
|
+
*/
|
|
16958
|
+
borderRadius?: string;
|
|
16959
|
+
}
|
|
16960
|
+
|
|
16935
16961
|
/**
|
|
16936
16962
|
* Tooltip customizable UI properties
|
|
16937
16963
|
*
|
|
@@ -18782,16 +18808,16 @@ export declare function newAbsoluteDashboardDateFilter(from: DateString, to: Dat
|
|
|
18782
18808
|
export declare function newAbsoluteDateFilter(dateDataSet: ObjRef | Identifier, from: string, to: string, localIdentifier?: string, emptyValueHandling?: EmptyValues): IAbsoluteDateFilter;
|
|
18783
18809
|
|
|
18784
18810
|
/**
|
|
18785
|
-
* Creates an ad-hoc
|
|
18811
|
+
* Creates an ad-hoc document definition not based on any template.
|
|
18786
18812
|
*
|
|
18787
18813
|
* @alpha
|
|
18788
18814
|
*/
|
|
18789
|
-
export declare function
|
|
18815
|
+
export declare function newAdHocPublisherDocumentDefinition(options: {
|
|
18790
18816
|
title: string;
|
|
18791
|
-
periodStart:
|
|
18792
|
-
periodEnd:
|
|
18793
|
-
pages?:
|
|
18794
|
-
}, modifications?: Partial<Omit<
|
|
18817
|
+
periodStart: PublisherDateString;
|
|
18818
|
+
periodEnd: PublisherDateString;
|
|
18819
|
+
pages?: IPublisherDocumentPage[];
|
|
18820
|
+
}, modifications?: Partial<Omit<IPublisherDocumentDefinition, "type" | "title" | "periodStart" | "periodEnd" | "content">>): IPublisherDocumentDefinition;
|
|
18795
18821
|
|
|
18796
18822
|
/**
|
|
18797
18823
|
* Creates a new all time date filter. This filter is used to indicate that there should be no filtering on the dates.
|
|
@@ -19131,6 +19157,54 @@ export declare function newPositiveAttributeFilter(attributeOrRef: IAttribute |
|
|
|
19131
19157
|
*/
|
|
19132
19158
|
export declare function newPreviousPeriodMeasure(measureIdOrLocalId: MeasureOrLocalId, dateDataSets: IPreviousPeriodDateDataSetSimple[], modifications?: MeasureModifications<PreviousPeriodMeasureBuilder>): IMeasure<IPreviousPeriodMeasureDefinition>;
|
|
19133
19159
|
|
|
19160
|
+
/**
|
|
19161
|
+
* Creates document content from page instances.
|
|
19162
|
+
*
|
|
19163
|
+
* @alpha
|
|
19164
|
+
*/
|
|
19165
|
+
export declare function newPublisherDocumentContent(pages: IPublisherDocumentPage[], modifications?: Partial<Omit<IPublisherDocumentContent, "version" | "pages">>): IPublisherDocumentContent;
|
|
19166
|
+
|
|
19167
|
+
/**
|
|
19168
|
+
* Creates a document definition from a template.
|
|
19169
|
+
*
|
|
19170
|
+
* @remarks
|
|
19171
|
+
* The template content is deep-copied; no reference to the template is kept, so the
|
|
19172
|
+
* document stays frozen while the template evolves.
|
|
19173
|
+
*
|
|
19174
|
+
* @alpha
|
|
19175
|
+
*/
|
|
19176
|
+
export declare function newPublisherDocumentDefinitionFromTemplate(template: IPublisherDocumentTemplate | IPublisherDocumentTemplateDefinition, options: {
|
|
19177
|
+
title: string;
|
|
19178
|
+
periodStart: PublisherDateString;
|
|
19179
|
+
periodEnd: PublisherDateString;
|
|
19180
|
+
}, modifications?: Partial<Omit<IPublisherDocumentDefinition, "type" | "title" | "periodStart" | "periodEnd" | "content">>): IPublisherDocumentDefinition;
|
|
19181
|
+
|
|
19182
|
+
/**
|
|
19183
|
+
* Clones a page layout into a page instance embeddable in template/document content.
|
|
19184
|
+
*
|
|
19185
|
+
* @remarks
|
|
19186
|
+
* The body is deep-copied and detached from the source page — no reference is kept.
|
|
19187
|
+
* Slot localIdentifiers (and the layout slotIds pointing at them) are prefixed with the
|
|
19188
|
+
* page-instance localIdentifier, so one page used repeatedly in the same content stays unique.
|
|
19189
|
+
*
|
|
19190
|
+
* @alpha
|
|
19191
|
+
*/
|
|
19192
|
+
export declare function newPublisherDocumentPageFromLayout(page: IPublisherPageLayout | IPublisherPageLayoutDefinition, localIdentifier?: string): IPublisherDocumentPage;
|
|
19193
|
+
|
|
19194
|
+
/**
|
|
19195
|
+
* Creates a new document template definition.
|
|
19196
|
+
*
|
|
19197
|
+
* @alpha
|
|
19198
|
+
*/
|
|
19199
|
+
export declare function newPublisherDocumentTemplateDefinition(title: string, content: IPublisherDocumentContent, modifications?: Partial<Omit<IPublisherDocumentTemplateDefinition, "type" | "title" | "content">>): IPublisherDocumentTemplateDefinition;
|
|
19200
|
+
|
|
19201
|
+
/**
|
|
19202
|
+
* Creates a new page layout definition.
|
|
19203
|
+
*
|
|
19204
|
+
* @alpha
|
|
19205
|
+
*/
|
|
19206
|
+
export declare function newPublisherPageLayoutDefinition(title: string, body: IPublisherPageBody, modifications?: Partial<Omit<IPublisherPageLayoutDefinition, "type" | "title" | "content">>): IPublisherPageLayoutDefinition;
|
|
19207
|
+
|
|
19134
19208
|
/**
|
|
19135
19209
|
* Creates a new ranking filter.
|
|
19136
19210
|
*
|
|
@@ -19183,54 +19257,6 @@ export declare function newRelativeDashboardDateFilter(granularity: DateFilterGr
|
|
|
19183
19257
|
*/
|
|
19184
19258
|
export declare function newRelativeDateFilter(dateDataSet: ObjRef | Identifier, granularity: DateAttributeGranularity, from: number, to: number, localIdentifier?: string, boundedFilter?: IUpperBoundedFilter | ILowerBoundedFilter, emptyValueHandling?: EmptyValues): IRelativeDateFilter;
|
|
19185
19259
|
|
|
19186
|
-
/**
|
|
19187
|
-
* Creates report content from page instances.
|
|
19188
|
-
*
|
|
19189
|
-
* @alpha
|
|
19190
|
-
*/
|
|
19191
|
-
export declare function newReportContent(pages: IReportContentPage[], modifications?: Partial<Omit<IReportContent, "version" | "pages">>): IReportContent;
|
|
19192
|
-
|
|
19193
|
-
/**
|
|
19194
|
-
* Clones a report page into a page instance embeddable in template/report content.
|
|
19195
|
-
*
|
|
19196
|
-
* @remarks
|
|
19197
|
-
* The body is deep-copied and detached from the source page — no reference is kept.
|
|
19198
|
-
* Slot localIdentifiers (and the layout slotIds pointing at them) are prefixed with the
|
|
19199
|
-
* page-instance localIdentifier, so one page used repeatedly in the same content stays unique.
|
|
19200
|
-
*
|
|
19201
|
-
* @alpha
|
|
19202
|
-
*/
|
|
19203
|
-
export declare function newReportContentPageFromLayout(page: IReportPageLayout | IReportPageLayoutDefinition, localIdentifier?: string): IReportContentPage;
|
|
19204
|
-
|
|
19205
|
-
/**
|
|
19206
|
-
* Creates a report definition from a template.
|
|
19207
|
-
*
|
|
19208
|
-
* @remarks
|
|
19209
|
-
* The template content is deep-copied; no reference to the template is kept, so the
|
|
19210
|
-
* report stays frozen while the template evolves.
|
|
19211
|
-
*
|
|
19212
|
-
* @alpha
|
|
19213
|
-
*/
|
|
19214
|
-
export declare function newReportDefinitionFromTemplate(template: IReportTemplate | IReportTemplateDefinition, options: {
|
|
19215
|
-
title: string;
|
|
19216
|
-
periodStart: ReportDateString;
|
|
19217
|
-
periodEnd: ReportDateString;
|
|
19218
|
-
}, modifications?: Partial<Omit<IReportDefinition, "type" | "title" | "periodStart" | "periodEnd" | "content">>): IReportDefinition;
|
|
19219
|
-
|
|
19220
|
-
/**
|
|
19221
|
-
* Creates a new report page definition.
|
|
19222
|
-
*
|
|
19223
|
-
* @alpha
|
|
19224
|
-
*/
|
|
19225
|
-
export declare function newReportPageLayoutDefinition(title: string, body: IReportPageBody, modifications?: Partial<Omit<IReportPageLayoutDefinition, "type" | "title" | "content">>): IReportPageLayoutDefinition;
|
|
19226
|
-
|
|
19227
|
-
/**
|
|
19228
|
-
* Creates a new report template definition.
|
|
19229
|
-
*
|
|
19230
|
-
* @alpha
|
|
19231
|
-
*/
|
|
19232
|
-
export declare function newReportTemplateDefinition(title: string, content: IReportContent, modifications?: Partial<Omit<IReportTemplateDefinition, "type" | "title" | "content">>): IReportTemplateDefinition;
|
|
19233
|
-
|
|
19234
19260
|
/**
|
|
19235
19261
|
* Creates a new total.
|
|
19236
19262
|
*
|
|
@@ -19598,93 +19624,51 @@ export declare type PreviousPeriodMeasureBuilderInput = {
|
|
|
19598
19624
|
dateDataSets: IPreviousPeriodDateDataSetSimple[];
|
|
19599
19625
|
} | IMeasure<IPreviousPeriodMeasureDefinition>;
|
|
19600
19626
|
|
|
19601
|
-
/**
|
|
19602
|
-
* @public
|
|
19603
|
-
*/
|
|
19604
|
-
export declare type RangeConditionOperator = "BETWEEN" | "NOT_BETWEEN";
|
|
19605
|
-
|
|
19606
|
-
/**
|
|
19607
|
-
* @public
|
|
19608
|
-
*/
|
|
19609
|
-
export declare type RankingFilterOperator = "TOP" | "BOTTOM";
|
|
19610
|
-
|
|
19611
|
-
/**
|
|
19612
|
-
* Relative granularity offset
|
|
19613
|
-
* (e.g. "GDC.time.year" granularity with offset -2 means "the previous 2 years")
|
|
19614
|
-
* @alpha
|
|
19615
|
-
*/
|
|
19616
|
-
export declare type RelativeDateFilterGranularityOffset = number;
|
|
19617
|
-
|
|
19618
|
-
/**
|
|
19619
|
-
* Gets effective values of a relative date filter.
|
|
19620
|
-
*
|
|
19621
|
-
* @param filter - date filter to work with
|
|
19622
|
-
* @param includeDataSet - whether to include data set in the returned values
|
|
19623
|
-
* @returns filter values
|
|
19624
|
-
* @public
|
|
19625
|
-
*/
|
|
19626
|
-
export declare function relativeDateFilterValues(filter: IRelativeDateFilter, includeDataSet?: boolean): IRelativeDateFilterValues;
|
|
19627
|
-
|
|
19628
|
-
/**
|
|
19629
|
-
* Remote pluggable application registry item.
|
|
19630
|
-
* Loaded via Module Federation.
|
|
19631
|
-
*
|
|
19632
|
-
* @alpha
|
|
19633
|
-
*/
|
|
19634
|
-
export declare type RemotePluggableApplicationRegistryItem = IRemotePluggableApplicationRegistryItemV1;
|
|
19635
|
-
|
|
19636
|
-
/**
|
|
19637
|
-
* Pluggable application remote registry
|
|
19638
|
-
*
|
|
19639
|
-
* @alpha
|
|
19640
|
-
*/
|
|
19641
|
-
export declare type RemotePluggableApplicationsRegistry = IRemotePluggableApplicationsRegistryV1;
|
|
19642
|
-
|
|
19643
19627
|
/**
|
|
19644
19628
|
* What a section or page paints behind its content.
|
|
19645
19629
|
*
|
|
19646
19630
|
* @alpha
|
|
19647
19631
|
*/
|
|
19648
|
-
export declare type
|
|
19632
|
+
export declare type PublisherBackground = IPublisherColorBackground | IPublisherImageBackground;
|
|
19649
19633
|
|
|
19650
19634
|
/**
|
|
19651
19635
|
* Variables resolved by the rendering runtime; they are never declared or stored.
|
|
19652
19636
|
*
|
|
19653
19637
|
* @remarks
|
|
19654
|
-
* Referenced from
|
|
19638
|
+
* Referenced from document text as `{name}`. Custom variable names must not collide with these;
|
|
19655
19639
|
* on collision the built-in wins.
|
|
19656
19640
|
*
|
|
19657
19641
|
* @alpha
|
|
19658
19642
|
*/
|
|
19659
|
-
export declare type
|
|
19643
|
+
export declare type PublisherBuiltInVariable = "reportName" | "reportDescription" | "periodStart" | "periodEnd" | "reportDateRange" | "reportAttributeFilters" | "exportedAt" | "exportedBy" | "lastModifiedAt" | "lastModifiedBy" | "workspaceName" | "workspaceId" | "totalPages" | "currentPageNumber" | "logo";
|
|
19660
19644
|
|
|
19661
19645
|
/**
|
|
19662
|
-
* All built-in
|
|
19646
|
+
* All built-in document variable names.
|
|
19663
19647
|
*
|
|
19664
19648
|
* @alpha
|
|
19665
19649
|
*/
|
|
19666
|
-
export declare const
|
|
19650
|
+
export declare const PublisherBuiltInVariables: PublisherBuiltInVariable[];
|
|
19667
19651
|
|
|
19668
19652
|
/**
|
|
19669
19653
|
* Where content sits inside the box that carries it, along one axis.
|
|
19670
19654
|
*
|
|
19671
19655
|
* @alpha
|
|
19672
19656
|
*/
|
|
19673
|
-
export declare type
|
|
19657
|
+
export declare type PublisherContentAlignment = "start" | "center" | "end";
|
|
19674
19658
|
|
|
19675
19659
|
/**
|
|
19676
|
-
*
|
|
19660
|
+
* ISO 8601 calendar date (YYYY-MM-DD).
|
|
19677
19661
|
*
|
|
19678
19662
|
* @alpha
|
|
19679
19663
|
*/
|
|
19680
|
-
export declare
|
|
19664
|
+
export declare type PublisherDateString = string;
|
|
19681
19665
|
|
|
19682
19666
|
/**
|
|
19683
|
-
*
|
|
19667
|
+
* Convenience accessor for a document or template page by its localIdentifier.
|
|
19684
19668
|
*
|
|
19685
19669
|
* @alpha
|
|
19686
19670
|
*/
|
|
19687
|
-
export declare
|
|
19671
|
+
export declare function publisherDocumentPage(documentOrTemplate: IPublisherDocument | IPublisherDocumentDefinition | IPublisherDocumentTemplate | IPublisherDocumentTemplateDefinition, pageLocalIdentifier: string): IPublisherDocumentPage | undefined;
|
|
19688
19672
|
|
|
19689
19673
|
/**
|
|
19690
19674
|
* Size a heading is rendered at. Each size is styled by the matching theme text level
|
|
@@ -19692,14 +19676,14 @@ export declare type ReportDateString = string;
|
|
|
19692
19676
|
*
|
|
19693
19677
|
* @alpha
|
|
19694
19678
|
*/
|
|
19695
|
-
export declare type
|
|
19679
|
+
export declare type PublisherHeadingType = "h1" | "h2" | "h3" | "h4" | "h5" | "h6";
|
|
19696
19680
|
|
|
19697
19681
|
/**
|
|
19698
19682
|
* All heading sizes, largest first.
|
|
19699
19683
|
*
|
|
19700
19684
|
* @alpha
|
|
19701
19685
|
*/
|
|
19702
|
-
export declare const
|
|
19686
|
+
export declare const PublisherHeadingTypes: PublisherHeadingType[];
|
|
19703
19687
|
|
|
19704
19688
|
/**
|
|
19705
19689
|
* How an image is fitted to the area it is drawn in: kept whole inside it, filling it and cropped to
|
|
@@ -19707,14 +19691,14 @@ export declare const ReportHeadingTypes: ReportHeadingType[];
|
|
|
19707
19691
|
*
|
|
19708
19692
|
* @alpha
|
|
19709
19693
|
*/
|
|
19710
|
-
export declare type
|
|
19694
|
+
export declare type PublisherImageFit = "contain" | "cover" | "fill";
|
|
19711
19695
|
|
|
19712
19696
|
/**
|
|
19713
19697
|
* What an image slot displays.
|
|
19714
19698
|
*
|
|
19715
19699
|
* @alpha
|
|
19716
19700
|
*/
|
|
19717
|
-
export declare type
|
|
19701
|
+
export declare type PublisherImageSource = {
|
|
19718
19702
|
type: "url";
|
|
19719
19703
|
/**
|
|
19720
19704
|
* Image URL. Supports `{variables}` — a logo slot uses `{logo}`.
|
|
@@ -19729,40 +19713,40 @@ export declare type ReportImageSource = {
|
|
|
19729
19713
|
};
|
|
19730
19714
|
|
|
19731
19715
|
/**
|
|
19732
|
-
* Page shape a
|
|
19716
|
+
* Page shape a page layout is designed for.
|
|
19733
19717
|
*
|
|
19734
19718
|
* @remarks
|
|
19735
19719
|
* A layout's geometry only reads correctly at the proportions it was authored for: a row of three
|
|
19736
|
-
* visualizations that works on a widescreen
|
|
19720
|
+
* visualizations that works on a widescreen page is unusably narrow on an upright page. The format
|
|
19737
19721
|
* is therefore a property of the page, not a choice made when rendering it.
|
|
19738
19722
|
*
|
|
19739
19723
|
* @alpha
|
|
19740
19724
|
*/
|
|
19741
|
-
export declare type
|
|
19725
|
+
export declare type PublisherPageFormat = "widescreen" | "a4Portrait" | "letterPortrait";
|
|
19742
19726
|
|
|
19743
19727
|
/**
|
|
19744
|
-
* Width divided by height for each page format: 16:9 for a
|
|
19728
|
+
* Width divided by height for each page format: 16:9 for a widescreen page, ISO A4 (210 x 297 mm) and
|
|
19745
19729
|
* US Letter (8.5 x 11 in) upright.
|
|
19746
19730
|
*
|
|
19747
19731
|
* @alpha
|
|
19748
19732
|
*/
|
|
19749
|
-
export declare const
|
|
19733
|
+
export declare const PublisherPageFormatAspectRatios: Record<PublisherPageFormat, number>;
|
|
19750
19734
|
|
|
19751
19735
|
/**
|
|
19752
|
-
* List of built-in
|
|
19736
|
+
* List of built-in page format names.
|
|
19753
19737
|
*
|
|
19754
19738
|
* @alpha
|
|
19755
19739
|
*/
|
|
19756
|
-
export declare const
|
|
19740
|
+
export declare const PublisherPageFormats: PublisherPageFormat[];
|
|
19757
19741
|
|
|
19758
19742
|
/**
|
|
19759
|
-
* Node of a
|
|
19743
|
+
* Node of a page layout: a recursive row/column split tree (flexbox semantics)
|
|
19760
19744
|
* over a fixed page. Leaves assign their area to slots; the tree carries geometry and
|
|
19761
|
-
* box paint, slot content lives in {@link
|
|
19745
|
+
* box paint, slot content lives in {@link IPublisherPageBody.slots}.
|
|
19762
19746
|
*
|
|
19763
19747
|
* @alpha
|
|
19764
19748
|
*/
|
|
19765
|
-
export declare type
|
|
19749
|
+
export declare type PublisherPageLayoutNode = IPublisherLayoutSection | IPublisherLayoutSlotRef;
|
|
19766
19750
|
|
|
19767
19751
|
/**
|
|
19768
19752
|
* Size a paragraph is rendered at. Each size is styled by the matching theme text level
|
|
@@ -19770,28 +19754,28 @@ export declare type ReportPageLayoutNode = IReportLayoutSection | IReportLayoutS
|
|
|
19770
19754
|
*
|
|
19771
19755
|
* @alpha
|
|
19772
19756
|
*/
|
|
19773
|
-
export declare type
|
|
19757
|
+
export declare type PublisherParagraphType = "largeText" | "normalText" | "smallText";
|
|
19774
19758
|
|
|
19775
19759
|
/**
|
|
19776
19760
|
* All paragraph sizes, largest first.
|
|
19777
19761
|
*
|
|
19778
19762
|
* @alpha
|
|
19779
19763
|
*/
|
|
19780
|
-
export declare const
|
|
19764
|
+
export declare const PublisherParagraphTypes: PublisherParagraphType[];
|
|
19781
19765
|
|
|
19782
19766
|
/**
|
|
19783
|
-
* All slot types of
|
|
19767
|
+
* All slot types of document content version 1.
|
|
19784
19768
|
*
|
|
19785
19769
|
* @alpha
|
|
19786
19770
|
*/
|
|
19787
|
-
export declare type
|
|
19771
|
+
export declare type PublisherSlot = IPublisherVisualizationSlot | IPublisherTextSlot | IPublisherImageSlot;
|
|
19788
19772
|
|
|
19789
19773
|
/**
|
|
19790
|
-
* The marker referencing the named variable from
|
|
19774
|
+
* The marker referencing the named variable from document text.
|
|
19791
19775
|
*
|
|
19792
19776
|
* @alpha
|
|
19793
19777
|
*/
|
|
19794
|
-
export declare function
|
|
19778
|
+
export declare function publisherTextPlaceholder(name: string): string;
|
|
19795
19779
|
|
|
19796
19780
|
/**
|
|
19797
19781
|
* Size the slot is rendered at.
|
|
@@ -19802,35 +19786,77 @@ export declare function reportTextPlaceholder(name: string): string;
|
|
|
19802
19786
|
*
|
|
19803
19787
|
* @alpha
|
|
19804
19788
|
*/
|
|
19805
|
-
export declare function
|
|
19789
|
+
export declare function publisherTextSlotType(slot: IPublisherTextSlot): PublisherTextType;
|
|
19806
19790
|
|
|
19807
19791
|
/**
|
|
19808
19792
|
* Sizes the slot can be rendered at, which is what its own type decides.
|
|
19809
19793
|
*
|
|
19810
19794
|
* @alpha
|
|
19811
19795
|
*/
|
|
19812
|
-
export declare function
|
|
19796
|
+
export declare function publisherTextSlotTypes(slot: IPublisherTextSlot): PublisherTextType[];
|
|
19813
19797
|
|
|
19814
19798
|
/**
|
|
19815
19799
|
* Where the text of a text slot comes from.
|
|
19816
19800
|
*
|
|
19817
19801
|
* @alpha
|
|
19818
19802
|
*/
|
|
19819
|
-
export declare type
|
|
19803
|
+
export declare type PublisherTextSource = IPublisherStaticTextSource | IPublisherAiTextSource;
|
|
19820
19804
|
|
|
19821
19805
|
/**
|
|
19822
|
-
* Size any
|
|
19806
|
+
* Size any document text is rendered at.
|
|
19823
19807
|
*
|
|
19824
19808
|
* @alpha
|
|
19825
19809
|
*/
|
|
19826
|
-
export declare type
|
|
19810
|
+
export declare type PublisherTextType = PublisherHeadingType | PublisherParagraphType;
|
|
19827
19811
|
|
|
19828
19812
|
/**
|
|
19829
19813
|
* All sizes a text slot can be rendered at, headings first.
|
|
19830
19814
|
*
|
|
19831
19815
|
* @alpha
|
|
19832
19816
|
*/
|
|
19833
|
-
export declare const
|
|
19817
|
+
export declare const PublisherTextTypes: PublisherTextType[];
|
|
19818
|
+
|
|
19819
|
+
/**
|
|
19820
|
+
* @public
|
|
19821
|
+
*/
|
|
19822
|
+
export declare type RangeConditionOperator = "BETWEEN" | "NOT_BETWEEN";
|
|
19823
|
+
|
|
19824
|
+
/**
|
|
19825
|
+
* @public
|
|
19826
|
+
*/
|
|
19827
|
+
export declare type RankingFilterOperator = "TOP" | "BOTTOM";
|
|
19828
|
+
|
|
19829
|
+
/**
|
|
19830
|
+
* Relative granularity offset
|
|
19831
|
+
* (e.g. "GDC.time.year" granularity with offset -2 means "the previous 2 years")
|
|
19832
|
+
* @alpha
|
|
19833
|
+
*/
|
|
19834
|
+
export declare type RelativeDateFilterGranularityOffset = number;
|
|
19835
|
+
|
|
19836
|
+
/**
|
|
19837
|
+
* Gets effective values of a relative date filter.
|
|
19838
|
+
*
|
|
19839
|
+
* @param filter - date filter to work with
|
|
19840
|
+
* @param includeDataSet - whether to include data set in the returned values
|
|
19841
|
+
* @returns filter values
|
|
19842
|
+
* @public
|
|
19843
|
+
*/
|
|
19844
|
+
export declare function relativeDateFilterValues(filter: IRelativeDateFilter, includeDataSet?: boolean): IRelativeDateFilterValues;
|
|
19845
|
+
|
|
19846
|
+
/**
|
|
19847
|
+
* Remote pluggable application registry item.
|
|
19848
|
+
* Loaded via Module Federation.
|
|
19849
|
+
*
|
|
19850
|
+
* @alpha
|
|
19851
|
+
*/
|
|
19852
|
+
export declare type RemotePluggableApplicationRegistryItem = IRemotePluggableApplicationRegistryItemV1;
|
|
19853
|
+
|
|
19854
|
+
/**
|
|
19855
|
+
* Pluggable application remote registry
|
|
19856
|
+
*
|
|
19857
|
+
* @alpha
|
|
19858
|
+
*/
|
|
19859
|
+
export declare type RemotePluggableApplicationsRegistry = IRemotePluggableApplicationsRegistryV1;
|
|
19834
19860
|
|
|
19835
19861
|
/**
|
|
19836
19862
|
* Entitlements and their values that must be set for the pluggable application to be accessible for
|
|
@@ -19872,11 +19898,11 @@ export declare type RequiredWorkspacePermissions = Condition<Partial<IPluggableA
|
|
|
19872
19898
|
*
|
|
19873
19899
|
* @remarks
|
|
19874
19900
|
* A marker resolves wherever it appears, braces around it included, so there is no escape for a
|
|
19875
|
-
* literal `{name}` in
|
|
19901
|
+
* literal `{name}` in document text.
|
|
19876
19902
|
*
|
|
19877
19903
|
* @alpha
|
|
19878
19904
|
*/
|
|
19879
|
-
export declare function
|
|
19905
|
+
export declare function resolvePublisherTextPlaceholders(text: string, values: Record<string, string>): string;
|
|
19880
19906
|
|
|
19881
19907
|
/**
|
|
19882
19908
|
* Resolves a dashboard timezone value to a concrete IANA timezone ID: the {@link BROWSER_DETECTED}
|
|
@@ -20132,10 +20158,10 @@ export declare type ThemeDashboardDensity = "comfortable" | "compact";
|
|
|
20132
20158
|
export declare type ThemeFontUri = string;
|
|
20133
20159
|
|
|
20134
20160
|
/**
|
|
20135
|
-
* Length used in rendered
|
|
20161
|
+
* Length used in rendered documents.
|
|
20136
20162
|
*
|
|
20137
20163
|
* @remarks
|
|
20138
|
-
* A
|
|
20164
|
+
* A document page scales with its width, so lengths are stated in `cqw` (1cqw = 1% of the page
|
|
20139
20165
|
* width). A bare number means cqw: `3.5` and `"3.5cqw"` are the same length. `cqi`, `em` and `%`
|
|
20140
20166
|
* are accepted as well. Anything that does not follow the page width is ignored: `px` and `rem`
|
|
20141
20167
|
* hold their size, and `cqh` and `cqb` resolve against the viewport, because a page contains its
|
|
@@ -20146,7 +20172,7 @@ export declare type ThemeFontUri = string;
|
|
|
20146
20172
|
*
|
|
20147
20173
|
* @alpha
|
|
20148
20174
|
*/
|
|
20149
|
-
export declare type
|
|
20175
|
+
export declare type ThemePublisherLength = string | number;
|
|
20150
20176
|
|
|
20151
20177
|
/**
|
|
20152
20178
|
* Throwing exhaustiveness check for discriminated unions: the `never` parameter fails the build on an
|
|
@@ -20277,7 +20303,7 @@ export declare function userFullName(user: IUser): string | undefined;
|
|
|
20277
20303
|
*
|
|
20278
20304
|
* @alpha
|
|
20279
20305
|
*/
|
|
20280
|
-
export declare function
|
|
20306
|
+
export declare function validatePublisherPageBody(body: IPublisherPageBody): IPublisherPageBodyValidationIssue[];
|
|
20281
20307
|
|
|
20282
20308
|
/**
|
|
20283
20309
|
* Builder for virtual arithmetic measures.
|