class Opal::UI::BarChart

Overview

Renders horizontal bar charts with labels, percentage scaling, and values.

Defined in:

opal/ui/components/barchart.cr

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from class Opal::UI::Element

add_class(name : String) : self add_class, children : Array(Element) children, classes : Set(String) classes, classes=(classes : Set(String)) classes=, has_class?(name : String) : Bool has_class?, id : String | Nil id, id=(id : String | Nil) id=, preferred_print_size(available_w : Int32) : Tuple(Int32, Int32) preferred_print_size, preferred_size(available_w : Int32, available_h : Int32) : Tuple(Int32, Int32) preferred_size, print(io : IO = STDOUT, width : Int32 | Nil = nil, color : Bool | Nil = nil, theme : Theme | Nil = nil) : Nil print, query(selector : String) : Array(Element)
query(klass : T.class) : Array(T) forall T query, query_one(selector : String) : Element
query_one(klass : T.class) : T forall T query_one, query_one?(selector : String) : Element | Nil
query_one?(klass : T.class) : T | Nil forall T query_one?, remove_class(name : String) : self remove_class, render(buffer : Buffer, x : Int32, y : Int32, width : Int32, height : Int32) : Nil render, render_print(buffer : Buffer, width : Int32, height : Int32) : Nil render_print, to_print_s(width : Int32 | Nil = nil, color : Bool | Nil = nil, theme : Theme | Nil = nil) : String to_print_s, to_string(width : Int32 | Nil = nil, color : Bool | Nil = nil, theme : Theme | Nil = nil) : String to_string

Instance methods inherited from module Opal::UI::Themable

current_theme : Theme current_theme, style(&block : self -> Nil) : self style, theme : Theme | Nil theme, theme=(theme : Theme | Nil) theme=, with_theme(new_theme : Theme | Symbol | String) : self with_theme

Constructor Detail

def self.new(items : Array(BarItem) = [] of BarItem, title : String | Nil = nil, bar_char : Char = '█', max_value : Float64 | Nil = nil) #

[View source]

Class Method Detail

def self.print(items : Array(BarItem), title : String | Nil = nil, io : IO = STDOUT, width : Int32 | Nil = nil, bar_char : Char = '█', max_value : Float64 | Nil = nil, color : Bool | Nil = nil, theme : Theme | Nil = nil) : Nil #

Class convenience method printing styled barchart directly to IO


[View source]
def self.print(raw_items : Array(Tuple(String, Float64)), title : String | Nil = nil, io : IO = STDOUT, width : Int32 | Nil = nil, bar_char : Char = '█', max_value : Float64 | Nil = nil, color : Bool | Nil = nil, theme : Theme | Nil = nil) : Nil #

Overload printing tuples of {label, value} directly to IO


[View source]
def self.to_string(items : Array(BarItem), title : String | Nil = nil, width : Int32 | Nil = nil, bar_char : Char = '█', max_value : Float64 | Nil = nil, color : Bool | Nil = nil, theme : Theme | Nil = nil) : String #

Class convenience method returning styled barchart string


[View source]
def self.to_string(raw_items : Array(Tuple(String, Float64)), title : String | Nil = nil, width : Int32 | Nil = nil, bar_char : Char = '█', max_value : Float64 | Nil = nil, color : Bool | Nil = nil, theme : Theme | Nil = nil) : String #

Overload accepting tuples of {label, value}


[View source]

Instance Method Detail

def add(label : String, value : Float64, color : Color | Symbol | String = :cyan, formatted_value : String | Nil = nil) : Nil #

[View source]
def bar_char : Char #

[View source]
def items : Array(BarItem) #

[View source]
def max_value : Float64 | Nil #

[View source]
def preferred_print_size(available_w : Int32) : Tuple(Int32, Int32) #

Preferred size in print mode: full item count plus title lines


[View source]
def preferred_size(available_w : Int32, available_h : Int32) : Tuple(Int32, Int32) #

[View source]
def render(buffer : Buffer, x : Int32, y : Int32, width : Int32, height : Int32) : Nil #

[View source]
def title : String | Nil #

[View source]