@d3-maps/core / mapObject

mapObject

Table of contents

• Functions
  • getObjectStateUpdate()
  • resolveObjectStyle()
• Variables
  • mapObjectState
• Type Aliases
  • MapObject
  • MapObjectEventType
  • MapObjectState
  • MapObjectStyles

Functions

getObjectStateUpdate()

function getObjectStateUpdate(event: MapObjectEventType): "default" | "hover" | "active";

Maps DOM event names to interaction state updates.

Parameters

Parameter	Type
event	MapObjectEventType

Returns

"default" | "hover" | "active"

---

resolveObjectStyle()

function resolveObjectStyle<TStyle>(state: "default" | "hover" | "active", styles?: Partial<Record<"default" | "hover" | "active", TStyle>>): TStyle | undefined;

Resolves a style value for the current state (falls back to default).

Type Parameters

Type Parameter
TStyle

Parameters

Parameter	Type
state	"default"
styles?	Partial<Record<"default"

Returns

TStyle | undefined

Variables

mapObjectState

const mapObjectState: readonly ["default", "hover", "active"];

Supported interaction states for map objects.

Type Aliases

MapObject

type MapObject = GeoGeometryObjects | ExtendedFeature;

---

MapObjectEventType

type MapObjectEventType = "mouseenter" | "mouseleave" | "mousedown" | "mouseup";

---

MapObjectState

type MapObjectState = typeof mapObjectState[number];

---

MapObjectStyles

type MapObjectStyles<TStyle> = Partial<Record<MapObjectState, TStyle>>;

Type Parameters

Type Parameter
TStyle