Skip to content

Commit

Permalink
Added section on configuration options to README.
Browse files Browse the repository at this point in the history
  • Loading branch information
Pete Harverson committed May 20, 2016
1 parent 988d30f commit dc4c9e4
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,29 @@ bin/kibana plugin -i prelert_swimlane_vis -u https://github.com/prelert/kibana-s

## Options

The options tab allows you to configure the color band thresholds and the format of the value shown
in the tooltip when hovering over a marker in the swimlane.

![image](resources/options.png)

### Color band thresholds

The swimlane uses five different colors to indicate the value of the metric over a time interval, from
light blue for the smallest values, through to red for the largest values. By default, the thresholds are
set for a 0 to 100 range of values, with the ranges set to:

| Range | Color |
| -----------------|---------------|
| 0 <= value < 3 | light blue |
| 3 <= value < 25 | blue |
| 25 <= value < 50 | yellow |
| 50 <= value < 75 | orange |
| 75 <= value | red |


### Tooltip formatting


## Issues
Please file issues [here](https://github.com/prelert/kibana-swimlane-vis/issues).

Expand Down

0 comments on commit dc4c9e4

Please sign in to comment.