Class IgbSparkline

Represents a sparkline chart.

Inheritance

System.Object

BaseRendererControl

IgbSparkline

Implements

JsonSerializable

System.IDisposable

Inherited Members

BaseRendererControl._cachedSerializedContent

BaseRendererControl.ResolveDisplay()

BaseRendererControl.ToSpinal(String)

BaseRendererControl.TransformSimpleKey(String)

BaseRendererControl.IsTransformedEnumValue(String)

BaseRendererControl.TransformPotentialEnumValue(String, Object)

BaseRendererControl.BuildSequenceInfo(Int32)

BaseRendererControl.BuildRenderTree(RenderTreeBuilder)

BaseRendererControl.TemplateContentType(String)

BaseRendererControl.OnAfterRenderAsync(Boolean)

BaseRendererControl.EnsureReady()

BaseRendererControl.MarkPropDirty(String)

BaseRendererControl.IsPropDirty(String)

BaseRendererControl.Serialize(SerializationContext, String)

BaseRendererControl.Serialize()

BaseRendererControl.InvokeMethod(String, Object[], String[], ElementReference[])

BaseRendererControl.InvokeMethodSync(String, Object[], String[], ElementReference[])

BaseRendererControl.SuspendNotifications(Object)

BaseRendererControl.ResumeNotifications(Object, Boolean)

BaseRendererControl.NotifyUpdateItem(Object, Int32, Object, Boolean)

BaseRendererControl.OnRefChanged(String, Object)

BaseRendererControl.OnInvokeReturn(Int64, Object)

BaseRendererControl.Camelize(String)

BaseRendererControl.ToPascal(String)

BaseRendererControl.OnElementNameChanged(BaseRendererElement, String, String)

BaseRendererControl.Dispose(Boolean)

BaseRendererControl.SetResourceStringAsync(String, String, String)

BaseRendererControl.SetResourceStringAsync(String, String)

BaseRendererControl.SetPropertyValue(Object, PropertyInfo, JsonElement)

BaseRendererControl.SetPropertyValue(Object, PropertyInfo, Object)

BaseRendererControl.Finalize()

BaseRendererControl.Dispose()

BaseRendererControl.IgBlazor

BaseRendererControl.Height

BaseRendererControl.Width

BaseRendererControl.Class

BaseRendererControl.AdditionalAttributes

BaseRendererControl.ChildContent

BaseRendererControl.SupportsVisualChildren

BaseRendererControl.UseDirectRender

BaseRendererControl.DirectRenderElementName

BaseRendererControl.NeedsDynamicContent

BaseRendererControl.UseCamelEnumValues

Namespace: IgniteUI.Blazor.Controls

Assembly: IgniteUI.Blazor.dll

Syntax

public class IgbSparkline : BaseRendererControl, JsonSerializable

Constructors

IgbSparkline()

Declaration

public IgbSparkline()

Properties

ActualHorizontalLabelFormatSpecifiers

Declaration

public IgbFormatSpecifierCollection ActualHorizontalLabelFormatSpecifiers { get; }

Property Value

Type	Description
IgbFormatSpecifierCollection

ActualPixelScalingRatio

Gets the actual scaling value used by the component to affect the pixel density of the control.

Declaration

public double ActualPixelScalingRatio { get; set; }

Property Value

Type	Description
System.Double

Remarks

A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control to appear blurry.

ActualVerticalLabelFormatSpecifiers

Declaration

public IgbFormatSpecifierCollection ActualVerticalLabelFormatSpecifiers { get; }

Property Value

Type	Description
IgbFormatSpecifierCollection

Brush

Gets or sets the sparkline brush.

Declaration

public string Brush { get; set; }

Property Value

Type	Description
System.String

ContentHorizontalLabelFormatSpecifiers

Declaration

public IgbFormatSpecifierCollection ContentHorizontalLabelFormatSpecifiers { get; }

Property Value

Type	Description
IgbFormatSpecifierCollection

ContentVerticalLabelFormatSpecifiers

Declaration

public IgbFormatSpecifierCollection ContentVerticalLabelFormatSpecifiers { get; }

Property Value

Type	Description
IgbFormatSpecifierCollection

DataSource

Gets or sets the ItemsSource of the sparkline.

Declaration

public object DataSource { get; set; }

Property Value

Type	Description
System.Object

