mdarray-sol 0.1.0-java

data/lib/sol/base_chart.rb

@@ -0,0 +1,148 @@
+# -*- coding: utf-8 -*-
+
+##########################################################################################
+# @author Rodrigo Botafogo
+#
+# Copyright © 2013 Rodrigo Botafogo. All Rights Reserved. Permission to use, copy, modify, 
+# and distribute this software and its documentation, without fee and without a signed 
+# licensing agreement, is hereby granted, provided that the above copyright notice, this 
+# paragraph and the following two paragraphs appear in all copies, modifications, and 
+# distributions.
+#
+# IN NO EVENT SHALL RODRIGO BOTAFOGO BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, 
+# INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF 
+# THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF RODRIGO BOTAFOGO HAS BEEN ADVISED OF THE 
+# POSSIBILITY OF SUCH DAMAGE.
+#
+# RODRIGO BOTAFOGO SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE 
+# SOFTWARE AND ACCOMPANYING DOCUMENTATION, IF ANY, PROVIDED HEREUNDER IS PROVIDED "AS IS". 
+# RODRIGO BOTAFOGO HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, 
+# OR MODIFICATIONS.
+##########################################################################################
+
+#==========================================================================================
+#
+#==========================================================================================
+
+class Sol
+  
+  module BaseChart
+
+    #------------------------------------------------------------------------------------
+    # Base Mixin
+    # Set or get the height attribute of a chart. The height is applied to the SVG element 
+    # generated by the chart when rendered (or rerendered). If a value is given, then it 
+    # will be used to calculate the new height and the chart returned for method chaining. 
+    # The value can either be a numeric, a function, or falsy. If no value is specified 
+    # then the value of the current height attribute will be returned.
+    #
+    # By default, without an explicit height being given, the chart will select the width 
+    # of its anchor element. If that isn't possible it defaults to 200. Setting the value 
+    # falsy will return the chart to the default behavior
+    #------------------------------------------------------------------------------------
+
+    def height(val = nil)
+      return @properties["height"] if !val
+      @properties["height"] = val
+      return self
+    end
+
+    #------------------------------------------------------------------------------------
+    # Base Mixin
+    # Set the data callback or retrieve the chart's data set. The data callback is passed 
+    # the chart's group and by default will return group.all(). This behavior may be 
+    # modified to, for instance, return only the top 5 groups:
+    #------------------------------------------------------------------------------------
+
+    def data
+    end
+
+    #------------------------------------------------------------------------------------
+    # Base Mixin
+    # Set or get the dimension attribute of a chart. In dc a dimension can be any valid 
+    # crossfilter dimension.
+    # If a value is given, then it will be used as the new dimension. If no value is 
+    # specified then the current dimension will be returned.
+    #------------------------------------------------------------------------------------
+
+    def dimension(val = nil)
+      return @properties["dimension"] if !val
+      @properties["dimension"] = val
+      return self
+    end
+
+    #------------------------------------------------------------------------------------
+    #
+    #------------------------------------------------------------------------------------
+
+    def grouped?
+      @group != nil
+    end
+
+    #------------------------------------------------------------------------------------
+    # Base Mixin
+    # Set or get the group attribute of a chart. In dc a group is a crossfilter group. 
+    # Usually the group should be created from the particular dimension associated with the 
+    # same chart. If a value is given, then it will be used as the new group.
+    # 
+    # If no value specified then the current group will be returned. If name is specified 
+    # then it will be used to generate legend label.
+    #------------------------------------------------------------------------------------
+
+    def group(method, name = nil)
+      
+      @group_name = @name.downcase + "Group"
+      @group = 
+        "var #{@group_name} = #{@dim}.group().#{Sol.camelcase(method.to_s)}(function(d) {return d[\"#{@y_column}\"];});"
+      @properties["group"] = @group_name
+      return self
+
+    end
+
+    #------------------------------------------------------------------------------------
+    # Base Mixin
+    # Set or get the minimum width attribute of a chart. This only applicable if the width 
+    # is calculated by dc.
+    #------------------------------------------------------------------------------------
+
+    def min_width
+
+    end
+
+    #------------------------------------------------------------------------------------
+    # Base Mixin
+    # Set or get the minimum height attribute of a chart. This only applicable if the width 
+    # is calculated by dc.
+    #------------------------------------------------------------------------------------
+
+    def min_height
+
+    end
+
+    #------------------------------------------------------------------------------------
+    # Set or get the animation transition duration(in milliseconds) for this chart instance. 
+    # Default duration is 750ms.
+    #------------------------------------------------------------------------------------
+
+    def transition_duration(val = nil)
+      return @properties["transitionDuration"] if !val
+      @properties["transitionDuration"] = val
+      return self
+    end
+
+    #------------------------------------------------------------------------------------
+    # Base Mixin
+    # Set or get the width attribute of a chart. See .height for further description of 
+    # the behavior.
+    #------------------------------------------------------------------------------------
+
+    def width(val = nil)
+      return @properties["width"] if !val
+      @properties["width"] = val
+      return self
+    end
+
+  end
+
+end

