class Cryplot::Legend

Overview

Class used to specific options for legend

Included Modules

Defined in:

plot/elems/legend.cr

Constructors

Instance Method Summary

Instance methods inherited from module Cryplot::FrameMixin(Cryplot::Legend)

frame_dash_type(value : Int32) frame_dash_type, frame_hide frame_hide, frame_line_color(value : String) frame_line_color, frame_line_style(value : Int32) frame_line_style, frame_line_type(value : Int32) frame_line_type, frame_line_width(value : Int32) frame_line_width, frame_repr frame_repr, frame_show(value = true) frame_show

Constructor methods inherited from module Cryplot::FrameMixin(Cryplot::Legend)

new new

Instance methods inherited from module Cryplot::BaseMixin(Cryplot::Legend)

derived : T derived, repr : String repr, to_s(io : IO) : Nil to_s

Instance methods inherited from module Cryplot::TitleMixin(Cryplot::Legend)

title(text : String) title, title_font_name(name : String) title_font_name, title_font_size(size : Int32) title_font_size, title_repr title_repr, title_shift_along_graph_x(val : Number) title_shift_along_graph_x, title_shift_along_graph_y(val : Number) title_shift_along_graph_y, title_shift_along_screen_x(val : Number) title_shift_along_screen_x, title_shift_along_screen_y(val : Number) title_shift_along_screen_y, title_shift_along_x(val : Number) title_shift_along_x, title_shift_along_y(val : Number) title_shift_along_y, title_text_color(color : String) title_text_color

Instance methods inherited from module Cryplot::BaseMixin(Cryplot::Legend)

derived : T derived, repr : String repr, to_s(io : IO) : Nil to_s

Instance methods inherited from module Cryplot::ShowMixin(Cryplot::Legend)

hidden? : Bool hidden?, hide hide, show(value = true) show, show_repr show_repr

Instance methods inherited from module Cryplot::BaseMixin(Cryplot::Legend)

derived : T derived, repr : String repr, to_s(io : IO) : Nil to_s

Instance methods inherited from module Cryplot::TextMixin(Cryplot::Legend)

enhanced(value : Bool) : T enhanced, text_color(color : String) : T text_color, text_repr : String text_repr

Instance methods inherited from module Cryplot::FontMixin(Cryplot::Legend)

font_name(name : String) : T font_name, font_repr : String font_repr, font_size(size : Int32) : T font_size

Instance methods inherited from module Cryplot::BaseMixin(Cryplot::Legend)

derived : T derived, repr : String repr, to_s(io : IO) : Nil to_s

Constructor Detail

def self.new #

[View source]

Instance Method Detail

def at_bottom #

Place the legend on the inside of the plot at its bottom side.


[View source]
def at_bottom_left #

Place the legend on the inside of the plot at its bottom-left corner.


[View source]
def at_bottom_right #

Place the legend on the inside of the plot at its bottom-right corner.


[View source]
def at_center #

Place the legend on the inside of the plot at its center.


[View source]
def at_left #

Place the legend on the inside of the plot at its left side.


[View source]
def at_outside_bottom #

Place the legend on the outside of the plot at its bottom side.


[View source]
def at_outside_bottom_left #

Place the legend on the outside of the plot at its bottom-left corner.


[View source]
def at_outside_bottom_right #

Place the legend on the outside of the plot at its bottom-right corner.


[View source]
def at_outside_left #

Place the legend on the outside of the plot at its left side.


[View source]
def at_outside_left_bottom #

Place the legend on the outside of the plot at its left-bottom corner.


[View source]
def at_outside_left_top #

Place the legend on the outside of the plot at its left-top corner.


[View source]
def at_outside_right #

Place the legend on the outside of the plot at its right side.


[View source]
def at_outside_right_bottom #

Place the legend on the outside of the plot at its right-bottom corner.


[View source]
def at_outside_right_top #

Place the legend on the outside of the plot at its right-top corner.


[View source]
def at_outside_top #

Place the legend on the outside of the plot at its top side.


[View source]
def at_outside_top_left #

Place the legend on the outside of the plot at its top-left corner.


[View source]
def at_outside_top_right #

Place the legend on the outside of the plot at its top-right corner.


[View source]
def at_right #

Place the legend on the inside of the plot at its right side.


[View source]
def at_top #

Place the legend on the inside of the plot at its top side.


[View source]
def at_top_left #

Place the legend on the inside of the plot at its top-left corner.


[View source]
def at_top_right #

Place the legend on the inside of the plot at its top-right corner.


[View source]
def display_expand_height_by(value : Int32) #

Set the height increment/decrement of the legend frame to either enlarge or reduce its height.


[View source]
def display_expand_width_by(value : Int32) #

Set the width increment/decrement of the legend frame to either enlarge or reduce its width.


[View source]
def display_horizontal #

Set the legend entries to be displayed along the horizontal (in rows).


[View source]
def display_horizontal_max_cols(value : Int32) #

Set the number of columns that trigger a new row to be created in the legend (when using horizontal display).


[View source]
def display_justify_left #

Set the legend labels to be left justified.


[View source]
def display_justify_right #

Set the legend labels to be right justified.


[View source]
def display_labels_after_symbols #

Set the labels in the legend entries to appear after their corresponding symbols (on the right).


[View source]
def display_labels_before_symbols #

Set the labels in the legend entries to appear before their corresponding symbols (on the left).


[View source]
def display_spacing(value : Int32) #

Set the spacing between the titles in the legend.


[View source]
def display_start_from_first #

Set the legend entries to be displayed in the order from first to last.


[View source]
def display_start_from_last #

Set the legend entries to be displayed in the order from last to first.


[View source]
def display_symbol_length(value : Int32) #

Set the length of the samples used to generate the symbols in the legend entries.


[View source]
def display_vertical #

Set the legend entries to be displayed along the vertical (in columns).


[View source]
def display_vertical_max_rows(value : Int32) #

Set the number of rows that trigger a new column to be created in the legend (when using vertical display).


[View source]
def opaque #

Set the background of the legend box to be opaque.


[View source]
def repr : String #
Description copied from module Cryplot::BaseMixin(Cryplot::Legend)

returns a string representation of object of some class


[View source]
def title_center #

Place the legend title on the center.


[View source]
def title_left #

Place the legend title on the left.


[View source]
def title_right #

Place the legend title on the right.


[View source]
def to_s(io : IO) : Nil #
Description copied from class Reference

Appends a short String representation of this object which includes its class name and its object address.

class Person
  def initialize(@name : String, @age : Int32)
  end
end

Person.new("John", 32).to_s # => #<Person:0x10a199f20>

[View source]
def transparent #

Set the background of the legend box to be transparent.


[View source]