eurostat-map 4.4.5 → 4.6.0

package/build/types/layers/composition/stripe/StripeMap.d.ts

@@ -0,0 +1,80 @@
+import type { MapInstance } from '../../../core/MapInstance'
+import type { CompositionStatConfig } from '../CompositionStatConfig'
+import type { StripeCompositionLegendConfig } from '../../../legend/composition/StripeCompositionLegendConfig'
+
+/**
+ * Stripe map type.
+ */
+export interface StripeMap extends MapInstance {
+    legend(): StripeCompositionLegendConfig | false
+    legend(config: StripeCompositionLegendConfig | false): this
+
+    stripeSettings(): {
+        width: number
+        orientation: number
+        otherColor: string
+        otherText: string
+    }
+    stripeSettings(v: { width?: number; orientation?: number; otherColor?: string; otherText?: string }): this
+
+    /** @deprecated Use stripeSettings({ width }) */
+    stripeWidth(): number
+    /** @deprecated Use stripeSettings({ width }) */
+    stripeWidth(v: number): this
+
+    /** @deprecated Use stripeSettings({ orientation }) */
+    stripeOrientation(): number
+    /** @deprecated Use stripeSettings({ orientation }) */
+    stripeOrientation(v: number): this
+
+    catColors(): any
+    catColors(v: any): this
+
+    catLabels(): any
+    catLabels(v: any): this
+
+    /** @deprecated Use stripeSettings({ otherColor }) */
+    stripeOtherColor(): string
+    /** @deprecated Use stripeSettings({ otherColor }) */
+    stripeOtherColor(v: string): this
+
+    /** @deprecated Use stripeSettings({ otherText }) */
+    stripeOtherText(): string
+    /** @deprecated Use stripeSettings({ otherText }) */
+    stripeOtherText(v: string): this
+
+    showOnlyWhenComplete(): boolean
+    showOnlyWhenComplete(v: boolean): this
+
+    noDataFillStyle(): string
+    noDataFillStyle(v: string): this
+
+    pieChartRadius(): number
+    pieChartRadius(v: number): this
+
+    pieChartInnerRadius(): number
+    pieChartInnerRadius(v: number): this
+
+    stripeTotalCode(): string | undefined
+    stripeTotalCode(v: string | undefined): this
+
+    statCodes(): string[] | undefined
+    statCodes(v: string[] | undefined): this
+
+    statStripe(config: CompositionStatConfig): this
+    /** @deprecated Legacy positional signature. Prefer statStripe({ categoryParameter, categoryCodes, ... }). */
+    statStripe(
+        /** Config. */
+        config: CompositionStatConfig,
+        /** Category parameter. */
+        categoryParameter?: string,
+        /** Category codes. */
+        categoryCodes?: string[],
+        /** Category labels. */
+        categoryLabels?: string[],
+        /** Category colors. */
+        categoryColors?: string[],
+        /** Total code. */
+        totalCode?: string
+    ): this
+}

package/build/types/layers/composition/stripe/StripeMapConfig.d.ts

@@ -0,0 +1,45 @@
+import type { MapConfig } from '../../../core/MapConfig'
+import type { StripeCompositionLegendConfig } from '../../../legend/composition/StripeCompositionLegendConfig'
+
+/**
+ * Configuration for stripe composition maps.
+ */
+export interface StripeMapConfig extends MapConfig {
+    /** Grouped stripe settings. */
+    stripeSettings?: {
+        width?: number
+        orientation?: number
+        otherColor?: string
+        otherText?: string
+    }
+    /** @deprecated Use stripeSettings.width */
+    /** Stripe width. */
+    stripeWidth?: number
+    /** @deprecated Use stripeSettings.orientation */
+    /** Stripe orientation. */
+    stripeOrientation?: number
+    /** Cat colors. */
+    catColors?: Record<string, string>
+    /** Cat labels. */
+    catLabels?: Record<string, string>
+    /** @deprecated Use stripeSettings.otherColor */
+    /** Stripe other color. */
+    stripeOtherColor?: string
+    /** @deprecated Use stripeSettings.otherText */
+    /** Stripe other text. */
+    stripeOtherText?: string
+    /** Show only when complete. */
+    showOnlyWhenComplete?: boolean
+    /** No data fill style. */
+    noDataFillStyle?: string
+    /** Pie chart radius. */
+    pieChartRadius?: number
+    /** Pie chart inner radius. */
+    pieChartInnerRadius?: number
+    /** Stripe total code. */
+    stripeTotalCode?: string
+    /** Stat codes. */
+    statCodes?: string[]
+    /** Legend. */
+    legend?: StripeCompositionLegendConfig | false
+}

