Struct rstk::chart::xy_plots::TkXYPlot

pub struct TkXYPlot {
    pub id: String,
}

Refers to an xy_plot

Fields

id: String

Implementations

impl TkXYPlot

pub fn draw_box_and_whiskers_x(&self, series: &str, values: &[f64], y: f64)

Draws a box-and-whiskers image on plot, in x direction.

pub fn draw_box_and_whiskers_y(&self, series: &str, x: f64, values: &[f64])

Draws a box-and-whiskers image on plot, in y direction.

pub fn draw_contour_fill<M: AsRef<[R]>, R: AsRef<[f64]>>(
    &self,
    x_coords: M,
    y_coords: M,
    values: M,
    classes: &[f64]
)

Draws filled contours for the given values on the grid.

• x_coords is a slice of lists of x-coordinates
• y_coords is a slice of lists of y-coordinates
• values is a slice of lists of values at each (x, y) position
• classes is a slice of class levels (leave empty for default).

pub fn draw_contour_lines<M: AsRef<[R]>, R: AsRef<[f64]>>(
    &self,
    x_coords: M,
    y_coords: M,
    values: M,
    classes: &[f64]
)

Draws contour lines for the given values on the grid.

• x_coords is a slice of lists of x-coordinates
• y_coords is a slice of lists of y-coordinates
• values is a slice of lists of values at each (x, y) position
• classes is a slice of class levels (leave empty for default).

pub fn draw_contour_lines_function_values<M: AsRef<[R]>, R: AsRef<[f64]>>(
    &self,
    x_coords: M,
    y_coords: M,
    values: M,
    classes: &[f64]
)

Draws contour lines for the given values on the grid.

• x_coords is a slice of lists of x-coordinates
• y_coords is a slice of lists of y-coordinates
• values is a slice of lists of values at each (x, y) position
• classes is a slice of class levels (leave empty for default).

pub fn draw_dot(&self, series: &str, (x, y): (f64, f64), value: f64)

Draws a dot - value determines symbol/colour.

pub fn draw_grid<M: AsRef<[R]>, R: AsRef<[f64]>>(
    &self,
    x_coords: M,
    y_coords: M
)

Draws grid cells as lines connecting the given coordinates.

• x_coords is a slice of lists of x-coordinates
• y_coords is a slice of lists of y-coordinates

pub fn draw_interval(&self, series: &str, x_coord: f64, y_min: f64, y_max: f64)

Adds a vertical error interval to chart.

• series - name of data series
• x_coord - x-coordinate
• y_min - minimum y-value
• y_max - maximum y-value

pub fn draw_interval_with_symbol(
    &self,
    series: &str,
    x_coord: f64,
    y_min: f64,
    y_max: f64,
    y_centre: f64
)

Adds a vertical error interval to chart with central symbol.

• series - name of data series
• x_coord - x-coordinate
• y_min - minimum y-value
• y_max - maximum y-value
• y_centre - position of symbol

pub fn draw_labelled_dot(
    &self,
    (x, y): (f64, f64),
    label: &str,
    location: Location
)

Draws a dot with a text label.

See TkChartDots for configuration options.

pub fn draw_minmax(&self, series: &str, x_coord: f64, y_min: f64, y_max: f64)

Draws a horizontal band on chart.

• series - name of data series
• x_coord - x-coordinate
• y_min - minimum y-value
• y_max - maximum y-value

pub fn draw_region(&self, series: &str, points: &[(f64, f64)])

Draws a closed polygon, using given points.

pub fn draw_vector(&self, series: &str, (x, y): (f64, f64), (u, v): (f64, f64))

Draws a vector on chart.

• series - name of data series
• (x, y) - coordinate for arrow
• (u, v) - depending on configuration, can be source point or angle, etc.

Use vector_CONFIG methods to alter display of vector.

pub fn legend_isometric_lines<M: AsRef<[R]>, R: AsRef<[f64]>>(
    &self,
    values: M,
    classes: &[f64]
)

