IGLib  1.7.2
The IGLib base library EXTENDED - with other lilbraries and applications.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
CShell.Sinks.Plotting Class Reference

Extension methods to help with plotting and access the plotting sinks. More...

Static Public Member Functions

static IPlotSink GetPlotSink (string sinkName)
 Gets a plot sink. If the plot exists or can be created the plot is opened. More...
 
static IPlotSink GetPlotSink (string sinkName, bool suppressOpen)
 Gets a plot sink. More...
 
static void Plot (this Series series, string sinkName=null)
 Plots the specified series. More...
 
static void Plot (this Chart chart, string sinkName=null)
 Plots the specified chart. More...
 
static void Plot (this IEnumerable ys, string seriesName=null, string chartType="Line", string sinkName=null)
 Plots the specified Y values. More...
 
static void Plot (this IEnumerable ys, IEnumerable xs, string seriesName=null, string chartType="Line", string sinkName=null)
 Plots the specified Y values at the corresponding X points. More...
 
static void PlotFunction (this Func< double, double > f, string seriesName=null, string chartType="Line", double from=-3.0, double to=3.0, int points=100, string sinkName=null)
 Plots a function that produces Y values. More...
 
static void PlotHistogram (this IEnumerable ys, string seriesName=null, string histogramName=null, string sinkName=null)
 Plots the Y values as a histogram. More...
 
static IPlotSink GetPlotSink (string sinkName)
 Gets a plot sink. If the plot exists or can be created the plot is opened. More...
 
static IPlotSink GetPlotSink (string sinkName, bool suppressOpen)
 Gets a plot sink. More...
 
static void Plot (this Series series, string sinkName=null)
 Plots the specified series. More...
 
static void Plot (this Chart chart, string sinkName=null)
 Plots the specified chart. More...
 
static void Plot (this IEnumerable ys, string seriesName=null, string chartType="Line", string sinkName=null)
 Plots the specified Y values. More...
 
static void Plot (this IEnumerable ys, IEnumerable xs, string seriesName=null, string chartType="Line", string sinkName=null)
 Plots the specified Y values at the corresponding X points. More...
 
static void PlotFunction (this Func< double, double > f, string seriesName=null, string chartType="Line", double from=-3.0, double to=3.0, int points=100, string sinkName=null)
 Plots a function that produces Y values. More...
 
static void PlotHistogram (this IEnumerable ys, string seriesName=null, string histogramName=null, string sinkName=null)
 Plots the Y values as a histogram. More...
 

Properties

static string[] PlotChartTypes [get]
 Gets the available plot chart types. More...
 

Detailed Description

Extension methods to help with plotting and access the plotting sinks.

Member Function Documentation

static IPlotSink CShell.Sinks.Plotting.GetPlotSink ( string  sinkName)
inlinestatic

Gets a plot sink. If the plot exists or can be created the plot is opened.

Parameters
sinkNameName of the sink.
static IPlotSink CShell.Sinks.Plotting.GetPlotSink ( string  sinkName,
bool  suppressOpen 
)
inlinestatic

Gets a plot sink.

Parameters
sinkNameName of the sink.
suppressOpenIf set to true the plot is not opened.

References CShell.Shell.GetSink(), and CShell.Constants.SinkPlot.

static void CShell.Sinks.Plotting.Plot ( this Series  series,
string  sinkName = null 
)
inlinestatic

Plots the specified series.

Parameters
seriesThe series.
sinkNameName of the sink.
static void CShell.Sinks.Plotting.Plot ( this Chart  chart,
string  sinkName = null 
)
inlinestatic

Plots the specified chart.

Parameters
chartThe chart.
sinkNameName of the sink.
static void CShell.Sinks.Plotting.Plot ( this IEnumerable  ys,
string  seriesName = null,
string  chartType = "Line",
string  sinkName = null 
)
inlinestatic

Plots the specified Y values.

Parameters
ysThe Y values.
seriesNameName of the series.
chartTypeThe chart type to be used for the points, see the PlotChartTypes property for all available types.
sinkNameName of the sink.
static void CShell.Sinks.Plotting.Plot ( this IEnumerable  ys,
IEnumerable  xs,
string  seriesName = null,
string  chartType = "Line",
string  sinkName = null 
)
inlinestatic

