ziya 1.0.0 → 2.0.0

data/lib/ziya/charts/bubble.rb

@@ -0,0 +1,18 @@
+# -----------------------------------------------------------------------------
+# Generates necessary xml for bubble chart 
+#
+# Author: Fernand
+# -----------------------------------------------------------------------------
+require 'ziya/charts/base'
+
+module Ziya::Charts
+  class Bubble < Base
+    # Creates a bubble chart
+    # <tt>:license</tt>::  the XML/SWF charts license
+    # <tt>:chart_id</tt>:: the name of the chart style sheet.      
+    def initialize( license=nil, chart_id=nil )
+      super( license, chart_id )
+      @type = "bubble"      
+    end
+  end
+end

data/lib/ziya/charts/candle_stick.rb

@@ -1,9 +1,14 @@
 # -----------------------------------------------------------------------------
 # Generates necessary xml for candlestick chart 
+#
+# Author: Fernand
 # -----------------------------------------------------------------------------
 module Ziya::Charts
   class CandleStick < Base
-    def initialize( license=nil, chart_id=nil)
+    # Creates a candlestick chart
+    # <tt>:license</tt>::  the XML/SWF charts license
+    # <tt>:chart_id</tt>:: the name of the chart style sheet.      
+    def initialize( license=nil, chart_id=nil )
       super( license, chart_id )
       @type = "candlestick"      
     end

data/lib/ziya/charts/column.rb

@@ -1,9 +1,14 @@
 # -----------------------------------------------------------------------------
-# Generates necessary xml for a StackColumn chart
+# Generates necessary xml for a Column chart
+#
+# Author: Fernand
 # -----------------------------------------------------------------------------
 module Ziya::Charts
   class Column < Base
-    def initialize( license=nil, chart_id=nil)
+    # Creates a column chart
+    # <tt>:license</tt>::  the XML/SWF charts license
+    # <tt>:chart_id</tt>:: the name of the chart style sheet.      
+    def initialize( license=nil, chart_id=nil )
       super( license, chart_id )
       @type = "column"      
     end

data/lib/ziya/charts/column_threed.rb

@@ -1,9 +1,14 @@
 # -----------------------------------------------------------------------------
 # Generates necessary xml for 3D column chart
+#
+# Author: Fernand
 # -----------------------------------------------------------------------------
 module Ziya::Charts
   class ColumnThreed < Base
-    def initialize( license=nil, chart_id=nil)
+    # Creates a 3D Column chart
+    # <tt>:license</tt>::  the XML/SWF charts license
+    # <tt>:chart_id</tt>:: the name of the chart style sheet.      
+    def initialize( license=nil, chart_id=nil )
       super( license, chart_id )
       @type = "3d column"      
     end

data/lib/ziya/charts/floating_bar.rb

@@ -1,9 +1,14 @@
 # -----------------------------------------------------------------------------
 # Generates necessary xml for floating bar chart
+#
+# Author: Fernand
 # -----------------------------------------------------------------------------
 module Ziya::Charts
   class FloatingBar < Base
-    def initialize( license=nil, chart_id=nil)
+    # Creates a floating bar chart
+    # <tt>:license</tt>::  the XML/SWF charts license
+    # <tt>:chart_id</tt>:: the name of the chart style sheet.      
+    def initialize( license=nil, chart_id=nil )
       super( license, chart_id )
       @type = "floating bar"      
     end

data/lib/ziya/charts/floating_column.rb

@@ -1,11 +1,16 @@
 # -----------------------------------------------------------------------------
 # Generates necessary xml for a floating column chart
+#
+# Author: Fernand
 # -----------------------------------------------------------------------------
 module Ziya::Charts
   class FloatingColumn < Base
-    def initialize( license=nil, chart_id=nil)
+    # Creates a floating column chart
+    # <tt>:license</tt>::  the XML/SWF charts license
+    # <tt>:chart_id</tt>:: the name of the chart style sheet.      
+    def initialize( license=nil, chart_id=nil )
       super( license, chart_id )
-      @type = "floating column"      
+      @type = "floating column"
     end
   end
 end

data/lib/ziya/charts/line.rb

@@ -1,9 +1,14 @@
 # -----------------------------------------------------------------------------
