Skip to main content

Interface: FlowmapSettings

Properties​

animationEnabled​

• Optional animationEnabled: boolean

Whether to use animation to show flow directions.

clusteringAuto​

• Optional clusteringAuto: boolean

Whether to automatically choose the clustering level depending on the map zoom level.

clusteringEnabled​

• Optional clusteringEnabled: boolean

Whether to cluster locations.

clusteringLevel​

• Optional clusteringLevel: number

Clustering level for manual clustering.

colorScheme​

• Optional colorScheme: string[] | "Default" | "Pl2" | "Pl3" | "Blues" | "BluGrn" | "BluYl" | "BrwnYl" | "BuGn" | "BuPu" | "Burg" | "BurgYl" | "Cool" | "DarkMint" | "Emrld" | "GnBu" | "Grayish" | "Greens" | "Greys" | "Inferno" | "Magenta" | "Magma" | "Mint" | "Oranges" | "OrRd" | "OrYel" | "Peach" | "Plasma" | "PinkYl" | "PuBu" | "PuBuGn" | "PuRd" | "Purp" | "Purples" | "PurpOr" | "RdPu" | "RedOr" | "Reds" | "Sunset" | "SunsetDark" | "Teal" | "TealGrn" | "Viridis" | "Warm" | "YlGn" | "YlGnBu" | "YlOrBr" | "YlOrRd"

Color scheme for flow map. Can be either one of the predefined ones or a list of hex colors.

darkMode​

• Optional darkMode: boolean

Whether to use dark mode for the base map and the flow map. The color scheme will be reversed if dark mode is enabled.

fadeAmount​

• Optional fadeAmount: number

The amount of fading out for flows with smaller magnitudes.

fadeEnabled​

• Optional fadeEnabled: boolean

Whether to fade out flows with smaller magnitudes.

fadeOpacityEnabled​

• Optional fadeOpacityEnabled: boolean

Whether to use opacity to fade out flows.

highlightColor​

• Optional highlightColor: string

Color for highlighted flows.

locationTotalsEnabled​

• Optional locationTotalsEnabled: boolean

Whether to show location totals.

locationsEnabled​

• Optional locationsEnabled: boolean

Whether to show locations.

maxTopFlowsDisplayNum​

• Optional maxTopFlowsDisplayNum: number

Maximum number of top flows to display at any time. If exceeded, only the flows with the top magnitudes will be displayed