@d3-maps/core / mapObject

mapObject

Table of contents

• Functions
  • getObjectStateUpdate()
  • resolveObjectStyle()
  • useMapObjectEvents()
• Variables
  • mapObjectState
• Interfaces
  • MapObjectInteractionController
  • MapObjectProps
• Type Aliases
  • ElementMapObjectMouseDownSource
  • MapObjectData
  • MapObjectEventType
  • MapObjectGlobalMouseupListener()
  • MapObjectGlobalMouseupSubscription()
  • MapObjectMouseDownSource
  • MapObjectState

Functions

getObjectStateUpdate()

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

Maps DOM event names to interaction state updates.

Parameters

Parameter	Type
event	MapObjectEventType

Returns

"default" | "hover" | "active" | "focus"

---

resolveObjectStyle()

function resolveObjectStyle<TStyle>(state: "default" | "hover" | "active" | "focus", styles?: Partial<Record<"default" | "hover" | "active" | "focus", 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

---

useMapObjectEvents()

function useMapObjectEvents<TTarget>(onStateChange?: (state: "default" | "hover" | "active" | "focus") => void, recoverOnGlobalMouseup?: boolean): MapObjectInteractionController<TTarget>;

Type Parameters

Type Parameter	Default type
TTarget	unknown

Parameters

Parameter	Type	Default value
onStateChange?	(state: "default"	"hover"
recoverOnGlobalMouseup?	boolean	false

Returns

MapObjectInteractionController<TTarget>

Variables

mapObjectState

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

Supported interaction states for map objects.

Interfaces

MapObjectInteractionController

Type Parameters

Type Parameter	Default type
TTarget	unknown

Properties

Property	Type
dispose	() => void
onBlur	() => "default"
onFocus	() => "default"
onMousedown	(source?: MapObjectMouseDownSource<TTarget>) => "default"
onMouseenter	() => "default"
onMouseleave	() => "default"
onMouseup	() => "default"

---

MapObjectProps

Extended by

• MapAnnotationProps
• MapFeatureProps
• MapGraticuleProps
• MapLineProps
• MapMarkerProps

Type Parameters

Type Parameter	Default type
TStyle	unknown

Properties

Property	Type
styles?	Partial<Record<"default"

Type Aliases

ElementMapObjectMouseDownSource

type ElementMapObjectMouseDownSource = 
  | Element
  | {
  currentTarget: EventTarget | null;
}
  | null
  | undefined;

---

MapObjectData

type MapObjectData = GeoGeometryObjects | ExtendedFeature;

---

MapObjectEventType

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

---

MapObjectGlobalMouseupListener()

type MapObjectGlobalMouseupListener = () => void;

Returns

void

---

MapObjectGlobalMouseupSubscription()

type MapObjectGlobalMouseupSubscription = (listener: MapObjectGlobalMouseupListener) => () => void;

Parameters

Parameter	Type
listener	MapObjectGlobalMouseupListener

Returns

(): void;

Returns

void

---

MapObjectMouseDownSource

type MapObjectMouseDownSource<TTarget> = 
  | TTarget
  | ElementMapObjectMouseDownSource;

Type Parameters

Type Parameter	Default type
TTarget	unknown

---

MapObjectState

type MapObjectState = typeof mapObjectState[number];