DataSourceScript

Provides a means of setting DataSource in the JavaScript environment.

Declaration

public string DataSourceScript { get; set; }

Property Value

Type	Description
System.String

DisplayNormalRangeInFront

Gets or sets the position of the normal range on the sparkline.

Declaration

public bool DisplayNormalRangeInFront { get; set; }

Property Value

Type	Description
System.Boolean

DisplayType

Gets or sets the display type of the sparkline.

Declaration

public SparklineDisplayType DisplayType { get; set; }

Property Value

Type	Description
SparklineDisplayType

FirstMarkerBrush

Gets or sets the first marker brush of the sparkline.

Declaration

public string FirstMarkerBrush { get; set; }

Property Value

Type	Description
System.String

FirstMarkerSize

Gets or sets the first marker size of the sparkline.

Declaration

public double FirstMarkerSize { get; set; }

Property Value

Type	Description
System.Double

FirstMarkerVisibility

Gets or sets the first marker visibility of the sparkline.

Declaration

public Visibility FirstMarkerVisibility { get; set; }

Property Value

Type	Description
Visibility

HighMarkerBrush

Gets or sets the high marker brush of the sparkline.

Declaration

public string HighMarkerBrush { get; set; }

Property Value

Type	Description
System.String

HighMarkerSize

Gets or sets the high marker size of the sparkline.

Declaration

public double HighMarkerSize { get; set; }

Property Value

Type	Description
System.Double

HighMarkerVisibility

Gets or sets the high marker visibility of the sparkline.

Declaration

public Visibility HighMarkerVisibility { get; set; }

Property Value

Type	Description
Visibility

HorizontalAxisBrush

Gets or sets the horizontal axis line brush of the sparkline.

Declaration

public string HorizontalAxisBrush { get; set; }

Property Value

Type	Description
System.String

HorizontalAxisLabel

The value or content to display on the horizontal axis.

Declaration

public object HorizontalAxisLabel { get; set; }

Property Value

Type	Description
System.Object

Remarks

This can be set to a formatted string, such as "{0}", or it can be set to a DataTemplate.

HorizontalAxisLabelScript

Provides a means of setting HorizontalAxisLabel in the JavaScript environment.

Declaration

public string HorizontalAxisLabelScript { get; set; }

Property Value

Type	Description
System.String

HorizontalAxisVisibility

Gets or sets the display state of the horizontal axis.

Declaration

public Visibility HorizontalAxisVisibility { get; set; }

Property Value

Type	Description
Visibility

HorizontalLabelFormat

Gets or sets the label composite format used when creating label values.

Declaration

public string HorizontalLabelFormat { get; set; }

Property Value

Type	Description
System.String

HorizontalLabelFormatSpecifiers

Gets or sets the format specifiers to use with the HorizontalLabelFormat string.

Declaration

public IgbFormatSpecifierCollection HorizontalLabelFormatSpecifiers { get; set; }

Property Value

Type	Description
IgbFormatSpecifierCollection

LabelMemberPath

String identifier of a column or property name to get labels from on each item in the data source. These labels will be retrieved from the first and last item, and displayed by the horizontal axis.

Declaration

public string LabelMemberPath { get; set; }

Property Value

Type	Description
System.String

LastMarkerBrush

Gets or sets the last marker brush of the sparkline.

Declaration

public string LastMarkerBrush { get; set; }

Property Value

Type	Description
System.String

LastMarkerSize

Gets or sets the last marker size of the sparkline.

Declaration

public double LastMarkerSize { get; set; }

Property Value

Type	Description
System.Double

LastMarkerVisibility

Gets or sets the last marker visibility of the sparkline.

Declaration

public Visibility LastMarkerVisibility { get; set; }

Property Value

Type	Description
Visibility

LineThickness

Gets or sets the line thickness of the sparkline.

Declaration

public double LineThickness { get; set; }

Property Value

Type	Description
System.Double

LowMarkerBrush

Gets or sets the low marker brush of the sparkline.

Declaration

public string LowMarkerBrush { get; set; }

Property Value

Type	Description
System.String

LowMarkerSize

Gets or sets the low marker size of the sparkline.

Declaration

public double LowMarkerSize { get; set; }

Property Value

Type	Description
System.Double

LowMarkerVisibility

Gets or sets the low marker visibility of the sparkline.

