← All compilation units

Flyology_TUI.Components.Sparklines

Description

Appearance

type Appearance is record
   Low    : Flyology_TUI.Styles.Style := Flyology_TUI.Styles.Default;
   Medium : Flyology_TUI.Styles.Style := Flyology_TUI.Styles.Default;
   High   : Flyology_TUI.Styles.Style := Flyology_TUI.Styles.Default;
end record;
Record fields
Low
Medium
High

Automatic

Automatic : constant Scale := (Mode => Automatic_Range);

Fixed

function Fixed
  (Minimum, Maximum : Long_Float) return Scale

Both bounds must be finite and Minimum must be less than Maximum. Invalid bounds raise Components.Structure_Error.

Parameters
Minimum
Maximum
Return value

From_Theme

function From_Theme
  (Theme : Flyology_TUI.Themes.Theme) return Appearance
Parameters
Theme
Return value

Render

function Render
  (Item       : Samples.Series;
   Width      : Natural;
   Scaling    : Scale := Automatic;
   Appearance : Sparklines.Appearance := (others => <>))
   return Flyology_TUI.Surfaces.Surface

Render at most Width newest samples from left to right. Empty cells stay blank. Automatic constant series use the middle (fourth) bar as their baseline. A zero Width is valid and returns a 0-by-1 surface. A non-finite converted sample raises Components.Structure_Error before any sample is mapped to a glyph index.

Parameters
Item
Width
Scaling
Appearance
Return value

Render

function Render
  (Item    : Samples.Series;
   Width   : Natural;
   Scaling : Scale := Automatic;
   Theme   : Flyology_TUI.Themes.Theme)
   return Flyology_TUI.Surfaces.Surface
Parameters
Item
Width
Scaling
Theme
Return value

Samples

with package Samples is new Flyology_TUI.Numeric_Series (<>);

Scale

type Scale (Mode : Scale_Mode := Automatic_Range) is record
   case Mode is
      when Automatic_Range =>
         null;
      when Fixed_Range =>
         Minimum : Long_Float;
         Maximum : Long_Float;
   end case;
end record;
Record fields
Mode
Minimum
Maximum

Scale_Mode

type Scale_Mode is (Automatic_Range, Fixed_Range);
Enumeration literals
Automatic_Range
Fixed_Range

To_Long_Float

function To_Long_Float
(Value : Samples.Value_Type) return Long_Float
Parameters
Value
Return value