@gooddata/sdk-model 11.57.0-alpha.5 → 11.57.0-alpha.7
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/conditionalFormatting/index.d.ts +4 -4
- package/esm/conditionalFormatting/index.d.ts.map +1 -1
- package/esm/index.d.ts +3 -4
- package/esm/index.d.ts.map +1 -1
- package/esm/index.js +3 -3
- package/esm/ldm/metadata/attribute/index.d.ts +7 -0
- package/esm/ldm/metadata/attribute/index.d.ts.map +1 -1
- package/esm/ldm/metadata/attributeDisplayForm/index.d.ts +8 -0
- package/esm/ldm/metadata/attributeDisplayForm/index.d.ts.map +1 -1
- package/esm/reports/builtinPageLayouts.d.ts.map +1 -1
- package/esm/reports/builtinPageLayouts.js +48 -34
- package/esm/reports/slot.d.ts +56 -16
- package/esm/reports/slot.d.ts.map +1 -1
- package/esm/reports/slot.js +45 -12
- package/esm/reports/styling.d.ts +79 -4
- package/esm/reports/styling.d.ts.map +1 -1
- package/esm/reports/styling.js +40 -0
- package/esm/reports/variables.d.ts +1 -1
- package/esm/reports/variables.d.ts.map +1 -1
- package/esm/reports/variables.js +0 -1
- package/esm/sdk-model.d.ts +406 -206
- package/esm/settings/settings.d.ts +12 -6
- package/esm/settings/settings.d.ts.map +1 -1
- package/esm/theme/index.d.ts +230 -0
- package/esm/theme/index.d.ts.map +1 -1
- package/esm/theme/index.js +12 -1
- package/package.json +5 -5
- package/esm/reports/brandKit.d.ts +0 -187
- package/esm/reports/brandKit.d.ts.map +0 -1
- package/esm/reports/brandKit.js +0 -208
package/esm/sdk-model.d.ts
CHANGED
|
@@ -1025,13 +1025,6 @@ export declare const BuiltInReportPageLayoutViz6TextLeft: IReportPageLayout;
|
|
|
1025
1025
|
*/
|
|
1026
1026
|
export declare const BuiltInReportSlotTypes: string[];
|
|
1027
1027
|
|
|
1028
|
-
/**
|
|
1029
|
-
* All semantic kinds a text slot can carry.
|
|
1030
|
-
*
|
|
1031
|
-
* @alpha
|
|
1032
|
-
*/
|
|
1033
|
-
export declare const BuiltInReportTextSlotKinds: ReportTextSlotKind[];
|
|
1034
|
-
|
|
1035
1028
|
/**
|
|
1036
1029
|
* List of built-in widget types. These type names are reserved and must not be used by custom widgets.
|
|
1037
1030
|
*
|
|
@@ -1887,6 +1880,13 @@ export declare function defaultDimensionsGenerator(definition: IExecutionDefinit
|
|
|
1887
1880
|
*/
|
|
1888
1881
|
export declare const DefaultLocale: ILocale;
|
|
1889
1882
|
|
|
1883
|
+
/**
|
|
1884
|
+
* Size a heading slot that states none is rendered at.
|
|
1885
|
+
*
|
|
1886
|
+
* @alpha
|
|
1887
|
+
*/
|
|
1888
|
+
export declare const DefaultReportHeadingType: ReportHeadingType;
|
|
1889
|
+
|
|
1890
1890
|
/**
|
|
1891
1891
|
* Format assumed by a page that declares none, which keeps pages authored before formats existed
|
|
1892
1892
|
* on the shape they were designed for.
|
|
@@ -1895,6 +1895,13 @@ export declare const DefaultLocale: ILocale;
|
|
|
1895
1895
|
*/
|
|
1896
1896
|
export declare const DefaultReportPageFormat: ReportPageFormat;
|
|
1897
1897
|
|
|
1898
|
+
/**
|
|
1899
|
+
* Size a paragraph slot that states none is rendered at.
|
|
1900
|
+
*
|
|
1901
|
+
* @alpha
|
|
1902
|
+
*/
|
|
1903
|
+
export declare const DefaultReportParagraphType: ReportParagraphType;
|
|
1904
|
+
|
|
1898
1905
|
/**
|
|
1899
1906
|
* Calculates fingerprint for the execution definition.
|
|
1900
1907
|
*
|
|
@@ -3729,6 +3736,13 @@ export declare interface IAttributeDisplayFormMetadataObject extends IMetadataOb
|
|
|
3729
3736
|
* @alpha
|
|
3730
3737
|
*/
|
|
3731
3738
|
geoAreaConfig?: IAttributeDisplayFormGeoAreaConfig;
|
|
3739
|
+
/**
|
|
3740
|
+
* Semantic-layer conditional formatting authored on this label; takes precedence over the owning
|
|
3741
|
+
* attribute's (backend-defined).
|
|
3742
|
+
*
|
|
3743
|
+
* @alpha
|
|
3744
|
+
*/
|
|
3745
|
+
conditionalFormatting?: ISemanticConditionalFormatting;
|
|
3732
3746
|
}
|
|
3733
3747
|
|
|
3734
3748
|
/**
|
|
@@ -3949,6 +3963,12 @@ export declare interface IAttributeMetadataObject extends IMetadataObject {
|
|
|
3949
3963
|
* Source column name in the underlying data source table.
|
|
3950
3964
|
*/
|
|
3951
3965
|
sourceColumn?: string;
|
|
3966
|
+
/**
|
|
3967
|
+
* Semantic-layer conditional formatting authored on this attribute.
|
|
3968
|
+
*
|
|
3969
|
+
* @alpha
|
|
3970
|
+
*/
|
|
3971
|
+
conditionalFormatting?: ISemanticConditionalFormatting;
|
|
3952
3972
|
}
|
|
3953
3973
|
|
|
3954
3974
|
/**
|
|
@@ -5026,7 +5046,7 @@ export declare interface IConditionalFormatting {
|
|
|
5026
5046
|
*/
|
|
5027
5047
|
version?: string;
|
|
5028
5048
|
enabled: boolean;
|
|
5029
|
-
rules:
|
|
5049
|
+
rules: IConditionalFormattingRule[];
|
|
5030
5050
|
/**
|
|
5031
5051
|
* Targets whose formatting is explicitly suppressed — turned off rather than inherited from any
|
|
5032
5052
|
* semantic-layer conditional formatting carried on the execution result (see
|
|
@@ -5034,7 +5054,7 @@ export declare interface IConditionalFormatting {
|
|
|
5034
5054
|
* semantic layer has rules for it. A target not listed here (or when this is absent) is
|
|
5035
5055
|
* Inherited: semantic rules apply as-is.
|
|
5036
5056
|
*/
|
|
5037
|
-
suppressedTargets?:
|
|
5057
|
+
suppressedTargets?: ConditionalFormattingTarget[];
|
|
5038
5058
|
}
|
|
5039
5059
|
|
|
5040
5060
|
/**
|
|
@@ -5078,7 +5098,7 @@ export declare interface IConditionalFormattingFormat {
|
|
|
5078
5098
|
export declare interface IConditionalFormattingRule {
|
|
5079
5099
|
id: string;
|
|
5080
5100
|
target: ConditionalFormattingTarget;
|
|
5081
|
-
conditions:
|
|
5101
|
+
conditions: IConditionalFormattingCondition[];
|
|
5082
5102
|
}
|
|
5083
5103
|
|
|
5084
5104
|
/**
|
|
@@ -8225,6 +8245,18 @@ export declare interface IFeatureFlags {
|
|
|
8225
8245
|
* Enable the Business Briefing reports application.
|
|
8226
8246
|
*/
|
|
8227
8247
|
enableBusinessBriefingReportsApp?: boolean;
|
|
8248
|
+
/**
|
|
8249
|
+
* Enable the write and export postMessage commands for embedded dashboards and Analytical Designer.
|
|
8250
|
+
*
|
|
8251
|
+
* @remarks
|
|
8252
|
+
* Covers saveDashboard, saveAsDashboard, exportToPdf and openDeleteDashboardDialog in embedded
|
|
8253
|
+
* dashboards, and saveInsight, saveAsInsight and exportInsight in embedded Analytical Designer.
|
|
8254
|
+
* These commands are accepted from any parent origin, so the embedding organization must restrict
|
|
8255
|
+
* who may frame the application through the CSP frame-ancestors directive before this is enabled.
|
|
8256
|
+
*
|
|
8257
|
+
* Disabled by default.
|
|
8258
|
+
*/
|
|
8259
|
+
enableEmbeddingWriteCommands?: boolean;
|
|
8228
8260
|
}
|
|
8229
8261
|
|
|
8230
8262
|
/**
|
|
@@ -11658,11 +11690,6 @@ export declare interface IPermanentSettings {
|
|
|
11658
11690
|
* @beta
|
|
11659
11691
|
*/
|
|
11660
11692
|
defaultExportTemplate?: IDefaultExportTemplate;
|
|
11661
|
-
/**
|
|
11662
|
-
* Brand kit offered to report authors: brand colors, typography and shared assets.
|
|
11663
|
-
* @alpha
|
|
11664
|
-
*/
|
|
11665
|
-
reportsBrandKit?: IReportsBrandKit;
|
|
11666
11693
|
/**
|
|
11667
11694
|
* Indicates current platform edition.
|
|
11668
11695
|
*/
|
|
@@ -12487,6 +12514,37 @@ export declare interface IReportDefinition extends IReportBase {
|
|
|
12487
12514
|
ref?: ObjRef;
|
|
12488
12515
|
}
|
|
12489
12516
|
|
|
12517
|
+
/**
|
|
12518
|
+
* Slot rendering a heading.
|
|
12519
|
+
*
|
|
12520
|
+
* @remarks
|
|
12521
|
+
* A heading is a line of display text, so it carries no markup of its own: what is typed in it is
|
|
12522
|
+
* what it renders.
|
|
12523
|
+
*
|
|
12524
|
+
* @alpha
|
|
12525
|
+
*/
|
|
12526
|
+
export declare interface IReportHeadingSlot extends IReportSlotBase {
|
|
12527
|
+
type: "heading";
|
|
12528
|
+
style?: IReportHeadingStyle;
|
|
12529
|
+
/**
|
|
12530
|
+
* Undefined = declared-but-empty slot.
|
|
12531
|
+
*/
|
|
12532
|
+
source?: ReportTextSource;
|
|
12533
|
+
}
|
|
12534
|
+
|
|
12535
|
+
/**
|
|
12536
|
+
* Styling of a heading slot.
|
|
12537
|
+
*
|
|
12538
|
+
* @alpha
|
|
12539
|
+
*/
|
|
12540
|
+
export declare interface IReportHeadingStyle extends IReportTextStyle {
|
|
12541
|
+
/**
|
|
12542
|
+
* Defaults to {@link DefaultReportHeadingType}. The size owns the semantic typography that goes
|
|
12543
|
+
* with it; the rest of the style overrides ink and placement on top of it.
|
|
12544
|
+
*/
|
|
12545
|
+
type?: ReportHeadingType;
|
|
12546
|
+
}
|
|
12547
|
+
|
|
12490
12548
|
/**
|
|
12491
12549
|
* Image painted behind a section's or page's content.
|
|
12492
12550
|
*
|
|
@@ -12682,155 +12740,29 @@ export declare interface IReportPageLayoutDefinition {
|
|
|
12682
12740
|
}
|
|
12683
12741
|
|
|
12684
12742
|
/**
|
|
12685
|
-
*
|
|
12686
|
-
*
|
|
12687
|
-
* @remarks
|
|
12688
|
-
* Stored as the free-form content of the `reportsBrandKit` workspace setting. Everything is
|
|
12689
|
-
* optional; each part degrades independently to the product defaults. Assets resolve report
|
|
12690
|
-
* variables, chart colors derive the visualization palette, typography applies to rendered
|
|
12691
|
-
* reports.
|
|
12692
|
-
*
|
|
12693
|
-
* @alpha
|
|
12694
|
-
*/
|
|
12695
|
-
export declare interface IReportsBrandKit {
|
|
12696
|
-
/**
|
|
12697
|
-
* Content model version, for stored-content evolution.
|
|
12698
|
-
*/
|
|
12699
|
-
version: "1";
|
|
12700
|
-
colors?: IReportsBrandKitColors;
|
|
12701
|
-
typography?: IReportsBrandKitTypography;
|
|
12702
|
-
assets?: IReportsBrandKitAssets;
|
|
12703
|
-
}
|
|
12704
|
-
|
|
12705
|
-
/**
|
|
12706
|
-
* Brand assets, all hosted outside the platform.
|
|
12707
|
-
*
|
|
12708
|
-
* @alpha
|
|
12709
|
-
*/
|
|
12710
|
-
export declare interface IReportsBrandKitAssets {
|
|
12711
|
-
/**
|
|
12712
|
-
* Primary logo URL; resolves the `{logo}` report variable, taking precedence over
|
|
12713
|
-
* the workspace white-labeling logo.
|
|
12714
|
-
*/
|
|
12715
|
-
logo?: string;
|
|
12716
|
-
/**
|
|
12717
|
-
* Logo variant for dark backgrounds; resolves the `{logoInverse}` report variable.
|
|
12718
|
-
*/
|
|
12719
|
-
logoInverse?: string;
|
|
12720
|
-
/**
|
|
12721
|
-
* Additional brand images, each resolving its `{image_<id>}` report variable.
|
|
12722
|
-
*/
|
|
12723
|
-
images?: IReportsBrandKitImage[];
|
|
12724
|
-
}
|
|
12725
|
-
|
|
12726
|
-
/**
|
|
12727
|
-
* Brand colors.
|
|
12728
|
-
*
|
|
12729
|
-
* @remarks
|
|
12730
|
-
* Every color but {@link IReportsBrandKitColors.chart} is written into CSS, so it may be stated in
|
|
12731
|
-
* any notation CSS reads. Chart colors become palette entries instead of declarations, so they are
|
|
12732
|
-
* held to {@link parseReportsBrandChartColor} and a value it cannot read is dropped.
|
|
12743
|
+
* Slot rendering prose, written as markdown.
|
|
12733
12744
|
*
|
|
12734
12745
|
* @alpha
|
|
12735
12746
|
*/
|
|
12736
|
-
export declare interface
|
|
12737
|
-
|
|
12738
|
-
|
|
12739
|
-
*
|
|
12740
|
-
* @remarks
|
|
12741
|
-
* Also seeds the derived chart palette when {@link IReportsBrandKitColors.chart} is not
|
|
12742
|
-
* provided — but only when stated in a notation {@link parseReportsBrandChartColor} reads,
|
|
12743
|
-
* since seeding means computing tints of it rather than declaring it. Stated in any other
|
|
12744
|
-
* notation it remains a swatch, and charts keep the workspace palette.
|
|
12745
|
-
*/
|
|
12746
|
-
brand?: string;
|
|
12747
|
+
export declare interface IReportParagraphSlot extends IReportSlotBase {
|
|
12748
|
+
type: "paragraph";
|
|
12749
|
+
style?: IReportParagraphStyle;
|
|
12747
12750
|
/**
|
|
12748
|
-
*
|
|
12749
|
-
* {@link parseReportsBrandChartColor} reads; the sanitizer drops the rest.
|
|
12750
|
-
*/
|
|
12751
|
-
chart?: string[];
|
|
12752
|
-
/**
|
|
12753
|
-
* Ink of headings and titles.
|
|
12754
|
-
*/
|
|
12755
|
-
ink?: string;
|
|
12756
|
-
/**
|
|
12757
|
-
* Ink of body and secondary text.
|
|
12758
|
-
*/
|
|
12759
|
-
inkMuted?: string;
|
|
12760
|
-
/**
|
|
12761
|
-
* Default page background.
|
|
12762
|
-
*/
|
|
12763
|
-
paper?: string;
|
|
12764
|
-
/**
|
|
12765
|
-
* Alternate background for covers and highlighted sections.
|
|
12766
|
-
*/
|
|
12767
|
-
paperAlt?: string;
|
|
12768
|
-
}
|
|
12769
|
-
|
|
12770
|
-
/**
|
|
12771
|
-
* One hosted font file, loaded as a font face for rendered reports.
|
|
12772
|
-
*
|
|
12773
|
-
* @alpha
|
|
12774
|
-
*/
|
|
12775
|
-
export declare interface IReportsBrandKitFontFace {
|
|
12776
|
-
/**
|
|
12777
|
-
* Font family name the face registers; reference it from
|
|
12778
|
-
* {@link IReportsBrandKitTypography.fontFamily}.
|
|
12779
|
-
*/
|
|
12780
|
-
family: string;
|
|
12781
|
-
/**
|
|
12782
|
-
* Absolute URL of the externally hosted font file (TTF/OTF/WOFF/WOFF2). The organization
|
|
12783
|
-
* CSP must allow the host as a font source, and for exports the host must also serve
|
|
12784
|
-
* CORS headers.
|
|
12785
|
-
*/
|
|
12786
|
-
url: string;
|
|
12787
|
-
/**
|
|
12788
|
-
* CSS font-weight the face carries (1-1000). Defaults to 400.
|
|
12789
|
-
*/
|
|
12790
|
-
weight?: number;
|
|
12791
|
-
/**
|
|
12792
|
-
* Defaults to "normal".
|
|
12793
|
-
*/
|
|
12794
|
-
style?: "normal" | "italic";
|
|
12795
|
-
}
|
|
12796
|
-
|
|
12797
|
-
/**
|
|
12798
|
-
* Named brand image offered to report authors.
|
|
12799
|
-
*
|
|
12800
|
-
* @alpha
|
|
12801
|
-
*/
|
|
12802
|
-
export declare interface IReportsBrandKitImage {
|
|
12803
|
-
/**
|
|
12804
|
-
* Identifier the image is referenced by from report content, as the
|
|
12805
|
-
* `{image_<id>}` variable. Must match /^[a-zA-Z0-9_]+$/.
|
|
12806
|
-
*/
|
|
12807
|
-
id: string;
|
|
12808
|
-
/**
|
|
12809
|
-
* Absolute URL of the externally hosted image. The organization CSP must allow the
|
|
12810
|
-
* host, and for exports the host must also serve CORS headers.
|
|
12811
|
-
*/
|
|
12812
|
-
url: string;
|
|
12813
|
-
/**
|
|
12814
|
-
* Human readable description shown when the image is offered in the editor.
|
|
12751
|
+
* Undefined = declared-but-empty slot.
|
|
12815
12752
|
*/
|
|
12816
|
-
|
|
12753
|
+
source?: ReportTextSource;
|
|
12817
12754
|
}
|
|
12818
12755
|
|
|
12819
12756
|
/**
|
|
12820
|
-
*
|
|
12757
|
+
* Styling of a paragraph slot.
|
|
12821
12758
|
*
|
|
12822
12759
|
* @alpha
|
|
12823
12760
|
*/
|
|
12824
|
-
export declare interface
|
|
12761
|
+
export declare interface IReportParagraphStyle extends IReportTextStyle {
|
|
12825
12762
|
/**
|
|
12826
|
-
*
|
|
12763
|
+
* Defaults to {@link DefaultReportParagraphType}.
|
|
12827
12764
|
*/
|
|
12828
|
-
|
|
12829
|
-
/**
|
|
12830
|
-
* Hosted font files backing the families named in
|
|
12831
|
-
* {@link IReportsBrandKitTypography.fontFamily}.
|
|
12832
|
-
*/
|
|
12833
|
-
fonts?: IReportsBrandKitFontFace[];
|
|
12765
|
+
type?: ReportParagraphType;
|
|
12834
12766
|
}
|
|
12835
12767
|
|
|
12836
12768
|
/**
|
|
@@ -12918,30 +12850,15 @@ export declare interface IReportTemplateDefinition {
|
|
|
12918
12850
|
}
|
|
12919
12851
|
|
|
12920
12852
|
/**
|
|
12921
|
-
* Slot rendering text.
|
|
12853
|
+
* Slot rendering text of either kind.
|
|
12922
12854
|
*
|
|
12923
12855
|
* @alpha
|
|
12924
12856
|
*/
|
|
12925
|
-
export declare
|
|
12926
|
-
type: "text";
|
|
12927
|
-
kind: ReportTextSlotKind;
|
|
12928
|
-
/**
|
|
12929
|
-
* Ink and placement overrides on top of the kind's defaults.
|
|
12930
|
-
*/
|
|
12931
|
-
style?: IReportTextStyle;
|
|
12932
|
-
/**
|
|
12933
|
-
* Undefined = declared-but-empty slot.
|
|
12934
|
-
*/
|
|
12935
|
-
source?: ReportTextSource;
|
|
12936
|
-
}
|
|
12857
|
+
export declare type IReportTextSlot = IReportHeadingSlot | IReportParagraphSlot;
|
|
12937
12858
|
|
|
12938
12859
|
/**
|
|
12939
12860
|
* Styling of a text slot: the paint of its box, plus the ink and placement of the text it owns.
|
|
12940
12861
|
*
|
|
12941
|
-
* @remarks
|
|
12942
|
-
* Overrides the ink and placement of the slot's {@link ReportTextSlotKind} defaults; the kind
|
|
12943
|
-
* keeps owning semantic typography (size and weight).
|
|
12944
|
-
*
|
|
12945
12862
|
* @alpha
|
|
12946
12863
|
*/
|
|
12947
12864
|
export declare interface IReportTextStyle extends IReportBoxStyle {
|
|
@@ -14076,7 +13993,7 @@ export declare interface ISemanticConditionalFormatting {
|
|
|
14076
13993
|
* Model version of the persisted shape. Absent is treated as `"1"`.
|
|
14077
13994
|
*/
|
|
14078
13995
|
version?: string;
|
|
14079
|
-
conditions:
|
|
13996
|
+
conditions: IConditionalFormattingCondition[];
|
|
14080
13997
|
/**
|
|
14081
13998
|
* Whether the rules are applied when rendering. Absent is treated as `true` — this lets the
|
|
14082
13999
|
* object be turned off without deleting the authored conditions, distinct from having no rules
|
|
@@ -15122,6 +15039,20 @@ export declare function isReportContentV1(obj: unknown): obj is IReportContent;
|
|
|
15122
15039
|
*/
|
|
15123
15040
|
export declare function isReportDefinition(obj: unknown): obj is IReportDefinition;
|
|
15124
15041
|
|
|
15042
|
+
/**
|
|
15043
|
+
* Type-guard testing whether the provided object is an instance of {@link IReportHeadingSlot}.
|
|
15044
|
+
*
|
|
15045
|
+
* @alpha
|
|
15046
|
+
*/
|
|
15047
|
+
export declare function isReportHeadingSlot(obj: unknown): obj is IReportHeadingSlot;
|
|
15048
|
+
|
|
15049
|
+
/**
|
|
15050
|
+
* Type-guard testing whether the value is a {@link ReportHeadingType}.
|
|
15051
|
+
*
|
|
15052
|
+
* @alpha
|
|
15053
|
+
*/
|
|
15054
|
+
export declare function isReportHeadingType(value: unknown): value is ReportHeadingType;
|
|
15055
|
+
|
|
15125
15056
|
/**
|
|
15126
15057
|
* Type-guard testing whether the provided object is an instance of {@link IReportImageBackground}.
|
|
15127
15058
|
*
|
|
@@ -15178,6 +15109,20 @@ export declare function isReportPageLayoutContentV1(obj: unknown): obj is IRepor
|
|
|
15178
15109
|
*/
|
|
15179
15110
|
export declare function isReportPageLayoutDefinition(obj: unknown): obj is IReportPageLayoutDefinition;
|
|
15180
15111
|
|
|
15112
|
+
/**
|
|
15113
|
+
* Type-guard testing whether the provided object is an instance of {@link IReportParagraphSlot}.
|
|
15114
|
+
*
|
|
15115
|
+
* @alpha
|
|
15116
|
+
*/
|
|
15117
|
+
export declare function isReportParagraphSlot(obj: unknown): obj is IReportParagraphSlot;
|
|
15118
|
+
|
|
15119
|
+
/**
|
|
15120
|
+
* Type-guard testing whether the value is a {@link ReportParagraphType}.
|
|
15121
|
+
*
|
|
15122
|
+
* @alpha
|
|
15123
|
+
*/
|
|
15124
|
+
export declare function isReportParagraphType(value: unknown): value is ReportParagraphType;
|
|
15125
|
+
|
|
15181
15126
|
/**
|
|
15182
15127
|
* Type-guard testing whether the provided object is an instance of {@link ReportSlot}.
|
|
15183
15128
|
*
|
|
@@ -15341,6 +15286,13 @@ export declare function isTestNotification(notification: unknown): notification
|
|
|
15341
15286
|
*/
|
|
15342
15287
|
export declare function isTextAttributeFilter(obj: unknown): obj is TextAttributeFilter;
|
|
15343
15288
|
|
|
15289
|
+
/**
|
|
15290
|
+
* Type-guard testing whether the value is a {@link IThemeColorPaletteRef}.
|
|
15291
|
+
*
|
|
15292
|
+
* @alpha
|
|
15293
|
+
*/
|
|
15294
|
+
export declare function isThemeColorPaletteRef(value: unknown): value is IThemeColorPaletteRef;
|
|
15295
|
+
|
|
15344
15296
|
/** @alpha */
|
|
15345
15297
|
export declare const isTimeGranularity: (g: string | undefined) => boolean;
|
|
15346
15298
|
|
|
@@ -15675,6 +15627,13 @@ export declare interface ITestNotificationDetails {
|
|
|
15675
15627
|
* @beta
|
|
15676
15628
|
*/
|
|
15677
15629
|
export declare interface ITheme {
|
|
15630
|
+
/**
|
|
15631
|
+
* Shape version of the theme content. Absent means version 1: a theme created before the
|
|
15632
|
+
* `reports` and `assets` sections existed.
|
|
15633
|
+
*
|
|
15634
|
+
* @beta
|
|
15635
|
+
*/
|
|
15636
|
+
version?: "2";
|
|
15678
15637
|
/**
|
|
15679
15638
|
* Images
|
|
15680
15639
|
*
|
|
@@ -15739,6 +15698,18 @@ export declare interface ITheme {
|
|
|
15739
15698
|
* @alpha
|
|
15740
15699
|
*/
|
|
15741
15700
|
header?: IThemeHeader;
|
|
15701
|
+
/**
|
|
15702
|
+
* Report specific properties
|
|
15703
|
+
*
|
|
15704
|
+
* @alpha
|
|
15705
|
+
*/
|
|
15706
|
+
reports?: IThemeReports;
|
|
15707
|
+
/**
|
|
15708
|
+
* Image assets offered to reports
|
|
15709
|
+
*
|
|
15710
|
+
* @alpha
|
|
15711
|
+
*/
|
|
15712
|
+
assets?: IThemeAssets;
|
|
15742
15713
|
}
|
|
15743
15714
|
|
|
15744
15715
|
/**
|
|
@@ -15765,6 +15736,51 @@ export declare interface IThemeAnalyticalDesignerTitle {
|
|
|
15765
15736
|
color?: ThemeColor;
|
|
15766
15737
|
}
|
|
15767
15738
|
|
|
15739
|
+
/**
|
|
15740
|
+
* Externally hosted image the theme offers to reports.
|
|
15741
|
+
*
|
|
15742
|
+
* @remarks
|
|
15743
|
+
* The `id` is also the report variable the asset resolves: report content references it as `{id}`.
|
|
15744
|
+
* It must match `^[a-zA-Z][a-zA-Z0-9_]*$`.
|
|
15745
|
+
*
|
|
15746
|
+
* @alpha
|
|
15747
|
+
*/
|
|
15748
|
+
export declare interface IThemeAsset {
|
|
15749
|
+
id: string;
|
|
15750
|
+
/**
|
|
15751
|
+
* Absolute http(s) URL. The organization CSP must allow the host; for exports the host must
|
|
15752
|
+
* also serve CORS headers.
|
|
15753
|
+
*/
|
|
15754
|
+
url: string;
|
|
15755
|
+
/**
|
|
15756
|
+
* Label the asset is offered under in the editor.
|
|
15757
|
+
*/
|
|
15758
|
+
title?: string;
|
|
15759
|
+
/**
|
|
15760
|
+
* Accessible name of the image; also shown when the image cannot be loaded.
|
|
15761
|
+
*/
|
|
15762
|
+
altText?: string;
|
|
15763
|
+
}
|
|
15764
|
+
|
|
15765
|
+
/**
|
|
15766
|
+
* Image assets linked by URL, grouped by what they are used for.
|
|
15767
|
+
*
|
|
15768
|
+
* @alpha
|
|
15769
|
+
*/
|
|
15770
|
+
export declare interface IThemeAssets {
|
|
15771
|
+
logos?: IThemeAsset[];
|
|
15772
|
+
/**
|
|
15773
|
+
* Images offered for image slots, and as element backgrounds.
|
|
15774
|
+
*/
|
|
15775
|
+
images?: IThemeAsset[];
|
|
15776
|
+
/**
|
|
15777
|
+
* Images meant to be painted behind an element. They are offered first where a background is
|
|
15778
|
+
* chosen; {@link IThemeAssets.images} are offered there too, so an image used both ways is
|
|
15779
|
+
* stated once.
|
|
15780
|
+
*/
|
|
15781
|
+
backgrounds?: IThemeAsset[];
|
|
15782
|
+
}
|
|
15783
|
+
|
|
15768
15784
|
/**
|
|
15769
15785
|
* Axis customization
|
|
15770
15786
|
*
|
|
@@ -15917,6 +15933,22 @@ export declare interface IThemeColorFamily {
|
|
|
15917
15933
|
contrast?: ThemeColor;
|
|
15918
15934
|
}
|
|
15919
15935
|
|
|
15936
|
+
/**
|
|
15937
|
+
* Reference to an existing color palette object, in the same shape the active color palette
|
|
15938
|
+
* setting uses.
|
|
15939
|
+
*
|
|
15940
|
+
* @remarks
|
|
15941
|
+
* The `type` states the scope: `colorPalette` names one of the organization's palettes,
|
|
15942
|
+
* `workspaceColorPalette` one a workspace holds - its own, or one it inherits from a parent.
|
|
15943
|
+
* Either can be referenced.
|
|
15944
|
+
*
|
|
15945
|
+
* @alpha
|
|
15946
|
+
*/
|
|
15947
|
+
export declare interface IThemeColorPaletteRef {
|
|
15948
|
+
id: string;
|
|
15949
|
+
type: "colorPalette" | "workspaceColorPalette";
|
|
15950
|
+
}
|
|
15951
|
+
|
|
15920
15952
|
/**
|
|
15921
15953
|
* Used to color various elements across many components by replacing
|
|
15922
15954
|
* the default complementary palette of gray color shades
|
|
@@ -16541,6 +16573,146 @@ export declare interface IThemePalette {
|
|
|
16541
16573
|
complementary?: IThemeComplementaryPalette;
|
|
16542
16574
|
}
|
|
16543
16575
|
|
|
16576
|
+
/**
|
|
16577
|
+
* Report specific theme properties.
|
|
16578
|
+
*
|
|
16579
|
+
* @remarks
|
|
16580
|
+
* Consumed by the reports application only; the properties are not part of the shared theming
|
|
16581
|
+
* CSS variable specification.
|
|
16582
|
+
*
|
|
16583
|
+
* @alpha
|
|
16584
|
+
*/
|
|
16585
|
+
export declare interface IThemeReports {
|
|
16586
|
+
/**
|
|
16587
|
+
* Colors of visualizations in reports: stated inline, or a reference to a color palette
|
|
16588
|
+
* object. When absent, reports use the workspace's active color palette.
|
|
16589
|
+
*/
|
|
16590
|
+
visualizationPalette?: ThemeColor[] | IThemeColorPaletteRef;
|
|
16591
|
+
page?: IThemeReportsPage;
|
|
16592
|
+
colors?: IThemeReportsColors;
|
|
16593
|
+
textStyle?: IThemeReportsTextStyle;
|
|
16594
|
+
}
|
|
16595
|
+
|
|
16596
|
+
/**
|
|
16597
|
+
* Colors offered to report authors as swatches. Each list is exposed as indexed CSS variables.
|
|
16598
|
+
*
|
|
16599
|
+
* @alpha
|
|
16600
|
+
*/
|
|
16601
|
+
export declare interface IThemeReportsColors {
|
|
16602
|
+
/**
|
|
16603
|
+
* Offered for element backgrounds.
|
|
16604
|
+
*/
|
|
16605
|
+
backgrounds?: ThemeColor[];
|
|
16606
|
+
/**
|
|
16607
|
+
* Offered for text.
|
|
16608
|
+
*/
|
|
16609
|
+
text?: ThemeColor[];
|
|
16610
|
+
}
|
|
16611
|
+
|
|
16612
|
+
/**
|
|
16613
|
+
* One hosted font file registered as a font face for rendered reports.
|
|
16614
|
+
*
|
|
16615
|
+
* @alpha
|
|
16616
|
+
*/
|
|
16617
|
+
export declare interface IThemeReportsFontFace {
|
|
16618
|
+
/**
|
|
16619
|
+
* Font family name the face registers; referenced from {@link IThemeReportsTypography.fontFamily}.
|
|
16620
|
+
*/
|
|
16621
|
+
family: string;
|
|
16622
|
+
/**
|
|
16623
|
+
* Absolute http(s) URL of a TTF/OTF/WOFF/WOFF2 file.
|
|
16624
|
+
*/
|
|
16625
|
+
url: string;
|
|
16626
|
+
/**
|
|
16627
|
+
* CSS font-weight (1-1000). Defaults to 400.
|
|
16628
|
+
*/
|
|
16629
|
+
weight?: number;
|
|
16630
|
+
/**
|
|
16631
|
+
* Defaults to "normal".
|
|
16632
|
+
*/
|
|
16633
|
+
style?: "normal" | "italic";
|
|
16634
|
+
}
|
|
16635
|
+
|
|
16636
|
+
/**
|
|
16637
|
+
* Heading levels. Each level takes what it does not state from here, then from
|
|
16638
|
+
* {@link IThemeReportsTextStyle}.
|
|
16639
|
+
*
|
|
16640
|
+
* @alpha
|
|
16641
|
+
*/
|
|
16642
|
+
export declare interface IThemeReportsHeading {
|
|
16643
|
+
color?: ThemeColor;
|
|
16644
|
+
lineHeight?: ThemeReportsLength;
|
|
16645
|
+
h1?: IThemeReportsTextLevel;
|
|
16646
|
+
h2?: IThemeReportsTextLevel;
|
|
16647
|
+
h3?: IThemeReportsTextLevel;
|
|
16648
|
+
h4?: IThemeReportsTextLevel;
|
|
16649
|
+
h5?: IThemeReportsTextLevel;
|
|
16650
|
+
h6?: IThemeReportsTextLevel;
|
|
16651
|
+
}
|
|
16652
|
+
|
|
16653
|
+
/**
|
|
16654
|
+
* Report page properties.
|
|
16655
|
+
*
|
|
16656
|
+
* @alpha
|
|
16657
|
+
*/
|
|
16658
|
+
export declare interface IThemeReportsPage {
|
|
16659
|
+
backgroundColor?: ThemeColor;
|
|
16660
|
+
}
|
|
16661
|
+
|
|
16662
|
+
/**
|
|
16663
|
+
* Paragraph levels. Each level takes what it does not state from here, then from
|
|
16664
|
+
* {@link IThemeReportsTextStyle}.
|
|
16665
|
+
*
|
|
16666
|
+
* @alpha
|
|
16667
|
+
*/
|
|
16668
|
+
export declare interface IThemeReportsParagraph {
|
|
16669
|
+
color?: ThemeColor;
|
|
16670
|
+
lineHeight?: ThemeReportsLength;
|
|
16671
|
+
largeText?: IThemeReportsTextLevel;
|
|
16672
|
+
normalText?: IThemeReportsTextLevel;
|
|
16673
|
+
smallText?: IThemeReportsTextLevel;
|
|
16674
|
+
}
|
|
16675
|
+
|
|
16676
|
+
/**
|
|
16677
|
+
* Typography of one text level.
|
|
16678
|
+
*
|
|
16679
|
+
* @alpha
|
|
16680
|
+
*/
|
|
16681
|
+
export declare interface IThemeReportsTextLevel {
|
|
16682
|
+
fontSize?: ThemeReportsLength;
|
|
16683
|
+
lineHeight?: ThemeReportsLength;
|
|
16684
|
+
/**
|
|
16685
|
+
* Overrides the color of the level's group.
|
|
16686
|
+
*/
|
|
16687
|
+
color?: ThemeColor;
|
|
16688
|
+
}
|
|
16689
|
+
|
|
16690
|
+
/**
|
|
16691
|
+
* Text of rendered reports.
|
|
16692
|
+
*
|
|
16693
|
+
* @alpha
|
|
16694
|
+
*/
|
|
16695
|
+
export declare interface IThemeReportsTextStyle {
|
|
16696
|
+
color?: ThemeColor;
|
|
16697
|
+
lineHeight?: ThemeReportsLength;
|
|
16698
|
+
typography?: IThemeReportsTypography;
|
|
16699
|
+
heading?: IThemeReportsHeading;
|
|
16700
|
+
paragraph?: IThemeReportsParagraph;
|
|
16701
|
+
}
|
|
16702
|
+
|
|
16703
|
+
/**
|
|
16704
|
+
* Typography of rendered reports.
|
|
16705
|
+
*
|
|
16706
|
+
* @alpha
|
|
16707
|
+
*/
|
|
16708
|
+
export declare interface IThemeReportsTypography {
|
|
16709
|
+
/**
|
|
16710
|
+
* CSS font-family stack applied to rendered reports.
|
|
16711
|
+
*/
|
|
16712
|
+
fontFamily?: string;
|
|
16713
|
+
fonts?: IThemeReportsFontFace[];
|
|
16714
|
+
}
|
|
16715
|
+
|
|
16544
16716
|
/**
|
|
16545
16717
|
* Table customization
|
|
16546
16718
|
*
|
|
@@ -19088,20 +19260,6 @@ export declare type ParameterValue = IParameterDefinition["defaultValue"];
|
|
|
19088
19260
|
*/
|
|
19089
19261
|
export declare function parameterValueMatchesType(definition: IParameterDefinition, value: ParameterValue): boolean;
|
|
19090
19262
|
|
|
19091
|
-
/**
|
|
19092
|
-
* Reads one of {@link IReportsBrandKitColors.chart} as rgb channels, or undefined where the value is
|
|
19093
|
-
* not one of the notations those colors are stated in.
|
|
19094
|
-
*
|
|
19095
|
-
* @remarks
|
|
19096
|
-
* Chart colors become palette entries rather than CSS declarations, so unlike the rest of the kit
|
|
19097
|
-
* they are held to what this reads: hex (3, 4, 6 or 8 digits) and `rgb()`/`rgba()`. The sanitizer
|
|
19098
|
-
* drops what this cannot read, so a stored kit never carries a chart color the palette would
|
|
19099
|
-
* silently ignore.
|
|
19100
|
-
*
|
|
19101
|
-
* @alpha
|
|
19102
|
-
*/
|
|
19103
|
-
export declare function parseReportsBrandChartColor(color: string): IRgbColorValue | undefined;
|
|
19104
|
-
|
|
19105
19263
|
/**
|
|
19106
19264
|
* Provenance of a granted permission — granted directly to the grantee,
|
|
19107
19265
|
* or inherited from a group or rule.
|
|
@@ -19347,7 +19505,7 @@ export declare type ReportBackground = IReportColorBackground | IReportImageBack
|
|
|
19347
19505
|
*
|
|
19348
19506
|
* @alpha
|
|
19349
19507
|
*/
|
|
19350
|
-
export declare type ReportBuiltInVariable = "reportName" | "reportDescription" | "periodStart" | "periodEnd" | "reportDateRange" | "reportAttributeFilters" | "exportedAt" | "exportedBy" | "lastModifiedAt" | "lastModifiedBy" | "workspaceName" | "workspaceId" | "totalPages" | "currentPageNumber" | "logo"
|
|
19508
|
+
export declare type ReportBuiltInVariable = "reportName" | "reportDescription" | "periodStart" | "periodEnd" | "reportDateRange" | "reportAttributeFilters" | "exportedAt" | "exportedBy" | "lastModifiedAt" | "lastModifiedBy" | "workspaceName" | "workspaceId" | "totalPages" | "currentPageNumber" | "logo";
|
|
19351
19509
|
|
|
19352
19510
|
/**
|
|
19353
19511
|
* All built-in report variable names.
|
|
@@ -19377,6 +19535,21 @@ export declare function reportContentPage(reportOrTemplate: IReport | IReportDef
|
|
|
19377
19535
|
*/
|
|
19378
19536
|
export declare type ReportDateString = string;
|
|
19379
19537
|
|
|
19538
|
+
/**
|
|
19539
|
+
* Size a heading is rendered at. Each size is styled by the matching theme text level
|
|
19540
|
+
* (`reports.textStyle.heading.h1` ...).
|
|
19541
|
+
*
|
|
19542
|
+
* @alpha
|
|
19543
|
+
*/
|
|
19544
|
+
export declare type ReportHeadingType = "h1" | "h2" | "h3" | "h4" | "h5" | "h6";
|
|
19545
|
+
|
|
19546
|
+
/**
|
|
19547
|
+
* All heading sizes, largest first.
|
|
19548
|
+
*
|
|
19549
|
+
* @alpha
|
|
19550
|
+
*/
|
|
19551
|
+
export declare const ReportHeadingTypes: ReportHeadingType[];
|
|
19552
|
+
|
|
19380
19553
|
/**
|
|
19381
19554
|
* How an image is fitted to the area it is drawn in: kept whole inside it, filling it and cropped to
|
|
19382
19555
|
* do so, or stretched to its shape.
|
|
@@ -19441,19 +19614,19 @@ export declare const ReportPageFormats: ReportPageFormat[];
|
|
|
19441
19614
|
export declare type ReportPageLayoutNode = IReportLayoutSection | IReportLayoutSlotRef;
|
|
19442
19615
|
|
|
19443
19616
|
/**
|
|
19444
|
-
*
|
|
19617
|
+
* Size a paragraph is rendered at. Each size is styled by the matching theme text level
|
|
19618
|
+
* (`reports.textStyle.paragraph.largeText` ...).
|
|
19445
19619
|
*
|
|
19446
19620
|
* @alpha
|
|
19447
19621
|
*/
|
|
19448
|
-
export declare
|
|
19622
|
+
export declare type ReportParagraphType = "largeText" | "normalText" | "smallText";
|
|
19449
19623
|
|
|
19450
19624
|
/**
|
|
19451
|
-
*
|
|
19452
|
-
* use it.
|
|
19625
|
+
* All paragraph sizes, largest first.
|
|
19453
19626
|
*
|
|
19454
19627
|
* @alpha
|
|
19455
19628
|
*/
|
|
19456
|
-
export declare const
|
|
19629
|
+
export declare const ReportParagraphTypes: ReportParagraphType[];
|
|
19457
19630
|
|
|
19458
19631
|
/**
|
|
19459
19632
|
* All slot types of report content version 1.
|
|
@@ -19470,12 +19643,22 @@ export declare type ReportSlot = IReportVisualizationSlot | IReportTextSlot | IR
|
|
|
19470
19643
|
export declare function reportTextPlaceholder(name: string): string;
|
|
19471
19644
|
|
|
19472
19645
|
/**
|
|
19473
|
-
*
|
|
19474
|
-
*
|
|
19646
|
+
* Size the slot is rendered at.
|
|
19647
|
+
*
|
|
19648
|
+
* @remarks
|
|
19649
|
+
* A slot states its size, and content is an open format: a size the slot cannot carry, and a size
|
|
19650
|
+
* from a newer version, both fall back to the default of the slot's own type.
|
|
19475
19651
|
*
|
|
19476
19652
|
* @alpha
|
|
19477
19653
|
*/
|
|
19478
|
-
export declare
|
|
19654
|
+
export declare function reportTextSlotType(slot: IReportTextSlot): ReportTextType;
|
|
19655
|
+
|
|
19656
|
+
/**
|
|
19657
|
+
* Sizes the slot can be rendered at, which is what its own type decides.
|
|
19658
|
+
*
|
|
19659
|
+
* @alpha
|
|
19660
|
+
*/
|
|
19661
|
+
export declare function reportTextSlotTypes(slot: IReportTextSlot): ReportTextType[];
|
|
19479
19662
|
|
|
19480
19663
|
/**
|
|
19481
19664
|
* Where the text of a text slot comes from.
|
|
@@ -19484,6 +19667,20 @@ export declare type ReportTextSlotKind = "title" | "subtitle" | "sectionTitle" |
|
|
|
19484
19667
|
*/
|
|
19485
19668
|
export declare type ReportTextSource = IReportStaticTextSource | IReportAiTextSource;
|
|
19486
19669
|
|
|
19670
|
+
/**
|
|
19671
|
+
* Size any report text is rendered at.
|
|
19672
|
+
*
|
|
19673
|
+
* @alpha
|
|
19674
|
+
*/
|
|
19675
|
+
export declare type ReportTextType = ReportHeadingType | ReportParagraphType;
|
|
19676
|
+
|
|
19677
|
+
/**
|
|
19678
|
+
* All sizes a text slot can be rendered at, headings first.
|
|
19679
|
+
*
|
|
19680
|
+
* @alpha
|
|
19681
|
+
*/
|
|
19682
|
+
export declare const ReportTextTypes: ReportTextType[];
|
|
19683
|
+
|
|
19487
19684
|
/**
|
|
19488
19685
|
* Entitlements and their values that must be set for the pluggable application to be accessible for
|
|
19489
19686
|
* the currently logged user.
|
|
@@ -19590,20 +19787,6 @@ export declare function sanitizeBucketTotals(bucket: IBucket, sortItems: ISortIt
|
|
|
19590
19787
|
*/
|
|
19591
19788
|
export declare function sanitizeParameterValue(definition: IParameterDefinition, value: ParameterValue): ParameterValue;
|
|
19592
19789
|
|
|
19593
|
-
/**
|
|
19594
|
-
* Reads a stored brand kit from free-form JSON, keeping the parts that are valid and dropping
|
|
19595
|
-
* everything else.
|
|
19596
|
-
*
|
|
19597
|
-
* @remarks
|
|
19598
|
-
* The setting content is not schema-validated by the backend, so every consumer must go
|
|
19599
|
-
* through this. Returns undefined only when the value is not a version "1" brand kit at all;
|
|
19600
|
-
* a kit whose sections are absent or entirely invalid comes back empty, which the type permits
|
|
19601
|
-
* and a workspace that has not filled its kit in yet carries.
|
|
19602
|
-
*
|
|
19603
|
-
* @alpha
|
|
19604
|
-
*/
|
|
19605
|
-
export declare function sanitizeReportsBrandKit(value: unknown): IReportsBrandKit | undefined;
|
|
19606
|
-
|
|
19607
19790
|
/**
|
|
19608
19791
|
* Supported email attachments
|
|
19609
19792
|
* @alpha
|
|
@@ -19797,6 +19980,23 @@ export declare type ThemeDashboardDensity = "comfortable" | "compact";
|
|
|
19797
19980
|
*/
|
|
19798
19981
|
export declare type ThemeFontUri = string;
|
|
19799
19982
|
|
|
19983
|
+
/**
|
|
19984
|
+
* Length used in rendered reports.
|
|
19985
|
+
*
|
|
19986
|
+
* @remarks
|
|
19987
|
+
* A report page scales with its width, so lengths are stated in `cqw` (1cqw = 1% of the page
|
|
19988
|
+
* width). A bare number means cqw: `3.5` and `"3.5cqw"` are the same length. `cqi`, `em` and `%`
|
|
19989
|
+
* are accepted as well. Anything that does not follow the page width is ignored: `px` and `rem`
|
|
19990
|
+
* hold their size, and `cqh` and `cqb` resolve against the viewport, because a page contains its
|
|
19991
|
+
* inline axis only.
|
|
19992
|
+
*
|
|
19993
|
+
* A line height is the exception to the bare number: `1.5` is the CSS ratio it looks like, a
|
|
19994
|
+
* multiple of the font size, not a share of the page width.
|
|
19995
|
+
*
|
|
19996
|
+
* @alpha
|
|
19997
|
+
*/
|
|
19998
|
+
export declare type ThemeReportsLength = string | number;
|
|
19999
|
+
|
|
19800
20000
|
/**
|
|
19801
20001
|
* Throwing exhaustiveness check for discriminated unions: the `never` parameter fails the build on an
|
|
19802
20002
|
* unhandled case, and the throw guards runtime values the compiler cannot see. Counterpart: {@link assertNever}.
|