glimmer-libui-cc-graphs_and_charts 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bad5c6db427c320e3b452ee60e2b3af416604525c96e74c915b59c905d746b07
-  data.tar.gz: 3659c73cd8a91a9da31c5cf2cb896b04130a7e1a4c58d2f2e92f7b841726de58
+  metadata.gz: c2a02d818ffec27e5d64eafa181c90e1362b62ea8f201018fe92705b0d95a664
+  data.tar.gz: 6de4a548a1c74d91cc389663d9917311bd66523402ba984ac05a250d8cff5baa
 SHA512:
-  metadata.gz: 9ff88818e482120a5492d7bb2a789afc89d1a40efed3411d355afcc5db7737ef5f5a5e206a3a2737ccdcaf11a8ba01592a398878b1cd005153d1d3ead08d2728
-  data.tar.gz: b487f6b49b979d6b3a72a2c174f8cd55c558037e2baf2997b6ddaf0a2b2e9ffa243d62ce48558966115a07bfaccf69802682a7d94b0af4043dad29da5e33e909
+  metadata.gz: 738a36dedf90e91774876d7cc41f545edb00ac03d65cd6bf89eaf30eac5374b4abfa591d007d971476a02dd854ca14a262a7fcda34fdc24ac531b17509ee0dcf
+  data.tar.gz: 2039bf32f7d8fb7930c24fda0eba1def6c30db968d452cb219a7ceab604bfed450b87b8d68ae061d75017ea59f6161d46b9fbebd8ab5581727116ebfd32fec82

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 0.1.7
+
+- Scale `y` axis when using `values` option to fill up the vertical graph height if all y-axis values are smaller than `1`
+
 ## 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`

data/README.md

