@luzmo/dashboard-contents-types 1.0.3 → 1.0.4

package/src/lib/hexbin-map/hexbin-map-options.d.ts

@@ -0,0 +1,116 @@
+import { DisplayLegendViewOptions, DisplayTitleViewOptions, InfoTooltipViewOptions, InteractivityCustomTooltipViewOptions, InteractivityExportViewOptions, InteractivityMeasureDimensionPickerViewOptions, ItemThemeConfig, LegendViewOptions, LimitViewOptions, ManualValuesRange, MapObjectViewOptions, TitleViewOptions } from '../shared';
+interface HexbinMapInteractivity {
+    /**
+     * Interactivity options
+     */
+    interactivity?: {
+        /**
+         * Available export types interactivity option
+         * @default ["xlsx", "csv", "png"]
+         */
+        availableExportTypes?: NonNullable<NonNullable<InteractivityExportViewOptions['interactivity']>['availableExportTypes']>;
+        /**
+         * Export types interactivity option
+         * @default ["xlsx", "csv", "png"]
+         */
+        exportTypes?: NonNullable<NonNullable<InteractivityExportViewOptions['interactivity']>['exportTypes']>;
+        /**
+         * Custom tooltip interactivity option, in format {locale: "tooltip"}, for example, {en: "Total Revenue"}
+         * @default null
+         */
+        customTooltip?: NonNullable<NonNullable<InteractivityCustomTooltipViewOptions['interactivity']>['customTooltip']>;
+        /**
+         * An array of measure dimension picker configurations
+         * @default [[]]
+         */
+        measureDimensionPicker?: NonNullable<NonNullable<InteractivityMeasureDimensionPickerViewOptions['interactivity']>['measureDimensionPicker']>;
+    };
+}
+interface HexbinMapDisplayViewOptions {
+    /**
+     * Display options for the Hexbin map
+     */
+    display: {
+        /**
+         * Show or hide the title
+         * @default true
+         */
+        title: NonNullable<NonNullable<DisplayTitleViewOptions['display']>['title']>;
+        /**
+         * Show or hide the legend
+         * @default true
+         */
+        legend?: NonNullable<NonNullable<DisplayLegendViewOptions['display']>['legend']>;
+    };
+}
+export interface HexbinMapViewOptions extends Omit<MapObjectViewOptions, 'display' | 'theme' | 'limit'>, HexbinMapDisplayViewOptions, TitleViewOptions, LegendViewOptions, InfoTooltipViewOptions, HexbinMapInteractivity {
+    /**
+     * Theme configuration
+     */
+    theme?: Omit<ItemThemeConfig, 'axis' | 'legend'>;
+    /**
+     * Options to enable or disable different map features
+     * @default { "zoom": true, "pan": true, "pitchBearing": true, "repositionOnRefresh": true }
+     */
+    enabled?: MapObjectViewOptions['enabled'];
+    /**
+     * Legend options
+     * @default { "size": "M", "position": "bottomLeft", "type": "bar" }
+     */
+    legend?: LegendViewOptions['legend'];
+    /**
+     * Value
+     * @TJS-ignore
+     */
+    value?: (d: any) => number;
+    /**
+     * Radius
+     * @default
+     */
+    radius?: number;
+    /**
+     * Opacity
+     * @default 0.85
+     */
+    opacity?: number;
+    /**
+     * Aggregation type
+     * @default "sum"
+     */
+    aggregationType?: 'sum' | 'mean' | 'median' | 'minimum' | 'maximum' | 'count';
+    /**
+     * Classification method
+     * @default "interval"
+     */
+    classification?: 'interval' | 'quantile' | 'continuous' | 'k-means';
+    /**
+     * Number of classes for classification
+     * @default 5
+     * @examples [3, 4, 5, 6, 7, 8, 9]
+     */
+    numberClasses?: number;
+    /**
+     * A color class, use "manual" to specify custom colors in the manualValues option
+     * @default "PuBu"
+     * @examples ["manual", "Spectral", "RdYlBu", "PdBu", "PiYG", "PRGn", "RdYlGn", "BrBG", "RdGy", "PuOr", "Paired", "Set1", "Set3", "OrRd", "PuBu", "BuPu", "Oranges", "BuGn", "YlOrBr", "YlGn", "Reds", "RdPu", "Greens", "YlGnBu", "Purples", "GnBu", "Greys", "YlOrRd", "PuRd", "Blues", "PuBuGn", "Spectrum", "BlueRed", "Plasma", "Viris", "Incan", "Fire", "Inferno", "Ocean", "Sunrise"]
+     */
+    colorsClass?: string;
+    /**
+     * Manually specified classification and colors
+     * @default { "manualValues": [] }
+     */
+    manualValues?: {
+        ranges?: ManualValuesRange[];
+    };
+    /**
+     * Show number of observations
+     */
+    limit?: {
+        /**
+         * Number of observations value
+         * @default 1000
+         */
+        number?: NonNullable<LimitViewOptions['limit']>['number'];
+    };
+}
+export {};