Declaration

public Visibility LowMarkerVisibility { get; set; }

Property Value

Type	Description
Visibility

MarkerBrush

Gets or sets the marker brush of the sparkline.

Declaration

public string MarkerBrush { get; set; }

Property Value

Type	Description
System.String

MarkerSize

Gets or sets the marker size of the sparkline.

Declaration

public double MarkerSize { get; set; }

Property Value

Type	Description
System.Double

MarkerVisibility

Gets or sets the marker visibility of the sparkline.

Declaration

public Visibility MarkerVisibility { get; set; }

Property Value

Type	Description
Visibility

Maximum

Gets or sets the maximum value of the y axis.

Declaration

public double Maximum { get; set; }

Property Value

Type	Description
System.Double

Minimum

Gets or sets the minimum value of the y axis.

Declaration

public double Minimum { get; set; }

Property Value

Type	Description
System.Double

NegativeBrush

Gets or sets the negative brush of the sparkline.

Declaration

public string NegativeBrush { get; set; }

Property Value

Type	Description
System.String

NegativeMarkerBrush

Gets or sets the negative marker brush of the sparkline.

Declaration

public string NegativeMarkerBrush { get; set; }

Property Value

Type	Description
System.String

NegativeMarkerSize

Gets or sets the negative marker size of the sparkline.

Declaration

public double NegativeMarkerSize { get; set; }

Property Value

Type	Description
System.Double

NegativeMarkerVisibility

Gets or sets the negative marker visibility of the sparkline.

Declaration

public Visibility NegativeMarkerVisibility { get; set; }

Property Value

Type	Description
Visibility

NormalRangeFill

Gets or sets the normal range brush of the sparkline.

Declaration

public string NormalRangeFill { get; set; }

Property Value

Type	Description
System.String

NormalRangeMaximum

Gets or sets the maximum value of the normal range.

Declaration

public double NormalRangeMaximum { get; set; }

Property Value

Type	Description
System.Double

NormalRangeMinimum

Gets or sets the minimum value of the normal range.

Declaration

public double NormalRangeMinimum { get; set; }

Property Value

Type	Description
System.Double

NormalRangeVisibility

Gets or sets the normal range visibility of the sparkline.

Declaration

public Visibility NormalRangeVisibility { get; set; }

Property Value

Type	Description
Visibility

ParentTypeName

Declaration

protected override string ParentTypeName { get; }

Property Value

Type	Description
System.String

Overrides

BaseRendererControl.ParentTypeName

PixelScalingRatio

Gets or sets the scaling value used to affect the pixel density of the control.

Declaration

public double PixelScalingRatio { get; set; }

Property Value

Type	Description
System.Double

Remarks

A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control to appear blurry.

TrendLineBrush

Gets or sets the trendline brush of the sparkline.

Declaration

public string TrendLineBrush { get; set; }

Property Value

Type	Description
System.String

TrendLinePeriod

Gets or sets the trendline period used by the sparkline.

Declaration

public int TrendLinePeriod { get; set; }

Property Value

Type	Description
System.Int32

TrendLineThickness

Gets or sets the thickness of the sparkline's trendline.

Declaration

public double TrendLineThickness { get; set; }

Property Value

Type	Description
System.Double

TrendLineType

Gets or sets the type of trendline used by the sparkline.

Declaration

public TrendLineType TrendLineType { get; set; }

Property Value

Type	Description
TrendLineType

Type

Declaration

public override string Type { get; }

Property Value

Type	Description
System.String

Overrides

BaseRendererControl.Type

UnknownValuePlotting

Gets or sets the way null values are interpreted.

Declaration

public UnknownValuePlotting UnknownValuePlotting { get; set; }

Property Value

Type	Description
UnknownValuePlotting

ValueMemberPath

Gets or sets the string path to the value column.

Declaration

public string ValueMemberPath { get; set; }

Property Value

Type	Description
System.String

VerticalAxisBrush

Gets or sets the vertical axis line brush of the sparkline.

Declaration

public string VerticalAxisBrush { get; set; }

Property Value

Type	Description
System.String

VerticalAxisLabel

The value or content to display on the vertical axis.

Declaration

public object VerticalAxisLabel { get; set; }

Property Value

Type	Description
System.Object

Remarks

This can be set to a formatted string, such as "{0:n}", or it can be set to a DataTemplate.

