Linting fixes

Copyright messages
esnet · Sep 4, 2015 · 494ea07 · 494ea07
1 parent 27ffc28
commit 494ea07
Show file tree

Hide file tree

Showing 90 changed files with 1,522 additions and 2,541 deletions.
diff --git a/.eslintrc b/.eslintrc
@@ -28,10 +28,9 @@
     "no-dupe-keys": 2,
     "no-duplicate-case": 2,
     "no-empty": 2,
-    "no-empty-class": 2,
+    "no-empty-character-class": 2,
     "no-ex-assign": 2,
     "no-extra-boolean-cast": 2,
-    "no-extra-parens": 0,
     "no-extra-semi": 2,
     "no-func-assign": 2,
     "no-inner-declarations": [
@@ -181,7 +180,7 @@
     "no-ternary": 0,
     "no-trailing-spaces": 2,
     "no-underscore-dangle": 0,
-    "no-wrap-func": 2,
+    "no-extra-parens": 0,
     "one-var": [
       2,
       "never"
@@ -242,7 +241,7 @@
         "nonwords": false
       }
     ],
-    "spaced-line-comment": [
+    "spaced-comment": [
       2,
       "always"
     ],

diff --git a/.npmignore b/.npmignore
@@ -1,5 +1,4 @@
 lib/
-!build/npm/lib
 examples/
 screenshots/
 docs/

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,7 @@
-"ESnet React Charts, Copyright (c) 2014, The Regents of the University of California,
-through Lawrence Berkeley National Laboratory (subject to receipt of any
-required approvals from the U.S. Dept. of Energy).  All rights reserved."
+"ESnet React Timeseries Charts, Copyright (c) 2015, The Regents of the
+University of California, through Lawrence Berkeley National Laboratory
+(subject to receipt of any required approvals from the U.S. Dept. of Energy).
+All rights reserved."
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

diff --git a/README.md b/README.md
@@ -2,18 +2,21 @@
 
 This library contains a set of modular charting components used for building flexible interactive charts. It was built for React from the ground up, specifically to visualize timeseries data and network traffic data in particular. Low level elements are constructed using d3, while higher level composability is provided by React. Charts can be stacked as rows, overlayed on top of each other, or any combination, all in a highly declarative manner.
 
+The library is used thoughout the public facing [ESnet Portal](http://my.es.net).
+
 Current features of the library include:
 
  * Declarative layout of charts using JSX
  * Interactivity, including pan and zoom
  * Add new chart types or overlays
  * Multiple axis, multiple rows
- * Line, area and scatter charts
+ * Line, area, scatter charts
  * Brushing
  * Timeseries tables
  * Legends
+ * Baseline and TimeRange markers
 
-Please see the examples for a feel for the library, or read on to get started.
+Please browse the examples for a feel for the library, or read on to get started.
 
 Getting started
 ---------------
@@ -26,7 +29,7 @@ Once installed, you can import the necessary components from the library:
 
     import { Charts, ChartContainer, ChartRow, YAxis, LineChart } from "react-timeseries-charts";
 
-Then we construct our chart in the `render()` function of our component. The code to generate the above chart, specified in JSX, looks like this:
+Then we construct our chart in the `render()` function of our component. For a simple example we create a chart with two line charts on it, specified in JSX:
 
     <ChartContainer timeRange={series1.range()} padding="5">
         <ChartRow height="200">
@@ -43,14 +46,14 @@ At the outer layer, we add a `ChartContainer` which contains our timerange for t
 
 For the next layer of the layout we make a `ChartRow`. We can have multiple charts stacked on top of each other by using more than one row. In this case we just have one row. Each row has a specific height in the layout, so we specify that as 200px high here.
 
-Next up we want to put something in our row. Rows contain a central flexible sized area in which charts can be added. This area is surrounded in the JSX by the `<Charts>` tag. Each chart in this area is overlaid on top of each other. In this case we are adding two `LineChart`s, one for each of our series and so they will be drawn on top of each other. For scaling each chart will reference an axis that will define the scale and display the y-scale.
+Next up we want to put something in our row. Rows contain a central flexible sized area in which charts can be added. This area is surrounded in the JSX by the `<Charts>` tag. Each chart in this area is overlaid on top of each other. In this case we are adding two `LineChart`s, one for each of our series. As a result they will be drawn on top of each other. For scaling each chart will reference an axis that will define the scale as well as display that scale visually as the y-axis.
 
 Finally, we specify the axes that the charts reference. These go either before or after the `Charts` group, depending on if you want the axis before (to the left) or after the charts (to the right). You can specify any number of axes on either side. For each `YAxis` you specify the `id` so that a chart can reference it, the `label` you want displayed alongside the axis and, importantly, the scale using `min` and `max`. You can also specify the `width`, the `type` of the axis (`linear`, `log`, etc) and the `format`.
 
 Data format
 -----------
 
-This charting library is built on the ESnet timeseries library called Pond. Pond was essentially created to provide a common representation for things like timeseries, timeranges, events and other structures. For the purpose of using the charting library, you need to create a TimeSeries() object as your series, which will be rendered by the chart code. For example:
+This charting library is built on the ESnet timeseries library called [Pond](http://software.es.net/pond). Pond was created to provide a common representation for things like timeseries, timeranges, events and other structures. For the purpose of using the charting library, you need to create a TimeSeries() object as your series, which will be rendered by the chart code. For example:
 
     import {TimeSeries, TimeRange} from "pond";
 

diff --git a/docs/areachart.md b/docs/areachart.md
diff --git a/docs/barchart.md b/docs/barchart.md
diff --git a/docs/baseline.md b/docs/baseline.md
diff --git a/docs/brush.md b/docs/brush.md
diff --git a/docs/chartcontainer.md b/docs/chartcontainer.md
diff --git a/docs/chartrow.md b/docs/chartrow.md
diff --git a/docs/charts.md b/docs/charts.md
diff --git a/docs/eventchart.md b/docs/eventchart.md
diff --git a/docs/eventrect.md b/docs/eventrect.md
diff --git a/docs/labelaxis.md b/docs/labelaxis.md
diff --git a/docs/legend.md b/docs/legend.md
diff --git a/docs/linechart.md b/docs/linechart.md
diff --git a/docs/pointindicator.md b/docs/pointindicator.md
diff --git a/docs/resizable.md b/docs/resizable.md
diff --git a/docs/scatterchart.md b/docs/scatterchart.md
diff --git a/docs/timeaxis.md b/docs/timeaxis.md
diff --git a/docs/tracker.md b/docs/tracker.md