data/lib/sol/chart.rb

@@ -0,0 +1,138 @@
+# -*- coding: utf-8 -*-
+
+##########################################################################################
+# @author Rodrigo Botafogo
+#
+# Copyright © 2013 Rodrigo Botafogo. All Rights Reserved. Permission to use, copy, modify, 
+# and distribute this software and its documentation, without fee and without a signed 
+# licensing agreement, is hereby granted, provided that the above copyright notice, this 
+# paragraph and the following two paragraphs appear in all copies, modifications, and 
+# distributions.
+#
+# IN NO EVENT SHALL RODRIGO BOTAFOGO BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, 
+# INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF 
+# THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF RODRIGO BOTAFOGO HAS BEEN ADVISED OF THE 
+# POSSIBILITY OF SUCH DAMAGE.
+#
+# RODRIGO BOTAFOGO SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE 
+# SOFTWARE AND ACCOMPANYING DOCUMENTATION, IF ANY, PROVIDED HEREUNDER IS PROVIDED "AS IS". 
+# RODRIGO BOTAFOGO HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, 
+# OR MODIFICATIONS.
+##########################################################################################
+
+# Required Mixins for charts
+require_relative "base_chart"
+require_relative "coordinate_chart"
+require_relative "margins"
+require_relative "stack"
+require_relative 'scale'
+require_relative 'interval'
+
+
+#==========================================================================================
+#
+#==========================================================================================
+
+class Sol
+  
+  #==========================================================================================
+  #
+  #==========================================================================================
+
+  class Chart
+    include BaseChart
+
+    def self.build(type, x_column, y_column, name)
+      case type
+      when :line_chart
+        return LineChart.new(type, x_column, y_column, name)
+      when :bar_chart
+        return BarChart.new(type, x_column, y_column, name)
+      else
+        return Chart.new(type, x_column, y_column, name)
+      end
+
+    end
+
+    #------------------------------------------------------------------------------------
+    #
+    #------------------------------------------------------------------------------------
+
+    class << self
+      attr_reader :chart_map
+    end
+
+    @chart_map = {:line_chart => "lineChart", :bar_chart => "barChart"}
+
+    attr_reader :type
+    attr_reader :dim
+    attr_reader :jstype
+    attr_reader :name
+    attr_reader :y_column
+
+    attr_reader :spot
+    attr_reader :properties
+
+    #------------------------------------------------------------------------------------
+    #
+    #------------------------------------------------------------------------------------
+
+    def initialize(type, x_column, y_column, name)
+
+      @type = type
+      @dim = x_column + "Dimension"
+      @jstype = Chart.chart_map[type]
+      @y_column = y_column
+      @name = name
+      @spot = name + "Chart"
+      @properties = Hash.new
+
+      dimension(Sol.camelcase(@dim.to_s))
+      
+    end
+        
+    #------------------------------------------------------------------------------------
+    #
+    #------------------------------------------------------------------------------------
+
+    def props
+
+      # start the chart specification
+      str = @name
+      @properties.each_pair do |key, value|
+        str << "." + "#{key}(#{value})"
+      end
+      str << ";"
+      str
+
+    end
+
+    #------------------------------------------------------------------------------------
+    #
+    #------------------------------------------------------------------------------------
+
+    def header
+
+    <<-EOS
+    var #{@name} = dc.#{@jstype}(\"##{@spot}\"); 
+    #{@group}
+    EOS
+
+    end
+
+    #------------------------------------------------------------------------------------
+    #
+    #------------------------------------------------------------------------------------
+
+    def js_spec
+      gr = header + props
+      gr
+    end
+
+  end
+  
+end
+
+require_relative "line_chart"
+require_relative "bar_chart"