-# Generates necessary xml for a StackColumn chart
+# Generates necessary xml for a line chart
+#
+# Author: Fernand
 # -----------------------------------------------------------------------------
 module Ziya::Charts
   class Line < Base
-    def initialize( license=nil, chart_id=nil)
+    # Creates a line chart
+    # <tt>:license</tt>::  the XML/SWF charts license
+    # <tt>:chart_id</tt>:: the name of the chart style sheet.      
+    def initialize( license=nil, chart_id=nil )
       super( license, chart_id )
       @type = "line"      
     end

data/lib/ziya/charts/mixed.rb

@@ -1,8 +1,13 @@
 # -----------------------------------------------------------------------------
 # Generates necessary xml for mixed chart 
+#
+# Author: Fernand
 # -----------------------------------------------------------------------------
 module Ziya::Charts
   class Mixed < Base
+    # Creates a mixed chart ie comosed of different chart types ie line + column
+    # <tt>:license</tt>::  the XML/SWF charts license
+    # <tt>:chart_id</tt>:: the name of the chart style sheet.      
     def initialize( license=nil, chart_id=nil )
       super( license, chart_id )
       @type = nil      

data/lib/ziya/charts/parallel_threed_column.rb

@@ -1,9 +1,14 @@
 # -----------------------------------------------------------------------------
 # Generates necessary xml for parallel 3D column chart
+#
+# Author: Fernand
 # -----------------------------------------------------------------------------
 module Ziya::Charts
   class ParallelThreedColumn < Base
-    def initialize( license=nil, chart_id=nil)
+    # Creates a parallel column 3D chart
+    # <tt>:license</tt>::  the XML/SWF charts license
+    # <tt>:chart_id</tt>:: the name of the chart style sheet.      
+    def initialize( license=nil, chart_id=nil )
       super( license, chart_id )
       @type = "parallel 3d column"      
     end

data/lib/ziya/charts/pie.rb

@@ -1,9 +1,14 @@
 # -----------------------------------------------------------------------------
-# 
+# Generates necessary xml for pie chart
+#
+# Author: Fernand
 # -----------------------------------------------------------------------------
 module Ziya::Charts
   class Pie < Base
-    def initialize( license=nil, chart_id=nil)
+    # Creates a pie chart
+    # <tt>:license</tt>::  the XML/SWF charts license
+    # <tt>:chart_id</tt>:: the name of the chart style sheet.      
+    def initialize( license=nil, chart_id=nil )
       super( license, chart_id )
       @type = "pie"      
     end

data/lib/ziya/charts/pie_threed.rb

@@ -1,9 +1,14 @@
 # -----------------------------------------------------------------------------
 # Generates necessary xml for 3D pie chart 
+#
+# Author: Fernand
 # -----------------------------------------------------------------------------
-module Ziya::Charts
+module Ziya::Charts  
   class PieThreed < Base
-    def initialize( license=nil, chart_id=nil)
+    # Creates a 3D pie chart
+    # <tt>:license</tt>::  the XML/SWF charts license
+    # <tt>:chart_id</tt>:: the name of the chart style sheet.          
+    def initialize( license=nil, chart_id=nil )
       super( license, chart_id )
       @type = "3d pie"      
     end

data/lib/ziya/charts/polar.rb

@@ -1,8 +1,13 @@
 # -----------------------------------------------------------------------------
-# 
+# Generates necessary xml for polar chart 
+#
+# Author: Fernand
 # -----------------------------------------------------------------------------
 module Ziya::Charts
   class Polar < Base
+    # Creates a polar chart
+    # <tt>:license</tt>::  the XML/SWF charts license
+    # <tt>:chart_id</tt>:: the name of the chart style sheet.          
     def initialize( license=nil, chart_id=nil)
       super( license, chart_id )
       @type = "polar"      

data/lib/ziya/charts/scatter.rb

@@ -1,9 +1,14 @@
 # -----------------------------------------------------------------------------
 # Generates necessary xml for scatter chart 
+# 
+# Author: Fernand
 # -----------------------------------------------------------------------------
 module Ziya::Charts
   class Scatter < Base
