@gooddata/sdk-model 11.62.0-alpha.2 → 11.62.0-alpha.4
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/dashboard/filterContext.d.ts +1 -1
- package/esm/dashboard/filterContext.d.ts.map +1 -1
- package/esm/dashboard/filterContext.js +2 -2
- package/esm/dashboard/filterConverters.d.ts.map +1 -1
- package/esm/dashboard/filterConverters.js +10 -2
- package/esm/execution/filter/factory.d.ts +35 -0
- package/esm/execution/filter/factory.d.ts.map +1 -1
- package/esm/execution/filter/factory.js +5 -11
- package/esm/execution/filter/index.d.ts +13 -0
- package/esm/execution/filter/index.d.ts.map +1 -1
- package/esm/execution/filter/index.js +2 -0
- package/esm/execution/objectFactoryNotation/index.d.ts.map +1 -1
- package/esm/execution/objectFactoryNotation/index.js +16 -5
- package/esm/genAI/chat.d.ts +3 -2
- package/esm/genAI/chat.d.ts.map +1 -1
- package/esm/index.d.ts +23 -12
- package/esm/index.d.ts.map +1 -1
- package/esm/index.js +20 -10
- package/esm/publisher/aliases.d.ts +580 -0
- package/esm/publisher/aliases.d.ts.map +1 -0
- package/esm/publisher/aliases.js +304 -0
- package/esm/publisher/v1/builtinPageLayouts.d.ts +45 -0
- package/esm/publisher/v1/builtinPageLayouts.d.ts.map +1 -0
- package/esm/publisher/{builtinPageLayouts.js → v1/builtinPageLayouts.js} +14 -14
- package/esm/publisher/{content.d.ts → v1/content.d.ts} +14 -14
- package/esm/publisher/v1/content.d.ts.map +1 -0
- package/esm/publisher/{content.js → v1/content.js} +1 -1
- package/esm/publisher/{document.d.ts → v1/document.d.ts} +21 -21
- package/esm/publisher/v1/document.d.ts.map +1 -0
- package/esm/publisher/v1/document.js +35 -0
- package/esm/publisher/v1/factory.d.ts +65 -0
- package/esm/publisher/v1/factory.d.ts.map +1 -0
- package/esm/publisher/{factory.js → v1/factory.js} +12 -12
- package/esm/publisher/{layout.d.ts → v1/layout.d.ts} +13 -13
- package/esm/publisher/v1/layout.d.ts.map +1 -0
- package/esm/publisher/{layout.js → v1/layout.js} +4 -4
- package/esm/publisher/{pageFormat.d.ts → v1/pageFormat.d.ts} +6 -6
- package/esm/publisher/v1/pageFormat.d.ts.map +1 -0
- package/esm/publisher/{pageFormat.js → v1/pageFormat.js} +6 -6
- package/esm/publisher/{pageLayout.d.ts → v1/pageLayout.d.ts} +27 -27
- package/esm/publisher/v1/pageLayout.d.ts.map +1 -0
- package/esm/publisher/{pageLayout.js → v1/pageLayout.js} +18 -18
- package/esm/publisher/{slot.d.ts → v1/slot.d.ts} +41 -41
- package/esm/publisher/v1/slot.d.ts.map +1 -0
- package/esm/publisher/v1/slot.js +90 -0
- package/esm/publisher/{styling.d.ts → v1/styling.d.ts} +36 -36
- package/esm/publisher/v1/styling.d.ts.map +1 -0
- package/esm/publisher/{styling.js → v1/styling.js} +14 -14
- package/esm/publisher/{variables.d.ts → v1/variables.d.ts} +10 -10
- package/esm/publisher/v1/variables.d.ts.map +1 -0
- package/esm/publisher/{variables.js → v1/variables.js} +4 -4
- package/esm/publisher/v2/checks.d.ts +58 -0
- package/esm/publisher/v2/checks.d.ts.map +1 -0
- package/esm/publisher/v2/checks.js +100 -0
- package/esm/publisher/v2/content.d.ts +154 -0
- package/esm/publisher/v2/content.d.ts.map +1 -0
- package/esm/publisher/v2/content.js +34 -0
- package/esm/publisher/v2/document.d.ts +116 -0
- package/esm/publisher/v2/document.d.ts.map +1 -0
- package/esm/publisher/v2/document.js +47 -0
- package/esm/publisher/v2/factory.d.ts +69 -0
- package/esm/publisher/v2/factory.d.ts.map +1 -0
- package/esm/publisher/v2/factory.js +80 -0
- package/esm/publisher/v2/layout.d.ts +48 -0
- package/esm/publisher/v2/layout.d.ts.map +1 -0
- package/esm/publisher/v2/layout.js +20 -0
- package/esm/publisher/v2/page.d.ts +67 -0
- package/esm/publisher/v2/page.d.ts.map +1 -0
- package/esm/publisher/v2/page.js +34 -0
- package/esm/publisher/v2/sections.d.ts +34 -0
- package/esm/publisher/v2/sections.d.ts.map +1 -0
- package/esm/publisher/v2/sections.js +40 -0
- package/esm/publisher/v2/structure.d.ts +5 -0
- package/esm/publisher/v2/structure.d.ts.map +1 -0
- package/esm/publisher/v2/structure.js +533 -0
- package/esm/publisher/v2/style.d.ts +323 -0
- package/esm/publisher/v2/style.d.ts.map +1 -0
- package/esm/publisher/v2/style.js +22 -0
- package/esm/publisher/v2/validation.d.ts +26 -0
- package/esm/publisher/v2/validation.d.ts.map +1 -0
- package/esm/publisher/v2/validation.js +157 -0
- package/esm/publisher/v2/widget.d.ts +295 -0
- package/esm/publisher/v2/widget.d.ts.map +1 -0
- package/esm/publisher/v2/widget.js +79 -0
- package/esm/sdk-model.d.ts +2426 -453
- package/esm/settings/settings.d.ts +31 -1
- package/esm/settings/settings.d.ts.map +1 -1
- package/package.json +4 -4
- package/esm/publisher/builtinPageLayouts.d.ts +0 -45
- package/esm/publisher/builtinPageLayouts.d.ts.map +0 -1
- package/esm/publisher/content.d.ts.map +0 -1
- package/esm/publisher/document.d.ts.map +0 -1
- package/esm/publisher/document.js +0 -35
- package/esm/publisher/factory.d.ts +0 -65
- package/esm/publisher/factory.d.ts.map +0 -1
- package/esm/publisher/layout.d.ts.map +0 -1
- package/esm/publisher/pageFormat.d.ts.map +0 -1
- package/esm/publisher/pageLayout.d.ts.map +0 -1
- package/esm/publisher/slot.d.ts.map +0 -1
- package/esm/publisher/slot.js +0 -87
- package/esm/publisher/styling.d.ts.map +0 -1
- package/esm/publisher/variables.d.ts.map +0 -1
package/esm/sdk-model.d.ts
CHANGED
|
@@ -970,33 +970,82 @@ export declare function bucketsTotals(buckets: IBucket[]): ITotal[];
|
|
|
970
970
|
*/
|
|
971
971
|
export declare function bucketTotals(bucket: IBucket): ITotal[];
|
|
972
972
|
|
|
973
|
+
/**
|
|
974
|
+
* Current version of {@link BuiltInPublisherPageLayoutCoverV1}.
|
|
975
|
+
*
|
|
976
|
+
* @alpha
|
|
977
|
+
*/
|
|
978
|
+
export declare const BuiltInPublisherPageLayoutCover: IPublisherPageLayoutV1;
|
|
979
|
+
|
|
973
980
|
/**
|
|
974
981
|
* Built-in cover page: document title and subtitle.
|
|
975
982
|
*
|
|
976
983
|
* @alpha
|
|
977
984
|
*/
|
|
978
|
-
export declare const
|
|
985
|
+
export declare const BuiltInPublisherPageLayoutCoverV1: IPublisherPageLayoutV1;
|
|
986
|
+
|
|
987
|
+
/**
|
|
988
|
+
* Current version of {@link BuiltInPublisherPageLayoutPortraitCoverV1}.
|
|
989
|
+
*
|
|
990
|
+
* @alpha
|
|
991
|
+
*/
|
|
992
|
+
export declare const BuiltInPublisherPageLayoutPortraitCover: IPublisherPageLayoutV1;
|
|
979
993
|
|
|
980
994
|
/**
|
|
981
995
|
* Built-in portrait cover page: document title and subtitle.
|
|
982
996
|
*
|
|
983
997
|
* @alpha
|
|
984
998
|
*/
|
|
985
|
-
export declare const
|
|
999
|
+
export declare const BuiltInPublisherPageLayoutPortraitCoverV1: IPublisherPageLayoutV1;
|
|
1000
|
+
|
|
1001
|
+
/**
|
|
1002
|
+
* Current version of {@link BuiltInPublisherPageLayoutPortraitSectionV1}.
|
|
1003
|
+
*
|
|
1004
|
+
* @alpha
|
|
1005
|
+
*/
|
|
1006
|
+
export declare const BuiltInPublisherPageLayoutPortraitSection: IPublisherPageLayoutV1;
|
|
986
1007
|
|
|
987
1008
|
/**
|
|
988
1009
|
* Built-in portrait section divider page.
|
|
989
1010
|
*
|
|
990
1011
|
* @alpha
|
|
991
1012
|
*/
|
|
992
|
-
export declare const
|
|
1013
|
+
export declare const BuiltInPublisherPageLayoutPortraitSectionV1: IPublisherPageLayoutV1;
|
|
1014
|
+
|
|
1015
|
+
/**
|
|
1016
|
+
* Current version of {@link BuiltInPublisherPageLayoutPortraitSummaryV1}.
|
|
1017
|
+
*
|
|
1018
|
+
* @alpha
|
|
1019
|
+
*/
|
|
1020
|
+
export declare const BuiltInPublisherPageLayoutPortraitSummary: IPublisherPageLayoutV1;
|
|
993
1021
|
|
|
994
1022
|
/**
|
|
995
1023
|
* Built-in portrait page carrying a full-page narrative, with no visualization.
|
|
996
1024
|
*
|
|
997
1025
|
* @alpha
|
|
998
1026
|
*/
|
|
999
|
-
export declare const
|
|
1027
|
+
export declare const BuiltInPublisherPageLayoutPortraitSummaryV1: IPublisherPageLayoutV1;
|
|
1028
|
+
|
|
1029
|
+
/**
|
|
1030
|
+
* Current version of {@link BuiltInPublisherPageLayoutsV1}.
|
|
1031
|
+
*
|
|
1032
|
+
* @alpha
|
|
1033
|
+
*/
|
|
1034
|
+
export declare const BuiltInPublisherPageLayouts: readonly IPublisherPageLayoutV1[];
|
|
1035
|
+
|
|
1036
|
+
/**
|
|
1037
|
+
* Current version of {@link BuiltInPublisherPageLayoutSectionV1}.
|
|
1038
|
+
*
|
|
1039
|
+
* @alpha
|
|
1040
|
+
*/
|
|
1041
|
+
export declare const BuiltInPublisherPageLayoutSection: IPublisherPageLayoutV1;
|
|
1042
|
+
|
|
1043
|
+
/**
|
|
1044
|
+
* Built-in section divider page.
|
|
1045
|
+
*
|
|
1046
|
+
* @alpha
|
|
1047
|
+
*/
|
|
1048
|
+
export declare const BuiltInPublisherPageLayoutSectionV1: IPublisherPageLayoutV1;
|
|
1000
1049
|
|
|
1001
1050
|
/**
|
|
1002
1051
|
* All built-in page layouts served by the SPI. Built-ins are read-only: they cannot be
|
|
@@ -1004,29 +1053,36 @@ export declare const BuiltInPublisherPageLayoutPortraitSummary: IPublisherPageLa
|
|
|
1004
1053
|
*
|
|
1005
1054
|
* @alpha
|
|
1006
1055
|
*/
|
|
1007
|
-
export declare const
|
|
1056
|
+
export declare const BuiltInPublisherPageLayoutsV1: readonly IPublisherPageLayoutV1[];
|
|
1008
1057
|
|
|
1009
1058
|
/**
|
|
1010
|
-
*
|
|
1059
|
+
* Current version of {@link BuiltInPublisherPageLayoutViz6TextLeftV1}.
|
|
1011
1060
|
*
|
|
1012
1061
|
* @alpha
|
|
1013
1062
|
*/
|
|
1014
|
-
export declare const
|
|
1063
|
+
export declare const BuiltInPublisherPageLayoutViz6TextLeft: IPublisherPageLayoutV1;
|
|
1015
1064
|
|
|
1016
1065
|
/**
|
|
1017
1066
|
* Built-in content page with six visualizations and a text column on the left.
|
|
1018
1067
|
*
|
|
1019
1068
|
* @alpha
|
|
1020
1069
|
*/
|
|
1021
|
-
export declare const
|
|
1070
|
+
export declare const BuiltInPublisherPageLayoutViz6TextLeftV1: IPublisherPageLayoutV1;
|
|
1022
1071
|
|
|
1023
1072
|
/**
|
|
1024
|
-
*
|
|
1073
|
+
* Current version of {@link BuiltInPublisherSlotTypesV1}.
|
|
1025
1074
|
*
|
|
1026
1075
|
* @alpha
|
|
1027
1076
|
*/
|
|
1028
1077
|
export declare const BuiltInPublisherSlotTypes: string[];
|
|
1029
1078
|
|
|
1079
|
+
/**
|
|
1080
|
+
* List of built-in document slot type names.
|
|
1081
|
+
*
|
|
1082
|
+
* @alpha
|
|
1083
|
+
*/
|
|
1084
|
+
export declare const BuiltInPublisherSlotTypesV1: string[];
|
|
1085
|
+
|
|
1030
1086
|
/**
|
|
1031
1087
|
* List of built-in widget types. These type names are reserved and must not be used by custom widgets.
|
|
1032
1088
|
*
|
|
@@ -1882,12 +1938,26 @@ export declare function defaultDimensionsGenerator(definition: IExecutionDefinit
|
|
|
1882
1938
|
*/
|
|
1883
1939
|
export declare const DefaultLocale: ILocale;
|
|
1884
1940
|
|
|
1941
|
+
/**
|
|
1942
|
+
* Current version of {@link DefaultPublisherHeadingTypeV1}.
|
|
1943
|
+
*
|
|
1944
|
+
* @alpha
|
|
1945
|
+
*/
|
|
1946
|
+
export declare const DefaultPublisherHeadingType: PublisherHeadingTypeV1;
|
|
1947
|
+
|
|
1885
1948
|
/**
|
|
1886
1949
|
* Size a heading slot that states none is rendered at.
|
|
1887
1950
|
*
|
|
1888
1951
|
* @alpha
|
|
1889
1952
|
*/
|
|
1890
|
-
export declare const
|
|
1953
|
+
export declare const DefaultPublisherHeadingTypeV1: PublisherHeadingTypeV1;
|
|
1954
|
+
|
|
1955
|
+
/**
|
|
1956
|
+
* Current version of {@link DefaultPublisherPageFormatV1}.
|
|
1957
|
+
*
|
|
1958
|
+
* @alpha
|
|
1959
|
+
*/
|
|
1960
|
+
export declare const DefaultPublisherPageFormat: PublisherPageFormatV1;
|
|
1891
1961
|
|
|
1892
1962
|
/**
|
|
1893
1963
|
* Format assumed by a page that declares none, which keeps pages authored before formats existed
|
|
@@ -1895,14 +1965,26 @@ export declare const DefaultPublisherHeadingType: PublisherHeadingType;
|
|
|
1895
1965
|
*
|
|
1896
1966
|
* @alpha
|
|
1897
1967
|
*/
|
|
1898
|
-
export declare const
|
|
1968
|
+
export declare const DefaultPublisherPageFormatV1: PublisherPageFormatV1;
|
|
1969
|
+
|
|
1970
|
+
/**
|
|
1971
|
+
* @alpha
|
|
1972
|
+
*/
|
|
1973
|
+
export declare const DefaultPublisherPageSizeV2: PublisherPageSizeV2;
|
|
1974
|
+
|
|
1975
|
+
/**
|
|
1976
|
+
* Current version of {@link DefaultPublisherParagraphTypeV1}.
|
|
1977
|
+
*
|
|
1978
|
+
* @alpha
|
|
1979
|
+
*/
|
|
1980
|
+
export declare const DefaultPublisherParagraphType: PublisherParagraphTypeV1;
|
|
1899
1981
|
|
|
1900
1982
|
/**
|
|
1901
1983
|
* Size a paragraph slot that states none is rendered at.
|
|
1902
1984
|
*
|
|
1903
1985
|
* @alpha
|
|
1904
1986
|
*/
|
|
1905
|
-
export declare const
|
|
1987
|
+
export declare const DefaultPublisherParagraphTypeV1: PublisherParagraphTypeV1;
|
|
1906
1988
|
|
|
1907
1989
|
/**
|
|
1908
1990
|
* Calculates fingerprint for the execution definition.
|
|
@@ -2920,12 +3002,19 @@ export declare function getPluggableApplicationHref(app: PluggableApplicationReg
|
|
|
2920
3002
|
*/
|
|
2921
3003
|
export declare function getPluggableApplicationLocalizedTitle(app: PluggableApplicationRegistryItem, locale: ILocale | undefined): string;
|
|
2922
3004
|
|
|
3005
|
+
/**
|
|
3006
|
+
* Current version of {@link getPublisherTextPlaceholdersV1}.
|
|
3007
|
+
*
|
|
3008
|
+
* @alpha
|
|
3009
|
+
*/
|
|
3010
|
+
export declare const getPublisherTextPlaceholders: typeof getPublisherTextPlaceholdersV1;
|
|
3011
|
+
|
|
2923
3012
|
/**
|
|
2924
3013
|
* Collects the distinct `{variable}` names referenced in the text, in order of first occurrence.
|
|
2925
3014
|
*
|
|
2926
3015
|
* @alpha
|
|
2927
3016
|
*/
|
|
2928
|
-
export declare function
|
|
3017
|
+
export declare function getPublisherTextPlaceholdersV1(text: string): string[];
|
|
2929
3018
|
|
|
2930
3019
|
/**
|
|
2931
3020
|
* Returns count of selected elements
|
|
@@ -3005,6 +3094,18 @@ export declare interface IAbsoluteDateFilterBody extends IIdentifiableFilter {
|
|
|
3005
3094
|
* End date (including): this is in format 'YYYY-MM-DD'
|
|
3006
3095
|
*/
|
|
3007
3096
|
to: string;
|
|
3097
|
+
/**
|
|
3098
|
+
* Granularity of the selected periods. When not set, the range is a plain range of days.
|
|
3099
|
+
*
|
|
3100
|
+
* 'from' and 'to' stay day-level even when this is set: they are the first day of the first
|
|
3101
|
+
* selected period and the last day of the last selected period.
|
|
3102
|
+
*
|
|
3103
|
+
* @remarks
|
|
3104
|
+
* On the Tiger backend, `GDC.time.month`, `GDC.time.quarter` and `GDC.time.year` select whole periods
|
|
3105
|
+
* when 'from' and 'to' are days in the 'YYYY-MM-DD' format covering whole periods; any other range, and
|
|
3106
|
+
* every other granularity, selects the days of the range as given.
|
|
3107
|
+
*/
|
|
3108
|
+
granularity?: DateAttributeGranularity;
|
|
3008
3109
|
/**
|
|
3009
3110
|
* How to treat empty date values.
|
|
3010
3111
|
*/
|
|
@@ -3033,6 +3134,31 @@ export declare interface IAbsoluteDateFilterForm extends IDateFilterOption {
|
|
|
3033
3134
|
emptyValueHandling?: EmptyValues;
|
|
3034
3135
|
}
|
|
3035
3136
|
|
|
3137
|
+
/**
|
|
3138
|
+
* Options of a new absolute date filter.
|
|
3139
|
+
*
|
|
3140
|
+
* @public
|
|
3141
|
+
*/
|
|
3142
|
+
export declare interface IAbsoluteDateFilterOptions {
|
|
3143
|
+
/**
|
|
3144
|
+
* Filter local identifier.
|
|
3145
|
+
*/
|
|
3146
|
+
localIdentifier?: string;
|
|
3147
|
+
/**
|
|
3148
|
+
* How to treat empty date values.
|
|
3149
|
+
*/
|
|
3150
|
+
emptyValueHandling?: EmptyValues;
|
|
3151
|
+
/**
|
|
3152
|
+
* Granularity of the selected periods; day is the default and is not stored.
|
|
3153
|
+
*
|
|
3154
|
+
* @remarks
|
|
3155
|
+
* On the Tiger backend, `GDC.time.month`, `GDC.time.quarter` and `GDC.time.year` select whole periods
|
|
3156
|
+
* when 'from' and 'to' are days in the 'YYYY-MM-DD' format covering whole periods; any other range, and
|
|
3157
|
+
* every other granularity, selects the days of the range as given.
|
|
3158
|
+
*/
|
|
3159
|
+
granularity?: DateAttributeGranularity;
|
|
3160
|
+
}
|
|
3161
|
+
|
|
3036
3162
|
/**
|
|
3037
3163
|
* Custom absolute date filter preset
|
|
3038
3164
|
* @alpha
|
|
@@ -3065,6 +3191,7 @@ export declare interface IAbsoluteDateFilterValues {
|
|
|
3065
3191
|
from: string;
|
|
3066
3192
|
to: string;
|
|
3067
3193
|
dataSet?: ObjRef;
|
|
3194
|
+
granularity?: DateAttributeGranularity;
|
|
3068
3195
|
emptyValueHandling?: EmptyValues;
|
|
3069
3196
|
}
|
|
3070
3197
|
|
|
@@ -7842,7 +7969,6 @@ export declare interface IFeatureFlags {
|
|
|
7842
7969
|
enableOracleDataSource?: boolean;
|
|
7843
7970
|
enableOidcAuth?: boolean;
|
|
7844
7971
|
enableMotherDuckDataSource?: boolean;
|
|
7845
|
-
enableMongoDbDataSource?: boolean;
|
|
7846
7972
|
enableStarrocksDataSource?: boolean;
|
|
7847
7973
|
enableSingleStoreDataSource?: boolean;
|
|
7848
7974
|
enableDenodoDataSource?: boolean;
|
|
@@ -8315,6 +8441,10 @@ export declare interface IFeatureFlags {
|
|
|
8315
8441
|
* Enable the templates and page layouts screens of the Business Briefing reports application.
|
|
8316
8442
|
*/
|
|
8317
8443
|
enableReportsSubsections?: boolean;
|
|
8444
|
+
/**
|
|
8445
|
+
* Enable Publisher v2.
|
|
8446
|
+
*/
|
|
8447
|
+
enablePublisherV2?: boolean;
|
|
8318
8448
|
/**
|
|
8319
8449
|
* Enable the write and export postMessage commands for embedded dashboards and Analytical Designer.
|
|
8320
8450
|
*
|
|
@@ -8335,6 +8465,13 @@ export declare interface IFeatureFlags {
|
|
|
8335
8465
|
* Disabled by default.
|
|
8336
8466
|
*/
|
|
8337
8467
|
enableLocalizationOverview?: boolean;
|
|
8468
|
+
/**
|
|
8469
|
+
* Enable the new rendering of charts in the AI Assistant.
|
|
8470
|
+
*
|
|
8471
|
+
* @remarks
|
|
8472
|
+
* Disabled by default.
|
|
8473
|
+
*/
|
|
8474
|
+
enableAiAssistantChartsV2?: boolean;
|
|
8338
8475
|
}
|
|
8339
8476
|
|
|
8340
8477
|
/**
|
|
@@ -8800,8 +8937,9 @@ export declare interface IGenAIPublisherDocumentContext {
|
|
|
8800
8937
|
title?: string;
|
|
8801
8938
|
/**
|
|
8802
8939
|
* Document definition as the user sees it, including edits that are not saved yet.
|
|
8940
|
+
* Pinned to the v1 type because the v1 copilot reads it; it does not follow newer Publisher versions.
|
|
8803
8941
|
*/
|
|
8804
|
-
definition?:
|
|
8942
|
+
definition?: IPublisherDocumentDefinitionV1;
|
|
8805
8943
|
/**
|
|
8806
8944
|
* Name of the conversation draft the editor shows, while that draft is not saved yet.
|
|
8807
8945
|
*/
|
|
@@ -10900,6 +11038,20 @@ export declare interface INegativeAttributeFilterBody extends IIdentifiableFilte
|
|
|
10900
11038
|
notIn: IAttributeElements;
|
|
10901
11039
|
}
|
|
10902
11040
|
|
|
11041
|
+
/**
|
|
11042
|
+
* @alpha
|
|
11043
|
+
*/
|
|
11044
|
+
export declare interface INewPublisherDocumentFilterIdOptionsV2 {
|
|
11045
|
+
/**
|
|
11046
|
+
* The label of an attribute filter or the dataset of a date filter, as an identifier ref.
|
|
11047
|
+
*/
|
|
11048
|
+
target: ObjRef;
|
|
11049
|
+
/**
|
|
11050
|
+
* Local identifiers of the document's `content.filters`.
|
|
11051
|
+
*/
|
|
11052
|
+
usedIds: ReadonlySet<string>;
|
|
11053
|
+
}
|
|
11054
|
+
|
|
10903
11055
|
/**
|
|
10904
11056
|
* Builder for inline measures.
|
|
10905
11057
|
*
|
|
@@ -11906,6 +12058,18 @@ export declare interface IPermanentSettings {
|
|
|
11906
12058
|
* Default delimiter to use for CSV exports when not overridden by request.
|
|
11907
12059
|
*/
|
|
11908
12060
|
exportCsvCustomDelimiter?: string;
|
|
12061
|
+
/**
|
|
12062
|
+
* Who can view a newly created metric. Applies only with `enableMetricPermissions`.
|
|
12063
|
+
* The backend treats an unset value as RESTRICTED.
|
|
12064
|
+
* @alpha
|
|
12065
|
+
*/
|
|
12066
|
+
defaultMetricVisibility?: ObjectVisibility;
|
|
12067
|
+
/**
|
|
12068
|
+
* Who can view a newly created visualization. Applies only with `enableVisualizationPermissions`.
|
|
12069
|
+
* The backend treats an unset value as RESTRICTED.
|
|
12070
|
+
* @alpha
|
|
12071
|
+
*/
|
|
12072
|
+
defaultVisualizationVisibility?: ObjectVisibility;
|
|
11909
12073
|
/**
|
|
11910
12074
|
* Headline component will not be underlined when it is set up with drilling.
|
|
11911
12075
|
*/
|
|
@@ -12182,12 +12346,37 @@ export declare interface IProductionFeaturesConfig {
|
|
|
12182
12346
|
features?: IProductionFeatureConfig[];
|
|
12183
12347
|
}
|
|
12184
12348
|
|
|
12349
|
+
/**
|
|
12350
|
+
* Both ends are inclusive.
|
|
12351
|
+
*
|
|
12352
|
+
* @alpha
|
|
12353
|
+
*/
|
|
12354
|
+
export declare interface IPublisherAbsolutePeriodV2 {
|
|
12355
|
+
type: "absolute";
|
|
12356
|
+
granularity: "GDC.time.date";
|
|
12357
|
+
/**
|
|
12358
|
+
* `YYYY-MM-DD`.
|
|
12359
|
+
*/
|
|
12360
|
+
from: string;
|
|
12361
|
+
/**
|
|
12362
|
+
* `YYYY-MM-DD`.
|
|
12363
|
+
*/
|
|
12364
|
+
to: string;
|
|
12365
|
+
}
|
|
12366
|
+
|
|
12367
|
+
/**
|
|
12368
|
+
* Current version of {@link IPublisherAiTextSourceV1}.
|
|
12369
|
+
*
|
|
12370
|
+
* @alpha
|
|
12371
|
+
*/
|
|
12372
|
+
export declare type IPublisherAiTextSource = IPublisherAiTextSourceV1;
|
|
12373
|
+
|
|
12185
12374
|
/**
|
|
12186
12375
|
* Text generated by AI at document-build time.
|
|
12187
12376
|
*
|
|
12188
12377
|
* @alpha
|
|
12189
12378
|
*/
|
|
12190
|
-
export declare interface
|
|
12379
|
+
export declare interface IPublisherAiTextSourceV1 {
|
|
12191
12380
|
type: "ai";
|
|
12192
12381
|
/**
|
|
12193
12382
|
* Instruction for the generator. Supports `{variables}`.
|
|
@@ -12204,13 +12393,99 @@ export declare interface IPublisherAiTextSource {
|
|
|
12204
12393
|
generatedAt?: string;
|
|
12205
12394
|
}
|
|
12206
12395
|
|
|
12396
|
+
/**
|
|
12397
|
+
* Current version of {@link IPublisherAttributeFilterConfigV1}.
|
|
12398
|
+
*
|
|
12399
|
+
* @alpha
|
|
12400
|
+
*/
|
|
12401
|
+
export declare type IPublisherAttributeFilterConfig = IPublisherAttributeFilterConfigV1;
|
|
12402
|
+
|
|
12207
12403
|
/**
|
|
12208
12404
|
* Configuration of a document's content-level attribute filter: the part of a dashboard attribute
|
|
12209
12405
|
* filter's configuration that documents support.
|
|
12210
12406
|
*
|
|
12211
12407
|
* @alpha
|
|
12212
12408
|
*/
|
|
12213
|
-
export declare type
|
|
12409
|
+
export declare type IPublisherAttributeFilterConfigV1 = Pick<IDashboardAttributeFilterConfig, "localIdentifier" | "displayAsLabel">;
|
|
12410
|
+
|
|
12411
|
+
/**
|
|
12412
|
+
* @alpha
|
|
12413
|
+
*/
|
|
12414
|
+
export declare interface IPublisherAxisDisplayV2 {
|
|
12415
|
+
visible?: boolean;
|
|
12416
|
+
/**
|
|
12417
|
+
* The axis title.
|
|
12418
|
+
*/
|
|
12419
|
+
name?: {
|
|
12420
|
+
visible?: boolean;
|
|
12421
|
+
position?: "low" | "middle" | "high";
|
|
12422
|
+
};
|
|
12423
|
+
/**
|
|
12424
|
+
* The tick labels. Rotation is in degrees, -90 to 90.
|
|
12425
|
+
*/
|
|
12426
|
+
values?: {
|
|
12427
|
+
visible?: boolean;
|
|
12428
|
+
rotation?: number;
|
|
12429
|
+
};
|
|
12430
|
+
min?: number;
|
|
12431
|
+
max?: number;
|
|
12432
|
+
}
|
|
12433
|
+
|
|
12434
|
+
/**
|
|
12435
|
+
* @alpha
|
|
12436
|
+
*/
|
|
12437
|
+
export declare interface IPublisherBackgroundStyleV2 {
|
|
12438
|
+
backgroundColor?: PublisherColorValueV2;
|
|
12439
|
+
/**
|
|
12440
|
+
* Opacity of the background color only.
|
|
12441
|
+
*/
|
|
12442
|
+
backgroundOpacity?: PublisherOpacityV2;
|
|
12443
|
+
backgroundImage?: PublisherImageSourceV2;
|
|
12444
|
+
backgroundImageOpacity?: PublisherOpacityV2;
|
|
12445
|
+
/**
|
|
12446
|
+
* Defaults to `cover`.
|
|
12447
|
+
*/
|
|
12448
|
+
backgroundFit?: "cover" | "contain" | "fill" | "tile";
|
|
12449
|
+
backgroundHorizontalAlign?: PublisherHorizontalAlignV2;
|
|
12450
|
+
backgroundVerticalAlign?: PublisherVerticalAlignV2;
|
|
12451
|
+
backgroundOffset?: PublisherPxV2;
|
|
12452
|
+
backgroundOffsetTop?: PublisherPxV2;
|
|
12453
|
+
backgroundOffsetRight?: PublisherPxV2;
|
|
12454
|
+
backgroundOffsetBottom?: PublisherPxV2;
|
|
12455
|
+
backgroundOffsetLeft?: PublisherPxV2;
|
|
12456
|
+
}
|
|
12457
|
+
|
|
12458
|
+
/**
|
|
12459
|
+
* @remarks
|
|
12460
|
+
* A side key wins over the matching all-sides key in any order. `borderStyle` defaults to `solid`,
|
|
12461
|
+
* so a width alone draws a line.
|
|
12462
|
+
*
|
|
12463
|
+
* @alpha
|
|
12464
|
+
*/
|
|
12465
|
+
export declare interface IPublisherBorderStyleV2 {
|
|
12466
|
+
borderWidth?: PublisherPxV2;
|
|
12467
|
+
borderStyle?: PublisherBorderLineStyleV2;
|
|
12468
|
+
borderColor?: PublisherColorValueV2;
|
|
12469
|
+
borderTopWidth?: PublisherPxV2;
|
|
12470
|
+
borderTopStyle?: PublisherBorderLineStyleV2;
|
|
12471
|
+
borderTopColor?: PublisherColorValueV2;
|
|
12472
|
+
borderRightWidth?: PublisherPxV2;
|
|
12473
|
+
borderRightStyle?: PublisherBorderLineStyleV2;
|
|
12474
|
+
borderRightColor?: PublisherColorValueV2;
|
|
12475
|
+
borderBottomWidth?: PublisherPxV2;
|
|
12476
|
+
borderBottomStyle?: PublisherBorderLineStyleV2;
|
|
12477
|
+
borderBottomColor?: PublisherColorValueV2;
|
|
12478
|
+
borderLeftWidth?: PublisherPxV2;
|
|
12479
|
+
borderLeftStyle?: PublisherBorderLineStyleV2;
|
|
12480
|
+
borderLeftColor?: PublisherColorValueV2;
|
|
12481
|
+
}
|
|
12482
|
+
|
|
12483
|
+
/**
|
|
12484
|
+
* Current version of {@link IPublisherBoxStyleV1}.
|
|
12485
|
+
*
|
|
12486
|
+
* @alpha
|
|
12487
|
+
*/
|
|
12488
|
+
export declare type IPublisherBoxStyle = IPublisherBoxStyleV1;
|
|
12214
12489
|
|
|
12215
12490
|
/**
|
|
12216
12491
|
* Paint of the box itself. Never affects the geometry of the box or its children —
|
|
@@ -12218,8 +12493,8 @@ export declare type IPublisherAttributeFilterConfig = Pick<IDashboardAttributeFi
|
|
|
12218
12493
|
*
|
|
12219
12494
|
* @alpha
|
|
12220
12495
|
*/
|
|
12221
|
-
export declare interface
|
|
12222
|
-
background?:
|
|
12496
|
+
export declare interface IPublisherBoxStyleV1 {
|
|
12497
|
+
background?: PublisherBackgroundV1;
|
|
12223
12498
|
/**
|
|
12224
12499
|
* Corner radius in percent of the page width — the same relative unit the rest of a document page
|
|
12225
12500
|
* is sized in, so the corners keep their proportion however large the page is rendered.
|
|
@@ -12228,19 +12503,63 @@ export declare interface IPublisherBoxStyle {
|
|
|
12228
12503
|
borderRadius?: number;
|
|
12229
12504
|
/**
|
|
12230
12505
|
* Inset of the box's own content, in percent of the page width like
|
|
12231
|
-
* {@link
|
|
12506
|
+
* {@link IPublisherBoxStyleV1.borderRadius}. Insets only inward — siblings and the layout
|
|
12232
12507
|
* gaps around the box are untouched. A box that paints a background usually wants one;
|
|
12233
12508
|
* a full-bleed box (an image-backed cover) wants none, which is why no default exists.
|
|
12234
12509
|
*/
|
|
12235
12510
|
padding?: number;
|
|
12236
12511
|
}
|
|
12237
12512
|
|
|
12513
|
+
/**
|
|
12514
|
+
* Box keys. They apply to the node they are set on and never inherit.
|
|
12515
|
+
*
|
|
12516
|
+
* @alpha
|
|
12517
|
+
*/
|
|
12518
|
+
export declare interface IPublisherBoxStyleV2 extends IPublisherBackgroundStyleV2, IPublisherPaddingStyleV2, IPublisherBorderStyleV2, IPublisherCornerStyleV2, IPublisherShadowStyleV2 {
|
|
12519
|
+
/**
|
|
12520
|
+
* Opacity of the whole node, content included.
|
|
12521
|
+
*/
|
|
12522
|
+
opacity?: PublisherOpacityV2;
|
|
12523
|
+
}
|
|
12524
|
+
|
|
12525
|
+
/**
|
|
12526
|
+
* @alpha
|
|
12527
|
+
*/
|
|
12528
|
+
export declare interface IPublisherChartStyleV2 {
|
|
12529
|
+
fontSize?: PublisherPxV2;
|
|
12530
|
+
textColor?: PublisherColorValueV2;
|
|
12531
|
+
axisLineColor?: PublisherColorValueV2;
|
|
12532
|
+
/**
|
|
12533
|
+
* Color of the axis title.
|
|
12534
|
+
*/
|
|
12535
|
+
axisNameColor?: PublisherColorValueV2;
|
|
12536
|
+
axisNameSize?: PublisherPxV2;
|
|
12537
|
+
/**
|
|
12538
|
+
* Color of the tick labels.
|
|
12539
|
+
*/
|
|
12540
|
+
axisValueColor?: PublisherColorValueV2;
|
|
12541
|
+
axisValueSize?: PublisherPxV2;
|
|
12542
|
+
gridColor?: PublisherColorValueV2;
|
|
12543
|
+
plotLineColor?: PublisherColorValueV2;
|
|
12544
|
+
legendColor?: PublisherColorValueV2;
|
|
12545
|
+
legendSize?: PublisherPxV2;
|
|
12546
|
+
dataLabelColor?: PublisherColorValueV2;
|
|
12547
|
+
dataLabelSize?: PublisherPxV2;
|
|
12548
|
+
}
|
|
12549
|
+
|
|
12550
|
+
/**
|
|
12551
|
+
* Current version of {@link IPublisherColorBackgroundV1}.
|
|
12552
|
+
*
|
|
12553
|
+
* @alpha
|
|
12554
|
+
*/
|
|
12555
|
+
export declare type IPublisherColorBackground = IPublisherColorBackgroundV1;
|
|
12556
|
+
|
|
12238
12557
|
/**
|
|
12239
12558
|
* Solid color painted behind a section's or page's content.
|
|
12240
12559
|
*
|
|
12241
12560
|
* @alpha
|
|
12242
12561
|
*/
|
|
12243
|
-
export declare interface
|
|
12562
|
+
export declare interface IPublisherColorBackgroundV1 {
|
|
12244
12563
|
type: "color";
|
|
12245
12564
|
/**
|
|
12246
12565
|
* CSS color value. Absolute: document styling states brand colors directly and does not
|
|
@@ -12250,25 +12569,80 @@ export declare interface IPublisherColorBackground {
|
|
|
12250
12569
|
}
|
|
12251
12570
|
|
|
12252
12571
|
/**
|
|
12253
|
-
*
|
|
12572
|
+
* @alpha
|
|
12573
|
+
*/
|
|
12574
|
+
export declare interface IPublisherContainerStyleV2 extends IPublisherBoxStyleV2, IPublisherInheritedTextStyleV2 {
|
|
12575
|
+
gap?: PublisherGapValueV2;
|
|
12576
|
+
}
|
|
12577
|
+
|
|
12578
|
+
/**
|
|
12579
|
+
* Row or column of layout nodes.
|
|
12254
12580
|
*
|
|
12255
12581
|
* @alpha
|
|
12256
12582
|
*/
|
|
12257
|
-
export declare interface
|
|
12258
|
-
|
|
12583
|
+
export declare interface IPublisherContainerV2 {
|
|
12584
|
+
type: "row" | "column";
|
|
12259
12585
|
/**
|
|
12260
|
-
*
|
|
12261
|
-
* in the current workspace.
|
|
12586
|
+
* Matches `[A-Za-z0-9_.-]{1,64}`.
|
|
12262
12587
|
*/
|
|
12263
|
-
|
|
12588
|
+
id?: string;
|
|
12589
|
+
/**
|
|
12590
|
+
* In reading order. An empty list renders as a spacer.
|
|
12591
|
+
*/
|
|
12592
|
+
children: PublisherLayoutNodeV2[];
|
|
12593
|
+
/**
|
|
12594
|
+
* Share of the parent's main axis, greater than 0. Defaults to 1.
|
|
12595
|
+
*/
|
|
12596
|
+
proportion?: number;
|
|
12597
|
+
/**
|
|
12598
|
+
* Enforced by the editor, never checked on write.
|
|
12599
|
+
*/
|
|
12600
|
+
locked?: boolean;
|
|
12601
|
+
style?: IPublisherContainerStyleV2;
|
|
12264
12602
|
}
|
|
12265
12603
|
|
|
12604
|
+
/**
|
|
12605
|
+
* @remarks
|
|
12606
|
+
* A corner key wins over `borderRadius` in any order.
|
|
12607
|
+
*
|
|
12608
|
+
* @alpha
|
|
12609
|
+
*/
|
|
12610
|
+
export declare interface IPublisherCornerStyleV2 {
|
|
12611
|
+
borderRadius?: PublisherRadiusValueV2;
|
|
12612
|
+
borderTopLeftRadius?: PublisherRadiusValueV2;
|
|
12613
|
+
borderTopRightRadius?: PublisherRadiusValueV2;
|
|
12614
|
+
borderBottomRightRadius?: PublisherRadiusValueV2;
|
|
12615
|
+
borderBottomLeftRadius?: PublisherRadiusValueV2;
|
|
12616
|
+
}
|
|
12617
|
+
|
|
12618
|
+
/**
|
|
12619
|
+
* @alpha
|
|
12620
|
+
*/
|
|
12621
|
+
export declare interface IPublisherDataSetRefV2 {
|
|
12622
|
+
identifier: string;
|
|
12623
|
+
type: "dataSet";
|
|
12624
|
+
}
|
|
12625
|
+
|
|
12626
|
+
/**
|
|
12627
|
+
* Current version of {@link IPublisherDocumentV1}.
|
|
12628
|
+
*
|
|
12629
|
+
* @alpha
|
|
12630
|
+
*/
|
|
12631
|
+
export declare type IPublisherDocument = IPublisherDocumentV1;
|
|
12632
|
+
|
|
12633
|
+
/**
|
|
12634
|
+
* Current version of {@link IPublisherDocumentBaseV1}.
|
|
12635
|
+
*
|
|
12636
|
+
* @alpha
|
|
12637
|
+
*/
|
|
12638
|
+
export declare type IPublisherDocumentBase = IPublisherDocumentBaseV1;
|
|
12639
|
+
|
|
12266
12640
|
/**
|
|
12267
12641
|
* Fields shared by document definitions and persisted documents.
|
|
12268
12642
|
*
|
|
12269
12643
|
* @alpha
|
|
12270
12644
|
*/
|
|
12271
|
-
export declare interface
|
|
12645
|
+
export declare interface IPublisherDocumentBaseV1 {
|
|
12272
12646
|
title: string;
|
|
12273
12647
|
description?: string;
|
|
12274
12648
|
tags?: string[];
|
|
@@ -12280,17 +12654,17 @@ export declare interface IPublisherDocumentBase {
|
|
|
12280
12654
|
* visualization slot's dateDataSet (lowest precedence, per-slot opt-out via
|
|
12281
12655
|
* ignoreReportPeriod). Also available as `{periodStart}` in text.
|
|
12282
12656
|
*/
|
|
12283
|
-
periodStart:
|
|
12657
|
+
periodStart: PublisherDateStringV1;
|
|
12284
12658
|
/**
|
|
12285
12659
|
* Reported period end, ISO 8601 date (YYYY-MM-DD), inclusive.
|
|
12286
12660
|
*/
|
|
12287
|
-
periodEnd:
|
|
12661
|
+
periodEnd: PublisherDateStringV1;
|
|
12288
12662
|
/**
|
|
12289
12663
|
* Content of the document. When created from a template the content is deep-copied
|
|
12290
12664
|
* and NO reference to the template is kept — the document stays frozen while pages
|
|
12291
12665
|
* and templates evolve.
|
|
12292
12666
|
*/
|
|
12293
|
-
content:
|
|
12667
|
+
content: IPublisherDocumentContentV1;
|
|
12294
12668
|
/**
|
|
12295
12669
|
* Values for variables declared in content.variables, keyed by variable name.
|
|
12296
12670
|
*/
|
|
@@ -12298,38 +12672,79 @@ export declare interface IPublisherDocumentBase {
|
|
|
12298
12672
|
}
|
|
12299
12673
|
|
|
12300
12674
|
/**
|
|
12301
|
-
*
|
|
12675
|
+
* Current version of {@link IPublisherDocumentContentV1}.
|
|
12302
12676
|
*
|
|
12303
12677
|
* @alpha
|
|
12304
12678
|
*/
|
|
12305
|
-
export declare
|
|
12306
|
-
|
|
12307
|
-
|
|
12308
|
-
|
|
12309
|
-
|
|
12310
|
-
|
|
12311
|
-
|
|
12312
|
-
|
|
12313
|
-
|
|
12679
|
+
export declare type IPublisherDocumentContent = IPublisherDocumentContentV1;
|
|
12680
|
+
|
|
12681
|
+
/**
|
|
12682
|
+
* Keys shared by both shapes of document content.
|
|
12683
|
+
*
|
|
12684
|
+
* @alpha
|
|
12685
|
+
*/
|
|
12686
|
+
export declare interface IPublisherDocumentContentBaseV2 {
|
|
12687
|
+
defaults?: IPublisherDocumentDefaultsV2;
|
|
12314
12688
|
/**
|
|
12315
|
-
*
|
|
12316
|
-
* The document period is NOT stored here — it is derived from periodStart/periodEnd
|
|
12317
|
-
* at execution time.
|
|
12689
|
+
* Date filters name their `dataSet`. At most one filter per attribute or date dataset.
|
|
12318
12690
|
*/
|
|
12319
12691
|
filters?: FilterContextItem[];
|
|
12692
|
+
attributeFilterConfigs?: IDashboardAttributeFilterConfig[];
|
|
12693
|
+
style?: IPublisherDocumentStyleV2;
|
|
12320
12694
|
/**
|
|
12321
|
-
*
|
|
12322
|
-
*
|
|
12323
|
-
* @remarks
|
|
12324
|
-
* A filter with a `displayAsLabel` must be stored on the attribute's primary label: its selection
|
|
12325
|
-
* is read as primary-label values and shown by `displayAsLabel`.
|
|
12695
|
+
* Overrides the workspace locale for this document, for example `de-DE`.
|
|
12326
12696
|
*/
|
|
12327
|
-
|
|
12697
|
+
locale?: string;
|
|
12328
12698
|
/**
|
|
12329
|
-
*
|
|
12330
|
-
* ({@link IPublisherDocumentBase.variableValues}).
|
|
12699
|
+
* Overrides the workspace format locale used for dates, for example `de-DE`.
|
|
12331
12700
|
*/
|
|
12332
|
-
|
|
12701
|
+
formatLocale?: string;
|
|
12702
|
+
}
|
|
12703
|
+
|
|
12704
|
+
/**
|
|
12705
|
+
* @alpha
|
|
12706
|
+
*/
|
|
12707
|
+
export declare interface IPublisherDocumentContentSetSectionsOptionsV2 {
|
|
12708
|
+
/**
|
|
12709
|
+
* Content the sections were read from. Its other keys are kept.
|
|
12710
|
+
*/
|
|
12711
|
+
content: PublisherDocumentContentV2;
|
|
12712
|
+
sections: IPublisherSectionV2[];
|
|
12713
|
+
}
|
|
12714
|
+
|
|
12715
|
+
/**
|
|
12716
|
+
* Versioned content shared verbatim by document templates and documents.
|
|
12717
|
+
*
|
|
12718
|
+
* @alpha
|
|
12719
|
+
*/
|
|
12720
|
+
export declare interface IPublisherDocumentContentV1 {
|
|
12721
|
+
/**
|
|
12722
|
+
* Content model version, for stored-content evolution.
|
|
12723
|
+
*/
|
|
12724
|
+
version: "1";
|
|
12725
|
+
/**
|
|
12726
|
+
* Ordered pages of the document.
|
|
12727
|
+
*/
|
|
12728
|
+
pages: IPublisherDocumentPageV1[];
|
|
12729
|
+
/**
|
|
12730
|
+
* Content-level default filters; pages and slots may extend or override them.
|
|
12731
|
+
* The document period is NOT stored here — it is derived from periodStart/periodEnd
|
|
12732
|
+
* at execution time.
|
|
12733
|
+
*/
|
|
12734
|
+
filters?: FilterContextItem[];
|
|
12735
|
+
/**
|
|
12736
|
+
* Configuration of the content-level attribute filters, keyed by the filter's local identifier.
|
|
12737
|
+
*
|
|
12738
|
+
* @remarks
|
|
12739
|
+
* A filter with a `displayAsLabel` must be stored on the attribute's primary label: its selection
|
|
12740
|
+
* is read as primary-label values and shown by `displayAsLabel`.
|
|
12741
|
+
*/
|
|
12742
|
+
attributeFilterConfigs?: IPublisherAttributeFilterConfigV1[];
|
|
12743
|
+
/**
|
|
12744
|
+
* Custom variable declarations. Values live on the document
|
|
12745
|
+
* ({@link IPublisherDocumentBaseV1.variableValues}).
|
|
12746
|
+
*/
|
|
12747
|
+
variables?: IPublisherVariableDefinitionV1[];
|
|
12333
12748
|
/**
|
|
12334
12749
|
* Instructions every AI-written text without instructions of its own is generated with.
|
|
12335
12750
|
* Supports `{variables}`.
|
|
@@ -12337,12 +12752,39 @@ export declare interface IPublisherDocumentContent {
|
|
|
12337
12752
|
takeawaysInstruction?: string;
|
|
12338
12753
|
}
|
|
12339
12754
|
|
|
12755
|
+
/**
|
|
12756
|
+
* @alpha
|
|
12757
|
+
*/
|
|
12758
|
+
export declare interface IPublisherDocumentDefaultsV2 {
|
|
12759
|
+
/**
|
|
12760
|
+
* Applies to every page without its own `pageSize`.
|
|
12761
|
+
*/
|
|
12762
|
+
pageSize?: PublisherPageSizeV2;
|
|
12763
|
+
takeaway?: {
|
|
12764
|
+
/**
|
|
12765
|
+
* Combined with each takeaway widget's own `generation`.
|
|
12766
|
+
*/
|
|
12767
|
+
generation?: IPublisherTakeawayGenerationV2;
|
|
12768
|
+
};
|
|
12769
|
+
/**
|
|
12770
|
+
* Document templates only. A document stores its period on the entity.
|
|
12771
|
+
*/
|
|
12772
|
+
period?: PublisherPeriodV2;
|
|
12773
|
+
}
|
|
12774
|
+
|
|
12775
|
+
/**
|
|
12776
|
+
* Current version of {@link IPublisherDocumentDefinitionV1}.
|
|
12777
|
+
*
|
|
12778
|
+
* @alpha
|
|
12779
|
+
*/
|
|
12780
|
+
export declare type IPublisherDocumentDefinition = IPublisherDocumentDefinitionV1;
|
|
12781
|
+
|
|
12340
12782
|
/**
|
|
12341
12783
|
* Payload for creating or updating a document.
|
|
12342
12784
|
*
|
|
12343
12785
|
* @alpha
|
|
12344
12786
|
*/
|
|
12345
|
-
export declare interface
|
|
12787
|
+
export declare interface IPublisherDocumentDefinitionV1 extends IPublisherDocumentBaseV1 {
|
|
12346
12788
|
type: "report";
|
|
12347
12789
|
/**
|
|
12348
12790
|
* Present when updating an existing document.
|
|
@@ -12351,393 +12793,1030 @@ export declare interface IPublisherDocumentDefinition extends IPublisherDocument
|
|
|
12351
12793
|
}
|
|
12352
12794
|
|
|
12353
12795
|
/**
|
|
12354
|
-
*
|
|
12355
|
-
* plus its own identity.
|
|
12356
|
-
*
|
|
12357
|
-
* @remarks
|
|
12358
|
-
* Cloning a {@link IPublisherPageLayout} into content assigns the localIdentifier and regenerates
|
|
12359
|
-
* slot localIdentifiers (with the layout slotIds) so repeated use of one page stays unique.
|
|
12360
|
-
* Deliberately carries NO reference back to the source page — later page edits never
|
|
12361
|
-
* affect existing templates or documents.
|
|
12796
|
+
* Payload for creating or updating a document.
|
|
12362
12797
|
*
|
|
12363
12798
|
* @alpha
|
|
12364
12799
|
*/
|
|
12365
|
-
export declare interface
|
|
12800
|
+
export declare interface IPublisherDocumentDefinitionV2 extends IPublisherEntityDefinitionBaseV2 {
|
|
12801
|
+
type: "document";
|
|
12802
|
+
period: PublisherPeriodV2;
|
|
12366
12803
|
/**
|
|
12367
|
-
*
|
|
12804
|
+
* A document created from a template gets a deep copy of its content and keeps no reference to it.
|
|
12368
12805
|
*/
|
|
12369
|
-
|
|
12806
|
+
content: PublisherDocumentContentV2;
|
|
12370
12807
|
}
|
|
12371
12808
|
|
|
12372
12809
|
/**
|
|
12373
|
-
*
|
|
12810
|
+
* Current version of {@link IPublisherDocumentPageV1}.
|
|
12374
12811
|
*
|
|
12375
12812
|
* @alpha
|
|
12376
12813
|
*/
|
|
12377
|
-
export declare
|
|
12378
|
-
ref: ObjRef;
|
|
12379
|
-
/**
|
|
12380
|
-
* When true, the object comes from a parent workspace and is not editable
|
|
12381
|
-
* in the current workspace.
|
|
12382
|
-
*/
|
|
12383
|
-
isLocked?: boolean;
|
|
12384
|
-
}
|
|
12814
|
+
export declare type IPublisherDocumentPage = IPublisherDocumentPageV1;
|
|
12385
12815
|
|
|
12386
12816
|
/**
|
|
12387
|
-
*
|
|
12817
|
+
* Document content stored as a flat list of pages.
|
|
12388
12818
|
*
|
|
12389
12819
|
* @alpha
|
|
12390
12820
|
*/
|
|
12391
|
-
export declare interface
|
|
12392
|
-
|
|
12393
|
-
|
|
12394
|
-
* Present when updating an existing template.
|
|
12395
|
-
*/
|
|
12396
|
-
ref?: ObjRef;
|
|
12397
|
-
title: string;
|
|
12398
|
-
description?: string;
|
|
12399
|
-
tags?: string[];
|
|
12400
|
-
content: IPublisherDocumentContent;
|
|
12821
|
+
export declare interface IPublisherDocumentPagesContentV2 extends IPublisherDocumentContentBaseV2 {
|
|
12822
|
+
pages: IPublisherDocumentPageV2[];
|
|
12823
|
+
sections?: never;
|
|
12401
12824
|
}
|
|
12402
12825
|
|
|
12403
12826
|
/**
|
|
12404
|
-
*
|
|
12827
|
+
* Page instance embedded in template/document content: a deep clone of a page body
|
|
12828
|
+
* plus its own identity.
|
|
12405
12829
|
*
|
|
12406
12830
|
* @remarks
|
|
12407
|
-
*
|
|
12408
|
-
*
|
|
12831
|
+
* Cloning a {@link IPublisherPageLayoutV1} into content assigns the localIdentifier and regenerates
|
|
12832
|
+
* slot localIdentifiers (with the layout slotIds) so repeated use of one page stays unique.
|
|
12833
|
+
* Deliberately carries NO reference back to the source page — later page edits never
|
|
12834
|
+
* affect existing templates or documents.
|
|
12409
12835
|
*
|
|
12410
12836
|
* @alpha
|
|
12411
12837
|
*/
|
|
12412
|
-
export declare interface
|
|
12413
|
-
type: "heading";
|
|
12414
|
-
style?: IPublisherHeadingStyle;
|
|
12838
|
+
export declare interface IPublisherDocumentPageV1 extends IPublisherPageBodyV1 {
|
|
12415
12839
|
/**
|
|
12416
|
-
*
|
|
12840
|
+
* Identifier unique within the content; stable across template-to-document copy and reordering.
|
|
12417
12841
|
*/
|
|
12418
|
-
|
|
12842
|
+
localIdentifier: string;
|
|
12419
12843
|
}
|
|
12420
12844
|
|
|
12421
12845
|
/**
|
|
12422
|
-
*
|
|
12846
|
+
* Page inside a document.
|
|
12423
12847
|
*
|
|
12424
12848
|
* @alpha
|
|
12425
12849
|
*/
|
|
12426
|
-
export declare interface
|
|
12850
|
+
export declare interface IPublisherDocumentPageV2 extends IPublisherPageBodyV2 {
|
|
12427
12851
|
/**
|
|
12428
|
-
*
|
|
12429
|
-
* with it; the rest of the style overrides ink and placement on top of it.
|
|
12852
|
+
* Unique in the document. Matches `[A-Za-z0-9_.-]{1,64}`.
|
|
12430
12853
|
*/
|
|
12431
|
-
|
|
12854
|
+
id: string;
|
|
12855
|
+
/**
|
|
12856
|
+
* Defaults to `true`. A hidden page is left out of the viewer, exports and page numbers.
|
|
12857
|
+
*/
|
|
12858
|
+
visible?: boolean;
|
|
12432
12859
|
}
|
|
12433
12860
|
|
|
12434
12861
|
/**
|
|
12435
|
-
*
|
|
12862
|
+
* Document content stored as sections of pages.
|
|
12436
12863
|
*
|
|
12437
12864
|
* @alpha
|
|
12438
12865
|
*/
|
|
12439
|
-
export declare interface
|
|
12440
|
-
|
|
12441
|
-
|
|
12442
|
-
* Local identifier of an image slot in {@link IPublisherPageBody.slots}. Routing the image
|
|
12443
|
-
* through a slot keeps it template-fillable and gives it the slot's placeholder metadata.
|
|
12444
|
-
* A reference that is missing or resolves to a non-image slot paints no background.
|
|
12445
|
-
*/
|
|
12446
|
-
slotId: string;
|
|
12866
|
+
export declare interface IPublisherDocumentSectionsContentV2 extends IPublisherDocumentContentBaseV2 {
|
|
12867
|
+
sections: IPublisherSectionV2[];
|
|
12868
|
+
pages?: never;
|
|
12447
12869
|
}
|
|
12448
12870
|
|
|
12449
12871
|
/**
|
|
12450
|
-
*
|
|
12872
|
+
* Style of the area behind the pages. Exports ignore it.
|
|
12451
12873
|
*
|
|
12452
12874
|
* @alpha
|
|
12453
12875
|
*/
|
|
12454
|
-
export declare interface
|
|
12455
|
-
type: "image";
|
|
12456
|
-
/**
|
|
12457
|
-
* Undefined = declared-but-empty slot.
|
|
12458
|
-
*/
|
|
12459
|
-
source?: PublisherImageSource;
|
|
12460
|
-
altText?: string;
|
|
12876
|
+
export declare interface IPublisherDocumentStyleV2 extends IPublisherBackgroundStyleV2 {
|
|
12461
12877
|
/**
|
|
12462
|
-
*
|
|
12463
|
-
*/
|
|
12464
|
-
fit?: PublisherImageFit;
|
|
12465
|
-
/**
|
|
12466
|
-
* Placement overrides for the drawn image; centered on both axes by default.
|
|
12878
|
+
* Space between pages in the viewer and the editor.
|
|
12467
12879
|
*/
|
|
12468
|
-
|
|
12880
|
+
gap?: PublisherGapValueV2;
|
|
12469
12881
|
}
|
|
12470
12882
|
|
|
12471
12883
|
/**
|
|
12472
|
-
*
|
|
12473
|
-
* is cropped to fill one.
|
|
12884
|
+
* Current version of {@link IPublisherDocumentTemplateV1}.
|
|
12474
12885
|
*
|
|
12475
12886
|
* @alpha
|
|
12476
12887
|
*/
|
|
12477
|
-
export declare
|
|
12478
|
-
horizontalAlign?: PublisherContentAlignment;
|
|
12479
|
-
verticalAlign?: PublisherContentAlignment;
|
|
12480
|
-
}
|
|
12888
|
+
export declare type IPublisherDocumentTemplate = IPublisherDocumentTemplateV1;
|
|
12481
12889
|
|
|
12482
12890
|
/**
|
|
12483
|
-
*
|
|
12891
|
+
* Current version of {@link IPublisherDocumentTemplateDefinitionV1}.
|
|
12484
12892
|
*
|
|
12485
12893
|
* @alpha
|
|
12486
12894
|
*/
|
|
12487
|
-
export declare
|
|
12488
|
-
/**
|
|
12489
|
-
* Fractional weight of this node inside its parent (flex-grow semantics).
|
|
12490
|
-
* Defaults to 1. Example: sibling weights [2, 1] render a 2/3 + 1/3 split.
|
|
12491
|
-
*/
|
|
12492
|
-
weight?: number;
|
|
12493
|
-
}
|
|
12895
|
+
export declare type IPublisherDocumentTemplateDefinition = IPublisherDocumentTemplateDefinitionV1;
|
|
12494
12896
|
|
|
12495
12897
|
/**
|
|
12496
|
-
*
|
|
12898
|
+
* Payload for creating or updating a document template.
|
|
12497
12899
|
*
|
|
12498
12900
|
* @alpha
|
|
12499
12901
|
*/
|
|
12500
|
-
export declare interface
|
|
12501
|
-
type: "
|
|
12502
|
-
/**
|
|
12503
|
-
* "row" lays children out horizontally, "column" vertically.
|
|
12504
|
-
*/
|
|
12505
|
-
direction: "row" | "column";
|
|
12506
|
-
children: PublisherPageLayoutNode[];
|
|
12902
|
+
export declare interface IPublisherDocumentTemplateDefinitionV1 {
|
|
12903
|
+
type: "reportTemplate";
|
|
12507
12904
|
/**
|
|
12508
|
-
*
|
|
12905
|
+
* Present when updating an existing template.
|
|
12509
12906
|
*/
|
|
12510
|
-
|
|
12907
|
+
ref?: ObjRef;
|
|
12908
|
+
title: string;
|
|
12909
|
+
description?: string;
|
|
12910
|
+
tags?: string[];
|
|
12911
|
+
content: IPublisherDocumentContentV1;
|
|
12511
12912
|
}
|
|
12512
12913
|
|
|
12513
12914
|
/**
|
|
12514
|
-
*
|
|
12915
|
+
* Payload for creating or updating a document template.
|
|
12515
12916
|
*
|
|
12516
12917
|
* @alpha
|
|
12517
12918
|
*/
|
|
12518
|
-
export declare interface
|
|
12519
|
-
type: "
|
|
12520
|
-
|
|
12521
|
-
* Local identifier of a slot in {@link IPublisherPageBody.slots}.
|
|
12522
|
-
* A slotId with no matching slot renders as an empty area.
|
|
12523
|
-
*/
|
|
12524
|
-
slotId: string;
|
|
12919
|
+
export declare interface IPublisherDocumentTemplateDefinitionV2 extends IPublisherEntityDefinitionBaseV2 {
|
|
12920
|
+
type: "documentTemplate";
|
|
12921
|
+
content: PublisherDocumentContentV2;
|
|
12525
12922
|
}
|
|
12526
12923
|
|
|
12527
12924
|
/**
|
|
12528
|
-
*
|
|
12529
|
-
*
|
|
12530
|
-
* @remarks
|
|
12531
|
-
* This is both the content of the standalone {@link IPublisherPageLayout} object and the shape
|
|
12532
|
-
* embedded in template/document content ({@link IPublisherDocumentPage}).
|
|
12533
|
-
*
|
|
12534
|
-
* There is no header/footer chrome: page title, description, footer, page numbers and
|
|
12535
|
-
* logos are ordinary slots in the layout tree (text slots with `{currentPageNumber}`/`{totalPages}`,
|
|
12536
|
-
* an image slot with `{logo}`). Every slot fills its layout area completely.
|
|
12925
|
+
* Document template metadata object.
|
|
12537
12926
|
*
|
|
12538
12927
|
* @alpha
|
|
12539
12928
|
*/
|
|
12540
|
-
export declare interface
|
|
12541
|
-
|
|
12542
|
-
* Editor hint only (template galleries, default styling, AI context).
|
|
12543
|
-
* Renderers must not branch layout logic on it — geometry always comes from `layout`.
|
|
12544
|
-
*/
|
|
12545
|
-
kind?: "cover" | "section" | "content";
|
|
12546
|
-
/**
|
|
12547
|
-
* Page proportions the layout was authored for. Defaults to
|
|
12548
|
-
* {@link DefaultPublisherPageFormat}.
|
|
12549
|
-
*/
|
|
12550
|
-
format?: PublisherPageFormat;
|
|
12551
|
-
/**
|
|
12552
|
-
* Paint of the page itself, behind everything the layout places.
|
|
12553
|
-
*/
|
|
12554
|
-
style?: IPublisherBoxStyle;
|
|
12555
|
-
/**
|
|
12556
|
-
* Root of the page layout tree.
|
|
12557
|
-
*/
|
|
12558
|
-
layout: PublisherPageLayoutNode;
|
|
12559
|
-
/**
|
|
12560
|
-
* All slots referenced by the layout, flat, keyed by localIdentifier.
|
|
12561
|
-
*/
|
|
12562
|
-
slots: PublisherSlot[];
|
|
12929
|
+
export declare interface IPublisherDocumentTemplateV1 extends IPublisherDocumentTemplateDefinitionV1, IAuditableDates, IAuditableUsers {
|
|
12930
|
+
ref: ObjRef;
|
|
12563
12931
|
/**
|
|
12564
|
-
*
|
|
12565
|
-
*
|
|
12932
|
+
* When true, the object comes from a parent workspace and is not editable
|
|
12933
|
+
* in the current workspace.
|
|
12566
12934
|
*/
|
|
12567
|
-
|
|
12935
|
+
isLocked?: boolean;
|
|
12568
12936
|
}
|
|
12569
12937
|
|
|
12570
12938
|
/**
|
|
12571
|
-
*
|
|
12939
|
+
* Document template metadata object.
|
|
12572
12940
|
*
|
|
12573
12941
|
* @alpha
|
|
12574
12942
|
*/
|
|
12575
|
-
export declare interface
|
|
12576
|
-
|
|
12577
|
-
message: string;
|
|
12943
|
+
export declare interface IPublisherDocumentTemplateV2 extends IPublisherDocumentTemplateDefinitionV2, IPublisherEntityMetadataV2 {
|
|
12944
|
+
ref: ObjRef;
|
|
12578
12945
|
}
|
|
12579
12946
|
|
|
12580
12947
|
/**
|
|
12581
|
-
*
|
|
12948
|
+
* Document metadata object.
|
|
12582
12949
|
*
|
|
12583
12950
|
* @alpha
|
|
12584
12951
|
*/
|
|
12585
|
-
export declare interface
|
|
12952
|
+
export declare interface IPublisherDocumentV1 extends IPublisherDocumentDefinitionV1, IAuditableDates, IAuditableUsers {
|
|
12586
12953
|
ref: ObjRef;
|
|
12587
12954
|
/**
|
|
12588
12955
|
* When true, the object comes from a parent workspace and is not editable
|
|
12589
12956
|
* in the current workspace.
|
|
12590
12957
|
*/
|
|
12591
12958
|
isLocked?: boolean;
|
|
12592
|
-
/**
|
|
12593
|
-
* Predefined page shipped with the product, populated by the SPI. Never sent to or
|
|
12594
|
-
* stored on the backend; UI must disable deletion and editing of built-in pages.
|
|
12595
|
-
*/
|
|
12596
|
-
isBuiltIn?: boolean;
|
|
12597
12959
|
}
|
|
12598
12960
|
|
|
12599
12961
|
/**
|
|
12600
|
-
*
|
|
12962
|
+
* Document metadata object.
|
|
12601
12963
|
*
|
|
12602
12964
|
* @alpha
|
|
12603
12965
|
*/
|
|
12604
|
-
export declare interface
|
|
12605
|
-
|
|
12606
|
-
* Content model version, for stored-content evolution.
|
|
12607
|
-
*/
|
|
12608
|
-
version: "1";
|
|
12966
|
+
export declare interface IPublisherDocumentV2 extends IPublisherDocumentDefinitionV2, IPublisherEntityMetadataV2 {
|
|
12967
|
+
ref: ObjRef;
|
|
12609
12968
|
}
|
|
12610
12969
|
|
|
12611
12970
|
/**
|
|
12612
|
-
*
|
|
12971
|
+
* Fields shared by the definitions of all Publisher entities.
|
|
12613
12972
|
*
|
|
12614
12973
|
* @alpha
|
|
12615
12974
|
*/
|
|
12616
|
-
export declare interface
|
|
12617
|
-
type: "reportPageLayout";
|
|
12975
|
+
export declare interface IPublisherEntityDefinitionBaseV2 {
|
|
12618
12976
|
/**
|
|
12619
|
-
* Present when updating an existing
|
|
12977
|
+
* Present when updating an existing entity.
|
|
12620
12978
|
*/
|
|
12621
12979
|
ref?: ObjRef;
|
|
12622
12980
|
title: string;
|
|
12623
12981
|
description?: string;
|
|
12624
12982
|
tags?: string[];
|
|
12625
|
-
|
|
12983
|
+
version: PublisherContentVersionV2;
|
|
12626
12984
|
}
|
|
12627
12985
|
|
|
12628
12986
|
/**
|
|
12629
|
-
*
|
|
12987
|
+
* Fields shared by all persisted Publisher entities.
|
|
12630
12988
|
*
|
|
12631
12989
|
* @alpha
|
|
12632
12990
|
*/
|
|
12633
|
-
export declare interface
|
|
12634
|
-
|
|
12635
|
-
style?: IPublisherParagraphStyle;
|
|
12991
|
+
export declare interface IPublisherEntityMetadataV2 extends IAuditableDates, IAuditableUsers {
|
|
12992
|
+
ref: ObjRef;
|
|
12636
12993
|
/**
|
|
12637
|
-
*
|
|
12994
|
+
* When true, the object comes from a parent workspace and is not editable
|
|
12995
|
+
* in the current workspace.
|
|
12638
12996
|
*/
|
|
12639
|
-
|
|
12997
|
+
isLocked?: boolean;
|
|
12640
12998
|
}
|
|
12641
12999
|
|
|
12642
13000
|
/**
|
|
12643
|
-
*
|
|
13001
|
+
* Current version of {@link IPublisherHeadingSlotV1}.
|
|
12644
13002
|
*
|
|
12645
13003
|
* @alpha
|
|
12646
13004
|
*/
|
|
12647
|
-
export declare
|
|
12648
|
-
/**
|
|
12649
|
-
* Defaults to {@link DefaultPublisherParagraphType}.
|
|
12650
|
-
*/
|
|
12651
|
-
type?: PublisherParagraphType;
|
|
12652
|
-
}
|
|
13005
|
+
export declare type IPublisherHeadingSlot = IPublisherHeadingSlotV1;
|
|
12653
13006
|
|
|
12654
13007
|
/**
|
|
12655
|
-
*
|
|
13008
|
+
* Slot rendering a heading.
|
|
12656
13009
|
*
|
|
12657
13010
|
* @remarks
|
|
12658
|
-
*
|
|
12659
|
-
*
|
|
13011
|
+
* A heading is a line of display text, so it carries no markup of its own: what is typed in it is
|
|
13012
|
+
* what it renders.
|
|
12660
13013
|
*
|
|
12661
13014
|
* @alpha
|
|
12662
13015
|
*/
|
|
12663
|
-
export declare interface
|
|
12664
|
-
type:
|
|
12665
|
-
|
|
12666
|
-
* Identifier unique within the page body. The layout tree references it, and it is
|
|
12667
|
-
* the join key when a document fills a template's slots. Regenerated when a page is
|
|
12668
|
-
* cloned into template content so repeated use of one page stays unique.
|
|
12669
|
-
*/
|
|
12670
|
-
localIdentifier: string;
|
|
13016
|
+
export declare interface IPublisherHeadingSlotV1 extends IPublisherSlotBaseV1 {
|
|
13017
|
+
type: "heading";
|
|
13018
|
+
style?: IPublisherHeadingStyleV1;
|
|
12671
13019
|
/**
|
|
12672
|
-
*
|
|
13020
|
+
* Undefined = declared-but-empty slot.
|
|
12673
13021
|
*/
|
|
12674
|
-
|
|
13022
|
+
source?: PublisherTextSourceV1;
|
|
12675
13023
|
}
|
|
12676
13024
|
|
|
12677
13025
|
/**
|
|
12678
|
-
*
|
|
13026
|
+
* Current version of {@link IPublisherHeadingStyleV1}.
|
|
12679
13027
|
*
|
|
12680
13028
|
* @alpha
|
|
12681
13029
|
*/
|
|
12682
|
-
export declare
|
|
12683
|
-
|
|
12684
|
-
|
|
12685
|
-
|
|
12686
|
-
|
|
13030
|
+
export declare type IPublisherHeadingStyle = IPublisherHeadingStyleV1;
|
|
13031
|
+
|
|
13032
|
+
/**
|
|
13033
|
+
* Styling of a heading slot.
|
|
13034
|
+
*
|
|
13035
|
+
* @alpha
|
|
13036
|
+
*/
|
|
13037
|
+
export declare interface IPublisherHeadingStyleV1 extends IPublisherTextStyleV1 {
|
|
12687
13038
|
/**
|
|
12688
|
-
*
|
|
13039
|
+
* Defaults to {@link DefaultPublisherHeadingTypeV1}. The size owns the semantic typography that goes
|
|
13040
|
+
* with it; the rest of the style overrides ink and placement on top of it.
|
|
12689
13041
|
*/
|
|
12690
|
-
|
|
13042
|
+
type?: PublisherHeadingTypeV1;
|
|
12691
13043
|
}
|
|
12692
13044
|
|
|
12693
13045
|
/**
|
|
12694
|
-
* Author-written text.
|
|
12695
|
-
*
|
|
12696
13046
|
* @alpha
|
|
12697
13047
|
*/
|
|
12698
|
-
export declare interface
|
|
12699
|
-
type: "
|
|
13048
|
+
export declare interface IPublisherHeadingWidgetV2 extends IPublisherWidgetBaseV2 {
|
|
13049
|
+
type: "heading";
|
|
12700
13050
|
/**
|
|
12701
|
-
*
|
|
12702
|
-
* resolved only at render/export time.
|
|
13051
|
+
* Inline markdown only.
|
|
12703
13052
|
*/
|
|
12704
|
-
|
|
13053
|
+
markdown?: string;
|
|
13054
|
+
/**
|
|
13055
|
+
* Outline level below the page title, independent of the text style. Defaults to 1.
|
|
13056
|
+
*/
|
|
13057
|
+
level?: PublisherHeadingLevelV2;
|
|
13058
|
+
/**
|
|
13059
|
+
* `textStyle` defaults to {@link publisherHeadingDefaultTextStyleV2} of the level.
|
|
13060
|
+
*/
|
|
13061
|
+
style?: IPublisherTextWidgetStyleV2;
|
|
12705
13062
|
}
|
|
12706
13063
|
|
|
12707
13064
|
/**
|
|
12708
|
-
* Slot rendering text of either kind.
|
|
12709
|
-
*
|
|
12710
13065
|
* @alpha
|
|
12711
13066
|
*/
|
|
12712
|
-
export declare
|
|
13067
|
+
export declare interface IPublisherHeadlineStyleV2 {
|
|
13068
|
+
primaryValueColor?: PublisherColorValueV2;
|
|
13069
|
+
primaryValueSize?: PublisherPxV2;
|
|
13070
|
+
secondaryValueColor?: PublisherColorValueV2;
|
|
13071
|
+
secondaryValueSize?: PublisherPxV2;
|
|
13072
|
+
positiveColor?: PublisherColorValueV2;
|
|
13073
|
+
negativeColor?: PublisherColorValueV2;
|
|
13074
|
+
}
|
|
13075
|
+
|
|
13076
|
+
/**
|
|
13077
|
+
* Current version of {@link IPublisherImageBackgroundV1}.
|
|
13078
|
+
*
|
|
13079
|
+
* @alpha
|
|
13080
|
+
*/
|
|
13081
|
+
export declare type IPublisherImageBackground = IPublisherImageBackgroundV1;
|
|
13082
|
+
|
|
13083
|
+
/**
|
|
13084
|
+
* Image painted behind a section's or page's content.
|
|
13085
|
+
*
|
|
13086
|
+
* @alpha
|
|
13087
|
+
*/
|
|
13088
|
+
export declare interface IPublisherImageBackgroundV1 {
|
|
13089
|
+
type: "image";
|
|
13090
|
+
/**
|
|
13091
|
+
* Local identifier of an image slot in {@link IPublisherPageBodyV1.slots}. Routing the image
|
|
13092
|
+
* through a slot keeps it template-fillable and gives it the slot's placeholder metadata.
|
|
13093
|
+
* A reference that is missing or resolves to a non-image slot paints no background.
|
|
13094
|
+
*/
|
|
13095
|
+
slotId: string;
|
|
13096
|
+
}
|
|
13097
|
+
|
|
13098
|
+
/**
|
|
13099
|
+
* Current version of {@link IPublisherImageSlotV1}.
|
|
13100
|
+
*
|
|
13101
|
+
* @alpha
|
|
13102
|
+
*/
|
|
13103
|
+
export declare type IPublisherImageSlot = IPublisherImageSlotV1;
|
|
13104
|
+
|
|
13105
|
+
/**
|
|
13106
|
+
* Slot rendering an image.
|
|
13107
|
+
*
|
|
13108
|
+
* @alpha
|
|
13109
|
+
*/
|
|
13110
|
+
export declare interface IPublisherImageSlotV1 extends IPublisherSlotBaseV1 {
|
|
13111
|
+
type: "image";
|
|
13112
|
+
/**
|
|
13113
|
+
* Undefined = declared-but-empty slot.
|
|
13114
|
+
*/
|
|
13115
|
+
source?: PublisherImageSourceV1;
|
|
13116
|
+
altText?: string;
|
|
13117
|
+
/**
|
|
13118
|
+
* How the image fills the slot area. Defaults to "contain".
|
|
13119
|
+
*/
|
|
13120
|
+
fit?: PublisherImageFitV1;
|
|
13121
|
+
/**
|
|
13122
|
+
* Placement overrides for the drawn image; centered on both axes by default.
|
|
13123
|
+
*/
|
|
13124
|
+
style?: IPublisherImageStyleV1;
|
|
13125
|
+
}
|
|
13126
|
+
|
|
13127
|
+
/**
|
|
13128
|
+
* Current version of {@link IPublisherImageStyleV1}.
|
|
13129
|
+
*
|
|
13130
|
+
* @alpha
|
|
13131
|
+
*/
|
|
13132
|
+
export declare type IPublisherImageStyle = IPublisherImageStyleV1;
|
|
13133
|
+
|
|
13134
|
+
/**
|
|
13135
|
+
* Where the drawn image sits when it does not fill its box, and which part of it is kept when it
|
|
13136
|
+
* is cropped to fill one.
|
|
13137
|
+
*
|
|
13138
|
+
* @alpha
|
|
13139
|
+
*/
|
|
13140
|
+
export declare interface IPublisherImageStyleV1 {
|
|
13141
|
+
horizontalAlign?: PublisherContentAlignmentV1;
|
|
13142
|
+
verticalAlign?: PublisherContentAlignmentV1;
|
|
13143
|
+
}
|
|
13144
|
+
|
|
13145
|
+
/**
|
|
13146
|
+
* @alpha
|
|
13147
|
+
*/
|
|
13148
|
+
export declare interface IPublisherImageWidgetStyleV2 extends IPublisherBoxStyleV2 {
|
|
13149
|
+
/**
|
|
13150
|
+
* Defaults to `contain`.
|
|
13151
|
+
*/
|
|
13152
|
+
fit?: "contain" | "cover" | "fill";
|
|
13153
|
+
horizontalAlign?: PublisherHorizontalAlignV2;
|
|
13154
|
+
verticalAlign?: PublisherVerticalAlignV2;
|
|
13155
|
+
}
|
|
13156
|
+
|
|
13157
|
+
/**
|
|
13158
|
+
* @alpha
|
|
13159
|
+
*/
|
|
13160
|
+
export declare interface IPublisherImageWidgetV2 extends IPublisherWidgetBaseV2 {
|
|
13161
|
+
type: "image";
|
|
13162
|
+
source?: PublisherImageSourceV2;
|
|
13163
|
+
altText?: string;
|
|
13164
|
+
decorative?: boolean;
|
|
13165
|
+
style?: IPublisherImageWidgetStyleV2;
|
|
13166
|
+
}
|
|
13167
|
+
|
|
13168
|
+
/**
|
|
13169
|
+
* Text keys that a page or container passes down to the content inside, unless a widget sets its own.
|
|
13170
|
+
*
|
|
13171
|
+
* @alpha
|
|
13172
|
+
*/
|
|
13173
|
+
export declare interface IPublisherInheritedTextStyleV2 {
|
|
13174
|
+
textStyle?: PublisherTextStyleNameV2;
|
|
13175
|
+
textColor?: PublisherColorValueV2;
|
|
13176
|
+
/**
|
|
13177
|
+
* `justify` applies to text only.
|
|
13178
|
+
*/
|
|
13179
|
+
horizontalAlign?: PublisherHorizontalAlignV2 | "justify";
|
|
13180
|
+
verticalAlign?: PublisherVerticalAlignV2;
|
|
13181
|
+
}
|
|
13182
|
+
|
|
13183
|
+
/**
|
|
13184
|
+
* Current version of {@link IPublisherLayoutNodeBaseV1}.
|
|
13185
|
+
*
|
|
13186
|
+
* @alpha
|
|
13187
|
+
*/
|
|
13188
|
+
export declare type IPublisherLayoutNodeBase = IPublisherLayoutNodeBaseV1;
|
|
13189
|
+
|
|
13190
|
+
/**
|
|
13191
|
+
* Fields common to all page layout nodes.
|
|
13192
|
+
*
|
|
13193
|
+
* @alpha
|
|
13194
|
+
*/
|
|
13195
|
+
export declare interface IPublisherLayoutNodeBaseV1 {
|
|
13196
|
+
/**
|
|
13197
|
+
* Fractional weight of this node inside its parent (flex-grow semantics).
|
|
13198
|
+
* Defaults to 1. Example: sibling weights [2, 1] render a 2/3 + 1/3 split.
|
|
13199
|
+
*/
|
|
13200
|
+
weight?: number;
|
|
13201
|
+
}
|
|
13202
|
+
|
|
13203
|
+
/**
|
|
13204
|
+
* Current version of {@link IPublisherLayoutSectionV1}.
|
|
13205
|
+
*
|
|
13206
|
+
* @alpha
|
|
13207
|
+
*/
|
|
13208
|
+
export declare type IPublisherLayoutSection = IPublisherLayoutSectionV1;
|
|
13209
|
+
|
|
13210
|
+
/**
|
|
13211
|
+
* A container splitting its area into children laid out along a direction.
|
|
13212
|
+
*
|
|
13213
|
+
* @alpha
|
|
13214
|
+
*/
|
|
13215
|
+
export declare interface IPublisherLayoutSectionV1 extends IPublisherLayoutNodeBaseV1 {
|
|
13216
|
+
type: "section";
|
|
13217
|
+
/**
|
|
13218
|
+
* "row" lays children out horizontally, "column" vertically.
|
|
13219
|
+
*/
|
|
13220
|
+
direction: "row" | "column";
|
|
13221
|
+
children: PublisherPageLayoutNodeV1[];
|
|
13222
|
+
/**
|
|
13223
|
+
* Paint of this section's box. Never affects how children are laid out.
|
|
13224
|
+
*/
|
|
13225
|
+
style?: IPublisherBoxStyleV1;
|
|
13226
|
+
}
|
|
13227
|
+
|
|
13228
|
+
/**
|
|
13229
|
+
* Current version of {@link IPublisherLayoutSlotRefV1}.
|
|
13230
|
+
*
|
|
13231
|
+
* @alpha
|
|
13232
|
+
*/
|
|
13233
|
+
export declare type IPublisherLayoutSlotRef = IPublisherLayoutSlotRefV1;
|
|
13234
|
+
|
|
13235
|
+
/**
|
|
13236
|
+
* A leaf assigning its area to a slot. The slot fills the area completely.
|
|
13237
|
+
*
|
|
13238
|
+
* @alpha
|
|
13239
|
+
*/
|
|
13240
|
+
export declare interface IPublisherLayoutSlotRefV1 extends IPublisherLayoutNodeBaseV1 {
|
|
13241
|
+
type: "slotRef";
|
|
13242
|
+
/**
|
|
13243
|
+
* Local identifier of a slot in {@link IPublisherPageBodyV1.slots}.
|
|
13244
|
+
* A slotId with no matching slot renders as an empty area.
|
|
13245
|
+
*/
|
|
13246
|
+
slotId: string;
|
|
13247
|
+
}
|
|
13248
|
+
|
|
13249
|
+
/**
|
|
13250
|
+
* @remarks
|
|
13251
|
+
* A side key wins over `padding` in any order.
|
|
13252
|
+
*
|
|
13253
|
+
* @alpha
|
|
13254
|
+
*/
|
|
13255
|
+
export declare interface IPublisherPaddingStyleV2 {
|
|
13256
|
+
padding?: PublisherPaddingValueV2;
|
|
13257
|
+
paddingTop?: PublisherPaddingValueV2;
|
|
13258
|
+
paddingRight?: PublisherPaddingValueV2;
|
|
13259
|
+
paddingBottom?: PublisherPaddingValueV2;
|
|
13260
|
+
paddingLeft?: PublisherPaddingValueV2;
|
|
13261
|
+
}
|
|
13262
|
+
|
|
13263
|
+
/**
|
|
13264
|
+
* Current version of {@link IPublisherPageBodyV1}.
|
|
13265
|
+
*
|
|
13266
|
+
* @alpha
|
|
13267
|
+
*/
|
|
13268
|
+
export declare type IPublisherPageBody = IPublisherPageBodyV1;
|
|
13269
|
+
|
|
13270
|
+
/**
|
|
13271
|
+
* Body of a document page: geometry (flex split tree) plus the slots it places.
|
|
13272
|
+
*
|
|
13273
|
+
* @remarks
|
|
13274
|
+
* This is both the content of the standalone {@link IPublisherPageLayoutV1} object and the shape
|
|
13275
|
+
* embedded in template/document content ({@link IPublisherDocumentPageV1}).
|
|
13276
|
+
*
|
|
13277
|
+
* There is no header/footer chrome: page title, description, footer, page numbers and
|
|
13278
|
+
* logos are ordinary slots in the layout tree (text slots with `{currentPageNumber}`/`{totalPages}`,
|
|
13279
|
+
* an image slot with `{logo}`). Every slot fills its layout area completely.
|
|
13280
|
+
*
|
|
13281
|
+
* @alpha
|
|
13282
|
+
*/
|
|
13283
|
+
export declare interface IPublisherPageBodyV1 {
|
|
13284
|
+
/**
|
|
13285
|
+
* Editor hint only (template galleries, default styling, AI context).
|
|
13286
|
+
* Renderers must not branch layout logic on it — geometry always comes from `layout`.
|
|
13287
|
+
*/
|
|
13288
|
+
kind?: "cover" | "section" | "content";
|
|
13289
|
+
/**
|
|
13290
|
+
* Page proportions the layout was authored for. Defaults to
|
|
13291
|
+
* {@link DefaultPublisherPageFormatV1}.
|
|
13292
|
+
*/
|
|
13293
|
+
format?: PublisherPageFormatV1;
|
|
13294
|
+
/**
|
|
13295
|
+
* Paint of the page itself, behind everything the layout places.
|
|
13296
|
+
*/
|
|
13297
|
+
style?: IPublisherBoxStyleV1;
|
|
13298
|
+
/**
|
|
13299
|
+
* Root of the page layout tree.
|
|
13300
|
+
*/
|
|
13301
|
+
layout: PublisherPageLayoutNodeV1;
|
|
13302
|
+
/**
|
|
13303
|
+
* All slots referenced by the layout, flat, keyed by localIdentifier.
|
|
13304
|
+
*/
|
|
13305
|
+
slots: PublisherSlotV1[];
|
|
13306
|
+
/**
|
|
13307
|
+
* Page-level filters: merged over content-level filters (a filter targeting the
|
|
13308
|
+
* same object replaces the inherited one); slot filters apply on top.
|
|
13309
|
+
*/
|
|
13310
|
+
filters?: FilterContextItem[];
|
|
13311
|
+
}
|
|
13312
|
+
|
|
13313
|
+
/**
|
|
13314
|
+
* Content of one page, as a page template stores it.
|
|
13315
|
+
*
|
|
13316
|
+
* @alpha
|
|
13317
|
+
*/
|
|
13318
|
+
export declare interface IPublisherPageBodyV2 {
|
|
13319
|
+
kind?: PublisherPageKindV2;
|
|
13320
|
+
pageSize?: PublisherPageSizeV2;
|
|
13321
|
+
/**
|
|
13322
|
+
* Markdown speaker notes, never drawn on the page.
|
|
13323
|
+
*/
|
|
13324
|
+
notes?: string;
|
|
13325
|
+
style?: IPublisherPageStyleV2;
|
|
13326
|
+
layout: PublisherLayoutNodeV2;
|
|
13327
|
+
filters?: FilterContextItem[];
|
|
13328
|
+
}
|
|
13329
|
+
|
|
13330
|
+
/**
|
|
13331
|
+
* Current version of {@link IPublisherPageBodyValidationIssueV1}.
|
|
13332
|
+
*
|
|
13333
|
+
* @alpha
|
|
13334
|
+
*/
|
|
13335
|
+
export declare type IPublisherPageBodyValidationIssue = IPublisherPageBodyValidationIssueV1;
|
|
13336
|
+
|
|
13337
|
+
/**
|
|
13338
|
+
* Validation issue found in a page body.
|
|
13339
|
+
*
|
|
13340
|
+
* @alpha
|
|
13341
|
+
*/
|
|
13342
|
+
export declare interface IPublisherPageBodyValidationIssueV1 {
|
|
13343
|
+
severity: "error" | "warning";
|
|
13344
|
+
message: string;
|
|
13345
|
+
}
|
|
13346
|
+
|
|
13347
|
+
/**
|
|
13348
|
+
* Current version of {@link IPublisherPageLayoutV1}.
|
|
13349
|
+
*
|
|
13350
|
+
* @alpha
|
|
13351
|
+
*/
|
|
13352
|
+
export declare type IPublisherPageLayout = IPublisherPageLayoutV1;
|
|
13353
|
+
|
|
13354
|
+
/**
|
|
13355
|
+
* Current version of {@link IPublisherPageLayoutContentV1}.
|
|
13356
|
+
*
|
|
13357
|
+
* @alpha
|
|
13358
|
+
*/
|
|
13359
|
+
export declare type IPublisherPageLayoutContent = IPublisherPageLayoutContentV1;
|
|
13360
|
+
|
|
13361
|
+
/**
|
|
13362
|
+
* Stored content of the reportPage entity.
|
|
13363
|
+
*
|
|
13364
|
+
* @alpha
|
|
13365
|
+
*/
|
|
13366
|
+
export declare interface IPublisherPageLayoutContentV1 extends IPublisherPageBodyV1 {
|
|
13367
|
+
/**
|
|
13368
|
+
* Content model version, for stored-content evolution.
|
|
13369
|
+
*/
|
|
13370
|
+
version: "1";
|
|
13371
|
+
}
|
|
13372
|
+
|
|
13373
|
+
/**
|
|
13374
|
+
* Current version of {@link IPublisherPageLayoutDefinitionV1}.
|
|
13375
|
+
*
|
|
13376
|
+
* @alpha
|
|
13377
|
+
*/
|
|
13378
|
+
export declare type IPublisherPageLayoutDefinition = IPublisherPageLayoutDefinitionV1;
|
|
13379
|
+
|
|
13380
|
+
/**
|
|
13381
|
+
* Payload for creating or updating a page layout.
|
|
13382
|
+
*
|
|
13383
|
+
* @alpha
|
|
13384
|
+
*/
|
|
13385
|
+
export declare interface IPublisherPageLayoutDefinitionV1 {
|
|
13386
|
+
type: "reportPageLayout";
|
|
13387
|
+
/**
|
|
13388
|
+
* Present when updating an existing page.
|
|
13389
|
+
*/
|
|
13390
|
+
ref?: ObjRef;
|
|
13391
|
+
title: string;
|
|
13392
|
+
description?: string;
|
|
13393
|
+
tags?: string[];
|
|
13394
|
+
content: IPublisherPageLayoutContentV1;
|
|
13395
|
+
}
|
|
13396
|
+
|
|
13397
|
+
/**
|
|
13398
|
+
* Reusable page layout metadata object.
|
|
13399
|
+
*
|
|
13400
|
+
* @alpha
|
|
13401
|
+
*/
|
|
13402
|
+
export declare interface IPublisherPageLayoutV1 extends IPublisherPageLayoutDefinitionV1, IAuditableDates, IAuditableUsers {
|
|
13403
|
+
ref: ObjRef;
|
|
13404
|
+
/**
|
|
13405
|
+
* When true, the object comes from a parent workspace and is not editable
|
|
13406
|
+
* in the current workspace.
|
|
13407
|
+
*/
|
|
13408
|
+
isLocked?: boolean;
|
|
13409
|
+
/**
|
|
13410
|
+
* Predefined page shipped with the product, populated by the SPI. Never sent to or
|
|
13411
|
+
* stored on the backend; UI must disable deletion and editing of built-in pages.
|
|
13412
|
+
*/
|
|
13413
|
+
isBuiltIn?: boolean;
|
|
13414
|
+
}
|
|
13415
|
+
|
|
13416
|
+
/**
|
|
13417
|
+
* @alpha
|
|
13418
|
+
*/
|
|
13419
|
+
export declare interface IPublisherPageStyleV2 extends IPublisherBackgroundStyleV2, IPublisherPaddingStyleV2, IPublisherInheritedTextStyleV2 {
|
|
13420
|
+
/**
|
|
13421
|
+
* Default gap of every container on the page.
|
|
13422
|
+
*/
|
|
13423
|
+
gap?: PublisherGapValueV2;
|
|
13424
|
+
}
|
|
13425
|
+
|
|
13426
|
+
/**
|
|
13427
|
+
* Payload for creating or updating a page template.
|
|
13428
|
+
*
|
|
13429
|
+
* @alpha
|
|
13430
|
+
*/
|
|
13431
|
+
export declare interface IPublisherPageTemplateDefinitionV2 extends IPublisherEntityDefinitionBaseV2 {
|
|
13432
|
+
type: "pageTemplate";
|
|
13433
|
+
content: IPublisherPageBodyV2;
|
|
13434
|
+
}
|
|
13435
|
+
|
|
13436
|
+
/**
|
|
13437
|
+
* Page template metadata object.
|
|
13438
|
+
*
|
|
13439
|
+
* @alpha
|
|
13440
|
+
*/
|
|
13441
|
+
export declare interface IPublisherPageTemplateV2 extends IPublisherPageTemplateDefinitionV2, IPublisherEntityMetadataV2 {
|
|
13442
|
+
ref: ObjRef;
|
|
13443
|
+
/**
|
|
13444
|
+
* True for the default page templates the backend serves. Their ids start with `default.`.
|
|
13445
|
+
*/
|
|
13446
|
+
isDefault?: boolean;
|
|
13447
|
+
}
|
|
13448
|
+
|
|
13449
|
+
/**
|
|
13450
|
+
* Current version of {@link IPublisherParagraphSlotV1}.
|
|
13451
|
+
*
|
|
13452
|
+
* @alpha
|
|
13453
|
+
*/
|
|
13454
|
+
export declare type IPublisherParagraphSlot = IPublisherParagraphSlotV1;
|
|
13455
|
+
|
|
13456
|
+
/**
|
|
13457
|
+
* Slot rendering prose, written as markdown.
|
|
13458
|
+
*
|
|
13459
|
+
* @alpha
|
|
13460
|
+
*/
|
|
13461
|
+
export declare interface IPublisherParagraphSlotV1 extends IPublisherSlotBaseV1 {
|
|
13462
|
+
type: "paragraph";
|
|
13463
|
+
style?: IPublisherParagraphStyleV1;
|
|
13464
|
+
/**
|
|
13465
|
+
* Undefined = declared-but-empty slot.
|
|
13466
|
+
*/
|
|
13467
|
+
source?: PublisherTextSourceV1;
|
|
13468
|
+
}
|
|
13469
|
+
|
|
13470
|
+
/**
|
|
13471
|
+
* Current version of {@link IPublisherParagraphStyleV1}.
|
|
13472
|
+
*
|
|
13473
|
+
* @alpha
|
|
13474
|
+
*/
|
|
13475
|
+
export declare type IPublisherParagraphStyle = IPublisherParagraphStyleV1;
|
|
13476
|
+
|
|
13477
|
+
/**
|
|
13478
|
+
* Styling of a paragraph slot.
|
|
13479
|
+
*
|
|
13480
|
+
* @alpha
|
|
13481
|
+
*/
|
|
13482
|
+
export declare interface IPublisherParagraphStyleV1 extends IPublisherTextStyleV1 {
|
|
13483
|
+
/**
|
|
13484
|
+
* Defaults to {@link DefaultPublisherParagraphTypeV1}.
|
|
13485
|
+
*/
|
|
13486
|
+
type?: PublisherParagraphTypeV1;
|
|
13487
|
+
}
|
|
13488
|
+
|
|
13489
|
+
/**
|
|
13490
|
+
* Both ends are inclusive.
|
|
13491
|
+
*
|
|
13492
|
+
* @alpha
|
|
13493
|
+
*/
|
|
13494
|
+
export declare interface IPublisherRelativePeriodV2 {
|
|
13495
|
+
type: "relative";
|
|
13496
|
+
granularity: DateFilterGranularity;
|
|
13497
|
+
/**
|
|
13498
|
+
* Offset in `granularity` units from the current one, for example `-1`.
|
|
13499
|
+
*/
|
|
13500
|
+
from: number;
|
|
13501
|
+
to: number;
|
|
13502
|
+
}
|
|
13503
|
+
|
|
13504
|
+
/**
|
|
13505
|
+
* Named group of pages.
|
|
13506
|
+
*
|
|
13507
|
+
* @alpha
|
|
13508
|
+
*/
|
|
13509
|
+
export declare interface IPublisherSectionV2 {
|
|
13510
|
+
/**
|
|
13511
|
+
* Unique in the document. Matches `[A-Za-z0-9_.-]{1,64}`.
|
|
13512
|
+
*/
|
|
13513
|
+
id: string;
|
|
13514
|
+
title?: string;
|
|
13515
|
+
description?: string;
|
|
13516
|
+
pages: IPublisherDocumentPageV2[];
|
|
13517
|
+
}
|
|
13518
|
+
|
|
13519
|
+
/**
|
|
13520
|
+
* @remarks
|
|
13521
|
+
* The part keys override the named `shadow`, or define a shadow without one.
|
|
13522
|
+
*
|
|
13523
|
+
* @alpha
|
|
13524
|
+
*/
|
|
13525
|
+
export declare interface IPublisherShadowStyleV2 {
|
|
13526
|
+
shadow?: PublisherShadowValueV2;
|
|
13527
|
+
/**
|
|
13528
|
+
* px on the design canvas; may be negative.
|
|
13529
|
+
*/
|
|
13530
|
+
shadowX?: number;
|
|
13531
|
+
/**
|
|
13532
|
+
* px on the design canvas; may be negative.
|
|
13533
|
+
*/
|
|
13534
|
+
shadowY?: number;
|
|
13535
|
+
shadowBlur?: PublisherPxV2;
|
|
13536
|
+
/**
|
|
13537
|
+
* px on the design canvas; may be negative.
|
|
13538
|
+
*/
|
|
13539
|
+
shadowSpread?: number;
|
|
13540
|
+
shadowColor?: PublisherColorValueV2;
|
|
13541
|
+
shadowOpacity?: PublisherOpacityV2;
|
|
13542
|
+
}
|
|
13543
|
+
|
|
13544
|
+
/**
|
|
13545
|
+
* Current version of {@link IPublisherSlotBaseV1}.
|
|
13546
|
+
*
|
|
13547
|
+
* @alpha
|
|
13548
|
+
*/
|
|
13549
|
+
export declare type IPublisherSlotBase = IPublisherSlotBaseV1;
|
|
13550
|
+
|
|
13551
|
+
/**
|
|
13552
|
+
* Structural base of every document slot.
|
|
13553
|
+
*
|
|
13554
|
+
* @remarks
|
|
13555
|
+
* Parsers written against this base can skip slot types introduced by a newer
|
|
13556
|
+
* content version instead of failing.
|
|
13557
|
+
*
|
|
13558
|
+
* @alpha
|
|
13559
|
+
*/
|
|
13560
|
+
export declare interface IPublisherSlotBaseV1 {
|
|
13561
|
+
type: string;
|
|
13562
|
+
/**
|
|
13563
|
+
* Identifier unique within the page body. The layout tree references it, and it is
|
|
13564
|
+
* the join key when a document fills a template's slots. Regenerated when a page is
|
|
13565
|
+
* cloned into template content so repeated use of one page stays unique.
|
|
13566
|
+
*/
|
|
13567
|
+
localIdentifier: string;
|
|
13568
|
+
/**
|
|
13569
|
+
* Present when the slot is an unfilled placeholder.
|
|
13570
|
+
*/
|
|
13571
|
+
placeholder?: IPublisherSlotPlaceholderV1;
|
|
13572
|
+
}
|
|
13573
|
+
|
|
13574
|
+
/**
|
|
13575
|
+
* Current version of {@link IPublisherSlotPlaceholderV1}.
|
|
13576
|
+
*
|
|
13577
|
+
* @alpha
|
|
13578
|
+
*/
|
|
13579
|
+
export declare type IPublisherSlotPlaceholder = IPublisherSlotPlaceholderV1;
|
|
13580
|
+
|
|
13581
|
+
/**
|
|
13582
|
+
* Metadata of a slot that is intentionally left unfilled in a page layout or template.
|
|
13583
|
+
*
|
|
13584
|
+
* @alpha
|
|
13585
|
+
*/
|
|
13586
|
+
export declare interface IPublisherSlotPlaceholderV1 {
|
|
13587
|
+
/**
|
|
13588
|
+
* Authoring hint shown in the empty slot.
|
|
13589
|
+
*/
|
|
13590
|
+
hint?: string;
|
|
13591
|
+
/**
|
|
13592
|
+
* When true, a document is not considered complete until this slot is filled.
|
|
13593
|
+
*/
|
|
13594
|
+
required?: boolean;
|
|
13595
|
+
}
|
|
13596
|
+
|
|
13597
|
+
/**
|
|
13598
|
+
* Current version of {@link IPublisherStaticTextSourceV1}.
|
|
13599
|
+
*
|
|
13600
|
+
* @alpha
|
|
13601
|
+
*/
|
|
13602
|
+
export declare type IPublisherStaticTextSource = IPublisherStaticTextSourceV1;
|
|
13603
|
+
|
|
13604
|
+
/**
|
|
13605
|
+
* Author-written text.
|
|
13606
|
+
*
|
|
13607
|
+
* @alpha
|
|
13608
|
+
*/
|
|
13609
|
+
export declare interface IPublisherStaticTextSourceV1 {
|
|
13610
|
+
type: "static";
|
|
13611
|
+
/**
|
|
13612
|
+
* Markdown content with `{variable}` placeholders. Stored raw — placeholders are
|
|
13613
|
+
* resolved only at render/export time.
|
|
13614
|
+
*/
|
|
13615
|
+
content: string;
|
|
13616
|
+
}
|
|
13617
|
+
|
|
13618
|
+
/**
|
|
13619
|
+
* @alpha
|
|
13620
|
+
*/
|
|
13621
|
+
export declare interface IPublisherTableStyleV2 {
|
|
13622
|
+
fontSize?: PublisherPxV2;
|
|
13623
|
+
rowHeight?: PublisherPxV2;
|
|
13624
|
+
gridColor?: PublisherColorValueV2;
|
|
13625
|
+
valueColor?: PublisherColorValueV2;
|
|
13626
|
+
nullValueColor?: PublisherColorValueV2;
|
|
13627
|
+
headerLabelColor?: PublisherColorValueV2;
|
|
13628
|
+
headerBackgroundColor?: PublisherColorValueV2;
|
|
13629
|
+
totalValueColor?: PublisherColorValueV2;
|
|
13630
|
+
totalBackgroundColor?: PublisherColorValueV2;
|
|
13631
|
+
subtotalBackgroundColor?: PublisherColorValueV2;
|
|
13632
|
+
}
|
|
13633
|
+
|
|
13634
|
+
/**
|
|
13635
|
+
* @alpha
|
|
13636
|
+
*/
|
|
13637
|
+
export declare interface IPublisherTakeawayGenerationV2 {
|
|
13638
|
+
/**
|
|
13639
|
+
* Appended to the preset instructions. Sent together with the document's takeaway instructions;
|
|
13640
|
+
* the widget's instructions win on a clash.
|
|
13641
|
+
*/
|
|
13642
|
+
instructions?: string;
|
|
13643
|
+
/**
|
|
13644
|
+
* What the AI reads.
|
|
13645
|
+
*/
|
|
13646
|
+
context?: {
|
|
13647
|
+
/**
|
|
13648
|
+
* Widget ids on the same page. Defaults to every visualization on the page.
|
|
13649
|
+
*/
|
|
13650
|
+
widgets?: string[];
|
|
13651
|
+
/**
|
|
13652
|
+
* Defaults to `true`.
|
|
13653
|
+
*/
|
|
13654
|
+
pageTitle?: boolean;
|
|
13655
|
+
/**
|
|
13656
|
+
* Filters and period. Defaults to `true`.
|
|
13657
|
+
*/
|
|
13658
|
+
filters?: boolean;
|
|
13659
|
+
/**
|
|
13660
|
+
* Defaults to `false`.
|
|
13661
|
+
*/
|
|
13662
|
+
otherPages?: boolean;
|
|
13663
|
+
};
|
|
13664
|
+
}
|
|
13665
|
+
|
|
13666
|
+
/**
|
|
13667
|
+
* @alpha
|
|
13668
|
+
*/
|
|
13669
|
+
export declare interface IPublisherTakeawayWidgetV2 extends IPublisherWidgetBaseV2 {
|
|
13670
|
+
type: "takeaway";
|
|
13671
|
+
/**
|
|
13672
|
+
* Text defaults to a localized "Takeaway".
|
|
13673
|
+
*/
|
|
13674
|
+
title?: IPublisherWidgetTitleV2;
|
|
13675
|
+
/**
|
|
13676
|
+
* The generated or written text.
|
|
13677
|
+
*/
|
|
13678
|
+
markdown?: string;
|
|
13679
|
+
generation?: IPublisherTakeawayGenerationV2;
|
|
13680
|
+
style?: IPublisherTextWidgetStyleV2;
|
|
13681
|
+
}
|
|
13682
|
+
|
|
13683
|
+
/**
|
|
13684
|
+
* Current version of {@link IPublisherTextSlotV1}.
|
|
13685
|
+
*
|
|
13686
|
+
* @alpha
|
|
13687
|
+
*/
|
|
13688
|
+
export declare type IPublisherTextSlot = IPublisherTextSlotV1;
|
|
13689
|
+
|
|
13690
|
+
/**
|
|
13691
|
+
* Slot rendering text of either kind.
|
|
13692
|
+
*
|
|
13693
|
+
* @alpha
|
|
13694
|
+
*/
|
|
13695
|
+
export declare type IPublisherTextSlotV1 = IPublisherHeadingSlotV1 | IPublisherParagraphSlotV1;
|
|
13696
|
+
|
|
13697
|
+
/**
|
|
13698
|
+
* Current version of {@link IPublisherTextStyleV1}.
|
|
13699
|
+
*
|
|
13700
|
+
* @alpha
|
|
13701
|
+
*/
|
|
13702
|
+
export declare type IPublisherTextStyle = IPublisherTextStyleV1;
|
|
12713
13703
|
|
|
12714
13704
|
/**
|
|
12715
13705
|
* Styling of a text slot: the paint of its box, plus the ink and placement of the text it owns.
|
|
12716
13706
|
*
|
|
12717
13707
|
* @alpha
|
|
12718
13708
|
*/
|
|
12719
|
-
export declare interface
|
|
13709
|
+
export declare interface IPublisherTextStyleV1 extends IPublisherBoxStyleV1 {
|
|
12720
13710
|
/**
|
|
12721
|
-
* CSS color value. Absolute, like {@link
|
|
13711
|
+
* CSS color value. Absolute, like {@link IPublisherColorBackgroundV1.color}.
|
|
12722
13712
|
*/
|
|
12723
13713
|
color?: string;
|
|
12724
|
-
horizontalAlign?:
|
|
12725
|
-
verticalAlign?:
|
|
13714
|
+
horizontalAlign?: PublisherContentAlignmentV1;
|
|
13715
|
+
verticalAlign?: PublisherContentAlignmentV1;
|
|
13716
|
+
}
|
|
13717
|
+
|
|
13718
|
+
/**
|
|
13719
|
+
* @alpha
|
|
13720
|
+
*/
|
|
13721
|
+
export declare interface IPublisherTextStyleV2 extends IPublisherInheritedTextStyleV2 {
|
|
13722
|
+
fontSize?: PublisherPxV2;
|
|
13723
|
+
/**
|
|
13724
|
+
* 1 to 1000.
|
|
13725
|
+
*/
|
|
13726
|
+
fontWeight?: number;
|
|
13727
|
+
fontStyle?: "normal" | "italic";
|
|
13728
|
+
/**
|
|
13729
|
+
* Multiple of the font size.
|
|
13730
|
+
*/
|
|
13731
|
+
lineHeight?: number;
|
|
13732
|
+
/**
|
|
13733
|
+
* In em.
|
|
13734
|
+
*/
|
|
13735
|
+
letterSpacing?: number;
|
|
13736
|
+
textTransform?: "none" | "uppercase" | "lowercase" | "capitalize";
|
|
13737
|
+
/**
|
|
13738
|
+
* Defaults to `shrink`.
|
|
13739
|
+
*/
|
|
13740
|
+
textOverflow?: "shrink" | "clip" | "ellipsis";
|
|
13741
|
+
}
|
|
13742
|
+
|
|
13743
|
+
/**
|
|
13744
|
+
* @alpha
|
|
13745
|
+
*/
|
|
13746
|
+
export declare interface IPublisherTextWidgetStyleV2 extends IPublisherBoxStyleV2, IPublisherTextStyleV2 {
|
|
13747
|
+
}
|
|
13748
|
+
|
|
13749
|
+
/**
|
|
13750
|
+
* @alpha
|
|
13751
|
+
*/
|
|
13752
|
+
export declare interface IPublisherTextWidgetV2 extends IPublisherWidgetBaseV2 {
|
|
13753
|
+
type: "text";
|
|
13754
|
+
/**
|
|
13755
|
+
* Full markdown: paragraphs, lists, quotes and headings.
|
|
13756
|
+
*/
|
|
13757
|
+
markdown?: string;
|
|
13758
|
+
/**
|
|
13759
|
+
* Page furniture such as page numbers: kept out of the accessibility tree, PDF tags and AI context.
|
|
13760
|
+
*/
|
|
13761
|
+
decorative?: boolean;
|
|
13762
|
+
/**
|
|
13763
|
+
* `textStyle` defaults to `normalText`.
|
|
13764
|
+
*/
|
|
13765
|
+
style?: IPublisherTextWidgetStyleV2;
|
|
13766
|
+
}
|
|
13767
|
+
|
|
13768
|
+
/**
|
|
13769
|
+
* Page title: the PowerPoint slide title and the page name for screen readers.
|
|
13770
|
+
*
|
|
13771
|
+
* @remarks
|
|
13772
|
+
* At most one per page. A page without one uses its first heading as the slide title.
|
|
13773
|
+
*
|
|
13774
|
+
* @alpha
|
|
13775
|
+
*/
|
|
13776
|
+
export declare interface IPublisherTitleWidgetV2 extends IPublisherWidgetBaseV2 {
|
|
13777
|
+
type: "title";
|
|
13778
|
+
/**
|
|
13779
|
+
* Inline markdown only: strong, emphasis, highlight, strike, links and line breaks.
|
|
13780
|
+
*/
|
|
13781
|
+
markdown?: string;
|
|
13782
|
+
/**
|
|
13783
|
+
* `textStyle` defaults to `title`.
|
|
13784
|
+
*/
|
|
13785
|
+
style?: IPublisherTextWidgetStyleV2;
|
|
13786
|
+
}
|
|
13787
|
+
|
|
13788
|
+
/**
|
|
13789
|
+
* @alpha
|
|
13790
|
+
*/
|
|
13791
|
+
export declare interface IPublisherValidationIssueV2 {
|
|
13792
|
+
/**
|
|
13793
|
+
* Where the problem is, for example `content.sections[1].pages[0].layout.children[2].id`.
|
|
13794
|
+
* Empty for the validated value itself.
|
|
13795
|
+
*/
|
|
13796
|
+
path: string;
|
|
13797
|
+
message: string;
|
|
12726
13798
|
}
|
|
12727
13799
|
|
|
13800
|
+
/**
|
|
13801
|
+
* Current version of {@link IPublisherVariableDefinitionV1}.
|
|
13802
|
+
*
|
|
13803
|
+
* @alpha
|
|
13804
|
+
*/
|
|
13805
|
+
export declare type IPublisherVariableDefinition = IPublisherVariableDefinitionV1;
|
|
13806
|
+
|
|
12728
13807
|
/**
|
|
12729
13808
|
* A custom variable declared by document content and given a value by a document.
|
|
12730
13809
|
*
|
|
12731
13810
|
* @remarks
|
|
12732
|
-
* Referenced from text as `{name}`. Values come from {@link
|
|
12733
|
-
* falling back to {@link
|
|
13811
|
+
* Referenced from text as `{name}`. Values come from {@link IPublisherDocumentBaseV1.variableValues},
|
|
13812
|
+
* falling back to {@link IPublisherVariableDefinitionV1.defaultValue}.
|
|
12734
13813
|
*
|
|
12735
13814
|
* @alpha
|
|
12736
13815
|
*/
|
|
12737
|
-
export declare interface
|
|
13816
|
+
export declare interface IPublisherVariableDefinitionV1 {
|
|
12738
13817
|
/**
|
|
12739
13818
|
* Variable name as used inside the `{...}` marker. Must match /^[a-zA-Z][a-zA-Z0-9_]*$/.
|
|
12740
|
-
* Built-in names ({@link
|
|
13819
|
+
* Built-in names ({@link PublisherBuiltInVariableV1}) are reserved.
|
|
12741
13820
|
*/
|
|
12742
13821
|
name: string;
|
|
12743
13822
|
/**
|
|
@@ -12752,12 +13831,55 @@ export declare interface IPublisherVariableDefinition {
|
|
|
12752
13831
|
defaultValue?: string;
|
|
12753
13832
|
}
|
|
12754
13833
|
|
|
13834
|
+
/**
|
|
13835
|
+
* Overrides of the saved visualization's display settings.
|
|
13836
|
+
*
|
|
13837
|
+
* @remarks
|
|
13838
|
+
* A key left out keeps the saved visualization's value. A key the visualization type does not
|
|
13839
|
+
* support is ignored.
|
|
13840
|
+
*
|
|
13841
|
+
* @alpha
|
|
13842
|
+
*/
|
|
13843
|
+
export declare interface IPublisherVisualizationDisplayV2 {
|
|
13844
|
+
legend?: {
|
|
13845
|
+
visible?: boolean;
|
|
13846
|
+
position?: "auto" | "top" | "bottom" | "left" | "right";
|
|
13847
|
+
};
|
|
13848
|
+
xAxis?: IPublisherAxisDisplayV2;
|
|
13849
|
+
yAxis?: IPublisherAxisDisplayV2;
|
|
13850
|
+
secondaryYAxis?: IPublisherAxisDisplayV2;
|
|
13851
|
+
gridlines?: {
|
|
13852
|
+
visible?: boolean;
|
|
13853
|
+
};
|
|
13854
|
+
dataLabels?: {
|
|
13855
|
+
visible?: boolean | "auto";
|
|
13856
|
+
};
|
|
13857
|
+
dataPoints?: {
|
|
13858
|
+
visible?: boolean | "auto";
|
|
13859
|
+
};
|
|
13860
|
+
}
|
|
13861
|
+
|
|
13862
|
+
/**
|
|
13863
|
+
* @alpha
|
|
13864
|
+
*/
|
|
13865
|
+
export declare interface IPublisherVisualizationRefV2 {
|
|
13866
|
+
identifier: string;
|
|
13867
|
+
type: "insight";
|
|
13868
|
+
}
|
|
13869
|
+
|
|
13870
|
+
/**
|
|
13871
|
+
* Current version of {@link IPublisherVisualizationSlotV1}.
|
|
13872
|
+
*
|
|
13873
|
+
* @alpha
|
|
13874
|
+
*/
|
|
13875
|
+
export declare type IPublisherVisualizationSlot = IPublisherVisualizationSlotV1;
|
|
13876
|
+
|
|
12755
13877
|
/**
|
|
12756
13878
|
* Slot rendering an insight, with its own filter context.
|
|
12757
13879
|
*
|
|
12758
13880
|
* @alpha
|
|
12759
13881
|
*/
|
|
12760
|
-
export declare interface
|
|
13882
|
+
export declare interface IPublisherVisualizationSlotV1 extends IPublisherSlotBaseV1 {
|
|
12761
13883
|
type: "visualization";
|
|
12762
13884
|
/**
|
|
12763
13885
|
* Insight to render. Undefined = declared-but-empty slot; renderers show a placeholder.
|
|
@@ -12769,29 +13891,113 @@ export declare interface IPublisherVisualizationSlot extends IPublisherSlotBase
|
|
|
12769
13891
|
title?: string;
|
|
12770
13892
|
showTitle?: boolean;
|
|
12771
13893
|
/**
|
|
12772
|
-
* Visualization properties overriding the insight's own.
|
|
13894
|
+
* Visualization properties overriding the insight's own.
|
|
13895
|
+
*/
|
|
13896
|
+
properties?: VisualizationProperties;
|
|
13897
|
+
/**
|
|
13898
|
+
* Slot-level filters, applied on top of the effective content and page filters.
|
|
13899
|
+
* A slot filter targeting the same object replaces the inherited one.
|
|
13900
|
+
*/
|
|
13901
|
+
filters?: FilterContextItem[];
|
|
13902
|
+
/**
|
|
13903
|
+
* Content- and page-level filters this slot ignores (matched by display form / date dataset).
|
|
13904
|
+
*/
|
|
13905
|
+
ignoredFilters?: IDashboardFilterReference[];
|
|
13906
|
+
/**
|
|
13907
|
+
* Date dataset the document's period (periodStart/periodEnd) is applied to as an
|
|
13908
|
+
* absolute date filter at execution time. Undefined = backend date-dataset
|
|
13909
|
+
* auto-resolution applies.
|
|
13910
|
+
*/
|
|
13911
|
+
dateDataSet?: ObjRef;
|
|
13912
|
+
/**
|
|
13913
|
+
* When true, the implicit date filter derived from the document's period is not
|
|
13914
|
+
* applied to this slot.
|
|
13915
|
+
*/
|
|
13916
|
+
ignoreReportPeriod?: boolean;
|
|
13917
|
+
}
|
|
13918
|
+
|
|
13919
|
+
/**
|
|
13920
|
+
* @remarks
|
|
13921
|
+
* Each of `chart`, `table` and `headline` applies only while the visualization renders as that kind,
|
|
13922
|
+
* so the style survives a switch from a chart to a table.
|
|
13923
|
+
*
|
|
13924
|
+
* @alpha
|
|
13925
|
+
*/
|
|
13926
|
+
export declare interface IPublisherVisualizationStyleV2 extends IPublisherBoxStyleV2 {
|
|
13927
|
+
chart?: IPublisherChartStyleV2;
|
|
13928
|
+
table?: IPublisherTableStyleV2;
|
|
13929
|
+
headline?: IPublisherHeadlineStyleV2;
|
|
13930
|
+
}
|
|
13931
|
+
|
|
13932
|
+
/**
|
|
13933
|
+
* @alpha
|
|
13934
|
+
*/
|
|
13935
|
+
export declare interface IPublisherVisualizationWidgetV2 extends IPublisherWidgetBaseV2 {
|
|
13936
|
+
type: "visualization";
|
|
13937
|
+
visualization?: IPublisherVisualizationRefV2;
|
|
13938
|
+
title?: IPublisherWidgetTitleV2;
|
|
13939
|
+
/**
|
|
13940
|
+
* Defaults to the visualization's description.
|
|
13941
|
+
*/
|
|
13942
|
+
altText?: string;
|
|
13943
|
+
/**
|
|
13944
|
+
* The date dataset that the document period filters.
|
|
13945
|
+
*/
|
|
13946
|
+
dateDataSet?: IPublisherDataSetRefV2;
|
|
13947
|
+
ignoreDocumentPeriod?: boolean;
|
|
13948
|
+
filters?: FilterContextItem[];
|
|
13949
|
+
/**
|
|
13950
|
+
* May name a filter the document no longer has.
|
|
13951
|
+
*/
|
|
13952
|
+
ignoreDocumentFilters?: IDashboardFilterReference[];
|
|
13953
|
+
display?: IPublisherVisualizationDisplayV2;
|
|
13954
|
+
style?: IPublisherVisualizationStyleV2;
|
|
13955
|
+
}
|
|
13956
|
+
|
|
13957
|
+
/**
|
|
13958
|
+
* @remarks
|
|
13959
|
+
* Empty content is an absent key; `""` and `null` are invalid.
|
|
13960
|
+
*
|
|
13961
|
+
* @alpha
|
|
13962
|
+
*/
|
|
13963
|
+
export declare interface IPublisherWidgetBaseV2 {
|
|
13964
|
+
type: PublisherWidgetTypeV2;
|
|
13965
|
+
/**
|
|
13966
|
+
* Unique within its page. Copying a page keeps widget ids as written. Matches `[A-Za-z0-9_.-]{1,64}`.
|
|
12773
13967
|
*/
|
|
12774
|
-
|
|
13968
|
+
id: string;
|
|
12775
13969
|
/**
|
|
12776
|
-
*
|
|
12777
|
-
* A slot filter targeting the same object replaces the inherited one.
|
|
13970
|
+
* Share of the parent's main axis, greater than 0. Defaults to 1.
|
|
12778
13971
|
*/
|
|
12779
|
-
|
|
13972
|
+
proportion?: number;
|
|
13973
|
+
placeholder?: IPublisherWidgetPlaceholderV2;
|
|
12780
13974
|
/**
|
|
12781
|
-
*
|
|
13975
|
+
* Enforced by the editor, never checked on write.
|
|
12782
13976
|
*/
|
|
12783
|
-
|
|
13977
|
+
locked?: boolean;
|
|
13978
|
+
}
|
|
13979
|
+
|
|
13980
|
+
/**
|
|
13981
|
+
* @alpha
|
|
13982
|
+
*/
|
|
13983
|
+
export declare interface IPublisherWidgetPlaceholderV2 {
|
|
13984
|
+
hint?: string;
|
|
13985
|
+
required?: boolean;
|
|
13986
|
+
}
|
|
13987
|
+
|
|
13988
|
+
/**
|
|
13989
|
+
* @alpha
|
|
13990
|
+
*/
|
|
13991
|
+
export declare interface IPublisherWidgetTitleV2 {
|
|
12784
13992
|
/**
|
|
12785
|
-
*
|
|
12786
|
-
* absolute date filter at execution time. Undefined = backend date-dataset
|
|
12787
|
-
* auto-resolution applies.
|
|
13993
|
+
* Defaults to `true`.
|
|
12788
13994
|
*/
|
|
12789
|
-
|
|
13995
|
+
visible?: boolean;
|
|
12790
13996
|
/**
|
|
12791
|
-
*
|
|
12792
|
-
* applied to this slot.
|
|
13997
|
+
* May contain text variables. A visible title without text shows the visualization's own title.
|
|
12793
13998
|
*/
|
|
12794
|
-
|
|
13999
|
+
text?: string;
|
|
14000
|
+
style?: IPublisherTextStyleV2;
|
|
12795
14001
|
}
|
|
12796
14002
|
|
|
12797
14003
|
/**
|
|
@@ -14987,211 +16193,468 @@ export declare interface ISourceInsightMeasureValueFilterRef {
|
|
|
14987
16193
|
}
|
|
14988
16194
|
|
|
14989
16195
|
/**
|
|
14990
|
-
* Source insight ranking filter reference.
|
|
14991
|
-
* @public
|
|
16196
|
+
* Source insight ranking filter reference.
|
|
16197
|
+
* @public
|
|
16198
|
+
*/
|
|
16199
|
+
export declare interface ISourceInsightRankingFilterRef {
|
|
16200
|
+
type: "rankingFilter";
|
|
16201
|
+
measure: ObjRefInScope;
|
|
16202
|
+
}
|
|
16203
|
+
|
|
16204
|
+
/**
|
|
16205
|
+
* Tests whether the provided object is of type {@link IParameterMetadataObject}.
|
|
16206
|
+
*
|
|
16207
|
+
* @param obj - object to test
|
|
16208
|
+
* @public
|
|
16209
|
+
*/
|
|
16210
|
+
export declare function isParameterMetadataObject(obj: unknown): obj is IParameterMetadataObject;
|
|
16211
|
+
|
|
16212
|
+
/**
|
|
16213
|
+
* Tests whether the provided object is of type {@link IParameterMetadataObjectDefinition}.
|
|
16214
|
+
*
|
|
16215
|
+
* @param obj - object to test
|
|
16216
|
+
* @public
|
|
16217
|
+
*/
|
|
16218
|
+
export declare function isParameterMetadataObjectDefinition(obj: unknown): obj is IParameterMetadataObjectDefinition;
|
|
16219
|
+
|
|
16220
|
+
/**
|
|
16221
|
+
* Type guard for checking whether object is a period-over-period measure.
|
|
16222
|
+
*
|
|
16223
|
+
* @public
|
|
16224
|
+
*/
|
|
16225
|
+
export declare function isPoPMeasure(obj: unknown): obj is IMeasure<IPoPMeasureDefinition>;
|
|
16226
|
+
|
|
16227
|
+
/**
|
|
16228
|
+
* Type guard for checking whether object is a period-over-period measure definition.
|
|
16229
|
+
*
|
|
16230
|
+
* @public
|
|
16231
|
+
*/
|
|
16232
|
+
export declare function isPoPMeasureDefinition(obj: unknown): obj is IPoPMeasureDefinition;
|
|
16233
|
+
|
|
16234
|
+
/**
|
|
16235
|
+
* Type guard checking whether the provided object is a positive attribute filter.
|
|
16236
|
+
*
|
|
16237
|
+
* @public
|
|
16238
|
+
*/
|
|
16239
|
+
export declare function isPositiveAttributeFilter(obj: unknown): obj is IPositiveAttributeFilter;
|
|
16240
|
+
|
|
16241
|
+
/**
|
|
16242
|
+
* Type guard for checking whether object is a previous-period measure.
|
|
16243
|
+
*
|
|
16244
|
+
* @public
|
|
16245
|
+
*/
|
|
16246
|
+
export declare function isPreviousPeriodMeasure(obj: unknown): obj is IMeasure<IPreviousPeriodMeasureDefinition>;
|
|
16247
|
+
|
|
16248
|
+
/**
|
|
16249
|
+
* Type guard for checking whether object is a previous period measure definition.
|
|
16250
|
+
*
|
|
16251
|
+
* @public
|
|
16252
|
+
*/
|
|
16253
|
+
export declare function isPreviousPeriodMeasureDefinition(obj: unknown): obj is IPreviousPeriodMeasureDefinition;
|
|
16254
|
+
|
|
16255
|
+
/**
|
|
16256
|
+
* @alpha
|
|
16257
|
+
*/
|
|
16258
|
+
export declare function isPublisherAbsolutePeriodV2(obj: unknown): obj is IPublisherAbsolutePeriodV2;
|
|
16259
|
+
|
|
16260
|
+
/**
|
|
16261
|
+
* Current version of {@link isPublisherColorBackgroundV1}.
|
|
16262
|
+
*
|
|
16263
|
+
* @alpha
|
|
16264
|
+
*/
|
|
16265
|
+
export declare const isPublisherColorBackground: typeof isPublisherColorBackgroundV1;
|
|
16266
|
+
|
|
16267
|
+
/**
|
|
16268
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherColorBackgroundV1}.
|
|
16269
|
+
*
|
|
16270
|
+
* @alpha
|
|
16271
|
+
*/
|
|
16272
|
+
export declare function isPublisherColorBackgroundV1(obj: unknown): obj is IPublisherColorBackgroundV1;
|
|
16273
|
+
|
|
16274
|
+
/**
|
|
16275
|
+
* @alpha
|
|
16276
|
+
*/
|
|
16277
|
+
export declare function isPublisherColumnV2(obj: unknown): obj is IPublisherContainerV2 & {
|
|
16278
|
+
type: "column";
|
|
16279
|
+
};
|
|
16280
|
+
|
|
16281
|
+
/**
|
|
16282
|
+
* @alpha
|
|
16283
|
+
*/
|
|
16284
|
+
export declare function isPublisherContainerV2(obj: unknown): obj is IPublisherContainerV2;
|
|
16285
|
+
|
|
16286
|
+
/**
|
|
16287
|
+
* Current version of {@link isPublisherDocumentV1}.
|
|
16288
|
+
*
|
|
16289
|
+
* @alpha
|
|
16290
|
+
*/
|
|
16291
|
+
export declare const isPublisherDocument: typeof isPublisherDocumentV1;
|
|
16292
|
+
|
|
16293
|
+
/**
|
|
16294
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentContentV1}.
|
|
16295
|
+
*
|
|
16296
|
+
* @alpha
|
|
16297
|
+
*/
|
|
16298
|
+
export declare function isPublisherDocumentContentV1(obj: unknown): obj is IPublisherDocumentContentV1;
|
|
16299
|
+
|
|
16300
|
+
/**
|
|
16301
|
+
* Current version of {@link isPublisherDocumentDefinitionV1}.
|
|
16302
|
+
*
|
|
16303
|
+
* @alpha
|
|
16304
|
+
*/
|
|
16305
|
+
export declare const isPublisherDocumentDefinition: typeof isPublisherDocumentDefinitionV1;
|
|
16306
|
+
|
|
16307
|
+
/**
|
|
16308
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentDefinitionV1}.
|
|
16309
|
+
*
|
|
16310
|
+
* @alpha
|
|
16311
|
+
*/
|
|
16312
|
+
export declare function isPublisherDocumentDefinitionV1(obj: unknown): obj is IPublisherDocumentDefinitionV1;
|
|
16313
|
+
|
|
16314
|
+
/**
|
|
16315
|
+
* @alpha
|
|
16316
|
+
*/
|
|
16317
|
+
export declare function isPublisherDocumentDefinitionV2(obj: unknown): obj is IPublisherDocumentDefinitionV2;
|
|
16318
|
+
|
|
16319
|
+
/**
|
|
16320
|
+
* @alpha
|
|
16321
|
+
*/
|
|
16322
|
+
export declare function isPublisherDocumentPagesContentV2(obj: unknown): obj is IPublisherDocumentPagesContentV2;
|
|
16323
|
+
|
|
16324
|
+
/**
|
|
16325
|
+
* @alpha
|
|
16326
|
+
*/
|
|
16327
|
+
export declare function isPublisherDocumentPageV2(obj: unknown): obj is IPublisherDocumentPageV2;
|
|
16328
|
+
|
|
16329
|
+
/**
|
|
16330
|
+
* @alpha
|
|
16331
|
+
*/
|
|
16332
|
+
export declare function isPublisherDocumentSectionsContentV2(obj: unknown): obj is IPublisherDocumentSectionsContentV2;
|
|
16333
|
+
|
|
16334
|
+
/**
|
|
16335
|
+
* Current version of {@link isPublisherDocumentTemplateV1}.
|
|
16336
|
+
*
|
|
16337
|
+
* @alpha
|
|
16338
|
+
*/
|
|
16339
|
+
export declare const isPublisherDocumentTemplate: typeof isPublisherDocumentTemplateV1;
|
|
16340
|
+
|
|
16341
|
+
/**
|
|
16342
|
+
* Current version of {@link isPublisherDocumentTemplateDefinitionV1}.
|
|
16343
|
+
*
|
|
16344
|
+
* @alpha
|
|
16345
|
+
*/
|
|
16346
|
+
export declare const isPublisherDocumentTemplateDefinition: typeof isPublisherDocumentTemplateDefinitionV1;
|
|
16347
|
+
|
|
16348
|
+
/**
|
|
16349
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentTemplateDefinitionV1}.
|
|
16350
|
+
*
|
|
16351
|
+
* @alpha
|
|
16352
|
+
*/
|
|
16353
|
+
export declare function isPublisherDocumentTemplateDefinitionV1(obj: unknown): obj is IPublisherDocumentTemplateDefinitionV1;
|
|
16354
|
+
|
|
16355
|
+
/**
|
|
16356
|
+
* @alpha
|
|
16357
|
+
*/
|
|
16358
|
+
export declare function isPublisherDocumentTemplateDefinitionV2(obj: unknown): obj is IPublisherDocumentTemplateDefinitionV2;
|
|
16359
|
+
|
|
16360
|
+
/**
|
|
16361
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentTemplateV1}.
|
|
16362
|
+
*
|
|
16363
|
+
* @alpha
|
|
16364
|
+
*/
|
|
16365
|
+
export declare function isPublisherDocumentTemplateV1(obj: unknown): obj is IPublisherDocumentTemplateV1;
|
|
16366
|
+
|
|
16367
|
+
/**
|
|
16368
|
+
* @alpha
|
|
16369
|
+
*/
|
|
16370
|
+
export declare function isPublisherDocumentTemplateV2(obj: unknown): obj is IPublisherDocumentTemplateV2;
|
|
16371
|
+
|
|
16372
|
+
/**
|
|
16373
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentV1}.
|
|
16374
|
+
*
|
|
16375
|
+
* @alpha
|
|
16376
|
+
*/
|
|
16377
|
+
export declare function isPublisherDocumentV1(obj: unknown): obj is IPublisherDocumentV1;
|
|
16378
|
+
|
|
16379
|
+
/**
|
|
16380
|
+
* @alpha
|
|
16381
|
+
*/
|
|
16382
|
+
export declare function isPublisherDocumentV2(obj: unknown): obj is IPublisherDocumentV2;
|
|
16383
|
+
|
|
16384
|
+
/**
|
|
16385
|
+
* Current version of {@link isPublisherHeadingSlotV1}.
|
|
16386
|
+
*
|
|
16387
|
+
* @alpha
|
|
16388
|
+
*/
|
|
16389
|
+
export declare const isPublisherHeadingSlot: typeof isPublisherHeadingSlotV1;
|
|
16390
|
+
|
|
16391
|
+
/**
|
|
16392
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherHeadingSlotV1}.
|
|
16393
|
+
*
|
|
16394
|
+
* @alpha
|
|
16395
|
+
*/
|
|
16396
|
+
export declare function isPublisherHeadingSlotV1(obj: unknown): obj is IPublisherHeadingSlotV1;
|
|
16397
|
+
|
|
16398
|
+
/**
|
|
16399
|
+
* Current version of {@link isPublisherHeadingTypeV1}.
|
|
16400
|
+
*
|
|
16401
|
+
* @alpha
|
|
16402
|
+
*/
|
|
16403
|
+
export declare const isPublisherHeadingType: typeof isPublisherHeadingTypeV1;
|
|
16404
|
+
|
|
16405
|
+
/**
|
|
16406
|
+
* Type-guard testing whether the value is a {@link PublisherHeadingTypeV1}.
|
|
16407
|
+
*
|
|
16408
|
+
* @alpha
|
|
16409
|
+
*/
|
|
16410
|
+
export declare function isPublisherHeadingTypeV1(value: unknown): value is PublisherHeadingTypeV1;
|
|
16411
|
+
|
|
16412
|
+
/**
|
|
16413
|
+
* @alpha
|
|
16414
|
+
*/
|
|
16415
|
+
export declare function isPublisherHeadingWidgetV2(obj: unknown): obj is IPublisherHeadingWidgetV2;
|
|
16416
|
+
|
|
16417
|
+
/**
|
|
16418
|
+
* Current version of {@link isPublisherImageBackgroundV1}.
|
|
16419
|
+
*
|
|
16420
|
+
* @alpha
|
|
16421
|
+
*/
|
|
16422
|
+
export declare const isPublisherImageBackground: typeof isPublisherImageBackgroundV1;
|
|
16423
|
+
|
|
16424
|
+
/**
|
|
16425
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherImageBackgroundV1}.
|
|
16426
|
+
*
|
|
16427
|
+
* @alpha
|
|
16428
|
+
*/
|
|
16429
|
+
export declare function isPublisherImageBackgroundV1(obj: unknown): obj is IPublisherImageBackgroundV1;
|
|
16430
|
+
|
|
16431
|
+
/**
|
|
16432
|
+
* Current version of {@link isPublisherImageSlotV1}.
|
|
16433
|
+
*
|
|
16434
|
+
* @alpha
|
|
16435
|
+
*/
|
|
16436
|
+
export declare const isPublisherImageSlot: typeof isPublisherImageSlotV1;
|
|
16437
|
+
|
|
16438
|
+
/**
|
|
16439
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherImageSlotV1}.
|
|
16440
|
+
*
|
|
16441
|
+
* @alpha
|
|
16442
|
+
*/
|
|
16443
|
+
export declare function isPublisherImageSlotV1(obj: unknown): obj is IPublisherImageSlotV1;
|
|
16444
|
+
|
|
16445
|
+
/**
|
|
16446
|
+
* @alpha
|
|
16447
|
+
*/
|
|
16448
|
+
export declare function isPublisherImageWidgetV2(obj: unknown): obj is IPublisherImageWidgetV2;
|
|
16449
|
+
|
|
16450
|
+
/**
|
|
16451
|
+
* Current version of {@link isPublisherLayoutSectionV1}.
|
|
16452
|
+
*
|
|
16453
|
+
* @alpha
|
|
16454
|
+
*/
|
|
16455
|
+
export declare const isPublisherLayoutSection: typeof isPublisherLayoutSectionV1;
|
|
16456
|
+
|
|
16457
|
+
/**
|
|
16458
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherLayoutSectionV1}.
|
|
16459
|
+
*
|
|
16460
|
+
* @alpha
|
|
16461
|
+
*/
|
|
16462
|
+
export declare function isPublisherLayoutSectionV1(obj: unknown): obj is IPublisherLayoutSectionV1;
|
|
16463
|
+
|
|
16464
|
+
/**
|
|
16465
|
+
* Current version of {@link isPublisherLayoutSlotRefV1}.
|
|
16466
|
+
*
|
|
16467
|
+
* @alpha
|
|
16468
|
+
*/
|
|
16469
|
+
export declare const isPublisherLayoutSlotRef: typeof isPublisherLayoutSlotRefV1;
|
|
16470
|
+
|
|
16471
|
+
/**
|
|
16472
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherLayoutSlotRefV1}.
|
|
16473
|
+
*
|
|
16474
|
+
* @alpha
|
|
16475
|
+
*/
|
|
16476
|
+
export declare function isPublisherLayoutSlotRefV1(obj: unknown): obj is IPublisherLayoutSlotRefV1;
|
|
16477
|
+
|
|
16478
|
+
/**
|
|
16479
|
+
* @alpha
|
|
14992
16480
|
*/
|
|
14993
|
-
export declare
|
|
14994
|
-
type: "rankingFilter";
|
|
14995
|
-
measure: ObjRefInScope;
|
|
14996
|
-
}
|
|
16481
|
+
export declare function isPublisherPageBodyV2(obj: unknown): obj is IPublisherPageBodyV2;
|
|
14997
16482
|
|
|
14998
16483
|
/**
|
|
14999
|
-
*
|
|
16484
|
+
* Current version of {@link isPublisherPageFormatV1}.
|
|
15000
16485
|
*
|
|
15001
|
-
* @
|
|
15002
|
-
* @public
|
|
16486
|
+
* @alpha
|
|
15003
16487
|
*/
|
|
15004
|
-
export declare
|
|
16488
|
+
export declare const isPublisherPageFormat: typeof isPublisherPageFormatV1;
|
|
15005
16489
|
|
|
15006
16490
|
/**
|
|
15007
|
-
*
|
|
16491
|
+
* Type-guard testing whether the provided value is a {@link PublisherPageFormatV1}.
|
|
15008
16492
|
*
|
|
15009
|
-
* @
|
|
15010
|
-
* @public
|
|
16493
|
+
* @alpha
|
|
15011
16494
|
*/
|
|
15012
|
-
export declare function
|
|
16495
|
+
export declare function isPublisherPageFormatV1(value: unknown): value is PublisherPageFormatV1;
|
|
15013
16496
|
|
|
15014
16497
|
/**
|
|
15015
|
-
*
|
|
16498
|
+
* Current version of {@link isPublisherPageLayoutV1}.
|
|
15016
16499
|
*
|
|
15017
|
-
* @
|
|
16500
|
+
* @alpha
|
|
15018
16501
|
*/
|
|
15019
|
-
export declare
|
|
16502
|
+
export declare const isPublisherPageLayout: typeof isPublisherPageLayoutV1;
|
|
15020
16503
|
|
|
15021
16504
|
/**
|
|
15022
|
-
* Type
|
|
16505
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayoutContentV1}.
|
|
15023
16506
|
*
|
|
15024
|
-
* @
|
|
16507
|
+
* @alpha
|
|
15025
16508
|
*/
|
|
15026
|
-
export declare function
|
|
16509
|
+
export declare function isPublisherPageLayoutContentV1(obj: unknown): obj is IPublisherPageLayoutContentV1;
|
|
15027
16510
|
|
|
15028
16511
|
/**
|
|
15029
|
-
*
|
|
16512
|
+
* Current version of {@link isPublisherPageLayoutDefinitionV1}.
|
|
15030
16513
|
*
|
|
15031
|
-
* @
|
|
16514
|
+
* @alpha
|
|
15032
16515
|
*/
|
|
15033
|
-
export declare
|
|
16516
|
+
export declare const isPublisherPageLayoutDefinition: typeof isPublisherPageLayoutDefinitionV1;
|
|
15034
16517
|
|
|
15035
16518
|
/**
|
|
15036
|
-
* Type
|
|
16519
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayoutDefinitionV1}.
|
|
15037
16520
|
*
|
|
15038
|
-
* @
|
|
16521
|
+
* @alpha
|
|
15039
16522
|
*/
|
|
15040
|
-
export declare function
|
|
16523
|
+
export declare function isPublisherPageLayoutDefinitionV1(obj: unknown): obj is IPublisherPageLayoutDefinitionV1;
|
|
15041
16524
|
|
|
15042
16525
|
/**
|
|
15043
|
-
* Type
|
|
16526
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayoutV1}.
|
|
15044
16527
|
*
|
|
15045
|
-
* @
|
|
16528
|
+
* @alpha
|
|
15046
16529
|
*/
|
|
15047
|
-
export declare function
|
|
16530
|
+
export declare function isPublisherPageLayoutV1(obj: unknown): obj is IPublisherPageLayoutV1;
|
|
15048
16531
|
|
|
15049
16532
|
/**
|
|
15050
|
-
* Type-guard testing whether the provided object is an instance of {@link IPublisherColorBackground}.
|
|
15051
|
-
*
|
|
15052
16533
|
* @alpha
|
|
15053
16534
|
*/
|
|
15054
|
-
export declare function
|
|
16535
|
+
export declare function isPublisherPageSizeV2(value: unknown): value is PublisherPageSizeV2;
|
|
15055
16536
|
|
|
15056
16537
|
/**
|
|
15057
|
-
* Type-guard testing whether the provided object is an instance of {@link IPublisherDocument}.
|
|
15058
|
-
*
|
|
15059
16538
|
* @alpha
|
|
15060
16539
|
*/
|
|
15061
|
-
export declare function
|
|
16540
|
+
export declare function isPublisherPageTemplateDefinitionV2(obj: unknown): obj is IPublisherPageTemplateDefinitionV2;
|
|
15062
16541
|
|
|
15063
16542
|
/**
|
|
15064
|
-
* Type-guard testing whether the provided object is an instance of {@link IPublisherDocumentContent}.
|
|
15065
|
-
*
|
|
15066
16543
|
* @alpha
|
|
15067
16544
|
*/
|
|
15068
|
-
export declare function
|
|
16545
|
+
export declare function isPublisherPageTemplateV2(obj: unknown): obj is IPublisherPageTemplateV2;
|
|
15069
16546
|
|
|
15070
16547
|
/**
|
|
15071
|
-
*
|
|
16548
|
+
* Current version of {@link isPublisherParagraphSlotV1}.
|
|
15072
16549
|
*
|
|
15073
16550
|
* @alpha
|
|
15074
16551
|
*/
|
|
15075
|
-
export declare
|
|
16552
|
+
export declare const isPublisherParagraphSlot: typeof isPublisherParagraphSlotV1;
|
|
15076
16553
|
|
|
15077
16554
|
/**
|
|
15078
|
-
* Type-guard testing whether the provided object is an instance of {@link
|
|
16555
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherParagraphSlotV1}.
|
|
15079
16556
|
*
|
|
15080
16557
|
* @alpha
|
|
15081
16558
|
*/
|
|
15082
|
-
export declare function
|
|
16559
|
+
export declare function isPublisherParagraphSlotV1(obj: unknown): obj is IPublisherParagraphSlotV1;
|
|
15083
16560
|
|
|
15084
16561
|
/**
|
|
15085
|
-
*
|
|
16562
|
+
* Current version of {@link isPublisherParagraphTypeV1}.
|
|
15086
16563
|
*
|
|
15087
16564
|
* @alpha
|
|
15088
16565
|
*/
|
|
15089
|
-
export declare
|
|
16566
|
+
export declare const isPublisherParagraphType: typeof isPublisherParagraphTypeV1;
|
|
15090
16567
|
|
|
15091
16568
|
/**
|
|
15092
|
-
* Type-guard testing whether the
|
|
16569
|
+
* Type-guard testing whether the value is a {@link PublisherParagraphTypeV1}.
|
|
15093
16570
|
*
|
|
15094
16571
|
* @alpha
|
|
15095
16572
|
*/
|
|
15096
|
-
export declare function
|
|
16573
|
+
export declare function isPublisherParagraphTypeV1(value: unknown): value is PublisherParagraphTypeV1;
|
|
15097
16574
|
|
|
15098
16575
|
/**
|
|
15099
|
-
* Type-guard testing whether the value is a {@link PublisherHeadingType}.
|
|
15100
|
-
*
|
|
15101
16576
|
* @alpha
|
|
15102
16577
|
*/
|
|
15103
|
-
export declare function
|
|
16578
|
+
export declare function isPublisherRelativePeriodV2(obj: unknown): obj is IPublisherRelativePeriodV2;
|
|
15104
16579
|
|
|
15105
16580
|
/**
|
|
15106
|
-
* Type-guard testing whether the provided object is an instance of {@link IPublisherImageBackground}.
|
|
15107
|
-
*
|
|
15108
16581
|
* @alpha
|
|
15109
16582
|
*/
|
|
15110
|
-
export declare function
|
|
16583
|
+
export declare function isPublisherRowV2(obj: unknown): obj is IPublisherContainerV2 & {
|
|
16584
|
+
type: "row";
|
|
16585
|
+
};
|
|
15111
16586
|
|
|
15112
16587
|
/**
|
|
15113
|
-
*
|
|
16588
|
+
* Current version of {@link isPublisherSlotV1}.
|
|
15114
16589
|
*
|
|
15115
16590
|
* @alpha
|
|
15116
16591
|
*/
|
|
15117
|
-
export declare
|
|
16592
|
+
export declare const isPublisherSlot: typeof isPublisherSlotV1;
|
|
15118
16593
|
|
|
15119
16594
|
/**
|
|
15120
|
-
* Type-guard testing whether the provided object is an instance of {@link
|
|
16595
|
+
* Type-guard testing whether the provided object is an instance of {@link PublisherSlotV1}.
|
|
15121
16596
|
*
|
|
15122
16597
|
* @alpha
|
|
15123
16598
|
*/
|
|
15124
|
-
export declare function
|
|
16599
|
+
export declare function isPublisherSlotV1(obj: unknown): obj is PublisherSlotV1;
|
|
15125
16600
|
|
|
15126
16601
|
/**
|
|
15127
|
-
* Type-guard testing whether the provided object is an instance of {@link IPublisherLayoutSlotRef}.
|
|
15128
|
-
*
|
|
15129
16602
|
* @alpha
|
|
15130
16603
|
*/
|
|
15131
|
-
export declare function
|
|
16604
|
+
export declare function isPublisherTakeawayWidgetV2(obj: unknown): obj is IPublisherTakeawayWidgetV2;
|
|
15132
16605
|
|
|
15133
16606
|
/**
|
|
15134
|
-
*
|
|
16607
|
+
* Current version of {@link isPublisherTextSlotV1}.
|
|
15135
16608
|
*
|
|
15136
16609
|
* @alpha
|
|
15137
16610
|
*/
|
|
15138
|
-
export declare
|
|
16611
|
+
export declare const isPublisherTextSlot: typeof isPublisherTextSlotV1;
|
|
15139
16612
|
|
|
15140
16613
|
/**
|
|
15141
|
-
* Type-guard testing whether the provided object is an instance of {@link
|
|
16614
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherTextSlotV1}.
|
|
15142
16615
|
*
|
|
15143
16616
|
* @alpha
|
|
15144
16617
|
*/
|
|
15145
|
-
export declare function
|
|
16618
|
+
export declare function isPublisherTextSlotV1(obj: unknown): obj is IPublisherTextSlotV1;
|
|
15146
16619
|
|
|
15147
16620
|
/**
|
|
15148
|
-
* Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayoutContent}.
|
|
15149
|
-
*
|
|
15150
16621
|
* @alpha
|
|
15151
16622
|
*/
|
|
15152
|
-
export declare function
|
|
16623
|
+
export declare function isPublisherTextStyleNameV2(value: unknown): value is PublisherTextStyleNameV2;
|
|
15153
16624
|
|
|
15154
16625
|
/**
|
|
15155
|
-
* Type-guard testing whether the provided object is an instance of {@link IPublisherPageLayoutDefinition}.
|
|
15156
|
-
*
|
|
15157
16626
|
* @alpha
|
|
15158
16627
|
*/
|
|
15159
|
-
export declare function
|
|
16628
|
+
export declare function isPublisherTextWidgetV2(obj: unknown): obj is IPublisherTextWidgetV2;
|
|
15160
16629
|
|
|
15161
16630
|
/**
|
|
15162
|
-
* Type-guard testing whether the provided object is an instance of {@link IPublisherParagraphSlot}.
|
|
15163
|
-
*
|
|
15164
16631
|
* @alpha
|
|
15165
16632
|
*/
|
|
15166
|
-
export declare function
|
|
16633
|
+
export declare function isPublisherTitleWidgetV2(obj: unknown): obj is IPublisherTitleWidgetV2;
|
|
15167
16634
|
|
|
15168
16635
|
/**
|
|
15169
|
-
*
|
|
16636
|
+
* Current version of {@link isPublisherVisualizationSlotV1}.
|
|
15170
16637
|
*
|
|
15171
16638
|
* @alpha
|
|
15172
16639
|
*/
|
|
15173
|
-
export declare
|
|
16640
|
+
export declare const isPublisherVisualizationSlot: typeof isPublisherVisualizationSlotV1;
|
|
15174
16641
|
|
|
15175
16642
|
/**
|
|
15176
|
-
* Type-guard testing whether the provided object is an instance of {@link
|
|
16643
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherVisualizationSlotV1}.
|
|
15177
16644
|
*
|
|
15178
16645
|
* @alpha
|
|
15179
16646
|
*/
|
|
15180
|
-
export declare function
|
|
16647
|
+
export declare function isPublisherVisualizationSlotV1(obj: unknown): obj is IPublisherVisualizationSlotV1;
|
|
15181
16648
|
|
|
15182
16649
|
/**
|
|
15183
|
-
* Type-guard testing whether the provided object is an instance of {@link IPublisherTextSlot}.
|
|
15184
|
-
*
|
|
15185
16650
|
* @alpha
|
|
15186
16651
|
*/
|
|
15187
|
-
export declare function
|
|
16652
|
+
export declare function isPublisherVisualizationWidgetV2(obj: unknown): obj is IPublisherVisualizationWidgetV2;
|
|
15188
16653
|
|
|
15189
16654
|
/**
|
|
15190
|
-
* Type-guard testing whether the provided object is an instance of {@link IPublisherVisualizationSlot}.
|
|
15191
|
-
*
|
|
15192
16655
|
* @alpha
|
|
15193
16656
|
*/
|
|
15194
|
-
export declare function
|
|
16657
|
+
export declare function isPublisherWidgetV2(obj: unknown): obj is PublisherWidgetV2;
|
|
15195
16658
|
|
|
15196
16659
|
/**
|
|
15197
16660
|
* Type guard checking whether the provided object is a measure value filter's range condition.
|
|
@@ -18798,7 +20261,19 @@ export declare function modifySimpleMeasure(measure: IMeasure<IMeasureDefinition
|
|
|
18798
20261
|
* @param to - end of the interval in ISO-8601 calendar date format
|
|
18799
20262
|
* @alpha
|
|
18800
20263
|
*/
|
|
18801
|
-
export declare function newAbsoluteDashboardDateFilter(from: DateString, to: DateString, dataSet?: ObjRef, localIdentifier?: string, emptyValueHandling?: EmptyValues): IDashboardDateFilter;
|
|
20264
|
+
export declare function newAbsoluteDashboardDateFilter(from: DateString, to: DateString, dataSet?: ObjRef, localIdentifier?: string, emptyValueHandling?: EmptyValues, granularity?: DateFilterGranularity): IDashboardDateFilter;
|
|
20265
|
+
|
|
20266
|
+
/**
|
|
20267
|
+
* Creates a new absolute date filter.
|
|
20268
|
+
*
|
|
20269
|
+
* @param dateDataSet - ref or identifier of the date data set to filter on
|
|
20270
|
+
* @param from - start of the interval in ISO-8601 calendar date format
|
|
20271
|
+
* @param to - end of the interval in ISO-8601 calendar date format
|
|
20272
|
+
* @param options - local identifier, empty values handling and granularity of the filter
|
|
20273
|
+
*
|
|
20274
|
+
* @public
|
|
20275
|
+
*/
|
|
20276
|
+
export declare function newAbsoluteDateFilter(dateDataSet: ObjRef | Identifier, from: string, to: string, options: IAbsoluteDateFilterOptions): IAbsoluteDateFilter;
|
|
18802
20277
|
|
|
18803
20278
|
/**
|
|
18804
20279
|
* Creates a new absolute date filter.
|
|
@@ -18812,17 +20287,24 @@ export declare function newAbsoluteDashboardDateFilter(from: DateString, to: Dat
|
|
|
18812
20287
|
*/
|
|
18813
20288
|
export declare function newAbsoluteDateFilter(dateDataSet: ObjRef | Identifier, from: string, to: string, localIdentifier?: string, emptyValueHandling?: EmptyValues): IAbsoluteDateFilter;
|
|
18814
20289
|
|
|
20290
|
+
/**
|
|
20291
|
+
* Current version of {@link newAdHocPublisherDocumentDefinitionV1}.
|
|
20292
|
+
*
|
|
20293
|
+
* @alpha
|
|
20294
|
+
*/
|
|
20295
|
+
export declare const newAdHocPublisherDocumentDefinition: typeof newAdHocPublisherDocumentDefinitionV1;
|
|
20296
|
+
|
|
18815
20297
|
/**
|
|
18816
20298
|
* Creates an ad-hoc document definition not based on any template.
|
|
18817
20299
|
*
|
|
18818
20300
|
* @alpha
|
|
18819
20301
|
*/
|
|
18820
|
-
export declare function
|
|
20302
|
+
export declare function newAdHocPublisherDocumentDefinitionV1(options: {
|
|
18821
20303
|
title: string;
|
|
18822
|
-
periodStart:
|
|
18823
|
-
periodEnd:
|
|
18824
|
-
pages?:
|
|
18825
|
-
}, modifications?: Partial<Omit<
|
|
20304
|
+
periodStart: PublisherDateStringV1;
|
|
20305
|
+
periodEnd: PublisherDateStringV1;
|
|
20306
|
+
pages?: IPublisherDocumentPageV1[];
|
|
20307
|
+
}, modifications?: Partial<Omit<IPublisherDocumentDefinitionV1, "type" | "title" | "periodStart" | "periodEnd" | "content">>): IPublisherDocumentDefinitionV1;
|
|
18826
20308
|
|
|
18827
20309
|
/**
|
|
18828
20310
|
* Creates a new all time date filter. This filter is used to indicate that there should be no filtering on the dates.
|
|
@@ -19162,12 +20644,26 @@ export declare function newPositiveAttributeFilter(attributeOrRef: IAttribute |
|
|
|
19162
20644
|
*/
|
|
19163
20645
|
export declare function newPreviousPeriodMeasure(measureIdOrLocalId: MeasureOrLocalId, dateDataSets: IPreviousPeriodDateDataSetSimple[], modifications?: MeasureModifications<PreviousPeriodMeasureBuilder>): IMeasure<IPreviousPeriodMeasureDefinition>;
|
|
19164
20646
|
|
|
20647
|
+
/**
|
|
20648
|
+
* Current version of {@link newPublisherDocumentContentV1}.
|
|
20649
|
+
*
|
|
20650
|
+
* @alpha
|
|
20651
|
+
*/
|
|
20652
|
+
export declare const newPublisherDocumentContent: typeof newPublisherDocumentContentV1;
|
|
20653
|
+
|
|
19165
20654
|
/**
|
|
19166
20655
|
* Creates document content from page instances.
|
|
19167
20656
|
*
|
|
19168
20657
|
* @alpha
|
|
19169
20658
|
*/
|
|
19170
|
-
export declare function
|
|
20659
|
+
export declare function newPublisherDocumentContentV1(pages: IPublisherDocumentPageV1[], modifications?: Partial<Omit<IPublisherDocumentContentV1, "version" | "pages">>): IPublisherDocumentContentV1;
|
|
20660
|
+
|
|
20661
|
+
/**
|
|
20662
|
+
* Current version of {@link newPublisherDocumentDefinitionFromTemplateV1}.
|
|
20663
|
+
*
|
|
20664
|
+
* @alpha
|
|
20665
|
+
*/
|
|
20666
|
+
export declare const newPublisherDocumentDefinitionFromTemplate: typeof newPublisherDocumentDefinitionFromTemplateV1;
|
|
19171
20667
|
|
|
19172
20668
|
/**
|
|
19173
20669
|
* Creates a document definition from a template.
|
|
@@ -19178,11 +20674,32 @@ export declare function newPublisherDocumentContent(pages: IPublisherDocumentPag
|
|
|
19178
20674
|
*
|
|
19179
20675
|
* @alpha
|
|
19180
20676
|
*/
|
|
19181
|
-
export declare function
|
|
20677
|
+
export declare function newPublisherDocumentDefinitionFromTemplateV1(template: IPublisherDocumentTemplateV1 | IPublisherDocumentTemplateDefinitionV1, options: {
|
|
19182
20678
|
title: string;
|
|
19183
|
-
periodStart:
|
|
19184
|
-
periodEnd:
|
|
19185
|
-
}, modifications?: Partial<Omit<
|
|
20679
|
+
periodStart: PublisherDateStringV1;
|
|
20680
|
+
periodEnd: PublisherDateStringV1;
|
|
20681
|
+
}, modifications?: Partial<Omit<IPublisherDocumentDefinitionV1, "type" | "title" | "periodStart" | "periodEnd" | "content">>): IPublisherDocumentDefinitionV1;
|
|
20682
|
+
|
|
20683
|
+
/**
|
|
20684
|
+
* Generates a document filter id such as `document_filter_region_name`.
|
|
20685
|
+
*
|
|
20686
|
+
* @remarks
|
|
20687
|
+
* Every character of the target's identifier outside `[A-Za-z0-9_]` becomes `_`, and the id is cut to
|
|
20688
|
+
* 64 characters. When the document already uses the id, `_2`, `_3` and so on is appended, with the
|
|
20689
|
+
* base shortened so the id stays within 64 characters.
|
|
20690
|
+
*
|
|
20691
|
+
* Throws when the target is not an identifier ref.
|
|
20692
|
+
*
|
|
20693
|
+
* @alpha
|
|
20694
|
+
*/
|
|
20695
|
+
export declare function newPublisherDocumentFilterIdV2({ target, usedIds, }: INewPublisherDocumentFilterIdOptionsV2): string;
|
|
20696
|
+
|
|
20697
|
+
/**
|
|
20698
|
+
* Current version of {@link newPublisherDocumentPageFromLayoutV1}.
|
|
20699
|
+
*
|
|
20700
|
+
* @alpha
|
|
20701
|
+
*/
|
|
20702
|
+
export declare const newPublisherDocumentPageFromLayout: typeof newPublisherDocumentPageFromLayoutV1;
|
|
19186
20703
|
|
|
19187
20704
|
/**
|
|
19188
20705
|
* Clones a page layout into a page instance embeddable in template/document content.
|
|
@@ -19194,21 +20711,80 @@ export declare function newPublisherDocumentDefinitionFromTemplate(template: IPu
|
|
|
19194
20711
|
*
|
|
19195
20712
|
* @alpha
|
|
19196
20713
|
*/
|
|
19197
|
-
export declare function
|
|
20714
|
+
export declare function newPublisherDocumentPageFromLayoutV1(page: IPublisherPageLayoutV1 | IPublisherPageLayoutDefinitionV1, localIdentifier?: string): IPublisherDocumentPageV1;
|
|
20715
|
+
|
|
20716
|
+
/**
|
|
20717
|
+
* Copies a page template's content into a new document page.
|
|
20718
|
+
*
|
|
20719
|
+
* @remarks
|
|
20720
|
+
* The page is a deep copy with its own page id. Widget ids stay as written, so pages made from
|
|
20721
|
+
* one template share widget ids; a widget is addressed by page id plus widget id.
|
|
20722
|
+
*
|
|
20723
|
+
* A document page can be passed as the template: its `id` is replaced and its `visible` is dropped.
|
|
20724
|
+
*
|
|
20725
|
+
* @alpha
|
|
20726
|
+
*/
|
|
20727
|
+
export declare function newPublisherDocumentPageFromTemplateV2(body: IPublisherPageBodyV2 & Partial<Pick<IPublisherDocumentPageV2, "id" | "visible">>, id?: string): IPublisherDocumentPageV2;
|
|
20728
|
+
|
|
20729
|
+
/**
|
|
20730
|
+
* Current version of {@link newPublisherDocumentTemplateDefinitionV1}.
|
|
20731
|
+
*
|
|
20732
|
+
* @alpha
|
|
20733
|
+
*/
|
|
20734
|
+
export declare const newPublisherDocumentTemplateDefinition: typeof newPublisherDocumentTemplateDefinitionV1;
|
|
19198
20735
|
|
|
19199
20736
|
/**
|
|
19200
20737
|
* Creates a new document template definition.
|
|
19201
20738
|
*
|
|
19202
20739
|
* @alpha
|
|
19203
20740
|
*/
|
|
19204
|
-
export declare function
|
|
20741
|
+
export declare function newPublisherDocumentTemplateDefinitionV1(title: string, content: IPublisherDocumentContentV1, modifications?: Partial<Omit<IPublisherDocumentTemplateDefinitionV1, "type" | "title" | "content">>): IPublisherDocumentTemplateDefinitionV1;
|
|
20742
|
+
|
|
20743
|
+
/**
|
|
20744
|
+
* Generates an id such as `widget_7f3a91c4`.
|
|
20745
|
+
*
|
|
20746
|
+
* @remarks
|
|
20747
|
+
* For a valid id, the prefix uses only `[A-Za-z0-9_.-]`, has at most 55 characters and does not
|
|
20748
|
+
* start with `default.`.
|
|
20749
|
+
*
|
|
20750
|
+
* @alpha
|
|
20751
|
+
*/
|
|
20752
|
+
export declare function newPublisherIdV2(prefix: string): string;
|
|
20753
|
+
|
|
20754
|
+
/**
|
|
20755
|
+
* Generates a page id such as `page_7f3a91c4`.
|
|
20756
|
+
*
|
|
20757
|
+
* @alpha
|
|
20758
|
+
*/
|
|
20759
|
+
export declare function newPublisherPageIdV2(): string;
|
|
20760
|
+
|
|
20761
|
+
/**
|
|
20762
|
+
* Current version of {@link newPublisherPageLayoutDefinitionV1}.
|
|
20763
|
+
*
|
|
20764
|
+
* @alpha
|
|
20765
|
+
*/
|
|
20766
|
+
export declare const newPublisherPageLayoutDefinition: typeof newPublisherPageLayoutDefinitionV1;
|
|
19205
20767
|
|
|
19206
20768
|
/**
|
|
19207
20769
|
* Creates a new page layout definition.
|
|
19208
20770
|
*
|
|
19209
20771
|
* @alpha
|
|
19210
20772
|
*/
|
|
19211
|
-
export declare function
|
|
20773
|
+
export declare function newPublisherPageLayoutDefinitionV1(title: string, body: IPublisherPageBodyV1, modifications?: Partial<Omit<IPublisherPageLayoutDefinitionV1, "type" | "title" | "content">>): IPublisherPageLayoutDefinitionV1;
|
|
20774
|
+
|
|
20775
|
+
/**
|
|
20776
|
+
* Generates a section id such as `section_7f3a91c4`.
|
|
20777
|
+
*
|
|
20778
|
+
* @alpha
|
|
20779
|
+
*/
|
|
20780
|
+
export declare function newPublisherSectionIdV2(): string;
|
|
20781
|
+
|
|
20782
|
+
/**
|
|
20783
|
+
* Generates a widget id such as `widget_7f3a91c4`.
|
|
20784
|
+
*
|
|
20785
|
+
* @alpha
|
|
20786
|
+
*/
|
|
20787
|
+
export declare function newPublisherWidgetIdV2(): string;
|
|
19212
20788
|
|
|
19213
20789
|
/**
|
|
19214
20790
|
* Creates a new ranking filter.
|
|
@@ -19374,6 +20950,15 @@ export declare type ObjectPermissionsObjectKind = "attribute" | "fact" | "label"
|
|
|
19374
20950
|
*/
|
|
19375
20951
|
export declare type ObjectType = "measure" | "fact" | "attribute" | "computedAttribute" | "displayForm" | "dataSet" | "tag" | "insight" | "variable" | "analyticalDashboard" | "theme" | "colorPalette" | "workspaceTheme" | "workspaceColorPalette" | "filterContext" | "dashboardPlugin" | "attributeHierarchy" | "user" | "userGroup" | "dateHierarchyTemplate" | "dateAttributeHierarchy" | "exportDefinition" | "automation" | "filterView" | "workspaceDataFilter" | "workspaceDataFilterSetting" | "userDataFilter" | "notificationChannel" | "memoryItem" | "parameter" | "reportPageLayout" | "reportTemplate" | "report";
|
|
19376
20952
|
|
|
20953
|
+
/**
|
|
20954
|
+
* Who can view a newly created object.
|
|
20955
|
+
* RESTRICTED means only its creator.
|
|
20956
|
+
* WORKSPACE means also all workspace users, with view access.
|
|
20957
|
+
*
|
|
20958
|
+
* @alpha
|
|
20959
|
+
*/
|
|
20960
|
+
export declare type ObjectVisibility = "RESTRICTED" | "WORKSPACE";
|
|
20961
|
+
|
|
19377
20962
|
/**
|
|
19378
20963
|
* Model object reference.
|
|
19379
20964
|
*
|
|
@@ -19582,98 +21167,234 @@ export declare class PoPMeasureBuilder extends MeasureBuilderBase<IPoPMeasureDef
|
|
|
19582
21167
|
}
|
|
19583
21168
|
|
|
19584
21169
|
/**
|
|
19585
|
-
* Input to the PoPMeasureBuilder.
|
|
19586
|
-
* @public
|
|
21170
|
+
* Input to the PoPMeasureBuilder.
|
|
21171
|
+
* @public
|
|
21172
|
+
*/
|
|
21173
|
+
export declare type PoPMeasureBuilderInput = {
|
|
21174
|
+
measureOrLocalId: MeasureOrLocalId;
|
|
21175
|
+
popAttrIdOrRef: ObjRef | Identifier;
|
|
21176
|
+
} | IMeasure<IPoPMeasureDefinition>;
|
|
21177
|
+
|
|
21178
|
+
/**
|
|
21179
|
+
* Builder for previous period measures.
|
|
21180
|
+
*
|
|
21181
|
+
* Do not instantiate this builder directly, instead use {@link newPreviousPeriodMeasure}.
|
|
21182
|
+
*
|
|
21183
|
+
* @public
|
|
21184
|
+
*/
|
|
21185
|
+
export declare class PreviousPeriodMeasureBuilder extends MeasureBuilderBase<IPreviousPeriodMeasureDefinition> {
|
|
21186
|
+
private previousPeriodMeasure;
|
|
21187
|
+
/**
|
|
21188
|
+
* @internal
|
|
21189
|
+
*/
|
|
21190
|
+
constructor(input: PreviousPeriodMeasureBuilderInput);
|
|
21191
|
+
/**
|
|
21192
|
+
* Sets master measure from which this previous period measure should be calculated.
|
|
21193
|
+
*
|
|
21194
|
+
* @param measureOrLocalId - measure value or measure local identifier
|
|
21195
|
+
*/
|
|
21196
|
+
masterMeasure: (measureOrLocalId: MeasureOrLocalId) => this;
|
|
21197
|
+
/**
|
|
21198
|
+
* Sets date data set + offset within the data set to use when calculating values of this measure.
|
|
21199
|
+
*
|
|
21200
|
+
* @param dd - date data set + offset
|
|
21201
|
+
*/
|
|
21202
|
+
dateDataSets: (dd: IPreviousPeriodDateDataSetSimple[]) => this;
|
|
21203
|
+
protected buildDefinition(): IPreviousPeriodMeasureDefinition;
|
|
21204
|
+
protected generateLocalId(): string;
|
|
21205
|
+
private convertDd;
|
|
21206
|
+
}
|
|
21207
|
+
|
|
21208
|
+
/**
|
|
21209
|
+
* Import to the PreviousPeriodMeasureBuilder.
|
|
21210
|
+
* @public
|
|
21211
|
+
*/
|
|
21212
|
+
export declare type PreviousPeriodMeasureBuilderInput = {
|
|
21213
|
+
measureIdOrLocalId: MeasureOrLocalId;
|
|
21214
|
+
dateDataSets: IPreviousPeriodDateDataSetSimple[];
|
|
21215
|
+
} | IMeasure<IPreviousPeriodMeasureDefinition>;
|
|
21216
|
+
|
|
21217
|
+
/**
|
|
21218
|
+
* Current version of {@link PublisherBackgroundV1}.
|
|
21219
|
+
*
|
|
21220
|
+
* @alpha
|
|
21221
|
+
*/
|
|
21222
|
+
export declare type PublisherBackground = PublisherBackgroundV1;
|
|
21223
|
+
|
|
21224
|
+
/**
|
|
21225
|
+
* What a section or page paints behind its content.
|
|
21226
|
+
*
|
|
21227
|
+
* @alpha
|
|
21228
|
+
*/
|
|
21229
|
+
export declare type PublisherBackgroundV1 = IPublisherColorBackgroundV1 | IPublisherImageBackgroundV1;
|
|
21230
|
+
|
|
21231
|
+
/**
|
|
21232
|
+
* @alpha
|
|
21233
|
+
*/
|
|
21234
|
+
export declare type PublisherBorderLineStyleV2 = "solid" | "dashed" | "dotted" | "none";
|
|
21235
|
+
|
|
21236
|
+
/**
|
|
21237
|
+
* Current version of {@link PublisherBuiltInVariableV1}.
|
|
21238
|
+
*
|
|
21239
|
+
* @alpha
|
|
21240
|
+
*/
|
|
21241
|
+
export declare type PublisherBuiltInVariable = PublisherBuiltInVariableV1;
|
|
21242
|
+
|
|
21243
|
+
/**
|
|
21244
|
+
* Current version of {@link PublisherBuiltInVariablesV1}.
|
|
21245
|
+
*
|
|
21246
|
+
* @alpha
|
|
21247
|
+
*/
|
|
21248
|
+
export declare const PublisherBuiltInVariables: PublisherBuiltInVariableV1[];
|
|
21249
|
+
|
|
21250
|
+
/**
|
|
21251
|
+
* All built-in document variable names.
|
|
21252
|
+
*
|
|
21253
|
+
* @alpha
|
|
21254
|
+
*/
|
|
21255
|
+
export declare const PublisherBuiltInVariablesV1: PublisherBuiltInVariableV1[];
|
|
21256
|
+
|
|
21257
|
+
/**
|
|
21258
|
+
* Variables resolved by the rendering runtime; they are never declared or stored.
|
|
21259
|
+
*
|
|
21260
|
+
* @remarks
|
|
21261
|
+
* Referenced from document text as `{name}`. Custom variable names must not collide with these;
|
|
21262
|
+
* on collision the built-in wins.
|
|
21263
|
+
*
|
|
21264
|
+
* @alpha
|
|
21265
|
+
*/
|
|
21266
|
+
export declare type PublisherBuiltInVariableV1 = "reportName" | "reportDescription" | "periodStart" | "periodEnd" | "reportDateRange" | "reportAttributeFilters" | "exportedAt" | "exportedBy" | "lastModifiedAt" | "lastModifiedBy" | "workspaceName" | "workspaceId" | "totalPages" | "currentPageNumber" | "logo";
|
|
21267
|
+
|
|
21268
|
+
/**
|
|
21269
|
+
* Theme color reference or literal color.
|
|
21270
|
+
*
|
|
21271
|
+
* @remarks
|
|
21272
|
+
* A reference is the whole value, never part of a longer string:
|
|
21273
|
+
* `{theme.colors.<list>.<id>}`, where list is `backgrounds`, `texts` or `lines`, or
|
|
21274
|
+
* `{theme.palette.<name>}`, where name is `primary`, `success`, `error` or `warning`.
|
|
21275
|
+
* The ids `default`, `surface`, `inverse`, `muted` and `accent` always resolve.
|
|
21276
|
+
*
|
|
21277
|
+
* A literal is `#rgb`, `#rrggbb`, `#rrggbbaa`, or `rgb()` with 3 or 4 arguments. `#rgba` is invalid.
|
|
21278
|
+
*
|
|
21279
|
+
* @alpha
|
|
21280
|
+
*/
|
|
21281
|
+
export declare type PublisherColorValueV2 = string;
|
|
21282
|
+
|
|
21283
|
+
/**
|
|
21284
|
+
* Current version of {@link PublisherContentAlignmentV1}.
|
|
21285
|
+
*
|
|
21286
|
+
* @alpha
|
|
21287
|
+
*/
|
|
21288
|
+
export declare type PublisherContentAlignment = PublisherContentAlignmentV1;
|
|
21289
|
+
|
|
21290
|
+
/**
|
|
21291
|
+
* Where content sits inside the box that carries it, along one axis.
|
|
21292
|
+
*
|
|
21293
|
+
* @alpha
|
|
21294
|
+
*/
|
|
21295
|
+
export declare type PublisherContentAlignmentV1 = "start" | "center" | "end";
|
|
21296
|
+
|
|
21297
|
+
/**
|
|
21298
|
+
* @alpha
|
|
21299
|
+
*/
|
|
21300
|
+
export declare type PublisherContentVersionV2 = "2";
|
|
21301
|
+
|
|
21302
|
+
/**
|
|
21303
|
+
* Current version of {@link PublisherDateStringV1}.
|
|
21304
|
+
*
|
|
21305
|
+
* @alpha
|
|
21306
|
+
*/
|
|
21307
|
+
export declare type PublisherDateString = PublisherDateStringV1;
|
|
21308
|
+
|
|
21309
|
+
/**
|
|
21310
|
+
* ISO 8601 calendar date (YYYY-MM-DD).
|
|
21311
|
+
*
|
|
21312
|
+
* @alpha
|
|
21313
|
+
*/
|
|
21314
|
+
export declare type PublisherDateStringV1 = string;
|
|
21315
|
+
|
|
21316
|
+
/**
|
|
21317
|
+
* Returns the sections of document content. Content stored as `pages` becomes one untitled section
|
|
21318
|
+
* with a generated id.
|
|
21319
|
+
*
|
|
21320
|
+
* @remarks
|
|
21321
|
+
* For content stored as `pages`, each call returns a new section id. Read once and keep the result
|
|
21322
|
+
* for as long as the section must stay the same one.
|
|
21323
|
+
*
|
|
21324
|
+
* @alpha
|
|
19587
21325
|
*/
|
|
19588
|
-
export declare
|
|
19589
|
-
measureOrLocalId: MeasureOrLocalId;
|
|
19590
|
-
popAttrIdOrRef: ObjRef | Identifier;
|
|
19591
|
-
} | IMeasure<IPoPMeasureDefinition>;
|
|
21326
|
+
export declare function publisherDocumentContentSectionsV2(content: PublisherDocumentContentV2): IPublisherSectionV2[];
|
|
19592
21327
|
|
|
19593
21328
|
/**
|
|
19594
|
-
*
|
|
21329
|
+
* Writes sections back into document content, in the shape the content was read in.
|
|
19595
21330
|
*
|
|
19596
|
-
*
|
|
21331
|
+
* @remarks
|
|
21332
|
+
* The result holds `sections` when the content held `sections`, when there is more than one section,
|
|
21333
|
+
* or when the only section has a title or description. Otherwise it holds `pages`, and the section's
|
|
21334
|
+
* id is dropped.
|
|
19597
21335
|
*
|
|
19598
|
-
* @
|
|
21336
|
+
* @alpha
|
|
19599
21337
|
*/
|
|
19600
|
-
export declare
|
|
19601
|
-
private previousPeriodMeasure;
|
|
19602
|
-
/**
|
|
19603
|
-
* @internal
|
|
19604
|
-
*/
|
|
19605
|
-
constructor(input: PreviousPeriodMeasureBuilderInput);
|
|
19606
|
-
/**
|
|
19607
|
-
* Sets master measure from which this previous period measure should be calculated.
|
|
19608
|
-
*
|
|
19609
|
-
* @param measureOrLocalId - measure value or measure local identifier
|
|
19610
|
-
*/
|
|
19611
|
-
masterMeasure: (measureOrLocalId: MeasureOrLocalId) => this;
|
|
19612
|
-
/**
|
|
19613
|
-
* Sets date data set + offset within the data set to use when calculating values of this measure.
|
|
19614
|
-
*
|
|
19615
|
-
* @param dd - date data set + offset
|
|
19616
|
-
*/
|
|
19617
|
-
dateDataSets: (dd: IPreviousPeriodDateDataSetSimple[]) => this;
|
|
19618
|
-
protected buildDefinition(): IPreviousPeriodMeasureDefinition;
|
|
19619
|
-
protected generateLocalId(): string;
|
|
19620
|
-
private convertDd;
|
|
19621
|
-
}
|
|
21338
|
+
export declare function publisherDocumentContentSetSectionsV2({ content, sections, }: IPublisherDocumentContentSetSectionsOptionsV2): PublisherDocumentContentV2;
|
|
19622
21339
|
|
|
19623
21340
|
/**
|
|
19624
|
-
*
|
|
19625
|
-
*
|
|
21341
|
+
* Content of a document or a document template. It holds `pages` or `sections`, never both.
|
|
21342
|
+
*
|
|
21343
|
+
* @alpha
|
|
19626
21344
|
*/
|
|
19627
|
-
export declare type
|
|
19628
|
-
measureIdOrLocalId: MeasureOrLocalId;
|
|
19629
|
-
dateDataSets: IPreviousPeriodDateDataSetSimple[];
|
|
19630
|
-
} | IMeasure<IPreviousPeriodMeasureDefinition>;
|
|
21345
|
+
export declare type PublisherDocumentContentV2 = IPublisherDocumentPagesContentV2 | IPublisherDocumentSectionsContentV2;
|
|
19631
21346
|
|
|
19632
21347
|
/**
|
|
19633
|
-
*
|
|
21348
|
+
* Current version of {@link publisherDocumentPageV1}.
|
|
19634
21349
|
*
|
|
19635
21350
|
* @alpha
|
|
19636
21351
|
*/
|
|
19637
|
-
export declare
|
|
21352
|
+
export declare const publisherDocumentPage: typeof publisherDocumentPageV1;
|
|
19638
21353
|
|
|
19639
21354
|
/**
|
|
19640
|
-
*
|
|
19641
|
-
*
|
|
19642
|
-
* @remarks
|
|
19643
|
-
* Referenced from document text as `{name}`. Custom variable names must not collide with these;
|
|
19644
|
-
* on collision the built-in wins.
|
|
21355
|
+
* Convenience accessor for a document or template page by its localIdentifier.
|
|
19645
21356
|
*
|
|
19646
21357
|
* @alpha
|
|
19647
21358
|
*/
|
|
19648
|
-
export declare
|
|
21359
|
+
export declare function publisherDocumentPageV1(documentOrTemplate: IPublisherDocumentV1 | IPublisherDocumentDefinitionV1 | IPublisherDocumentTemplateV1 | IPublisherDocumentTemplateDefinitionV1, pageLocalIdentifier: string): IPublisherDocumentPageV1 | undefined;
|
|
19649
21360
|
|
|
19650
21361
|
/**
|
|
19651
|
-
*
|
|
21362
|
+
* @alpha
|
|
21363
|
+
*/
|
|
21364
|
+
export declare type PublisherGapValueV2 = PublisherPxV2 | "{theme.spacing.gap.compact}" | "{theme.spacing.gap.normal}" | "{theme.spacing.gap.spacious}";
|
|
21365
|
+
|
|
21366
|
+
/**
|
|
21367
|
+
* Text style a heading uses when its style sets none: `h(n+1)` for level n, `h6` for levels 5 and 6.
|
|
19652
21368
|
*
|
|
19653
21369
|
* @alpha
|
|
19654
21370
|
*/
|
|
19655
|
-
export declare
|
|
21371
|
+
export declare function publisherHeadingDefaultTextStyleV2(level?: PublisherHeadingLevelV2): Extract<PublisherTextStyleNameV2, "h2" | "h3" | "h4" | "h5" | "h6">;
|
|
19656
21372
|
|
|
19657
21373
|
/**
|
|
19658
|
-
*
|
|
21374
|
+
* @alpha
|
|
21375
|
+
*/
|
|
21376
|
+
export declare type PublisherHeadingLevelV2 = 1 | 2 | 3 | 4 | 5 | 6;
|
|
21377
|
+
|
|
21378
|
+
/**
|
|
21379
|
+
* Current version of {@link PublisherHeadingTypeV1}.
|
|
19659
21380
|
*
|
|
19660
21381
|
* @alpha
|
|
19661
21382
|
*/
|
|
19662
|
-
export declare type
|
|
21383
|
+
export declare type PublisherHeadingType = PublisherHeadingTypeV1;
|
|
19663
21384
|
|
|
19664
21385
|
/**
|
|
19665
|
-
*
|
|
21386
|
+
* Current version of {@link PublisherHeadingTypesV1}.
|
|
19666
21387
|
*
|
|
19667
21388
|
* @alpha
|
|
19668
21389
|
*/
|
|
19669
|
-
export declare
|
|
21390
|
+
export declare const PublisherHeadingTypes: PublisherHeadingTypeV1[];
|
|
19670
21391
|
|
|
19671
21392
|
/**
|
|
19672
|
-
*
|
|
21393
|
+
* All heading sizes, largest first.
|
|
19673
21394
|
*
|
|
19674
21395
|
* @alpha
|
|
19675
21396
|
*/
|
|
19676
|
-
export declare
|
|
21397
|
+
export declare const PublisherHeadingTypesV1: PublisherHeadingTypeV1[];
|
|
19677
21398
|
|
|
19678
21399
|
/**
|
|
19679
21400
|
* Size a heading is rendered at. Each size is styled by the matching theme text level
|
|
@@ -19681,14 +21402,19 @@ export declare function publisherDocumentPage(documentOrTemplate: IPublisherDocu
|
|
|
19681
21402
|
*
|
|
19682
21403
|
* @alpha
|
|
19683
21404
|
*/
|
|
19684
|
-
export declare type
|
|
21405
|
+
export declare type PublisherHeadingTypeV1 = "h1" | "h2" | "h3" | "h4" | "h5" | "h6";
|
|
19685
21406
|
|
|
19686
21407
|
/**
|
|
19687
|
-
*
|
|
21408
|
+
* @alpha
|
|
21409
|
+
*/
|
|
21410
|
+
export declare type PublisherHorizontalAlignV2 = "left" | "center" | "right";
|
|
21411
|
+
|
|
21412
|
+
/**
|
|
21413
|
+
* Current version of {@link PublisherImageFitV1}.
|
|
19688
21414
|
*
|
|
19689
21415
|
* @alpha
|
|
19690
21416
|
*/
|
|
19691
|
-
export declare
|
|
21417
|
+
export declare type PublisherImageFit = PublisherImageFitV1;
|
|
19692
21418
|
|
|
19693
21419
|
/**
|
|
19694
21420
|
* How an image is fitted to the area it is drawn in: kept whole inside it, filling it and cropped to
|
|
@@ -19696,14 +21422,21 @@ export declare const PublisherHeadingTypes: PublisherHeadingType[];
|
|
|
19696
21422
|
*
|
|
19697
21423
|
* @alpha
|
|
19698
21424
|
*/
|
|
19699
|
-
export declare type
|
|
21425
|
+
export declare type PublisherImageFitV1 = "contain" | "cover" | "fill";
|
|
21426
|
+
|
|
21427
|
+
/**
|
|
21428
|
+
* Current version of {@link PublisherImageSourceV1}.
|
|
21429
|
+
*
|
|
21430
|
+
* @alpha
|
|
21431
|
+
*/
|
|
21432
|
+
export declare type PublisherImageSource = PublisherImageSourceV1;
|
|
19700
21433
|
|
|
19701
21434
|
/**
|
|
19702
21435
|
* What an image slot displays.
|
|
19703
21436
|
*
|
|
19704
21437
|
* @alpha
|
|
19705
21438
|
*/
|
|
19706
|
-
export declare type
|
|
21439
|
+
export declare type PublisherImageSourceV1 = {
|
|
19707
21440
|
type: "url";
|
|
19708
21441
|
/**
|
|
19709
21442
|
* Image URL. Supports `{variables}` — a logo slot uses `{logo}`.
|
|
@@ -19717,6 +21450,73 @@ export declare type PublisherImageSource = {
|
|
|
19717
21450
|
ref: ObjRef;
|
|
19718
21451
|
};
|
|
19719
21452
|
|
|
21453
|
+
/**
|
|
21454
|
+
* Theme image reference or https URL.
|
|
21455
|
+
*
|
|
21456
|
+
* @remarks
|
|
21457
|
+
* A reference is the whole value: `{theme.logo}`, `{theme.coverImage}`, `{theme.assets.logos.<id>}`
|
|
21458
|
+
* or `{theme.assets.images.<id>}`.
|
|
21459
|
+
*
|
|
21460
|
+
* A URL must start with `https://` and may contain text variables; each resolved value is
|
|
21461
|
+
* percent-encoded and the result must still start with `https://`.
|
|
21462
|
+
*
|
|
21463
|
+
* @alpha
|
|
21464
|
+
*/
|
|
21465
|
+
export declare type PublisherImageSourceV2 = string;
|
|
21466
|
+
|
|
21467
|
+
/**
|
|
21468
|
+
* @alpha
|
|
21469
|
+
*/
|
|
21470
|
+
export declare type PublisherLayoutNodeV2 = IPublisherContainerV2 | PublisherWidgetV2;
|
|
21471
|
+
|
|
21472
|
+
/**
|
|
21473
|
+
* Number from 0 to 1.
|
|
21474
|
+
*
|
|
21475
|
+
* @alpha
|
|
21476
|
+
*/
|
|
21477
|
+
export declare type PublisherOpacityV2 = number;
|
|
21478
|
+
|
|
21479
|
+
/**
|
|
21480
|
+
* @alpha
|
|
21481
|
+
*/
|
|
21482
|
+
export declare type PublisherPaddingValueV2 = PublisherPxV2 | "{theme.spacing.padding.compact}" | "{theme.spacing.padding.normal}" | "{theme.spacing.padding.spacious}";
|
|
21483
|
+
|
|
21484
|
+
/**
|
|
21485
|
+
* Current version of {@link PublisherPageFormatV1}.
|
|
21486
|
+
*
|
|
21487
|
+
* @alpha
|
|
21488
|
+
*/
|
|
21489
|
+
export declare type PublisherPageFormat = PublisherPageFormatV1;
|
|
21490
|
+
|
|
21491
|
+
/**
|
|
21492
|
+
* Current version of {@link PublisherPageFormatAspectRatiosV1}.
|
|
21493
|
+
*
|
|
21494
|
+
* @alpha
|
|
21495
|
+
*/
|
|
21496
|
+
export declare const PublisherPageFormatAspectRatios: Record<PublisherPageFormatV1, number>;
|
|
21497
|
+
|
|
21498
|
+
/**
|
|
21499
|
+
* Width divided by height for each page format: 16:9 for a widescreen page, ISO A4 (210 x 297 mm) and
|
|
21500
|
+
* US Letter (8.5 x 11 in) upright.
|
|
21501
|
+
*
|
|
21502
|
+
* @alpha
|
|
21503
|
+
*/
|
|
21504
|
+
export declare const PublisherPageFormatAspectRatiosV1: Record<PublisherPageFormatV1, number>;
|
|
21505
|
+
|
|
21506
|
+
/**
|
|
21507
|
+
* Current version of {@link PublisherPageFormatsV1}.
|
|
21508
|
+
*
|
|
21509
|
+
* @alpha
|
|
21510
|
+
*/
|
|
21511
|
+
export declare const PublisherPageFormats: PublisherPageFormatV1[];
|
|
21512
|
+
|
|
21513
|
+
/**
|
|
21514
|
+
* List of built-in page format names.
|
|
21515
|
+
*
|
|
21516
|
+
* @alpha
|
|
21517
|
+
*/
|
|
21518
|
+
export declare const PublisherPageFormatsV1: PublisherPageFormatV1[];
|
|
21519
|
+
|
|
19720
21520
|
/**
|
|
19721
21521
|
* Page shape a page layout is designed for.
|
|
19722
21522
|
*
|
|
@@ -19727,31 +21527,63 @@ export declare type PublisherImageSource = {
|
|
|
19727
21527
|
*
|
|
19728
21528
|
* @alpha
|
|
19729
21529
|
*/
|
|
19730
|
-
export declare type
|
|
21530
|
+
export declare type PublisherPageFormatV1 = "widescreen" | "a4Portrait" | "letterPortrait";
|
|
19731
21531
|
|
|
19732
21532
|
/**
|
|
19733
|
-
*
|
|
19734
|
-
* US Letter (8.5 x 11 in) upright.
|
|
21533
|
+
* Editor hint; it does not change how the page renders.
|
|
19735
21534
|
*
|
|
19736
21535
|
* @alpha
|
|
19737
21536
|
*/
|
|
19738
|
-
export declare
|
|
21537
|
+
export declare type PublisherPageKindV2 = "cover" | "section" | "content";
|
|
19739
21538
|
|
|
19740
21539
|
/**
|
|
19741
|
-
*
|
|
21540
|
+
* Current version of {@link PublisherPageLayoutNodeV1}.
|
|
19742
21541
|
*
|
|
19743
21542
|
* @alpha
|
|
19744
21543
|
*/
|
|
19745
|
-
export declare
|
|
21544
|
+
export declare type PublisherPageLayoutNode = PublisherPageLayoutNodeV1;
|
|
19746
21545
|
|
|
19747
21546
|
/**
|
|
19748
21547
|
* Node of a page layout: a recursive row/column split tree (flexbox semantics)
|
|
19749
21548
|
* over a fixed page. Leaves assign their area to slots; the tree carries geometry and
|
|
19750
|
-
* box paint, slot content lives in {@link
|
|
21549
|
+
* box paint, slot content lives in {@link IPublisherPageBodyV1.slots}.
|
|
21550
|
+
*
|
|
21551
|
+
* @alpha
|
|
21552
|
+
*/
|
|
21553
|
+
export declare type PublisherPageLayoutNodeV1 = IPublisherLayoutSectionV1 | IPublisherLayoutSlotRefV1;
|
|
21554
|
+
|
|
21555
|
+
/**
|
|
21556
|
+
* @alpha
|
|
21557
|
+
*/
|
|
21558
|
+
export declare const PublisherPageSizesV2: readonly ["widescreen"];
|
|
21559
|
+
|
|
21560
|
+
/**
|
|
21561
|
+
* Page size. The widescreen design canvas is 1920 × 1080 px.
|
|
21562
|
+
*
|
|
21563
|
+
* @alpha
|
|
21564
|
+
*/
|
|
21565
|
+
export declare type PublisherPageSizeV2 = (typeof PublisherPageSizesV2)[number];
|
|
21566
|
+
|
|
21567
|
+
/**
|
|
21568
|
+
* Current version of {@link PublisherParagraphTypeV1}.
|
|
21569
|
+
*
|
|
21570
|
+
* @alpha
|
|
21571
|
+
*/
|
|
21572
|
+
export declare type PublisherParagraphType = PublisherParagraphTypeV1;
|
|
21573
|
+
|
|
21574
|
+
/**
|
|
21575
|
+
* Current version of {@link PublisherParagraphTypesV1}.
|
|
21576
|
+
*
|
|
21577
|
+
* @alpha
|
|
21578
|
+
*/
|
|
21579
|
+
export declare const PublisherParagraphTypes: PublisherParagraphTypeV1[];
|
|
21580
|
+
|
|
21581
|
+
/**
|
|
21582
|
+
* All paragraph sizes, largest first.
|
|
19751
21583
|
*
|
|
19752
21584
|
* @alpha
|
|
19753
21585
|
*/
|
|
19754
|
-
export declare
|
|
21586
|
+
export declare const PublisherParagraphTypesV1: PublisherParagraphTypeV1[];
|
|
19755
21587
|
|
|
19756
21588
|
/**
|
|
19757
21589
|
* Size a paragraph is rendered at. Each size is styled by the matching theme text level
|
|
@@ -19759,28 +21591,82 @@ export declare type PublisherPageLayoutNode = IPublisherLayoutSection | IPublish
|
|
|
19759
21591
|
*
|
|
19760
21592
|
* @alpha
|
|
19761
21593
|
*/
|
|
19762
|
-
export declare type
|
|
21594
|
+
export declare type PublisherParagraphTypeV1 = "largeText" | "normalText" | "smallText";
|
|
19763
21595
|
|
|
19764
21596
|
/**
|
|
19765
|
-
*
|
|
21597
|
+
* Reported period, in the dashboard date filter grammar without a dataset.
|
|
21598
|
+
*
|
|
21599
|
+
* @alpha
|
|
21600
|
+
*/
|
|
21601
|
+
export declare type PublisherPeriodV2 = IPublisherAbsolutePeriodV2 | IPublisherRelativePeriodV2;
|
|
21602
|
+
|
|
21603
|
+
/**
|
|
21604
|
+
* Length in px on the page's design canvas, zero or more.
|
|
21605
|
+
*
|
|
21606
|
+
* @alpha
|
|
21607
|
+
*/
|
|
21608
|
+
export declare type PublisherPxV2 = number;
|
|
21609
|
+
|
|
21610
|
+
/**
|
|
21611
|
+
* @alpha
|
|
21612
|
+
*/
|
|
21613
|
+
export declare type PublisherRadiusValueV2 = PublisherPxV2 | "{theme.corners.small}" | "{theme.corners.medium}" | "{theme.corners.large}" | "{theme.corners.full}";
|
|
21614
|
+
|
|
21615
|
+
/**
|
|
21616
|
+
* `{theme.shadows.<name>}` or `none`.
|
|
21617
|
+
*
|
|
21618
|
+
* @alpha
|
|
21619
|
+
*/
|
|
21620
|
+
export declare type PublisherShadowValueV2 = string;
|
|
21621
|
+
|
|
21622
|
+
/**
|
|
21623
|
+
* Current version of {@link PublisherSlotV1}.
|
|
19766
21624
|
*
|
|
19767
21625
|
* @alpha
|
|
19768
21626
|
*/
|
|
19769
|
-
export declare
|
|
21627
|
+
export declare type PublisherSlot = PublisherSlotV1;
|
|
19770
21628
|
|
|
19771
21629
|
/**
|
|
19772
21630
|
* All slot types of document content version 1.
|
|
19773
21631
|
*
|
|
19774
21632
|
* @alpha
|
|
19775
21633
|
*/
|
|
19776
|
-
export declare type
|
|
21634
|
+
export declare type PublisherSlotV1 = IPublisherVisualizationSlotV1 | IPublisherTextSlotV1 | IPublisherImageSlotV1;
|
|
21635
|
+
|
|
21636
|
+
/**
|
|
21637
|
+
* Current version of {@link publisherTextPlaceholderV1}.
|
|
21638
|
+
*
|
|
21639
|
+
* @alpha
|
|
21640
|
+
*/
|
|
21641
|
+
export declare const publisherTextPlaceholder: typeof publisherTextPlaceholderV1;
|
|
19777
21642
|
|
|
19778
21643
|
/**
|
|
19779
21644
|
* The marker referencing the named variable from document text.
|
|
19780
21645
|
*
|
|
19781
21646
|
* @alpha
|
|
19782
21647
|
*/
|
|
19783
|
-
export declare function
|
|
21648
|
+
export declare function publisherTextPlaceholderV1(name: string): string;
|
|
21649
|
+
|
|
21650
|
+
/**
|
|
21651
|
+
* Current version of {@link publisherTextSlotTypeV1}.
|
|
21652
|
+
*
|
|
21653
|
+
* @alpha
|
|
21654
|
+
*/
|
|
21655
|
+
export declare const publisherTextSlotType: typeof publisherTextSlotTypeV1;
|
|
21656
|
+
|
|
21657
|
+
/**
|
|
21658
|
+
* Current version of {@link publisherTextSlotTypesV1}.
|
|
21659
|
+
*
|
|
21660
|
+
* @alpha
|
|
21661
|
+
*/
|
|
21662
|
+
export declare const publisherTextSlotTypes: typeof publisherTextSlotTypesV1;
|
|
21663
|
+
|
|
21664
|
+
/**
|
|
21665
|
+
* Sizes the slot can be rendered at, which is what its own type decides.
|
|
21666
|
+
*
|
|
21667
|
+
* @alpha
|
|
21668
|
+
*/
|
|
21669
|
+
export declare function publisherTextSlotTypesV1(slot: IPublisherTextSlotV1): PublisherTextTypeV1[];
|
|
19784
21670
|
|
|
19785
21671
|
/**
|
|
19786
21672
|
* Size the slot is rendered at.
|
|
@@ -19791,35 +21677,81 @@ export declare function publisherTextPlaceholder(name: string): string;
|
|
|
19791
21677
|
*
|
|
19792
21678
|
* @alpha
|
|
19793
21679
|
*/
|
|
19794
|
-
export declare function
|
|
21680
|
+
export declare function publisherTextSlotTypeV1(slot: IPublisherTextSlotV1): PublisherTextTypeV1;
|
|
19795
21681
|
|
|
19796
21682
|
/**
|
|
19797
|
-
*
|
|
21683
|
+
* Current version of {@link PublisherTextSourceV1}.
|
|
19798
21684
|
*
|
|
19799
21685
|
* @alpha
|
|
19800
21686
|
*/
|
|
19801
|
-
export declare
|
|
21687
|
+
export declare type PublisherTextSource = PublisherTextSourceV1;
|
|
19802
21688
|
|
|
19803
21689
|
/**
|
|
19804
21690
|
* Where the text of a text slot comes from.
|
|
19805
21691
|
*
|
|
19806
21692
|
* @alpha
|
|
19807
21693
|
*/
|
|
19808
|
-
export declare type
|
|
21694
|
+
export declare type PublisherTextSourceV1 = IPublisherStaticTextSourceV1 | IPublisherAiTextSourceV1;
|
|
19809
21695
|
|
|
19810
21696
|
/**
|
|
19811
|
-
*
|
|
21697
|
+
* @alpha
|
|
21698
|
+
*/
|
|
21699
|
+
export declare const PublisherTextStyleNamesV2: readonly ["title", "h1", "h2", "h3", "h4", "h5", "h6", "largeText", "normalText", "smallText"];
|
|
21700
|
+
|
|
21701
|
+
/**
|
|
21702
|
+
* Named text style from the theme's `documents.textStyle`.
|
|
21703
|
+
*
|
|
21704
|
+
* @alpha
|
|
21705
|
+
*/
|
|
21706
|
+
export declare type PublisherTextStyleNameV2 = (typeof PublisherTextStyleNamesV2)[number];
|
|
21707
|
+
|
|
21708
|
+
/**
|
|
21709
|
+
* Current version of {@link PublisherTextTypeV1}.
|
|
21710
|
+
*
|
|
21711
|
+
* @alpha
|
|
21712
|
+
*/
|
|
21713
|
+
export declare type PublisherTextType = PublisherTextTypeV1;
|
|
21714
|
+
|
|
21715
|
+
/**
|
|
21716
|
+
* Current version of {@link PublisherTextTypesV1}.
|
|
19812
21717
|
*
|
|
19813
21718
|
* @alpha
|
|
19814
21719
|
*/
|
|
19815
|
-
export declare
|
|
21720
|
+
export declare const PublisherTextTypes: PublisherTextTypeV1[];
|
|
19816
21721
|
|
|
19817
21722
|
/**
|
|
19818
21723
|
* All sizes a text slot can be rendered at, headings first.
|
|
19819
21724
|
*
|
|
19820
21725
|
* @alpha
|
|
19821
21726
|
*/
|
|
19822
|
-
export declare const
|
|
21727
|
+
export declare const PublisherTextTypesV1: PublisherTextTypeV1[];
|
|
21728
|
+
|
|
21729
|
+
/**
|
|
21730
|
+
* Size any document text is rendered at.
|
|
21731
|
+
*
|
|
21732
|
+
* @alpha
|
|
21733
|
+
*/
|
|
21734
|
+
export declare type PublisherTextTypeV1 = PublisherHeadingTypeV1 | PublisherParagraphTypeV1;
|
|
21735
|
+
|
|
21736
|
+
/**
|
|
21737
|
+
* @alpha
|
|
21738
|
+
*/
|
|
21739
|
+
export declare type PublisherVerticalAlignV2 = "top" | "center" | "bottom";
|
|
21740
|
+
|
|
21741
|
+
/**
|
|
21742
|
+
* @alpha
|
|
21743
|
+
*/
|
|
21744
|
+
export declare const PublisherWidgetTypesV2: readonly ["title", "heading", "text", "image", "visualization", "takeaway"];
|
|
21745
|
+
|
|
21746
|
+
/**
|
|
21747
|
+
* @alpha
|
|
21748
|
+
*/
|
|
21749
|
+
export declare type PublisherWidgetTypeV2 = (typeof PublisherWidgetTypesV2)[number];
|
|
21750
|
+
|
|
21751
|
+
/**
|
|
21752
|
+
* @alpha
|
|
21753
|
+
*/
|
|
21754
|
+
export declare type PublisherWidgetV2 = IPublisherTitleWidgetV2 | IPublisherHeadingWidgetV2 | IPublisherTextWidgetV2 | IPublisherImageWidgetV2 | IPublisherVisualizationWidgetV2 | IPublisherTakeawayWidgetV2;
|
|
19823
21755
|
|
|
19824
21756
|
/**
|
|
19825
21757
|
* @public
|
|
@@ -19897,6 +21829,13 @@ export declare type RequiredSettings = Condition<Partial<IPermanentSettings | IF
|
|
|
19897
21829
|
*/
|
|
19898
21830
|
export declare type RequiredWorkspacePermissions = Condition<Partial<IPluggableApplicationWorkspacePermissions>>;
|
|
19899
21831
|
|
|
21832
|
+
/**
|
|
21833
|
+
* Current version of {@link resolvePublisherTextPlaceholdersV1}.
|
|
21834
|
+
*
|
|
21835
|
+
* @alpha
|
|
21836
|
+
*/
|
|
21837
|
+
export declare const resolvePublisherTextPlaceholders: typeof resolvePublisherTextPlaceholdersV1;
|
|
21838
|
+
|
|
19900
21839
|
/**
|
|
19901
21840
|
* Replaces `{variable}` markers with values. Markers with no value are left as-is.
|
|
19902
21841
|
* Values are inserted verbatim — there is no recursive expansion.
|
|
@@ -19907,7 +21846,7 @@ export declare type RequiredWorkspacePermissions = Condition<Partial<IPluggableA
|
|
|
19907
21846
|
*
|
|
19908
21847
|
* @alpha
|
|
19909
21848
|
*/
|
|
19910
|
-
export declare function
|
|
21849
|
+
export declare function resolvePublisherTextPlaceholdersV1(text: string, values: Record<string, string>): string;
|
|
19911
21850
|
|
|
19912
21851
|
/**
|
|
19913
21852
|
* Resolves a dashboard timezone value to a concrete IANA timezone ID: the {@link BROWSER_DETECTED}
|
|
@@ -20298,6 +22237,32 @@ export declare type UserDataFilterDefinition = IUserDataFilterDefinition | IUser
|
|
|
20298
22237
|
*/
|
|
20299
22238
|
export declare function userFullName(user: IUser): string | undefined;
|
|
20300
22239
|
|
|
22240
|
+
/**
|
|
22241
|
+
* Validates the content of a document or a document template: every key, value and node type,
|
|
22242
|
+
* exactly one of `pages` and `sections`, page and section ids unique in the document, a `dataSet` on
|
|
22243
|
+
* every date filter, at most one filter per attribute display form or date dataset, and the page
|
|
22244
|
+
* rules on every page.
|
|
22245
|
+
*
|
|
22246
|
+
* @alpha
|
|
22247
|
+
*/
|
|
22248
|
+
export declare function validatePublisherDocumentContentV2(content: unknown): IPublisherValidationIssueV2[];
|
|
22249
|
+
|
|
22250
|
+
/**
|
|
22251
|
+
* Validates a document, document template or page template, as a definition or as a persisted
|
|
22252
|
+
* object: everything its content validator checks, `version` `"2"`, `defaults.period` set on document
|
|
22253
|
+
* templates only, and the `default.` id prefix left to the backend's default page templates.
|
|
22254
|
+
*
|
|
22255
|
+
* @alpha
|
|
22256
|
+
*/
|
|
22257
|
+
export declare function validatePublisherEntityV2(entity: unknown): IPublisherValidationIssueV2[];
|
|
22258
|
+
|
|
22259
|
+
/**
|
|
22260
|
+
* Current version of {@link validatePublisherPageBodyV1}.
|
|
22261
|
+
*
|
|
22262
|
+
* @alpha
|
|
22263
|
+
*/
|
|
22264
|
+
export declare const validatePublisherPageBody: typeof validatePublisherPageBodyV1;
|
|
22265
|
+
|
|
20301
22266
|
/**
|
|
20302
22267
|
* Validates the structural invariants of a page body beyond what its types guarantee for content
|
|
20303
22268
|
* arriving from the wire: the page format is known, slot localIdentifiers are unique, layout
|
|
@@ -20308,7 +22273,15 @@ export declare function userFullName(user: IUser): string | undefined;
|
|
|
20308
22273
|
*
|
|
20309
22274
|
* @alpha
|
|
20310
22275
|
*/
|
|
20311
|
-
export declare function
|
|
22276
|
+
export declare function validatePublisherPageBodyV1(body: IPublisherPageBodyV1): IPublisherPageBodyValidationIssueV1[];
|
|
22277
|
+
|
|
22278
|
+
/**
|
|
22279
|
+
* Validates a page body, such as a page template's content: every key, value and node type, at most
|
|
22280
|
+
* one title widget, and widget ids unique in the page.
|
|
22281
|
+
*
|
|
22282
|
+
* @alpha
|
|
22283
|
+
*/
|
|
22284
|
+
export declare function validatePublisherPageBodyV2(body: unknown): IPublisherValidationIssueV2[];
|
|
20312
22285
|
|
|
20313
22286
|
/**
|
|
20314
22287
|
* Builder for virtual arithmetic measures.
|