eurostat-map 4.4.4 → 4.5.0

package/build/types/map-types/flow/FlowMapConfig.d.ts

@@ -99,60 +99,122 @@ export interface FlowMapConfig extends MapConfig {
     /** Flow graph. */
     flowGraph?: FlowGraph
 
+    /** Grouped flow settings object. */
+    flowSettings?: {
+        color?: string
+        regionColors?: string[]
+        regionLabels?: string[]
+        arrows?: boolean
+        arrowScale?: number
+        maxWidth?: number
+        minWidth?: number
+        outlines?: boolean
+        outlineWidth?: number
+        outlineColor?: string
+        colorGradient?: boolean
+        stack?: boolean
+        nodes?: boolean
+        nodeType?: 'circle' | 'donut'
+        labelOffsets?: { x?: number; y?: number }
+        lineType?: 'curved' | 'straight' | 'sankey'
+        nodeSizeScale?: (value: number) => number
+        opacity?: number
+        internal?: boolean
+        topLocations?: number
+        topLocationsType?: 'sum' | 'origin' | 'destination'
+        curvatureSettings?: FlowCurvatureSettings
+        order?: (a: any, b: any) => number
+        widthGradient?: boolean
+        opacityGradient?: boolean
+        widthGradientSettings?: FlowWidthGradientSettings
+        bidirectional?: boolean
+        edgeBundling?: boolean
+        bundleSettings?: FlowBundleSettings
+    }
+
+    /** @deprecated Use flowSettings.color */
     /** Flow color. */
     flowColor?: string
+    /** @deprecated Use flowSettings.regionColors */
     /** Flow region colors. */
     flowRegionColors?: string[]
+    /** @deprecated Use flowSettings.regionLabels */
     /** Flow region labels. */
     flowRegionLabels?: string[]
+    /** @deprecated Use flowSettings.arrows */
     /** Flow arrows. */
     flowArrows?: boolean
+    /** @deprecated Use flowSettings.arrowScale */
     /** Flow arrow scale. */
     flowArrowScale?: number
+    /** @deprecated Use flowSettings.maxWidth */
     /** Flow max width. */
     flowMaxWidth?: number
+    /** @deprecated Use flowSettings.minWidth */
     /** Flow min width. */
     flowMinWidth?: number
+    /** @deprecated Use flowSettings.outlines */
     /** Flow outlines. */
     flowOutlines?: boolean
+    /** @deprecated Use flowSettings.outlineWidth */
     /** Flow outline width. */
     flowOutlineWidth?: number
+    /** @deprecated Use flowSettings.outlineColor */
     /** Flow outline color. */
     flowOutlineColor?: string
+    /** @deprecated Use flowSettings.colorGradient */
     /** Flow color gradient. */
     flowColorGradient?: boolean
+    /** @deprecated Use flowSettings.stack */
     /** Flow stack. */
     flowStack?: boolean
+    /** @deprecated Use flowSettings.nodes */
     /** Flow nodes. */
     flowNodes?: boolean
+    /** @deprecated Use flowSettings.nodeType */
     /** Flow node type. */
     flowNodeType?: 'circle' | 'donut'
+    /** @deprecated Use flowSettings.labelOffsets */
     /** Flow label offsets. */
     flowLabelOffsets?: { x?: number; y?: number }
+    /** @deprecated Use flowSettings.lineType */
     /** Flow line type. */
     flowLineType?: 'curved' | 'straight' | 'sankey'
+    /** @deprecated Use flowSettings.nodeSizeScale */
     flowNodeSizeScale?: (value: number) => number
+    /** @deprecated Use flowSettings.opacity */
     /** Flow opacity. */
     flowOpacity?: number
+    /** @deprecated Use flowSettings.internal */
     /** Flow internal. */
     flowInternal?: boolean
+    /** @deprecated Use flowSettings.topLocations */
     /** Flow top locations. */
     flowTopLocations?: number
+    /** @deprecated Use flowSettings.topLocationsType */
     /** Flow top locations type. */
     flowTopLocationsType?: 'sum' | 'origin' | 'destination'
+    /** @deprecated Use flowSettings.curvatureSettings */
     /** Flow curvature settings. */
     flowCurvatureSettings?: FlowCurvatureSettings
+    /** @deprecated Use flowSettings.order */
     flowOrder?: (a: any, b: any) => number
+    /** @deprecated Use flowSettings.widthGradient */
     /** Flow width gradient. */
     flowWidthGradient?: boolean
+    /** @deprecated Use flowSettings.opacityGradient */
     /** Flow opacity gradient. */
     flowOpacityGradient?: boolean
+    /** @deprecated Use flowSettings.widthGradientSettings */
     /** Flow width gradient settings. */
     flowWidthGradientSettings?: FlowWidthGradientSettings
+    /** @deprecated Use flowSettings.bidirectional */
     /** Flow bidirectional. */
     flowBidirectional?: boolean
+    /** @deprecated Use flowSettings.edgeBundling */
     /** Flow edge bundling. */
     flowEdgeBundling?: boolean
+    /** @deprecated Use flowSettings.bundleSettings */
     /** Flow bundle settings. */
     flowBundleSettings?: FlowBundleSettings
 }

package/build/types/map-types/proportional-symbol/ProportionalSymbolConfig.d.ts

@@ -1,5 +1,32 @@
 import type { MapConfig } from '../../core/MapConfig'
 
+export interface ProportionalSymbolSettings {
+    shape?: string
+    customShape?: any
+    customSVG?: any
+    spikeWidth?: number
+    offset?: { x: number; y: number }
+    barWidth?: number
+    minValue?: number | undefined
+    maxValue?: number | undefined
+    fill?: string
+    fillOpacity?: number
+    stroke?: string
+    strokeWidth?: number
+    strokeOpacity?: number
+    sizeScale?: 'sqrt' | 'linear' | any
+    minSize?: number
+    maxSize?: number
+    classes?: number
+    colors?: string[] | null
+    colorFun?: any
+    classToFillStyle?: any
+    thresholds?: number[]
+    classificationMethod?: string
+    brightenFactor?: number
+    codeLabels?: boolean
+}
+
 /**
  * Configuration for proportional symbol maps
  */
@@ -14,4 +41,7 @@ export interface ProportionalSymbolConfig extends MapConfig {
 
     /** Size function. */
     psCustomSize?: (value: number) => number
+
+    /** Grouped proportional symbol style settings. */
+    psSettings?: ProportionalSymbolSettings
 }

package/build/types/map-types/proportional-symbol/ProportionalSymbolMap.d.ts

@@ -1,9 +1,13 @@
 import { MapInstance } from '../../core/MapInstance'