package/build/types/layers/composition/waffle/WaffleMap.d.ts

@@ -0,0 +1,124 @@
+import type { MapInstance } from '../../../core/MapInstance'
+import type { CompositionStatConfig } from '../CompositionStatConfig'
+import type { WaffleLegendConfig } from '../../../legend/composition/WaffleLegendConfig'
+
+/**
+ * Waffle map type.
+ */
+export interface WaffleMap extends MapInstance {
+    legend(): WaffleLegendConfig | false
+    legend(config: WaffleLegendConfig | false): this
+
+    catColors(): any
+    catColors(v: any): this
+
+    catLabels(): any
+    catLabels(v: any): this
+
+    showOnlyWhenComplete(): boolean
+    showOnlyWhenComplete(v: boolean): this
+
+    noDataFillStyle(): string
+    noDataFillStyle(v: string): this
+
+    waffleSettings(): {
+        minSize?: number
+        maxSize?: number
+        gridSize?: number
+        cellPadding?: number
+        strokeFill?: string
+        strokeWidth?: number
+        roundedCorners?: number
+        tooltipSize?: number
+        otherColor?: string
+        otherText?: string
+    }
+    waffleSettings(v: {
+        minSize?: number
+        maxSize?: number
+        gridSize?: number
+        cellPadding?: number
+        strokeFill?: string
+        strokeWidth?: number
+        roundedCorners?: number
+        tooltipSize?: number
+        otherColor?: string
+        otherText?: string
+    }): this
+
+    /** @deprecated Use waffleSettings({ maxSize }) */
+    waffleMaxSize(): number
+    /** @deprecated Use waffleSettings({ maxSize }) */
+    waffleMaxSize(v: number): this
+
+    /** @deprecated Use waffleSettings({ minSize }) */
+    waffleMinSize(): number
+    /** @deprecated Use waffleSettings({ minSize }) */
+    waffleMinSize(v: number): this
+
+    /** @deprecated Use waffleSettings({ gridSize }) */
+    waffleGridSize(): number
+    /** @deprecated Use waffleSettings({ gridSize }) */
+    waffleGridSize(v: number): this
+
+    /** @deprecated Use waffleSettings({ cellPadding }) */
+    waffleCellPadding(): number
+    /** @deprecated Use waffleSettings({ cellPadding }) */
+    waffleCellPadding(v: number): this
+
+    /** @deprecated Use waffleSettings({ otherColor }) */
+    waffleOtherColor(): string
+    /** @deprecated Use waffleSettings({ otherColor }) */
+    waffleOtherColor(v: string): this
+
+    /** @deprecated Use waffleSettings({ otherText }) */
+    waffleOtherText(): string
+    /** @deprecated Use waffleSettings({ otherText }) */
+    waffleOtherText(v: string): this
+
+    /** @deprecated Use waffleSettings({ strokeFill }) */
+    waffleStrokeFill(): string
+    /** @deprecated Use waffleSettings({ strokeFill }) */
+    waffleStrokeFill(v: string): this
+
+    /** @deprecated Use waffleSettings({ strokeWidth }) */
+    waffleStrokeWidth(): number
+    /** @deprecated Use waffleSettings({ strokeWidth }) */
+    waffleStrokeWidth(v: number): this
+
+    /** @deprecated Use waffleSettings({ roundedCorners }) */
+    waffleRoundedCorners(): number
+    /** @deprecated Use waffleSettings({ roundedCorners }) */
+    waffleRoundedCorners(v: number): this
+
+    /** @deprecated Use waffleSettings({ tooltipSize }) */
+    waffleTooltipSize(): number
+    /** @deprecated Use waffleSettings({ tooltipSize }) */
+    waffleTooltipSize(v: number): this
+
+    dorling(): boolean
+    dorling(v: boolean): this
+
+    waffleTotalCode(): string | undefined
+    waffleTotalCode(v: string | undefined): this
+
+    statCodes(): string[] | undefined
+    statCodes(v: string[] | undefined): this
+
+    statWaffle(config: CompositionStatConfig): this
+    /** @deprecated Legacy positional signature. Prefer statWaffle({ categoryParameter, categoryCodes, ... }). */
+    statWaffle(
+        /** Config. */
+        config: CompositionStatConfig,
+        /** Category parameter. */
+        categoryParameter?: string,
+        /** Category codes. */
+        categoryCodes?: string[],
+        /** Category labels. */
+        categoryLabels?: string[],
+        /** Category colors. */
+        categoryColors?: string[],
+        /** Total code. */
+        totalCode?: string
+    ): this
+}

