/time-series

Deprecated, replaced by Charts widget, https://github.com/mendixlabs/charts

Primary LanguageTypeScriptApache License 2.0Apache-2.0

Build Status Dependency Status Dev Dependency Status codecov

Time series

Plot and track your data across different time periods on a chart.

Features

  • Plot numeric data date on a time line
  • Multiple series in one graph
  • Date formatting on x-axis (eg: dd/MM/yyyy, MMM-yyyy). See all patterns here
  • Formatting of numbers on y-axis (decimal precision)
  • Guidelines and floating tool tips
  • Automatic and custom line colouring eg: green, #00FF00, rgb(0,255,0)
  • Filling of series area

Dependencies

  • Mendix 7.6

Demo project

https://timeseriestest.mxapps.io/

Usage

This widget requires a context.

Series Configuration

Atleast one series is required, with its data source

Data source

  • Name - The name of the series, it will appear in the chart's legend.
  • Data entity - The entity containing the data points for x-axis and y-axis (it has the x and y attributes). In this example its the Point entity.
  • Source
    • XPath - For "XPath" source, add an XPath constraint in the Source - XPath tab. Not the XPath are more efficient in large data sets.
    • Microflow - For "Microflow" source, add a data source microflow in the Source - Microflow tab.

Sample domain model and configuration

Sample domain model and configuration

Issues, suggestions and feature requests

We are actively maintaining this widget, please report any issues or suggestion for improvement at https://github.com/mendixlabs/time-series/issues.

Development

Prerequisite: Install git, node package manager, webpack CLI, grunt CLI, Karma CLI

To contribute, fork and clone.

> git clone https://github.com/mendixlabs/time-series.git

The code is in typescript. Use a typescript IDE of your choice, like Visual Studio Code or WebStorm.

To set up the development environment, run:

> npm install

Create a folder named dist in the project root.

Create a Mendix test project in the dist folder and rename its root folder to MxTestProject. Changes to the widget code shall be automatically pushed to this test project. Or get the test project from https://github.com/mendixlabs/time-seriesreleases/latest

To automatically compile, bundle and push code changes to the running Mendix test project, run:

> grunt

To run the unit tests with code coverage, results can be found at dist/testresults/coverage/index.html, run:

> npm test

or run the unit tests continuously during development:

> karma start