Class SparklineBuilder

Inheritance
System.Object
ControlBuilder
SparklineBuilder
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.EJ2.Charts
Assembly: Syncfusion.EJ2.dll
Syntax
public class SparklineBuilder : ControlBuilder

Constructors

SparklineBuilder()

Declaration
public SparklineBuilder()

SparklineBuilder(Sparkline)

Declaration
public SparklineBuilder(Sparkline model)
Parameters
Type Name Description
Sparkline model

Fields

model

Declaration
public Sparkline model
Field Value
Type Description
Sparkline

Properties

HtmlAttr

Declaration
public IDictionary<string, object> HtmlAttr { get; set; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, System.Object>

ID

Declaration
public string ID { get; set; }
Property Value
Type Description
System.String

Output

Declaration
public override TextWriter Output { get; set; }
Property Value
Type Description
System.IO.TextWriter
Overrides

Methods

AxisRendering(String)

Triggers before sparkline axis render.

Declaration
public SparklineBuilder AxisRendering(string axisRendering)
Parameters
Type Name Description
System.String axisRendering
Returns
Type Description
SparklineBuilder

AxisSettings(SparklineAxisSettings)

To configure Sparkline container area customization.

Declaration
public SparklineBuilder AxisSettings(SparklineAxisSettings axisSettings)
Parameters
Type Name Description
SparklineAxisSettings axisSettings
Returns
Type Description
SparklineBuilder

AxisSettings(Action<SparklineAxisSettingsBuilder>)

Declaration
public SparklineBuilder AxisSettings(Action<SparklineAxisSettingsBuilder> axisSettings)
Parameters
Type Name Description
System.Action<SparklineAxisSettingsBuilder> axisSettings
Returns
Type Description
SparklineBuilder

Border(SparklineSparklineBorder)

To configure Sparkline points border color and width.

Declaration
public SparklineBuilder Border(SparklineSparklineBorder border)
Parameters
Type Name Description
SparklineSparklineBorder border
Returns
Type Description
SparklineBuilder

Border(Action<SparklineSparklineBorderBuilder>)

Declaration
public SparklineBuilder Border(Action<SparklineSparklineBorderBuilder> border)
Parameters
Type Name Description
System.Action<SparklineSparklineBorderBuilder> border
Returns
Type Description
SparklineBuilder

ContainerArea(SparklineContainerArea)

To configure Sparkline container area customization.

Declaration
public SparklineBuilder ContainerArea(SparklineContainerArea containerArea)
Parameters
Type Name Description
SparklineContainerArea containerArea
Returns
Type Description
SparklineBuilder

DataLabelRendering(String)

Triggers before the sparkline datalabel render.

Declaration
public SparklineBuilder DataLabelRendering(string dataLabelRendering)
Parameters
Type Name Description
System.String dataLabelRendering
Returns
Type Description
SparklineBuilder

DataLabelSettings(SparklineSparklineDataLabelSettings)

To configure Sparkline dataLabel configuration.

Declaration
public SparklineBuilder DataLabelSettings(SparklineSparklineDataLabelSettings dataLabelSettings)
Parameters
Type Name Description
SparklineSparklineDataLabelSettings dataLabelSettings
Returns
Type Description
SparklineBuilder

DataLabelSettings(Action<SparklineSparklineDataLabelSettingsBuilder>)

Declaration
public SparklineBuilder DataLabelSettings(Action<SparklineSparklineDataLabelSettingsBuilder> dataLabelSettings)
Parameters
Type Name Description
System.Action<SparklineSparklineDataLabelSettingsBuilder> dataLabelSettings
Returns
Type Description
SparklineBuilder

DataSource(Action<DataManagerBuilder>)

Declaration
public SparklineBuilder DataSource(Action<DataManagerBuilder> dataSource)
Parameters
Type Name Description
System.Action<DataManagerBuilder> dataSource
Returns
Type Description
SparklineBuilder

DataSource(Object)

To configure sparkline data source.

Declaration
public SparklineBuilder DataSource(object dataSource)
Parameters
Type Name Description
System.Object dataSource
Returns
Type Description
SparklineBuilder

EnablePersistence(Boolean)

Enable or disable persisting component's state between page reloads.

Declaration
public SparklineBuilder EnablePersistence(bool enablePersistence = true)
Parameters
Type Name Description
System.Boolean enablePersistence
Returns
Type Description
SparklineBuilder

EnableRtl(Boolean)

Enable or disable rendering component in right to left direction.

Declaration
public SparklineBuilder EnableRtl(bool enableRtl = true)
Parameters
Type Name Description
System.Boolean enableRtl
Returns
Type Description
SparklineBuilder

EndPointColor(String)

To configure sparkline series last x value point color.

Declaration
public SparklineBuilder EndPointColor(string endPointColor)
Parameters
Type Name Description
System.String endPointColor
Returns
Type Description
SparklineBuilder

Fill(String)

To configure sparkline series fill.

Declaration
public SparklineBuilder Fill(string fill)
Parameters
Type Name Description
System.String fill
Returns
Type Description
SparklineBuilder

Format(String)

To apply internationalization for sparkline.

Declaration
public SparklineBuilder Format(string format)
Parameters
Type Name Description
System.String format
Returns
Type Description
SparklineBuilder

Height(String)

To configure Sparkline height.

Declaration
public SparklineBuilder Height(string height)
Parameters
Type Name Description
System.String height
Returns
Type Description
SparklineBuilder

HighPointColor(String)

To configure sparkline series highest y value point color.

Declaration
public SparklineBuilder HighPointColor(string highPointColor)
Parameters
Type Name Description
System.String highPointColor
Returns
Type Description
SparklineBuilder

HtmlAttributes(Object)

Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

Declaration
public SparklineBuilder HtmlAttributes(object htmlAttributes)
Parameters
Type Name Description
System.Object htmlAttributes
Returns
Type Description
SparklineBuilder

LineWidth(Double)

To configure sparkline line series width.

Declaration
public SparklineBuilder LineWidth(double lineWidth)
Parameters
Type Name Description
System.Double lineWidth
Returns
Type Description
SparklineBuilder

Load(String)

Triggers before sparkline render.

Declaration
public SparklineBuilder Load(string load)
Parameters
Type Name Description
System.String load
Returns
Type Description
SparklineBuilder

Loaded(String)

Triggers after sparkline rendered.

Declaration
public SparklineBuilder Loaded(string loaded)
Parameters
Type Name Description
System.String loaded
Returns
Type Description
SparklineBuilder

Locale(String)

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

Declaration
public SparklineBuilder Locale(string locale)
Parameters
Type Name Description
System.String locale
Returns
Type Description
SparklineBuilder

LowPointColor(String)

To configure sparkline series lowest y value point color.

Declaration
public SparklineBuilder LowPointColor(string lowPointColor)
Parameters
Type Name Description
System.String lowPointColor
Returns
Type Description
SparklineBuilder

MarkerRendering(String)

Triggers before the sparkline marker render.

Declaration
public SparklineBuilder MarkerRendering(string markerRendering)
Parameters
Type Name Description
System.String markerRendering
Returns
Type Description
SparklineBuilder

MarkerSettings(SparklineSparklineMarkerSettings)

To configure Sparkline marker configuration.

Declaration
public SparklineBuilder MarkerSettings(SparklineSparklineMarkerSettings markerSettings)
Parameters
Type Name Description
SparklineSparklineMarkerSettings markerSettings
Returns
Type Description
SparklineBuilder

MarkerSettings(Action<SparklineSparklineMarkerSettingsBuilder>)

Declaration
public SparklineBuilder MarkerSettings(Action<SparklineSparklineMarkerSettingsBuilder> markerSettings)
Parameters
Type Name Description
System.Action<SparklineSparklineMarkerSettingsBuilder> markerSettings
Returns
Type Description
SparklineBuilder

NegativePointColor(String)

To configure sparkline series negative y value point color.

Declaration
public SparklineBuilder NegativePointColor(string negativePointColor)
Parameters
Type Name Description
System.String negativePointColor
Returns
Type Description
SparklineBuilder

Opacity(Double)

To configure sparkline line series opacity.

Declaration
public SparklineBuilder Opacity(double opacity)
Parameters
Type Name Description
System.Double opacity
Returns
Type Description
SparklineBuilder

Padding(SparklinePadding)

To configure Sparkline container area customization.

Declaration
public SparklineBuilder Padding(SparklinePadding padding)
Parameters
Type Name Description
SparklinePadding padding
Returns
Type Description
SparklineBuilder

Padding(Action<SparklinePaddingBuilder>)

Declaration
public SparklineBuilder Padding(Action<SparklinePaddingBuilder> padding)
Parameters
Type Name Description
System.Action<SparklinePaddingBuilder> padding
Returns
Type Description
SparklineBuilder

Palette(String[])

To configure sparkline series color palette. It applicable to column and pie type series.

Declaration
public SparklineBuilder Palette(string[] palette)
Parameters
Type Name Description
System.String[] palette
Returns
Type Description
SparklineBuilder

PointRegionMouseClick(String)

Triggers while mouse click on the sparkline point region.

Declaration
public SparklineBuilder PointRegionMouseClick(string pointRegionMouseClick)
Parameters
Type Name Description
System.String pointRegionMouseClick
Returns
Type Description
SparklineBuilder

PointRegionMouseMove(String)

Triggers while mouse move on the sparkline point region.

Declaration
public SparklineBuilder PointRegionMouseMove(string pointRegionMouseMove)
Parameters
Type Name Description
System.String pointRegionMouseMove
Returns
Type Description
SparklineBuilder

PointRendering(String)

Triggers before sparkline points render.

Declaration
public SparklineBuilder PointRendering(string pointRendering)
Parameters
Type Name Description
System.String pointRendering
Returns
Type Description
SparklineBuilder

Query(String)

Specifies the query for filter the data.

Declaration
public SparklineBuilder Query(string query)
Parameters
Type Name Description
System.String query
Returns
Type Description
SparklineBuilder

RangeBandSettings(Action<SparklineRangeBandSettingBuilder>)

Declaration
public SparklineBuilder RangeBandSettings(Action<SparklineRangeBandSettingBuilder> rangeBandSettings)
Parameters
Type Name Description
System.Action<SparklineRangeBandSettingBuilder> rangeBandSettings
Returns
Type Description
SparklineBuilder

RangeBandSettings(List<SparklineRangeBandSetting>)

To configure Sparkline axis line customization.

Declaration
public SparklineBuilder RangeBandSettings(List<SparklineRangeBandSetting> rangeBandSettings)
Parameters
Type Name Description
System.Collections.Generic.List<SparklineRangeBandSetting> rangeBandSettings
Returns
Type Description
SparklineBuilder

RangePadding(SparklineRangePadding)

To configure Sparkline series type.

Declaration
public SparklineBuilder RangePadding(SparklineRangePadding rangePadding)
Parameters
Type Name Description
SparklineRangePadding rangePadding
Returns
Type Description
SparklineBuilder

Render()

Declaration
public HtmlString Render()
Returns
Type Description
System.Web.HtmlString

Resize(String)

Triggers on resizing the sparkline.

Declaration
public SparklineBuilder Resize(string resize)
Parameters
Type Name Description
System.String resize
Returns
Type Description
SparklineBuilder

SeriesRendering(String)

Triggers before sparkline series render.

Declaration
public SparklineBuilder SeriesRendering(string seriesRendering)
Parameters
Type Name Description
System.String seriesRendering
Returns
Type Description
SparklineBuilder

SparklineMouseClick(String)

Triggers while mouse click on the sparkline container.

Declaration
public SparklineBuilder SparklineMouseClick(string sparklineMouseClick)
Parameters
Type Name Description
System.String sparklineMouseClick
Returns
Type Description
SparklineBuilder

SparklineMouseMove(String)

Triggers while mouse move on the sparkline container.

Declaration
public SparklineBuilder SparklineMouseMove(string sparklineMouseMove)
Parameters
Type Name Description
System.String sparklineMouseMove
Returns
Type Description
SparklineBuilder

StartPointColor(String)

To configure sparkline series first x value point color.

Declaration
public SparklineBuilder StartPointColor(string startPointColor)
Parameters
Type Name Description
System.String startPointColor
Returns
Type Description
SparklineBuilder

Theme(SparklineTheme)

To configure sparkline theme.

Declaration
public SparklineBuilder Theme(SparklineTheme theme)
Parameters
Type Name Description
SparklineTheme theme
Returns
Type Description
SparklineBuilder

TiePointColor(String)

To configure sparkline winloss series tie y value point color.

Declaration
public SparklineBuilder TiePointColor(string tiePointColor)
Parameters
Type Name Description
System.String tiePointColor
Returns
Type Description
SparklineBuilder

TooltipInitialize(String)

Triggers before sparkline tooltip render.

Declaration
public SparklineBuilder TooltipInitialize(string tooltipInitialize)
Parameters
Type Name Description
System.String tooltipInitialize
Returns
Type Description
SparklineBuilder

TooltipSettings(SparklineSparklineTooltipSettings)

To configure Sparkline tooltip settings.

Declaration
public SparklineBuilder TooltipSettings(SparklineSparklineTooltipSettings tooltipSettings)
Parameters
Type Name Description
SparklineSparklineTooltipSettings tooltipSettings
Returns
Type Description
SparklineBuilder

TooltipSettings(Action<SparklineSparklineTooltipSettingsBuilder>)

Declaration
public SparklineBuilder TooltipSettings(Action<SparklineSparklineTooltipSettingsBuilder> tooltipSettings)
Parameters
Type Name Description
System.Action<SparklineSparklineTooltipSettingsBuilder> tooltipSettings
Returns
Type Description
SparklineBuilder

Type(SparklineType)

To configure Sparkline series type.

Declaration
public SparklineBuilder Type(SparklineType type)
Parameters
Type Name Description
SparklineType type
Returns
Type Description
SparklineBuilder

UseGroupingSeparator(Boolean)

To enable the separator

Declaration
public SparklineBuilder UseGroupingSeparator(bool useGroupingSeparator = true)
Parameters
Type Name Description
System.Boolean useGroupingSeparator
Returns
Type Description
SparklineBuilder

ValueType(SparklineValueType)

To configure sparkline series value type.

Declaration
public SparklineBuilder ValueType(SparklineValueType valueType)
Parameters
Type Name Description
SparklineValueType valueType
Returns
Type Description
SparklineBuilder

Width(String)

To configure Sparkline width.

Declaration
public SparklineBuilder Width(string width)
Parameters
Type Name Description
System.String width
Returns
Type Description
SparklineBuilder

XName(String)

To configure sparkline series xName.

Declaration
public SparklineBuilder XName(string xName)
Parameters
Type Name Description
System.String xName
Returns
Type Description
SparklineBuilder

YName(String)

To configure sparkline series yName.

Declaration
public SparklineBuilder YName(string yName)
Parameters
Type Name Description
System.String yName
Returns
Type Description
SparklineBuilder