Interface USStateMapProps

Hierarchy

  • BaseMapProps
    • USStateMapProps

Properties

getFillColor? getRegionUrl? getTooltip highlightedRegion? 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 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 highlightedRegion

highlightedRegion?: Region

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

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