@gooddata/sdk-model 11.63.0-alpha.0 → 11.63.0-alpha.2
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/agentSkill/index.d.ts +1 -1
- package/esm/agentSkill/index.d.ts.map +1 -1
- package/esm/index.d.ts +8 -6
- package/esm/index.d.ts.map +1 -1
- package/esm/index.js +6 -4
- package/esm/publisher/aliases.d.ts +33 -33
- package/esm/publisher/aliases.d.ts.map +1 -1
- package/esm/publisher/aliases.js +25 -25
- package/esm/publisher/v1/content.d.ts +2 -2
- package/esm/publisher/v1/content.d.ts.map +1 -1
- package/esm/publisher/v1/defaultPageTemplates.d.ts +45 -0
- package/esm/publisher/v1/defaultPageTemplates.d.ts.map +1 -0
- package/esm/publisher/v1/{builtinPageLayouts.js → defaultPageTemplates.js} +25 -25
- package/esm/publisher/v1/factory.d.ts +5 -5
- package/esm/publisher/v1/factory.d.ts.map +1 -1
- package/esm/publisher/v1/factory.js +4 -4
- package/esm/publisher/v1/layout.d.ts +4 -4
- package/esm/publisher/v1/layout.d.ts.map +1 -1
- package/esm/publisher/v1/pageFormat.d.ts +1 -1
- package/esm/publisher/v1/{pageLayout.d.ts → pageTemplate.d.ts} +19 -19
- package/esm/publisher/v1/pageTemplate.d.ts.map +1 -0
- package/esm/publisher/v1/{pageLayout.js → pageTemplate.js} +7 -7
- package/esm/publisher/v1/slot.d.ts +1 -1
- package/esm/publisher/v2/themeReference.d.ts +17 -0
- package/esm/publisher/v2/themeReference.d.ts.map +1 -0
- package/esm/publisher/v2/themeReference.js +27 -0
- package/esm/publisher/v2/variables.d.ts +31 -0
- package/esm/publisher/v2/variables.d.ts.map +1 -0
- package/esm/publisher/v2/variables.js +59 -0
- package/esm/sdk-model.d.ts +483 -179
- package/esm/settings/settings.d.ts +4 -0
- package/esm/settings/settings.d.ts.map +1 -1
- package/esm/theme/index.d.ts +231 -0
- package/esm/theme/index.d.ts.map +1 -1
- package/package.json +3 -3
- package/esm/publisher/v1/builtinPageLayouts.d.ts +0 -45
- package/esm/publisher/v1/builtinPageLayouts.d.ts.map +0 -1
- package/esm/publisher/v1/pageLayout.d.ts.map +0 -1
package/esm/sdk-model.d.ts
CHANGED
|
@@ -43,7 +43,7 @@ export declare type AccessGranularPermission = "VIEW" | "EDIT" | "SHARE";
|
|
|
43
43
|
*
|
|
44
44
|
* @alpha
|
|
45
45
|
*/
|
|
46
|
-
export declare type AgentCustomSkill = "alert" | "anomaly_detection" | "clustering" | "dashboard_builder" | "dashboard_editor" | "dashboard_summary" | "forecasting" | "key_driver_analysis" | "metric" | "schedule_export" | "visualization" | "visualization_summary" | "what_if_analysis" | "knowledge" | "report_builder";
|
|
46
|
+
export declare type AgentCustomSkill = "alert" | "anomaly_detection" | "clustering" | "dashboard_builder" | "dashboard_editor" | "dashboard_summary" | "document_builder" | "forecasting" | "key_driver_analysis" | "metric" | "schedule_export" | "visualization" | "visualization_summary" | "what_if_analysis" | "knowledge" | "report_builder";
|
|
47
47
|
|
|
48
48
|
/**
|
|
49
49
|
* Determines when an agent instruction is applied to a request.
|
|
@@ -970,105 +970,6 @@ 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
|
-
|
|
980
|
-
/**
|
|
981
|
-
* Built-in cover page: document title and subtitle.
|
|
982
|
-
*
|
|
983
|
-
* @alpha
|
|
984
|
-
*/
|
|
985
|
-
export declare const BuiltInPublisherPageLayoutCoverV1: IPublisherPageLayoutV1;
|
|
986
|
-
|
|
987
|
-
/**
|
|
988
|
-
* Current version of {@link BuiltInPublisherPageLayoutPortraitCoverV1}.
|
|
989
|
-
*
|
|
990
|
-
* @alpha
|
|
991
|
-
*/
|
|
992
|
-
export declare const BuiltInPublisherPageLayoutPortraitCover: IPublisherPageLayoutV1;
|
|
993
|
-
|
|
994
|
-
/**
|
|
995
|
-
* Built-in portrait cover page: document title and subtitle.
|
|
996
|
-
*
|
|
997
|
-
* @alpha
|
|
998
|
-
*/
|
|
999
|
-
export declare const BuiltInPublisherPageLayoutPortraitCoverV1: IPublisherPageLayoutV1;
|
|
1000
|
-
|
|
1001
|
-
/**
|
|
1002
|
-
* Current version of {@link BuiltInPublisherPageLayoutPortraitSectionV1}.
|
|
1003
|
-
*
|
|
1004
|
-
* @alpha
|
|
1005
|
-
*/
|
|
1006
|
-
export declare const BuiltInPublisherPageLayoutPortraitSection: IPublisherPageLayoutV1;
|
|
1007
|
-
|
|
1008
|
-
/**
|
|
1009
|
-
* Built-in portrait section divider page.
|
|
1010
|
-
*
|
|
1011
|
-
* @alpha
|
|
1012
|
-
*/
|
|
1013
|
-
export declare const BuiltInPublisherPageLayoutPortraitSectionV1: IPublisherPageLayoutV1;
|
|
1014
|
-
|
|
1015
|
-
/**
|
|
1016
|
-
* Current version of {@link BuiltInPublisherPageLayoutPortraitSummaryV1}.
|
|
1017
|
-
*
|
|
1018
|
-
* @alpha
|
|
1019
|
-
*/
|
|
1020
|
-
export declare const BuiltInPublisherPageLayoutPortraitSummary: IPublisherPageLayoutV1;
|
|
1021
|
-
|
|
1022
|
-
/**
|
|
1023
|
-
* Built-in portrait page carrying a full-page narrative, with no visualization.
|
|
1024
|
-
*
|
|
1025
|
-
* @alpha
|
|
1026
|
-
*/
|
|
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;
|
|
1049
|
-
|
|
1050
|
-
/**
|
|
1051
|
-
* All built-in page layouts served by the SPI. Built-ins are read-only: they cannot be
|
|
1052
|
-
* edited or deleted, and they are never persisted on the backend.
|
|
1053
|
-
*
|
|
1054
|
-
* @alpha
|
|
1055
|
-
*/
|
|
1056
|
-
export declare const BuiltInPublisherPageLayoutsV1: readonly IPublisherPageLayoutV1[];
|
|
1057
|
-
|
|
1058
|
-
/**
|
|
1059
|
-
* Current version of {@link BuiltInPublisherPageLayoutViz6TextLeftV1}.
|
|
1060
|
-
*
|
|
1061
|
-
* @alpha
|
|
1062
|
-
*/
|
|
1063
|
-
export declare const BuiltInPublisherPageLayoutViz6TextLeft: IPublisherPageLayoutV1;
|
|
1064
|
-
|
|
1065
|
-
/**
|
|
1066
|
-
* Built-in content page with six visualizations and a text column on the left.
|
|
1067
|
-
*
|
|
1068
|
-
* @alpha
|
|
1069
|
-
*/
|
|
1070
|
-
export declare const BuiltInPublisherPageLayoutViz6TextLeftV1: IPublisherPageLayoutV1;
|
|
1071
|
-
|
|
1072
973
|
/**
|
|
1073
974
|
* Current version of {@link BuiltInPublisherSlotTypesV1}.
|
|
1074
975
|
*
|
|
@@ -1972,6 +1873,105 @@ export declare const DefaultPublisherPageFormatV1: PublisherPageFormatV1;
|
|
|
1972
1873
|
*/
|
|
1973
1874
|
export declare const DefaultPublisherPageSizeV2: PublisherPageSizeV2;
|
|
1974
1875
|
|
|
1876
|
+
/**
|
|
1877
|
+
* Current version of {@link DefaultPublisherPageTemplateCoverV1}.
|
|
1878
|
+
*
|
|
1879
|
+
* @alpha
|
|
1880
|
+
*/
|
|
1881
|
+
export declare const DefaultPublisherPageTemplateCover: IPublisherPageTemplateV1;
|
|
1882
|
+
|
|
1883
|
+
/**
|
|
1884
|
+
* Default cover page: document title and subtitle.
|
|
1885
|
+
*
|
|
1886
|
+
* @alpha
|
|
1887
|
+
*/
|
|
1888
|
+
export declare const DefaultPublisherPageTemplateCoverV1: IPublisherPageTemplateV1;
|
|
1889
|
+
|
|
1890
|
+
/**
|
|
1891
|
+
* Current version of {@link DefaultPublisherPageTemplatePortraitCoverV1}.
|
|
1892
|
+
*
|
|
1893
|
+
* @alpha
|
|
1894
|
+
*/
|
|
1895
|
+
export declare const DefaultPublisherPageTemplatePortraitCover: IPublisherPageTemplateV1;
|
|
1896
|
+
|
|
1897
|
+
/**
|
|
1898
|
+
* Default portrait cover page: document title and subtitle.
|
|
1899
|
+
*
|
|
1900
|
+
* @alpha
|
|
1901
|
+
*/
|
|
1902
|
+
export declare const DefaultPublisherPageTemplatePortraitCoverV1: IPublisherPageTemplateV1;
|
|
1903
|
+
|
|
1904
|
+
/**
|
|
1905
|
+
* Current version of {@link DefaultPublisherPageTemplatePortraitSectionV1}.
|
|
1906
|
+
*
|
|
1907
|
+
* @alpha
|
|
1908
|
+
*/
|
|
1909
|
+
export declare const DefaultPublisherPageTemplatePortraitSection: IPublisherPageTemplateV1;
|
|
1910
|
+
|
|
1911
|
+
/**
|
|
1912
|
+
* Default portrait section divider page.
|
|
1913
|
+
*
|
|
1914
|
+
* @alpha
|
|
1915
|
+
*/
|
|
1916
|
+
export declare const DefaultPublisherPageTemplatePortraitSectionV1: IPublisherPageTemplateV1;
|
|
1917
|
+
|
|
1918
|
+
/**
|
|
1919
|
+
* Current version of {@link DefaultPublisherPageTemplatePortraitSummaryV1}.
|
|
1920
|
+
*
|
|
1921
|
+
* @alpha
|
|
1922
|
+
*/
|
|
1923
|
+
export declare const DefaultPublisherPageTemplatePortraitSummary: IPublisherPageTemplateV1;
|
|
1924
|
+
|
|
1925
|
+
/**
|
|
1926
|
+
* Default portrait page carrying a full-page narrative, with no visualization.
|
|
1927
|
+
*
|
|
1928
|
+
* @alpha
|
|
1929
|
+
*/
|
|
1930
|
+
export declare const DefaultPublisherPageTemplatePortraitSummaryV1: IPublisherPageTemplateV1;
|
|
1931
|
+
|
|
1932
|
+
/**
|
|
1933
|
+
* Current version of {@link DefaultPublisherPageTemplatesV1}.
|
|
1934
|
+
*
|
|
1935
|
+
* @alpha
|
|
1936
|
+
*/
|
|
1937
|
+
export declare const DefaultPublisherPageTemplates: readonly IPublisherPageTemplateV1[];
|
|
1938
|
+
|
|
1939
|
+
/**
|
|
1940
|
+
* Current version of {@link DefaultPublisherPageTemplateSectionV1}.
|
|
1941
|
+
*
|
|
1942
|
+
* @alpha
|
|
1943
|
+
*/
|
|
1944
|
+
export declare const DefaultPublisherPageTemplateSection: IPublisherPageTemplateV1;
|
|
1945
|
+
|
|
1946
|
+
/**
|
|
1947
|
+
* Default section divider page.
|
|
1948
|
+
*
|
|
1949
|
+
* @alpha
|
|
1950
|
+
*/
|
|
1951
|
+
export declare const DefaultPublisherPageTemplateSectionV1: IPublisherPageTemplateV1;
|
|
1952
|
+
|
|
1953
|
+
/**
|
|
1954
|
+
* All default page templates served by the SPI. They are read-only: they cannot be
|
|
1955
|
+
* edited or deleted, and they are never persisted on the backend.
|
|
1956
|
+
*
|
|
1957
|
+
* @alpha
|
|
1958
|
+
*/
|
|
1959
|
+
export declare const DefaultPublisherPageTemplatesV1: readonly IPublisherPageTemplateV1[];
|
|
1960
|
+
|
|
1961
|
+
/**
|
|
1962
|
+
* Current version of {@link DefaultPublisherPageTemplateViz6TextLeftV1}.
|
|
1963
|
+
*
|
|
1964
|
+
* @alpha
|
|
1965
|
+
*/
|
|
1966
|
+
export declare const DefaultPublisherPageTemplateViz6TextLeft: IPublisherPageTemplateV1;
|
|
1967
|
+
|
|
1968
|
+
/**
|
|
1969
|
+
* Default content page with six visualizations and a text column on the left.
|
|
1970
|
+
*
|
|
1971
|
+
* @alpha
|
|
1972
|
+
*/
|
|
1973
|
+
export declare const DefaultPublisherPageTemplateViz6TextLeftV1: IPublisherPageTemplateV1;
|
|
1974
|
+
|
|
1975
1975
|
/**
|
|
1976
1976
|
* Current version of {@link DefaultPublisherParagraphTypeV1}.
|
|
1977
1977
|
*
|
|
@@ -3016,6 +3016,24 @@ export declare const getPublisherTextPlaceholders: typeof getPublisherTextPlaceh
|
|
|
3016
3016
|
*/
|
|
3017
3017
|
export declare function getPublisherTextPlaceholdersV1(text: string): string[];
|
|
3018
3018
|
|
|
3019
|
+
/**
|
|
3020
|
+
* Collects the distinct `{variable}` names referenced in the text, in order of first occurrence.
|
|
3021
|
+
*
|
|
3022
|
+
* @alpha
|
|
3023
|
+
*/
|
|
3024
|
+
export declare function getPublisherTextPlaceholdersV2(text: string): string[];
|
|
3025
|
+
|
|
3026
|
+
/**
|
|
3027
|
+
* The path of a theme reference such as `{theme.colors.texts.muted}`, as
|
|
3028
|
+
* `["colors", "texts", "muted"]`; undefined when the value is not one.
|
|
3029
|
+
*
|
|
3030
|
+
* @remarks
|
|
3031
|
+
* A theme reference is always the whole value, never part of a longer string.
|
|
3032
|
+
*
|
|
3033
|
+
* @alpha
|
|
3034
|
+
*/
|
|
3035
|
+
export declare function getPublisherThemeReferencePathV2(value: unknown): string[] | undefined;
|
|
3036
|
+
|
|
3019
3037
|
/**
|
|
3020
3038
|
* Returns count of selected elements
|
|
3021
3039
|
* @alpha
|
|
@@ -8379,6 +8397,10 @@ export declare interface IFeatureFlags {
|
|
|
8379
8397
|
* Enable enhanced insight picker.
|
|
8380
8398
|
*/
|
|
8381
8399
|
enableEnhancedInsightPicker?: boolean;
|
|
8400
|
+
/**
|
|
8401
|
+
* Enable deleting visualizations from the dashboard edit mode visualization list.
|
|
8402
|
+
*/
|
|
8403
|
+
enableDashboardVisualizationDelete?: boolean;
|
|
8382
8404
|
/**
|
|
8383
8405
|
* Enable ai agentic suggestions.
|
|
8384
8406
|
*/
|
|
@@ -12828,7 +12850,7 @@ export declare interface IPublisherDocumentPagesContentV2 extends IPublisherDocu
|
|
|
12828
12850
|
* plus its own identity.
|
|
12829
12851
|
*
|
|
12830
12852
|
* @remarks
|
|
12831
|
-
* Cloning a {@link
|
|
12853
|
+
* Cloning a {@link IPublisherPageTemplateV1} into content assigns the localIdentifier and regenerates
|
|
12832
12854
|
* slot localIdentifiers (with the layout slotIds) so repeated use of one page stays unique.
|
|
12833
12855
|
* Deliberately carries NO reference back to the source page — later page edits never
|
|
12834
12856
|
* affect existing templates or documents.
|
|
@@ -13188,7 +13210,7 @@ export declare interface IPublisherInheritedTextStyleV2 {
|
|
|
13188
13210
|
export declare type IPublisherLayoutNodeBase = IPublisherLayoutNodeBaseV1;
|
|
13189
13211
|
|
|
13190
13212
|
/**
|
|
13191
|
-
* Fields common to all
|
|
13213
|
+
* Fields common to all layout nodes.
|
|
13192
13214
|
*
|
|
13193
13215
|
* @alpha
|
|
13194
13216
|
*/
|
|
@@ -13218,7 +13240,7 @@ export declare interface IPublisherLayoutSectionV1 extends IPublisherLayoutNodeB
|
|
|
13218
13240
|
* "row" lays children out horizontally, "column" vertically.
|
|
13219
13241
|
*/
|
|
13220
13242
|
direction: "row" | "column";
|
|
13221
|
-
children:
|
|
13243
|
+
children: PublisherLayoutNodeV1[];
|
|
13222
13244
|
/**
|
|
13223
13245
|
* Paint of this section's box. Never affects how children are laid out.
|
|
13224
13246
|
*/
|
|
@@ -13271,7 +13293,7 @@ export declare type IPublisherPageBody = IPublisherPageBodyV1;
|
|
|
13271
13293
|
* Body of a document page: geometry (flex split tree) plus the slots it places.
|
|
13272
13294
|
*
|
|
13273
13295
|
* @remarks
|
|
13274
|
-
* This is both the content of the standalone {@link
|
|
13296
|
+
* This is both the content of the standalone {@link IPublisherPageTemplateV1} object and the shape
|
|
13275
13297
|
* embedded in template/document content ({@link IPublisherDocumentPageV1}).
|
|
13276
13298
|
*
|
|
13277
13299
|
* There is no header/footer chrome: page title, description, footer, page numbers and
|
|
@@ -13296,9 +13318,9 @@ export declare interface IPublisherPageBodyV1 {
|
|
|
13296
13318
|
*/
|
|
13297
13319
|
style?: IPublisherBoxStyleV1;
|
|
13298
13320
|
/**
|
|
13299
|
-
* Root of the
|
|
13321
|
+
* Root of the layout tree.
|
|
13300
13322
|
*/
|
|
13301
|
-
layout:
|
|
13323
|
+
layout: PublisherLayoutNodeV1;
|
|
13302
13324
|
/**
|
|
13303
13325
|
* All slots referenced by the layout, flat, keyed by localIdentifier.
|
|
13304
13326
|
*/
|
|
@@ -13345,25 +13367,35 @@ export declare interface IPublisherPageBodyValidationIssueV1 {
|
|
|
13345
13367
|
}
|
|
13346
13368
|
|
|
13347
13369
|
/**
|
|
13348
|
-
*
|
|
13370
|
+
* @alpha
|
|
13371
|
+
*/
|
|
13372
|
+
export declare interface IPublisherPageStyleV2 extends IPublisherBackgroundStyleV2, IPublisherPaddingStyleV2, IPublisherInheritedTextStyleV2 {
|
|
13373
|
+
/**
|
|
13374
|
+
* Default gap of every container on the page.
|
|
13375
|
+
*/
|
|
13376
|
+
gap?: PublisherGapValueV2;
|
|
13377
|
+
}
|
|
13378
|
+
|
|
13379
|
+
/**
|
|
13380
|
+
* Current version of {@link IPublisherPageTemplateV1}.
|
|
13349
13381
|
*
|
|
13350
13382
|
* @alpha
|
|
13351
13383
|
*/
|
|
13352
|
-
export declare type
|
|
13384
|
+
export declare type IPublisherPageTemplate = IPublisherPageTemplateV1;
|
|
13353
13385
|
|
|
13354
13386
|
/**
|
|
13355
|
-
* Current version of {@link
|
|
13387
|
+
* Current version of {@link IPublisherPageTemplateContentV1}.
|
|
13356
13388
|
*
|
|
13357
13389
|
* @alpha
|
|
13358
13390
|
*/
|
|
13359
|
-
export declare type
|
|
13391
|
+
export declare type IPublisherPageTemplateContent = IPublisherPageTemplateContentV1;
|
|
13360
13392
|
|
|
13361
13393
|
/**
|
|
13362
13394
|
* Stored content of the reportPage entity.
|
|
13363
13395
|
*
|
|
13364
13396
|
* @alpha
|
|
13365
13397
|
*/
|
|
13366
|
-
export declare interface
|
|
13398
|
+
export declare interface IPublisherPageTemplateContentV1 extends IPublisherPageBodyV1 {
|
|
13367
13399
|
/**
|
|
13368
13400
|
* Content model version, for stored-content evolution.
|
|
13369
13401
|
*/
|
|
@@ -13371,18 +13403,18 @@ export declare interface IPublisherPageLayoutContentV1 extends IPublisherPageBod
|
|
|
13371
13403
|
}
|
|
13372
13404
|
|
|
13373
13405
|
/**
|
|
13374
|
-
* Current version of {@link
|
|
13406
|
+
* Current version of {@link IPublisherPageTemplateDefinitionV1}.
|
|
13375
13407
|
*
|
|
13376
13408
|
* @alpha
|
|
13377
13409
|
*/
|
|
13378
|
-
export declare type
|
|
13410
|
+
export declare type IPublisherPageTemplateDefinition = IPublisherPageTemplateDefinitionV1;
|
|
13379
13411
|
|
|
13380
13412
|
/**
|
|
13381
|
-
* Payload for creating or updating a page
|
|
13413
|
+
* Payload for creating or updating a page template.
|
|
13382
13414
|
*
|
|
13383
13415
|
* @alpha
|
|
13384
13416
|
*/
|
|
13385
|
-
export declare interface
|
|
13417
|
+
export declare interface IPublisherPageTemplateDefinitionV1 {
|
|
13386
13418
|
type: "reportPageLayout";
|
|
13387
13419
|
/**
|
|
13388
13420
|
* Present when updating an existing page.
|
|
@@ -13391,15 +13423,25 @@ export declare interface IPublisherPageLayoutDefinitionV1 {
|
|
|
13391
13423
|
title: string;
|
|
13392
13424
|
description?: string;
|
|
13393
13425
|
tags?: string[];
|
|
13394
|
-
content:
|
|
13426
|
+
content: IPublisherPageTemplateContentV1;
|
|
13427
|
+
}
|
|
13428
|
+
|
|
13429
|
+
/**
|
|
13430
|
+
* Payload for creating or updating a page template.
|
|
13431
|
+
*
|
|
13432
|
+
* @alpha
|
|
13433
|
+
*/
|
|
13434
|
+
export declare interface IPublisherPageTemplateDefinitionV2 extends IPublisherEntityDefinitionBaseV2 {
|
|
13435
|
+
type: "pageTemplate";
|
|
13436
|
+
content: IPublisherPageBodyV2;
|
|
13395
13437
|
}
|
|
13396
13438
|
|
|
13397
13439
|
/**
|
|
13398
|
-
* Reusable page
|
|
13440
|
+
* Reusable page template metadata object.
|
|
13399
13441
|
*
|
|
13400
13442
|
* @alpha
|
|
13401
13443
|
*/
|
|
13402
|
-
export declare interface
|
|
13444
|
+
export declare interface IPublisherPageTemplateV1 extends IPublisherPageTemplateDefinitionV1, IAuditableDates, IAuditableUsers {
|
|
13403
13445
|
ref: ObjRef;
|
|
13404
13446
|
/**
|
|
13405
13447
|
* When true, the object comes from a parent workspace and is not editable
|
|
@@ -13408,29 +13450,9 @@ export declare interface IPublisherPageLayoutV1 extends IPublisherPageLayoutDefi
|
|
|
13408
13450
|
isLocked?: boolean;
|
|
13409
13451
|
/**
|
|
13410
13452
|
* 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
|
|
13453
|
+
* stored on the backend; UI must disable deletion and editing of default page templates.
|
|
13412
13454
|
*/
|
|
13413
|
-
|
|
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;
|
|
13455
|
+
isDefault?: boolean;
|
|
13434
13456
|
}
|
|
13435
13457
|
|
|
13436
13458
|
/**
|
|
@@ -13579,7 +13601,7 @@ export declare interface IPublisherSlotBaseV1 {
|
|
|
13579
13601
|
export declare type IPublisherSlotPlaceholder = IPublisherSlotPlaceholderV1;
|
|
13580
13602
|
|
|
13581
13603
|
/**
|
|
13582
|
-
* Metadata of a slot that is intentionally left unfilled in a page
|
|
13604
|
+
* Metadata of a slot that is intentionally left unfilled in a page template or document template.
|
|
13583
13605
|
*
|
|
13584
13606
|
* @alpha
|
|
13585
13607
|
*/
|
|
@@ -16495,49 +16517,49 @@ export declare const isPublisherPageFormat: typeof isPublisherPageFormatV1;
|
|
|
16495
16517
|
export declare function isPublisherPageFormatV1(value: unknown): value is PublisherPageFormatV1;
|
|
16496
16518
|
|
|
16497
16519
|
/**
|
|
16498
|
-
* Current version of {@link isPublisherPageLayoutV1}.
|
|
16499
|
-
*
|
|
16500
16520
|
* @alpha
|
|
16501
16521
|
*/
|
|
16502
|
-
export declare
|
|
16522
|
+
export declare function isPublisherPageSizeV2(value: unknown): value is PublisherPageSizeV2;
|
|
16503
16523
|
|
|
16504
16524
|
/**
|
|
16505
|
-
*
|
|
16525
|
+
* Current version of {@link isPublisherPageTemplateV1}.
|
|
16506
16526
|
*
|
|
16507
16527
|
* @alpha
|
|
16508
16528
|
*/
|
|
16509
|
-
export declare
|
|
16529
|
+
export declare const isPublisherPageTemplate: typeof isPublisherPageTemplateV1;
|
|
16510
16530
|
|
|
16511
16531
|
/**
|
|
16512
|
-
*
|
|
16532
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherPageTemplateContentV1}.
|
|
16513
16533
|
*
|
|
16514
16534
|
* @alpha
|
|
16515
16535
|
*/
|
|
16516
|
-
export declare
|
|
16536
|
+
export declare function isPublisherPageTemplateContentV1(obj: unknown): obj is IPublisherPageTemplateContentV1;
|
|
16517
16537
|
|
|
16518
16538
|
/**
|
|
16519
|
-
*
|
|
16539
|
+
* Current version of {@link isPublisherPageTemplateDefinitionV1}.
|
|
16520
16540
|
*
|
|
16521
16541
|
* @alpha
|
|
16522
16542
|
*/
|
|
16523
|
-
export declare
|
|
16543
|
+
export declare const isPublisherPageTemplateDefinition: typeof isPublisherPageTemplateDefinitionV1;
|
|
16524
16544
|
|
|
16525
16545
|
/**
|
|
16526
|
-
* Type-guard testing whether the provided object is an instance of {@link
|
|
16546
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherPageTemplateDefinitionV1}.
|
|
16527
16547
|
*
|
|
16528
16548
|
* @alpha
|
|
16529
16549
|
*/
|
|
16530
|
-
export declare function
|
|
16550
|
+
export declare function isPublisherPageTemplateDefinitionV1(obj: unknown): obj is IPublisherPageTemplateDefinitionV1;
|
|
16531
16551
|
|
|
16532
16552
|
/**
|
|
16533
16553
|
* @alpha
|
|
16534
16554
|
*/
|
|
16535
|
-
export declare function
|
|
16555
|
+
export declare function isPublisherPageTemplateDefinitionV2(obj: unknown): obj is IPublisherPageTemplateDefinitionV2;
|
|
16536
16556
|
|
|
16537
16557
|
/**
|
|
16558
|
+
* Type-guard testing whether the provided object is an instance of {@link IPublisherPageTemplateV1}.
|
|
16559
|
+
*
|
|
16538
16560
|
* @alpha
|
|
16539
16561
|
*/
|
|
16540
|
-
export declare function
|
|
16562
|
+
export declare function isPublisherPageTemplateV1(obj: unknown): obj is IPublisherPageTemplateV1;
|
|
16541
16563
|
|
|
16542
16564
|
/**
|
|
16543
16565
|
* @alpha
|
|
@@ -17317,6 +17339,13 @@ export declare interface ITheme {
|
|
|
17317
17339
|
* @alpha
|
|
17318
17340
|
*/
|
|
17319
17341
|
reports?: IThemePublisher;
|
|
17342
|
+
/**
|
|
17343
|
+
* How documents with content version 2 look. Version 1 documents read `reports` until the
|
|
17344
|
+
* switch to version 2.
|
|
17345
|
+
*
|
|
17346
|
+
* @alpha
|
|
17347
|
+
*/
|
|
17348
|
+
documents?: IThemeDocuments;
|
|
17320
17349
|
/**
|
|
17321
17350
|
* Image assets offered to documents
|
|
17322
17351
|
*
|
|
@@ -17935,6 +17964,239 @@ export declare interface IThemeDefinition extends Partial<IMetadataObject> {
|
|
|
17935
17964
|
readonly theme: ITheme;
|
|
17936
17965
|
}
|
|
17937
17966
|
|
|
17967
|
+
/**
|
|
17968
|
+
* How documents with content version 2 look.
|
|
17969
|
+
*
|
|
17970
|
+
* @remarks
|
|
17971
|
+
* A key left out falls back to the matching platform key, then the complementary palette, then the
|
|
17972
|
+
* built-in default. Only documents follow it; the Publisher UI around them follows the platform theme.
|
|
17973
|
+
*
|
|
17974
|
+
* @alpha
|
|
17975
|
+
*/
|
|
17976
|
+
export declare interface IThemeDocuments {
|
|
17977
|
+
colors?: IThemeDocumentsColors;
|
|
17978
|
+
textStyle?: IThemeDocumentsTextStyle;
|
|
17979
|
+
chart?: IPublisherChartStyleV2;
|
|
17980
|
+
table?: IPublisherTableStyleV2;
|
|
17981
|
+
headline?: IPublisherHeadlineStyleV2;
|
|
17982
|
+
shadows?: Record<string, IThemeDocumentsShadow>;
|
|
17983
|
+
/**
|
|
17984
|
+
* The default look of a takeaway widget.
|
|
17985
|
+
*/
|
|
17986
|
+
takeaway?: IPublisherTextWidgetStyleV2;
|
|
17987
|
+
page?: IThemeDocumentsPage;
|
|
17988
|
+
corners?: IThemeDocumentsCorners;
|
|
17989
|
+
spacing?: IThemeDocumentsSpacing;
|
|
17990
|
+
}
|
|
17991
|
+
|
|
17992
|
+
/**
|
|
17993
|
+
* A color offered to documents. Content stores its id, never its position in the list.
|
|
17994
|
+
*
|
|
17995
|
+
* @alpha
|
|
17996
|
+
*/
|
|
17997
|
+
export declare interface IThemeDocumentsColor {
|
|
17998
|
+
id: string;
|
|
17999
|
+
/**
|
|
18000
|
+
* Absent: the role keeps its inherited value. May reference `{theme.palette.<name>}`.
|
|
18001
|
+
*/
|
|
18002
|
+
color?: PublisherColorValueV2;
|
|
18003
|
+
}
|
|
18004
|
+
|
|
18005
|
+
/**
|
|
18006
|
+
* Colors offered to documents, one list per kind of paint.
|
|
18007
|
+
*
|
|
18008
|
+
* @remarks
|
|
18009
|
+
* The ids `default`, `surface` and `inverse` (backgrounds), `default`, `muted` and `inverse` (texts),
|
|
18010
|
+
* `default` (lines) and `accent` (any list) always resolve, falling back to the platform palette.
|
|
18011
|
+
*
|
|
18012
|
+
* @alpha
|
|
18013
|
+
*/
|
|
18014
|
+
export declare interface IThemeDocumentsColors {
|
|
18015
|
+
backgrounds?: IThemeDocumentsColor[];
|
|
18016
|
+
texts?: IThemeDocumentsColor[];
|
|
18017
|
+
/**
|
|
18018
|
+
* Borders, dividers, accent bars, gridlines and axis lines.
|
|
18019
|
+
*/
|
|
18020
|
+
lines?: IThemeDocumentsColor[];
|
|
18021
|
+
/**
|
|
18022
|
+
* Colors of visualizations: stated inline, or a reference to a color palette object. When
|
|
18023
|
+
* absent, documents use the workspace's active color palette.
|
|
18024
|
+
*/
|
|
18025
|
+
visualizationPalette?: PublisherColorValueV2[] | IThemeColorPaletteRef;
|
|
18026
|
+
}
|
|
18027
|
+
|
|
18028
|
+
/**
|
|
18029
|
+
* Corner radius steps; `full` is built in.
|
|
18030
|
+
*
|
|
18031
|
+
* @alpha
|
|
18032
|
+
*/
|
|
18033
|
+
export declare interface IThemeDocumentsCorners {
|
|
18034
|
+
small?: ThemeDocumentsLength;
|
|
18035
|
+
medium?: ThemeDocumentsLength;
|
|
18036
|
+
large?: ThemeDocumentsLength;
|
|
18037
|
+
}
|
|
18038
|
+
|
|
18039
|
+
/**
|
|
18040
|
+
* One hosted font file registered as a font face for documents.
|
|
18041
|
+
*
|
|
18042
|
+
* @alpha
|
|
18043
|
+
*/
|
|
18044
|
+
export declare interface IThemeDocumentsFontFace {
|
|
18045
|
+
family: string;
|
|
18046
|
+
url: string;
|
|
18047
|
+
/**
|
|
18048
|
+
* `"400 700"` covers a variable font's range with one face.
|
|
18049
|
+
*/
|
|
18050
|
+
weight?: number | string;
|
|
18051
|
+
style?: "normal" | "italic";
|
|
18052
|
+
unicodeRange?: string;
|
|
18053
|
+
}
|
|
18054
|
+
|
|
18055
|
+
/**
|
|
18056
|
+
* Heading text styles.
|
|
18057
|
+
*
|
|
18058
|
+
* @alpha
|
|
18059
|
+
*/
|
|
18060
|
+
export declare interface IThemeDocumentsHeading extends IThemeDocumentsTextGroup {
|
|
18061
|
+
h1?: IThemeDocumentsTextLevel;
|
|
18062
|
+
h2?: IThemeDocumentsTextLevel;
|
|
18063
|
+
h3?: IThemeDocumentsTextLevel;
|
|
18064
|
+
h4?: IThemeDocumentsTextLevel;
|
|
18065
|
+
h5?: IThemeDocumentsTextLevel;
|
|
18066
|
+
h6?: IThemeDocumentsTextLevel;
|
|
18067
|
+
}
|
|
18068
|
+
|
|
18069
|
+
/**
|
|
18070
|
+
* The look of marked text: strong, emphasis, highlight or link.
|
|
18071
|
+
*
|
|
18072
|
+
* @alpha
|
|
18073
|
+
*/
|
|
18074
|
+
export declare interface IThemeDocumentsMarkStyle {
|
|
18075
|
+
color?: PublisherColorValueV2;
|
|
18076
|
+
backgroundColor?: PublisherColorValueV2;
|
|
18077
|
+
fontWeight?: number;
|
|
18078
|
+
fontStyle?: "normal" | "italic";
|
|
18079
|
+
}
|
|
18080
|
+
|
|
18081
|
+
/**
|
|
18082
|
+
* Page defaults of documents.
|
|
18083
|
+
*
|
|
18084
|
+
* @alpha
|
|
18085
|
+
*/
|
|
18086
|
+
export declare interface IThemeDocumentsPage {
|
|
18087
|
+
padding?: PublisherPaddingValueV2;
|
|
18088
|
+
gap?: PublisherGapValueV2;
|
|
18089
|
+
}
|
|
18090
|
+
|
|
18091
|
+
/**
|
|
18092
|
+
* A named shadow, referenced from content as `{theme.shadows.<name>}`.
|
|
18093
|
+
*
|
|
18094
|
+
* @alpha
|
|
18095
|
+
*/
|
|
18096
|
+
export declare interface IThemeDocumentsShadow {
|
|
18097
|
+
x?: number;
|
|
18098
|
+
y?: number;
|
|
18099
|
+
blur?: ThemeDocumentsLength;
|
|
18100
|
+
spread?: number;
|
|
18101
|
+
color?: PublisherColorValueV2;
|
|
18102
|
+
opacity?: number;
|
|
18103
|
+
}
|
|
18104
|
+
|
|
18105
|
+
/**
|
|
18106
|
+
* Spacing scales of documents.
|
|
18107
|
+
*
|
|
18108
|
+
* @alpha
|
|
18109
|
+
*/
|
|
18110
|
+
export declare interface IThemeDocumentsSpacing {
|
|
18111
|
+
gap?: IThemeDocumentsSteps;
|
|
18112
|
+
padding?: IThemeDocumentsSteps;
|
|
18113
|
+
}
|
|
18114
|
+
|
|
18115
|
+
/**
|
|
18116
|
+
* The named steps of a document spacing scale.
|
|
18117
|
+
*
|
|
18118
|
+
* @alpha
|
|
18119
|
+
*/
|
|
18120
|
+
export declare interface IThemeDocumentsSteps {
|
|
18121
|
+
compact?: ThemeDocumentsLength;
|
|
18122
|
+
normal?: ThemeDocumentsLength;
|
|
18123
|
+
spacious?: ThemeDocumentsLength;
|
|
18124
|
+
}
|
|
18125
|
+
|
|
18126
|
+
/**
|
|
18127
|
+
* Body text styles.
|
|
18128
|
+
*
|
|
18129
|
+
* @alpha
|
|
18130
|
+
*/
|
|
18131
|
+
export declare interface IThemeDocumentsText extends IThemeDocumentsTextGroup {
|
|
18132
|
+
largeText?: IThemeDocumentsTextLevel;
|
|
18133
|
+
normalText?: IThemeDocumentsTextLevel;
|
|
18134
|
+
smallText?: IThemeDocumentsTextLevel;
|
|
18135
|
+
}
|
|
18136
|
+
|
|
18137
|
+
/**
|
|
18138
|
+
* Values a group of text styles shares unless a level sets its own.
|
|
18139
|
+
*
|
|
18140
|
+
* @alpha
|
|
18141
|
+
*/
|
|
18142
|
+
export declare interface IThemeDocumentsTextGroup {
|
|
18143
|
+
color?: PublisherColorValueV2;
|
|
18144
|
+
/**
|
|
18145
|
+
* A multiple of the font size.
|
|
18146
|
+
*/
|
|
18147
|
+
lineHeight?: number;
|
|
18148
|
+
}
|
|
18149
|
+
|
|
18150
|
+
/**
|
|
18151
|
+
* One named text style.
|
|
18152
|
+
*
|
|
18153
|
+
* @alpha
|
|
18154
|
+
*/
|
|
18155
|
+
export declare interface IThemeDocumentsTextLevel extends IThemeDocumentsTextGroup {
|
|
18156
|
+
fontSize?: ThemeDocumentsLength;
|
|
18157
|
+
}
|
|
18158
|
+
|
|
18159
|
+
/**
|
|
18160
|
+
* The named text styles of documents.
|
|
18161
|
+
*
|
|
18162
|
+
* @alpha
|
|
18163
|
+
*/
|
|
18164
|
+
export declare interface IThemeDocumentsTextStyle {
|
|
18165
|
+
typography?: IThemeDocumentsTypography;
|
|
18166
|
+
/**
|
|
18167
|
+
* Falls back to `heading.h1`.
|
|
18168
|
+
*/
|
|
18169
|
+
title?: IThemeDocumentsTextLevel;
|
|
18170
|
+
heading?: IThemeDocumentsHeading;
|
|
18171
|
+
text?: IThemeDocumentsText;
|
|
18172
|
+
/**
|
|
18173
|
+
* Default: bold.
|
|
18174
|
+
*/
|
|
18175
|
+
strong?: IThemeDocumentsMarkStyle;
|
|
18176
|
+
/**
|
|
18177
|
+
* Default: italic.
|
|
18178
|
+
*/
|
|
18179
|
+
emphasis?: IThemeDocumentsMarkStyle;
|
|
18180
|
+
highlight?: IThemeDocumentsMarkStyle;
|
|
18181
|
+
/**
|
|
18182
|
+
* Default color: `{theme.palette.primary}`.
|
|
18183
|
+
*/
|
|
18184
|
+
link?: IThemeDocumentsMarkStyle;
|
|
18185
|
+
}
|
|
18186
|
+
|
|
18187
|
+
/**
|
|
18188
|
+
* Fonts of documents.
|
|
18189
|
+
*
|
|
18190
|
+
* @alpha
|
|
18191
|
+
*/
|
|
18192
|
+
export declare interface IThemeDocumentsTypography {
|
|
18193
|
+
/**
|
|
18194
|
+
* A CSS font family list; a name with a digit must be quoted.
|
|
18195
|
+
*/
|
|
18196
|
+
fontFamily?: string;
|
|
18197
|
+
fonts?: IThemeDocumentsFontFace[];
|
|
18198
|
+
}
|
|
18199
|
+
|
|
17938
18200
|
/**
|
|
17939
18201
|
*
|
|
17940
18202
|
* @beta
|
|
@@ -20695,14 +20957,14 @@ export declare function newPublisherDocumentDefinitionFromTemplateV1(template: I
|
|
|
20695
20957
|
export declare function newPublisherDocumentFilterIdV2({ target, usedIds, }: INewPublisherDocumentFilterIdOptionsV2): string;
|
|
20696
20958
|
|
|
20697
20959
|
/**
|
|
20698
|
-
* Current version of {@link
|
|
20960
|
+
* Current version of {@link newPublisherDocumentPageFromTemplateV1}.
|
|
20699
20961
|
*
|
|
20700
20962
|
* @alpha
|
|
20701
20963
|
*/
|
|
20702
|
-
export declare const
|
|
20964
|
+
export declare const newPublisherDocumentPageFromTemplate: typeof newPublisherDocumentPageFromTemplateV1;
|
|
20703
20965
|
|
|
20704
20966
|
/**
|
|
20705
|
-
* Clones a page
|
|
20967
|
+
* Clones a page template into a page instance embeddable in template/document content.
|
|
20706
20968
|
*
|
|
20707
20969
|
* @remarks
|
|
20708
20970
|
* The body is deep-copied and detached from the source page — no reference is kept.
|
|
@@ -20711,7 +20973,7 @@ export declare const newPublisherDocumentPageFromLayout: typeof newPublisherDocu
|
|
|
20711
20973
|
*
|
|
20712
20974
|
* @alpha
|
|
20713
20975
|
*/
|
|
20714
|
-
export declare function
|
|
20976
|
+
export declare function newPublisherDocumentPageFromTemplateV1(page: IPublisherPageTemplateV1 | IPublisherPageTemplateDefinitionV1, localIdentifier?: string): IPublisherDocumentPageV1;
|
|
20715
20977
|
|
|
20716
20978
|
/**
|
|
20717
20979
|
* Copies a page template's content into a new document page.
|
|
@@ -20759,18 +21021,18 @@ export declare function newPublisherIdV2(prefix: string): string;
|
|
|
20759
21021
|
export declare function newPublisherPageIdV2(): string;
|
|
20760
21022
|
|
|
20761
21023
|
/**
|
|
20762
|
-
* Current version of {@link
|
|
21024
|
+
* Current version of {@link newPublisherPageTemplateDefinitionV1}.
|
|
20763
21025
|
*
|
|
20764
21026
|
* @alpha
|
|
20765
21027
|
*/
|
|
20766
|
-
export declare const
|
|
21028
|
+
export declare const newPublisherPageTemplateDefinition: typeof newPublisherPageTemplateDefinitionV1;
|
|
20767
21029
|
|
|
20768
21030
|
/**
|
|
20769
|
-
* Creates a new page
|
|
21031
|
+
* Creates a new page template definition.
|
|
20770
21032
|
*
|
|
20771
21033
|
* @alpha
|
|
20772
21034
|
*/
|
|
20773
|
-
export declare function
|
|
21035
|
+
export declare function newPublisherPageTemplateDefinitionV1(title: string, body: IPublisherPageBodyV1, modifications?: Partial<Omit<IPublisherPageTemplateDefinitionV1, "type" | "title" | "content">>): IPublisherPageTemplateDefinitionV1;
|
|
20774
21036
|
|
|
20775
21037
|
/**
|
|
20776
21038
|
* Generates a section id such as `section_7f3a91c4`.
|
|
@@ -21464,6 +21726,22 @@ export declare type PublisherImageSourceV1 = {
|
|
|
21464
21726
|
*/
|
|
21465
21727
|
export declare type PublisherImageSourceV2 = string;
|
|
21466
21728
|
|
|
21729
|
+
/**
|
|
21730
|
+
* Current version of {@link PublisherLayoutNodeV1}.
|
|
21731
|
+
*
|
|
21732
|
+
* @alpha
|
|
21733
|
+
*/
|
|
21734
|
+
export declare type PublisherLayoutNode = PublisherLayoutNodeV1;
|
|
21735
|
+
|
|
21736
|
+
/**
|
|
21737
|
+
* Node of a page's layout tree: a recursive row/column split tree (flexbox semantics)
|
|
21738
|
+
* over a fixed page. Leaves assign their area to slots; the tree carries geometry and
|
|
21739
|
+
* box paint, slot content lives in {@link IPublisherPageBodyV1.slots}.
|
|
21740
|
+
*
|
|
21741
|
+
* @alpha
|
|
21742
|
+
*/
|
|
21743
|
+
export declare type PublisherLayoutNodeV1 = IPublisherLayoutSectionV1 | IPublisherLayoutSlotRefV1;
|
|
21744
|
+
|
|
21467
21745
|
/**
|
|
21468
21746
|
* @alpha
|
|
21469
21747
|
*/
|
|
@@ -21518,7 +21796,7 @@ export declare const PublisherPageFormats: PublisherPageFormatV1[];
|
|
|
21518
21796
|
export declare const PublisherPageFormatsV1: PublisherPageFormatV1[];
|
|
21519
21797
|
|
|
21520
21798
|
/**
|
|
21521
|
-
* Page shape a page
|
|
21799
|
+
* Page shape a page template is designed for.
|
|
21522
21800
|
*
|
|
21523
21801
|
* @remarks
|
|
21524
21802
|
* A layout's geometry only reads correctly at the proportions it was authored for: a row of three
|
|
@@ -21536,22 +21814,6 @@ export declare type PublisherPageFormatV1 = "widescreen" | "a4Portrait" | "lette
|
|
|
21536
21814
|
*/
|
|
21537
21815
|
export declare type PublisherPageKindV2 = "cover" | "section" | "content";
|
|
21538
21816
|
|
|
21539
|
-
/**
|
|
21540
|
-
* Current version of {@link PublisherPageLayoutNodeV1}.
|
|
21541
|
-
*
|
|
21542
|
-
* @alpha
|
|
21543
|
-
*/
|
|
21544
|
-
export declare type PublisherPageLayoutNode = PublisherPageLayoutNodeV1;
|
|
21545
|
-
|
|
21546
|
-
/**
|
|
21547
|
-
* Node of a page layout: a recursive row/column split tree (flexbox semantics)
|
|
21548
|
-
* over a fixed page. Leaves assign their area to slots; the tree carries geometry and
|
|
21549
|
-
* box paint, slot content lives in {@link IPublisherPageBodyV1.slots}.
|
|
21550
|
-
*
|
|
21551
|
-
* @alpha
|
|
21552
|
-
*/
|
|
21553
|
-
export declare type PublisherPageLayoutNodeV1 = IPublisherLayoutSectionV1 | IPublisherLayoutSlotRefV1;
|
|
21554
|
-
|
|
21555
21817
|
/**
|
|
21556
21818
|
* @alpha
|
|
21557
21819
|
*/
|
|
@@ -21647,6 +21909,13 @@ export declare const publisherTextPlaceholder: typeof publisherTextPlaceholderV1
|
|
|
21647
21909
|
*/
|
|
21648
21910
|
export declare function publisherTextPlaceholderV1(name: string): string;
|
|
21649
21911
|
|
|
21912
|
+
/**
|
|
21913
|
+
* The marker referencing the variable from document text.
|
|
21914
|
+
*
|
|
21915
|
+
* @alpha
|
|
21916
|
+
*/
|
|
21917
|
+
export declare function publisherTextPlaceholderV2(name: PublisherTextVariableV2): string;
|
|
21918
|
+
|
|
21650
21919
|
/**
|
|
21651
21920
|
* Current version of {@link publisherTextSlotTypeV1}.
|
|
21652
21921
|
*
|
|
@@ -21733,6 +22002,27 @@ export declare const PublisherTextTypesV1: PublisherTextTypeV1[];
|
|
|
21733
22002
|
*/
|
|
21734
22003
|
export declare type PublisherTextTypeV1 = PublisherHeadingTypeV1 | PublisherParagraphTypeV1;
|
|
21735
22004
|
|
|
22005
|
+
/**
|
|
22006
|
+
* All document text variable names.
|
|
22007
|
+
*
|
|
22008
|
+
* @alpha
|
|
22009
|
+
*/
|
|
22010
|
+
export declare const PublisherTextVariablesV2: readonly PublisherTextVariableV2[];
|
|
22011
|
+
|
|
22012
|
+
/**
|
|
22013
|
+
* A variable every document resolves, referenced from text as `{name}`.
|
|
22014
|
+
*
|
|
22015
|
+
* @alpha
|
|
22016
|
+
*/
|
|
22017
|
+
export declare type PublisherTextVariableV2 = "documentName" | "documentDescription" | "documentDateRange" | "documentAttributeFilters" | "periodStart" | "periodEnd" | "lastModifiedAt" | "lastModifiedBy" | "exportedAt" | "exportedBy" | "workspaceName" | "workspaceId" | "currentPageNumber" | "totalPages";
|
|
22018
|
+
|
|
22019
|
+
/**
|
|
22020
|
+
* The theme reference to the path, such as `{theme.assets.images.cover}`.
|
|
22021
|
+
*
|
|
22022
|
+
* @alpha
|
|
22023
|
+
*/
|
|
22024
|
+
export declare function publisherThemeReferenceV2(path: readonly string[]): string;
|
|
22025
|
+
|
|
21736
22026
|
/**
|
|
21737
22027
|
* @alpha
|
|
21738
22028
|
*/
|
|
@@ -21848,6 +22138,13 @@ export declare const resolvePublisherTextPlaceholders: typeof resolvePublisherTe
|
|
|
21848
22138
|
*/
|
|
21849
22139
|
export declare function resolvePublisherTextPlaceholdersV1(text: string, values: Record<string, string>): string;
|
|
21850
22140
|
|
|
22141
|
+
/**
|
|
22142
|
+
* Replaces `{variable}` markers with values. A marker with no value stays as typed.
|
|
22143
|
+
*
|
|
22144
|
+
* @alpha
|
|
22145
|
+
*/
|
|
22146
|
+
export declare function resolvePublisherTextPlaceholdersV2(text: string, values: Partial<Record<PublisherTextVariableV2, string>>): string;
|
|
22147
|
+
|
|
21851
22148
|
/**
|
|
21852
22149
|
* Resolves a dashboard timezone value to a concrete IANA timezone ID: the {@link BROWSER_DETECTED}
|
|
21853
22150
|
* sentinel resolves to the browser/runtime timezone, any other value is returned as-is.
|
|
@@ -22094,6 +22391,13 @@ export declare type ThemeColor = string;
|
|
|
22094
22391
|
*/
|
|
22095
22392
|
export declare type ThemeDashboardDensity = "comfortable" | "compact";
|
|
22096
22393
|
|
|
22394
|
+
/**
|
|
22395
|
+
* A length on the document page canvas, in px. Units are not accepted.
|
|
22396
|
+
*
|
|
22397
|
+
* @alpha
|
|
22398
|
+
*/
|
|
22399
|
+
export declare type ThemeDocumentsLength = number;
|
|
22400
|
+
|
|
22097
22401
|
/**
|
|
22098
22402
|
* Custom font URI which is used to override the default font
|
|
22099
22403
|
*
|