Use a Chart with a REST Data Source

Last update: Edit

1 Introduction

With the Charts widgets, you can use data from a REST Service to plot graphs.

This how-to will teach you how to do the following:

  • Publish a REST API
  • Use a REST end point as a data source for the Charts widget

2 Prerequisites

Before starting this how-to, make sure you have completed the following prerequisites:

  • Install the latest Mendix desktop modeler
  • Create an app
  • Import the latest Charts Widgets from the Mendix Marketplace

3 Setting up Data to be Exposed by a REST Endpoint

Mendix allows you to publish REST Web services natively from the modeler. Using these capabilities you can publish a REST service and use it in our Charts widget to plot graphs.

To create an Area Chart with data from a REST service, follow these steps:

  1. Create a new Module in your app.
  2. Rename the module to ChartsREST.
  3. Open the Domain model.
  4. Create Value and Series entities with the attributes and association shown in the picture below. Chart Rest Domain
  5. Right-click Value and select Generate overview pages…. Chart Rest Enter Data
  6. Add the Value_NewEdit page generated to your navigation.
  7. Run the app.
  8. In your browser, open the NewEdit page.
  9. Add values and series by entering data in the appropriate fields.

4 Publishing the Service

To use data from a model in the REST service, you need to create a JSON structure.

4.1 Creating the Structure

  1. Create a JSON Structure
    Charts Rest MD

4.2 Configuring the REST Service

To configure the REST service, follow these steps:

  1. Add Published REST service. Charts Rest Publish

  2. Add REST Service Microflow. Charts Rest Microflow

  3. Add Export mapping. Charts Rest Export Mapping

5 Using REST as a Data Source

To use the REST Data source end point in your chart, follow these steps:

  1. Create a page in your app containing an Area chart widget.

  2. Double click the Area chart widget.

  3. In the tab Chart properties, add a new chart Series property.

  4. Add Series name and Entity.

  5. Select Data source REST endpoint.

    Chart Rest Series

  6. Add the REST URL.

    Chart Rest URL

  7. In the tab Data points, select the X-axis data attribute and the Y-axis data attribute.

    select Data Points

  8. Add Parameters to the REST Request. The contextId, series name are provided by default.

    select Data Points

  9. Run your app and view the chart.

    Show Chart

6 Read More