User guide

The user guide covers different parts of basic usage of Folium. Each page focuses on a single topic and outlines how it is implemented in Folium, with reproducible examples.

If you don’t know anything about Folium, start with the Getting started.

Advanced topics can be found in the Advanced Guide and further specification in the API Reference.

• Map
  • Scale
  • Zoom control
  • Limits
• UI elements
  • LayerControl
  • Popups
  • Icons
• Raster layers
  • Tiles
  • ImageOverlay
  • VideoOverlay
  • WmsTileLayer
• Vector layers
  • Circle and CircleMarker
  • PolyLine
  • Rectangle
  • Polygon
  • ColorLine
• GeoJSON and choropleth
  • Using GeoJson
  • Using Choropleth
  • GeoJSON point features with markers
  • GeoJSON popup and tooltip
  • Using GeoPandas.GeoDataFrame in folium
  • Smoothing
• Features
  • FitOverlays
  • Click-related classes
• Plugins
  • BoatMarker
  • BeautifyIcon
  • Draw
  • DualMap plugin
  • FeatureGroupSubGroup
  • FloatImage
  • Fullscreen
  • Geocoder
  • GroupedLayerControl
  • Heatmap
  • HeatMapWithTime Plugin
  • LocateControl
  • MarkerCluster
  • MiniMap
  • MeasureControl
  • MousePosition
  • Pattern plugins
  • PolylineOffset
  • PolylineTextPath and AntPath
  • Realtime plugin
  • ScrollZoomToggler
  • Search
  • SemiCircle
  • SideBySideLayers
  • TagFilterButton
  • Terminator
  • TimeSliderChoropleth
  • TimestampedGeoJson
  • Vector tiles using VectorGridProtobuf
  • TimestampedWmsTileLayers