data/lib/sol/coordinate_chart.rb

@@ -0,0 +1,128 @@
+# -*- coding: utf-8 -*-
+
+##########################################################################################
+# @author Rodrigo Botafogo
+#
+# Copyright © 2013 Rodrigo Botafogo. All Rights Reserved. Permission to use, copy, modify, 
+# and distribute this software and its documentation, without fee and without a signed 
+# licensing agreement, is hereby granted, provided that the above copyright notice, this 
+# paragraph and the following two paragraphs appear in all copies, modifications, and 
+# distributions.
+#
+# IN NO EVENT SHALL RODRIGO BOTAFOGO BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, 
+# INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF 
+# THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF RODRIGO BOTAFOGO HAS BEEN ADVISED OF THE 
+# POSSIBILITY OF SUCH DAMAGE.
+#
+# RODRIGO BOTAFOGO SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE 
+# SOFTWARE AND ACCOMPANYING DOCUMENTATION, IF ANY, PROVIDED HEREUNDER IS PROVIDED "AS IS". 
+# RODRIGO BOTAFOGO HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, 
+# OR MODIFICATIONS.
+##########################################################################################
+
+class Sol
+  
+  #==========================================================================================
+  #
+  #==========================================================================================
+
+  module CoordinateChart
+
+    #------------------------------------------------------------------------------------
+    # Turn on/off the brush-based range filter. When brushing is on then user can drag the 
+    # mouse across a chart with a quantitative scale to perform range filtering based on the 
+    # extent of the brush, or click on the bars of an ordinal bar chart or slices of a pie 
+    # chart to filter and unfilter them. However turning on the brush filter will disable 
+    # other interactive elements on the chart such as highlighting, tool tips, and reference 
+    # lines. Zooming will still be possible if enabled, but only via scrolling (panning will 
+    # be disabled.) Default: true
+    #------------------------------------------------------------------------------------
+
+    def brush_on(bool = nil)
+      return @properties["brushOn"] if bool == nil
+      @properties["brushOn"] = bool
+      return self
+    end
+
+    #------------------------------------------------------------------------------------
+    # Get or set the padding in pixels for the clip path. Once set padding will be applied 
+    # evenly to the top, left, right, and bottom when the clip path is generated. If set to 
+    # zero, the clip area will be exactly the chart body area minus the margins. Default: 5
+    #------------------------------------------------------------------------------------
+
+    def clip_padding(val = nil)
+      return @properties["clipPadding"] if !val
+      @properties["clipPadding"] = val
+      return self
+    end
+
+    #------------------------------------------------------------------------------------
+    # Get or set the elasticity on x axis. If this attribute is set to true, then the x 
+    # axis will rescle to auto-fit the data range when filtered.
+    #------------------------------------------------------------------------------------
+
+    def elastic_x(bool = nil)
+      return @properties["elasticX"] if bool == nil
+      @properties["elasticX"] = bool
+      return self
+    end
+
+    #------------------------------------------------------------------------------------
+    # Turn on/off elastic y axis behavior. If y axis elasticity is turned on, then the 
+    # grid chart will attempt to recalculate the y axis range whenever a redraw event is 
+    # triggered.
+    #------------------------------------------------------------------------------------
+    
+    def elastic_y(bool = nil)
+      return @properties["elasticY"] if bool == nil
+      @properties["elasticY"] = bool
+      return self
+    end
+
+    #------------------------------------------------------------------------------------
+    # Defines the x scale for the chart
+    #------------------------------------------------------------------------------------
+
+    def x(type, input_domain = nil, input_range = nil)
+
+      if (type.is_a? Sol::Scale)
+        scale = type
+      else
+        scale = Sol.scale(type)
+        scale.domain(input_domain) if input_domain
+        scale.range(input_range) if input_range
+      end
+      @properties["x"] = scale.spec
+
+      return self
+
+    end
+
+    #------------------------------------------------------------------------------------
+    # Set or get the x axis label. If setting the label, you may optionally include additional 
+    # padding to the margin to make room for the label. By default the padded is set to 12 
+    # to accomodate the text height.
+    #------------------------------------------------------------------------------------
+
+    def x_axis_label(val = nil, padding = 12)
+      return @properties["xAxisLabel"] if !val
+      @properties["xAxisLabel"] = "\"#{val}\""
+      return self
+    end
+
+    #------------------------------------------------------------------------------------
+    # Set or get the y axis label. If setting the label, you may optionally include additional 
+    # padding to the margin to make room for the label. By default the padded is set to 12 to 
+    # accomodate the text height.
+    #------------------------------------------------------------------------------------
+
+    def y_axis_label(val = nil, padding = 12)
+      return @properties["yAxisLabel"] if !val
+      @properties["yAxisLabel"] = "\"#{val}\""
+      return self
+    end
+
+  end
+
+end

