Interface WorldMapProps

Hierarchy

BaseMapProps
- WorldMapProps

Index

Properties

getFillColor? getFillOpacity? getRegionUrl? getTooltip width?

Properties

`Optional` getFillColor

getFillColor?: ((regionId: string) => string)

Type declaration

- (regionId: string): string
- Function that returns the fill color for a region's shape, given the region's regionId.
  
  Returns
  Fill color for the region.
  Parameters
  - regionId: string
    
    RegionId of the region for which to get the fill color.
  Returns string

`Optional` getFillOpacity

getFillOpacity?: ((geoId: string) => number)

Type declaration

- (geoId: string): number
- Function that returns the fill opacity for a region's shape, given the region's geoId.
  
  Default
  1
  
  Returns
  Fill opacity for the region.
  Parameters
  - geoId: string
    
    GeoId of the region for which to get the fill opacity.
  Returns number

`Optional` getRegionUrl

getRegionUrl?: ((regionId: string) => undefined | string)

Type declaration

- (regionId: string): undefined | string
- Function that returns the regionUrl for the region corresponding to a given regionId.
  
  Default
  undefined
  
  Returns
  Region URL for the region.
  Parameters
  - regionId: string
    
    RegionId of the region for which to get the regionUrl.
  Returns undefined | string

getTooltip

getTooltip: ((regionId: string) => ReactNode)

Type declaration

- (regionId: string): ReactNode
- Function that returns tooltip content for the region corresponding to a given regionId.
  
  Returns
  Tooltip content for the region.
  Parameters
  - regionId: string
    
    RegionId of the region for which to get tooltip content.
  Returns ReactNode

`Optional` width

width?: number

Width of the SVG containing the map.

Generated using TypeDoc