package/src/lib/hexbin-map/hexbin-map-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hexbin-map-options.d.ts","sourceRoot":"","sources":["../../../../../../libs/dashboard-contents-types/src/lib/hexbin-map/hexbin-map-options.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,wBAAwB,EACxB,uBAAuB,EACvB,sBAAsB,EACtB,qCAAqC,EACrC,8BAA8B,EAC9B,8CAA8C,EAC9C,eAAe,EACf,iBAAiB,EACjB,gBAAgB,EAChB,iBAAiB,EACjB,oBAAoB,EACpB,gBAAgB,EACjB,MAAM,WAAW,CAAC;AAEnB,UAAU,sBAAsB;IAC9B;;OAEG;IACH,aAAa,CAAC,EAAE;QACd;;;WAGG;QACH,oBAAoB,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC,8BAA8B,CAAC,eAAe,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC;QACzH;;;WAGG;QACH,WAAW,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC,8BAA8B,CAAC,eAAe,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC;QACvG;;;WAGG;QACH,aAAa,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC,qCAAqC,CAAC,eAAe,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC;QAClH;;;WAGG;QACH,sBAAsB,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC,8CAA8C,CAAC,eAAe,CAAC,CAAC,CAAC,wBAAwB,CAAC,CAAC,CAAC;KAC9I,CAAC;CACH;AAED,UAAU,2BAA2B;IACnC;;OAEG;IACH,OAAO,EAAE;QACP;;;WAGG;QACH,KAAK,EAAE,WAAW,CAAC,WAAW,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;QAC7E;;;WAGG;QACH,MAAM,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;KAClF,CAAC;CACH;AAED,MAAM,WAAW,oBAAqB,SACpC,IAAI,CAAC,oBAAoB,EAAE,SAAS,GAAG,OAAO,GAAG,OAAO,CAAC,EACzD,2BAA2B,EAC3B,gBAAgB,EAChB,iBAAiB,EACjB,sBAAsB,EACtB,sBAAsB;IACtB;;OAEG;IACH,KAAK,CAAC,EAAE,IAAI,CAAC,eAAe,EAAE,MAAM,GAAG,QAAQ,CAAC,CAAC;IACjD;;;OAGG;IACH,OAAO,CAAC,EAAE,oBAAoB,CAAC,SAAS,CAAC,CAAC;IAC1C;;;OAGG;IACH,MAAM,CAAC,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IACrC;;;OAGG;IACH,KAAK,CAAC,EAAE,CAAC,CAAC,KAAA,KAAK,MAAM,CAAC;IACtB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC;IAC9E;;;OAGG;IACH,cAAc,CAAC,EAAE,UAAU,GAAG,UAAU,GAAG,YAAY,GAAG,SAAS,CAAC;IACpE;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,YAAY,CAAC,EAAE;QACb,MAAM,CAAC,EAAE,iBAAiB,EAAE,CAAC;KAC9B,CAAC;IACF;;OAEG;IACH,KAAK,CAAC,EAAE;QACN;;;WAGG;QACH,MAAM,CAAC,EAAE,WAAW,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;KAC3D,CAAC;CACH"}

