RadSparkline
Represents a sparkline control that provides a compact, inline chart visualization for displaying trends and patterns in data series.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
[TelerikToolboxCategory("Data Controls")]
public class RadSparkline : RadControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProvider, IPrintableInheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadSparkline...
Implements:
Inherited Members
Constructors
Initializes a new instance of the RadSparkline class with default settings.
public RadSparkline()Properties
Gets the collection of annotations that can be added to the sparkline to provide additional visual information or markers.
[Browsable(true)]
public SparkAnnotationCollection Annotations { get; }Gets the current visible area of the sparkline that defines the rendering boundaries and viewport.
[Browsable(false)]
public SparkArea Area { get; }Gets the collection of axes used by the sparkline for data positioning and scaling.
[Browsable(true)]
public SparkAxisCollection Axes { get; }Gets or sets how the horizontal axis is drawn relative to the data series in the sparkline.
[Browsable(true)]
public AxisDrawMode AxisDrawMode { get; set; }Gets the collection of controllers that manage user interaction and behavior for the sparkline view.
[Browsable(false)]
public SparkViewControllerCollection Controllers { get; }Gets the default size of the RadSparkline control.
protected override Size DefaultSize { get; }Overrides:
Gets or sets how empty or null data points are handled in the sparkline visualization.
[Browsable(true)]
public EmptyPointBehavior EmptyPointBehavior { get; set; }Gets or sets the data series that will be displayed in the sparkline chart.
[Browsable(true)]
public SparkSeries Series { get; set; }Gets or sets whether the horizontal axis line is visible in the sparkline chart.
[Browsable(true)]
public bool ShowAxis { get; set; }Gets or sets whether a marker indicating the first data point in the series will be displayed on the sparkline.
[Browsable(true)]
public bool ShowFirstPointIndicator { get; set; }Gets or sets whether a marker indicating the highest data point value will be displayed on the sparkline.
[Browsable(true)]
public bool ShowHighPointIndicator { get; set; }Gets or sets whether a marker indicating the last data point in the series will be displayed on the sparkline.
[Browsable(true)]
public bool ShowLastPointIndicator { get; set; }Gets or sets whether a marker indicating the lowest data point value will be displayed on the sparkline.
[Browsable(true)]
public bool ShowLowPointIndicator { get; set; }Gets or sets whether markers for negative data point values will be displayed on the sparkline.
[Browsable(true)]
public bool ShowNegativePointIndicators { get; set; }Gets or sets a value indicating whether tooltips are displayed when hovering over data points in the sparkline.
[Browsable(true)]
public bool ShowToolTip { get; set; }Gets the main sparkline element that contains the visualization logic and rendering components.
public RadSparklineElement SparklineElement { get; }Methods
Begins the print process for the sparkline and returns the number of pages to print.
public int BeginPrint(RadPrintDocument sender, PrintEventArgs args)The RadPrintDocument that initiated the print operation.
argsPrintEventArgsA PrintEventArgs that contains the event data.
Returns:The number of pages to print (always returns 1 for sparklines).
Implements:
Creates the child elements for the sparkline control within the specified parent element.
protected override void CreateChildItems(RadElement parent)The parent element that will contain the child elements.
Overrides:
Creates and returns a new instance of the RadSparklineElement that will be used as the core element of the sparkline control.
protected virtual RadSparklineElement CreateSparklineElement()A new RadSparklineElement instance.
Returns a disposable object that can be used to defer refresh operations until disposed, allowing for batch updates.
public IDisposable DeferRefresh()An IDisposable object that defers refresh operations.
Releases the unmanaged resources used by the RadSparkline and optionally releases the managed resources.
protected override void Dispose(bool disposing)true to release both managed and unmanaged resources; false to release only unmanaged resources.
Overrides:
Ends the print process for the sparkline.
public bool EndPrint(RadPrintDocument sender, PrintEventArgs args)The RadPrintDocument that initiated the print operation.
argsPrintEventArgsA PrintEventArgs that contains the event data.
Returns:true if the print operation completed successfully; otherwise, false.
Implements:
Exports the sparkline to an image file using the specified format and size.
public void ExportToImage(string filePath, Size size, ImageFormat imageFormat)The path where the exported image file will be saved.
sizeSizeThe dimensions of the exported image.
imageFormatImageFormatThe image format to use for the exported file.
Gets the settings dialog for configuring print options for the sparkline.
public Form GetSettingsDialog(RadPrintDocument document)The RadPrintDocument associated with the print operation.
Returns:A Form containing the print settings dialog.
Implements:
Performs initialization when the control is loaded with the specified desired size.
protected override void OnLoad(Size desiredSize)The desired size for the control.
Overrides:
Called when the control's theme is changed, ensuring the sparkline area is properly updated to reflect theme modifications.
protected override void OnThemeChanged()Overrides:
Prints the sparkline directly to the default printer without showing any dialog.
public virtual void Print()Prints the sparkline using the specified print document, optionally showing printer settings dialog first.
public virtual void Print(bool showPrinterSettings, RadPrintDocument document)true to show the printer settings dialog before printing; false to print directly.
documentRadPrintDocumentThe RadPrintDocument instance to use for controlling the print process.
Prints the sparkline to the default printer, optionally showing printer settings dialog first.
public virtual void Print(bool showPrinterSettings)true to show the printer settings dialog before printing; false to print directly.
Prints the specified page of the sparkline to the print document.
public bool PrintPage(int pageNumber, RadPrintDocument sender, PrintPageEventArgs args)The page number to print (always 1 for sparklines).
senderRadPrintDocumentThe RadPrintDocument that initiated the print operation.
argsPrintPageEventArgsA PrintPageEventArgs that contains the event data and graphics context for printing.
Returns:false to indicate that there are no more pages to print; otherwise, true.
Implements:
Shows a print preview dialog for the sparkline with default print settings.
public virtual void PrintPreview()Shows a print preview dialog for the sparkline using the specified print document.
public virtual void PrintPreview(RadPrintDocument document)The RadPrintDocument instance to use for controlling the print preview.
Forces a complete refresh of the sparkline control, including layout recalculation and visual updates.
public override void Refresh()Overrides:
Resets theme value overrides for the background color property.
protected override void ResetBackColorThemeOverrides()Overrides:
Resets theme value overrides for the foreground color property.
protected override void ResetForeColorThemeOverrides()Overrides:
Resumes refresh operations for the sparkline after they have been suspended.
public void ResumeRefresh()Scales the control by the specified factor and adjusts the sparkline view margins accordingly.
protected override void ScaleControl(SizeF factor, BoundsSpecified specified)The scaling factor to apply to the control.
specifiedBoundsSpecifiedA bitwise combination of the BoundsSpecified values specifying which bounds to scale.
Overrides:
Sets theme value overrides for the background color property.
protected override void SetBackColorThemeOverrides()Overrides:
Sets theme value overrides for the foreground color property.
protected override void SetForeColorThemeOverrides()Overrides:
Suspends refresh operations for the sparkline to improve performance during multiple property changes.
public void SuspendRefresh()Events
Occurs when the sparkline area requires a custom renderer for the first time, allowing users to provide their own rendering implementation.
public event SparklineCreateRendererEventHandler CreateRendererOccurs when a sparkline fill area is about to be painted, allowing customization of the brush used for filling regions.
public event PaintSparkFillEventHandler PaintSparkFillOccurs when a sparkline stroke is about to be painted, allowing customization of the pen used for drawing lines and borders.
public event PaintSparkStrokeEventHandler PaintSparkStroke