Class SfBulletChart<TValue>

Bullet Chart control is used to display the one or more measures and compares them to a target value with built-in features like orientation, qualitative ranges, multiple measures, labels, tooltip and animation.

Inheritance

System.Object

SfBaseComponent

SfBulletChart<TValue>

Implements

IBulletChart

Inherited Members

SfBaseComponent.Dispose()

SfBaseComponent.Dispose(Boolean)

Namespace: Syncfusion.Blazor.Charts

Assembly: Syncfusion.Blazor.dll

Syntax

public class SfBulletChart<TValue> : SfBaseComponent, IBulletChart

Type Parameters

Name	Description
TValue	Represents the generic data type of the bullet chart control.

Constructors

SfBulletChart()

Declaration

public SfBulletChart()

Properties

CategoryField

It defines the category for the data source.

Declaration

public string CategoryField { get; set; }

Property Value

Type	Description
System.String	Accepts the string value. A string value representing the category field in the data source.

ChildContent

Sets and gets the content of the UI element.

Declaration

public RenderFragment ChildContent { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment	Accepts a RenderFragment that defines the content of the UI element.

DataSource

default value of multiple data bullet chart.

Declaration

public IEnumerable<TValue> DataSource { get; set; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<TValue>

EnableGroupSeparator

default value for enableGroupSeparator.

Declaration

public bool EnableGroupSeparator { get; set; }

Property Value

Type	Description
System.Boolean	true, if the grouping separator can be enabled. Otherwise, false.

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration

public bool EnableRtl { get; set; }

Property Value

Type	Description
System.Boolean	true, if the right to left direction can be enabled for the component. The default value is false.

Format

Sets and gets format for the bullet chart axis and data label.

Declaration

public string Format { get; set; }

Property Value

Type	Description
System.String	Accepts the string value. The default value is empty.

Height

The height of the bullet chart as a string accepts input both as '100px' or '100%'. If specified as '100%, bullet chart renders to the full height of its parent element.

Declaration

public string Height { get; set; }

Property Value

Type	Description
System.String	Accepts the string value. The default value is 100%.

ID

Set the id string for the bullet chart component.

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String	Accepts the string value.

Interval

Specifies the interval for an scale.

Declaration

public double Interval { get; set; }

Property Value

Type	Description
System.Double	A double value representing the interval for the scale. The default value is -1.

LabelFormat

Specifies the format of the bullet chart axis labels.

Declaration

public string LabelFormat { get; set; }

Property Value

Type	Description
System.String	Accepts the string value, The default value is empty.

LabelPosition

specifies the axis label position of the bullet chart.

Declaration

public LabelsPlacement LabelPosition { get; set; }

Property Value

Type	Description
LabelsPlacement	A value of LabelsPlacement enumeration that specifies the position of axis labels in the component. The default value is Outside.

Maximum

Specifies the maximum range of an scale.

Declaration

public double Maximum { get; set; }

Property Value

Type	Description
System.Double	A double value representing the maximum range of the scale. The default value is -1.

Minimum

Specifies the minimum range of an scale.

Declaration

public double Minimum { get; set; }

Property Value

Type	Description
System.Double	A double value representing the minimum range of the scale. The default value is -1.

MinorTicksPerInterval

specifies the interval of minor ticks.

Declaration

public double MinorTicksPerInterval { get; set; }

Property Value

Type	Description
System.Double	A double value representing the interval of minor ticks. The default value is 4.

OpposedPosition

If set to true, the axis will render at the opposite side of its default position.

Declaration

public bool OpposedPosition { get; set; }

Property Value

Type	Description
System.Boolean	true, if the opposed position can be enabled. Otherwise, false. The default value is false.

Orientation

Orientation of the scale.

Declaration

public OrientationType Orientation { get; set; }

Property Value

Type	Description
OrientationType	A value of the OrientationType enumeration that specifies the orientation of scale. The default value is Horizontal.

Subtitle

Specifies the sub title of the bullet chart.

Declaration

public string Subtitle { get; set; }

Property Value

Type	Description
System.String	Accepts the string value. The default value is empty.

TabIndex

TabIndex value for the bullet chart.

Declaration

public int TabIndex { get; set; }

Property Value

Type	Description
System.Int32	An integer value representing the tab index of bullet chart. The default value is 1.

TargetColor

Default stroke of comparative measure.

Declaration

public string TargetColor { get; set; }

Property Value

Type	Description
System.String	Accepts the string value. The default value is #191919.

TargetField

The DataSource field that contains the target value.

Declaration

public string TargetField { get; set; }

Property Value

Type	Description
System.String	Accepts the string value. The default value is empty.

TargetTypes

The DataSource field that contains the target value.

Declaration

public List<TargetType> TargetTypes { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<TargetType>	A list of TargetType enumeration values that specifies the type of target options available in bullet chart. The available target values are Rect, Cross and Circle.

TargetWidth

Options for customizing comparative bar color bullet chart.

Declaration

public double TargetWidth { get; set; }

Property Value

Type	Description
System.Double	A double value representing the target width for the comparative measure in bullet chart. The default value is 5.

Theme

Specifies the theme for the bullet chart.

Declaration

public Theme Theme { get; set; }

Property Value

Type	Description
Theme	Accepts the value from the Theme enum. The default value is Bootstrap4.

TickPosition

specifies the tick position of the bullet chart.

Declaration

public TickPosition TickPosition { get; set; }

Property Value

Type	Description
TickPosition	One of the TickPosition enumeration that specifies the position of tick in component. The default value is Outside.

Title

Specifies the title of the bullet chart.

Declaration

public string Title { get; set; }

Property Value

Type	Description
System.String	Accepts the string value. The default value is empty.

TitlePosition

Sets the title position of bullet chart.

Declaration

public TextPosition TitlePosition { get; set; }

Property Value

Type	Description
TextPosition	One of the TextPosition enumeration that specifies the position of title in the component. The default value is Top.

Type

Default type on feature measure.

Declaration

public FeatureType Type { get; set; }

Property Value

Type	Description
FeatureType	One of the FeatureType enumeration that specifies the type of feature in the component. The default value is Rect.

ValueField

The DataSource field that contains the value value.

Declaration

public string ValueField { get; set; }

Property Value

Type	Description
System.String	Accepts the string value. The default value is empty.

ValueFill

Default stroke color of feature measure.

Declaration

public string ValueFill { get; set; }

Property Value

Type	Description
System.String	Accepts the string value that represents the color of the stroke.

ValueHeight

Options for customizing feature bar height of the bullet chart.

Declaration

public double ValueHeight { get; set; }

Property Value

Type	Description
System.Double	Accepts the double value representing the height of the value element. The default value is 6.

Width

The width of the bullet chart as a string accepts input as both like '100px' or '100%'. If specified as '100%, bullet chart renders to the full width of its parent element.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String	Accepts the string value that represents the width of the bullet chart.

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder	__builder

ExportAsync(ExportType, String, Nullable<PdfPageOrientation>)

The method is used to perform the export functionality for the rendered bullet chart.

Declaration

public Task ExportAsync(ExportType type, string fileName, Nullable<PdfPageOrientation> orientation = null)

Parameters

Type	Name	Description
ExportType	type	Specifies the export type for the rendered bullet chart.
System.String	fileName	Specifies the filename.
System.Nullable<Syncfusion.PdfExport.PdfPageOrientation>	orientation	Specifies the portrait or landscape orientation of the page.

Returns

Type	Description
System.Threading.Tasks.Task	Returns base64 string.

OnAfterRenderAsync(Boolean)

Method invoked after each time the component has been rendered.

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Type	Name	Description
System.Boolean	firstRender	Specifies the first render of the component.

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the asynchronous operation.

Overrides

SfBaseComponent.OnAfterRenderAsync(Boolean)

OnInitializedAsync()

Method invoked when the component is ready to start.

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the asynchronous operation.

Overrides

SfBaseComponent.OnInitializedAsync()

OnObservableChange(String, Object, Boolean, NotifyCollectionChangedEventArgs)

Declaration

protected override void OnObservableChange(string propertyName, object sender, bool isCollectionChanged = false, NotifyCollectionChangedEventArgs e = null)

Parameters

Type	Name	Description
System.String	propertyName
System.Object	sender
System.Boolean	isCollectionChanged
System.Collections.Specialized.NotifyCollectionChangedEventArgs	e

Overrides

SfBaseComponent.OnObservableChange(String, Object, Boolean, NotifyCollectionChangedEventArgs)

OnParametersSetAsync()

Method invoked when the component has received parameters from its parent in the render tree and the incoming values have been assigned to properties.

Declaration

protected override Task OnParametersSetAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the asynchronous operation.

PrintAsync(ElementReference)

The method is used to perform the print functionality in bullet chart.

Declaration

public Task PrintAsync(ElementReference elementRef = null)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.ElementReference	elementRef

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the asynchronous operation.

Implements

IBulletChart