Adds contour classes to the legend as coloured lines.

• values is a slice of lists of values at each (x, y) position
• classes is a slice of class levels (leave empty for default).

pub fn legend_shades<M: AsRef<[R]>, R: AsRef<[f64]>>(
    &self,
    values: M,
    classes: &[f64]
)

Adds contour classes to the legend as coloured rectangles.

• values is a slice of lists of values at each (x, y) position
• classes is a slice of class levels (leave empty for default).

pub fn plot(&self, series: &str, (x, y): (f64, f64))

Plots a single point.

pub fn plot_list(&self, series: &str, points: &[(f64, f64)], every: bool)

Plots a list of points.

• every - set to true if a symbol should be drawn for every point

pub fn rchart(&self, series: &str, (x, y): (f64, f64))

Plots a single point, like plot, but includes a +/- s.d. line on chart.

pub fn trend_line(&self, series: &str, (x, y): (f64, f64))

Plots points for a trendline.

pub fn vector_centred(&self, series: &str, value: bool)

Sets whether coordinates specify start or centre of vector arrow.

pub fn vector_colour(&self, series: &str, colour: &str)

Sets colour of vector arrow.

pub fn vector_scale(&self, series: &str, scale: f64)

Sets scale factor for converting vector length into pixels.

pub fn vector_type(&self, series: &str, value: CoordinatesType)

Sets scale factor for converting vector length into pixels.

Trait Implementations

impl Clone for TkXYPlot

fn clone(&self) -> TkXYPlot

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TkXYPlot

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<TkXYPlot> for TkXYPlot

fn eq(&self, other: &TkXYPlot) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &TkXYPlot) -> bool

This method tests for !=.

impl TkChartDots for TkXYPlot

fn dot_colour(&self, series: &str, colour: &str)

Sets colour of dots in given data series.

fn dot_classes(&self, series: &str, values: &[(f64, &str)])

Defines class limits and colours, e.g. [(0.0, “green”), (2.0, “red”), …]

fn dot_effect_3d(&self, series: &str, value: bool)

Sets a 3D effect for dots in given data series.

fn dot_outline(&self, series: &str, value: bool)

Sets whether an outline should be displayed for dots in given data series.

fn dot_radius(&self, series: &str, value: f64)

Sets radius for dots in given data series.

fn dot_scale(&self, series: &str, value: f64)

Sets scale factor of radius to pixels for dots in given data series.

fn dot_scale_by_value(&self, series: &str, value: bool)

Sets whether dots in given data series should all have the same size (false) or be scaled by value (true).

impl TkChartSeries for TkXYPlot

fn series_colour(&self, series: &str, colour: &str)

Sets colour for displaying data series

fn series_drawing_mode(&self, series: &str, mode: DrawingMode)

Sets drawing mode for displaying data series (called “type” in tklib’s plotchart documentation).

fn series_fill_area(&self, series: &str, area: FillArea)

Used to select whether to fill the area above or below the line of data series.

fn series_fill_colour(&self, series: &str, colour: &str)

Sets colour to use when drawing filled area.

fn series_line_width(&self, series: &str, width: u64)

Sets width of line for displaying data series

fn series_symbol(&self, series: &str, symbol: Symbol, radius: u64)

Sets symbol type and radius for displaying data series

impl TkPlotchart for TkXYPlot

fn id(&self) -> &str

Returns the widget’s id reference - used within tk

fn background_axes_colour(&self, colour: &str)

Sets the background colour for the axes.

fn background_gradient_colour(
    &self,
    colour: &str,
    direction: GradientDirection,
    brightness: Brightness
)

Sets a background gradient.

fn background_image(&self, image: &TkImage)

Sets a background image.

fn background_plot_colour(&self, colour: &str)

Sets the background colour for the plot area.

fn balloon(&self, (x, y): (f64, f64), text: &str, direction: Direction)

Creates balloon text (does not work for 3D plots).

fn balloon_arrow_size(&self, value: u64)

Sets arrow-length, in pixels, for balloon text.

