@astrato-io/visualizations 0.0.0-stage → 0.6.5

package/src/definitions/model/definitions/descriptors/descriptor-metadata.d.ts

@@ -0,0 +1,1341 @@
+import type { VisualizationDefinition } from '../types/definition.types';
+import type { VisualizationDefinitionDocumentation, VisualizationDefinitionFeature } from '../types/descriptor.types';
+type VisualizationDefinitionType = VisualizationDefinition['type'];
+export interface VisualizationDefinitionDescriptorMetadataEntry<TType extends VisualizationDefinitionType = VisualizationDefinitionType> {
+    /** Additional named scenarios that demonstrate materially different valid definition shapes. */
+    additionalExamples?: readonly {
+        definition: VisualizationDefinition & {
+            type: TType;
+        };
+        title: string;
+    }[];
+    /** Product-facing explanation of the selected visualization's requirements and semantics. */
+    documentation: VisualizationDefinitionDocumentation;
+    /** Canonical valid definition used by generated documentation and Nash prompting examples. */
+    example: VisualizationDefinition & {
+        type: TType;
+    };
+    /** Concise capability list used when callers or Nash discover and compare visualization types. */
+    supportedFeatures: readonly VisualizationDefinitionFeature[];
+    /** VisualizationDefinition discriminator associated with this metadata entry. */
+    type: TType;
+}
+interface ExampleDimension {
+    fieldKey: string;
+    format: {
+        formatType: 'none';
+    };
+    ref: string;
+    showNullValues?: boolean;
+}
+interface ExampleField {
+    fieldKey: string;
+    ref: string;
+}
+interface ExampleMeasure {
+    aggregation: string;
+    fieldKey: string;
+    format: {
+        formatType: 'number2Decimal';
+        negativeType: 'parenthesis';
+    };
+    ref: string;
+}
+/**
+ * Complete metadata catalog used by public descriptors and generated reference documentation.
+ * Adding a new VisualizationDefinition type without a corresponding entry fails TypeScript compilation.
+ */
+export declare const visualizationDefinitionDescriptorMetadata: readonly [{
+    readonly additionalExamples: readonly [{
+        readonly definition: {
+            readonly data: {
+                readonly dimensions: [ExampleDimension];
+                readonly measures: [ExampleMeasure];
+            };
+            readonly presentation: {
+                readonly coloring: {
+                    readonly overwrites: [{
+                        readonly color: "#0F766E";
+                        readonly value: "Audi";
+                    }, {
+                        readonly color: "#D97706";
+                        readonly operator: "inList";
+                        readonly values: ["BMW", "Buick"];
+                    }];
+                    readonly rules: [{
+                        readonly color: "#DC2626";
+                        readonly measure: "sales";
+                        readonly operator: "less";
+                        readonly value: 20;
+                    }];
+                };
+            };
+            readonly type: "bar";
+            readonly version: 1;
+        };
+        readonly title: "Colors bound to dimension values and a measure threshold";
+    }];
+    readonly documentation: {
+        readonly constraints: readonly ["Sorting and Top N refer to definition-local refs, not generated data-item IDs.", "Every dimension and measure must resolve to an available field with a compatible role.", "Set axis per measure to plot it against the primary or the secondary measure axis.", "presentation.axes.primaryMeasure.bands shades the plot between two primary measure axis values; start and end are measure values, and the bands replace any on the base vSpec.", "Set range on a measure axis to fix its min, max, or both, for example to give several charts one shared scale; leave both unset and set startsAtZero to keep an auto-fitted axis anchored at zero. Set inverted on a measure axis to reverse its values, for example to put rank 1 at the top.", "Set scale to log on a measure axis to draw it logarithmically, with gridlines at powers of ten. Zero and negative values are drawn at the floor of a log axis."];
+        readonly dataRequirements: readonly ["At least one dimension.", "At least one measure."];
+        readonly summary: "Categorical comparison chart with sorting, limiting, per-measure axes, labels, and orientation controls.";
+        readonly title: "Bar chart";
+    };
+    readonly example: {
+        readonly data: {
+            readonly dimensions: [{
+                readonly showNullValues: false;
+                readonly fieldKey: string;
+                readonly format: {
+                    formatType: "none";
+                };
+                readonly ref: string;
+            }];
+            readonly measures: [{
+                readonly dataLabels: {
+                    readonly placements: ["outside", "inside"];
+                    readonly visible: true;
+                };
+                readonly aggregation: string;
+                readonly fieldKey: string;
+                readonly format: {
+                    formatType: "number2Decimal";
+                    negativeType: "parenthesis";
+                };
+                readonly ref: string;
+            }];
+        };
+        readonly filterGroup: {
+            filters: {
+                fieldKey: "[Cars].[Manufacturer]";
+                operator: "inList";
+                values: string[];
+            }[];
+            operator: "and";
+        };
+        readonly limiting: {
+            readonly queryLimit: 100;
+            readonly topN: {
+                readonly by: "sales";
+                readonly count: 10;
+                readonly direction: "desc";
+                readonly showOthers: false;
+            };
+        };
+        readonly presentation: {
+            readonly axes: {
+                readonly primaryMeasure: {
+                    readonly bands: [{
+                        readonly color: "#E6E6E6";
+                        readonly end: 150000;
+                        readonly label: "Target range";
+                        readonly start: 100000;
+                    }];
+                    readonly labelsVisible: boolean;
+                    readonly title: string;
+                    readonly titleVisible: boolean;
+                };
+                readonly dimension: {
+                    labelsVisible: boolean;
+                    title: string;
+                    titleVisible: boolean;
+                };
+                readonly secondaryMeasure: {
+                    labelsVisible: boolean;
+                    title: string;
+                    titleVisible: boolean;
+                };
+            };
+            readonly legend: {
+                position: "right";
+                title: string;
+                visible: boolean;
+            };
+            readonly orientation: "vertical";
+        };
+        readonly sorting: [{
+            readonly by: "sales";
+            readonly direction: "desc";
+        }];
+        readonly type: "bar";
+        readonly version: 1;
+    };
+    readonly supportedFeatures: readonly ["axes", "axis-bands", "axis-range", "axis-scale", "conditional-coloring", "data-labels", "dimensions", "filters", "legend", "measure-axis", "measures", "orientation", "query-limit", "sorting", "top-n", "value-formatting"];
+    readonly type: "bar";
+}, {
+    readonly documentation: {
+        readonly constraints: readonly ["The single dimension is assigned the combo category role.", "Set seriesType per measure to create bar, line, or point series; omission keeps the existing line default.", "Data labels apply only to bar series.", "Sorting refers to definition-local refs, not generated data-item IDs.", "Set axis per measure to plot it against the primary or the secondary measure axis. Bar series share one axis: state it on any bar measure, and every bar measure that states one must state the same axis.", "presentation.axes.primaryMeasure.bands shades the plot between two primary measure axis values; start and end are measure values, and the bands replace any on the base vSpec.", "Set range on a measure axis to fix its min, max, or both, for example to give several charts one shared scale; leave both unset and set startsAtZero to keep an auto-fitted axis anchored at zero. Set inverted on a measure axis to reverse its values, for example to put rank 1 at the top.", "Set scale to log on a measure axis to draw it logarithmically, with gridlines at powers of ten. Zero and negative values are drawn at the floor of a log axis."];
+        readonly dataRequirements: readonly ["Exactly one dimension.", "Between one and ten measures."];
+        readonly summary: "Combined categorical chart supporting multiple measures, per-measure axes, sorting, limiting, labels, legend, and orientation.";
+        readonly title: "Combo chart";
+    };
+    readonly example: {
+        readonly data: {
+            readonly dimensions: [ExampleDimension];
+            readonly measures: [{
+                readonly dataLabels: {
+                    readonly visible: true;
+                };
+                readonly seriesType: "bar";
+                readonly aggregation: string;
+                readonly fieldKey: string;
+                readonly format: {
+                    formatType: "number2Decimal";
+                    negativeType: "parenthesis";
+                };
+                readonly ref: string;
+            }, {
+                readonly axis: "secondary";
+                readonly seriesType: "line";
+                readonly aggregation: string;
+                readonly fieldKey: string;
+                readonly format: {
+                    formatType: "number2Decimal";
+                    negativeType: "parenthesis";
+                };
+                readonly ref: string;
+            }];
+        };
+        readonly filterGroup: {
+            filters: {
+                fieldKey: "[Cars].[Manufacturer]";
+                operator: "inList";
+                values: string[];
+            }[];
+            operator: "and";
+        };
+        readonly limiting: {
+            readonly queryLimit: 100;
+        };
+        readonly presentation: {
+            readonly axes: {
+                dimension: {
+                    labelsVisible: boolean;
+                    title: string;
+                    titleVisible: boolean;
+                };
+                primaryMeasure: {
+                    labelsVisible: boolean;
+                    title: string;
+                    titleVisible: boolean;
+                };
+            };
+            readonly dataLabels: {
+                readonly visible: true;
+            };
+            readonly legend: {
+                position: "right";
+                title: string;
+                visible: boolean;
+            };
+            readonly orientation: "vertical";
+        };
+        readonly sorting: [{
+            readonly by: "sales";
+            readonly direction: "desc";
+        }];
+        readonly type: "combo";
+        readonly version: 1;
+    };
+    readonly supportedFeatures: readonly [...VisualizationDefinitionFeature[], "axes", "axis-bands", "axis-range", "axis-scale", "data-labels", "legend", "measure-axis", "orientation", "query-limit", "series-type", "sorting"];
+    readonly type: "combo";
+}, {
+    readonly documentation: {
+        readonly constraints: readonly ["All measures are assigned the gauge-value role.", "Distribution definitions enable the established gauge comparison mode."];
+        readonly dataRequirements: readonly ["Zero or one dimension.", "Between one and twenty measures."];
+        readonly summary: "Gauge distribution across one or more values, optionally grouped by a dimension.";
+        readonly title: "Distribution gauge";
+    };
+    readonly example: {
+        readonly data: {
+            readonly dimensions: [ExampleDimension];
+            readonly measures: [ExampleMeasure, ExampleMeasure];
+        };
+        readonly filterGroup: {
+            filters: {
+                fieldKey: "[Cars].[Manufacturer]";
+                operator: "inList";
+                values: string[];
+            }[];
+            operator: "and";
+        };
+        readonly presentation: {
+            readonly displayMode: "bar";
+            readonly legend: {
+                position: "right";
+                title: string;
+                visible: boolean;
+            };
+        };
+        readonly type: "distribution-gauge";
+        readonly version: 1;
+    };
+    readonly supportedFeatures: readonly [...VisualizationDefinitionFeature[], "conditional-coloring", "display-mode", "legend"];
+    readonly type: "distribution-gauge";
+}, {
+    readonly documentation: {
+        readonly constraints: readonly ["Dimension order is significant and maps to the two dot-chart dimension roles.", "Set range on the primary measure axis to fix its min, max, or both, for example to give several charts one shared scale; leave both unset and set startsAtZero to keep an auto-fitted axis anchored at zero. Set inverted on the primary measure axis to reverse its values."];
+        readonly dataRequirements: readonly ["Exactly two dimensions.", "Exactly one measure."];
+        readonly summary: "Dot comparison using two categorical dimensions and one measure.";
+        readonly title: "Dot chart";
+    };
+    readonly example: {
+        readonly data: {
+            readonly dimensions: [ExampleDimension, ExampleDimension];
+            readonly measures: [ExampleMeasure];
+        };
+        readonly filterGroup: {
+            filters: {
+                fieldKey: "[Cars].[Manufacturer]";
+                operator: "inList";
+                values: string[];
+            }[];
+            operator: "and";
+        };
+        readonly presentation: {
+            readonly axes: {
+                dimension: {
+                    labelsVisible: boolean;
+                    title: string;
+                    titleVisible: boolean;
+                };
+                primaryMeasure: {
+                    labelsVisible: boolean;
+                    title: string;
+                    titleVisible: boolean;
+                };
+            };
+            readonly legend: {
+                position: "right";
+                title: string;
+                visible: boolean;
+            };
+            readonly orientation: "horizontal";
+        };
+        readonly type: "dot";
+        readonly version: 1;
+    };
+    readonly supportedFeatures: readonly [...VisualizationDefinitionFeature[], "conditional-coloring", "axes", "axis-range", "legend", "orientation"];
+    readonly type: "dot";
+}, {
+    readonly documentation: {
+        readonly constraints: readonly ["With a dimension, the first measure is the gauge value and the optional second measure is the target.", "Without a dimension, supplied measures are gauge values.", "When a target measure is supplied, the compiler enables the established data-target mode."];
+        readonly dataRequirements: readonly ["Zero or one dimension.", "Between one and twenty measures; with one dimension, at most two measures."];
+        readonly summary: "Gauge values with an optional grouping dimension and optional data target.";
+        readonly title: "Gauge chart";
+    };
+    readonly example: {
+        readonly data: {
+            readonly dimensions: [ExampleDimension];
+            readonly measures: [ExampleMeasure, ExampleMeasure];
+        };
+        readonly filterGroup: {
+            filters: {
+                fieldKey: "[Cars].[Manufacturer]";
+                operator: "inList";
+                values: string[];
+            }[];
+            operator: "and";
+        };
+        readonly presentation: {
+            readonly displayMode: "radial";
+            readonly legend: {
+                position: "right";
+                title: string;
+                visible: boolean;
+            };
+        };
+        readonly type: "gauge";
+        readonly version: 1;
+    };
+    readonly supportedFeatures: readonly [...VisualizationDefinitionFeature[], "conditional-coloring", "display-mode", "legend"];
+    readonly type: "gauge";
+}, {
+    readonly documentation: {
+        readonly constraints: readonly ["Dimension order maps to horizontal then vertical roles.", "Measure order maps to color then optional size roles."];
+        readonly dataRequirements: readonly ["Exactly two dimensions.", "One or two measures."];
+        readonly summary: "Two-dimensional matrix colored and optionally sized by measures.";
+        readonly title: "Heat map";
+    };
+    readonly example: {
+        readonly data: {
+            readonly dimensions: [ExampleDimension, ExampleDimension];
+            readonly measures: [ExampleMeasure, ExampleMeasure];
+        };
+        readonly filterGroup: {
+            filters: {
+                fieldKey: "[Cars].[Manufacturer]";
+                operator: "inList";
+                values: string[];
+            }[];
+            operator: "and";
+        };
+        readonly limiting: {
+            readonly queryLimit: 100;
+        };
+        readonly presentation: {
+            readonly axes: {
+                dimension: {
+                    labelsVisible: boolean;
+                    title: string;
+                    titleVisible: boolean;
+                };
+                primaryMeasure: {
+                    labelsVisible: boolean;
+                    title: string;
+                    titleVisible: boolean;
+                };
+                secondaryDimension: {
+                    labelsVisible: boolean;
+                    title: string;
+                    titleVisible: boolean;
+                };
+            };
+            readonly legend: {
+                position: "right";
+                title: string;
+                visible: boolean;
+            };
+        };
+        readonly sorting: [{
+            readonly by: "sales";
+            readonly direction: "desc";
+        }];
+        readonly type: "heatMap";
+        readonly version: 1;
+    };
+    readonly supportedFeatures: readonly [...VisualizationDefinitionFeature[], "conditional-coloring", "axes", "legend", "query-limit", "sorting"];
+    readonly type: "heatMap";
+}, {
+    readonly documentation: {
+        readonly constraints: readonly ["The compiler creates the canonical generated count measure; callers do not provide measures.", "presentation.axes.primaryMeasure.bands shades the plot between two primary measure axis values; start and end are measure values, and the bands replace any on the base vSpec.", "Set range on the primary measure axis to fix its min, max, or both, for example to give several charts one shared scale; leave both unset and set startsAtZero to keep an auto-fitted axis anchored at zero. Set inverted on the primary measure axis to reverse its values."];
+        readonly dataRequirements: readonly ["Exactly one numeric dimension.", "No caller-supplied measures."];
+        readonly summary: "Distribution of a numeric field into generated bins and counts.";
+        readonly title: "Histogram";
+    };
+    readonly example: {
+        readonly data: {
+            readonly dimensions: [ExampleDimension];
+        };
+        readonly filterGroup: {
+            filters: {
+                fieldKey: "[Cars].[Manufacturer]";
+                operator: "inList";
+                values: string[];
+            }[];
+            operator: "and";
+        };
+        readonly presentation: {
+            readonly axes: {
+                dimension: {
+                    labelsVisible: boolean;
+                    title: string;
+                    titleVisible: boolean;
+                };
+                primaryMeasure: {
+                    labelsVisible: boolean;
+                    title: string;
+                    titleVisible: boolean;
+                };
+            };
+            readonly legend: {
+                position: "right";
+                title: string;
+                visible: boolean;
+            };
+            readonly orientation: "vertical";
+        };
+        readonly type: "histogram";
+        readonly version: 1;
+    };
+    readonly supportedFeatures: readonly ["axes", "axis-bands", "axis-range", "dimensions", "filters", "legend", "orientation", "value-formatting"];
+    readonly type: "histogram";
+}, {
+    readonly additionalExamples: readonly [{
+        readonly definition: {
+            readonly data: {
+                readonly dimensions: [ExampleDimension];
+                readonly measures: [{
+                    readonly dataPointShape: "circle";
+                    readonly aggregation: string;
+                    readonly fieldKey: string;
+                    readonly format: {
+                        formatType: "number2Decimal";
+                        negativeType: "parenthesis";
+                    };
+                    readonly ref: string;
+                }];
+            };
+            readonly presentation: {
+                readonly axes: {
+                    readonly primaryMeasure: {
+                        readonly inverted: true;
+                        readonly range: {
+                            readonly max: 100;
+                            readonly min: 1;
+                        };
+                        readonly title: "Rank";
+                    };
+                };
+            };
+            readonly type: "line";
+            readonly version: 1;
+        };
+        readonly title: "Fixed, inverted measure axis";
+    }, {
+        readonly definition: {
+            readonly data: {
+                readonly dimensions: [ExampleDimension, ExampleDimension];
+                readonly measures: [{
+                    readonly dataPointShape: "circle";
+                    readonly aggregation: string;
+                    readonly fieldKey: string;
+                    readonly format: {
+                        formatType: "number2Decimal";
+                        negativeType: "parenthesis";
+                    };
+                    readonly ref: string;
+                }];
+            };
+            readonly presentation: {
+                readonly coloring: {
+                    readonly overwrites: [{
+                        readonly color: "#7C3AED";
+                        readonly operator: "startsWith";
+                        readonly value: "A";
+                    }];
+                };
+            };
+            readonly type: "line";
+            readonly version: 1;
+        };
+        readonly title: "Series colored by dimension value";
+    }];
+    readonly documentation: {
+        readonly constraints: readonly ["Each measure may select the primary or secondary axis using its axis property.", "Visible data labels require dataPointShape on every measure.", "presentation.axes.primaryMeasure.bands shades the plot between two primary measure axis values; start and end are measure values, and the bands replace any on the base vSpec.", "Set range on a measure axis to fix its min, max, or both, for example to give several charts one shared scale; leave both unset and set startsAtZero to keep an auto-fitted axis anchored at zero. Set inverted on a measure axis to reverse its values, for example to put rank 1 at the top.", "Set scale to log on a measure axis to draw it logarithmically, with gridlines at powers of ten. Zero and negative values are drawn at the floor of a log axis.", "Value colors in presentation.coloring require at least two dimensions; measure color rules are not supported."];
+        readonly dataRequirements: readonly ["At least one dimension.", "At least one measure."];
+        readonly summary: "Trend chart with sorting, query limiting, dual measure axes, labels, legend, and orientation.";
+        readonly title: "Line chart";
+    };
+    readonly example: {
+        readonly data: {
+            readonly dimensions: [ExampleDimension];
+            readonly measures: [{
+                readonly axis: "primary";
+                readonly dataPointShape: "circle";
+                readonly aggregation: string;
+                readonly fieldKey: string;
+                readonly format: {
+                    formatType: "number2Decimal";
+                    negativeType: "parenthesis";
+                };
+                readonly ref: string;
+            }, {
+                readonly axis: "secondary";
+                readonly dataPointShape: "square";
+                readonly aggregation: string;
+                readonly fieldKey: string;
+                readonly format: {
+                    formatType: "number2Decimal";
+                    negativeType: "parenthesis";
+                };
+                readonly ref: string;
+            }];
+        };
+        readonly filterGroup: {
+            filters: {
+                fieldKey: "[Cars].[Manufacturer]";
+                operator: "inList";
+                values: string[];
+            }[];
+            operator: "and";
+        };
+        readonly limiting: {
+            readonly queryLimit: 100;
+        };
+        readonly presentation: {
+            readonly axes: {
+                dimension: {
+                    labelsVisible: boolean;
+                    title: string;
+                    titleVisible: boolean;
+                };
+                primaryMeasure: {
+                    labelsVisible: boolean;
+                    title: string;
+                    titleVisible: boolean;
+                };
+                secondaryMeasure: {
+                    labelsVisible: boolean;
+                    title: string;
+                    titleVisible: boolean;
+                };
+            };
+            readonly dataLabels: {
+                readonly density: "medium";
+                readonly visible: true;
+            };
+            readonly legend: {
+                position: "right";
+                title: string;
+                visible: boolean;
+            };
+            readonly orientation: "vertical";
+        };
+        readonly sorting: [{
+            readonly by: "sales";
+            readonly direction: "desc";
+        }];
+        readonly type: "line";
+        readonly version: 1;
+    };
+    readonly supportedFeatures: readonly ["axes", "axis-bands", "axis-range", "axis-scale", "conditional-coloring", "data-labels", "data-points", "dimensions", "filters", "legend", "measure-axis", "measures", "orientation", "query-limit", "sorting", "value-formatting"];
+    readonly type: "line";
+}, {
+    readonly documentation: {
+        readonly constraints: readonly ["Without dimensions, at least two measures are required.", "With dimensions, exactly one measure is supported.", "Value colors in presentation.coloring require two dimensions; measure color rules are not supported."];
+        readonly dataRequirements: readonly ["Zero to two dimensions.", "Two to five measures without dimensions, or one with dimensions."];
+        readonly summary: "Radial comparison chart for one or more measures with optional categorical dimensions.";
+        readonly title: "Radar chart";
+    };
+    readonly example: {
+        readonly data: {
+            readonly dimensions: [ExampleDimension];
+            readonly measures: [ExampleMeasure];
+        };
+        readonly filterGroup: {
+            filters: {
+                fieldKey: "[Cars].[Manufacturer]";
+                operator: "inList";
+                values: string[];
+            }[];
+            operator: "and";
+        };
+        readonly presentation: {
+            readonly legend: {
+                position: "right";
+                title: string;
+                visible: boolean;
+            };
+        };
+        readonly type: "radar";
+        readonly version: 1;
+    };
+    readonly supportedFeatures: readonly [...VisualizationDefinitionFeature[], "conditional-coloring", "legend"];
+    readonly type: "radar";
+}, {
+    readonly additionalExamples: readonly [{
+        readonly definition: {
+            readonly data: {
+                readonly dimensions: [ExampleDimension];
+                readonly measures: [ExampleMeasure];
+            };
+            readonly presentation: {
+                readonly coloring: {
+                    readonly overwrites: [{
+                        readonly color: "#134E4A";
+                        readonly value: "Audi";
+                    }, {
+                        readonly color: "#2DD4BF";
+                        readonly value: "BMW";
+                    }, {
+                        readonly color: "#CCFBF1";
+                        readonly value: "Buick";
+                    }];
+                };
+            };
+            readonly type: "pie";
+            readonly version: 1;
+        };
+        readonly title: "Ordered bands colored along a ramp";
+    }];
+    readonly documentation: {
+        readonly constraints: readonly ["The first measure is the slice value; the optional second measure receives the length role."];
+        readonly dataRequirements: readonly ["Exactly one dimension.", "One or two measures."];
+        readonly summary: "Part-to-whole chart with optional secondary radial measure.";
+        readonly title: "Pie chart";
+    };
+    readonly example: {
+        readonly data: {
+            readonly dimensions: [ExampleDimension];
+            readonly measures: [ExampleMeasure];
+        };
+        readonly filterGroup: {
+            filters: {
+                fieldKey: "[Cars].[Manufacturer]";
+                operator: "inList";
+                values: string[];
+            }[];
+            operator: "and";
+        };
+        readonly limiting: {
+            readonly queryLimit: 100;
+        };
+        readonly presentation: {
+            readonly legend: {
+                position: "right";
+                title: string;
+                visible: boolean;
+            };
+        };
+        readonly sorting: [{
+            readonly by: "sales";
+            readonly direction: "desc";
+        }];
+        readonly type: "pie";
+        readonly version: 1;
+    };
+    readonly supportedFeatures: readonly [...VisualizationDefinitionFeature[], "conditional-coloring", "legend", "query-limit", "sorting"];
+    readonly type: "pie";
+}, {
+    readonly documentation: {
+        readonly constraints: readonly ["At least one dimension or measure must be supplied.", "Trees with dimensions support at most one measure; measure-only trees may contain multiple measures."];
+        readonly dataRequirements: readonly ["Zero to ten dimensions.", "Zero to one hundred measures, or at most one with dimensions."];
+        readonly summary: "Hierarchical tree built from dimensions, measures, or both.";
+        readonly title: "Tree chart";
+    };
+    readonly example: {
+        readonly data: {
+            readonly dimensions: [ExampleDimension, ExampleDimension];
+            readonly measures: [ExampleMeasure];
+        };
+        readonly filterGroup: {
+            filters: {
+                fieldKey: "[Cars].[Manufacturer]";
+                operator: "inList";
+                values: string[];
+            }[];
+            operator: "and";
+        };
+        readonly limiting: {
+            readonly queryLimit: 100;
+        };
+        readonly presentation: {
+            readonly layout: {
+                readonly compact: true;
+                readonly direction: "top";
+                readonly forceAutoFit: false;
+                readonly initialExpandedLevels: 1;
+            };
+        };
+        readonly sorting: [{
+            readonly by: "sales";
+            readonly direction: "desc";
+        }];
+        readonly type: "tree";
+        readonly version: 1;
+    };
+    readonly supportedFeatures: readonly [...VisualizationDefinitionFeature[], "layout", "query-limit", "sorting"];
+    readonly type: "tree";
+}, {
+    readonly documentation: {
+        readonly constraints: readonly ["Dimension order defines hierarchy depth."];
+        readonly dataRequirements: readonly ["Between one and ten dimensions.", "Exactly one measure."];
+        readonly summary: "Hierarchical area chart using ordered dimensions and one size measure.";
+        readonly title: "Treemap";
+    };
+    readonly example: {
+        readonly data: {
+            readonly dimensions: [ExampleDimension, ExampleDimension];
+            readonly measures: [ExampleMeasure];
+        };
+        readonly filterGroup: {
+            filters: {
+                fieldKey: "[Cars].[Manufacturer]";
+                operator: "inList";
+                values: string[];
+            }[];
+            operator: "and";
+        };
+        readonly presentation: {
+            readonly legend: {
+                position: "right";
+                title: string;
+                visible: boolean;
+            };
+        };
+        readonly type: "treemap";
+        readonly version: 1;
+    };
+    readonly supportedFeatures: readonly [...VisualizationDefinitionFeature[], "conditional-coloring", "legend"];
+    readonly type: "treemap";
+}, {
+    readonly additionalExamples: readonly [{
+        readonly definition: {
+            readonly data: {
+                readonly dimensions: [ExampleDimension, ExampleDimension];
+                readonly measures: [ExampleMeasure];
+            };
+            readonly presentation: {
+                readonly coloring: {
+                    readonly overwrites: [{
+                        readonly color: "#CA8A04";
+                        readonly dimension: "manufacturer";
+                        readonly value: "Audi";
+                    }];
+                };
+            };
+            readonly type: "sankey";
+            readonly version: 1;
+        };
+        readonly title: "A color bound to a value of one flow stage";
+    }];
+    readonly documentation: {
+        readonly constraints: readonly ["Dimension order defines the source-to-target flow stages.", "Every value color in presentation.coloring must name the dimension it applies to."];
+        readonly dataRequirements: readonly ["Between two and fifteen dimensions.", "Exactly one measure."];
+        readonly summary: "Flow chart across an ordered sequence of categorical dimensions.";
+        readonly title: "Sankey chart";
+    };
+    readonly example: {
+        readonly data: {
+            readonly dimensions: [ExampleDimension, ExampleDimension];
+            readonly measures: [ExampleMeasure];
+        };
+        readonly filterGroup: {
+            filters: {
+                fieldKey: "[Cars].[Manufacturer]";
+                operator: "inList";
+                values: string[];
+            }[];
+            operator: "and";
+        };
+        readonly type: "sankey";
+        readonly version: 1;
+    };
+    readonly supportedFeatures: readonly [...VisualizationDefinitionFeature[], "conditional-coloring"];
+    readonly type: "sankey";
+}, {
+    readonly documentation: {
+        readonly constraints: readonly ["Measure order maps to horizontal, vertical, and optional size roles.", "The optional second dimension receives the image role.", "Roles come from item order only; a ref is a label and does not select a role.", "With a size measure, points scale between the setPointSize and setMaxPointSize operation values.", "Set range on a measure axis to fix its min, max, or both, for example to give several charts one shared scale; leave both unset and set startsAtZero to keep an auto-fitted axis anchored at zero. Set inverted on a measure axis to reverse its values, for example to put rank 1 at the top."];
+        readonly dataRequirements: readonly ["One or two dimensions.", "Two or three measures."];
+        readonly summary: "Relationship chart using horizontal and vertical measures with optional size and image roles.";
+        readonly title: "Scatter chart";
+    };
+    readonly example: {
+        readonly data: {
+            readonly dimensions: [ExampleDimension];
+            readonly measures: [ExampleMeasure, ExampleMeasure, ExampleMeasure];
+        };
+        readonly filterGroup: {
+            filters: {
+                fieldKey: "[Cars].[Manufacturer]";
+                operator: "inList";
+                values: string[];
+            }[];
+            operator: "and";
+        };
+        readonly presentation: {
+            readonly axes: {
+                primaryMeasure: {
+                    labelsVisible: boolean;
+                    title: string;
+                    titleVisible: boolean;
+                };
+                secondaryMeasure: {
+                    labelsVisible: boolean;
+                    title: string;
+                    titleVisible: boolean;
+                };
+            };
+            readonly legend: {
+                position: "right";
+                title: string;
+                visible: boolean;
+            };
+        };
+        readonly type: "scatter";
+        readonly version: 1;
+    };
+    readonly supportedFeatures: readonly [...VisualizationDefinitionFeature[], "conditional-coloring", "axes", "axis-range", "legend", "query-limit", "sorting"];
+    readonly type: "scatter";
+}, {
+    readonly additionalExamples: readonly [{
+        readonly definition: {
+            readonly data: {
+                readonly dimensions: [ExampleDimension, ExampleDimension];
+                readonly measures: [ExampleMeasure];
+                readonly structure: "expandable";
+            };
+            readonly filterGroup: {
+                filters: {
+                    fieldKey: "[Cars].[Manufacturer]";
+                    operator: "inList";
+                    values: string[];
+                }[];
+                operator: "and";
+            };
+            readonly limiting: {
+                readonly queryLimit: 100;
+            };
+            readonly sorting: [{
+                readonly by: "sales";
+                readonly direction: "desc";
+            }];
+            readonly type: "table";
+            readonly version: 1;
+        };
+        readonly title: "Expandable table";
+    }, {
+        readonly definition: {
+            readonly data: {
+                readonly columnDimensions: [ExampleDimension];
+                readonly measures: [ExampleMeasure];
+                readonly rowDimensions: [ExampleDimension];
+                readonly structure: "pivot";
+            };
+            readonly filterGroup: {
+                filters: {
+                    fieldKey: "[Cars].[Manufacturer]";
+                    operator: "inList";
+                    values: string[];
+                }[];
+                operator: "and";
+            };
+            readonly limiting: {
+                readonly queryLimit: 100;
+            };
+            readonly sorting: [{
+                readonly by: "sales";
+                readonly direction: "desc";
+            }];
+            readonly type: "table";
+            readonly version: 1;
+        };
+        readonly title: "Pivot table";
+    }];
+    readonly documentation: {
+        readonly constraints: readonly ["Normal table column order is preserved, and each column declares whether it is a dimension or measure.", "Expandable table dimension order defines the expansion hierarchy.", "Pivot tables explicitly separate row dimensions, column dimensions, and measures.", "Measure definitions require valid aggregation for raw fields.", "Presentation settings initialize table appearance and layout; later runtime operations preserve them.", "Totals settings are optional; omitted totals properties preserve their values from the fresh default or preset vSpec."];
+        readonly dataRequirements: readonly ["Normal tables require at least one ordered dimension or measure column.", "Expandable tables require at least one dimension and one measure.", "Pivot tables require at least one row dimension, one column dimension, and one measure."];
+        readonly summary: "Normal, expandable, or pivot tabular output with formatting, filtering, sorting, query limiting, and totals.";
+        readonly title: "Table";
+    };
+    readonly example: {
+        readonly data: {
+            readonly columns: [{
+                readonly role: "dimension";
+                readonly fieldKey: string;
+                readonly format: {
+                    formatType: "none";
+                };
+                readonly ref: string;
+                readonly showNullValues?: boolean;
+            }, {
+                readonly role: "dimension";
+                readonly fieldKey: string;
+                readonly format: {
+                    formatType: "none";
+                };
+                readonly ref: string;
+                readonly showNullValues?: boolean;
+            }, {
+                readonly role: "measure";
+                readonly aggregation: string;
+                readonly fieldKey: string;
+                readonly format: {
+                    formatType: "number2Decimal";
+                    negativeType: "parenthesis";
+                };
+                readonly ref: string;
+            }];
+            readonly structure: "normal";
+        };
+        readonly filterGroup: {
+            filters: {
+                fieldKey: "[Cars].[Manufacturer]";
+                operator: "inList";
+                values: string[];
+            }[];
+            operator: "and";
+        };
+        readonly limiting: {
+            readonly queryLimit: 100;
+        };
+        readonly presentation: {
+            readonly background: {
+                readonly color: "#ffffff";
+                readonly type: "single";
+            };
+            readonly body: {
+                readonly fontColor: "#1f1c3b";
+                readonly fontFamily: "Roboto";
+                readonly fontSize: 13;
+                readonly horizontalAlign: "center";
+                readonly verticalAlign: "middle";
+            };
+            readonly borders: {
+                readonly color: "#e0e0e0";
+                readonly dividerColor: "#e0e0e0";
+                readonly dividers: "all";
+                readonly enabled: true;
+                readonly lineStyle: "line";
+                readonly radius: 4;
+                readonly strokeWidth: 1;
+            };
+            readonly header: {
+                readonly backgroundColor: "#ffffff";
+                readonly borderColor: "#e0e0e0";
+                readonly fontColor: "#1f1c3b";
+                readonly fontFamily: "Roboto";
+                readonly fontSize: 13;
+            };
+            readonly highlight: {
+                readonly backgroundColor: "#f2f2f2";
+                readonly mode: "row";
+            };
+            readonly layout: {
+                readonly columnWidthBehavior: "responsive";
+                readonly rowHeight: 41;
+            };
+        };
+        readonly sorting: [{
+            readonly by: "sales";
+            readonly direction: "desc";
+        }];
+        readonly totals: {
+            readonly applyTo: "both";
+            readonly enabled: true;
+            readonly showRecordsCount: true;
+            readonly style: {
+                readonly backgroundColor: "#f3f4f6";
+                readonly fontColor: "#111827";
+                readonly fontStyle: {
+                    readonly bold: true;
+                };
+                readonly position: "bottom";
+                readonly responsiveHeight: true;
+            };
+        };
+        readonly type: "table";
+        readonly version: 1;
+    };
+    readonly supportedFeatures: readonly ["dimensions", "filters", "layout", "measures", "query-limit", "sorting", "table-structure", "totals", "value-formatting"];
+    readonly type: "table";
+}, {
+    readonly documentation: {
+        readonly constraints: readonly ["Dimensions are not supported. Measure order defines the waterfall sequence.", "Set range on the primary measure axis to fix its min, max, or both, for example to give several charts one shared scale; leave both unset and set startsAtZero to keep an auto-fitted axis anchored at zero. Set inverted on the primary measure axis to reverse its values.", "presentation.axes.primaryMeasure.bands shades the plot between two primary measure axis values; start and end are measure values, and the bands replace any on the base vSpec."];
+        readonly dataRequirements: readonly ["Between one and one hundred measures."];
+        readonly summary: "Sequential contribution chart composed from one or more measures.";
+        readonly title: "Waterfall chart";
+    };
+    readonly example: {
+        readonly data: {
+            readonly measures: [{
+                readonly dataLabels: {
+                    readonly visible: true;
+                };
+                readonly aggregation: string;
+                readonly fieldKey: string;
+                readonly format: {
+                    formatType: "number2Decimal";
+                    negativeType: "parenthesis";
+                };
+                readonly ref: string;
+            }, {
+                readonly dataLabels: {
+                    readonly visible: true;
+                };
+                readonly aggregation: string;
+                readonly fieldKey: string;
+                readonly format: {
+                    formatType: "number2Decimal";
+                    negativeType: "parenthesis";
+                };
+                readonly ref: string;
+            }];
+        };
+        readonly filterGroup: {
+            filters: {
+                fieldKey: "[Cars].[Manufacturer]";
+                operator: "inList";
+                values: string[];
+            }[];
+            operator: "and";
+        };
+        readonly presentation: {
+            readonly axes: {
+                dimension: {
+                    labelsVisible: boolean;
+                    title: string;
+                    titleVisible: boolean;
+                };
+                primaryMeasure: {
+                    labelsVisible: boolean;
+                    title: string;
+                    titleVisible: boolean;
+                };
+            };
+            readonly dataLabels: {
+                readonly visible: true;
+            };
+            readonly orientation: "vertical";
+        };
+        readonly type: "waterfall";
+        readonly version: 1;
+    };
+    readonly supportedFeatures: readonly ["axes", "axis-bands", "axis-range", "data-labels", "filters", "measures", "orientation", "value-formatting"];
+    readonly type: "waterfall";
+}, {
+    readonly documentation: {
+        readonly constraints: readonly ["The dimension supplies words and the measure supplies their weight."];
+        readonly dataRequirements: readonly ["Exactly one dimension.", "Exactly one measure."];
+        readonly summary: "Weighted word display using one label dimension and one measure.";
+        readonly title: "Word cloud";
+    };
+    readonly example: {
+        readonly data: {
+            readonly dimensions: [ExampleDimension];
+            readonly measures: [ExampleMeasure];
+        };
+        readonly filterGroup: {
+            filters: {
+                fieldKey: "[Cars].[Manufacturer]";
+                operator: "inList";
+                values: string[];
+            }[];
+            operator: "and";
+        };
+        readonly type: "word-cloud";
+        readonly version: 1;
+    };
+    readonly supportedFeatures: readonly [...VisualizationDefinitionFeature[], "conditional-coloring"];
+    readonly type: "word-cloud";
+}, {
+    readonly documentation: {
+        readonly constraints: readonly ["The selected field must be date- or timestamp-compatible."];
+        readonly dataRequirements: readonly ["Exactly one field."];
+        readonly summary: "Date selection control with single/range modes, labels, quick select, and responsive settings.";
+        readonly title: "Date picker";
+    };
+    readonly example: {
+        readonly data: {
+            readonly field: ExampleField;
+        };
+        readonly settings: {
+            readonly endDateLabel: "To";
+            readonly pickerState: "expanded";
+            readonly pickerType: "range";
+            readonly quickSelect: true;
+            readonly responsive: true;
+            readonly startDateLabel: "From";
+            readonly timePickerVisibility: "never";
+            readonly weekStart: "1";
+        };
+        readonly type: "date-picker";
+        readonly version: 1;
+    };
+    readonly supportedFeatures: readonly ["dimensions", "filter-settings"];
+    readonly type: "date-picker";
+}, {
+    readonly documentation: {
+        readonly constraints: readonly ["The selected field is used as a filter dimension."];
+        readonly dataRequirements: readonly ["Exactly one field."];
+        readonly summary: "Interactive field filter with list/dropdown presentation and search/quick-select controls.";
+        readonly title: "Filter";
+    };
+    readonly example: {
+        readonly data: {
+            readonly field: ExampleField;
+        };
+        readonly presentation: {
+            readonly mode: "listbox";
+            readonly quickSelect: true;
+            readonly responsive: true;
+            readonly searchable: true;
+            readonly showProgressBar: false;
+        };
+        readonly type: "filter";
+        readonly version: 1;
+    };
+    readonly supportedFeatures: readonly ["dimensions", "filter-settings"];
+    readonly type: "filter";
+}, {
+    readonly documentation: {
+        readonly constraints: readonly ["The URL must be absolute and valid; null clears the source."];
+        readonly dataRequirements: readonly ["No query data."];
+        readonly summary: "Embedded external web content.";
+        readonly title: "Iframe";
+    };
+    readonly example: {
+        readonly settings: {
+            readonly url: "https://example.com";
+        };
+        readonly type: "iframe";
+        readonly version: 1;
+    };
+    readonly supportedFeatures: readonly ["content"];
+    readonly type: "iframe";
+}, {
+    readonly documentation: {
+        readonly constraints: readonly ["The source must use one of the supported image source variants."];
+        readonly dataRequirements: readonly ["No query data."];
+        readonly summary: "Image content with fit, opacity, blur, saturation, and shadow controls.";
+        readonly title: "Image";
+    };
+    readonly example: {
+        readonly settings: {
+            readonly blur: 0;
+            readonly fit: "contain";
+            readonly opacity: 0.95;
+            readonly saturation: 0.9;
+            readonly shadow: true;
+            readonly source: {
+                readonly imageUrl: "https://example.com/image.png";
+                readonly sourceKind: "url";
+            };
+        };
+        readonly type: "image";
+        readonly version: 1;
+    };
+    readonly supportedFeatures: readonly ["content", "object-settings"];
+    readonly type: "image";
+}, {
+    readonly documentation: {
+        readonly constraints: readonly ["A raw field measure requires aggregation; semantic measures and calculations omit it."];
+        readonly dataRequirements: readonly ["Exactly one measure."];
+        readonly summary: "Single aggregated or semantic value with value formatting and static filters.";
+        readonly title: "Number";
+    };
+    readonly example: {
+        readonly data: {
+            readonly measure: ExampleMeasure;
+        };
+        readonly filterGroup: {
+            filters: {
+                fieldKey: "[Cars].[Manufacturer]";
+                operator: "inList";
+                values: string[];
+            }[];
+            operator: "and";
+        };
+        readonly type: "number";
+        readonly version: 1;
+    };
+    readonly supportedFeatures: readonly ["filters", "measures", "value-formatting"];
+    readonly type: "number";
+}, {
+    readonly documentation: {
+        readonly constraints: readonly ["Image-specific settings apply only when the selected shape/background mode supports them."];
+        readonly dataRequirements: readonly ["No query data."];
+        readonly summary: "Decorative shape with fill, stroke, sizing, rotation, and border controls.";
+        readonly title: "Shape";
+    };
+    readonly example: {
+        readonly settings: {
+            readonly backgroundColor: {
+                readonly code: "#2e6e9e";
+            };
+            readonly backgroundType: "color";
+            readonly borderEnabled: true;
+            readonly borderRadius: 8;
+            readonly heightBasedSize: false;
+            readonly lineThickness: 4;
+            readonly preserveAspectRatio: true;
+            readonly rotate: 12;
+            readonly scale: 0.7;
+            readonly shape: "hexagon";
+            readonly strokeColor: {
+                readonly code: "#18212b";
+            };
+        };
+        readonly type: "shape";
+        readonly version: 1;
+    };
+    readonly supportedFeatures: readonly ["object-settings"];
+    readonly type: "shape";
+}, {
+    readonly documentation: {
+        readonly constraints: readonly ["Content interpretation follows the selected representation."];
+        readonly dataRequirements: readonly ["No query data."];
+        readonly summary: "Text or Markdown content with typography, alignment, wrapping, and responsive controls.";
+        readonly title: "Text object";
+    };
+    readonly example: {
+        readonly settings: {
+            readonly align: "center";
+            readonly content: "## Revenue overview";
+            readonly fontFamily: "Arial";
+            readonly fontSize: 30;
+            readonly position: "middle";
+            readonly representation: "markdown";
+            readonly responsive: true;
+            readonly textColor: "#18212b";
+            readonly wordWrap: true;
+        };
+        readonly type: "simpleTextObject";
+        readonly version: 1;
+    };
+    readonly supportedFeatures: readonly ["content", "object-settings"];
+    readonly type: "simpleTextObject";
+}, {
+    readonly documentation: {
+        readonly constraints: readonly ["The referenced variable must exist in the host variable service when variable behavior is used."];
+        readonly dataRequirements: readonly ["No query data; variable-backed input."];
+        readonly summary: "Variable input control with input type, label, placeholder, and responsive settings.";
+        readonly title: "Atomic input";
+    };
+    readonly example: {
+        readonly settings: {
+            readonly customLabel: {
+                readonly enabled: true;
+                readonly text: "Target";
+            };
+            readonly inputType: "text";
+            readonly placeholder: "Enter target";
+            readonly responsive: true;
+            readonly variableId: "target-variable";
+        };
+        readonly type: "atomic-input";
+        readonly version: 1;
+    };
+    readonly supportedFeatures: readonly ["input-settings"];
+    readonly type: "atomic-input";
+}, {
+    readonly documentation: {
+        readonly constraints: readonly ["Orientation defaults to horizontal. Use vertical for stacked sidebar filters; editors open beside the sidebar when space permits.", "The bar displays active selections from its selection group, regardless of the fields allowed for creating new filters.", "An empty selectableFieldKeys list allows users to create filters on any selectable field.", "Selection mode overrides apply only to selections created by this bar; apply, cancel, and clear affect the shared selection group.", "Chart breakdown switching is hidden by default. Enable showChartBreakdown only when the app uses dimension groups; a group must have multiple available fields for the control to appear."];
+        readonly dataRequirements: readonly ["No query data; uses field metadata and selections supplied by the host."];
+        readonly summary: "App filter bar settings for selection behavior, filter creation, associative filtering, and selectable fields.";
+        readonly title: "Astrato App Filter Bar";
+    };
+    readonly example: {
+        readonly settings: {
+            readonly enableAddingNewFilters: true;
+            readonly enableAssociativeFilter: true;
+            readonly selectableFieldKeys: ["[Cars].[Manufacturer]", "[Cars].[Model]"];
+            readonly selectionMode: "inherit";
+            readonly showChartBreakdown: false;
+            readonly showClearAll: true;
+        };
+        readonly type: "astrato-app-filter-bar";
+        readonly version: 1;
+    };
+    readonly supportedFeatures: readonly ["selection-settings"];
+    readonly type: "astrato-app-filter-bar";
+}, {
+    readonly documentation: {
+        readonly constraints: readonly ["The field must be numeric or date-compatible with the configured range and step.", "Providing range enables manual bounds; omitting it keeps data-derived bounds."];
+        readonly dataRequirements: readonly ["Exactly one field."];
+        readonly summary: "Numeric or date range control with single/multi layout, step, and quick select.";
+        readonly title: "Slider";
+    };
+    readonly example: {
+        readonly data: {
+            readonly field: ExampleField;
+        };
+        readonly settings: {
+            readonly layout: "multi";
+            readonly quickSelect: true;
+            readonly range: {
+                readonly max: 500;
+                readonly min: 0;
+            };
+            readonly step: 10;
+        };
+        readonly type: "slider";
+        readonly version: 1;
+    };
+    readonly supportedFeatures: readonly ["dimensions", "filter-settings"];
+    readonly type: "slider";
+}];
+/** Returns the documentation metadata associated with one supported visualization type. */
+export declare const getVisualizationDefinitionDescriptorMetadata: <TType extends VisualizationDefinitionType>(type: TType) => VisualizationDefinitionDescriptorMetadataEntry<TType>;
+export {};