Interface MetricUSStateMapProps

Hierarchy

  • Omit<USStateMapProps, "getRegionUrl" | "getTooltip">
    • MetricUSStateMapProps

Properties

getFillColor? getTooltip? highlightedRegion? metric regionDB showBorderingStates? showCounties? stateRegionId 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 getTooltip

getTooltip?: ((region: Region) => ReactNode)

Type declaration

    • (region: Region): ReactNode

    • Function that returns tooltip content for a given region.

      Returns

      Tooltip content for the region.

      Parameters

      • region: Region

        Region for which to get tooltip content.

      Returns ReactNode

Optional highlightedRegion

highlightedRegion?: Region

Region to highlight on the map by rendering the shape with an outline.

metric

metric: string | Metric

Metric represented by the map's coloring.

regionDB

regionDB: RegionDB

Region DB instance. Used for generating region links, coloring the map, etc.

Optional showBorderingStates

showBorderingStates?: boolean

Show the shapes of the bordering states.

Default

true

Optional showCounties

showCounties?: boolean

Show the county shapes.

Default

true

stateRegionId

stateRegionId: string

RegionId of the state being mapped.

Optional width

width?: number

Width of the SVG containing the map.

Settings

Member Visibility

Theme

Generated using TypeDoc