fn balloon_background_colour(&self, colour: &str)

Sets background colour of balloon text.

fn balloon_font(&self, font: &TkFont)

Sets font for balloon text.

fn balloon_justify(&self, value: Justify)

Sets justification for balloon text.

fn balloon_outline_colour(&self, colour: &str)

Sets outline colour of balloon text.

fn balloon_margin(&self, value: u64)

Sets width of margin, in pixels, around balloon text.

fn balloon_rim_width(&self, value: u64)

Sets margin size, in pixels, around balloon text.

fn balloon_text_colour(&self, colour: &str)

Sets colour of balloon text.

fn draw_x_band(&self, y_min: f64, y_max: f64)

Draws a horizontal light-grey band.

fn draw_y_band(&self, y_min: f64, y_max: f64)

Draws a vertical light-grey band.

fn erase(&self)

Erases this plot and all associated resources.

fn legend(&self, series: &str, text: &str)

Adds a line to legend for given data series.

fn legend_background(&self, colour: &str)

Sets background colour for legend.

fn legend_border(&self, colour: &str)

Sets border colour for legend.

fn legend_canvas(&self, canvas: &TkCanvas)

Sets canvas on which to draw legend.

fn legend_font(&self, font: &TkFont)

Sets font with which to draw legend.

fn legend_position(&self, value: Position)

Position of legend on display.

fn legend_remove(&self, series: &str)

Removes legend entry for given series.

fn legend_spacing(&self, value: u64)

Sets spacing between rows in legend.

fn legend_type(&mut self, value: LegendType)

Type of legend to display - series identified by line or colour rectangle.

fn plaintext(&self, (x, y): (f64, f64), text: &str, direction: Direction)

Starts definition of plain text (does not work for 3D plots).

fn plaintext_colour(&self, colour: &str)

Sets colour of plain text.

fn plaintext_font(&self, font: &TkFont)

Sets font for plain text.

fn plaintext_justify(&self, value: Justify)

Sets justification for plain text.

fn save(&self, filename: &str)

Saves chart to a file in postscript format.

fn subtitle(&self, text: &str)

Sets subtitle of chart.

fn title(&self, text: &str, placement: Justify)

Sets title of chart.

fn v_subtitle(&self, text: &str)

Sets subtitle of the (vertical) y-axis, and displays vertically along axis.

fn v_title(&self, text: &str)

Sets title of the (vertical) y-axis, and displays vertically along axis.

fn x_format(&self, format: &str)

Sets tcl format string for numbers, see Tk manual

fn x_label_offset(&self, value: f64)

Sets space in pixels between label and tickmark.

fn x_minor_ticks(&self, value: u64)

Sets number of minor tick marks.

fn x_scale(&self, (min, max, step): (f64, f64, f64))

Changes x-axis definition to (min, max, step).

fn x_subtitle(&self, text: &str)

Sets subtitle of the (horizontal) x-axis.

fn x_tick_lines(&self, colour: &str, dash: ChartDash)

Turns on display of vertical ticklines at each tick location.

fn x_tick_length(&self, value: u64)

Sets length in pixels of tick lines.

fn x_title(&self, text: &str)

Sets title of the (horizontal) x-axis.

fn y_format(&self, format: &str)

Sets tcl format string for numbers, see Tk manual

fn y_label_offset(&self, value: f64)

Sets space in pixels between label and tickmark.

fn y_minor_ticks(&self, value: u64)

Sets number of minor tick marks.

fn y_scale(&self, (min, max, step): (f64, f64, f64))

Changes y-axis definition to (min, max, step).

fn y_subtitle(&self, text: &str)

Sets subtitle of the (vertical) y-axis.

fn y_tick_lines(&self, colour: &str, dash: ChartDash)

Turns on display of vertical ticklines at each tick location.

fn y_tick_length(&self, value: u64)

Sets length in pixels of tick lines.

fn y_title(&self, text: &str)

Sets title of the (vertical) y-axis.

impl StructuralPartialEq for TkXYPlot