Class IgbDashboardTile

Inheritance
System.Object
BaseRendererControl
IgbDashboardTile
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbDashboardTile : BaseRendererControl, RefSink, JsonSerializable, IDisposable

Constructors

IgbDashboardTile()

Declaration
public IgbDashboardTile()

Properties

ActualBrushes

Gets the actual palette of brushes to use for coloring the chart series.

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

ActualCustomizations

Declaration
public IgbDashboardTileCustomizationCollection ActualCustomizations { get; }
Property Value
Type Description
IgbDashboardTileCustomizationCollection

ActualOutlines

Gets the actual palette of brushes to use for outlines on the chart series.

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

AutoCalloutsVisible

Gets or sets if the auto value callouts should be displayed.

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

BackgroundColor

Gets or sets the color to use for the background of the component.

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

BaseTheme

Gets or sets the base built in theme to use for the checkbox.

Declaration
public BaseControlTheme BaseTheme { get; set; }
Property Value
Type Description
BaseControlTheme

Brushes

Gets or sets the palette of brushes to use for coloring the dashboard tile.

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

The value provided should be an array of CSS color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection

CategoryAxisMajorStroke

Gets the brush to use for the Category axis major strokes, if applicable.

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

ChangingContent

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

ChangingContentScript

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

ContentCustomizations

Declaration
public IgbDashboardTileCustomizationCollection ContentCustomizations { get; }
Property Value
Type Description
IgbDashboardTileCustomizationCollection

CrosshairsAnnotationEnabled

Gets or sets whether annotations are shown along the axis for crosshair values

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

CrosshairsDisplayMode

Gets or sets the crosshairs to be displayed.

Declaration
public CrosshairsDisplayMode CrosshairsDisplayMode { get; set; }
Property Value
Type Description
CrosshairsDisplayMode

Customizations

Gets a collection where you can add customization that will be applied to the generated visualizations.

Declaration
public IgbDashboardTileCustomizationCollection Customizations { get; protected set; }
Property Value
Type Description
IgbDashboardTileCustomizationCollection

DataSource

Gets or sets a collection of data items used to generate the dashboard tile.

Declaration
public object DataSource { get; set; }
Property Value
Type Description
System.Object
Remarks

The ItemsSource of this dashboard tile can be a list of objects containing one or more numeric properties.
Additionally, if the objects in the list implement an enumerable interface, the dashboard tile will attempt to delve into the sub-collections when reading through the data source. Data binding can be further configured by attributing the data item classes with the data intent feature.

DataSourceScript

Provides a means of setting DataSource in the JavaScript environment.

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

DefaultEventBehavior

Declaration
protected override ControlEventBehavior DefaultEventBehavior { get; }
Property Value
Type Description
ControlEventBehavior
Overrides

Density

Gets or sets the display density to use for the toolbar.

Declaration
public ControlDisplayDensity Density { get; set; }
Property Value
Type Description
ControlDisplayDensity

ExcludedProperties

Gets or sets a set of property paths that should be excluded from consideration by the category chart.

Declaration
public string[] ExcludedProperties { get; set; }
Property Value
Type Description
System.String[]

FilterExpressions

Gets the current filter that is applied to the chart. Collection can be updated to modify the filter for the chart. Once filter expressions are in this collection, the chart will no longer listen for changes on their properties.

Declaration
public IgbFilterExpressionCollection FilterExpressions { get; protected set; }
Property Value
Type Description
IgbFilterExpressionCollection

FilterStringErrorsParsing

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

FilterStringErrorsParsingScript

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

FinalValueAnnotationsVisible

Gets or sets whether annotations for the final value of each series is displayed on the axis.

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

GroupDescriptions

Gets the current grouping that is applied to the grid. Collection can be updated to modify the grouping for the grid. Once grouping descriptions are in this collection, the grid will no longer listen for changes on their properties.

Declaration
public IgbDashboardTileSortDescriptionCollection GroupDescriptions { get; protected set; }
Property Value
Type Description
IgbDashboardTileSortDescriptionCollection

GroupSortDescriptions

Declaration
public IgbDashboardTileSortDescriptionCollection GroupSortDescriptions { get; protected set; }
Property Value
Type Description
IgbDashboardTileSortDescriptionCollection