Plots the specified Y values at the corresponding X points.

Parameters
ysThe Y values.
xsThe X values.
seriesNameName of the series.
chartTypeThe chart type to be used for the points, see the PlotChartTypes property for all available types.
sinkNameName of the sink.
static void CShell.Sinks.Plotting.PlotFunction ( this Func< double, double >  f,
string  seriesName = null,
string  chartType = "Line",
double  from = -3.0,
double  to = 3.0,
int  points = 100,
string  sinkName = null 
)
inlinestatic

Plots a function that produces Y values.

Parameters
fThe function to plot.
seriesNameName of the resulting series.
chartTypeThe chart type to be used for the points, see the PlotChartTypes property for all available types.
fromAt what X value to start the plot.
toAt what X value to end the plot.
pointsHow many points to plot between start and end.
sinkNameName of the sink.
static void CShell.Sinks.Plotting.PlotHistogram ( this IEnumerable  ys,
string  seriesName = null,
string  histogramName = null,
string  sinkName = null 
)
inlinestatic

Plots the Y values as a histogram.

Parameters
ysThe Y values to plot.
seriesNameName of the series.
histogramNameName of the resulting histogram.
sinkNameName of the sink.
static IPlotSink CShell.Sinks.Plotting.GetPlotSink ( string  sinkName)
inlinestatic

Gets a plot sink. If the plot exists or can be created the plot is opened.

Parameters
sinkNameName of the sink.
static IPlotSink CShell.Sinks.Plotting.GetPlotSink ( string  sinkName,
bool  suppressOpen 
)
inlinestatic

Gets a plot sink.

Parameters
sinkNameName of the sink.
suppressOpenIf set to true the plot is not opened.

References CShell.Shell.GetSink(), and CShell.Constants.SinkPlot.

static void CShell.Sinks.Plotting.Plot ( this Series  series,
string  sinkName = null 
)
inlinestatic

Plots the specified series.

Parameters
seriesThe series.
sinkNameName of the sink.
static void CShell.Sinks.Plotting.Plot ( this Chart  chart,
string  sinkName = null 
)
inlinestatic

Plots the specified chart.

Parameters
chartThe chart.
sinkNameName of the sink.
static void CShell.Sinks.Plotting.Plot ( this IEnumerable  ys,
string  seriesName = null,
string  chartType = "Line",
string  sinkName = null 
)
inlinestatic

Plots the specified Y values.

Parameters
ysThe Y values.
seriesNameName of the series.
chartTypeThe chart type to be used for the points, see the PlotChartTypes property for all available types.
sinkNameName of the sink.
static void CShell.Sinks.Plotting.Plot ( this IEnumerable  ys,
IEnumerable  xs,
string  seriesName = null,
string  chartType = "Line",
string  sinkName = null 
)
inlinestatic

Plots the specified Y values at the corresponding X points.

Parameters
ysThe Y values.
xsThe X values.
seriesNameName of the series.
chartTypeThe chart type to be used for the points, see the PlotChartTypes property for all available types.
sinkNameName of the sink.
static void CShell.Sinks.Plotting.PlotFunction ( this Func< double, double >  f,
string  seriesName = null,
string  chartType = "Line",
double  from = -3.0,
double  to = 3.0,
int  points = 100,
string  sinkName = null 
)
inlinestatic

Plots a function that produces Y values.

Parameters
fThe function to plot.
seriesNameName of the resulting series.
chartTypeThe chart type to be used for the points, see the PlotChartTypes property for all available types.
fromAt what X value to start the plot.
toAt what X value to end the plot.
pointsHow many points to plot between start and end.
sinkNameName of the sink.
static void CShell.Sinks.Plotting.PlotHistogram ( this IEnumerable  ys,
string  seriesName = null,
string  histogramName = null,
string  sinkName = null 
)
inlinestatic

Plots the Y values as a histogram.

Parameters
ysThe Y values to plot.
seriesNameName of the series.
histogramNameName of the resulting histogram.
sinkNameName of the sink.

Property Documentation

string [] CShell.Sinks.Plotting.PlotChartTypes
staticget

Gets the available plot chart types.


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