Reference > Methods

Methods

The methods of the SharpPlot class are listed below.

SharpPlot Methods

AddAttributesDefine a single handler for all X values in all series
AddBookmarkBookmark this page with name, level, openflag and weblink
AddCommentInsert a note with optional id and compression switch
AddEffectAllow user to associate arbitrary SVG/XAML with any standard text item or subitem
AddHintsDefine a single hint for all X values in all series
AddHyperlinksDefine a single link for all X values in all series
AddJavaPrologueInclude the definition of a JavaScript function in the output chart
AddTableShadingAdd a combination of Color and Fill to an individual table cell
AddTipsDefine a single tip for all X values in all series
DefineFontCreate a definition for a font, including CSS details and PostScript name
DrawBarChart

Draws a grouped or stacked barchart from an array of arrays of values

DrawBoxPlot

Construct compound box-whisker plot from a data array and two integer category arrays

DrawBubbleChart

Scatterplot from 2 arrays of data with markers scaled by 3rd array

DrawCloudChart

3D Scatter from x,y and multiple z values

DrawContourPlot

Contour plot from 3 arrays of double values

DrawDialChart

Draw a dial or gauge from data and pointer radii

DrawFrame

Draw current frame, with any fixed text such as headings and footnotes

DrawGanttChart

Gantt chart from 3 double arrays of Y-values, X-start and X-end values

DrawHistogram

Construct a histogram from a floating-point vector

DrawImage

Add image at given width with alternative uri

DrawKey

This will draw and clear any pending keys, using the current setting of key text.

DrawLineGraph

Construct plot from array of arrays of y values and x-values

DrawMinMaxChart

Create hi-lo plot from arrays of max,min and optional axis values

DrawMultiple

Multiple plot from double array of arrays of y-values versus double x-values

DrawNote

Write text note given text, position, angle and maximum width

DrawPieChart

Piechart from data and sector explosions as percentages

DrawPolarChart

Polar plot from multiple series and times or angles

DrawResponsePlot

Create surface from multiple sets of z-values with matched x and y values

DrawScatterPlot

Make a scatter plot from x and y data

DrawStepChart

Stepped line from arrays of height data and step-start values

DrawTable

Build a table from an array of arrays of strings, giving cells in columns

DrawTowerChart

Tower chart from an array of arrays of height values

DrawTraceChart

Draw a set of parallel traces from an array of arrays of Y-values and an array of X-values

DrawTriangle

Construct triangle chart from data (3 series giving proportions or counts)

DrawVectors

Vector plot from a matrix of xyxy pairs

DrawVennDiagram

Draw a Venn diagram using supplied membership data

DrawXBarChart

XBarchart from multiple data series and x-values