package/src/lib/hexbin-map/hexbin-map-slots.d.ts

@@ -0,0 +1,29 @@
+import { DashboardContentVizItemSlot, HierarchySlotContent, NumericSlotContent, DateTimeSlotContent, SpatialSlotContent } from '../shared';
+/**
+ * Geo slot definition of the Hexbin Map. This is the required slot. This slot can only accept a Geo content type column.
+ */
+interface GeoSlot extends DashboardContentVizItemSlot {
+    name: 'geo';
+    /**
+     * Geo slot definition
+     * @maxItems 1
+     */
+    content: SpatialSlotContent[];
+}
+/**
+ * Measure slot definition of the Hexbin Map
+ */
+interface MeasureSlot extends DashboardContentVizItemSlot {
+    name: 'measure';
+    /**
+     * Measure slot definition
+     * @maxItems 1
+     */
+    content: (HierarchySlotContent | NumericSlotContent | DateTimeSlotContent)[];
+}
+/**
+ * Data definition of the Heat Map
+ * @maxItems 2
+ */
+export type HexbinMapSlots = (GeoSlot | MeasureSlot)[];
+export {};

package/src/lib/hexbin-map/hexbin-map-slots.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hexbin-map-slots.d.ts","sourceRoot":"","sources":["../../../../../../libs/dashboard-contents-types/src/lib/hexbin-map/hexbin-map-slots.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,2BAA2B,EAC3B,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,kBAAkB,EACnB,MAAM,WAAW,CAAC;AAEnB;;GAEG;AACH,UAAU,OAAQ,SAAQ,2BAA2B;IACnD,IAAI,EAAE,KAAK,CAAC;IACZ;;;OAGG;IACH,OAAO,EAAE,kBAAkB,EAAE,CAAC;CAC/B;AAED;;GAEG;AACH,UAAU,WAAY,SAAQ,2BAA2B;IACvD,IAAI,EAAE,SAAS,CAAC;IAChB;;;OAGG;IACH,OAAO,EAAE,CAAC,oBAAoB,GAAG,kBAAkB,GAAG,mBAAmB,CAAC,EAAE,CAAC;CAC9E;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,GAAG,WAAW,CAAC,EAAE,CAAC"}

package/src/lib/hexbin-map/hexbin-map.d.ts

@@ -0,0 +1,23 @@
+import { VizItemType } from '../shared';
+import { HexbinMapViewOptions } from './hexbin-map-options';
+import { HexbinMapSlots } from './hexbin-map-slots';
+/**
+ * Hexbin Map item
+ */
+export interface HexbinMap {
+    /**
+     * Type of the item
+     */
+    type: Extract<VizItemType, 'hexbin-map'>;
+    /**
+     * Options of the Hexbin Map item
+     * @$ref ./hexbin-map-options.schema.json/
+     */
+    options: HexbinMapViewOptions;
+    /**
+     * Data definition of the Hexbin Map
+     * @maxItems 2
+     * @$ref ./hexbin-map-slots.schema.json
+     */
+    slots: HexbinMapSlots;
+}

package/src/lib/hexbin-map/hexbin-map.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hexbin-map.d.ts","sourceRoot":"","sources":["../../../../../../libs/dashboard-contents-types/src/lib/hexbin-map/hexbin-map.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;IACzC;;;OAGG;IACH,OAAO,EAAE,oBAAoB,CAAC;IAC9B;;;;OAIG;IACH,KAAK,EAAE,cAAc,CAAC;CACvB"}

package/src/lib/hexbin-map/index.d.ts

@@ -0,0 +1,3 @@
+export * from './hexbin-map-options';
+export * from './hexbin-map-slots';
+export * from './hexbin-map';

package/src/lib/hexbin-map/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../libs/dashboard-contents-types/src/lib/hexbin-map/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC"}

