A plot element that draws a title for an axis. More...

Inheritance diagram for VectSharp.Plots.ContinuousAxisTitle:

Public Member Functions

ContinuousAxisTitle (IEnumerable< FormattedText > title, IReadOnlyList< double > startPoint, IReadOnlyList< double > endPoint, IContinuousCoordinateSystem coordinateSystem)

Create a new ContinuousAxisTitle instance. More...

ContinuousAxisTitle (string title, IReadOnlyList< double > startPoint, IReadOnlyList< double > endPoint, IContinuousCoordinateSystem coordinateSystem, PlotElementPresentationAttributes presentationAttributes=null)

Create a new ContinuousAxisTitle instance. More...

void Plot (Graphics target)

Draw the plot element on the specified target  Graphics.

Parameters

target The Graphics on which to draw.

More...

void Plot (Graphics target)

Draw the plot element on the specified target Graphics. More...

Properties
IReadOnlyList< double >	StartPoint `[get, set]`
	The starting point of the axis, expressed in data space coordinates. More...

IReadOnlyList< double >	EndPoint `[get, set]`
	The ending point of the axis, expressed in data space coordinates. More...

double	Position = 30 `[get, set]`
	The distance between the title and the axis, in plot space coordinates. More...

IEnumerable< FormattedText >	Title `[get, set]`
	The axis title to draw. More...

bool	FollowAxis = true `[get, set]`
	If the axis is not a straight line (e.g., because the coordinate system is not linear), if this is `true` the title will follow the shape of the axis. If this is `false`, the title will always be drawn on a straight line. More...

double?	Rotation = null `[get, set]`
	Orientation of the title with respect to the horizontal. If this is `null`, the title is parallel to the axis. More...

TextBaselines	Baseline = TextBaselines.Middle `[get, set]`
	The baseline for the title anchor. More...

TextAnchors	Alignment = TextAnchors.Left `[get, set]`
	The alignment for the title anchor. More...

IContinuousCoordinateSystem	CoordinateSystem `[get, set]`
	The coordinate system used to transform the points from data space to plot space. More...

PlotElementPresentationAttributes	PresentationAttributes = new PlotElementPresentationAttributes() { Font = new Font(FontFamily.ResolveFontFamily(FontFamily.StandardFontFamilies.HelveticaBold), 14), Stroke = null, Fill = Colours.Black } `[get, set]`
	Presentation attributes determining the appearance of the title. More...

string	Tag `[get, set]`
	A tag to identify the labels in the plot. More...

Properties inherited from VectSharp.Plots.IPlotElement
ICoordinateSystem	CoordinateSystem `[get]`
	The coordinate system used to transform the points from data space to plot space. More...

Detailed Description

A plot element that draws a title for an axis.

Definition at line 570 of file Axes.cs.

Constructor & Destructor Documentation

◆ ContinuousAxisTitle() [1/2]

VectSharp.Plots.ContinuousAxisTitle.ContinuousAxisTitle	(	IEnumerable< FormattedText >	title,
		IReadOnlyList< double >	startPoint,
		IReadOnlyList< double >	endPoint,
		IContinuousCoordinateSystem	coordinateSystem
	)

Create a new ContinuousAxisTitle instance.

Parameters

title	The title to draw on the axis.
startPoint	The starting point of the axis, expressed in data space coordinates.
endPoint	The ending point of the axis, expressed in data space coordinates.
coordinateSystem	The coordinate system used to transform the points from data space to plot space.

Definition at line 638 of file Axes.cs.

◆ ContinuousAxisTitle() [2/2]

VectSharp.Plots.ContinuousAxisTitle.ContinuousAxisTitle	(	string	title,
		IReadOnlyList< double >	startPoint,
		IReadOnlyList< double >	endPoint,
		IContinuousCoordinateSystem	coordinateSystem,
		PlotElementPresentationAttributes	presentationAttributes = `null`
	)

Create a new ContinuousAxisTitle instance.