+import type { ProportionalSymbolSettings } from './ProportionalSymbolConfig'
 
 /**
  * Proportional symbol map object
  */
 export interface ProportionalSymbolMap extends MapInstance {
+    psSettings(): ProportionalSymbolSettings
+    psSettings(v: ProportionalSymbolSettings): this
+
     psMaxSize(): number
     psMaxSize(v: number): this
 

package/build/types/map-types/proportional-symbol/mushroom/MushroomMap.d.ts

@@ -4,27 +4,64 @@ import type { MapInstance } from '../../../core/MapInstance'
  * Mushroom map type.
  */
 export interface MushroomMap extends MapInstance {
+    mushroomSettings(): {
+        codes: [string, string]
+        minSize: number
+        maxSize: number
+        colors: [string, string]
+        orientation: 'horizontal' | 'vertical'
+        sizeScaleFunction: any
+        sizeScaleFunctionV1: any
+        sizeScaleFunctionV2: any
+    }
+    mushroomSettings(v: {
+        codes?: [string, string]
+        minSize?: number
+        maxSize?: number
+        colors?: [string, string]
+        orientation?: 'horizontal' | 'vertical'
+        sizeScaleFunction?: any
+        sizeScaleFunctionV1?: any
+        sizeScaleFunctionV2?: any
+    }): this
+
+    /** @deprecated Use mushroomSettings({ codes }) */
     mushroomCodes(): [string, string]
+    /** @deprecated Use mushroomSettings({ codes }) */
     mushroomCodes(v: [string, string]): this
 
+    /** @deprecated Use mushroomSettings({ minSize }) */
     mushroomMinSize(): number
+    /** @deprecated Use mushroomSettings({ minSize }) */
     mushroomMinSize(v: number): this
 
+    /** @deprecated Use mushroomSettings({ maxSize }) */
     mushroomMaxSize(): number
+    /** @deprecated Use mushroomSettings({ maxSize }) */
     mushroomMaxSize(v: number): this
 
+    /** @deprecated Use mushroomSettings({ colors }) */
     mushroomColors(): [string, string]
+    /** @deprecated Use mushroomSettings({ colors }) */
     mushroomColors(v: [string, string]): this
 
+    /** @deprecated Use mushroomSettings({ orientation }) */
     mushroomOrientation(): 'horizontal' | 'vertical'
+    /** @deprecated Use mushroomSettings({ orientation }) */
     mushroomOrientation(v: 'horizontal' | 'vertical'): this
 
+    /** @deprecated Use mushroomSettings({ sizeScaleFunction }) */
     mushroomSizeScaleFunction(): any
+    /** @deprecated Use mushroomSettings({ sizeScaleFunction }) */
     mushroomSizeScaleFunction(v: any): this
 
+    /** @deprecated Use mushroomSettings({ sizeScaleFunctionV1 }) */
     mushroomSizeScaleFunctionV1(): any
+    /** @deprecated Use mushroomSettings({ sizeScaleFunctionV1 }) */
     mushroomSizeScaleFunctionV1(v: any): this
 
+    /** @deprecated Use mushroomSettings({ sizeScaleFunctionV2 }) */
     mushroomSizeScaleFunctionV2(): any
+    /** @deprecated Use mushroomSettings({ sizeScaleFunctionV2 }) */
     mushroomSizeScaleFunctionV2(v: any): this
 }

package/build/types/map-types/proportional-symbol/mushroom/MushroomMapConfig.d.ts

@@ -4,17 +4,36 @@ import type { MapConfig } from '../../../core/MapConfig'
  * Configuration for mushroom maps.
  */
 export interface MushroomMapConfig extends MapConfig {
+    /** Grouped mushroom settings. */
+    mushroomSettings?: {
+        codes?: [string, string]
+        minSize?: number
+        maxSize?: number
+        colors?: [string, string]
+        orientation?: 'horizontal' | 'vertical'
+        sizeScaleFunction?: (value: number) => number
+        sizeScaleFunctionV1?: (value: number) => number
+        sizeScaleFunctionV2?: (value: number) => number
+    }
+    /** @deprecated Use mushroomSettings.codes */
     /** Mushroom codes. */
     mushroomCodes?: [string, string]
+    /** @deprecated Use mushroomSettings.minSize */
     /** Mushroom min size. */
     mushroomMinSize?: number
+    /** @deprecated Use mushroomSettings.maxSize */
     /** Mushroom max size. */
     mushroomMaxSize?: number
+    /** @deprecated Use mushroomSettings.colors */
     /** Mushroom colors. */
     mushroomColors?: [string, string]
+    /** @deprecated Use mushroomSettings.orientation */
     /** Mushroom orientation. */
     mushroomOrientation?: 'horizontal' | 'vertical'
+    /** @deprecated Use mushroomSettings.sizeScaleFunction */
     mushroomSizeScaleFunction?: (value: number) => number
+    /** @deprecated Use mushroomSettings.sizeScaleFunctionV1 */
     mushroomSizeScaleFunctionV1?: (value: number) => number
+    /** @deprecated Use mushroomSettings.sizeScaleFunctionV2 */
     mushroomSizeScaleFunctionV2?: (value: number) => number
 }

package/build/types/map-types/spark/SparkMap.d.ts

@@ -1,11 +1,15 @@
 import type { MapInstance } from '../../core/MapInstance'
 import type { SparkStatConfig } from './SparkStatConfig'
 import type { SparklineLegendConfig } from '../../legend/composition/SparklineLegendConfig'
+import type { SparkSettings } from './SparkMapConfig'
 
 /**
  * Spark map type.
  */
 export interface SparkMap extends MapInstance {
+    sparkSettings(): SparkSettings
+    sparkSettings(v: SparkSettings): this
+
     legend(): SparklineLegendConfig | false
     legend(config: SparklineLegendConfig | false): this
 

package/build/types/map-types/spark/SparkMapConfig.d.ts

@@ -1,12 +1,44 @@
 import type { MapConfig } from '../../core/MapConfig'
 import type { SparklineLegendConfig } from '../../legend/composition/SparklineLegendConfig'
 
+export interface SparkSettings {
+    type?: 'line' | 'area' | 'bar'
+    lineOffsets?: { x: number; y: number }
+    lineWidth?: number
+    lineHeight?: number
+    lineStrokeWidth?: number
+    lineOpacity?: number
+    lineColor?: string | ((value: number, index: number, data: any[]) => string)
+    areaColor?: string | ((value: number, index: number, data: any[]) => string)
+    lineCircleRadius?: number
+    tooltipChart?: {
+        width: number
+        height: number
+        margin: { left: number; right: number; top: number; bottom: number }
+        circleRadius: number
+    }
+    lineChartFunction?: (node: any, data: any[], width: number, height: number, isForTooltip?: boolean) => void
+}
+
 /**
  * Configuration for sparkline maps.
  */
 export interface SparkMapConfig extends MapConfig {
+    /** Grouped sparkline rendering settings. */
+    sparkSettings?: SparkSettings
+
     /** Spark type. */
     sparkType?: 'line' | 'area' | 'bar'
+
+    /** Object-form stat configuration for temporal sparkline datasets. */
+    dates?: string[]
+    labels?: string[]
+    eurostatDatasetCode?: string
+    customData?: Record<string, Record<string, number>>
+    filters?: Record<string, any>
+    unitText?: string
+    transform?: (value: any) => any
+
     sparkLineColor?: string | ((value: number, index: number, data: any[]) => string)
     sparkAreaColor?: string | ((value: number, index: number, data: any[]) => string)
     /** Spark line width. */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "eurostat-map",
-    "version": "4.4.4",
+    "version": "4.5.0",
     "description": "Reusable library to quickly create and customise web maps showing Eurostat data directly retrieved from Eurostat database.",
     "keywords": [
         "cartography",
@@ -38,9 +38,12 @@
         "build-prod-debug": "webpack --config webpack/webpack.config.debug-size.js",
         "format": "prettier --write .",
         "copy-types": "copyfiles -u 2 \"src/types/**/*.d.ts\" build/types",
-        "check:types:legend-config-sync": "node test/scripts/check-legend-config-sync.js",
-        "type-check": "npm run check:types:legend-config-sync && tsc --noEmit && tsc --noEmit test/typescript-test.ts",
+        "check:types:legend-config-sync": "node scripts/check-legend-config-sync.js",
+        "type-check": "npm run check:types:legend-config-sync && tsc --noEmit --skipLibCheck && tsc --noEmit --skipLibCheck test/typescript-test.ts",
+        "update-all": "npm run update-types && npm run update-docs && npm run update-examples",
+        "update-types": "node scripts/update-types.js",
         "update-docs": "typedoc --options typedoc.json",
+        "update-previews": "node examples/scripts/generate-previews.js",
         "update-examples": "npm run update-examples-manifest && npm run generate-previews",
         "update-examples-manifest": "node examples/scripts/update-examples-manifest.js",
         "generate-previews": "node examples/scripts/generate-previews.js"