package/src/lib/marker-map/index.d.ts

@@ -0,0 +1,3 @@
+export * from './marker-map-options';
+export * from './marker-map-slots';
+export * from './marker-map';

package/src/lib/marker-map/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../libs/dashboard-contents-types/src/lib/marker-map/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC"}

package/src/lib/marker-map/marker-map-options.d.ts

@@ -0,0 +1,61 @@
+import { DisplayTitleViewOptions, InfoTooltipViewOptions, InteractivityCustomEventsViewOptions, InteractivityCustomTooltipViewOptions, InteractivityExportViewOptions, InteractivityMeasureDimensionPickerViewOptions, ItemThemeConfig, LimitViewOptions, MapObjectViewOptions, TitleViewOptions } from '../shared';
+interface MarkerMapInteractivity {
+    /**
+     * Interactivity options
+     */
+    interactivity?: {
+        /**
+         * Export types interactivity option
+         * @default ["xlsx", "csv", "png"]
+         */
+        exportTypes?: NonNullable<NonNullable<InteractivityExportViewOptions['interactivity']>['exportTypes']>;
+        /**
+         * Available export types interactivity option
+         * @default ["xlsx", "csv", "png"]
+         */
+        availableExportTypes?: NonNullable<NonNullable<InteractivityExportViewOptions['interactivity']>['availableExportTypes']>;
+        /**
+         * Custom events interactivity option
+         * @default null
+         */
+        customEvents?: NonNullable<NonNullable<InteractivityCustomEventsViewOptions['interactivity']>['customEvents']>;
+        /**
+         * Custom tooltip interactivity option, in format {locale: "tooltip"}, for example, {en: "Total Revenue"}
+         * @default null
+         */
+        customTooltip?: NonNullable<NonNullable<InteractivityCustomTooltipViewOptions['interactivity']>['customTooltip']>;
+        /**
+         * An array of measure dimension picker configurations
+         * @default [[]]
+         */
+        measureDimensionPicker?: NonNullable<NonNullable<InteractivityMeasureDimensionPickerViewOptions['interactivity']>['measureDimensionPicker']>;
+    };
+}
+export interface MarkerMapViewOptions extends Omit<MapObjectViewOptions, 'display' | 'theme' | 'limit'>, TitleViewOptions, InfoTooltipViewOptions, MarkerMapInteractivity {
+    /**
+     * Theme configuration
+     */
+    theme?: Omit<ItemThemeConfig, 'axis' | 'colors' | 'legend'>;
+    /**
+     * Title display option
+     * @default { "title": true }
+     */
+    display?: DisplayTitleViewOptions['display'];
+    /**
+     * Cluster surface
+     * @examples [30, 60, 90]
+     * @default 30
+     */
+    maxClusterRadius?: number;
+    /**
+     * Show number of observations
+     */
+    limit?: {
+        /**
+         * Number of observations value
+         * @default 1000
+         */
+        number?: NonNullable<LimitViewOptions['limit']>['number'];
+    };
+}
+export {};

