org.webjars.bowergithub.predixdesignsystem:px-timeline

px-timeline

Overview

Px-timeline a Predix UI component that provides a flexible, interactive timeline for visualizing a time-based series of events and documenting details relevant to each event.

Usage

Prerequisites

1. node.js
2. npm
3. gulp
4. bower
5. webcomponents-lite.js polyfill

Node, npm, and bower are necessary to install the component and dependencies. webcomponents.js adds support for web components and custom elements to your application.

Getting Started

First, install the component via bower on the command line:

bower install px-timeline --save

Second, import the component in your application with the following tag in your head:

<link rel="import" href="/bower_components/px-timeline/px-timeline.html"/>

Finally, use the component in your application:

<px-timeline
  show-time-groups=true
  show-node-content=false
  timeline-data="{{data}}"
  enhanced=true>
</px-timeline>

---

Documentation

Read the full API and view the demo here.

The documentation in this repository is supplemental to the official Predix documentation, which is continuously updated and maintained by the Predix documentation team. Go to http://predix.io to see the official Predix documentation.

Local Development

From the component's directory...

$ npm install
$ bower install
$ gulp sass

From the component's directory, to start a local server run:

$ gulp serve

Navigate to the root of that server (e.g. http://localhost:8080/) in a browser to open the API documentation page, with link to the "Demo" / working examples.

Navigate to to the test runner (e.g. http://localhost:8080/test/runner.html) in a browser to see your tests pass.

GE Coding Style Guide

GE JS Developer's Guide

---

Known Issues

Please use Github Issues to submit any bugs you might find.