Map image drill-down

A demo of amCharts 4, the previous version. For a new project, start from the amCharts 5 demos.

Map image drill-down is a typical scenario for widely used functionality such as "store locator" and alike.

This demo shows multiple aspects of complex map solution:

  • External data with post-processing.
  • Multiple map image series.
  • Event handling with API manipulations toggling series and controlling map zoom.
  • Heat rule functionality.

Click on any bubbles for drill-down effect.

Open in:

Code

JavaScript

// Themes begin
am4core.useTheme(am4themes_animated);
// Themes end

// Create map instance
var chart = am4core.create("chartdiv", am4maps.MapChart);
chart.maxZoomLevel = 64;

// Set map definition
chart.geodata = am4geodata_usaLow;

// Set projection
chart.projection = new am4maps.projections.AlbersUsa();

// Add button
var zoomOut = chart.tooltipContainer.createChild(am4core.ZoomOutButton);
zoomOut.align = "right";
zoomOut.valign = "top";
zoomOut.margin(20, 20, 20, 20);
zoomOut.events.on("hit", function() {
  if (currentSeries) {
    currentSeries.hide();
  }
  chart.goHome();
  zoomOut.hide();
  currentSeries = regionalSeries.US.series;
  currentSeries.show();
});
zoomOut.hide();


// Create map polygon series
var polygonSeries = chart.series.push(new am4maps.MapPolygonSeries());
polygonSeries.useGeodata = true;
polygonSeries.calculateVisualCenter = true;

// Configure series
var polygonTemplate = polygonSeries.mapPolygons.template;
polygonTemplate.tooltipText = "{name}";
polygonTemplate.fill = chart.colors.getIndex(0);

// Load data when map polygons are ready
chart.events.on("ready", loadStores);

// Loads store data
function loadStores() {
  var loader = new am4core.DataSource();
  loader.url = "https://s3-us-west-2.amazonaws.com/s.cdpn.io/t-160/TargetStores.json";
  loader.events.on("parseended", function(ev) {
    setupStores(ev.target.data);
  });
  loader.load();
}

// Creates a series
function createSeries(heatfield) {
  var series = chart.series.push(new am4maps.MapImageSeries());
  series.dataFields.value = heatfield;

  var template = series.mapImages.template;
  template.verticalCenter = "middle";
  template.horizontalCenter = "middle";
  template.propertyFields.latitude = "lat";
  template.propertyFields.longitude = "long";
  template.tooltipText = "{name}:\n[bold]{stores} stores[/]";

  var circle = template.createChild(am4core.Circle);
  circle.radius = 10;
  circle.fillOpacity = 0.7;
  circle.verticalCenter = "middle";
  circle.horizontalCenter = "middle";
  circle.nonScaling = true;

  var label = template.createChild(am4core.Label);
  label.text = "{stores}";
  label.fill = am4core.color("#fff");
  label.verticalCenter = "middle";
  label.horizontalCenter = "middle";
  label.nonScaling = true;

  var heat = series.heatRules.push({
    target: circle,
    property: "radius",
    min: 10,
    max: 30
  });

  // Set up drill-down
  series.mapImages.template.events.on("hit", function(ev) {

    // Determine what we've clicked on
    var data = ev.target.dataItem.dataContext;

    // No id? Individual store - nothing to drill down to further
    if (!data.target) {
      return;
    }

    // Create actual series if it hasn't been yet created
    if (!regionalSeries[data.target].series) {
      regionalSeries[data.target].series = createSeries("count");
      regionalSeries[data.target].series.data = data.markerData;
    }

    // Hide current series
    if (currentSeries) {
      currentSeries.hide();
    }

    // Control zoom
    if (data.type == "state") {
      var statePolygon = polygonSeries.getPolygonById("US-" + data.state);
      chart.zoomToMapObject(statePolygon);
    }
    else if (data.type == "city") {
      chart.zoomToGeoPoint({
        latitude: data.lat,
        longitude: data.long
      }, 64, true);
    }
    zoomOut.show();

    // Show new targert series
    currentSeries = regionalSeries[data.target].series;
    currentSeries.show();
  });

  return series;
}

var regionalSeries = {};
var currentSeries;

