Class: Ambling::Xy::Settings

Inherits:
Object
  • Object
show all
Includes:
Base
Defined in:
lib/ambling/xy.rb

Overview

“!” before x or y position (for example: <x>!20</x>) means that the coordinate will be calculated from the right side or the bottom

Defined Under Namespace

Classes: Axes, Background, Balloon, Bullets, ContextMenu, DateFormats, ErrorMessages, ExportAsImage, Graphs, Grid, Help, Labels, Legend, PlotArea, Scroller, Strings, Values, Zoom

Constant Summary collapse

VALUES = 
[:data_type,:csv_separator,:skip_rows,:font,:text_size,:text_color,:decimals_separator,:thousands_separator,:digits_after_decimal,:redraw,:reload_data_interval,:preloader_on_reload,:add_time_stamp,:depth,:angle,:link_target,:mask,:colors,:background,:plot_area,:grid,:values,:axes,:date_formats,:balloon,:bullets,:scroller,:zoom,:help,:legend,:export_as_image,:error_messages,:strings,:context_menu,:labels,:graphs]

Instance Attribute Summary collapse

Method Summary

Methods included from Base

#build_xml, #initialize, #populate, #to_xml

Instance Attribute Details

#add_time_stamp ⇒ Object

false

(true / false) if true, a unique number will be added every time flash loads data. Mainly this feature is useful if you set reload _data_interval



76
77
78
 
# File 'lib/ambling/xy.rb', line 76

def add_time_stamp
  @add_time_stamp
end

#angle ⇒ Object

30

(0 - 90) angle of chart area and columns (for 3D effect)



86
87
88
 
# File 'lib/ambling/xy.rb', line 86

def angle
  @angle
end

#axes ⇒ Object

axes



126
127
128
 
# File 'lib/ambling/xy.rb', line 126

def axes
  @axes
end

#background ⇒ Object

BACKGROUND



106
107
108
 
# File 'lib/ambling/xy.rb', line 106

def background
  @background
end

#balloon ⇒ Object

BALLOON



136
137
138
 
# File 'lib/ambling/xy.rb', line 136

def balloon
  @balloon
end

#bullets ⇒ Object

Returns the value of attribute bullets.



141
142
143
 
# File 'lib/ambling/xy.rb', line 141

def bullets
  @bullets
end

#colors ⇒ Object

#FF6600,#FCD202,#B0DE09,#0D8ECF,#2A0CD0,#CD0D74,#CC0000,#00CC00,#0000CC,#DDDDDD,#999999,#333333,#990000

Colors of graphs. if the graph color is not set, color from this array will be used



101
102
103
 
# File 'lib/ambling/xy.rb', line 101

def colors
  @colors
end

#context_menu ⇒ Object

<menu function_name=“printChart” title=“Print chart”></menu>



181
182
183
 
# File 'lib/ambling/xy.rb', line 181

def context_menu
  @context_menu
end

#csv_separator ⇒ Object

;

(string) csv file data separator (you need it only if you are using csv file for your data)



21
22
23
 
# File 'lib/ambling/xy.rb', line 21

def csv_separator
  @csv_separator
end

#data_type ⇒ Object

xml

(xml / csv)



16
17
18
 
# File 'lib/ambling/xy.rb', line 16

def data_type
  @data_type
end

#date_formats ⇒ Object

these settings are important only if your axis type is date or duration



131
132
133
 
# File 'lib/ambling/xy.rb', line 131

def date_formats
  @date_formats
end

#decimals_separator ⇒ Object

,

(string) decimal separator. Note, that this is for displaying data only. Decimals in data xml file must be separated with a dot



46
47
48
 
# File 'lib/ambling/xy.rb', line 46

def decimals_separator
  @decimals_separator
end

#depth ⇒ Object

0

(Number) the depth of chart and columns (for 3D effect)



81
82
83
 
# File 'lib/ambling/xy.rb', line 81

def depth
  @depth
end

#digits_after_decimal ⇒ Object

(Number) if your value has less digits after decimal then is set here, zeroes will be added



56
57
58
 
# File 'lib/ambling/xy.rb', line 56

def digits_after_decimal
  @digits_after_decimal
end

#error_messages ⇒ Object