package/src/lib/marker-map/marker-map-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"marker-map-options.d.ts","sourceRoot":"","sources":["../../../../../../libs/dashboard-contents-types/src/lib/marker-map/marker-map-options.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,uBAAuB,EACvB,sBAAsB,EACtB,oCAAoC,EACpC,qCAAqC,EACrC,8BAA8B,EAC9B,8CAA8C,EAC9C,eAAe,EACf,gBAAgB,EAChB,oBAAoB,EACpB,gBAAgB,EACjB,MAAM,WAAW,CAAC;AAEnB,UAAU,sBAAsB;IAC9B;;OAEG;IACH,aAAa,CAAC,EAAE;QACd;;;WAGG;QACH,WAAW,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC,8BAA8B,CAAC,eAAe,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC;QACvG;;;WAGG;QACH,oBAAoB,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC,8BAA8B,CAAC,eAAe,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC;QACzH;;;WAGG;QACH,YAAY,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC,oCAAoC,CAAC,eAAe,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC;QAC/G;;;WAGG;QACH,aAAa,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC,qCAAqC,CAAC,eAAe,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC;QAClH;;;WAGG;QACH,sBAAsB,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC,8CAA8C,CAAC,eAAe,CAAC,CAAC,CAAC,wBAAwB,CAAC,CAAC,CAAC;KAC9I,CAAC;CACH;AAED,MAAM,WAAW,oBAAqB,SACpC,IAAI,CAAC,oBAAoB,EAAE,SAAS,GAAG,OAAO,GAAG,OAAO,CAAC,EACzD,gBAAgB,EAChB,sBAAsB,EACtB,sBAAsB;IACtB;;OAEG;IACH,KAAK,CAAC,EAAE,IAAI,CAAC,eAAe,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC,CAAC;IAC5D;;;OAGG;IACH,OAAO,CAAC,EAAE,uBAAuB,CAAC,SAAS,CAAC,CAAC;IAC7C;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,KAAK,CAAC,EAAE;QACN;;;WAGG;QACH,MAAM,CAAC,EAAE,WAAW,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;KAC3D,CAAC;CACH"}

package/src/lib/marker-map/marker-map-slots.d.ts

@@ -0,0 +1,29 @@
+import { DashboardContentVizItemSlot, HierarchySlotContent, NumericSlotContent, DateTimeSlotContent, SpatialSlotContent } from '../shared';
+/**
+ * Geo slot definition of the Marker Map. This is the required slot. This slot can only accept a Geo content type column.
+ */
+interface GeoSlot extends DashboardContentVizItemSlot {
+    name: 'geo';
+    /**
+     * Geo slot definition
+     * @maxItems 1
+     */
+    content: SpatialSlotContent[];
+}
+/**
+ * Measure slot definition of the Marker Map
+ */
+interface MeasureSlot extends DashboardContentVizItemSlot {
+    name: 'measure';
+    /**
+     * Measure slot definition
+     * @maxItems 1
+     */
+    content: (HierarchySlotContent | NumericSlotContent | DateTimeSlotContent)[];
+}
+/**
+ * Data definition of the Marker Map
+ * @maxItems 3
+ */
+export type MarkerMapSlots = (GeoSlot | MeasureSlot)[];
+export {};

package/src/lib/marker-map/marker-map-slots.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"marker-map-slots.d.ts","sourceRoot":"","sources":["../../../../../../libs/dashboard-contents-types/src/lib/marker-map/marker-map-slots.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,2BAA2B,EAC3B,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,kBAAkB,EACnB,MAAM,WAAW,CAAC;AAEnB;;GAEG;AACH,UAAU,OAAQ,SAAQ,2BAA2B;IACnD,IAAI,EAAE,KAAK,CAAC;IACZ;;;OAGG;IACH,OAAO,EAAE,kBAAkB,EAAE,CAAC;CAC/B;AAED;;GAEG;AACH,UAAU,WAAY,SAAQ,2BAA2B;IACvD,IAAI,EAAE,SAAS,CAAC;IAChB;;;OAGG;IACH,OAAO,EAAE,CAAC,oBAAoB,GAAG,kBAAkB,GAAG,mBAAmB,CAAC,EAAE,CAAC;CAC9E;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,GAAG,WAAW,CAAC,EAAE,CAAC"}

package/src/lib/marker-map/marker-map.d.ts

@@ -0,0 +1,23 @@
+import { VizItemType } from '../shared';
+import { MarkerMapViewOptions } from './marker-map-options';
+import { MarkerMapSlots } from './marker-map-slots';
+/**
+ * Marker Map item
+ */
+export interface MarkerMap {
+    /**
+     * Type of the item
+     */
+    type: Extract<VizItemType, 'marker-map'>;
+    /**
+     * Options of the Marker Map item
+     * @$ref ./marker-map-options.schema.json/
+     */
+    options: MarkerMapViewOptions;
+    /**
+     * Data definition of the Marker Map
+     * @maxItems 2
+     * @$ref ./marker-map-slots.schema.json
+     */
+    slots: MarkerMapSlots;
+}