VerticalAxisLabelScript

Provides a means of setting VerticalAxisLabel in the JavaScript environment.

Declaration

public string VerticalAxisLabelScript { get; set; }

Property Value

Type	Description
System.String

VerticalAxisVisibility

Gets or sets the display state of the vertical axis.

Declaration

public Visibility VerticalAxisVisibility { get; set; }

Property Value

Type	Description
Visibility

VerticalLabelFormat

Gets or sets the label composite format used when creating label values.

Declaration

public string VerticalLabelFormat { get; set; }

Property Value

Type	Description
System.String

VerticalLabelFormatSpecifiers

Gets or sets the format specifiers to use with the VerticalLabelFormat string.

Declaration

public IgbFormatSpecifierCollection VerticalLabelFormatSpecifiers { get; set; }

Property Value

Type	Description
IgbFormatSpecifierCollection

Methods

EnsureModulesLoaded()

Declaration

protected override void EnsureModulesLoaded()

Overrides

BaseRendererControl.EnsureModulesLoaded()

ExportSerializedVisualData()

Declaration

public string ExportSerializedVisualData()

Returns

Type	Description
System.String

ExportSerializedVisualDataAsync()

Returns visuals as a serialized string.

Declaration

public Task<string> ExportSerializedVisualDataAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.String>

FindByName(String)

Declaration

public override object FindByName(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
System.Object

Overrides

BaseRendererControl.FindByName(String)

NotifyClearItems(Object)

Declaration

public void NotifyClearItems(object source_)

Parameters

Type	Name	Description
System.Object	source_

NotifyClearItemsAsync(Object)

Used to manually notify the IgbSparkline that the data source has reset or cleared its items. Invoking this method is only necessary if that datasource is not observable.

Declaration

public Task NotifyClearItemsAsync(object source_)

Parameters

Type	Name	Description
System.Object	source_	The data source which was cleared or reset.

Returns

Type	Description
System.Threading.Tasks.Task

NotifyInsertItem(Object, Int32, Object)

Declaration

public void NotifyInsertItem(object source_, int index, object newItem)

Parameters

Type	Name	Description
System.Object	source_
System.Int32	index
System.Object	newItem

NotifyInsertItemAsync(Object, Int32, Object)

Declaration

public Task NotifyInsertItemAsync(object source_, int index, object newItem)

Parameters

Type	Name	Description
System.Object	source_
System.Int32	index
System.Object	newItem

Returns

Type	Description
System.Threading.Tasks.Task

NotifyRemoveItem(Object, Int32, Object)

Declaration

public void NotifyRemoveItem(object source_, int index, object oldItem)

Parameters

Type	Name	Description
System.Object	source_
System.Int32	index
System.Object	oldItem

NotifyRemoveItemAsync(Object, Int32, Object)

Declaration

public Task NotifyRemoveItemAsync(object source_, int index, object oldItem)

Parameters

Type	Name	Description
System.Object	source_
System.Int32	index
System.Object	oldItem

Returns

Type	Description
System.Threading.Tasks.Task

NotifyResized()

Declaration

public void NotifyResized()

NotifyResizedAsync()

Notify that the control has resized.

Declaration

public Task NotifyResizedAsync()

Returns

Type	Description
System.Threading.Tasks.Task

NotifySetItem(Object, Int32, Object, Object)

Declaration

public void NotifySetItem(object source_, int index, object oldItem, object newItem)

Parameters

Type	Name	Description
System.Object	source_
System.Int32	index
System.Object	oldItem
System.Object	newItem

NotifySetItemAsync(Object, Int32, Object, Object)

Declaration

public Task NotifySetItemAsync(object source_, int index, object oldItem, object newItem)

Parameters

Type	Name	Description
System.Object	source_
System.Int32	index
System.Object	oldItem
System.Object	newItem

Returns

Type	Description
System.Threading.Tasks.Task

ProvideContainer(Object)

Declaration

public void ProvideContainer(object container)

Parameters

Type	Name	Description
System.Object	container

ProvideContainerAsync(Object)

Provides a container to the sparkline control.

Declaration

public Task ProvideContainerAsync(object container)

Parameters

Type	Name	Description
System.Object	container	The container.

Returns

Type	Description
System.Threading.Tasks.Task

Implements

JsonSerializable

System.IDisposable