“error_messages” settings will be applied for all error messages except the one which is showed if settings file wasn’t found



171
172
173
 
# File 'lib/ambling/xy.rb', line 171

def error_messages
  @error_messages
end

#export_as_image ⇒ Object

export_as_image feature works only on a web server



166
167
168
 
# File 'lib/ambling/xy.rb', line 166

def export_as_image
  @export_as_image
end

#font ⇒ Object

Arial

(font name) use device fonts, such as Arial, Times New Roman, Tahoma, Verdana…



31
32
33
 
# File 'lib/ambling/xy.rb', line 31

def font
  @font
end

#graphs ⇒ Object

if graph settings are defined both here and in data file, the ones from data file are used



191
192
193
 
# File 'lib/ambling/xy.rb', line 191

def graphs
  @graphs
end

#grid ⇒ Object

GRID



116
117
118
 
# File 'lib/ambling/xy.rb', line 116

def grid
  @grid
end

#help ⇒ Object

HELP button and balloon



156
157
158
 
# File 'lib/ambling/xy.rb', line 156

def help
  @help
end

#labels ⇒ Object

labels can also be added in data xml file, using exactly the same structure like it is here



186
187
188
 
# File 'lib/ambling/xy.rb', line 186

def labels
  @labels
end

#legend ⇒ Object

LEGEND



161
162
163
 
# File 'lib/ambling/xy.rb', line 161

def legend
  @legend
end

#link_target ⇒ Object

(_blank, _top …)



91
92
93
 
# File 'lib/ambling/xy.rb', line 91

def link_target
  @link_target
end

#mask ⇒ Object

true

if true, bubbles, data labels will be masked within plot area. If the <zoom> is enabled, this setting is always “true”



96
97
98
 
# File 'lib/ambling/xy.rb', line 96

def mask
  @mask
end

#plot_area ⇒ Object

PLOT AREA (the area between axes)



111
112
113
 
# File 'lib/ambling/xy.rb', line 111

def plot_area
  @plot_area
end

#preloader_on_reload ⇒ Object

false

(true / false) Whether to show preloaded when data or settings are reloaded



71
72
73
 
# File 'lib/ambling/xy.rb', line 71

def preloader_on_reload
  @preloader_on_reload
end

#redraw ⇒ Object

false

(true / false) if your chart’s width or height is set in percents, and redraw is set to true, the chart will be redrawn then screen size changes



61
62
63
 
# File 'lib/ambling/xy.rb', line 61

def redraw
  @redraw
end

#reload_data_interval ⇒ Object

0

(Number) how often data should be reloaded (time in seconds)



66
67
68
 
# File 'lib/ambling/xy.rb', line 66

def reload_data_interval
  @reload_data_interval
end

#scroller ⇒ Object

Returns the value of attribute scroller.



146
147
148
 
# File 'lib/ambling/xy.rb', line 146

def scroller
  @scroller
end

#skip_rows ⇒ Object

0

(Number) if you are using csv data type, you can set the number of rows which should be skipped here



26
27
28
 
# File 'lib/ambling/xy.rb', line 26

def skip_rows
  @skip_rows
end

#strings ⇒ Object

Returns the value of attribute strings.



176
177
178
 
# File 'lib/ambling/xy.rb', line 176

def strings
  @strings
end

#text_color ⇒ Object

#000000

(hex color code) main text color. Every text color can be set individually in the settings below



41
42
43
 
# File 'lib/ambling/xy.rb', line 41

def text_color
  @text_color
end

#text_size ⇒ Object

11

(Number) text size of all texts. Every text size can be set individually in the settings below



36
37
38
 
# File 'lib/ambling/xy.rb', line 36

def text_size
  @text_size
end

#thousands_separator ⇒ Object

(string) thousand separator. use “none” if you don’t want to separate



51
52
53
 
# File 'lib/ambling/xy.rb', line 51

def thousands_separator
  @thousands_separator
end

#values ⇒ Object

VALUES



121
122
123
 
# File 'lib/ambling/xy.rb', line 121

def values
  @values
end

#zoom ⇒ Object

Returns the value of attribute zoom.



151
152
153
 
# File 'lib/ambling/xy.rb', line 151

def zoom
  @zoom
end