package/src/lib/marker-map/marker-map.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"marker-map.d.ts","sourceRoot":"","sources":["../../../../../../libs/dashboard-contents-types/src/lib/marker-map/marker-map.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;IACzC;;;OAGG;IACH,OAAO,EAAE,oBAAoB,CAAC;IAC9B;;;;OAIG;IACH,KAAK,EAAE,cAAc,CAAC;CACvB"}

package/src/lib/route-map/index.d.ts

@@ -0,0 +1,3 @@
+export * from './route-map-options';
+export * from './route-map-slots';
+export * from './route-map';

package/src/lib/route-map/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../libs/dashboard-contents-types/src/lib/route-map/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC"}

package/src/lib/route-map/route-map-options.d.ts

@@ -0,0 +1,94 @@
+import { InfoTooltipViewOptions, InteractivityExportViewOptions, InteractivityMeasureDimensionPickerViewOptions, ItemThemeConfig, LimitViewOptions, ManualValuesRange, MapObjectViewOptions, TitleViewOptions } from '../shared';
+interface RouteMapInteractivity {
+    /**
+     * Interactivity options
+     */
+    interactivity?: {
+        /**
+         * Export types interactivity option
+         * @default ["xlsx", "csv", "png"]
+         */
+        exportTypes?: NonNullable<NonNullable<InteractivityExportViewOptions['interactivity']>['exportTypes']>;
+        /**
+         * Available export types interactivity option
+         * @default ["xlsx", "csv", "png"]
+         */
+        availableExportTypes?: NonNullable<NonNullable<InteractivityExportViewOptions['interactivity']>['availableExportTypes']>;
+        /**
+         * An array of measure dimension picker configurations
+         * @default [[]]
+         */
+        measureDimensionPicker?: NonNullable<NonNullable<InteractivityMeasureDimensionPickerViewOptions['interactivity']>['measureDimensionPicker']>;
+    };
+}
+interface RouteMapDisplayOptions {
+    /**
+     * Title display option
+     */
+    display?: {
+        /**
+         * Show or hide the title
+         * @default true
+         */
+        title?: boolean;
+        /**
+         * Show or hide the outline
+         * @default true
+         */
+        outline?: boolean;
+    };
+}
+export interface RouteMapViewOptions extends Omit<MapObjectViewOptions, 'display' | 'theme' | 'limit'>, RouteMapDisplayOptions, TitleViewOptions, InfoTooltipViewOptions, RouteMapInteractivity {
+    /**
+     * Theme configuration
+     */
+    theme?: Omit<ItemThemeConfig, 'axis' | 'colors' | 'legend'>;
+    /**
+     * Manually specified classification and colors
+     * @default { "manualValues": [] }
+     */
+    manualValues?: {
+        /**
+         * @default []
+         */
+        ranges?: ManualValuesRange[];
+    };
+    /**
+     * Classification method
+     * @default 'interval'
+     */
+    classification?: 'interval' | 'manual';
+    /**
+     * Number of classes for classification
+     * @default 5
+     * @examples [3, 4, 5, 6, 7, 8, 9]
+     */
+    numberClasses?: number;
+    /**
+     * Opacity of the route
+     * @default .7
+     */
+    opacity?: number;
+    /**
+     * Line weight of the route
+     * @default 4
+     */
+    lineWeight?: number;
+    /**
+     * A color class, use "manual" to specify custom colors in the manualValues option
+     * @default 'PuBu'
+     * @examples ["manual", "Spectral", "RdYlBu", "PdBu", "PiYG", "PRGn", "RdYlGn", "BrBG", "RdGy", "PuOr", "Paired", "Set1", "Set3", "OrRd", "PuBu", "BuPu", "Oranges", "BuGn", "YlOrBr", "YlGn", "Reds", "RdPu", "Greens", "YlGnBu", "Purples", "GnBu", "Greys", "YlOrRd", "PuRd", "Blues", "PuBuGn", "Spectrum", "BlueRed", "Plasma", "Viris", "Incan", "Fire", "Inferno", "Ocean", "Sunrise"]
+     */
+    colorsClass?: string;
+    /**
+     * Show number of observations
+     */
+    limit?: {
+        /**
+         * Number of observations value
+         * @default 10000
+         */
+        number?: NonNullable<LimitViewOptions['limit']>['number'];
+    };
+}
+export {};