-    def initialize( license=nil, chart_id=nil)
+    # Creates a scatter chart
+    # <tt>:license</tt>::  the XML/SWF charts license
+    # <tt>:chart_id</tt>:: the name of the chart style sheet.              
+    def initialize( license=nil, chart_id=nil )
       super( license, chart_id )
       @type = "scatter"      
     end

data/lib/ziya/charts/stacked_area.rb

@@ -1,8 +1,13 @@
 # -----------------------------------------------------------------------------
 # Generates necessary xml for stacked area chart 
+#
+# Author: Fernand
 # -----------------------------------------------------------------------------
 module Ziya::Charts
   class StackedArea < Base
+    # Creates a stacked area chart
+    # <tt>:license</tt>::  the XML/SWF charts license
+    # <tt>:chart_id</tt>:: the name of the chart style sheet.              
     def initialize( license=nil, chart_id=nil)
       super( license, chart_id )
       @type = "stacked area"      

data/lib/ziya/charts/stacked_bar.rb

@@ -1,8 +1,13 @@
 # -----------------------------------------------------------------------------
 # Generates necessary xml for a stacked bar chart
+#
+# Author: Fernand
 # -----------------------------------------------------------------------------
 module Ziya::Charts
   class StackedBar < Base
+    # Creates a stacked bar chart
+    # <tt>:license</tt>::  the XML/SWF charts license
+    # <tt>:chart_id</tt>:: the name of the chart style sheet.              
     def initialize( license=nil, chart_id=nil)
       super( license, chart_id )
       @type = "stacked bar"      

data/lib/ziya/charts/stacked_column.rb

@@ -1,9 +1,14 @@
 # -----------------------------------------------------------------------------
-# Generates necessary xml for a stack column chart
+# Generates necessary xml for a stacked column chart
+#
+# Author: Fernand
 # -----------------------------------------------------------------------------
 module Ziya::Charts
   class StackedColumn < Base
-    def initialize( license=nil, chart_id=nil)
+    # Creates a stacked column chart
+    # <tt>:license</tt>::  the XML/SWF charts license
+    # <tt>:chart_id</tt>:: the name of the chart style sheet.              
+    def initialize( license=nil, chart_id=nil )
       super( license, chart_id )
       @type = "stacked column"      
     end

data/lib/ziya/charts/stacked_threed_area.rb

@@ -0,0 +1,16 @@
+# -----------------------------------------------------------------------------
+# Generates necessary xml for a stacked 3d area chart
+# 
+# Author: Fernand
+# -----------------------------------------------------------------------------
+module Ziya::Charts
+  class StackedThreedArea < Base
+    # Creates a stacked 3d area chart
+    # <tt>:license</tt>::  the XML/SWF charts license
+    # <tt>:chart_id</tt>:: the name of the chart style sheet.              
+    def initialize( license=nil, chart_id=nil )
+      super( license, chart_id )
+      @type = "3d area"      
+    end
+  end
+end

data/lib/ziya/charts/stacked_threed_column.rb

@@ -1,9 +1,14 @@
 # -----------------------------------------------------------------------------
 # Generates necessary xml for a stacked 3d column chart
+# 
+# Author: Fernand
 # -----------------------------------------------------------------------------
 module Ziya::Charts
   class StackedThreedColumn < Base
-    def initialize( license=nil, chart_id=nil)
+    # Creates a stacked 3d column chart
+    # <tt>:license</tt>::  the XML/SWF charts license
+    # <tt>:chart_id</tt>:: the name of the chart style sheet.              
+    def initialize( license=nil, chart_id=nil )
       super( license, chart_id )
       @type = "stacked 3d column"      
     end

data/lib/ziya/components/area.rb

@@ -2,13 +2,16 @@
 # Defines an area on a chart. Typically used to embed links and buttons
 #
 # Author:: Fernand Galiana
-# Date::   Dec 15th, 2006
 # -----------------------------------------------------------------------------
 require 'ziya/components/base'
 
 module Ziya::Components
+  # Creates a linkable area on the chart to use with the link component.
+  # See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=link
+  # for additional documentation, examples and futher detail.
   class Area < Base  
     has_attribute :x, :y, :width, :height, :url, :priority, :target, :text,
