Function map

Main factory function to create maps

Returns MapInstance

A map object with builder pattern methods

Example

import eurostatmap from 'eurostatmap';

const map = eurostatmap.map('choropleth', {
  title: 'Population Density',
  stat: { eurostatDatasetCode: 'demo_r_d3dens' }
});
map.build();

map(type: "choropleth" | "ch", config?: ChoroplethConfig): ChoroplethMap
Main factory function to create maps
Parameters
- type: "choropleth" | "ch"
  The type of map to create
- Optionalconfig: ChoroplethConfig
  Configuration object
Returns ChoroplethMap
A map object with builder pattern methods
Example
```
import eurostatmap from 'eurostatmap';

const map = eurostatmap.map('choropleth', {
  title: 'Population Density',
  stat: { eurostatDatasetCode: 'demo_r_d3dens' }
});
map.build();
```
- Defined in src/types/index.d.ts:208
map(
type: "ps" | "proportionalSymbol" | "proportionalSymbols",
config?: ProportionalSymbolConfig,
): ProportionalSymbolMap
Main factory function to create maps
Parameters
- type: "ps" | "proportionalSymbol" | "proportionalSymbols"
  The type of map to create
- Optionalconfig: ProportionalSymbolConfig
  Configuration object
Returns ProportionalSymbolMap
A map object with builder pattern methods
Example
```
import eurostatmap from 'eurostatmap';

const map = eurostatmap.map('choropleth', {
  title: 'Population Density',
  stat: { eurostatDatasetCode: 'demo_r_d3dens' }
});
map.build();
```
- Defined in src/types/index.d.ts:209
map(type: "categorical" | "ct", config?: CategoricalMapConfig): CategoricalMap
Main factory function to create maps
Parameters
- type: "categorical" | "ct"
  The type of map to create
- Optionalconfig: CategoricalMapConfig
  Configuration object
Returns CategoricalMap
A map object with builder pattern methods
Example
```
import eurostatmap from 'eurostatmap';

const map = eurostatmap.map('choropleth', {
  title: 'Population Density',
  stat: { eurostatDatasetCode: 'demo_r_d3dens' }
});
map.build();
```
- Defined in src/types/index.d.ts:210
map(
type: "bivariateChoropleth" | "chbi",
config?: BivariateChoroplethConfig,
): BivariateChoroplethMap
Main factory function to create maps
Parameters
- type: "bivariateChoropleth" | "chbi"
  The type of map to create
- Optionalconfig: BivariateChoroplethConfig
  Configuration object
Returns BivariateChoroplethMap
A map object with builder pattern methods
Example
```
import eurostatmap from 'eurostatmap';

const map = eurostatmap.map('choropleth', {
  title: 'Population Density',
  stat: { eurostatDatasetCode: 'demo_r_d3dens' }
});
map.build();
```
- Defined in src/types/index.d.ts:211
map(
type: "trivariateChoropleth" | "ternary" | "chtri",
config?: TrivariateChoroplethConfig,
): TrivariateChoroplethMap
Main factory function to create maps
Parameters
- type: "trivariateChoropleth" | "ternary" | "chtri"
  The type of map to create
- Optionalconfig: TrivariateChoroplethConfig
  Configuration object
Returns TrivariateChoroplethMap
A map object with builder pattern methods
Example
```
import eurostatmap from 'eurostatmap';

const map = eurostatmap.map('choropleth', {
  title: 'Population Density',
  stat: { eurostatDatasetCode: 'demo_r_d3dens' }
});
map.build();
```
- Defined in src/types/index.d.ts:212
map(
type: "alpha" | "valueByAlpha",
config?: ValueByAlphaConfig,
): ValueByAlphaMap
Main factory function to create maps
Parameters
- type: "alpha" | "valueByAlpha"
  The type of map to create
- Optionalconfig: ValueByAlphaConfig
  Configuration object
Returns ValueByAlphaMap
A map object with builder pattern methods
Example
```
import eurostatmap from 'eurostatmap';

const map = eurostatmap.map('choropleth', {
  title: 'Population Density',
  stat: { eurostatDatasetCode: 'demo_r_d3dens' }
});
map.build();
```
- Defined in src/types/index.d.ts:213
map(type: "coxcomb" | "polar", config?: CoxcombMapConfig): CoxcombMap
Main factory function to create maps
Parameters
- type: "coxcomb" | "polar"
  The type of map to create
- Optionalconfig: CoxcombMapConfig
  Configuration object
Returns CoxcombMap
A map object with builder pattern methods
Example
```
import eurostatmap from 'eurostatmap';

const map = eurostatmap.map('choropleth', {
  title: 'Population Density',
  stat: { eurostatDatasetCode: 'demo_r_d3dens' }
});
map.build();
```
- Defined in src/types/index.d.ts:214
map(type: "bar" | "barComposition", config?: BarMapConfig): BarMap
Main factory function to create maps
Parameters
- type: "bar" | "barComposition"
  The type of map to create
- Optionalconfig: BarMapConfig
  Configuration object