package/src/lib/route-map/route-map-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"route-map-options.d.ts","sourceRoot":"","sources":["../../../../../../libs/dashboard-contents-types/src/lib/route-map/route-map-options.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,sBAAsB,EACtB,8BAA8B,EAC9B,8CAA8C,EAC9C,eAAe,EACf,gBAAgB,EAChB,iBAAiB,EACjB,oBAAoB,EACpB,gBAAgB,EACjB,MAAM,WAAW,CAAC;AAEnB,UAAU,qBAAqB;IAC7B;;OAEG;IACH,aAAa,CAAC,EAAE;QACd;;;WAGG;QACH,WAAW,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC,8BAA8B,CAAC,eAAe,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC;QACvG;;;WAGG;QACH,oBAAoB,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC,8BAA8B,CAAC,eAAe,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC;QACzH;;;WAGG;QACH,sBAAsB,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC,8CAA8C,CAAC,eAAe,CAAC,CAAC,CAAC,wBAAwB,CAAC,CAAC,CAAC;KAC9I,CAAC;CACH;AAED,UAAU,sBAAsB;IAC9B;;OAEG;IACH,OAAO,CAAC,EAAE;QACR;;;WAGG;QACH,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB;;;WAGG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,CAAC;CACH;AAED,MAAM,WAAW,mBAAoB,SACnC,IAAI,CAAC,oBAAoB,EAAE,SAAS,GAAG,OAAO,GAAG,OAAO,CAAC,EACzD,sBAAsB,EACtB,gBAAgB,EAChB,sBAAsB,EACtB,qBAAqB;IACrB;;OAEG;IACH,KAAK,CAAC,EAAE,IAAI,CAAC,eAAe,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC,CAAC;IAC5D;;;OAGG;IACH,YAAY,CAAC,EAAE;QACb;;WAEG;QACH,MAAM,CAAC,EAAE,iBAAiB,EAAE,CAAC;KAC9B,CAAC;IACF;;;OAGG;IACH,cAAc,CAAC,EAAE,UAAU,GAAG,QAAQ,CAAC;IACvC;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,KAAK,CAAC,EAAE;QACN;;;WAGG;QACH,MAAM,CAAC,EAAE,WAAW,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;KAC3D,CAAC;CACH"}

package/src/lib/route-map/route-map-slots.d.ts

@@ -0,0 +1,51 @@
+import { DashboardContentVizItemSlot, HierarchySlotContent, NumericSlotContent, DateTimeSlotContent, SpatialSlotContent } from '../shared';
+/**
+ * Order slot definition of the Route Map
+ */
+interface OrderSlot extends DashboardContentVizItemSlot {
+    name: 'order';
+    /**
+     * Order slot definition. It accepts either a numeric or date-time content.
+     * @maxItems 1
+     */
+    content: (NumericSlotContent | DateTimeSlotContent)[];
+}
+/**
+ * Geo slot definition of the Route Map. This is the required slot. This slot can only accept a Geo content type column.
+ */
+interface GeoSlot extends DashboardContentVizItemSlot {
+    name: 'geo';
+    /**
+     * Geo slot definition
+     * @maxItems 1
+     */
+    content: SpatialSlotContent[];
+}
+/**
+ * Legend slot definition of the Route Map
+ */
+interface LegendSlot extends DashboardContentVizItemSlot {
+    name: 'legend';
+    /**
+     * Legend slot definition
+     * @maxItems 1
+     */
+    content: (HierarchySlotContent | NumericSlotContent | DateTimeSlotContent)[];
+}
+/**
+ * Route slot definition of the Route Map
+ */
+interface RouteSlot extends DashboardContentVizItemSlot {
+    name: 'measure';
+    /**
+     * Route slot definition
+     * @maxItems 1
+     */
+    content: (HierarchySlotContent | NumericSlotContent | DateTimeSlotContent)[];
+}
+/**
+ * Data definition of the Route Map
+ * @maxItems 4
+ */
+export type RouteMapSlots = (OrderSlot | GeoSlot | LegendSlot | RouteSlot)[];
+export {};

