Represents a sparkline chart.
Inheritance
object
ComponentBase
- IComponent
- IHandleEvent
- IHandleAfterRender
- JsonSerializable
- IDisposable
Constructors
Section titled "Constructors"constructor
public IgbSparkline()Returns IgbSparkline
Properties
Section titled "Properties"IgBlazor
Section titled "IgBlazor"Inherited from: BaseRendererControl
[Inject]
protected IIgniteUIBlazor IgBlazor { get; set; }Height
Section titled "Height"Inherited from: BaseRendererControl
[Parameter]
public string Height { get; set; }Width
Section titled "Width"Inherited from: BaseRendererControl
[Parameter]
public string Width { get; set; }Class
Section titled "Class"Inherited from: BaseRendererControl
[Parameter]
public string Class { get; set; }AdditionalAttributes
Section titled "AdditionalAttributes"Inherited from: BaseRendererControl
[Parameter(CaptureUnmatchedValues = true)]
public Dictionary<string, object> AdditionalAttributes { get; set; }EventBehavior
Section titled "EventBehavior"Inherited from: BaseRendererControl
Gets or sets how events are bubbled up from JavaScript to Blazor.
[Parameter]
public ControlEventBehavior EventBehavior { get; set; }ChildContent
Section titled "ChildContent"Inherited from: BaseRendererControl
[Parameter]
public RenderFragment ChildContent { get; set; }RoundTripDateConversion
Section titled "RoundTripDateConversion"Inherited from: BaseRendererControl
Gets or sets what type of date conversion to make when round tripping dates.
[Parameter]
public RoundTripDateConversion RoundTripDateConversion { get; set; }SupportsVisualChildren
Section titled "SupportsVisualChildren"Inherited from: BaseRendererControl
protected virtual bool SupportsVisualChildren { get; }UseDirectRender
Section titled "UseDirectRender"Inherited from: BaseRendererControl
protected virtual bool UseDirectRender { get; }DirectRenderElementName
Section titled "DirectRenderElementName"Inherited from: BaseRendererControl
protected virtual string DirectRenderElementName { get; }NeedsDynamicContent
Section titled "NeedsDynamicContent"Inherited from: BaseRendererControl
protected virtual bool NeedsDynamicContent { get; }UseCamelEnumValues
Section titled "UseCamelEnumValues"Inherited from: BaseRendererControl
protected virtual bool UseCamelEnumValues { get; }ActualHorizontalLabelFormatSpecifiers
Section titled "ActualHorizontalLabelFormatSpecifiers"public IgbFormatSpecifierCollection ActualHorizontalLabelFormatSpecifiers { get; }ActualPixelScalingRatio
Section titled "ActualPixelScalingRatio"Gets the actual scaling value used by the component to affect the pixel density of the control.
[Parameter]
public double ActualPixelScalingRatio { get; set; }ActualVerticalLabelFormatSpecifiers
Section titled "ActualVerticalLabelFormatSpecifiers"public IgbFormatSpecifierCollection ActualVerticalLabelFormatSpecifiers { get; }Brush
Section titled "Brush"Gets or sets the sparkline brush.
[Parameter]
public string Brush { get; set; }ContentHorizontalLabelFormatSpecifiers
Section titled "ContentHorizontalLabelFormatSpecifiers"public IgbFormatSpecifierCollection ContentHorizontalLabelFormatSpecifiers { get; }ContentVerticalLabelFormatSpecifiers
Section titled "ContentVerticalLabelFormatSpecifiers"public IgbFormatSpecifierCollection ContentVerticalLabelFormatSpecifiers { get; }DataSource
Section titled "DataSource"Gets or sets the ItemsSource of the sparkline.
[Parameter]
public object DataSource { get; set; }DataSourceScript
Section titled "DataSourceScript"Provides a means of setting DataSource in the JavaScript environment.
[Parameter]
public string DataSourceScript { get; set; }DefaultEventBehavior
Section titled "DefaultEventBehavior"Gets the components default event behavior.
protected override ControlEventBehavior DefaultEventBehavior { get; }DisplayNormalRangeInFront
Section titled "DisplayNormalRangeInFront"Gets or sets the position of the normal range on the sparkline.
[Parameter]
public bool DisplayNormalRangeInFront { get; set; }DisplayType
Section titled "DisplayType"Gets or sets the display type of the sparkline.
[Parameter]
public SparklineDisplayType DisplayType { get; set; }FirstMarkerBrush
Section titled "FirstMarkerBrush"Gets or sets the first marker brush of the sparkline.
[Parameter]
public string FirstMarkerBrush { get; set; }FirstMarkerSize
Section titled "FirstMarkerSize"Gets or sets the first marker size of the sparkline.
[Parameter]
public double FirstMarkerSize { get; set; }FirstMarkerVisibility
Section titled "FirstMarkerVisibility"Gets or sets the first marker visibility of the sparkline.
[Parameter]
public Visibility FirstMarkerVisibility { get; set; }FormatLabel
Section titled "FormatLabel"Sets or gets a function which takes an object that produces a formatted label for displaying in the chart.
[Parameter]
public string FormatLabel { get; set; }FormatLabelScript
Section titled "FormatLabelScript"Provides a means of setting FormatLabel in the JavaScript environment.
[Parameter]
public string FormatLabelScript { get; set; }HighMarkerBrush
Section titled "HighMarkerBrush"Gets or sets the high marker brush of the sparkline.
[Parameter]
public string HighMarkerBrush { get; set; }HighMarkerSize
Section titled "HighMarkerSize"Gets or sets the high marker size of the sparkline.
[Parameter]
public double HighMarkerSize { get; set; }HighMarkerVisibility
Section titled "HighMarkerVisibility"Gets or sets the high marker visibility of the sparkline.
[Parameter]
public Visibility HighMarkerVisibility { get; set; }HorizontalAxisBrush
Section titled "HorizontalAxisBrush"Gets or sets the horizontal axis line brush of the sparkline.
[Parameter]
public string HorizontalAxisBrush { get; set; }HorizontalAxisLabel
Section titled "HorizontalAxisLabel"The value or content to display on the horizontal axis.
[Parameter]
public object HorizontalAxisLabel { get; set; }HorizontalAxisLabelScript
Section titled "HorizontalAxisLabelScript"Provides a means of setting HorizontalAxisLabel in the JavaScript environment.
[Parameter]
public string HorizontalAxisLabelScript { get; set; }HorizontalAxisVisibility
Section titled "HorizontalAxisVisibility"Gets or sets the display state of the horizontal axis.
[Parameter]
public Visibility HorizontalAxisVisibility { get; set; }HorizontalLabelFormat
Section titled "HorizontalLabelFormat"Gets or sets the label composite format used when creating label values.
[Parameter]
public string HorizontalLabelFormat { get; set; }HorizontalLabelFormatSpecifiers
Section titled "HorizontalLabelFormatSpecifiers"Gets or sets the format specifiers to use with the HorizontalLabelFormat string.
public IgbFormatSpecifierCollection HorizontalLabelFormatSpecifiers { get; set; }LabelMemberPath
Section titled "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.
[Parameter]
public string LabelMemberPath { get; set; }LastMarkerBrush
Section titled "LastMarkerBrush"Gets or sets the last marker brush of the sparkline.
[Parameter]
public string LastMarkerBrush { get; set; }LastMarkerSize
Section titled "LastMarkerSize"Gets or sets the last marker size of the sparkline.
[Parameter]
public double LastMarkerSize { get; set; }LastMarkerVisibility
Section titled "LastMarkerVisibility"Gets or sets the last marker visibility of the sparkline.
[Parameter]
public Visibility LastMarkerVisibility { get; set; }LineThickness
Section titled "LineThickness"Gets or sets the line thickness of the sparkline.
[Parameter]
public double LineThickness { get; set; }LowMarkerBrush
Section titled "LowMarkerBrush"Gets or sets the low marker brush of the sparkline.
[Parameter]
public string LowMarkerBrush { get; set; }LowMarkerSize
Section titled "LowMarkerSize"Gets or sets the low marker size of the sparkline.
[Parameter]
public double LowMarkerSize { get; set; }LowMarkerVisibility
Section titled "LowMarkerVisibility"Gets or sets the low marker visibility of the sparkline.
[Parameter]
public Visibility LowMarkerVisibility { get; set; }MarkerBrush
Section titled "MarkerBrush"Gets or sets the marker brush of the sparkline.
[Parameter]
public string MarkerBrush { get; set; }MarkerSize
Section titled "MarkerSize"Gets or sets the marker size of the sparkline.
[Parameter]
public double MarkerSize { get; set; }MarkerVisibility
Section titled "MarkerVisibility"Gets or sets the marker visibility of the sparkline.
[Parameter]
public Visibility MarkerVisibility { get; set; }Maximum
Section titled "Maximum"Gets or sets the maximum value of the y axis.
[Parameter]
public double Maximum { get; set; }Minimum
Section titled "Minimum"Gets or sets the minimum value of the y axis.
[Parameter]
public double Minimum { get; set; }NegativeBrush
Section titled "NegativeBrush"Gets or sets the negative brush of the sparkline.
[Parameter]
public string NegativeBrush { get; set; }NegativeMarkerBrush
Section titled "NegativeMarkerBrush"Gets or sets the negative marker brush of the sparkline.
[Parameter]
public string NegativeMarkerBrush { get; set; }NegativeMarkerSize
Section titled "NegativeMarkerSize"Gets or sets the negative marker size of the sparkline.
[Parameter]
public double NegativeMarkerSize { get; set; }NegativeMarkerVisibility
Section titled "NegativeMarkerVisibility"Gets or sets the negative marker visibility of the sparkline.
[Parameter]
public Visibility NegativeMarkerVisibility { get; set; }NormalRangeFill
Section titled "NormalRangeFill"Gets or sets the normal range brush of the sparkline.
[Parameter]
public string NormalRangeFill { get; set; }NormalRangeMaximum
Section titled "NormalRangeMaximum"Gets or sets the maximum value of the normal range.
[Parameter]
public double NormalRangeMaximum { get; set; }NormalRangeMinimum
Section titled "NormalRangeMinimum"Gets or sets the minimum value of the normal range.
[Parameter]
public double NormalRangeMinimum { get; set; }NormalRangeVisibility
Section titled "NormalRangeVisibility"Gets or sets the normal range visibility of the sparkline.
[Parameter]
public Visibility NormalRangeVisibility { get; set; }PixelScalingRatio
Section titled "PixelScalingRatio"Gets or sets the scaling value used to affect the pixel density of the control.
[Parameter]
public double PixelScalingRatio { get; set; }TextColor
Section titled "TextColor"Gets or sets the text color for the axis labels.
[Parameter]
public string TextColor { get; set; }TrendLineBrush
Section titled "TrendLineBrush"Gets or sets the trendline brush of the sparkline.
[Parameter]
public string TrendLineBrush { get; set; }TrendLinePeriod
Section titled "TrendLinePeriod"Gets or sets the trendline period used by the sparkline.
[Parameter]
public int TrendLinePeriod { get; set; }TrendLineThickness
Section titled "TrendLineThickness"Gets or sets the thickness of the sparkline's trendline.
[Parameter]
public double TrendLineThickness { get; set; }TrendLineType
Section titled "TrendLineType"Gets or sets the type of trendline used by the sparkline.
[Parameter]
public TrendLineType TrendLineType { get; set; }UnknownValuePlotting
Section titled "UnknownValuePlotting"Gets or sets the way null values are interpreted.
[Parameter]
public UnknownValuePlotting UnknownValuePlotting { get; set; }ValueMemberPath
Section titled "ValueMemberPath"Gets or sets the string path to the value column.
[Parameter]
public string ValueMemberPath { get; set; }VerticalAxisBrush
Section titled "VerticalAxisBrush"Gets or sets the vertical axis line brush of the sparkline.
[Parameter]
public string VerticalAxisBrush { get; set; }VerticalAxisLabel
Section titled "VerticalAxisLabel"The value or content to display on the vertical axis.
[Parameter]
public object VerticalAxisLabel { get; set; }VerticalAxisLabelScript
Section titled "VerticalAxisLabelScript"Provides a means of setting VerticalAxisLabel in the JavaScript environment.
[Parameter]
public string VerticalAxisLabelScript { get; set; }VerticalAxisVisibility
Section titled "VerticalAxisVisibility"Gets or sets the display state of the vertical axis.
[Parameter]
public Visibility VerticalAxisVisibility { get; set; }VerticalLabelFormat
Section titled "VerticalLabelFormat"Gets or sets the label composite format used when creating label values.
[Parameter]
public string VerticalLabelFormat { get; set; }VerticalLabelFormatSpecifiers
Section titled "VerticalLabelFormatSpecifiers"Gets or sets the format specifiers to use with the VerticalLabelFormat string.
public IgbFormatSpecifierCollection VerticalLabelFormatSpecifiers { get; set; }Accessors
Section titled "Accessors"eventCallbacksCache
Section titled "eventCallbacksCache"Inherited from: BaseRendererControl
protected Dictionary<Type, Dictionary<string, FieldInfo>> eventCallbacksCache_cachedSerializedContent
Section titled "_cachedSerializedContent"Inherited from: BaseRendererControl
protected string _cachedSerializedContentMethods
Section titled "Methods"ResolveEventBehavior()
Section titled "ResolveEventBehavior()"Inherited from: BaseRendererControl
Resolves the components event behavior if Auto is selected.
protected ControlEventBehavior ResolveEventBehavior()Returns any
ResolveDisplay()
Section titled "ResolveDisplay()"Inherited from: BaseRendererControl
protected virtual string ResolveDisplay()Returns any
ToSpinal(string)
Section titled "ToSpinal(string)"Inherited from: BaseRendererControl
protected string ToSpinal(string value)Parameters
- value:
string
Returns any
TransformSimpleKey(string)
Section titled "TransformSimpleKey(string)"Inherited from: BaseRendererControl
protected virtual string TransformSimpleKey(string key)Parameters
- key:
string
Returns any
IsTransformedEnumValue(string)
Section titled "IsTransformedEnumValue(string)"Inherited from: BaseRendererControl
protected virtual bool IsTransformedEnumValue(string key)Parameters
- key:
string
Returns any
TransformPotentialEnumValue(string, object)
Section titled "TransformPotentialEnumValue(string, object)"Inherited from: BaseRendererControl
protected virtual object TransformPotentialEnumValue(string key, object value)Parameters
- key:
string - value:
object
Returns any
BuildSequenceInfo(int)
Section titled "BuildSequenceInfo(int)"Inherited from: BaseRendererControl
protected virtual SequenceInfo BuildSequenceInfo(int startSequence)Parameters
- startSequence:
int
Returns any
BuildRenderTree(RenderTreeBuilder)
Section titled "BuildRenderTree(RenderTreeBuilder)"Inherited from: BaseRendererControl
protected override void BuildRenderTree(RenderTreeBuilder builder)Parameters
- builder:
RenderTreeBuilder
Returns any
TemplateContentType(string)
Section titled "TemplateContentType(string)"Inherited from: BaseRendererControl
protected Type TemplateContentType(string templateId)Parameters
- templateId:
string
Returns any
OnAfterRenderAsync(bool)
Section titled "OnAfterRenderAsync(bool)"Inherited from: BaseRendererControl
protected override Task OnAfterRenderAsync(bool firstRender)Parameters
- firstRender:
bool
Returns any
EnsureReady()
Section titled "EnsureReady()"Inherited from: BaseRendererControl
public Task EnsureReady()Returns any
MarkPropDirty(string)
Section titled "MarkPropDirty(string)"Inherited from: BaseRendererControl
protected void MarkPropDirty(string propertyName)Parameters
- propertyName:
string
Returns any
IsPropDirty(string)
Section titled "IsPropDirty(string)"Inherited from: BaseRendererControl
protected bool IsPropDirty(string propertyName)Parameters
- propertyName:
string
Returns any
Serialize(SerializationContext, string)
Section titled "Serialize(SerializationContext, string)"Inherited from: BaseRendererControl
public void Serialize(SerializationContext context, string propertyName = null)Parameters
- context:
SerializationContext - propertyName:
string
Returns any
Serialize()
Section titled "Serialize()"Inherited from: BaseRendererControl
public string Serialize()Returns any
InvokeMethod(string, object[], string[], ElementReference[])
Section titled "InvokeMethod(string, object[], string[], ElementReference[])"Inherited from: BaseRendererControl
protected Task<object> InvokeMethod(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
InvokeMethodSync(string, object[], string[], ElementReference[])
Section titled "InvokeMethodSync(string, object[], string[], ElementReference[])"Inherited from: BaseRendererControl
protected object InvokeMethodSync(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
SuspendNotifications(object)
Section titled "SuspendNotifications(object)"Inherited from: BaseRendererControl
Prevents data change notifications from be propagated to the component.
public void SuspendNotifications(object dataSource)Parameters
- dataSource:
object
Returns any
ResumeNotifications(object, bool)
Section titled "ResumeNotifications(object, bool)"Inherited from: BaseRendererControl
Resumes data change notifications.
public void ResumeNotifications(object dataSource, bool notify = true)Parameters
- dataSource:
object - notify:
bool
Returns any
NotifyUpdateItem(object, int, object, bool)
Section titled "NotifyUpdateItem(object, int, object, bool)"Inherited from: BaseRendererControl
public void NotifyUpdateItem(object dataSource, int index, object refItem, bool syncDataOnly = false)Parameters
- dataSource:
object - index:
int - refItem:
object - syncDataOnly:
bool
Returns any
OnRefChanged(string, object)
Section titled "OnRefChanged(string, object)"Inherited from: BaseRendererControl
public void OnRefChanged(string refName, object refValue)Parameters
- refName:
string - refValue:
object
Returns any
OnInvokeReturn(long, object)
Section titled "OnInvokeReturn(long, object)"Inherited from: BaseRendererControl
public void OnInvokeReturn(long invokeId, object returnValue)Parameters
- invokeId:
long - returnValue:
object
Returns any
Camelize(string)
Section titled "Camelize(string)"Inherited from: BaseRendererControl
protected string Camelize(string value)Parameters
- value:
string
Returns any
ToPascal(string)
Section titled "ToPascal(string)"Inherited from: BaseRendererControl
protected string ToPascal(string value)Parameters
- value:
string
Returns any
OnElementNameChanged(BaseRendererElement, string, string)
Section titled "OnElementNameChanged(BaseRendererElement, string, string)"Inherited from: BaseRendererControl
protected void OnElementNameChanged(BaseRendererElement element, string oldName, string newName)Parameters
- element:
BaseRendererElement - oldName:
string - newName:
string
Returns any
Dispose(bool)
Section titled "Dispose(bool)"Inherited from: BaseRendererControl
protected virtual void Dispose(bool disposing)Parameters
- disposing:
bool
Returns any
SetResourceStringAsync(string, string, string)
Section titled "SetResourceStringAsync(string, string, string)"Inherited from: BaseRendererControl
public Task<object> SetResourceStringAsync(string grouping, string id, string value)Parameters
- grouping:
string - id:
string - value:
string
Returns any
SetResourceStringAsync(string, string)
Section titled "SetResourceStringAsync(string, string)"Inherited from: BaseRendererControl
public Task<object> SetResourceStringAsync(string grouping, string json)Parameters
- grouping:
string - json:
string
Returns any
SetPropertyValue(object, PropertyInfo, JsonElement)
Section titled "SetPropertyValue(object, PropertyInfo, JsonElement)"Inherited from: BaseRendererControl
protected void SetPropertyValue(object item, PropertyInfo property, JsonElement jsonElement)Parameters
- item:
object - property:
PropertyInfo - jsonElement:
JsonElement
Returns any
SetPropertyValue(object, PropertyInfo, object)
Section titled "SetPropertyValue(object, PropertyInfo, object)"Inherited from: BaseRendererControl
protected void SetPropertyValue(object item, PropertyInfo property, object value)Parameters
- item:
object - property:
PropertyInfo - value:
object
Returns any
Dispose()
Section titled "Dispose()"Inherited from: BaseRendererControl
public void Dispose()Returns any
EnsureModulesLoaded()
Section titled "EnsureModulesLoaded()"protected override void EnsureModulesLoaded()Returns any
ExportSerializedVisualData()
Section titled "ExportSerializedVisualData()"public string ExportSerializedVisualData()Returns any
ExportSerializedVisualDataAsync()
Section titled "ExportSerializedVisualDataAsync()"Returns visuals as a serialized string.
public Task<string> ExportSerializedVisualDataAsync()Returns any
FindByName(string)
Section titled "FindByName(string)"public override object FindByName(string name)Parameters
- name:
string
Returns any
NotifyClearItems(object)
Section titled "NotifyClearItems(object)"public void NotifyClearItems(object source_)Parameters
- source_:
object
Returns any
NotifyClearItemsAsync(object)
Section titled "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.
public Task NotifyClearItemsAsync(object source_)Parameters
- source_:
object
Returns any
NotifyInsertItem(object, int, object)
Section titled "NotifyInsertItem(object, int, object)"public void NotifyInsertItem(object source_, int index, object newItem)Parameters
- source_:
object - index:
int - newItem:
object
Returns any
NotifyInsertItemAsync(object, int, object)
Section titled "NotifyInsertItemAsync(object, int, object)"public Task NotifyInsertItemAsync(object source_, int index, object newItem)Parameters
- source_:
object - index:
int - newItem:
object
Returns any
NotifyRemoveItem(object, int, object)
Section titled "NotifyRemoveItem(object, int, object)"public void NotifyRemoveItem(object source_, int index, object oldItem)Parameters
- source_:
object - index:
int - oldItem:
object
Returns any
NotifyRemoveItemAsync(object, int, object)
Section titled "NotifyRemoveItemAsync(object, int, object)"public Task NotifyRemoveItemAsync(object source_, int index, object oldItem)Parameters
- source_:
object - index:
int - oldItem:
object
Returns any
NotifyResized()
Section titled "NotifyResized()"public void NotifyResized()Returns any
NotifyResizedAsync()
Section titled "NotifyResizedAsync()"Notify that the control has resized.
public Task NotifyResizedAsync()Returns any
NotifySetItem(object, int, object, object)
Section titled "NotifySetItem(object, int, object, object)"public void NotifySetItem(object source_, int index, object oldItem, object newItem)Parameters
- source_:
object - index:
int - oldItem:
object - newItem:
object
Returns any
NotifySetItemAsync(object, int, object, object)
Section titled "NotifySetItemAsync(object, int, object, object)"public Task NotifySetItemAsync(object source_, int index, object oldItem, object newItem)Parameters
- source_:
object - index:
int - oldItem:
object - newItem:
object
Returns any
ProvideContainer(object)
Section titled "ProvideContainer(object)"public void ProvideContainer(object container)Parameters
- container:
object
Returns any
ProvideContainerAsync(object)
Section titled "ProvideContainerAsync(object)"Provides a container to the sparkline control.
public Task ProvideContainerAsync(object container)Parameters
- container:
object