GroupSorts

Gets or sets the sorts to apply after grouping has been applied.

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

HighlightedDataSource

Gets or sets a collection of data items used to generate the dashboard tile.

Declaration
public object HighlightedDataSource { get; set; }
Property Value
Type Description
System.Object
Remarks

The HighlightedItemsSource of this dashboard tile can be a list of objects containing one or more numeric properties.
Additionally, if the objects in the list implement an enumerable interface, the dashboard tile will attempt to delve into the sub-collections when reading through the data source. Data binding can be further configured by attributing the data item classes with the data intent feature.

HighlightedDataSourceScript

Provides a means of setting HighlightedDataSource in the JavaScript environment.

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

HighlightedValuesDisplayMode

Gets or sets whether and how to display highlighted values for the series. Note, this is distinct from the highlighting feature that indicates what is closest or under the mouse. This property applies to Category Chart and Financial Chart controls.

Declaration
public virtual SeriesHighlightedValuesDisplayMode HighlightedValuesDisplayMode { get; set; }
Property Value
Type Description
SeriesHighlightedValuesDisplayMode

HighlightFilterExpressions

Gets the current highlight filter that is applied to the chart. Collection can be updated to modify the highlight filter for the chart. Once filter expressions are in this collection, the chart will no longer listen for changes on their properties.

Declaration
public IgbFilterExpressionCollection HighlightFilterExpressions { get; protected set; }
Property Value
Type Description
IgbFilterExpressionCollection

IncludedProperties

Gets or sets a set of property paths that should be included for consideration by the category chart, leaving the remainder excluded. If null, all properties will be considered.

Declaration
public string[] IncludedProperties { get; set; }
Property Value
Type Description
System.String[]

InitialFilter

Gets or sets the filter to apply to the chart. This property will become ignored if the filter is changed outside of this property.

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

InitialFilterExpressions

Gets the initial filters that are applied to the chart.

Declaration
public IgbFilterExpressionCollection InitialFilterExpressions { get; protected set; }
Property Value
Type Description
IgbFilterExpressionCollection

InitialGroupDescriptions

Gets the initial groupings that are applied to the chart.

Declaration
public IgbDashboardTileSortDescriptionCollection InitialGroupDescriptions { get; protected set; }
Property Value
Type Description
IgbDashboardTileSortDescriptionCollection

InitialGroups

Gets or sets the groupings to apply to the chart. This property will become ignored if sorts are changed outside of this property.

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

InitialGroupSortDescriptions

Gets the initial sorts that are applied to the chart after groupings and summaries are applied.

Declaration
public IgbDashboardTileSortDescriptionCollection InitialGroupSortDescriptions { get; protected set; }
Property Value
Type Description
IgbDashboardTileSortDescriptionCollection

InitialHighlightFilter

Gets or sets the filter to apply to the chart. This property will become ignored if the filter is changed outside of this property.

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

InitialHighlightFilterExpressions

Gets the initial highlight filters that are applied to the chart.

Declaration
public IgbFilterExpressionCollection InitialHighlightFilterExpressions { get; protected set; }
Property Value
Type Description
IgbFilterExpressionCollection

InitialSortDescriptions

Gets the initial sorts that are applied to the chart.

Declaration
public IgbDashboardTileSortDescriptionCollection InitialSortDescriptions { get; protected set; }
Property Value
Type Description
IgbDashboardTileSortDescriptionCollection

InitialSorts

Gets or sets the sorts to apply to the chart. This property will become ignored if sorts are changed outside of this property.

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

InitialSummaries

Gets or sets the summaries to apply to the chart. This property will become ignored if sorts are changed outside of this property.

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

InitialSummaryDescriptions

Gets the initial summaries that are applied to the chart.

Declaration
public IgbDashboardTileSummaryDescriptionCollection InitialSummaryDescriptions { get; protected set; }
Property Value
Type Description
IgbDashboardTileSummaryDescriptionCollection

IsUserAnnotationsEnabled

Gets or sets whether initiating user annotations from the toolbar is enabled.

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

Outlines

Gets or sets the palette of brushes to use for outlines on the dashboard tile.

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

The value provided should be an array of CSS color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection

ParentTypeName

Declaration
protected override string ParentTypeName { get; }
Property Value
Type Description
System.String
Overrides

SelectedSeriesItems

Gets the currently selected data items. Adding or removing data items from this collection will select or deselect the visuals associated with those items.

Declaration
public IgbChartSelectedItemCollection SelectedSeriesItems { get; set; }
Property Value
Type Description
IgbChartSelectedItemCollection

ShouldAvoidAxisAnnotationCollisions

Gets or sets whether annotations for the final value of each series is displayed on the axis.

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

ShouldDisplayMockData

Gets or sets whether the dashboard tile should display mock data when the data source has not been provided, if supported for this type of chart.

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

ShouldUseSkeletonStyleForMockData

Gets or sets whether the dashboard tile should use a faded skeleton style for mock data.

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

SortDescriptions

Gets the current sort that is applied to the grid. Collection can be updated to modify the sort for the grid. Once sort descriptions are in this collection, the grid will no longer listen for changes on their properties.

Declaration
public IgbDashboardTileSortDescriptionCollection SortDescriptions { get; protected set; }
Property Value
Type Description
IgbDashboardTileSortDescriptionCollection

SummaryDescriptions

Gets the current summaries that are applied to the grid.

Declaration
public IgbDashboardTileSummaryDescriptionCollection SummaryDescriptions { get; protected set; }
Property Value
Type Description
IgbDashboardTileSummaryDescriptionCollection

TileTitle

Gets or sets text to display above the plot area.

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

TrendLineBrushes

Gets or sets the palette of brushes to used for coloring trend lines in this chart.

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

The value provided should be an array of CSS color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection

TrendLineType

Gets or sets the formula used for calculating trend lines in this chart.

Declaration
public TrendLineType TrendLineType { get; set; }
Property Value
Type Description
TrendLineType
Remarks

This property applies only to these chart types: point, line, spline, and bubble

TrendLineTypes

Gets or sets what trendlines to use in the chart.

Declaration
public IgbTrendLineTypeCollection TrendLineTypes { get; set; }
Property Value
Type Description
IgbTrendLineTypeCollection

Type

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

UserAnnotationInformationRequested

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

UserAnnotationInformationRequestedScript

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

UserAnnotationToolTipContentUpdating

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

UserAnnotationToolTipContentUpdatingScript

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

ValidVisualizationTypePriorityThreshold

Gets or sets the crosshairs to be displayed.

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

ValidVisualizationTypes

Gets the current set of valid visualization types for the data.

Declaration
public DashboardTileVisualizationType[] ValidVisualizationTypes { get; set; }
Property Value
Type Description
DashboardTileVisualizationType[]

ValueLines

Gets or sets what value lines to use in the chart.

Declaration
public IgbValueModeCollection ValueLines { get; set; }
Property Value
Type Description
IgbValueModeCollection

ValueLinesBrushes

Gets or sets the palette of brushes to use for coloring the value lines present in the ValueLines property.

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

The value provided should be an array of CSS color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection

ValueLinesGlobalAverageBrush

Gets or sets the color for GlobalAverage value lines.

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

ValueLinesGlobalMaximumBrush

Gets or sets the color for GlobalMaximum value lines.

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

ValueLinesGlobalMinimumBrush

Gets or sets the color for GlobalMinimum value lines.

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

VisualizationType

Gets or sets the crosshairs to be displayed.

Declaration
public DashboardTileVisualizationType VisualizationType { get; set; }
Property Value
Type Description
DashboardTileVisualizationType

Methods

CancelAnnotationFlow(String)

Declaration
public void CancelAnnotationFlow(string annotationFlowId)
Parameters
Type Name Description
System.String annotationFlowId

CancelAnnotationFlowAsync(String)

Declaration
public Task CancelAnnotationFlowAsync(string annotationFlowId)
Parameters
Type Name Description
System.String annotationFlowId
Returns
Type Description
System.Threading.Tasks.Task

ClearSettings()

Declaration
public void ClearSettings()

ClearSettingsAsync()

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

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides

FinishAnnotationFlow(IgbUserAnnotationInformation)