package/src/lib/route-map/route-map-slots.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"route-map-slots.d.ts","sourceRoot":"","sources":["../../../../../../libs/dashboard-contents-types/src/lib/route-map/route-map-slots.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,2BAA2B,EAC3B,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,kBAAkB,EACnB,MAAM,WAAW,CAAC;AAEnB;;GAEG;AACH,UAAU,SAAU,SAAQ,2BAA2B;IACrD,IAAI,EAAE,OAAO,CAAC;IACd;;;OAGG;IACH,OAAO,EAAE,CAAC,kBAAkB,GAAG,mBAAmB,CAAC,EAAE,CAAC;CACvD;AAED;;GAEG;AACH,UAAU,OAAQ,SAAQ,2BAA2B;IACnD,IAAI,EAAE,KAAK,CAAC;IACZ;;;OAGG;IACH,OAAO,EAAE,kBAAkB,EAAE,CAAC;CAC/B;AAED;;GAEG;AACH,UAAU,UAAW,SAAQ,2BAA2B;IACtD,IAAI,EAAE,QAAQ,CAAC;IACf;;;OAGG;IACH,OAAO,EAAE,CAAC,oBAAoB,GAAG,kBAAkB,GAAG,mBAAmB,CAAC,EAAE,CAAC;CAC9E;AAED;;GAEG;AACH,UAAU,SAAU,SAAQ,2BAA2B;IACrD,IAAI,EAAE,SAAS,CAAC;IAChB;;;OAGG;IACH,OAAO,EAAE,CAAC,oBAAoB,GAAG,kBAAkB,GAAG,mBAAmB,CAAC,EAAE,CAAC;CAC9E;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,SAAS,GAAG,OAAO,GAAG,UAAU,GAAG,SAAS,CAAC,EAAE,CAAC"}

package/src/lib/route-map/route-map.d.ts

@@ -0,0 +1,23 @@
+import { VizItemType } from '../shared';
+import { RouteMapViewOptions } from './route-map-options';
+import { RouteMapSlots } from './route-map-slots';
+/**
+ * Route Map item
+ */
+export interface RouteMap {
+    /**
+     * Type of the item
+     */
+    type: Extract<VizItemType, 'route-map'>;
+    /**
+     * Options of the Route Map item
+     * @$ref ./route-map-options.schema.json/
+     */
+    options: RouteMapViewOptions;
+    /**
+     * Data definition of the Route Map
+     * @maxItems 2
+     * @$ref ./route-map-slots.schema.json
+     */
+    slots: RouteMapSlots;
+}

package/src/lib/route-map/route-map.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"route-map.d.ts","sourceRoot":"","sources":["../../../../../../libs/dashboard-contents-types/src/lib/route-map/route-map.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAElD;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IACxC;;;OAGG;IACH,OAAO,EAAE,mBAAmB,CAAC;IAC7B;;;;OAIG;IACH,KAAK,EAAE,aAAa,CAAC;CACtB"}

package/src/lib/shared/drop-object-view-options.d.ts

@@ -1,7 +1,7 @@
 import { ObjectViewOptions } from './object-view-options';
 export interface DropObjectViewOptions extends ObjectViewOptions {
     /**
-     * The main color for the item, if omitted the default color from the theme will be used.
+     * The main color for the item, if omitted the default color from the theme will be used
      * @examples ["#FF5733", "#33FF57", "#5733FF"]
      * @default ""
      */