Skip to content

Commit

Permalink
README updated
Browse files Browse the repository at this point in the history
  • Loading branch information
Mikhus committed Sep 6, 2016
1 parent ef7df8c commit 1a427c4
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,13 +188,19 @@ Each type of the gauge in this library also has it's own specific configuration

##### Linear Gauge Options

Linear gauge has some specific options for customization and some drawing rules which is good to know.

First of all it can be drawn vertically or horizontally, depending on the upset width and height options for the canvas element. If width greater than height the gauge will be treated as horizontal, otherwise - as vertical.

Horizontal gauge drawing has a limitation of drawing value box. In this orientation value box rendering is disabled as far as it is not possible to find a good place for it within the current design. So it has to be kept im mind when the horizontal orientation is selected to draw the gauge.

###### Borders Options

- **borderRadius**: radius or founded corners for the gauge plate.
- **borderRadius**: radius for rounded corners of the gauge plate and its borders.

###### Bar Options

- **barBeginCircle**: defines if a gauge bar should start with a circle element imitating flask view of the bar. If set to zero value it won't be drawn at all.
- **barBeginCircle**: defines if a gauge bar should start with a circle element imitating flask view of the bar. If set to zero it won't be drawn at all.
- **barWidth**: bar width in percents in relation to overall width of the gauge. It is limited to 50% anyway.
- **barLength**: defines bar length in percents in relation to overall gauge length.
- **barStrokeWidth**: defines a width of a bar stroke. If set to zero - stroke won't be drawn.
Expand Down Expand Up @@ -228,6 +234,8 @@ Each type of the gauge in this library also has it's own specific configuration

##### Radial Gauge Options

Radial gauge controls has their specific customization options, which are enables to drastically customize its view to make it look, for example, like manometer or compass or any other radial-kind of the tool possible too imagine.

###### Bar Options

- **ticksAngle**: defines a max angle for ticks bar. By default is 270 degrees. If 360 degrees specified ticks bar fills the whole circle.
Expand Down

0 comments on commit 1a427c4

Please sign in to comment.