Declaration
public void FinishAnnotationFlow(IgbUserAnnotationInformation flowInformation)
Parameters
Type Name Description
IgbUserAnnotationInformation flowInformation

FinishAnnotationFlowAsync(IgbUserAnnotationInformation)

Declaration
public Task FinishAnnotationFlowAsync(IgbUserAnnotationInformation flowInformation)
Parameters
Type Name Description
IgbUserAnnotationInformation flowInformation
Returns
Type Description
System.Threading.Tasks.Task

GetCurrentSelectedSeriesItems()

Declaration
public IgbChartSelectedItemCollection GetCurrentSelectedSeriesItems()
Returns
Type Description
IgbChartSelectedItemCollection

GetCurrentSelectedSeriesItemsAsync()

Declaration
public Task<IgbChartSelectedItemCollection> GetCurrentSelectedSeriesItemsAsync()
Returns
Type Description
System.Threading.Tasks.Task<IgbChartSelectedItemCollection>

GetSettingsValue(String)

Declaration
public object GetSettingsValue(string key)
Parameters
Type Name Description
System.String key
Returns
Type Description
System.Object

GetSettingsValueAsync(String)

Declaration
public Task<object> GetSettingsValueAsync(string key)
Parameters
Type Name Description
System.String key
Returns
Type Description
System.Threading.Tasks.Task<System.Object>

HasModifiedSettings()

Declaration
public bool HasModifiedSettings()
Returns
Type Description
System.Boolean

HasModifiedSettingsAsync()

Declaration
public Task<bool> HasModifiedSettingsAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

LoadAnnotationsFromJson(String)

Declaration
public void LoadAnnotationsFromJson(string jsonString)
Parameters
Type Name Description
System.String jsonString

LoadAnnotationsFromJsonAsync(String)

Declaration
public Task LoadAnnotationsFromJsonAsync(string jsonString)
Parameters
Type Name Description
System.String jsonString
Returns
Type Description
System.Threading.Tasks.Task

OnUIReady()

Declaration
public void OnUIReady()

OnUIReadyAsync()

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

RemoveSettingsValue(String)

Declaration
public void RemoveSettingsValue(string key)
Parameters
Type Name Description
System.String key

RemoveSettingsValueAsync(String)

Declaration
public Task RemoveSettingsValueAsync(string key)
Parameters
Type Name Description
System.String key
Returns
Type Description
System.Threading.Tasks.Task

ResetAnnotations()

Declaration
public void ResetAnnotations()

ResetAnnotationsAsync()

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

ResetZoom()

Declaration
public void ResetZoom()

ResetZoomAsync()

Resets the zoom level to default.

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

SaveAnnotationsToJson()

Declaration
public string SaveAnnotationsToJson()
Returns
Type Description
System.String

SaveAnnotationsToJsonAsync()

Declaration
public Task<string> SaveAnnotationsToJsonAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.String>

StartCreatingAnnotation()

Declaration
public void StartCreatingAnnotation()

StartCreatingAnnotationAsync()

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

StartDeletingAnnotation()

Declaration
public void StartDeletingAnnotation()

StartDeletingAnnotationAsync()

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

UpdateSettingsValue(String, Object)

Declaration
public void UpdateSettingsValue(string key, object value)
Parameters
Type Name Description
System.String key
System.Object value

UpdateSettingsValueAsync(String, Object)

Declaration
public Task UpdateSettingsValueAsync(string key, object value)
Parameters
Type Name Description
System.String key
System.Object value
Returns
Type Description
System.Threading.Tasks.Task

ZoomIn(Double)

Declaration
public void ZoomIn(double percentage)
Parameters
Type Name Description
System.Double percentage

ZoomInAsync(Double)

Declaration
public Task ZoomInAsync(double percentage)
Parameters
Type Name Description
System.Double percentage
Returns
Type Description
System.Threading.Tasks.Task

ZoomOut(Double)

Declaration
public void ZoomOut(double percentage)
Parameters
Type Name Description
System.Double percentage

ZoomOutAsync(Double)

Performs zoom out action on the chart by specified percentage of current window rect

Declaration
public Task ZoomOutAsync(double percentage)
Parameters
Type Name Description
System.Double percentage
Returns
Type Description
System.Threading.Tasks.Task

Implements

System.IDisposable