data/lib/sol/interval.rb

@@ -0,0 +1,156 @@
+# -*- coding: utf-8 -*-
+
+##########################################################################################
+# @author Rodrigo Botafogo
+#
+# Copyright © 2013 Rodrigo Botafogo. All Rights Reserved. Permission to use, copy, modify, 
+# and distribute this software and its documentation, without fee and without a signed 
+# licensing agreement, is hereby granted, provided that the above copyright notice, this 
+# paragraph and the following two paragraphs appear in all copies, modifications, and 
+# distributions.
+#
+# IN NO EVENT SHALL RODRIGO BOTAFOGO BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, 
+# INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF 
+# THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF RODRIGO BOTAFOGO HAS BEEN ADVISED OF THE 
+# POSSIBILITY OF SUCH DAMAGE.
+#
+# RODRIGO BOTAFOGO SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE 
+# SOFTWARE AND ACCOMPANYING DOCUMENTATION, IF ANY, PROVIDED HEREUNDER IS PROVIDED "AS IS". 
+# RODRIGO BOTAFOGO HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, 
+# OR MODIFICATIONS.
+##########################################################################################
+
+class Sol
+
+  #==========================================================================================
+  #
+  #==========================================================================================
+
+  class Interval
+
+    attr_reader :spec
+
+    #------------------------------------------------------------------------------------
+    #
+    #------------------------------------------------------------------------------------
+
+    def initialize
+      @spec = "d3.time"
+    end
+
+    #------------------------------------------------------------------------------------
+    #
+    #------------------------------------------------------------------------------------
+
+    def second
+      @spec << ".second"
+    end
+
+    #------------------------------------------------------------------------------------
+    #
+    #------------------------------------------------------------------------------------
+
+    def minute
+      @spec << ".minute"
+    end
+
+    #------------------------------------------------------------------------------------
+    #
+    #------------------------------------------------------------------------------------
+
+    def hour
+      @spec << ".hour"
+    end
+
+    #------------------------------------------------------------------------------------
+    #
+    #------------------------------------------------------------------------------------
+
+    def day
+      @spec << ".day"
+    end
+
+    #------------------------------------------------------------------------------------
+    #
+    #------------------------------------------------------------------------------------
+
+    def week
+      @spec << ".week"
+    end
+
+    #------------------------------------------------------------------------------------
+    #
+    #------------------------------------------------------------------------------------
+
+    def sunday
+      @spec << ".sunday"
+    end
+
+    #------------------------------------------------------------------------------------
+    #
+    #------------------------------------------------------------------------------------
+
+    def monday
+      @spec << ".monday"
+    end
+
+    #------------------------------------------------------------------------------------
+    #
+    #------------------------------------------------------------------------------------
+
+    def tuesday
+      @spec << ".tuesday"
+    end
+
+    #------------------------------------------------------------------------------------
+    #
+    #------------------------------------------------------------------------------------
+
+    def wednesday
+      @spec << ".wednesday"
+    end
+
+    #------------------------------------------------------------------------------------
+    #
+    #------------------------------------------------------------------------------------
+
+    def thursday
+      @spec << ".thursday"
+    end
+
+    #------------------------------------------------------------------------------------
+    #
+    #------------------------------------------------------------------------------------
+
+    def friday
+      @spec << ".friday"
+    end
+
+    #------------------------------------------------------------------------------------
+    #
+    #------------------------------------------------------------------------------------
+
+    def saturday
+      @spec << ".saturday"
+    end
+
+    #------------------------------------------------------------------------------------
+    #
+    #------------------------------------------------------------------------------------
+
+    def month
+      @spec << ".month"
+    end
+
+    #------------------------------------------------------------------------------------
+    #
+    #------------------------------------------------------------------------------------
+
+    def year
+      @spec << ".year"
+    end
+
+  end
+
+end