class Opal::UI::EquationViewer

Overview

Mathematical equation viewer and interactive 2D function grapher. Features 2D Unicode mathematical typesetting (fractions, integrals, radicals, summations) and interactive Cartesian graphing f(x) with braille sub-pixel rendering, zoom, and pan.

Defined in:

opal/ui/components/equation_viewer.cr

Constant Summary

SUBSCRIPTS = {'0' => '₀', '1' => '₁', '2' => '₂', '3' => '₃', '4' => '₄', '5' => '₅', '6' => '₆', '7' => '₇', '8' => '₈', '9' => '₉', '+' => '₊', '-' => '₋', '=' => '₌', '(' => '₍', ')' => '₎', 'a' => 'ₐ', 'e' => 'ₑ', 'i' => 'ᵢ', 'j' => 'ⱼ', 'k' => 'ₖ', 'n' => 'ₙ', 'x' => 'ₓ'}
SUPERSCRIPTS = {'0' => '⁰', '1' => '¹', '2' => '²', '3' => '³', '4' => '⁴', '5' => '⁵', '6' => '⁶', '7' => '⁷', '8' => '⁸', '9' => '⁹', '+' => '⁺', '-' => '⁻', '=' => '⁼', '(' => '⁽', ')' => '⁾', 'n' => 'ⁿ', 'i' => 'ⁱ', 'x' => 'ˣ', 'y' => 'ʸ'}

Unicode character map for superscripts and subscripts

Constructors

Class Method Summary

Instance Method Summary

Constructor methods inherited from class Opal::UI::Control

new new

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

custom_inputs=(custom_inputs : Bool) custom_inputs=, custom_inputs? : Bool custom_inputs?, default_input_proc : Proc(InputEvent, Bool) | Nil default_input_proc, default_input_proc=(default_input_proc : Proc(InputEvent, Bool) | Nil) default_input_proc=, fallback_to_defaults!(enabled : Bool = true) : self fallback_to_defaults!, fallback_to_defaults=(fallback_to_defaults : Bool) fallback_to_defaults=, fallback_to_defaults? : Bool fallback_to_defaults?, focus : self focus, focused=(focused : Bool) focused=, focused? : Bool focused?, handle_default_input(event : InputEvent) : Bool handle_default_input, handle_input(event : InputEvent) : Bool handle_input, handle_key(key : Terminal::KeyEvent) : Bool handle_key, handle_mouse(event : Terminal::MouseEvent) : Bool handle_mouse, input_hook : Proc(InputEvent, Bool) | Nil input_hook, input_hook=(input_hook : Proc(InputEvent, Bool) | Nil) input_hook=, on_input(&block : self, InputEvent -> Bool) : self on_input, puppet(&block : self, InputEvent -> Bool) : self puppet, reset_inputs : self reset_inputs, setup_default_inputs : Nil setup_default_inputs, unfocus : self unfocus, use_custom_inputs!(enabled : Bool = true) : self use_custom_inputs!

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(function_title : String = "f(x) = sin(x)", x_min : Float64 = -5.0, x_max : Float64 = 5.0, y_min : Float64 = -3.0, y_max : Float64 = 3.0, width : Int32 = 42, height : Int32 = 16, function : Proc(Float64, Float64) | Nil = nil) #

[View source]
def self.new(function_title : String = "f(x) = sin(x)", x_min : Float64 = -5.0, x_max : Float64 = 5.0, y_min : Float64 = -3.0, y_max : Float64 = 3.0, width : Int32 = 42, height : Int32 = 16, &block : Float64 -> Float64) #

[View source]

Class Method Detail

def self.format_super_sub(expr : String) : String #

Converts a regular string with ^(exp) or _(sub) into Unicode super/subscripts


[View source]
def self.sqrt_text(inner : String) : String #

Formats a square root: √(expr) with Unicode overbar


[View source]

Instance Method Detail

def add_fraction(num : String, den : String) : Nil #

Adds a fraction node


[View source]
def add_integral(lower : String, upper : String, integrand : String) : Nil #

Adds an integral node


[View source]
def add_text(text : String) : Nil #

Adds a text node


[View source]
def axis_color : Color #

[View source]
def axis_color=(axis_color : Color) #

[View source]
def border_color : Color #

[View source]
def border_color=(border_color : Color) #

[View source]
def curve_color : Color #

Colors


[View source]
def curve_color=(curve_color : Color) #

Colors


[View source]
def formula_color : Color #

[View source]
def formula_color=(formula_color : Color) #

[View source]
def function : Proc(Float64, Float64) | Nil #

Function to graph: receives float x and returns float y = f(x)


[View source]
def function=(function : Proc(Float64, Float64) | Nil) #

Function to graph: receives float x and returns float y = f(x)


[View source]
def function_title : String #

[View source]
def function_title=(function_title : String) #

[View source]
def grid_color : Color #

[View source]
def grid_color=(grid_color : Color) #

[View source]
def handle_key(key : Terminal::KeyEvent) : Bool #
Description copied from module Opal::UI::InputHookable

Default key event handler. Override in subclasses if not using @default_input_proc.


[View source]
def handle_mouse(event : Terminal::MouseEvent) : Bool #
Description copied from module Opal::UI::InputHookable

Default mouse event handler. Override in subclasses if not using @default_input_proc.


[View source]
def height : Int32 #

[View source]
def height=(height : Int32) #

[View source]
def last_h : Int32 #

[View source]
def last_h=(last_h : Int32) #

[View source]
def last_w : Int32 #

[View source]
def last_w=(last_w : Int32) #

[View source]
def last_x : Int32 #

[View source]
def last_x=(last_x : Int32) #

[View source]
def last_y : Int32 #

[View source]
def last_y=(last_y : Int32) #

[View source]
def math_nodes : Array(MathNode) #

[View source]
def math_nodes=(math_nodes : Array(MathNode)) #

[View source]
def pan(dx_pct : Float64, dy_pct : Float64) : Nil #

Pans viewport


[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 render(buffer : Buffer) : Nil #

[View source]
def show_formula=(show_formula : Bool) #

[View source]
def show_formula? : Bool #

[View source]
def show_graph=(show_graph : Bool) #

Display settings


[View source]
def show_graph? : Bool #

Display settings


[View source]
def width : Int32 #

[View source]
def width=(width : Int32) #

[View source]
def x_max : Float64 #

[View source]
def x_max=(x_max : Float64) #

[View source]
def x_min : Float64 #

Viewport bounds


[View source]
def x_min=(x_min : Float64) #

Viewport bounds


[View source]
def y_max : Float64 #

[View source]
def y_max=(y_max : Float64) #

[View source]
def y_min : Float64 #

[View source]
def y_min=(y_min : Float64) #

[View source]
def zoom(factor : Float64) : Nil #

Zooms in/out


[View source]