package/build/types/layers/composition/waffle/WaffleMapConfig.d.ts

@@ -0,0 +1,58 @@
+import type { MapConfig } from '../../../core/MapConfig'
+import type { WaffleLegendConfig } from '../../../legend/composition/WaffleLegendConfig'
+
+/**
+ * Configuration for waffle chart composition maps.
+ */
+export interface WaffleMapConfig extends MapConfig {
+    /** Consolidated waffle chart settings. */
+    waffleSettings?: {
+        minSize?: number
+        maxSize?: number
+        gridSize?: number
+        cellPadding?: number
+        strokeFill?: string
+        strokeWidth?: number
+        roundedCorners?: number
+        tooltipSize?: number
+        otherColor?: string
+        otherText?: string
+    }
+
+    /** @deprecated Use waffleSettings.minSize */
+    waffleMinSize?: number
+    /** @deprecated Use waffleSettings.maxSize */
+    waffleMaxSize?: number
+    /** @deprecated Use waffleSettings.gridSize */
+    waffleGridSize?: number
+    /** @deprecated Use waffleSettings.cellPadding */
+    waffleCellPadding?: number
+    /** @deprecated Use waffleSettings.strokeFill */
+    waffleStrokeFill?: string
+    /** @deprecated Use waffleSettings.strokeWidth */
+    waffleStrokeWidth?: number
+    /** @deprecated Use waffleSettings.roundedCorners */
+    waffleRoundedCorners?: number
+    /** @deprecated Use waffleSettings.tooltipSize */
+    waffleTooltipSize?: number
+    /** Cat colors. */
+    catColors?: Record<string, string>
+    /** Cat labels. */
+    catLabels?: Record<string, string>
+    /** @deprecated Use waffleSettings.otherColor */
+    waffleOtherColor?: string
+    /** @deprecated Use waffleSettings.otherText */
+    waffleOtherText?: string
+    /** Show only when complete. */
+    showOnlyWhenComplete?: boolean
+    /** No data fill style. */
+    noDataFillStyle?: string
+    /** Dorling. */
+    dorling?: boolean
+    /** Waffle total code. */
+    waffleTotalCode?: string
+    /** Stat codes. */
+    statCodes?: string[]
+    /** Legend. */
+    legend?: WaffleLegendConfig | false
+}

package/build/types/layers/flow/FlowMap.d.ts

