Class: Ambling::Column::Settings::Guides::Guide

Inherits:

Object

• Object
• Ambling::Column::Settings::Guides::Guide

Includes:

Base

Defined in:

lib/ambling/column.rb

Overview

there can be any number of quides. guides can also be set in data xml file, using the same syntax as here

Constant Summary

VALUES =

[:behind,:start_value,:end_value,:title,:width,:color,:alpha,:fill_color,:fill_alpha,:inside,:centered,:rotate,:text_size,:text_color,:dashed,:dash_length]

Instance Attribute Summary

• #alpha ⇒ Object

  100

  (0 - 100) opacity of guide line.

• #behind ⇒ Object

  false

  (true / false) whether your guides should appear in front of columns or behind them.

• #centered ⇒ Object

  true

  (true / false) if you have start and end values defined, title can be placed in the middle between these values.

• #color ⇒ Object

  #000000

  (hex color code) color of guide line.

• #dash_length ⇒ Object

  5

  (Number).

• #dashed ⇒ Object

  false

  (true / false).

• #end_value ⇒ Object

  (number) if you set value here too, another quide will be drawn.

• #fill_alpha ⇒ Object

  0

  (0 - 100) opacity of a fill.

• #fill_color ⇒ Object

  guide.color

  (hex color code) fill color.

• #inside ⇒ Object

  values.value.inside

  whether to place title inside plot area.

• #rotate ⇒ Object

  values.value.rotate

  (0 - 90) angle of rotation of title.

• #start_value ⇒ Object

  (number) value at which guide should be placed.

• #text_color ⇒ Object

  values.value.color

  (hex color code).

• #text_size ⇒ Object

  values.value.text_size

  (Number).

• #title ⇒ Object

  (string) text which will be displayed near the guide.

• #width ⇒ Object

  0

  (Number) width of a guide line (0 for hairline).

Method Summary

Methods included from Base

#build_xml, #initialize, #populate, #to_xml

Instance Attribute Details

#alpha ⇒ Object

100

(0 - 100) opacity of guide line

# File 'lib/ambling/column.rb', line 1282

def alpha
  @alpha
end

#behind ⇒ Object

false

(true / false) whether your guides should appear in front of columns or behind them

# File 'lib/ambling/column.rb', line 1252

def behind
  @behind
end

#centered ⇒ Object

true

(true / false) if you have start and end values defined, title can be placed in the middle between these values. If false, it will be placed near start_value

# File 'lib/ambling/column.rb', line 1302

def centered
  @centered
end

#color ⇒ Object

#000000

(hex color code) color of guide line

# File 'lib/ambling/column.rb', line 1277

def color
  @color
end

#dash_length ⇒ Object

5

(Number)

# File 'lib/ambling/column.rb', line 1327

def dash_length
  @dash_length
end

#dashed ⇒ Object

false

(true / false)

# File 'lib/ambling/column.rb', line 1322

def dashed
  @dashed
end

#end_value ⇒ Object

(number) if you set value here too, another quide will be drawn. If you set fill alpha > 0, then the area between these quides will be filled with color

# File 'lib/ambling/column.rb', line 1262

def end_value
  @end_value
end

#fill_alpha ⇒ Object

0

(0 - 100) opacity of a fill

# File 'lib/ambling/column.rb', line 1292

def fill_alpha
  @fill_alpha
end

#fill_color ⇒ Object

guide.color

(hex color code) fill color. If not defined, color of a guide will be used. Separate color codes with comas for gradient

# File 'lib/ambling/column.rb', line 1287

def fill_color
  @fill_color
end

#inside ⇒ Object

values.value.inside

whether to place title inside plot area

# File 'lib/ambling/column.rb', line 1297

def inside
  @inside
end

#rotate ⇒ Object

values.value.rotate

(0 - 90) angle of rotation of title.

# File 'lib/ambling/column.rb', line 1307

def rotate
  @rotate
end

#start_value ⇒ Object

(number) value at which guide should be placed

# File 'lib/ambling/column.rb', line 1257

def start_value
  @start_value
end

#text_color ⇒ Object

values.value.color

(hex color code)

# File 'lib/ambling/column.rb', line 1317

def text_color
  @text_color
end

#text_size ⇒ Object

values.value.text_size

(Number)

# File 'lib/ambling/column.rb', line 1312

def text_size
  @text_size
end

#title ⇒ Object

(string) text which will be displayed near the guide

# File 'lib/ambling/column.rb', line 1267

def title
  @title
end

#width ⇒ Object

0

(Number) width of a guide line (0 for hairline)

# File 'lib/ambling/column.rb', line 1272

def width
  @width
end