Class IgbFinancialChart
Represents a chart with an ordinal X-axis and a numeric Y-axis.
Inheritance
System.Object
IgbFinancialChart
Implements
System.IDisposable
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbFinancialChart : IgbXYChart, JsonSerializable
Constructors
IgbFinancialChart()
Declaration
public IgbFinancialChart()
Properties
Declaration
public string ApplyCustomIndicatorsScript { get; set; }
Property Value
Type |
Description |
System.String |
|
ChartType
The type of price series to display in the main chart.
Declaration
public FinancialChartType ChartType { get; set; }
Property Value
CustomIndicatorNames
The names of custom indicators to add to the chart.
Declaration
public string[] CustomIndicatorNames { get; set; }
Property Value
Type |
Description |
System.String[] |
|
IndicatorBrushes
Brushes to use for financial indicators.
Declaration
public string IndicatorBrushes { get; set; }
Property Value
Type |
Description |
System.String |
|
IndicatorDisplayTypes
The display types of financial indicators.
Declaration
public IgbIndicatorDisplayTypeCollection IndicatorDisplayTypes { get; set; }
Property Value
IndicatorLongPeriod
The long period of financial indicators, where applicable.
Declaration
public int IndicatorLongPeriod { get; set; }
Property Value
Type |
Description |
System.Int32 |
|
IndicatorMultiplier
The multiplier of financial indicators, e.g. BollingerBandWidth indicator.
Declaration
public double IndicatorMultiplier { get; set; }
Property Value
Type |
Description |
System.Double |
|
IndicatorNegativeBrushes
Brushes to use for negative elements in financial indicators.
Declaration
public string IndicatorNegativeBrushes { get; set; }
Property Value
Type |
Description |
System.String |
|
IndicatorPeriod
The period of financial indicators, where applicable.
Declaration
public int IndicatorPeriod { get; set; }
Property Value
Type |
Description |
System.Int32 |
|
IndicatorShortPeriod
The short period of financial indicators, where applicable.
Declaration
public int IndicatorShortPeriod { get; set; }
Property Value
Type |
Description |
System.Int32 |
|
IndicatorSignalPeriod
The signal period of financial indicators, where applicable.
Declaration
public int IndicatorSignalPeriod { get; set; }
Property Value
Type |
Description |
System.Int32 |
|
IndicatorSmoothingPeriod
The smoothing period of financial indicators, where applicable.
Declaration
public int IndicatorSmoothingPeriod { get; set; }
Property Value
Type |
Description |
System.Int32 |
|
IndicatorThickness
The outline or stroke thickness of financial indicators.
Declaration
public double IndicatorThickness { get; set; }
Property Value
Type |
Description |
System.Double |
|
IndicatorTypes
A collection indicating what financial indicator types to display on the Financial Chart.
Declaration
public IgbFinancialIndicatorTypeCollection IndicatorTypes { get; set; }
Property Value
IsHorizontalZoomEnabled
Declaration
public override bool IsHorizontalZoomEnabled { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Overrides
IsLegendVisible
Gets or sets weather or not a legend is visible between toolbar and chart's plot area
Declaration
public bool IsLegendVisible { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
A boolean property controlling the visibility of the toolbar.
Declaration
public bool IsToolbarVisible { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
IsVerticalZoomEnabled
Declaration
public override bool IsVerticalZoomEnabled { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Overrides
IsWindowSyncedToVisibleRange
A boolean indicating whether the chart should automatically zoom in vertically on the currently visible range of data.
Declaration
public bool IsWindowSyncedToVisibleRange { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
LeftMargin
Declaration
public override double LeftMargin { get; set; }
Property Value
Type |
Description |
System.Double |
|
Overrides
NeedsDynamicContent
Declaration
protected override bool NeedsDynamicContent { get; }
Property Value
Type |
Description |
System.Boolean |
|
Overrides
NegativeBrushes
Gets or sets the palette used for coloring negative items of Waterfall chart type.
Declaration
public string NegativeBrushes { get; set; }
Property Value
Type |
Description |
System.String |
|
NegativeOutlines
Brushes to use for drawing negative elements, when using a chart type with contextual coloring, such as Waterfall.
Declaration
public string NegativeOutlines { get; set; }
Property Value
Type |
Description |
System.String |
|
OverlayBrushes
Brushes to use for filling financial overlays.
Declaration
public string OverlayBrushes { get; set; }
Property Value
Type |
Description |
System.String |
|
OverlayMultiplier
The multiplier of financial overlay, e.g. BollingerBands overlay.
Declaration
public double OverlayMultiplier { get; set; }
Property Value
Type |
Description |
System.Double |
|
OverlayOutlines
Brushes to use for outlining financial overlays.
Declaration
public string OverlayOutlines { get; set; }
Property Value
Type |
Description |
System.String |
|
OverlayThickness
The outline thickness of financial overlays.
Declaration
public double OverlayThickness { get; set; }
Property Value
Type |
Description |
System.Double |
|
OverlayTypes
A collection indicating what financial overlay types to display on the Financial Chart.
Declaration
public IgbFinancialOverlayTypeCollection OverlayTypes { get; set; }
Property Value
RangeSelectorOptions
A FinancialChartRangeSelectorOptionCollection containing the available range selector options on the toolbar.
Declaration
public IgbFinancialChartRangeSelectorOptionCollection RangeSelectorOptions { get; set; }
Property Value
Resolution
Gets or sets the rendering resolution for all series in this chart.
Declaration
public override double Resolution { get; set; }
Property Value
Type |
Description |
System.Double |
|
Overrides
Declaration
public double ToolbarHeight { get; set; }
Property Value
Type |
Description |
System.Double |
|
Declaration
public RenderFragment<IgbDataContext> TooltipTemplate { get; set; }
Property Value
Type |
Description |
Microsoft.AspNetCore.Components.RenderFragment<IgbDataContext> |
|
Type
Declaration
public override string Type { get; }
Property Value
Type |
Description |
System.String |
|
Overrides
VolumeBrushes
Brushes to use for filling volume series in the volume pane.
Declaration
public string VolumeBrushes { get; set; }
Property Value
Type |
Description |
System.String |
|
VolumeOutlines
Brushes to use for outlining volume series in the volume pane.
Declaration
public string VolumeOutlines { get; set; }
Property Value
Type |
Description |
System.String |
|
VolumeThickness
The outline thickness of volume series in the volume pane.
Declaration
public double VolumeThickness { get; set; }
Property Value
Type |
Description |
System.Double |
|
VolumeType
The type of series to display in the volume pane.
Declaration
public FinancialChartVolumeType VolumeType { get; set; }
Property Value
XAxisBreaks
Gets a collection of time axis breaks on x-axis.
You can add time axis breaks to exclude plotting of data points in specified range of dates
Declaration
public IgbTimeAxisBreakCollection XAxisBreaks { get; protected set; }
Property Value
XAxisEnhancedIntervalPreferMoreCategoryLabels
Gets or sets whether the x axis enhanced interval management should prefer to show all the labels if possible without collisions for supported types of category axes. This is for use with EnhancedIntervalMinimumCharacters = -1 and axes that have an integral interval.
Declaration
public bool XAxisEnhancedIntervalPreferMoreCategoryLabels { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
XAxisMaximumValue
Gets or sets maximum value on x-axis
Declaration
public DateTime XAxisMaximumValue { get; set; }
Property Value
Type |
Description |
System.DateTime |
|
XAxisMinimumValue
Gets or sets minimum value on x-axis
Declaration
public DateTime XAxisMinimumValue { get; set; }
Property Value
Type |
Description |
System.DateTime |
|
XAxisMode
The scaling mode of the X-axis.
Declaration
public FinancialChartXAxisMode XAxisMode { get; set; }
Property Value
XAxisZoomMaximumCategoryRange
Gets or sets number of visible categories at maximum zooming level
Declaration
public double XAxisZoomMaximumCategoryRange { get; set; }
Property Value
Type |
Description |
System.Double |
|
XAxisZoomMaximumItemSpan
Gets or sets maximum pixel span of series item that will be visible at maximum zooming level
This property ensures that series item does not get stretch above specified value.
Declaration
public double XAxisZoomMaximumItemSpan { get; set; }
Property Value
Type |
Description |
System.Double |
|
XAxisZoomToCategoryRange
Gets or sets number of categories that the chart will zoom in and fill plot area
Declaration
public double XAxisZoomToCategoryRange { get; set; }
Property Value
Type |
Description |
System.Double |
|
XAxisZoomToCategoryStart
Gets or sets starting category that chart will move its zoom window. Acceptable value is between 0 and number of data items
Declaration
public double XAxisZoomToCategoryStart { get; set; }
Property Value
Type |
Description |
System.Double |
|
XAxisZoomToItemSpan
Gets or sets pixel span of series item that will be used to zoom chart such that the item has desired span
Chart will automaticlly zoom in until series item has specified pixel span.
Declaration
public double XAxisZoomToItemSpan { get; set; }
Property Value
Type |
Description |
System.Double |
|
YAxisAbbreviateLargeNumbers
Gets or sets whether the large numbers on the Y-axis labels are abbreviated.
Declaration
public bool YAxisAbbreviateLargeNumbers { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
YAxisEnhancedIntervalPreferMoreCategoryLabels
Gets or sets whether the y axis enhanced interval management should prefer to show all the labels if possible without collisions for supported types of category axes. This is for use with EnhancedIntervalMinimumCharacters = -1 and axes that have an integral interval.
Declaration
public bool YAxisEnhancedIntervalPreferMoreCategoryLabels { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
YAxisInterval
Gets or sets the distance between each label and grid line along the Y-axis.
Declaration
public double YAxisInterval { get; set; }
Property Value
Type |
Description |
System.Double |
|
YAxisIsLogarithmic
Gets or sets whether the Y-axis should use a logarithmic scale instead of a linear one.
Declaration
public bool YAxisIsLogarithmic { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
YAxisLabelHorizontalAlignment
Gets or sets Horizontal alignment of Y-axis labels.
Declaration
public override HorizontalAlignment YAxisLabelHorizontalAlignment { get; set; }
Property Value
Overrides
YAxisLogarithmBase
Gets or sets the base value to use in the log function when mapping the position of data items along the Y-axis.
Declaration
public int YAxisLogarithmBase { get; set; }
Property Value
Type |
Description |
System.Int32 |
|
YAxisMaximumValue
Gets or sets the data value corresponding to the maximum value of the Y-axis.
Declaration
public double YAxisMaximumValue { get; set; }
Property Value
Type |
Description |
System.Double |
|
YAxisMinimumValue
Gets or sets the data value corresponding to the minimum value of the Y-axis.
Declaration
public double YAxisMinimumValue { get; set; }
Property Value
Type |
Description |
System.Double |
|
YAxisMinorInterval
Gets or sets the frequency of displayed minor lines along the Y-axis.
Declaration
public double YAxisMinorInterval { get; set; }
Property Value
Type |
Description |
System.Double |
|
YAxisMode
The scaling mode of the Y-axis.
Declaration
public FinancialChartYAxisMode YAxisMode { get; set; }
Property Value
ZoomSliderType
Gets or sets type of series to display in the zoom slider pane.
Declaration
public FinancialChartZoomSliderType ZoomSliderType { get; set; }
Property Value
ZoomSliderXAxisMajorStroke
Gets or sets stroke brush of major gridlines on x-axis of the zoom slider pane
Declaration
public string ZoomSliderXAxisMajorStroke { get; set; }
Property Value
Type |
Description |
System.String |
|
ZoomSliderXAxisMajorStrokeThickness
Gets or sets thickness of major gridlines on x-axis of the zoom slider pane
Declaration
public double ZoomSliderXAxisMajorStrokeThickness { get; set; }
Property Value
Type |
Description |
System.Double |
|
Methods
EnsureModulesLoaded()
Declaration
protected override void EnsureModulesLoaded()
Overrides
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
NotifyClearItems(Object)
Declaration
public override void NotifyClearItems(object source_)
Parameters
Type |
Name |
Description |
System.Object |
source_ |
|
Overrides
NotifyClearItemsAsync(Object)
Declaration
public override Task NotifyClearItemsAsync(object source_)
Parameters
Type |
Name |
Description |
System.Object |
source_ |
|
Returns
Type |
Description |
System.Threading.Tasks.Task |
|
Overrides
NotifyInsertItem(Object, Int32, Object)
Declaration
public override void NotifyInsertItem(object source_, int index, object newItem)
Parameters
Type |
Name |
Description |
System.Object |
source_ |
|
System.Int32 |
index |
|
System.Object |
newItem |
|
Overrides
NotifyInsertItemAsync(Object, Int32, Object)
Declaration
public override 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 |
|
Overrides
NotifyRemoveItem(Object, Int32, Object)
Declaration
public override void NotifyRemoveItem(object source_, int index, object oldItem)
Parameters
Type |
Name |
Description |
System.Object |
source_ |
|
System.Int32 |
index |
|
System.Object |
oldItem |
|
Overrides
NotifyRemoveItemAsync(Object, Int32, Object)
Declaration
public override 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 |
|
Overrides
NotifySetItem(Object, Int32, Object, Object)
Declaration
public override 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 |
|
Overrides
NotifySetItemAsync(Object, Int32, Object, Object)
Declaration
public override 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 |
|
Overrides
ProvideContainer(Object)
Declaration
public override void ProvideContainer(object container)
Parameters
Type |
Name |
Description |
System.Object |
container |
|
Overrides
ProvideContainerAsync(Object)
Called by the UI framework to provide a UI container for rendering this control.
Declaration
public override Task ProvideContainerAsync(object container)
Parameters
Type |
Name |
Description |
System.Object |
container |
The UI container element.
|
Returns
Type |
Description |
System.Threading.Tasks.Task |
|
Overrides
Implements
System.IDisposable