@@ -0,0 +1,218 @@
+import type { MapInstance } from '../../core/MapInstance'
+import type { FlowGraph, FlowCurvatureSettings, FlowWidthGradientSettings, FlowBundleSettings } from './FlowMapConfig'
+
+/**
+ * Flow map type.
+ */
+export interface FlowMap extends MapInstance {
+    flowGraph(): FlowGraph
+    flowGraph(v: FlowGraph): this
+
+    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: any
+        opacity: number
+        internal: boolean
+        topLocations: number
+        topLocationsType: 'sum' | 'origin' | 'destination'
+        curvatureSettings: FlowCurvatureSettings
+        order: any
+        widthGradient: boolean
+        opacityGradient: boolean
+        widthGradientSettings: FlowWidthGradientSettings
+        bidirectional: boolean
+        edgeBundling: boolean
+        bundleSettings: FlowBundleSettings
+    }
+    flowSettings(v: {
+        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?: any
+        opacity?: number
+        internal?: boolean
+        topLocations?: number
+        topLocationsType?: 'sum' | 'origin' | 'destination'
+        curvatureSettings?: FlowCurvatureSettings
+        order?: any
+        widthGradient?: boolean
+        opacityGradient?: boolean
+        widthGradientSettings?: FlowWidthGradientSettings
+        bidirectional?: boolean
+        edgeBundling?: boolean
+        bundleSettings?: FlowBundleSettings
+    }): this
+
+    /** @deprecated Use flowSettings({ color }) */
+    flowColor(): string
+    /** @deprecated Use flowSettings({ color }) */
+    flowColor(v: string): this
+
+    /** @deprecated Use flowSettings({ regionColors }) */
+    flowRegionColors(): string[]
+    /** @deprecated Use flowSettings({ regionColors }) */
+    flowRegionColors(v: string[]): this
+
+    /** @deprecated Use flowSettings({ regionLabels }) */
+    flowRegionLabels(): string[]
+    /** @deprecated Use flowSettings({ regionLabels }) */
+    flowRegionLabels(v: string[]): this
+
+    /** @deprecated Use flowSettings({ arrows }) */
+    flowArrows(): boolean
+    /** @deprecated Use flowSettings({ arrows }) */
+    flowArrows(v: boolean): this
+
+    /** @deprecated Use flowSettings({ arrowScale }) */
+    flowArrowScale(): number
+    /** @deprecated Use flowSettings({ arrowScale }) */
+    flowArrowScale(v: number): this
+
+    /** @deprecated Use flowSettings({ maxWidth }) */
+    flowMaxWidth(): number
+    /** @deprecated Use flowSettings({ maxWidth }) */
+    flowMaxWidth(v: number): this
+
+    /** @deprecated Use flowSettings({ minWidth }) */
+    flowMinWidth(): number
+    /** @deprecated Use flowSettings({ minWidth }) */
+    flowMinWidth(v: number): this
+
+    /** @deprecated Use flowSettings({ outlines }) */
+    flowOutlines(): boolean
+    /** @deprecated Use flowSettings({ outlines }) */
+    flowOutlines(v: boolean): this
+
+    /** @deprecated Use flowSettings({ outlineWidth }) */
+    flowOutlineWidth(): number
+    /** @deprecated Use flowSettings({ outlineWidth }) */
+    flowOutlineWidth(v: number): this
+
+    /** @deprecated Use flowSettings({ outlineColor }) */
+    flowOutlineColor(): string
+    /** @deprecated Use flowSettings({ outlineColor }) */
+    flowOutlineColor(v: string): this
+
+    /** @deprecated Use flowSettings({ colorGradient }) */
+    flowColorGradient(): boolean
+    /** @deprecated Use flowSettings({ colorGradient }) */
+    flowColorGradient(v: boolean): this
+
+    /** @deprecated Use flowSettings({ stack }) */
+    flowStack(): boolean
+    /** @deprecated Use flowSettings({ stack }) */
+    flowStack(v: boolean): this
+
+    /** @deprecated Use flowSettings({ nodes }) */
+    flowNodes(): boolean
+    /** @deprecated Use flowSettings({ nodes }) */
+    flowNodes(v: boolean): this
+
+    /** @deprecated Use flowSettings({ nodeType }) */
+    flowNodeType(): 'circle' | 'donut'
+    /** @deprecated Use flowSettings({ nodeType }) */
+    flowNodeType(v: 'circle' | 'donut'): this
+
+    /** @deprecated Use flowSettings({ labelOffsets }) */
+    flowLabelOffsets(): { x: number; y: number }
+    /** @deprecated Use flowSettings({ labelOffsets }) */
+    flowLabelOffsets(v: { x: number; y: number }): this
+
+    /** @deprecated Use flowSettings({ lineType }) */
+    flowLineType(): 'curved' | 'straight' | 'sankey'
+    /** @deprecated Use flowSettings({ lineType }) */
+    flowLineType(v: 'curved' | 'straight' | 'sankey'): this
+
+    /** @deprecated Use flowSettings({ nodeSizeScale }) */
+    flowNodeSizeScale(): any
+    /** @deprecated Use flowSettings({ nodeSizeScale }) */
+    flowNodeSizeScale(v: any): this
+
+    /** @deprecated Use flowSettings({ opacity }) */
+    flowOpacity(): number
+    /** @deprecated Use flowSettings({ opacity }) */
+    flowOpacity(v: number): this
+
+    /** @deprecated Use flowSettings({ internal }) */
+    flowInternal(): boolean
+    /** @deprecated Use flowSettings({ internal }) */
+    flowInternal(v: boolean): this
+
+    /** @deprecated Use flowSettings({ topLocations }) */
+    flowTopLocations(): number
+    /** @deprecated Use flowSettings({ topLocations }) */
+    flowTopLocations(v: number): this
+
+    /** @deprecated Use flowSettings({ topLocationsType }) */
+    flowTopLocationsType(): 'sum' | 'origin' | 'destination'
+    /** @deprecated Use flowSettings({ topLocationsType }) */
+    flowTopLocationsType(v: 'sum' | 'origin' | 'destination'): this
+
+    /** @deprecated Use flowSettings({ curvatureSettings }) */
+    flowCurvatureSettings(): FlowCurvatureSettings
+    /** @deprecated Use flowSettings({ curvatureSettings }) */
+    flowCurvatureSettings(v: FlowCurvatureSettings): this
+
+    /** @deprecated Use flowSettings({ order }) */
+    flowOrder(): any
+    /** @deprecated Use flowSettings({ order }) */
+    flowOrder(v: any): this
+
+    /** @deprecated Use flowSettings({ widthGradient }) */
+    flowWidthGradient(): boolean
+    /** @deprecated Use flowSettings({ widthGradient }) */
+    flowWidthGradient(v: boolean): this
+
+    /** @deprecated Use flowSettings({ opacityGradient }) */
+    flowOpacityGradient(): boolean
+    /** @deprecated Use flowSettings({ opacityGradient }) */
+    flowOpacityGradient(v: boolean): this
+
+    /** @deprecated Use flowSettings({ widthGradientSettings }) */
+    flowWidthGradientSettings(): FlowWidthGradientSettings
+    /** @deprecated Use flowSettings({ widthGradientSettings }) */
+    flowWidthGradientSettings(v: FlowWidthGradientSettings): this
+
+    /** @deprecated Use flowSettings({ bidirectional }) */
+    flowBidirectional(): boolean
+    /** @deprecated Use flowSettings({ bidirectional }) */
+    flowBidirectional(v: boolean): this
+
+    /** @deprecated Use flowSettings({ edgeBundling }) */
+    flowEdgeBundling(): boolean
+    /** @deprecated Use flowSettings({ edgeBundling }) */
+    flowEdgeBundling(v: boolean): this
+
+    /** @deprecated Use flowSettings({ bundleSettings }) */
+    flowBundleSettings(): FlowBundleSettings
+    /** @deprecated Use flowSettings({ bundleSettings }) */
+    flowBundleSettings(v: FlowBundleSettings): this
+}