Show / Hide Table of Contents

Class IgbBulletGraph

Represents a bullet graph.

Inheritance
System.Object
BaseRendererControl
IgbBulletGraph
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)
BaseRendererControl.NotifyInsertItem(Object, Int32, Object)
BaseRendererControl.NotifyRemoveItem(Object, Int32, Object)
BaseRendererControl.NotifyClearItems(Object)
BaseRendererControl.NotifySetItem(Object, Int32, Object, Object)
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 IgbBulletGraph : BaseRendererControl, RefSink, JsonSerializable, IDisposable

Constructors

IgbBulletGraph()

Declaration
public IgbBulletGraph()

Properties

ActualLabelFormatSpecifiers

Declaration
public IgbFormatSpecifierCollection ActualLabelFormatSpecifiers { get; }
Property Value
Type Description
IgbFormatSpecifierCollection

ActualMaximumValue

Gets the resolved maximum value of the scale.

Declaration
public double ActualMaximumValue { get; set; }
Property Value
Type Description
System.Double

ActualMaximumValueChanged

Declaration
public Action<double> ActualMaximumValueChanged { get; set; }
Property Value
Type Description
System.Action<System.Double>

ActualMaximumValueChangedScript

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

ActualMinimumValue

Gets the resolved minimum value of the scale.

Declaration
public double ActualMinimumValue { get; set; }
Property Value
Type Description
System.Double

ActualMinimumValueChanged

Declaration
public Action<double> ActualMinimumValueChanged { get; set; }
Property Value
Type Description
System.Action<System.Double>

ActualMinimumValueChangedScript

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

ActualPixelScalingRatio

Gets the actual pixel scaling ratio used 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.

ActualRanges

Declaration
public IgbLinearGraphRangeCollection ActualRanges { get; }
Property Value
Type Description
IgbLinearGraphRangeCollection

AlignLabel

