Struct gnuplot::Axes2D
[−]
[src]
pub struct Axes2D { // some fields omitted }
2D axes that is used for drawing 2D plots
Methods
impl Axes2D
[src]
fn set_border<'l>(&'l mut self, front: bool, locations: &[BorderLocation2D], options: &[PlotOption]) -> &'l mut Axes2D
Sets the properties of the plot border
Arguments
front
- Whether or not to draw the border above or below the plot contentslocations
- Which locations of the border to drawoptions
- Array of PlotOption controlling the appearance of the border. Relevant options are:Color
- Specifies the color of the borderLineStyle
- Specifies the style of the borderLineWidth
- Specifies the width of the border
fn set_x_axis<'l>(&'l mut self, show: bool, options: &[PlotOption]) -> &'l mut Axes2D
Sets the properties of x axis.
Arguments
show
- Whether or not draw the axisoptions
- Array of PlotOption controlling the appearance of the axis. Relevant options are:Color
- Specifies the color of the borderLineStyle
- Specifies the style of the borderLineWidth
- Specifies the width of the border
fn set_y_axis<'l>(&'l mut self, show: bool, options: &[PlotOption]) -> &'l mut Axes2D
Like set_x_axis
but for the y axis.
fn arrow<'l>(&'l mut self, x1: Coordinate, y1: Coordinate, x2: Coordinate, y2: Coordinate, options: &[PlotOption]) -> &'l mut Axes2D
Adds an arrow to the plot. The arrow is drawn from (x1, y1)
to (x2, y2)
with the arrow point towards (x2, y2)
.
Arguments
x1
- X coordinate of the arrow starty1
- Y coordinate of the arrow startx2
- X coordinate of the arrow endy2
- Y coordinate of the arrow endoptions
- Array of PlotOption controlling the appearance of the arrowhead and arrow shaft. Relevant options are:ArrowType
- Specifies the style of the arrow head (or an option to omit it)ArrowSize
- Sets the size of the arrow head (in graph units)Color
- Specifies the color of the arrowLineStyle
- Specifies the style of the arrow shaftLineWidth
- Specifies the width of the arrow shaft
fn set_legend<'l>(&'l mut self, x: Coordinate, y: Coordinate, legend_options: &'l [LegendOption], text_options: &'l [LabelOption]) -> &'l mut Axes2D
Specifies the location and other properties of the legend
Arguments
x
- X coordinate of the legendy
- Y coordinate of the legendlabel_options
- Array of LegendOption optionstext_options
- Array of LabelOption options specifying the appearance of the plot titles. Valid options are:Font
TextColor
TextAlign(AlignLeft)
TextAlign(AlignRight)
fn lines<'l, Tx: DataType, X: IntoIterator<Item=Tx>, Ty: DataType, Y: IntoIterator<Item=Ty>>(&'l mut self, x: X, y: Y, options: &[PlotOption]) -> &'l mut Axes2D
Plot a 2D scatter-plot with lines connecting each data point
Arguments
x
- x valuesy
- y valuesoptions
- Array of PlotOption controlling the appearance of the plot element. The relevant options are:Caption
- Specifies the caption for this dataset. Use an empty string to hide it (default).LineWidth
- Sets the width of the lineLineStyle
- Sets the style of the lineColor
- Sets the color
fn points<'l, Tx: DataType, X: IntoIterator<Item=Tx>, Ty: DataType, Y: IntoIterator<Item=Ty>>(&'l mut self, x: X, y: Y, options: &[PlotOption]) -> &'l mut Axes2D
Plot a 2D scatter-plot with a point standing in for each data point
Arguments
x
- x valuesy
- y valuesoptions
- Array of PlotOption controlling the appearance of the plot element. The relevant options are:Caption
- Specifies the caption for this dataset. Use an empty string to hide it (default).PointSymbol
- Sets symbol for each pointPointSize
- Sets the size of each pointColor
- Sets the color
fn lines_points<'l, Tx: DataType, X: IntoIterator<Item=Tx>, Ty: DataType, Y: IntoIterator<Item=Ty>>(&'l mut self, x: X, y: Y, options: &[PlotOption]) -> &'l mut Axes2D
A combination of lines and points methods (drawn in that order).
Arguments
x
- x valuesy
- y valuesoptions
- Array of PlotOption controlling the appearance of the plot element
fn x_error_lines<'l, Tx: DataType, X: IntoIterator<Item=Tx>, Ty: DataType, Y: IntoIterator<Item=Ty>, Txe: DataType, XE: IntoIterator<Item=Txe>>(&'l mut self, x: X, y: Y, x_error: XE, options: &[PlotOption]) -> &'l mut Axes2D
Plot a 2D scatter-plot with a point standing in for each data point and lines connecting each data point. Additionally, error bars are attached to each data point in the X direction.
Arguments
x
- x valuesy
- y valuessx_error
- Errors associated with the x valueoptions
- Array of PlotOption controlling the appearance of the plot element. The relevant options are:Caption
- Specifies the caption for this dataset. Use an empty string to hide it (default).PointSymbol
- Sets symbol for each pointPointSize
- Sets the size of each pointLineWidth
- Sets the width of the lineLineStyle
- Sets the style of the lineColor
- Sets the color
fn y_error_lines<'l, Tx: DataType, X: IntoIterator<Item=Tx>, Ty: DataType, Y: IntoIterator<Item=Ty>, Tye: DataType, YE: IntoIterator<Item=Tye>>(&'l mut self, x: X, y: Y, y_error: YE, options: &[PlotOption]) -> &'l mut Axes2D
Plot a 2D scatter-plot with a point standing in for each data point and lines connecting each data point. Additionally, error bars are attached to each data point in the Y direction.
Arguments
x
- x valuesy
- y valuesy_error
- Errors associated with the y valuesoptions
- Array of PlotOption controlling the appearance of the plot element. The relevant options are:Caption
- Specifies the caption for this dataset. Use an empty string to hide it (default).PointSymbol
- Sets symbol for each pointPointSize
- Sets the size of each pointLineWidth
- Sets the width of the lineLineStyle
- Sets the style of the lineColor
- Sets the color
fn fill_between<'l, Tx: DataType, X: IntoIterator<Item=Tx>, Tyl: DataType, YL: IntoIterator<Item=Tyl>, Tyh: DataType, YH: IntoIterator<Item=Tyh>>(&'l mut self, x: X, y_lo: YL, y_hi: YH, options: &[PlotOption]) -> &'l mut Axes2D
Plot a 2D scatter-plot of two curves (bound by y_lo
and y_hi
) with a filled region between them.
FillRegion
plot option can be used to control what happens when the curves intersect. If set to Above, then the y_lo < y_hi
region is filled.
If set to Below, then the y_lo > y_hi
region is filled. Otherwise both regions are filled.
Arguments
x
- x valuesy_lo
- Bottom y valuesy_hi
- Top y valuesoptions
- Array of PlotOption controlling the appearance of the plot element. The relevant options are:Caption
- Specifies the caption for this dataset. Use an empty string to hide it (default).FillRegion
- Specifies the region between the two curves to fillColor
- Sets the color of the filled regionFillAlpha
- Sets the transparency of the filled region
fn boxes<'l, Tx: DataType, X: IntoIterator<Item=Tx>, Ty: DataType, Y: IntoIterator<Item=Ty>>(&'l mut self, x: X, y: Y, options: &[PlotOption]) -> &'l mut Axes2D
Plot a 2D scatter-plot using boxes of automatic width. Box widths are set so that there are no gaps between successive boxes (i.e. each box may have a different width). Boxes start at the x-axis and go towards the y value of the datapoint.
Arguments
x
- x values (center of the box)y
- y valuesoptions
- Array of PlotOption controlling the appearance of the plot element. The relevant options are:Caption
- Specifies the caption for this dataset. Use an empty string to hide it (default).LineWidth
- Sets the width of the borderLineStyle
- Sets the style of the borderBorderColor
- Sets the color of the borderColor
- Sets the color of the box fillFillAlpha
- Sets the transparency of the box fill
fn boxes_set_width<'l, Tx: DataType, X: IntoIterator<Item=Tx>, Ty: DataType, Y: IntoIterator<Item=Ty>, Tw: DataType, W: IntoIterator<Item=Tw>>(&'l mut self, x: X, y: Y, w: W, options: &[PlotOption]) -> &'l mut Axes2D
Plot a 2D scatter-plot using boxes of set (per box) width. Boxes start at the x-axis and go towards the y value of the datapoint.
Arguments
x
- x values (center of the box)y
- y valuesw
- Box width valuesoptions
- Array of PlotOption controlling the appearance of the plot element. The relevant options are:Caption
- Specifies the caption for this dataset. Use an empty string to hide it (default).LineWidth
- Sets the width of the borderLineStyle
- Sets the style of the borderBorderColor
- Sets the color of the borderColor
- Sets the color of the box fillFillAlpha
- Sets the transparency of the box fill
fn image<'l, T: DataType, X: IntoIterator<Item=T>>(&'l mut self, mat: X, num_rows: usize, num_cols: usize, dimensions: Option<(f64, f64, f64, f64)>, options: &[PlotOption]) -> &'l mut Axes2D
Draws an image from a rectangular array of data by connecting the individual datapoints with polygons.
Arguments:
mat
- Row-major 2D array signifying the value of the datapoints. The X and Y coordinates of the datapoints are determined automatically, and optionally scaled using thedimensions
argument.num_rows
- Number of rows in the data arraynum_cols
- Number of columns in the data arraydimensions
- Optional X and Y coordinates of the first and last data points (with the rest of the coordinates spaced evenly between). By default this will be(0, 0)
and(num_rows - 1, num_cols - 1)
.options
- Array of PlotOption controlling the appearance of the surface. Relevant options are:Caption
- Specifies the caption for this dataset. Use an empty string to hide it (default).
Trait Implementations
impl AxesCommon for Axes2D
[src]
fn set_pos_grid<'l>(&'l mut self, nrow: u32, ncol: u32, pos: u32) -> &'l mut Self
Set the position of the axes on the figure using grid coordinates. # Arguments * nrow
- Number of rows in the grid. Must be greater than 0. * ncol
- Number of columns in the grid. Must be greater than 0. * pos
- Which grid cell to place this axes in, counting from top-left corner, going left and then down, starting at 0. Read more
fn set_pos<'l>(&'l mut self, x: f64, y: f64) -> &'l mut Self
Set the position of the axes on the figure using screen coordinates. The coordinates refer to the bottom-left corner of the axes # Arguments * x
- X position. Ranges from 0 to 1 * y
- Y position. Ranges from 0 to 1 Read more
fn set_size<'l>(&'l mut self, w: f64, h: f64) -> &'l mut Self
Set the size of the axes # Arguments * w
- Width. Ranges from 0 to 1 * h
- Height. Ranges from 0 to 1 Read more
fn set_aspect_ratio<'l>(&'l mut self, ratio: AutoOption<f64>) -> &'l mut Self
Set the aspect ratio of the axes # Arguments * ratio
- The aspect ratio. Set to Auto to return the ratio to default Read more
fn set_x_label<'l>(&'l mut self, text: &str, options: &[LabelOption]) -> &'l mut Self
Set the label for the X axis # Arguments * text
- Text of the label. Pass an empty string to hide the label * options
- Array of LabelOption controlling the appearance of the label. Relevant options are: * Offset
- Specifies the offset of the label * Font
- Specifies the font of the label * TextColor
- Specifies the color of the label * Rotate
- Specifies the rotation of the label * Align
- Specifies how to align the label Read more
fn set_y_label<'l>(&'l mut self, text: &str, options: &[LabelOption]) -> &'l mut Self
Like set_x_label
, but for the Y axis
fn set_cb_label<'l>(&'l mut self, text: &str, options: &[LabelOption]) -> &'l mut Self
Like set_x_label
, but for the color bar
fn set_title<'l>(&'l mut self, text: &str, options: &[LabelOption]) -> &'l mut Self
Set the title for the axes # Arguments * text
- Text of the title. Pass an empty string to hide the title * options
- Array of LabelOption controlling the appearance of the title. Relevant options are: * Offset
- Specifies the offset of the label * Font
- Specifies the font of the label * TextColor
- Specifies the color of the label * Rotate
- Specifies the rotation of the label * Align
- Specifies how to align the label Read more
fn label<'l>(&'l mut self, text: &str, x: Coordinate, y: Coordinate, options: &[LabelOption]) -> &'l mut Self
Adds a label to the plot, with an optional marker. # Arguments * text
- Text of the label * x
- X coordinate of the label * y
- Y coordinate of the label * options
- Array of LabelOption controlling the appearance of the label. Relevant options are: * Offset
- Specifies the offset of the label * Font
- Specifies the font of the label * TextColor
- Specifies the color of the label * Rotate
- Specifies the rotation of the label * Align
- Specifies how to align the label * MarkerSymbol
- Specifies the symbol for the marker. Omit to hide the marker * MarkerSize
- Specifies the size for the marker * MarkerColor
- Specifies the color for the marker Read more
fn set_x_ticks<'l>(&'l mut self, tick_placement: Option<(AutoOption<f64>, u32)>, tick_options: &[TickOption], label_options: &[LabelOption]) -> &'l mut Self
Sets the properties of the ticks on the X axis. Read more
fn set_y_ticks<'l>(&'l mut self, tick_placement: Option<(AutoOption<f64>, u32)>, tick_options: &[TickOption], label_options: &[LabelOption]) -> &'l mut Self
Like set_x_ticks
but for the Y axis.
fn set_cb_ticks<'l>(&'l mut self, tick_placement: Option<(AutoOption<f64>, u32)>, tick_options: &[TickOption], label_options: &[LabelOption]) -> &'l mut Self
Like set_x_ticks
but for the color bar axis.
fn set_x_ticks_custom<'l, T: DataType, TL: IntoIterator<Item=Tick<T>>>(&'l mut self, ticks: TL, tick_options: &[TickOption], label_options: &[LabelOption]) -> &'l mut Self
Sets ticks on the X axis with specified labels at specified positions. Read more
fn set_y_ticks_custom<'l, T: DataType, TL: IntoIterator<Item=Tick<T>>>(&'l mut self, ticks: TL, tick_options: &[TickOption], label_options: &[LabelOption]) -> &'l mut Self
Like set_x_ticks_custom
but for the the Y axis.
fn set_cb_ticks_custom<'l, T: DataType, TL: IntoIterator<Item=Tick<T>>>(&'l mut self, ticks: TL, tick_options: &[TickOption], label_options: &[LabelOption]) -> &'l mut Self
Like set_x_ticks_custom
but for the the color bar axis.
fn set_x_range<'l>(&'l mut self, min: AutoOption<f64>, max: AutoOption<f64>) -> &'l mut Self
Set the range of values for the X axis. Read more
fn set_y_range<'l>(&'l mut self, min: AutoOption<f64>, max: AutoOption<f64>) -> &'l mut Self
Set the range of values for the Y axis. Read more
fn set_cb_range<'l>(&'l mut self, min: AutoOption<f64>, max: AutoOption<f64>) -> &'l mut Self
Set the range of values for the color bar axis. Read more
fn set_x_log<'l>(&'l mut self, base: Option<f64>) -> &'l mut Self
Sets the X axis be logarithmic. Note that the range must be non-negative for this to be valid. Read more
fn set_y_log<'l>(&'l mut self, base: Option<f64>) -> &'l mut Self
Sets the Y axis be logarithmic. Note that the range must be non-negative for this to be valid. Read more
fn set_cb_log<'l>(&'l mut self, base: Option<f64>) -> &'l mut Self
Sets the color bar axis be logarithmic. Note that the range must be non-negative for this to be valid. Read more
fn set_palette(&mut self, palette: PaletteType) -> &mut Self
Sets the palette used for 3D surface and image plots Read more
fn set_custom_palette<T: IntoIterator<Item=(f32, f32, f32, f32)>>(&mut self, palette_generator: T) -> &mut Self
Sets a custom palette used for 3D surface and image plots. A custom palette is specified by a sequence of 4-tuples (with at least one element). The first element is the grayscale value that is mapped to the remaining three elements which specify the red, green and blue components of the color. The grayscale values must be non-decreasing. All values must range from 0 to 1. Read more