-                  :font, :bold, :size, :color, :background_color, :alpha            
+                  :font, :bold, :size, :color, :background_color, :alpha,
+                  :timeout, :retry, :spinning_wheel           
   end
 end

data/lib/ziya/components/axis_category.rb

@@ -1,69 +1,17 @@
 # -----------------------------------------------------------------------------
 # Sets the label attributes for the category-axis.
 #
-# <tt>skip</tt>:          If this axis holds too many labels, the skip key allows skipping (hiding) some labels.
-#                         A zero value doesn't hide any labels. If the skip value is 1, then the first label is
-#                         displayed, the following label is skipped, and so on. If the skip value is 2, then the
-#                         first label is displayed, the following 2 are skipped, and so on. Another way to hide
-#                         labels is by passing empty strings to chart_data in place of category labels.
-#                         The default is zero.
-# <tt>font</tt>:          The font used in the category-axis. See the Fonts section below.
-#                         The default is Arial.
-# <tt>bold</tt>:          A boolean value that indicates whether the font is bold or not.
-#                         The default is true.
-# <tt>size</tt>:          The font's size.
-#                         The default font size is calculated based on the chart size.
-# <tt>color</tt>:         The font's color. This must be a string holding triple hexadecimal values representing
-#                         the red, green, and blue components for a color.
-#                         The default is "000000" (black).
-# <tt>alpha</tt>:         This affects the labels' transparency, only when the embedded font is used (see the Fonts
-#                         section below.) Valid values are 0 (fully transparent) to 100 (fully opaque).
-#                         The default is 90. To hide all labels in this axis, set the alpha to 0
-# <tt>orientation</tt>:   This affects the labels' orientation, only when the embedded font is used (see the Fonts
-#                         section below.) Valid values are horizontal, diagonal_up, diagonal_down, vertical_up, and
-#                         vertical_down. Polar charts also accept the value circular.
-#                         The default value is horizontal.
-# <tt>margin</tt>:        This applies to area, stacked area, and line charts only. It's a boolean value that
-#                         indicates whether to leave a margin on the left and right of the graph, or bump it against
-#                         the left and right chart borders.
-#                         The default is false (no margin.) In mixed charts, there's always a margin to algin area
-#                         and line charts with column charts.
-# <tt>min</tt>:           This applies to scatter charts only, when the category-axis is calculated like the value-axis.
-#                         This determines the minimum value to start this axis with.
-#                         The default is calculated from the chart's data.
-# <tt>max</tt>:           This applies to scatter charts only, when the category-axis is calculated like the value-axis.
-#                         This determines the maximum value to end this axis with.
-#                         The default is calculated from the chart's data.
-# <tt>steps</tt>:         This applies to scatter charts only, when the category-axis is calculated like the value-axis.
-#                         This determines the number of steps between the minimum and maximum values. If the minimum value
-#                         is negative, and the maximum value is positive, then 'steps' is the number of steps between zero
-#                         and the larger of max and absolute min.
-#                         The default is 4.
-# <tt>prefix</tt>:        This applies to scatter charts only, when the category-axis is calculated like the value-axis.
-#                         This determines the characters to add before the value numbers (example: $10).
-#                         The default is nothing.
-# <tt>suffix</tt>:        This applies to scatter charts only, when the category-axis is calculated like the value-axis.
-#                         This determines the characters to add after the value numbers (example: 10%).
-#                         The default is nothing.
-# <tt>decimals</tt>:      This applies to scatter charts only, when the category-axis is calculated like the value-axis.
-#                         This determines the number of decimal places to the right of the decimal point (example: 10.45).
-#                         The default is zero (no decimals).
-# <tt>decimal_char</tt>:  This applies to scatter charts only, when the category-axis is calculated like the value-axis.
-#                         This determines the character to use at the left of a decimal fraction (example: 1.5).
-#                         The default is '.' (dot or full stop).
-# <tt>separator</tt>:     This applies to scatter charts only, when the category-axis is calculated like the value-axis.
-#                         This determines the character to place between every group of thousands (example: 1,00,000).
-#                         The default is nothing.
-#
-# See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=axis_category
-# for additional documentation, examples and futher detail.
-# Author:: Fernand Galiana
-# Date::   Dec 15th, 2006
+# Author:: Fernand
 # -----------------------------------------------------------------------------
 module Ziya::Components