Returns BarMap
A map object with builder pattern methods
Example
```
import eurostatmap from 'eurostatmap';

const map = eurostatmap.map('choropleth', {
  title: 'Population Density',
  stat: { eurostatDatasetCode: 'demo_r_d3dens' }
});
map.build();
```
- Defined in src/types/index.d.ts:215
map(
type: "stripeComposition" | "scomp" | "stripe",
config?: StripeMapConfig,
): StripeMap
Main factory function to create maps
Parameters
- type: "stripeComposition" | "scomp" | "stripe"
  The type of map to create
- Optionalconfig: StripeMapConfig
  Configuration object
Returns StripeMap
A map object with builder pattern methods
Example
```
import eurostatmap from 'eurostatmap';

const map = eurostatmap.map('choropleth', {
  title: 'Population Density',
  stat: { eurostatDatasetCode: 'demo_r_d3dens' }
});
map.build();
```
- Defined in src/types/index.d.ts:216
map(type: "waffle", config?: WaffleMapConfig): WaffleMap
Main factory function to create maps
Parameters
- type: "waffle"
  The type of map to create
- Optionalconfig: WaffleMapConfig
  Configuration object
Returns WaffleMap
A map object with builder pattern methods
Example
```
import eurostatmap from 'eurostatmap';

const map = eurostatmap.map('choropleth', {
  title: 'Population Density',
  stat: { eurostatDatasetCode: 'demo_r_d3dens' }
});
map.build();
```
- Defined in src/types/index.d.ts:217
map(type: "mushroom", config?: MushroomMapConfig): MushroomMap
Main factory function to create maps
Parameters
- type: "mushroom"
  The type of map to create
- Optionalconfig: MushroomMapConfig
  Configuration object
Returns MushroomMap
A map object with builder pattern methods
Example
```
import eurostatmap from 'eurostatmap';

const map = eurostatmap.map('choropleth', {
  title: 'Population Density',
  stat: { eurostatDatasetCode: 'demo_r_d3dens' }
});
map.build();
```
- Defined in src/types/index.d.ts:218
map(type: "composition" | "pieChart" | "pie", config?: PieMapConfig): PieMap
Main factory function to create maps
Parameters
- type: "composition" | "pieChart" | "pie"
  The type of map to create
- Optionalconfig: PieMapConfig
  Configuration object
Returns PieMap
A map object with builder pattern methods
Example
```
import eurostatmap from 'eurostatmap';

const map = eurostatmap.map('choropleth', {
  title: 'Population Density',
  stat: { eurostatDatasetCode: 'demo_r_d3dens' }
});
map.build();
```
- Defined in src/types/index.d.ts:219
map(
type: "sparkline" | "spark" | "sparklines",
config?: SparkMapConfig,
): SparkMap
Main factory function to create maps
Parameters
- type: "sparkline" | "spark" | "sparklines"
  The type of map to create
- Optionalconfig: SparkMapConfig
  Configuration object
Returns SparkMap
A map object with builder pattern methods
Example
```
import eurostatmap from 'eurostatmap';

const map = eurostatmap.map('choropleth', {
  title: 'Population Density',
  stat: { eurostatDatasetCode: 'demo_r_d3dens' }
});
map.build();
```
- Defined in src/types/index.d.ts:220
map(type: "flow" | "flowmap", config?: FlowMapConfig): FlowMap
Main factory function to create maps
Parameters
- type: "flow" | "flowmap"
  The type of map to create
- Optionalconfig: FlowMapConfig
  Configuration object
Returns FlowMap
A map object with builder pattern methods
Example
```
import eurostatmap from 'eurostatmap';

const map = eurostatmap.map('choropleth', {
  title: 'Population Density',
  stat: { eurostatDatasetCode: 'demo_r_d3dens' }
});
map.build();
```
- Defined in src/types/index.d.ts:221
map(type: MapType, config?: MapConfig): MapInstance
Main factory function to create maps
Parameters
- type: MapType
  The type of map to create
- Optionalconfig: MapConfig
  Configuration object
Returns MapInstance
A map object with builder pattern methods
Example
```
import eurostatmap from 'eurostatmap';

const map = eurostatmap.map('choropleth', {
  title: 'Population Density',
  stat: { eurostatDatasetCode: 'demo_r_d3dens' }
});
map.build();
```
- Defined in src/types/index.d.ts:222

Function map

Returns MapInstance

Example

Parameters

Returns ChoroplethMap

Example

Parameters

Returns ProportionalSymbolMap

Example

Parameters

Returns CategoricalMap

Example

Parameters

Returns BivariateChoroplethMap

Example

Parameters

Returns TrivariateChoroplethMap

Example

Parameters

Returns ValueByAlphaMap

Example

Parameters

Returns CoxcombMap

Example

Parameters

Returns BarMap

Example

Parameters

Returns StripeMap

Example

Parameters

Returns WaffleMap

Example

Parameters

Returns MushroomMap

Example

Parameters

Returns PieMap

Example

Parameters

Returns SparkMap

Example

Parameters

Returns FlowMap

Example

Parameters

Returns MapInstance

Example

Settings