Class: PDF::Charts::StdDev

Class | PDF::Charts::StdDev
In: | lib/pdf/charts/stddev.rb
Parent: | Object

Creates a standard deviation chart. This is a type of chart that is effective for the display of survey results or other data that can easily be measured in terms of the average and the standard deviation from that average.

The scale of responses is the vertical scale; the average data points and standard deviation values are the horizontal scale.

### Methods

new render_on

### Classes and Modules

Class PDF::Charts::StdDev::Label
Class PDF::Charts::StdDev::Marker
Class PDF::Charts::StdDev::Scale

### Constants

VERSION | = | '1.1.3'
DataPoint | = | Struct.new(:label, :average, :stddev) |  | A data element.

### Attributes

bar | [RW] | The standard deviation bar. A line will be drawn through the dot marker (if drawn) from the upper to lower standard deviation. If `nil`, the line will not be drawn. This is a PDF::Charts::StdDev::Marker object.
data | [R] | The data used to generate the standard deviation chart. This is an array of DataPoint objects, each containing a `label`, an `average`, and the `stddev` (standard deviation) from that average.
datapoint_width | [RW] | The width of a single datapoint.
dot | [RW] | The dot marker. A filled circle will be drawn with this information. If `nil`, the dot will not be drawn. This is a PDF::Charts::StdDev::Marker object.
height | [RW] | The height of the chart in PDF user units. Default 200 units.
inner_borders | [RW] | The inner border style. If `nil`, no inner borders are drawn. This is a PDF::Charts::StdDev::Marker object.
label | [RW] | The label style of the labels if they are displayed. This must be a PDF::Charts::StdDev::Label object.
leading_gap | [RW] | The minimum gap between the chart and the bottom of the page, in PDF user units.
lower_crossbar | [RW] | The lower crossbar. A line will be drawn across the bottom of the standard deviation bar to the width of the dot marker. If dot is `nil`, then the line will be twice as wide as it is thick. If `nil`, the lower crossbar will not be drawn. This is a PDF::Charts::StdDev::Marker object.
maximum_width | [RW] | The maximum width of the chart in PDF user units. Default 500 units.
outer_borders | [RW] | The outer border style. If `nil`, no inner borders are drawn. This is a PDF::Charts::StdDev::Marker object.
scale | [RW] | The scale of the chart. All values must be within this range. This will be a Scale object. It defaults to a scale of 0..6 with a step of 1.
show_labels | [RW] | This will be `true` if labels are to be displayed.
upper_crossbar | [RW] | The upper crossbar. A line will be drawn across the top of the standard deviation bar to the width of the dot marker. If dot is `nil`, then the line will be twice as wide as it is thick. If `nil`, the upper crossbar will not be drawn. This is a PDF::Charts::StdDev::Marker object.

### Public Class methods

new() {|self if block_given?| ...}

### Public Instance methods

render_on(pdf)

Draw the standard deviation chart on the supplied PDF document.

[Validate]