@@ -1,18 +1,18 @@
-# Graphs and Charts 0.1.6 (Alpha)
+# Graphs and Charts 0.1.7 (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)
 
 Graphs and Charts (Custom Controls) for [Glimmer DSL for LibUI](https://github.com/AndyObtiva/glimmer-dsl-libui)
 
-![line graph](/screenshots/glimmer-libui-cc-graphs_and_charts-mac-basic-line-graph.png)
+![line graph](/screenshots/glimmer-libui-cc-graphs_and_charts-mac-basic-line-graph-relative.png)
 
 ## Setup
 
 Add this line to Bundler `Gemfile`:
 
 ```ruby
-gem 'glimmer-libui-cc-graphs_and_charts', '~> 0.1.6'
+gem 'glimmer-libui-cc-graphs_and_charts', '~> 0.1.7'
 ```
 
 Run:
@@ -42,6 +42,53 @@ require 'glimmer/view/line_graph'
 This makes the `line_graph` [Glimmer DSL for LibUI Custom Control](https://github.com/AndyObtiva/glimmer-dsl-libui#custom-components) available in the Glimmer GUI DSL.
 You can then nest `line_graph` under `window` or some container like `vertical_box`. By the way, `line_graph` is implemented on top of the [`area` Glimmer DSL for LibUI control](https://github.com/AndyObtiva/glimmer-dsl-libui#area-api).
 
+Note that you can use in absolute mode or relative mode for determining x-axis values starting from newest point to oldest point along the time x-axis:
+- Absolute Mode: pass `values` which maps x-axis values to y-axis values
+- Relative Mode: pass `y_values`, `x_value_start`, and `x_interval_in_seconds` (x-axis values are calculated automatically in a uniform way from `x_value_start` deducting `x_interval_in_seconds`)
+
+**Absolute Mode:**
+
+It supports any `Numeric` y-axis values in addition to `Time` x-axis values.
+
+```ruby
+      @line_graph = line_graph(
+        width: 900,
+        height: 300,
+        lines: [
+          {
+            name: 'Stock 1',
+            stroke: [163, 40, 39, thickness: 2],
+            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")},
+          },
+          {
+            name: 'Stock 2',
+            stroke: [47, 109, 104, thickness: 2],
+            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")},
+          },
+        ],
+      )
+```
+
+![basic line graph](/screenshots/glimmer-libui-cc-graphs_and_charts-mac-basic-line-graph.png)
+
+**Relative Mode:**
+
+Currently, it only supports `Integer` y-axis values in addition to `Time` x-axis values.
+
 ```ruby
 line_graph(
   width: 900,
@@ -69,11 +116,11 @@ line_graph(
 )
 ```
 
-![basic line graph](/screenshots/glimmer-libui-cc-graphs_and_charts-mac-basic-line-graph.png)
+![basic line graph relative](/screenshots/glimmer-libui-cc-graphs_and_charts-mac-basic-line-graph-relative.png)
 
 Look into [lib/glimmer/view/line_graph.rb](/lib/glimmer/view/line_graph.rb) to learn about all supported options.
 
-Basic Line Graph Example:
+**Basic Line Graph Example:**
 
 [examples/graphs_and_charts/basic_line_graph.rb](/examples/graphs_and_charts/basic_line_graph.rb)
 
@@ -81,6 +128,61 @@ Basic Line Graph Example:
 require 'glimmer-dsl-libui'
 require 'glimmer/view/line_graph'
 
+class BasicLineGraph
+  include Glimmer::LibUI::Application
+  
+  body {
+    window('Basic Line Graph', 900, 300) { |main_window|
+      @line_graph = line_graph(
+        width: 900,
+        height: 300,
+        lines: [
+          {
+            name: 'Stock 1',
+            stroke: [163, 40, 39, thickness: 2],
+            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")},
+          },
+          {
+            name: 'Stock 2',
+            stroke: [47, 109, 104, thickness: 2],
+            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")},
+          },
+        ],
+      )
+      
+      on_content_size_changed do
+        @line_graph.width = main_window.content_size[0]
+        @line_graph.height = main_window.content_size[1]
+      end
+    }
+  }
+end
+
+BasicLineGraph.launch
+```
+
+![basic line graph](/screenshots/glimmer-libui-cc-graphs_and_charts-mac-basic-line-graph.png)
+
+**Basic Line Graph Relative Example:**
+
+```ruby
+require 'glimmer-dsl-libui'
+require 'glimmer/view/line_graph'
+
 class BasicLineGraph
   include Glimmer::LibUI::Application
   
@@ -121,7 +223,7 @@ end
 BasicLineGraph.launch
 ```
 
-![basic line graph](/screenshots/glimmer-libui-cc-graphs_and_charts-mac-basic-line-graph.png)
+![basic line graph relative](/screenshots/glimmer-libui-cc-graphs_and_charts-mac-basic-line-graph-relative.png)
 
 Contributing to glimmer-libui-cc-graphs_and_charts
 ------------------------------------------

data/VERSION

@@ -1 +1 @@
-0.1.6
+0.1.7

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.6 ruby lib
+# stub: glimmer-libui-cc-graphs_and_charts 0.1.7 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "glimmer-libui-cc-graphs_and_charts".freeze
-  s.version = "0.1.6".freeze
+  s.version = "0.1.7".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-22"
+  s.date = "2023-12-23"
   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 = [

data/lib/glimmer/view/line_graph.rb

@@ -132,6 +132,7 @@ module Glimmer
         @graph_point_distance_per_line = nil
         @y_value_max_for_all_lines = nil
         @x_resolution = nil
+        @y_resolution = nil
         @x_value_range_for_all_lines = nil
         @x_value_min_for_all_lines = nil
         @x_value_max_for_all_lines = nil
@@ -153,15 +154,19 @@ module Glimmer
         
         @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, drawable_width].min
+          value = [value, width_drawable].min
           hash.merge(line => value)
         end
       end
       
-      def drawable_width
+      def width_drawable
         width - 2.0*graph_padding_width - graph_grid_marker_padding_width
       end
       
+      def height_drawable
+        height - 2.0*graph_padding_height
+      end
+      
       def graph_point_distance_for_line(line)
         @graph_point_distance_per_line&.[](line) || graph_point_distance
       end
@@ -184,8 +189,15 @@ module Glimmer
         @grid_marker_numbers ||= []
         @graph_stroke_marker_values ||= []
         @mod_values ||= []
+        if lines && lines.all? {|line| line[:values]} && !y_value_max_for_all_lines.nil? && y_value_max_for_all_lines > 1
+          return
+        end
         grid_marker_points.each_with_index do |marker_point, index|
-          @grid_marker_number_values[index] ||= (grid_marker_points.size - index).to_i
+          @grid_marker_number_values[index] ||= begin
+            value = (grid_marker_points.size - index).to_i
+            value = y_value_max_for_all_lines if !y_value_max_for_all_lines.nil? && y_value_max_for_all_lines.to_i != y_value_max_for_all_lines && grid_marker_points.size == 1
+            value
+          end
           grid_marker_number_value = @grid_marker_number_values[index]
           @grid_marker_numbers[index] ||= (grid_marker_number_value >= 1000) ? "#{grid_marker_number_value / 1000}K" : grid_marker_number_value.to_s
           grid_marker_number = @grid_marker_numbers[index]
@@ -215,7 +227,7 @@ module Glimmer
               stroke graph_stroke_marker_line
             }
           end
-          if grid_marker_number_value % mod_value == comparison_value
+          if grid_marker_number_value % mod_value == comparison_value || grid_marker_number_value != grid_marker_number_value.to_i
             grid_marker_number_width = estimate_width_of_text(grid_marker_number, grid_marker_number_font)
             text(marker_point[:x] + 4 + 3, marker_point[:y] - 6, grid_marker_number_width) {
               string(grid_marker_number) {
@@ -229,10 +241,10 @@ module Glimmer
       
       def grid_marker_points
         if @grid_marker_points.nil?
-          graph_max = [y_value_max_for_all_lines, 1].max
+          graph_y_max = [y_value_max_for_all_lines, y_value_max_for_all_lines.between?(0, 1) ? y_value_max_for_all_lines : 1].max
           current_graph_height = (height - graph_padding_height * 2)
-          division_height = current_graph_height / graph_max
-          @grid_marker_points = graph_max.to_i.times.map do |marker_index|
+          division_height = current_graph_height / graph_y_max
+          @grid_marker_points = graph_y_max.ceil.times.map do |marker_index|
             x = graph_padding_width
             y = graph_padding_height + marker_index * division_height
             {x: x, y: y}
@@ -280,10 +292,10 @@ module Glimmer
         if @points[graph_line].nil?
           y_values = graph_line[:y_values] || []
           y_values = y_values[0, max_visible_point_count(graph_line)]
-          graph_max = [y_value_max_for_all_lines, 1].max
+          graph_y_max = [y_value_max_for_all_lines, 1].max
           points = y_values.each_with_index.map do |y_value, index|
             x = width - graph_padding_width - (index * graph_point_distance_for_line(graph_line))
-            y = ((height - graph_padding_height) - y_value * ((height - graph_padding_height * 2) / graph_max))
+            y = ((height - graph_padding_height) - y_value * ((height - graph_padding_height * 2) / graph_y_max))
             {x: x, y: y, index: index, y_value: y_value}
           end
           @points[graph_line] = translate_points(graph_line, points)
@@ -300,9 +312,10 @@ module Glimmer
           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))
+            scaled_x_value = x_value_range_for_all_lines == 0 ? 0 : relative_x_value.to_f * x_resolution.to_f
+            scaled_y_value = y_value_max_for_all_lines == 0 ? 0 : y_value.to_f * y_resolution.to_f
+            x = width - graph_padding_width - scaled_x_value
+            y = height - graph_padding_height - scaled_y_value
             {x: x, y: y, index: index, x_value: x_value, y_value: y_value}
           end
           # Translation is not supported today
@@ -313,9 +326,15 @@ module Glimmer
         @points[graph_line]
       end
       
-      # this is the multiplier that we must multiply by the relative_x_value
+      # 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
+        @x_resolution ||= width_drawable.to_f / x_value_range_for_all_lines.to_f
+      end
+      
+      # this is the multiplier that we must multiply by the relative y value
+      def y_resolution
+        # TODO in the future, we will use the y range, but today, we assume it starts at 0
+        @y_resolution ||= height_drawable.to_f / y_value_max_for_all_lines.to_f
       end
       
       def x_value_range_for_all_lines

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-libui-cc-graphs_and_charts
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-22 00:00:00.000000000 Z
+date: 2023-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer-dsl-libui