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

Reusable library to quickly create and customise web maps showing Eurostat data directly retrieved from Eurostat database.

import type { MapInstance } from '../../core/MapInstance'
import type { SparkStatConfig } from './SparkStatConfig'
import type { SparklineLegendConfig } from '../../legend/composition/SparklineLegendConfig'

/**
 * Spark map type.
 */
export interface SparkMap extends MapInstance {
    legend(): SparklineLegendConfig | false
    legend(config: SparklineLegendConfig | false): this

    sparkLineColor(): any
    sparkLineColor(v: any): this

    showOnlyWhenComplete(): boolean
    showOnlyWhenComplete(v: boolean): this

    sparkType(): 'line' | 'area' | 'bar'
    sparkType(v: 'line' | 'area' | 'bar'): this

    sparkLineWidth(): number
    sparkLineWidth(v: number): this

    sparkLineHeight(): number
    sparkLineHeight(v: number): this

    sparkLineStrokeWidth(): number
    sparkLineStrokeWidth(v: number): this

    sparkLineOpacity(): number
    sparkLineOpacity(v: number): this

    sparkLineCircleRadius(): number
    sparkLineCircleRadius(v: number): this

    sparkLineAreaColor(): any
    sparkLineAreaColor(v: any): this

    sparkTooltipChart(): any
    sparkTooltipChart(v: any): this

    sparkLineChartFunction(): any
    sparkLineChartFunction(v: any): this

    sparkLineOffsets(): { x: number; y: number }
    sparkLineOffsets(v: { x: number; y: number }): this

    /** Manually set sparkline data instead of fetching it from Eurostat. */
    sparklineData(dataObject: Record<string, Record<string, number>>): this
    /** Configure fetching data from Eurostat and generating spark lines. */
    statSpark(config: SparkStatConfig): this
}