MapProps
Represents the props of the KendoReact Map component.
Definition
Package:@progress/kendo-react-map
Properties
The map center. Coordinates are listed as [Latitude, Longitude].
className?
string
Sets additional CSS classes to the component.
The configuration of built-in map controls.
dir?
string
Represents the dir HTML attribute.
maxZoom?
number
The maximum zoom level. Typical web maps use zoom levels from 0 (whole world) to 19 (sub-meter features).
19
minSize?
number
The size of the map in pixels at zoom level 0.
256
minZoom?
number
The minimum zoom level. Typical web maps use zoom levels from 0 (whole world) to 19 (sub-meter features).
1
onBeforeReset?
(event: BeforeResetEvent) => void
Fires immediately before the map is reset. This event is typically used for cleanup by layer implementers.
onMapClick?
(event: MapClickEvent) => void
Fires when the user clicks on the map.
onMarkerActivate?
(event: MarkerActivateEvent) => void
Fires when a marker has been displayed and has a DOM element assigned.
onMarkerClick?
(event: MarkerClickEvent) => void
Fires when a marker has been clicked or tapped.
onMarkerCreated?
(event: MarkerCreatedEvent) => void
Fires when a marker has been created and is about to be displayed.
Cancelling the event prevents the marker from being shown.
onPanEnd?
(event: PanEndEvent) => void
Fires after the map viewport has been moved.
onRefresh?
(mapOptions: any, mapInstance: any) => void
Fires when the Map is about to refresh. You can use the event to prevent the refresh of the Map in specific cases.
onReset?
(event: ResetEvent) => void
Fires when the map is reset.
This typically occurs on initial load and after a zoom/center change.
onShapeClick?
(event: ShapeClickEvent) => void
Fires when a shape is clicked or tapped.
onShapeCreated?
(event: ShapeCreatedEvent) => void
Fires when a shape is created, but is not rendered yet.
onShapeFeatureCreated?
(event: ShapeFeatureCreatedEvent) => void
Fires when a GeoJSON Feature is created on a shape layer.
onShapeMouseEnter?
(event: ShapeMouseEnterEvent) => void
Fires when the mouse enters a shape.
This event fires reliably only for shapes that have set fill color. The opacity can still be set to 0 so the shapes appear to have no fill.
onShapeMouseLeave?
(event: ShapeMouseLeaveEvent) => void
Fires when the mouse leaves a shape.
This event fires reliably only for shapes that have set fill color. The opacity can still be set to 0 so the shapes appear to have no fill.
onZoomEnd?
(event: ZoomEndEvent) => void
Fires when the map zoom level has changed.
onZoomStart?
(event: ZoomStartEvent) => void
Fires when the map zoom level is about to change.
Cancelling the event prevents the user action.
pannable?
boolean
Controls whether the user can pan the map.
true
style?
CSSProperties
The styles that are applied to the component.
webMcp?
boolean | WebMcpProps
Enables Web MCP tool registration for this component.
Requires a parent WebMcpProvider from @progress/kendo-react-webmcp.
wraparound?
boolean
Specifies whether the map should wrap around the east-west edges.
true
zoom?
number
The initial zoom level.
Typical web maps use zoom levels from 0 (whole world) to 19 (sub-meter features). The map size is derived from the zoom level and minScale options: size = (2 ^ zoom) * minSize
Map zoom rounds floating point numbers. This is done so as the majority of web maps use the whole zoom levels 0 through to 19.
3
zoomable?
boolean
Controls whether the map zoom level can be changed by the user.
true