SimWrapper

SimWrapper

  • Documentation
  • Examples
  • News
  • GitHub

›API Reference / General

Introduction

  • SimWrapper
  • Examples
  • File management
  • Getting help

Guides

  • 1. Getting started tutorial
  • 2. Dashboards in depth
  • 3. Building a project site
  • 4. Publishing to the web

API Reference / MATSim

  • MATSim Network link plots
  • MATSim Carrier viewer
  • MATSim DRT vehicle animation
  • MATSim Logistics Viewer
  • MATSim Public transit supply/demand
  • MATSim Events viewer

API Reference / General

  • Aggregate O/D flows
  • Bar, area, and line charts
  • Calculation tables
  • CSV table viewer
  • Flow maps
  • Gridmap
  • Heatmap chart
  • Matrix (HDF5) Viewer
  • Pie charts
  • Plotly
  • Sankey/Alluvial diagrams
  • Scatter plots
  • Shapefiles: Area maps, network links, and GeoJSON
  • Text blocks
  • Tiles
  • Vega-Lite charts
  • Video player
  • XML Viewer
  • XY hexagons (aggregate)
  • X/Y/Time point data

For Developers

  • Conversion scripts
  • Developing SimWrapper
  • Plugin writing guide
  • SimWrapper Change Log

Heatmap chart

Heatmap chart example Heatmap depicting Time of day vs. activity purpose

A heatmap chart depicts aggregate data in two dimensions on one chart.

Usage

Heatmap charts can only be included as panels in Dashboards. See Dashboard documentation for general tips on creating dashboard configurations.

  • Use panel type: heatmap in the dashboard configuration.
  • Each heatmap panel is defined inside a row in a dashboard-*.yaml file.
  • Standard title, description, and width fields define the frame.

Sample dashboard.yaml config snippet with a heatmap

layout:
  row1:
    - title: "My Heatmap"
      type: heatmap
      dataset: "trips-tod-wide.csv"
      y: depart
      columns: ['Home','Work','atwork','eatout','escort','othdiscr','othmaint',
                'school','shopping','social']
      xAxisTitle: "Activity Purpose"
      yAxisTitle: "Time of Day (Hour)"
      flipAxes: true

Heatmap chart properties

Heatmap chart properties:

dataset: String. The filepath containing the data. May include wildcards * and ?.

y: column containing y-value data.

columns:: Array[] containing names of columns with data to be categorized on the x-axis. See example above.

xAxisTitle and yAxisTitle: Descriptive titles for the x-axis and y-axis (optional).

flipAxes: True/false. Transpose the heatmap matrix, thus flipping the x and y axes. Can be useful if your data is stored one way but you want it displayed the other.

← PreviousMatrix (HDF5) Viewer →
SimWrapper
Docs
Getting StartedDeveloper GuideLatest Updates
More
VSP HomeMATSim.org⭐ us on GitHub!
Copyright © 2025 VSP, TU Berlin