Declaration
public EventCallback<IgbAlignLinearGraphLabelEventArgs> AlignLabel { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbAlignLinearGraphLabelEventArgs>

AlignLabelScript

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

BackingBrush

Gets or sets the brush to use to fill the backing of the bullet graph.

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

BackingInnerExtent

Gets or sets the inner extent of the bullet graph backing.

Declaration
public double BackingInnerExtent { get; set; }
Property Value
Type Description
System.Double

BackingOuterExtent

Gets or sets the outer extent of the bullet graph backing.

Declaration
public double BackingOuterExtent { get; set; }
Property Value
Type Description
System.Double

BackingOutline

Gets or sets the brush to use for the outline of the backing.

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

BackingStrokeThickness

Gets or sets the stroke thickness of the backing outline.

Declaration
public double BackingStrokeThickness { get; set; }
Property Value
Type Description
System.Double

ContentLabelFormatSpecifiers

Declaration
public IgbFormatSpecifierCollection ContentLabelFormatSpecifiers { get; }
Property Value
Type Description
IgbFormatSpecifierCollection

ContentRanges

Declaration
public IgbLinearGraphRangeCollection ContentRanges { get; }
Property Value
Type Description
IgbLinearGraphRangeCollection

Font

Gets or sets the font.

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

FontBrush

Gets or sets the brush to use for the label font.

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

FormatLabel

Declaration
public EventCallback<IgbFormatLinearGraphLabelEventArgs> FormatLabel { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbFormatLinearGraphLabelEventArgs>

FormatLabelScript

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

Interval

Gets or sets the interval to use for the scale.

Declaration
public double Interval { get; set; }
Property Value
Type Description
System.Double

IsScaleInverted

Gets or sets a value indicating whether the scale is inverted. When the scale is inverted the direction in which the scale values increase is right to left.

Declaration
public bool IsScaleInverted { get; set; }
Property Value
Type Description
System.Boolean

LabelExtent

Gets or sets the position at which to put the labels as a value from 0 to 1, measured from the bottom of the scale. Values further from zero than 1 can be used to hide the labels of the bullet graph.

Declaration
public double LabelExtent { get; set; }
Property Value
Type Description
System.Double

LabelFormat

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

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

LabelFormatSpecifiers

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

Declaration
public IgbFormatSpecifierCollection LabelFormatSpecifiers { get; set; }
Property Value
Type Description
IgbFormatSpecifierCollection

LabelInterval

Gets or sets the interval to use for rendering labels. This defaults to be the same interval as the tickmarks on the scale.

Declaration
public double LabelInterval { get; set; }
Property Value
Type Description
System.Double

LabelsPostInitial

A value to start adding labels, added to the scale's MinimumValue.

Declaration
public double LabelsPostInitial { get; set; }
Property Value
Type Description
System.Double

LabelsPreTerminal

A value to stop adding labels, subtracted from the scale's MaximumValue.

Declaration
public double LabelsPreTerminal { get; set; }
Property Value
Type Description
System.Double

MaximumValue

Gets or sets the maximum value of the scale.

Declaration
public double MaximumValue { get; set; }
Property Value
Type Description
System.Double

MinimumValue

Gets or sets the minimum value of the scale.

Declaration
public double MinimumValue { get; set; }
Property Value
Type Description
System.Double

MinorTickBrush

Gets or sets the brush to use for the minor tickmarks.

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

MinorTickCount

Gets or sets the number of minor tickmarks to place between major tickmarks.

Declaration
public double MinorTickCount { get; set; }
Property Value
Type Description
System.Double

MinorTickEndExtent

Gets or sets the position at which to stop rendering the minor tickmarks as a value from 0 to 1, measured from the front/bottom of the bullet graph. Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph.

Declaration
public double MinorTickEndExtent { get; set; }
Property Value
Type Description
System.Double

MinorTickStartExtent

Gets or sets the position at which to start rendering the minor tickmarks as a value from 0 to 1, measured from the front/bottom of the bullet graph. Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph.

Declaration
public double MinorTickStartExtent { get; set; }
Property Value
Type Description
System.Double

MinorTickStrokeThickness

Gets or sets the stroke thickness to use when rendering minor ticks.

Declaration
public double MinorTickStrokeThickness { get; set; }
Property Value
Type Description
System.Double

Orientation

Gets or sets the orientation of the scale.

Declaration
public LinearScaleOrientation Orientation { get; set; }
Property Value
Type Description
LinearScaleOrientation

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.

RangeBrushes

Gets or sets a collection of brushes to be used as the palette for bullet graph ranges.

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

RangeInnerExtent

Gets or sets the position at which to start rendering the ranges, measured from the front/bottom of the control as a value from 0 to 1. Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph.

Declaration
public double RangeInnerExtent { get; set; }
Property Value
Type Description
System.Double

RangeOuterExtent

Gets or sets the position at which to stop rendering the range as a value from 0 to 1 measured from the front/bottom of the bullet graph. Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph.

Declaration
public double RangeOuterExtent { get; set; }
Property Value
Type Description
System.Double

RangeOutlines

Gets or sets a collection of brushes to be used as the palette for bullet graph outlines.

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

Ranges

Gets or sets the scale ranges to render on the bullet graph.

Declaration
public IgbLinearGraphRangeCollection Ranges { get; set; }
Property Value
Type Description
IgbLinearGraphRangeCollection

ScaleBackgroundBrush

Gets or sets the background brush for the scale.

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

ScaleBackgroundOutline

Gets or sets the background outline for the scale.

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

ScaleBackgroundThickness

Gets or sets the background outline thickness for the scale.

Declaration
public double ScaleBackgroundThickness { get; set; }
Property Value
Type Description
System.Double

ScaleEndExtent

Gets or sets the position at which to stop rendering the scale as a value from 0 to 1, measured from the front/bottom of the bullet graph. Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph.

Declaration
public double ScaleEndExtent { get; set; }
Property Value
Type Description
System.Double

ScaleStartExtent

Gets or sets the position at which to start rendering the scale, measured from the front/bottom of the bullet graph as a value from 0 to 1. Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph.

Declaration
public double ScaleStartExtent { get; set; }
Property Value
Type Description
System.Double

ShowToolTip

Gets or sets a value indicating whether tooltips are enabled.

Declaration
public bool ShowToolTip { get; set; }
Property Value
Type Description
System.Boolean

ShowToolTipTimeout

Gets or sets the time in milliseconds that tooltip appearance is delayed with.

Declaration
public int ShowToolTipTimeout { get; set; }
Property Value
Type Description
System.Int32

TargetValue

Gets or sets the value indicated by the target value bar.

Declaration
public double TargetValue { get; set; }
Property Value
Type Description
System.Double

TargetValueBreadth

Get or sets the breadth of the target value element.

Declaration
public double TargetValueBreadth { get; set; }
Property Value
Type Description
System.Double

TargetValueBrush

Gets or sets the brush to use when rendering the fill of the comparative marker.

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

TargetValueInnerExtent

Gets or sets the position at which to start rendering the target value, measured from the front/bottom of the control as a value from 0 to 1. Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph.

Declaration
public double TargetValueInnerExtent { get; set; }
Property Value
Type Description
System.Double

TargetValueName

Gets or sets the name used for the target value. The name is displayed in the default target value tooltip.

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

TargetValueOuterExtent

Gets or sets the position at which to start rendering the target value, measured from the front/bottom of the control as a value from 0 to 1. Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph.

Declaration
public double TargetValueOuterExtent { get; set; }
Property Value
Type Description
System.Double

TargetValueOutline

Gets or sets the brush to use when rendering the outline of the target value.

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

TargetValueStrokeThickness

Gets or sets the stroke thickness of the outline of the target value bar.

Declaration
public double TargetValueStrokeThickness { get; set; }
Property Value
Type Description
System.Double

TickBrush

Gets or sets the brush to use for the major tickmarks.

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

TickEndExtent

Gets or sets the position at which to stop rendering the major tickmarks as a value from 0 to 1, measured from the front/bottom of the bullet graph. Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph.

Declaration
public double TickEndExtent { get; set; }
Property Value
Type Description
System.Double

TicksPostInitial

A value to start adding tickmarks, added to the scale's MinimumValue.

Declaration
public double TicksPostInitial { get; set; }
Property Value
Type Description
System.Double

TicksPreTerminal

A value to stop adding tickmarks, subtracted from the scale's MaximumValue.

Declaration
public double TicksPreTerminal { get; set; }
Property Value
Type Description
System.Double

TickStartExtent

Gets or sets the position at which to start rendering the major tickmarks as a value from 0 to 1, measured from the front/bottom of the bullet graph. Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph.

Declaration
public double TickStartExtent { get; set; }
Property Value
Type Description
System.Double

TickStrokeThickness

Gets or sets the stroke thickness to use when rendering ticks.

Declaration
public double TickStrokeThickness { get; set; }
Property Value
Type Description
System.Double

TransitionDuration

Gets or sets the number of milliseconds over which changes to the bullet graph should be animated.

Declaration
public int TransitionDuration { get; set; }
Property Value
Type Description
System.Int32

TransitionProgress

Gets the transition progress of the animation when the control is animating.

Declaration
public double TransitionProgress { get; set; }
Property Value
Type Description
System.Double

Type

Declaration
public override string Type { get; }
Property Value
Type Description
System.String
Overrides
BaseRendererControl.Type

Value

Gets or sets the value at which the bar ends.

Declaration
public double Value { get; set; }
Property Value
Type Description
System.Double

ValueBrush

Gets or sets the brush to use for the actual value element.

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

ValueInnerExtent

Gets or sets the position at which to start rendering the actual value geometries, measured from the front/bottom of the bullet graph as a value from 0 to 1. Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph.

Declaration
public double ValueInnerExtent { get; set; }
Property Value
Type Description
System.Double

ValueName

Gets or sets the name used for actual value.

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

ValueOuterExtent

Gets or sets the position at which to stop rendering the actual value geometries as a value from 0 to 1 measured from the front/bottom of the bullet graph. Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph.

Declaration
public double ValueOuterExtent { get; set; }
Property Value
Type Description
System.Double

ValueOutline

Gets or sets the brush to use for the outline of actual value element.

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

ValueStrokeThickness

Gets or sets the stroke thickness to use when rendering single actual value element.

Declaration
public double ValueStrokeThickness { get; set; }
Property Value
Type Description
System.Double

Methods

ContainerResized()

Declaration
public void ContainerResized()

ContainerResizedAsync()

Notify that the container has resized.

Declaration
public Task ContainerResizedAsync()
Returns
Type Description
System.Threading.Tasks.Task

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)

Flush()

Declaration
public void Flush()

FlushAsync()

Use to force the bullet graph to finish any deferred work before printing or evaluating its visual.

Declaration
public Task FlushAsync()
Returns
Type Description
System.Threading.Tasks.Task
Remarks

This should only be called if the visual of the bullet graph needs to be synchronously saved or evaluated. Calling this method too often will hinder the performance of the bullet graph.

GetCurrentActualMaximumValue()

Declaration
public double GetCurrentActualMaximumValue()
Returns
Type Description
System.Double

GetCurrentActualMaximumValueAsync()

Declaration
public Task<double> GetCurrentActualMaximumValueAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

GetCurrentActualMinimumValue()

Declaration
public double GetCurrentActualMinimumValue()
Returns
Type Description
System.Double

GetCurrentActualMinimumValueAsync()

Declaration
public Task<double> GetCurrentActualMinimumValueAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

GetValueForPoint(Point)

Declaration
public double GetValueForPoint(Point point)
Parameters
Type Name Description
Point point
Returns
Type Description
System.Double

GetValueForPointAsync(Point)

Gets the value for the main scale of the bullet graph for a given point within the bounds of the bullet graph.

Declaration
public Task<double> GetValueForPointAsync(Point point)
Parameters
Type Name Description
Point point

The point for which to retrieve the associated value.

Returns
Type Description
System.Threading.Tasks.Task<System.Double>

ProvideContainer(Object)

Declaration
public void ProvideContainer(object container)
Parameters
Type Name Description
System.Object container

ProvideContainerAsync(Object)

Provide a container for the bullet graph.

Declaration
public Task ProvideContainerAsync(object container)
Parameters
Type Name Description
System.Object container

The container.

Returns
Type Description
System.Threading.Tasks.Task

StyleUpdated()

Declaration
public void StyleUpdated()

StyleUpdatedAsync()

Notify that the bullet graph styling has updated.

Declaration
public Task StyleUpdatedAsync()
Returns
Type Description
System.Threading.Tasks.Task

Implements

JsonSerializable
System.IDisposable