Skip to content

Instantly share code, notes, and snippets.

@nilaft

nilaft/readme-widgets.md

Last active July 31, 2018 16:12
Show Gist options
  • Save nilaft/889cefd8d6a5e345954509bde7f8490b to your computer and use it in GitHub Desktop.
Save nilaft/889cefd8d6a5e345954509bde7f8490b to your computer and use it in GitHub Desktop.
Download ZIP
Widget Views
Raw
readme-widgets.md

Widget Views and API

A Catamera widget has multiple views L0, L1, L2 and L3 (Table). Widget shows a summarized view, it could be cumulative or for a particular week or month. Some widgets have timeline showing for example last few months of data.

L0


##### L1


##### L2


##### L2 with Timeline


API's

There are three API's that is needed to power the widget

  1. Timeline API (required for widgets with timeline) : Timeline api returns a array of data needed to show timeline.

  2. Widget API : Widget API provides a summarized dataset needed for L0/L1/L2 views. A key/filter is passed as query parameter, which could be based on timeline selection.

  3. L3/Detail API : This for the detail view with the data grid. User is able to view multiple rows, filter, search and also the download all the rows.

You can find swagger definitions here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment