glimmer-libui-cc-graphs_and_charts 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13c6855a27c49f14aaa6bc865f8d954a4500a86b99943446a9b9c7d8f153bd87
-  data.tar.gz: 1fb52e2748e28024d4dbd46f9077a4b1e14aae00367487c16b622b514404cf56
+  metadata.gz: bad5c6db427c320e3b452ee60e2b3af416604525c96e74c915b59c905d746b07
+  data.tar.gz: 3659c73cd8a91a9da31c5cf2cb896b04130a7e1a4c58d2f2e92f7b841726de58
 SHA512:
-  metadata.gz: 0ce8817b76f6b9cc5ac0c5fc88223aa4c07625f747d3a79dc95569055862a77e65578543134be4fff45f783a83098d509abf27f7db48fe1bd4fdf1412a4c9fc0
-  data.tar.gz: 933bdaeb6f80038e708b13dee69f43c7532fe2facc25a37f1598858179b9f8efb08d7a3665b085fee975e90c319df5ce08bc2913430103ae42933d52a738d243
+  metadata.gz: 9ff88818e482120a5492d7bb2a789afc89d1a40efed3411d355afcc5db7737ef5f5a5e206a3a2737ccdcaf11a8ba01592a398878b1cd005153d1d3ead08d2728
+  data.tar.gz: b487f6b49b979d6b3a72a2c174f8cd55c558037e2baf2997b6ddaf0a2b2e9ffa243d62ce48558966115a07bfaccf69802682a7d94b0af4043dad29da5e33e909

data/CHANGELOG.md

@@ -1,10 +1,17 @@
 # Change Log
 
+## 0.1.6
+
+- Support passing line `values` as a `Hash` map of x-axis values to y-axis values instead of using the combination of `y_values`, `x_value_start`, and `x_interval_in_seconds`
+- Rename `examples/graphs_and_charts/basic_line_graph.rb` to `examples/graphs_and_charts/basic_line_graph_relative.rb`
+- New `examples/graphs_and_charts/basic_line_graph.rb` (replacing older example that got renamed to `basic_line_graph_relative.rb`)
+- Add graph auto-scaling logic to both `examples/graphs_and_charts/basic_line_graph.rb` & `examples/graphs_and_charts/basic_line_graph_relative.rb`
+
 ## 0.1.5
 
 - Render circles for every point in addition to the lines connecting all the points
 - Render a single point if there is only 1 value in `lines` `y_values` instead of rendering nothing until 2 values exist at least
-- Support `graph_point_radius`, `graph_selected_point_radius`, and `graph_fill_selected_point` options for custimizing the circle of every rendered point and selected point.
+- Support `graph_point_radius`, `graph_selected_point_radius`, and `graph_fill_selected_point` options for customizing the circle of every rendered point and selected point.
 - Avoid rendering on top of the grid markers on the left side
 - Optimize performance of rendering grid markers and showing mouse hover selection stats of a point
 

data/README.md

@@ -1,4 +1,4 @@
-# Graphs and Charts 0.1.5 (Alpha)
+# Graphs and Charts 0.1.6 (Alpha)
 ## [Glimmer DSL for LibUI](https://github.com/AndyObtiva/glimmer-dsl-libui) Custom Controls
 [![Gem Version](https://badge.fury.io/rb/glimmer-libui-cc-graphs_and_charts.svg)](http://badge.fury.io/rb/glimmer-libui-cc-graphs_and_charts)
 [![Join the chat at https://gitter.im/AndyObtiva/glimmer](https://badges.gitter.im/AndyObtiva/glimmer.svg)](https://gitter.im/AndyObtiva/glimmer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
@@ -12,7 +12,7 @@ Graphs and Charts (Custom Controls) for [Glimmer DSL for LibUI](https://github.c
 Add this line to Bundler `Gemfile`:
 
 ```ruby
-gem 'glimmer-libui-cc-graphs_and_charts', '~> 0.1.5'
+gem 'glimmer-libui-cc-graphs_and_charts', '~> 0.1.6'
 ```
 
 Run:
@@ -47,7 +47,7 @@ line_graph(
   width: 900,
   height: 300,
   graph_point_distance: :width_divided_by_point_count,
-  lines: [
+  series: [
     {
       name: 'Feature A',
       stroke: [163, 40, 39, thickness: 2],
@@ -94,7 +94,7 @@ class BasicLineGraph
         width: 900,
         height: 300,
         graph_point_distance: :width_divided_by_point_count,
-        lines: [
+        series: [
           {
             name: 'Feature A',
             stroke: [163, 40, 39, thickness: 2],

data/VERSION

@@ -1 +1 @@
-0.1.5
+0.1.6

data/examples/graphs_and_charts/basic_line_graph.rb

@@ -7,36 +7,43 @@ require 'glimmer/view/line_graph'
 class BasicLineGraph
   include Glimmer::LibUI::Application
   
-  before_body do
-    @start_time = Time.now
-  end
-  
   body {
-    window('Basic Line Graph', 900, 330) {
-      line_graph(
+    window('Basic Line Graph', 900, 300) { |main_window|
+      @line_graph = line_graph(
         width: 900,
         height: 300,
-        graph_point_distance: :width_divided_by_point_count,
         lines: [
           {
-            name: 'Feature A',
+            name: 'Stock 1',
             stroke: [163, 40, 39, thickness: 2],
-            x_value_start: @start_time,
-            x_interval_in_seconds: 8,
+            values: {
+              Time.new(2030, 12, 1) => 80,
+              Time.new(2030, 12, 2) => 36,
+              Time.new(2030, 12, 4) => 10,
+              Time.new(2030, 12, 5) => 60,
+              Time.new(2030, 12, 6) => 20,
+            },
             x_value_format: -> (time) {time.strftime("%a %d %b %Y %T GMT")},
-            y_values: [80, 36, 10, 60, 20, 110, 16, 5, 36, 1, 77, 15, 3, 34, 8, 63, 12, 17, 90, 28, 70]
           },
           {
-            name: 'Feature B',
+            name: 'Stock 2',
             stroke: [47, 109, 104, thickness: 2],
-            x_value_start: @start_time,
-            x_interval_in_seconds: 8,
+            values: {
+              Time.new(2030, 12, 1) => 62,
+              Time.new(2030, 12, 2) => 0,
+              Time.new(2030, 12, 3) => 90,
+              Time.new(2030, 12, 5) => 0,
+              Time.new(2030, 12, 7) => 17,
+            },
             x_value_format: -> (time) {time.strftime("%a %d %b %Y %T GMT")},
-            y_values: [62, 0, 90, 0, 0, 27, 0, 56, 0, 0, 24, 0, 60, 0, 30, 0, 47, 0, 38, 90, 0]
           },
         ],
-        display_attributes_on_hover: true,
       )
+      
+      on_content_size_changed do
+        @line_graph.width = main_window.content_size[0]
+        @line_graph.height = main_window.content_size[1]
+      end
     }
   }
 end

data/examples/graphs_and_charts/basic_line_graph_relative.rb

@@ -0,0 +1,49 @@
+# This line is only needed when running the example from inside the project directory
+$LOAD_PATH.prepend(File.expand_path(File.join(__dir__, '..', '..', 'lib'))) if File.exist?(File.join(__dir__, '..', '..', 'lib'))
+
+require 'glimmer-dsl-libui'
+require 'glimmer/view/line_graph'
+
+class BasicLineGraph
+  include Glimmer::LibUI::Application
+  
+  before_body do
+    @start_time = Time.now
+  end
+  
+  body {
+    window('Basic Line Graph', 900, 330) { |main_window|
+      @line_graph = line_graph(
+        width: 900,
+        height: 300,
+        graph_point_distance: :width_divided_by_point_count,
+        lines: [
+          {
+            name: 'Feature A',
+            stroke: [163, 40, 39, thickness: 2],
+            x_value_start: @start_time,
+            x_interval_in_seconds: 8,
+            x_value_format: -> (time) {time.strftime("%a %d %b %Y %T GMT")},
+            y_values: [80, 36, 10, 60, 20, 110, 16, 5, 36, 1, 77, 15, 3, 34, 8, 63, 12, 17, 90, 28, 70]
+          },
+          {
+            name: 'Feature B',
+            stroke: [47, 109, 104, thickness: 2],
+            x_value_start: @start_time,
+            x_interval_in_seconds: 8,
+            x_value_format: -> (time) {time.strftime("%a %d %b %Y %T GMT")},
+            y_values: [62, 0, 90, 0, 0, 27, 0, 56, 0, 0, 24, 0, 60, 0, 30, 0, 47, 0, 38, 90, 0]
+          },
+        ],
+        display_attributes_on_hover: true,
+      )
+      
+      on_content_size_changed do
+        @line_graph.width = main_window.content_size[0]
+        @line_graph.height = main_window.content_size[1] - 30
+      end
+    }
+  }
+end
+
+BasicLineGraph.launch

data/glimmer-libui-cc-graphs_and_charts.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: glimmer-libui-cc-graphs_and_charts 0.1.5 ruby lib
+# stub: glimmer-libui-cc-graphs_and_charts 0.1.6 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "glimmer-libui-cc-graphs_and_charts".freeze
-  s.version = "0.1.5".freeze
+  s.version = "0.1.6".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Andy Maleh".freeze]
-  s.date = "2023-12-21"
+  s.date = "2023-12-22"
   s.description = "Graphs and Charts (Custom Controls) for Glimmer DSL for LibUI, like Line Graph.".freeze
   s.email = "andy.am@gmail.com".freeze
   s.extra_rdoc_files = [
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
     "README.md",
     "VERSION",
     "examples/graphs_and_charts/basic_line_graph.rb",
+    "examples/graphs_and_charts/basic_line_graph_relative.rb",
     "glimmer-libui-cc-graphs_and_charts.gemspec",
     "lib/glimmer-libui-cc-graphs_and_charts.rb",
     "lib/glimmer/view/line_graph.rb"

data/lib/glimmer/view/line_graph.rb

@@ -131,6 +131,10 @@ module Glimmer
       def clear_drawing_cache
         @graph_point_distance_per_line = nil
         @y_value_max_for_all_lines = nil
+        @x_resolution = nil
+        @x_value_range_for_all_lines = nil
+        @x_value_min_for_all_lines = nil
+        @x_value_max_for_all_lines = nil
         @grid_marker_points = nil
         @points = nil
         @grid_marker_number_values = nil
@@ -145,15 +149,19 @@ module Glimmer
       end
       
       def calculate_graph_point_distance_per_line
-        return unless graph_point_distance == :width_divided_by_point_count
+        return unless lines[0]&.[](:y_values) && graph_point_distance == :width_divided_by_point_count
         
         @graph_point_distance_per_line ||= lines.inject({}) do |hash, line|
           value = (width - 2.0*graph_padding_width - graph_grid_marker_padding_width) / (line[:y_values].size - 1).to_f
-          value = [value, width - 2.0*graph_padding_width - graph_grid_marker_padding_width].min
+          value = [value, drawable_width].min
           hash.merge(line => value)
         end
       end
       
+      def drawable_width
+        width - 2.0*graph_padding_width - graph_grid_marker_padding_width
+      end
+      
       def graph_point_distance_for_line(line)
         @graph_point_distance_per_line&.[](line) || graph_point_distance
       end
@@ -244,7 +252,7 @@ module Glimmer
       def single_line_graph(graph_line)
         last_point = nil
         points = calculate_points(graph_line)
-        points.each do |point|
+        points.to_a.each do |point|
           if last_point
             line(last_point[:x], last_point[:y], point[:x], point[:y]) {
               stroke graph_line[:stroke]
@@ -260,6 +268,14 @@ module Glimmer
       end
       
       def calculate_points(graph_line)
+        if lines[0]&.[](:y_values)
+          calculate_points_relative(graph_line)
+        else
+          calculate_points_absolute(graph_line)
+        end
+      end
+      
+      def calculate_points_relative(graph_line)
         @points ||= {}
         if @points[graph_line].nil?
           y_values = graph_line[:y_values] || []
@@ -275,9 +291,67 @@ module Glimmer
         @points[graph_line]
       end
       
+      def calculate_points_absolute(graph_line)
+        @points ||= {}
+        if @points[graph_line].nil?
+          values = graph_line[:values] || []
+          # all points are visible when :values is supplied because we stretch the graph to show them all
+          graph_y_max = [y_value_max_for_all_lines, 1].max
+          x_value_range_for_all_lines
+          points = values.each_with_index.map do |(x_value, y_value), index|
+            relative_x_value = x_value - x_value_min_for_all_lines
+            stretched_x_value = x_value_range_for_all_lines == 0 ? 0 : relative_x_value.to_f * x_resolution.to_f
+            x = width - graph_padding_width - stretched_x_value
+            y = ((height - graph_padding_height) - y_value * ((height - graph_padding_height * 2) / graph_y_max))
+            {x: x, y: y, index: index, x_value: x_value, y_value: y_value}
+          end
+          # Translation is not supported today
+          # TODO consider supporting in the future
+#           @points[graph_line] = translate_points(graph_line, points)
+          @points[graph_line] = points
+        end
+        @points[graph_line]
+      end
+      
+      # this is the multiplier that we must multiply by the relative_x_value
+      def x_resolution
+        @x_resolution ||= drawable_width.to_f / x_value_range_for_all_lines.to_f
+      end
+      
+      def x_value_range_for_all_lines
+        @x_value_range_for_all_lines ||= x_value_max_for_all_lines - x_value_min_for_all_lines
+      end
+      
+      def x_value_min_for_all_lines
+        if @x_value_min_for_all_lines.nil?
+          line_visible_x_values = lines.map { |line| line[:values].to_h.keys }
+          all_visible_x_values = line_visible_x_values.reduce(:+) || []
+          # Right now, we assume Time objects
+          # TODO support String representations of Time (w/ some auto-detection of format)
+          @x_value_min_for_all_lines = all_visible_x_values.min
+        end
+        @x_value_min_for_all_lines
+      end
+      
+      def x_value_max_for_all_lines
+        if @x_value_max_for_all_lines.nil?
+          line_visible_x_values = lines.map { |line| line[:values].to_h.keys }
+          all_visible_x_values = line_visible_x_values.reduce(:+) || []
+          # Right now, we assume Time objects
+          # TODO support String representations of Time (w/ some auto-detection of format)
+          @x_value_max_for_all_lines = all_visible_x_values.max
+        end
+        @x_value_max_for_all_lines
+      end
+      
       def y_value_max_for_all_lines
         if @y_value_max_for_all_lines.nil?
-          line_visible_y_values = lines.map { |line| line[:y_values][0, max_visible_point_count(line)] }
+          if lines[0]&.[](:y_values)
+            line_visible_y_values = lines.map { |line| line[:y_values][0, max_visible_point_count(line)] }
+          else
+            # When using :values , we always stretch the graph so that all points are visible
+            line_visible_y_values = lines.map { |line| line[:values].to_h.values }
+          end
           all_visible_y_values = line_visible_y_values.reduce(:+) || []
           @y_value_max_for_all_lines = all_visible_y_values.max.to_f
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-libui-cc-graphs_and_charts
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-21 00:00:00.000000000 Z
+date: 2023-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer-dsl-libui
@@ -81,6 +81,7 @@ files:
 - README.md
 - VERSION
 - examples/graphs_and_charts/basic_line_graph.rb
+- examples/graphs_and_charts/basic_line_graph_relative.rb
 - glimmer-libui-cc-graphs_and_charts.gemspec
 - lib/glimmer-libui-cc-graphs_and_charts.rb
 - lib/glimmer/view/line_graph.rb