function setupStores(data) {

  // Init country-level series
  regionalSeries.US = {
    markerData: [],
    series: createSeries("stores")
  };

  // Set current series
  currentSeries = regionalSeries.US.series;

  // Process data
  am4core.array.each(data.query_results, function(store) {

    // Get store data
    var store = {
      state: store.MAIL_ST_PROV_C,
      long: am4core.type.toNumber(store.LNGTD_I),
      lat: am4core.type.toNumber(store.LATTD_I),
      location: store.co_loc_n,
      city: store.mail_city_n,
      count: am4core.type.toNumber(store.count)
    };

    // Process state-level data
    if (regionalSeries[store.state] == undefined) {
      var statePolygon = polygonSeries.getPolygonById("US-" + store.state);
      if (statePolygon) {

        // Add state data
        regionalSeries[store.state] = {
          target: store.state,
          type: "state",
          name: statePolygon.dataItem.dataContext.name,
          count: store.count,
          stores: 1,
          lat: statePolygon.visualLatitude,
          long: statePolygon.visualLongitude,
          state: store.state,
          markerData: []
        };
        regionalSeries.US.markerData.push(regionalSeries[store.state]);

      }
      else {
        // State not found
        return;
      }
    }
    else {
      regionalSeries[store.state].stores++;
      regionalSeries[store.state].count += store.count;
    }

    // Process city-level data
    if (regionalSeries[store.city] == undefined) {
      regionalSeries[store.city] = {
        target: store.city,
        type: "city",
        name: store.city,
        count: store.count,
        stores: 1,
        lat: store.lat,
        long: store.long,
        state: store.state,
        markerData: []
      };
      regionalSeries[store.state].markerData.push(regionalSeries[store.city]);
    }
    else {
      regionalSeries[store.city].stores++;
      regionalSeries[store.city].count += store.count;
    }

    // Process individual store
    regionalSeries[store.city].markerData.push({
      name: store.location,
      count: store.count,
      stores: 1,
      lat: store.lat,
      long: store.long,
      state: store.state
    });

  });

  regionalSeries.US.series.data = regionalSeries.US.markerData;
}

HTML

<div id="chartdiv"></div>

CSS

#chartdiv {
  width: 100%;
  height: 800px;
}

Resources

https://cdn.amcharts.com/lib/4/core.js
https://cdn.amcharts.com/lib/4/maps.js
https://cdn.amcharts.com/lib/4/geodata/usaLow.js
https://cdn.amcharts.com/lib/4/themes/animated.js

All in one page

<!-- Resources -->
<script src="https://cdn.amcharts.com/lib/4/core.js"></script>
<script src="https://cdn.amcharts.com/lib/4/maps.js"></script>
<script src="https://cdn.amcharts.com/lib/4/geodata/usaLow.js"></script>
<script src="https://cdn.amcharts.com/lib/4/themes/animated.js"></script>

<!-- Chart code -->
<script>
// Themes begin
am4core.useTheme(am4themes_animated);
// Themes end

// Create map instance
var chart = am4core.create("chartdiv", am4maps.MapChart);
chart.maxZoomLevel = 64;

// Set map definition
chart.geodata = am4geodata_usaLow;

// Set projection
chart.projection = new am4maps.projections.AlbersUsa();

// Add button
var zoomOut = chart.tooltipContainer.createChild(am4core.ZoomOutButton);
zoomOut.align = "right";
zoomOut.valign = "top";
zoomOut.margin(20, 20, 20, 20);
zoomOut.events.on("hit", function() {
  if (currentSeries) {
    currentSeries.hide();
  }
  chart.goHome();
  zoomOut.hide();
  currentSeries = regionalSeries.US.series;
  currentSeries.show();
});
zoomOut.hide();


// Create map polygon series
var polygonSeries = chart.series.push(new am4maps.MapPolygonSeries());
polygonSeries.useGeodata = true;
polygonSeries.calculateVisualCenter = true;

// Configure series
var polygonTemplate = polygonSeries.mapPolygons.template;
polygonTemplate.tooltipText = "{name}";
polygonTemplate.fill = chart.colors.getIndex(0);

// Load data when map polygons are ready
chart.events.on("ready", loadStores);

// Loads store data
function loadStores() {
  var loader = new am4core.DataSource();
  loader.url = "https://s3-us-west-2.amazonaws.com/s.cdpn.io/t-160/TargetStores.json";
  loader.events.on("parseended", function(ev) {
    setupStores(ev.target.data);
  });
  loader.load();
}