Parameters

title	The title to draw on the axis.
startPoint	The starting point of the axis, expressed in data space coordinates.
endPoint	The ending point of the axis, expressed in data space coordinates.
coordinateSystem	The coordinate system used to transform the points from data space to plot space.
presentationAttributes	Presentation attributes determining the appearance of the title.

Definition at line 654 of file Axes.cs.

Member Function Documentation

◆ Plot()

void VectSharp.Plots.ContinuousAxisTitle.Plot ( Graphics target )

Draw the plot element on the specified target  Graphics.

Parameters

target The Graphics on which to draw.

Implements VectSharp.Plots.IPlotElement.

Definition at line 685 of file Axes.cs.

Property Documentation

◆ Alignment

TextAnchors VectSharp.Plots.ContinuousAxisTitle.Alignment = TextAnchors.Left

getset

The alignment for the title anchor.

Definition at line 613 of file Axes.cs.

◆ Baseline

TextBaselines VectSharp.Plots.ContinuousAxisTitle.Baseline = TextBaselines.Middle

getset

The baseline for the title anchor.

Definition at line 608 of file Axes.cs.

◆ CoordinateSystem

IContinuousCoordinateSystem VectSharp.Plots.ContinuousAxisTitle.CoordinateSystem

getset

The coordinate system used to transform the points from data space to plot space.

Implements VectSharp.Plots.IPlotElement.

Definition at line 618 of file Axes.cs.

◆ EndPoint

IReadOnlyList<double> VectSharp.Plots.ContinuousAxisTitle.EndPoint

getset

The ending point of the axis, expressed in data space coordinates.

Definition at line 580 of file Axes.cs.

◆ FollowAxis

bool VectSharp.Plots.ContinuousAxisTitle.FollowAxis = true

getset

If the axis is not a straight line (e.g., because the coordinate system is not linear), if this is true the title will follow the shape of the axis. If this is false, the title will always be drawn on a straight line.

Definition at line 597 of file Axes.cs.

◆ Position

double VectSharp.Plots.ContinuousAxisTitle.Position = 30

getset

The distance between the title and the axis, in plot space coordinates.

Definition at line 585 of file Axes.cs.

◆ PresentationAttributes

PlotElementPresentationAttributes VectSharp.Plots.ContinuousAxisTitle.PresentationAttributes = new PlotElementPresentationAttributes() { Font = new Font(FontFamily.ResolveFontFamily(FontFamily.StandardFontFamilies.HelveticaBold), 14), Stroke = null, Fill = Colours.Black }

getset

Presentation attributes determining the appearance of the title.

Definition at line 624 of file Axes.cs.

◆ Rotation

double? VectSharp.Plots.ContinuousAxisTitle.Rotation = null

getset

Orientation of the title with respect to the horizontal. If this is null, the title is parallel to the axis.

Definition at line 603 of file Axes.cs.

◆ StartPoint

IReadOnlyList<double> VectSharp.Plots.ContinuousAxisTitle.StartPoint

getset

The starting point of the axis, expressed in data space coordinates.

Definition at line 575 of file Axes.cs.

◆ Tag

string VectSharp.Plots.ContinuousAxisTitle.Tag

getset

A tag to identify the labels in the plot.

Definition at line 629 of file Axes.cs.

◆ Title

IEnumerable<FormattedText> VectSharp.Plots.ContinuousAxisTitle.Title

getset

The axis title to draw.

Definition at line 590 of file Axes.cs.

The documentation for this class was generated from the following file:

VectSharp.Plots/Axes.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ ContinuousAxisTitle() [1/2]

◆ ContinuousAxisTitle() [2/2]

Member Function Documentation

◆ Plot()

Property Documentation

◆ Alignment

◆ Baseline

◆ CoordinateSystem

◆ EndPoint

◆ FollowAxis

◆ Position

◆ PresentationAttributes

◆ Rotation

◆ StartPoint

◆ Tag

◆ Title