FindExtremesDetermines the extreme values from an array of data, allowing for the ‘Curves’ style
GetCoefficientsCoefficients of modelfit
GetFittedValuesFitted values from model
GetITickPositionsCalculated Inner ticks
GetResidualsResiduals from modelfit
GetXTickPositionsCalculated X tickmarks
GetYTickPositionsCalculated Y tickmarks
IncludeSourceAdd arbitrary content passed as a simple string to either end of output
MapCoordsMaps a matched pair of (x,y) co-ordinate arrays to points
NewCellMove to the next cell in the current trellis.
NewFrameClear the area for a new chart with new frame size and position.
NewPagePage throw with option to skip full reset
NewYAxisPartial reset to allow independent secondary Y-axis
NextNoteReturns the correct position for the next note text allowing given extra space in pts
ReadCommentRecover comments saved to file in any output format or passed as a string
ReadPdfStreamRecover any page from an encoded PDF
RedrawAxesOverdraws the axes with optional framing
RenderBitmapReturn Bitmap rendered at given dpi and chosen antialiased text
RenderChartLogReturn completed chart as a readable log with optional prescan and extra information about chart ids
RenderEpsReturn completed chart as EPS with monochrome switch and prefix information
RenderImageMapReturn tags to make an HTML imagemap for chart at given dpi
RenderJsonChartMapReturn JSON arrays to make a map for entire chart
RenderMetafileReturn or stream completed chart as Metafile with choice of formats and dpi settings
RenderPSReturn completed chart to file as raw PostScript with monochrome and mediabox flags and extra PS prologue
RenderPageMapReturn an instance of the PageMap class to allow active graphics applications
RenderPdfReturn completed chart rendered through through PDF engine.
RenderSvgReturn chart as an SVG file with aspect ratio setting and extra header text
RenderVmlReturn completed chart rendered through VML engine as a div block to be incorporated in a webpage
RenderXamlReturn completed chart rendered through through XAML engine.
ResetClear SharpPlot to new paper size
ResetKeyRemoves any accumulated key definitions
ResetPropertiesAll properties except trellis definitions are returned to default values.
SaveChartLogSave completed chart as a readable log file with optional prescan and detail level
SaveEpsSave completed chart as EPS with monochrome switch and prefix information
SaveImageSave specified image to file with given resolution and rendering hint
SavePSSave completed chart to file as raw PostScript with monochrome and mediabox flags and extra PS prologue
SavePdfSave completed chart to named file as PDF
SaveSvgSave chart as an SVG file with aspect ratio setting and extra header text
SaveVmlSave completed chart rendered through VML engine as a complete webpage
SaveXamlSave completed chart rendered through XAML engine to text file
SetAltitudeColorsSet Altitude Colors for contour plots or markers
SetArrowStyleSet Arrow format from Arrow size, with optional sweep angle and fill pattern
SetAxisStyleSet Axis format from any reasonable combination of color, lineStyle and lineweight
SetBackgroundSet Paper from any reasonable combination of fillColor, fillStyle and edgeweight
SetBarWidthsSet Bar widths given an array of numbers or a single value
SetBaselineStyleSet Baseline format from any reasonable combination of color, lineStyle and lineweight
SetCaptionFontSet Caption font from a combination of fontname, size, style, colour
SetCellSizeSet Cellsize (width,height) from a single value or xvalue and yvalue pair
SetChartBackgroundSet Chart background from any reasonable combination of fillColor, fillStyle and edgeweight
SetChartNameAssign a non-default name to the current chart
SetColorsSet a color or an array of colors to be used by upcoming series
SetContourStyleSet Contour format from any reasonable combination of color, lineStyle and lineweight
SetContourTagFontSet ContourTag font from a combination of fontname, size, style, colour
SetDataWindowSet Window for data given an array of values or a single value
SetDatumLineStyleSet DatumLine style from any reasonable combination of color, lineStyle and lineweight
SetDatumLineTagsSet Datumline tags from a delimited string or a string array
SetDatumTagFontSet DatumTag font from a combination of fontname, size, style, colour
SetEdgeStyleSet Edge format from any reasonable combination of color, lineStyle and lineweight
SetEffectsSet Effect cycle – string or string array
SetFillStylesSet a fill-style or an array of fill-styles for use by upcoming series Set an array of fill-styles for use by upcoming series
SetFootnoteFontSet Footnote font from a combination of fontname, size, style, colour
SetFrameBackgroundSet Frame background from any reasonable combination of fillColor, fillStyle and edgeweight
SetGridLineStyleSet Gridline format from any reasonable combination of color, lineStyle and lineweight
SetHeadingFontSet Heading font from a combination of fontname, size, style, colour
SetHeadingNudgeSet Heading nudge(x,y) from given displacements
SetIDataRangeSet Inner data range given an array of numbers or a single value
SetILabelFontSet Inner label font from a combination of fontname, size, style, colour
SetILabelsSet Inner axis labels from a simple string or an array of strings
SetIRangeSet Inner axis range range given maximum and optional minimum values
SetITickMarksSet Inner axis tick marks given an array of numbers or a single value
SetIZonesSet Inner axis zones given one or more Zone definitions
SetKeyBackgroundSet Key background fill from any reasonable combination of fillColor, fillStyle and edgeweight
SetKeyFontSet Key font from a combination of fontname, size, style, colour
SetKeyFrameKey frame (ltwh in pts) Frame given top corner and size
SetKeyIndicesSet Key indices given an array of values or a single value
SetKeyNudgeSet Key box nudge from given displacements
SetKeyTextSet Legend texts for key from a delimited string or a string array
SetLabelFontSet Label font from a combination of fontname, size, style, colour
SetLabelMaskSet Label mask from a mask (always treated as flags)
SetLineStylesSet a Line-style or an array of line-styles to be used by upcoming series.
SetMarginsSet chart margins individually or as a group
SetMarkerColorsSet Altitude-colored markers for contour plots or markers
SetMarkerScalesSet Marker scales given an array of numbers or a single value
SetMarkersSet up a marker or an array of markers for upcoming series
SetModelSpanSet Modelfit span range given maximum and optional minimum values
SetNewlineSet Newline to any single character
SetNoteBackgroundSet Note background from any reasonable combination of fillColor, fillStyle and edgeweight
SetNoteFontSet Note font from a combination of fontname, size, style, colour
SetNoteNudgeSet Note nudge from given displacements
SetOrderOfFitOrder of fit for x and y axes (3D charts or contour plots)
SetPageLabelsSet Page-labels from a simple string or an array of strings
SetParityLimitStyleSet Parity limit style from any reasonable combination of color, lineStyle and lineweight
SetParityLineStyleSet Parity axis style from any reasonable combination of color, lineStyle and lineweight
SetParityZoneStyleSet Parity zone style from any reasonable combination of fillColor, fillStyle and edgeweight
SetPenWidthsSet a line-width or an array of line-widths for use by upcoming data series
SetPieCenterSet Pie centre (xy) from a single value or xvalue and yvalue pair
SetSelectionSet Selection mask for data from a mask (always treated as flags)
SetSeriesNamesAssign a list of names to the upcoming data series
SetSubheadingFontSet Subheading font from a combination of fontname, size, style, colour
SetTablePositionSet Table position from x,y and optional width
SetTowerFillStylesTower ptns (top,face,edge) for Walls and towers (single value sets all three)
SetTrellisMakes a trellis specification from a cell count or cell layout
SetValueFontSet Value tag font from a combination of fontname, size, style, colour
SetValueNudgeSet Value nudge from a pair of displacements or matching arrays
SetValueTagsSet Value tags from a delimited string or a string array
SetViewpointSet 3D viewpoint given a set of roll,pitch,yaw values
SetWallFillStylesWall patterns (YZ,XZ,XY) for Walls and towers (single value sets all three)
SetWeightingsSet Weights for modelfit given an array of numbers or a single value
SetXCaptionFontSet X Caption font from a combination of fontname, size, style, colour
SetXDataRangeSet X data range given an array of numbers or a single value
SetXDatumLinesSet X datum line(s) given an array of numbers or a single value
SetXGridLinesSet X gridline(s) given an array of numbers or a single value
SetXLabelFontSet X label font from a combination of fontname, size, style, colour
SetXLabelNudgeSet X-label nudge from given displacements
SetXLabelsSet X labels from a delimited string or a string array
SetXRangeSet X axis range range given maximum and optional minimum values
SetXTickLengthsSet X tick lengths given an array of numbers or a single value
SetXTickMarksSet X tick marks major tick interval
SetXZonesSet X zone given one or more Zone definitions
SetYCaptionFontSet Y Caption font from a combination of fontname, size, style, colour
SetYDataRangeSet Y data range given an array of numbers or a single value
SetYDatumLinesSet Y datum line(s) given an array of numbers or a single value
SetYGridLinesSet Y gridline(s) given an array of numbers or a single value
SetYLabelFontSet Y label font from a combination of fontname, size, style, colour
SetYLabelNudgeSet Y-label nudge from given displacements
SetYLabelsSet Y labels from a delimited string or a string array
SetYRangeSet Y axis range range given maximum and optional minimum values
SetYTickLengthsSet Y-tick lengths given an array of numbers or a single value
SetYTickMarksSet Y tick marks major tick interval
SetYZonesSet Y zone given one or more Zone definitions
SetZCaptionFontSet Z Caption font from a combination of fontname, size, style, colour
SetZDataRangeSet Z data range given an array of numbers or a single value
SetZDatumLinesSet Z datum line(s) given an array of numbers or a single value
SetZLabelFontSet Z label font from a combination of fontname, size, style, colour
SetZLabelsSet Z labels from a simple string or an array of strings
SetZRangeSet Z axis range range given maximum and optional minimum values
SetZTickMarksSet Z tick marks major tick interval
UseCmykUse a color defined by 4 inks rather than RGB intensities

Requirements

Namespace: Causeway

Assembly: SharpPlot (in sharpplot.dll)


Send comments on this topic
© Dyalog Ltd 2013