// Creates a series
function createSeries(heatfield) {
  var series = chart.series.push(new am4maps.MapImageSeries());
  series.dataFields.value = heatfield;

  var template = series.mapImages.template;
  template.verticalCenter = "middle";
  template.horizontalCenter = "middle";
  template.propertyFields.latitude = "lat";
  template.propertyFields.longitude = "long";
  template.tooltipText = "{name}:\n[bold]{stores} stores[/]";

  var circle = template.createChild(am4core.Circle);
  circle.radius = 10;
  circle.fillOpacity = 0.7;
  circle.verticalCenter = "middle";
  circle.horizontalCenter = "middle";
  circle.nonScaling = true;

  var label = template.createChild(am4core.Label);
  label.text = "{stores}";
  label.fill = am4core.color("#fff");
  label.verticalCenter = "middle";
  label.horizontalCenter = "middle";
  label.nonScaling = true;

  var heat = series.heatRules.push({
    target: circle,
    property: "radius",
    min: 10,
    max: 30
  });

  // Set up drill-down
  series.mapImages.template.events.on("hit", function(ev) {

    // Determine what we've clicked on
    var data = ev.target.dataItem.dataContext;

    // No id? Individual store - nothing to drill down to further
    if (!data.target) {
      return;
    }

    // Create actual series if it hasn't been yet created
    if (!regionalSeries[data.target].series) {
      regionalSeries[data.target].series = createSeries("count");
      regionalSeries[data.target].series.data = data.markerData;
    }

    // Hide current series
    if (currentSeries) {
      currentSeries.hide();
    }

    // Control zoom
    if (data.type == "state") {
      var statePolygon = polygonSeries.getPolygonById("US-" + data.state);
      chart.zoomToMapObject(statePolygon);
    }
    else if (data.type == "city") {
      chart.zoomToGeoPoint({
        latitude: data.lat,
        longitude: data.long
      }, 64, true);
    }
    zoomOut.show();

    // Show new targert series
    currentSeries = regionalSeries[data.target].series;
    currentSeries.show();
  });

  return series;
}

var regionalSeries = {};
var currentSeries;

function setupStores(data) {

  // Init country-level series
  regionalSeries.US = {
    markerData: [],
    series: createSeries("stores")
  };

  // Set current series
  currentSeries = regionalSeries.US.series;

  // Process data
  am4core.array.each(data.query_results, function(store) {

    // Get store data
    var store = {
      state: store.MAIL_ST_PROV_C,
      long: am4core.type.toNumber(store.LNGTD_I),
      lat: am4core.type.toNumber(store.LATTD_I),
      location: store.co_loc_n,
      city: store.mail_city_n,
      count: am4core.type.toNumber(store.count)
    };

    // Process state-level data
    if (regionalSeries[store.state] == undefined) {
      var statePolygon = polygonSeries.getPolygonById("US-" + store.state);
      if (statePolygon) {

        // Add state data
        regionalSeries[store.state] = {
          target: store.state,
          type: "state",
          name: statePolygon.dataItem.dataContext.name,
          count: store.count,
          stores: 1,
          lat: statePolygon.visualLatitude,
          long: statePolygon.visualLongitude,
          state: store.state,
          markerData: []
        };
        regionalSeries.US.markerData.push(regionalSeries[store.state]);

      }
      else {
        // State not found
        return;
      }
    }
    else {
      regionalSeries[store.state].stores++;
      regionalSeries[store.state].count += store.count;
    }

    // Process city-level data
    if (regionalSeries[store.city] == undefined) {
      regionalSeries[store.city] = {
        target: store.city,
        type: "city",
        name: store.city,
        count: store.count,
        stores: 1,
        lat: store.lat,
        long: store.long,
        state: store.state,
        markerData: []
      };
      regionalSeries[store.state].markerData.push(regionalSeries[store.city]);
    }
    else {
      regionalSeries[store.city].stores++;
      regionalSeries[store.city].count += store.count;
    }

    // Process individual store
    regionalSeries[store.city].markerData.push({
      name: store.location,
      count: store.count,
      stores: 1,
      lat: store.lat,
      long: store.long,
      state: store.state
    });

  });

  regionalSeries.US.series.data = regionalSeries.US.markerData;
}
</script>

<!-- HTML -->
<div id="chartdiv"></div>