Class Sparkline
Represents the Chart UI element.
Implements
Inherited Members
Namespace: Syncfusion.JavaScript.Web
Assembly: Syncfusion.EJ.Web.dll
Syntax
public class Sparkline : CommonDataBoundControl, INamingContainer, IPostBackEventHandler, IPostBackDataHandler, IUrlResolutionService
Constructors
Sparkline()
Declaration
public Sparkline()
Fields
model
Declaration
public SparklineProeprties model
Field Value
Type | Description |
---|---|
SparklineProeprties |
Properties
AxisLineSettings
Gets the Axis property of Sparkline.
Declaration
[JsonProperty("axisLineSettings")]
public AxisLineSettings AxisLineSettings { get; }
Property Value
Type | Description |
---|---|
AxisLineSettings |
Remarks
Options for Axis the Sparkline.
Background
Gets or sets the Background property of the Sparkline.
Declaration
[JsonProperty("background")]
public string Background { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Sparkline's Background.
Border
Gets the border property of Sparkline.
Declaration
[JsonProperty("border")]
public SparklineBorder Border { get; }
Property Value
Type | Description |
---|---|
SparklineBorder |
Remarks
Options for border the Sparkline.
DataSource
Gets or sets the datasource property of the Sparkline.
Declaration
[JsonProperty("dataSource")]
public object DataSource { get; set; }
Property Value
Type | Description |
---|---|
System.Object |
Remarks
Sparkline's datasource.
EnableCanvasRendering
Gets or sets the enableCanvasRendering property of the Sparkline.
Declaration
[JsonProperty("enableCanvasRendering")]
public bool EnableCanvasRendering { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Remarks
Sparkline's rendering mode enableCanvasRendering.
EndColor
Gets or sets the endColor property of the Sparkline.
Declaration
[JsonProperty("endColor")]
public string EndColor { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Sparkline's series marker endColor.
Fill
Gets or sets the Fill Color property of the Sparkline.
Declaration
[JsonProperty("fill")]
public string Fill { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Sparkline's series Fill Color.
HighPointColor
Gets or sets the highColor property of the Sparkline.
Declaration
[JsonProperty("highPointColor")]
public string HighPointColor { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Sparkline's series marker highColor.
IsResponsive
Gets or sets the isresponsive property of the Sparkline.
Declaration
[JsonProperty("isResponsive")]
public bool IsResponsive { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Remarks
Sparkline's rendering mode isresponsive.
LowPointColor
Gets or sets the lowColor property of the Sparkline.
Declaration
[JsonProperty("lowPointColor")]
public string LowPointColor { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Sparkline's series marker lowColor.
MarkerSettings
Gets the marker property of Sparkline.
Declaration
[JsonProperty("markerSettings")]
public MarkerSettings MarkerSettings { get; }
Property Value
Type | Description |
---|---|
MarkerSettings |
Remarks
Options for displaying and customizing the Sparkline marker.
Model
Declaration
[CLSCompliant(false)]
public SparklineProeprties Model { get; set; }
Property Value
Type | Description |
---|---|
SparklineProeprties |
NegativePointColor
Gets or sets the negativeColor property of the Sparkline.
Declaration
[JsonProperty("negativePointColor")]
public string NegativePointColor { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Sparkline's series marker negativeColor.
OnClientClick
Gets or sets the value for OnClientClick property of sparkline
Declaration
[JsonProperty("click")]
public string OnClientClick { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Client-side click event for Sparkline. Fires after clicking the Sparkline.
OnClientDoubleClick
Gets or sets the value for OnClientDoubleClick property of sparkline
Declaration
[JsonProperty("doubleClick")]
public string OnClientDoubleClick { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Client-side double click event for Sparkline. Fires after double clicking the Sparkline.
OnClientLoad
Gets or sets the value for OnClientLoad property of sparkline
Declaration
[JsonProperty("load")]
public string OnClientLoad { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Client-side load event for Sparkline. Fires before loading the Sparkline.
OnClientLoaded
Gets or sets the value for OnClientLoaded property of sparkline
Declaration
[JsonProperty("loaded")]
public string OnClientLoaded { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Client-side loaded event for Sparkline. Fires after loaded the Sparkline.
OnClientPointRegionMouseClick
Gets or sets the value for OnClientPointRegionMouseClick property of sparkline
Declaration
[JsonProperty("pointRegionMouseClick")]
public string OnClientPointRegionMouseClick { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Client-side PointRegionMouseClick event for Sparkline. Fires PointRegionMouseClick while mouse pointer click on the point location of the Sparkline.
OnClientPointRegionMouseMove
Gets or sets the value for OnClientPointRegionMouseMove property of sparkline
Declaration
[JsonProperty("pointRegionMouseMove")]
public string OnClientPointRegionMouseMove { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Client-side PointRegionMouseMove event for Sparkline. Fires PointRegionMouseMove while mouse pointer moving on the point location of the Sparkline.
OnClientRightClick
Gets or sets the value for OnClientRightClick property of sparkline
Declaration
[JsonProperty("rightClick")]
public string OnClientRightClick { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Client-side right click event for Sparkline. Fires after right clicking the Sparkline.
OnClientSeriesRendering
Gets or sets the value for OnClientSeriesRendering property of sparkline
Declaration
[JsonProperty("seriesRendering")]
public string OnClientSeriesRendering { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Client-side SeriesRendering event for Sparkline. Fires SeriesRendering while mouse pointer click on the point location of the Sparkline.
OnClientSparklineMouseLeave
Gets or sets the value for OnClientSparklineMouseLeave property of sparkline
Declaration
[JsonProperty("sparklineMouseLeave")]
public string OnClientSparklineMouseLeave { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Client-side Sparkline Mouse Leave event for Sparkline. Fires SparklineMouseLeave while mouse pointer outside the Sparkline area.
OnClientSparklineMouseMove
Gets or sets the value for OnClientSparklineMouseMove property of sparkline
Declaration
[JsonProperty("sparklineMouseMove")]
public string OnClientSparklineMouseMove { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Client-side Sparkline mouse move event for Sparkline. Fires event while mouse pointer inside the Sparkline area.
OnClientTooltipInitialize
Gets or sets the value for OnClientTooltipInitialize property of sparkline
Declaration
[JsonProperty("tooltipInitialize")]
public string OnClientTooltipInitialize { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Client-side tooltip event for Sparkline. Fires tooltip is moving the Sparkline.
Opacity
Gets or sets the opacity property of the Sparkline.
Declaration
[JsonProperty("opacity")]
public double Opacity { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
Remarks
Sparkline's series opacity.
Padding
Gets or sets the padding property of the Sparkline.
Declaration
[JsonProperty("padding")]
public double Padding { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
Remarks
Sparkline's Series padding.
Palette
Gets or sets the palette property of the Sparkline.
Declaration
[JsonProperty("palette")]
public string[] Palette { get; set; }
Property Value
Type | Description |
---|---|
System.String[] |
Remarks
Sparkline's palette pie series fill Color.
RangeBandSettings
Gets the rangeBandSettings property of Sparkline.
Declaration
[JsonProperty("rangeBandSettings")]
public RangeBandSettings RangeBandSettings { get; }
Property Value
Type | Description |
---|---|
RangeBandSettings |
Remarks
Options for rangeBandSettings the Sparkline.
Size
Gets the size property of Sparkline.
Declaration
[JsonProperty("size")]
public SparkSize Size { get; }
Property Value
Type | Description |
---|---|
SparkSize |
Remarks
Options for size the Sparkline.
SparklineHeight
Gets or sets the designer height of the Sparkline.
Declaration
public string SparklineHeight { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Height of the Sparkline in pixels / percentage
SparklineWidth
Gets or sets the designer width of the Sparkline.
Declaration
public string SparklineWidth { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Width of the Sparkline in pixels / percentage
StartPointColor
Gets or sets the startColor property of the Sparkline.
Declaration
[JsonProperty("startPointColor")]
public string StartPointColor { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Sparkline's series marker startColor.
Stroke
Gets or sets the Stroke property of the Sparkline.
Declaration
[JsonProperty("stroke")]
public string Stroke { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Sparkline's series Stroke Color.
Theme
Gets or sets the Theme of the Sparkline.
Declaration
[JsonProperty("theme")]
[JsonConverter(typeof(StringEnumConverter))]
public SparkTheme Theme { get; set; }
Property Value
Type | Description |
---|---|
SparkTheme |
Remarks
Specifies the theme for Sparkline.
Tooltip
Gets the tooltip property of Sparkline.
Declaration
[JsonProperty("tooltip")]
[CLSCompliant(false)]
public SparklineTooltip Tooltip { get; }
Property Value
Type | Description |
---|---|
SparklineTooltip |
Remarks
Options for tooltip the Sparkline.
Type
Gets or sets the type of the Sparkline.
Declaration
[JsonProperty("type")]
[JsonConverter(typeof(StringEnumConverter))]
public SparklineType Type { get; set; }
Property Value
Type | Description |
---|---|
SparklineType |
Remarks
Specifies the type for Sparkline.
Width
Gets or sets the Width property of the Sparkline.
Declaration
[JsonProperty("width")]
public double Width { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
Remarks
Sparkline's Series Width.
XName
Gets or sets the xName property of the Sparkline.
Declaration
[JsonProperty("xName")]
public string XName { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Sparkline's series DataSource xName.
YName
Gets or sets the yName property of the Sparkline.
Declaration
[JsonProperty("yName")]
public string YName { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Sparkline's series DataSource yName.
Methods
DependentScripts()
Declaration
public List<string> DependentScripts()
Returns
Type | Description |
---|---|
System.Collections.Generic.List<System.String> |
FetchData(IEnumerable)
Declaration
public override void FetchData(IEnumerable data)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.IEnumerable | data |
Overrides
GetDependentFiles()
Declaration
public override List<string> GetDependentFiles()
Returns
Type | Description |
---|---|
System.Collections.Generic.List<System.String> |
Overrides
LoadViewState(Object)
Declaration
protected override void LoadViewState(object state)
Parameters
Type | Name | Description |
---|---|---|
System.Object | state |
Overrides
OnInit(EventArgs)
Declaration
protected override void OnInit(EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.EventArgs | e |
OnLoad(EventArgs)
Declaration
protected override void OnLoad(EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.EventArgs | e |
Overrides
OnPreRender(EventArgs)
Declaration
protected override void OnPreRender(EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.EventArgs | e |
Overrides
Render()
Declaration
public string Render()
Returns
Type | Description |
---|---|
System.String |
Render(HtmlTextWriter)
Declaration
protected override void Render(HtmlTextWriter writer)
Parameters
Type | Name | Description |
---|---|---|
System.Web.UI.HtmlTextWriter | writer |
Overrides
SaveViewState()
Declaration
protected override object SaveViewState()
Returns
Type | Description |
---|---|
System.Object |