+  # Specifies the label attributes on the x or y axis depending on the chart type.
+  # See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=axis_category
+  # for additional documentation, examples and futher detail.  
   class AxisCategory < Base    
     has_attribute :skip, :font, :bold, :size, :color, :alpha, :orientation,
-                  :margin, :min, :max, :steps, :prefix, :suffix, :decimals,
-                  :decimal_char, :separator
+                  :margin, 
+                  :min, :max, :steps, :mode, :prefix, :suffix, :decimals,
+                  :decimal_char, :separator, 
+                  :bevel, :glow, :shadow, :blur
   end
 end

data/lib/ziya/components/axis_ticks.rb

@@ -1,35 +1,33 @@
 # ------------------------------------------------------------------------------

 # Describe the ticks configuration of the chart axis
 #
-# Sets the tick marks on the chart axes.
-#
-# <tt>value_ticks</tt>:       A boolean value that indicates whether the ticks on the value axis are visible or not.
-#                             The default is false.
-# <tt>category_ticks</tt>:    A boolean value that indicates whether the ticks on the category axis are visible or not.
-#                             The default is true.
-# <tt>position</tt>:          A string that determines where on the axis to display the ticks. Valid values are "outside",
-#                             "inside", and "centered".
-#                             The default is "outside".
-# <tt>major_thickness</tt>:   The thickness of major ticks. Major ticks are those appearing with the axis labels.
-#                             The default is 2 pixels.
-# <tt>major_color</tt>:       The color of major ticks. This must be a string holding triple hexadecimal values representing
-#                             the red, green, and blue components for a color.
-#                             The default is "000000" (black).
-# <tt>minor_thickness</tt>:   The thickness of minor ticks. Minor ticks are those appearing between major ticks.
-#                             The default is 1 pixel.
-# <tt>minor_color</tt>:       The color of minor ticks. This must be a string holding triple hexadecimal values representing
-#                             the red, green, and blue components for a color.
-#                             The default is "000000" (black).
-# <tt>minor_count</tt>:       This applies to the value axis only. It sets the number of minor ticks between every 2 major ticks.
-#                             The default is 4. The category axis displays minor ticks only where its labels get skipped.
-#
-# See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=axis_ticks
-# for additional documentation, examples and futher detail.
-#
-# Author:: Fernand Galiana
-# Date::   Dec 15th, 2006
+# Author:: Fernand
 # ------------------------------------------------------------------------------
 module Ziya::Components
+  # Sets the tick marks on the chart axes.
+  #
+  # <tt>value_ticks</tt>:       A boolean value that indicates whether the ticks on the value axis are visible or not.
+  #                             The default is false.
+  # <tt>category_ticks</tt>:    A boolean value that indicates whether the ticks on the category axis are visible or not.
+  #                             The default is true.
+  # <tt>position</tt>:          A string that determines where on the axis to display the ticks. Valid values are "outside",
+  #                             "inside", and "centered".
+  #                             The default is "outside".
+  # <tt>major_thickness</tt>:   The thickness of major ticks. Major ticks are those appearing with the axis labels.
+  #                             The default is 2 pixels.
+  # <tt>major_color</tt>:       The color of major ticks. This must be a string holding triple hexadecimal values representing
+  #                             the red, green, and blue components for a color.
+  #                             The default is "000000" (black).
+  # <tt>minor_thickness</tt>:   The thickness of minor ticks. Minor ticks are those appearing between major ticks.
+  #                             The default is 1 pixel.
+  # <tt>minor_color</tt>:       The color of minor ticks. This must be a string holding triple hexadecimal values representing
+  #                             the red, green, and blue components for a color.
+  #                             The default is "000000" (black).
+  # <tt>minor_count</tt>:       This applies to the value axis only. It sets the number of minor ticks between every 2 major ticks.
+  #                             The default is 4. The category axis displays minor ticks only where its labels get skipped.
+  #
+  # See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=axis_ticks
+  # for additional documentation, examples and futher detail.  
   class AxisTicks < Base  
     has_attribute :value_ticks, :category_ticks, :position, :major_thickness,
                   :major_color, :minor_thickness, :minor_color, :minor_count