Inheritance

Implements
  • IComponent
  • IHandleEvent
  • IHandleAfterRender
  • JsonSerializable
  • IDisposable

constructor

public IgbDashboardTile()

Returns IgbDashboardTile

Inherited from: BaseRendererControl

[Inject]
protected IIgniteUIBlazor IgBlazor { get; set; }

Inherited from: BaseRendererControl

[Parameter]
public string Height { get; set; }

Inherited from: BaseRendererControl

[Parameter]
public string Width { get; set; }

Inherited from: BaseRendererControl

[Parameter]
public string Class { get; set; }

Inherited from: BaseRendererControl

[Parameter(CaptureUnmatchedValues = true)]
public Dictionary<string, object> AdditionalAttributes { get; set; }

Inherited from: BaseRendererControl

Gets or sets how events are bubbled up from JavaScript to Blazor.

[Parameter]
public ControlEventBehavior EventBehavior { get; set; }

Inherited from: BaseRendererControl

[Parameter]
public RenderFragment ChildContent { get; set; }

Inherited from: BaseRendererControl

Gets or sets what type of date conversion to make when round tripping dates.

[Parameter]
public RoundTripDateConversion RoundTripDateConversion { get; set; }

Inherited from: BaseRendererControl

protected virtual bool SupportsVisualChildren { get; }

Inherited from: BaseRendererControl

protected virtual bool UseDirectRender { get; }

Inherited from: BaseRendererControl

protected virtual string DirectRenderElementName { get; }

Inherited from: BaseRendererControl

protected virtual bool NeedsDynamicContent { get; }

Inherited from: BaseRendererControl

protected virtual bool UseCamelEnumValues { get; }

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

[Parameter]
public string ActualBrushes { get; set; }
public IgbDashboardTileCustomizationCollection ActualCustomizations { get; }

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

[Parameter]
public string ActualOutlines { get; set; }

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

[Parameter]
public bool AutoCalloutsVisible { get; set; }

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

[Parameter]
public string BackgroundColor { get; set; }

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

[Parameter]
public BaseControlTheme BaseTheme { get; set; }

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

[Parameter]
public string Brushes { get; set; }

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

[Parameter]
public string CategoryAxisMajorStroke { get; set; }
public IgbDashboardTileCustomizationCollection ContentCustomizations { get; }

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

[Parameter]
public bool CrosshairsAnnotationEnabled { get; set; }

Gets or sets the crosshairs to be displayed.

[Parameter]
public CrosshairsDisplayMode CrosshairsDisplayMode { get; set; }

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

public IgbDashboardTileCustomizationCollection Customizations { get; protected set; }

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

[Parameter]
public object DataSource { get; set; }

Provides a means of setting DataSource in the JavaScript environment.

[Parameter]
public string DataSourceScript { get; set; }

Gets the components default event behavior.

protected override ControlEventBehavior DefaultEventBehavior { get; }

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

[Parameter]
public ControlDisplayDensity Density { get; set; }

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

[Parameter]
public string[] ExcludedProperties { get; set; }

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.

public IgbFilterExpressionCollection FilterExpressions { get; protected set; }

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

[Parameter]
public bool FinalValueAnnotationsVisible { get; set; }

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.

public IgbDashboardTileSortDescriptionCollection GroupDescriptions { get; protected set; }
public IgbDashboardTileSortDescriptionCollection GroupSortDescriptions { get; protected set; }

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

[Parameter]
public string GroupSorts { get; set; }

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.

public IgbFilterExpressionCollection HighlightFilterExpressions { get; protected set; }

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

[Parameter]
public object HighlightedDataSource { get; set; }

Provides a means of setting HighlightedDataSource in the JavaScript environment.

[Parameter]
public string HighlightedDataSourceScript { get; set; }

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.

[Parameter]
public virtual SeriesHighlightedValuesDisplayMode HighlightedValuesDisplayMode { get; set; }

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.

[Parameter]
public string[] IncludedProperties { get; set; }

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

[Parameter]
public string InitialFilter { get; set; }

Gets the initial filters that are applied to the chart.

public IgbFilterExpressionCollection InitialFilterExpressions { get; protected set; }

Gets the initial groupings that are applied to the chart.

public IgbDashboardTileSortDescriptionCollection InitialGroupDescriptions { get; protected set; }

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

public IgbDashboardTileSortDescriptionCollection InitialGroupSortDescriptions { get; protected set; }

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

[Parameter]
public string InitialGroups { get; set; }

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

[Parameter]
public string InitialHighlightFilter { get; set; }

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

public IgbFilterExpressionCollection InitialHighlightFilterExpressions { get; protected set; }

Gets the initial sorts that are applied to the chart.

public IgbDashboardTileSortDescriptionCollection InitialSortDescriptions { get; protected set; }

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

[Parameter]
public string InitialSorts { get; set; }

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

[Parameter]
public string InitialSummaries { get; set; }

Gets the initial summaries that are applied to the chart.

public IgbDashboardTileSummaryDescriptionCollection InitialSummaryDescriptions { get; protected set; }

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

[Parameter]
public bool IsUserAnnotationsEnabled { get; set; }

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

[Parameter]
public string Outlines { get; set; }
protected override string ParentTypeName { get; }

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

public IgbChartSelectedItemCollection SelectedSeriesItems { get; set; }

ShouldAvoidAxisAnnotationCollisions

Section titled "ShouldAvoidAxisAnnotationCollisions"

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

[Parameter]
public bool ShouldAvoidAxisAnnotationCollisions { get; set; }

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.

[Parameter]
public virtual bool ShouldDisplayMockData { get; set; }

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

[Parameter]
public virtual bool ShouldUseSkeletonStyleForMockData { get; set; }

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.

public IgbDashboardTileSortDescriptionCollection SortDescriptions { get; protected set; }

Gets the current summaries that are applied to the grid.

public IgbDashboardTileSummaryDescriptionCollection SummaryDescriptions { get; protected set; }

Gets or sets text to display above the plot area.

[Parameter]
public string TileTitle { get; set; }

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

[Parameter]
public string TrendLineBrushes { get; set; }

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

[Parameter]
public TrendLineType TrendLineType { get; set; }

Gets or sets what trendlines to use in the chart.

public IgbTrendLineTypeCollection TrendLineTypes { get; set; }
public override string Type { get; }

ValidVisualizationTypePriorityThreshold

Section titled "ValidVisualizationTypePriorityThreshold"

Gets or sets the crosshairs to be displayed.

[Parameter]
public double ValidVisualizationTypePriorityThreshold { get; set; }

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

[Parameter]
public DashboardTileVisualizationType[] ValidVisualizationTypes { get; set; }

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

public IgbValueModeCollection ValueLines { get; set; }

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

[Parameter]
public string ValueLinesBrushes { get; set; }

Gets or sets the color for GlobalAverage value lines.

[Parameter]
public string ValueLinesGlobalAverageBrush { get; set; }

Gets or sets the color for GlobalMaximum value lines.

[Parameter]
public string ValueLinesGlobalMaximumBrush { get; set; }

Gets or sets the color for GlobalMinimum value lines.

[Parameter]
public string ValueLinesGlobalMinimumBrush { get; set; }

Gets or sets the crosshairs to be displayed.

[Parameter]
public DashboardTileVisualizationType VisualizationType { get; set; }

Inherited from: BaseRendererControl

protected Dictionary<Type, Dictionary<string, FieldInfo>> eventCallbacksCache

Inherited from: BaseRendererControl

protected string _cachedSerializedContent

Inherited from: BaseRendererControl

Resolves the components event behavior if Auto is selected.

protected ControlEventBehavior ResolveEventBehavior()

Returns any

Inherited from: BaseRendererControl

protected virtual string ResolveDisplay()

Returns any

Inherited from: BaseRendererControl

protected string ToSpinal(string value)

Parameters

  • value: string

Returns any

Inherited from: BaseRendererControl

protected virtual string TransformSimpleKey(string key)

Parameters

  • key: string

Returns any

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

Inherited from: BaseRendererControl

protected virtual SequenceInfo BuildSequenceInfo(int startSequence)

Parameters

  • startSequence: int

Returns any

Inherited from: BaseRendererControl

protected override void BuildRenderTree(RenderTreeBuilder builder)

Parameters

  • builder: RenderTreeBuilder

Returns any

Inherited from: BaseRendererControl

protected Type TemplateContentType(string templateId)

Parameters

  • templateId: string

Returns any

Inherited from: BaseRendererControl

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

  • firstRender: bool

Returns any

Inherited from: BaseRendererControl

public Task EnsureReady()

Returns any

Inherited from: BaseRendererControl

protected void MarkPropDirty(string propertyName)

Parameters

  • propertyName: string

Returns any

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

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

Inherited from: BaseRendererControl

Prevents data change notifications from be propagated to the component.

public void SuspendNotifications(object dataSource)

Parameters

  • dataSource: object

Returns any

Inherited from: BaseRendererControl

Resumes data change notifications.

public void ResumeNotifications(object dataSource, bool notify = true)

Parameters

  • dataSource: object
  • notify: bool

Returns any

NotifyInsertItem(object, int, object)

Section titled "NotifyInsertItem(object, int, object)"

Inherited from: BaseRendererControl

public void NotifyInsertItem(object dataSource, int index, object refItem)

Parameters

  • dataSource: object
  • index: int
  • refItem: object

Returns any

NotifyRemoveItem(object, int, object)

Section titled "NotifyRemoveItem(object, int, object)"

Inherited from: BaseRendererControl

public void NotifyRemoveItem(object dataSource, int index, object oldItem)

Parameters

  • dataSource: object
  • index: int
  • oldItem: object

Returns any

Inherited from: BaseRendererControl

public void NotifyClearItems(object dataSource)

Parameters

  • dataSource: object

Returns any

NotifySetItem(object, int, object, object)

Section titled "NotifySetItem(object, int, object, object)"

Inherited from: BaseRendererControl

public void NotifySetItem(object dataSource, int index, object oldItem, object newItem)

Parameters

  • dataSource: object
  • index: int
  • oldItem: object
  • newItem: object

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

Inherited from: BaseRendererControl

public void OnRefChanged(string refName, object refValue)

Parameters

  • refName: string
  • refValue: object

Returns any

Inherited from: BaseRendererControl

public void OnInvokeReturn(long invokeId, object returnValue)

Parameters

  • invokeId: long
  • returnValue: object

Returns any

Inherited from: BaseRendererControl

protected string Camelize(string value)

Parameters

  • value: string

Returns any

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

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

Inherited from: BaseRendererControl

public void Dispose()

Returns any

public void CancelAnnotationFlow(string annotationFlowId)

Parameters

  • annotationFlowId: string

Returns any

public Task CancelAnnotationFlowAsync(string annotationFlowId)

Parameters

  • annotationFlowId: string

Returns any

public void ClearSettings()

Returns any

public Task ClearSettingsAsync()

Returns any

protected override void EnsureModulesLoaded()

Returns any

public override object FindByName(string name)

Parameters

  • name: string

Returns any

FinishAnnotationFlow(IgbUserAnnotationInformation)

Section titled "FinishAnnotationFlow(IgbUserAnnotationInformation)"
public void FinishAnnotationFlow(IgbUserAnnotationInformation flowInformation)

Parameters

  • flowInformation: IgbUserAnnotationInformation

Returns any

FinishAnnotationFlowAsync(IgbUserAnnotationInformation)

Section titled "FinishAnnotationFlowAsync(IgbUserAnnotationInformation)"
public Task FinishAnnotationFlowAsync(IgbUserAnnotationInformation flowInformation)

Parameters

  • flowInformation: IgbUserAnnotationInformation

Returns any

public IgbChartSelectedItemCollection GetCurrentSelectedSeriesItems()

Returns any

GetCurrentSelectedSeriesItemsAsync()

Section titled "GetCurrentSelectedSeriesItemsAsync()"
public Task<IgbChartSelectedItemCollection> GetCurrentSelectedSeriesItemsAsync()

Returns any

public object GetSettingsValue(string key)

Parameters

  • key: string

Returns any

public Task<object> GetSettingsValueAsync(string key)

Parameters

  • key: string

Returns any

public bool HasModifiedSettings()

Returns any

public Task<bool> HasModifiedSettingsAsync()

Returns any

public void LoadAnnotationsFromJson(string jsonString)

Parameters

  • jsonString: string

Returns any

LoadAnnotationsFromJsonAsync(string)

Section titled "LoadAnnotationsFromJsonAsync(string)"
public Task LoadAnnotationsFromJsonAsync(string jsonString)

Parameters

  • jsonString: string

Returns any

public void OnUIReady()

Returns any

public Task OnUIReadyAsync()

Returns any

public void RemoveSettingsValue(string key)

Parameters

  • key: string

Returns any

public Task RemoveSettingsValueAsync(string key)

Parameters

  • key: string

Returns any

public void ResetAnnotations()

Returns any

public Task ResetAnnotationsAsync()

Returns any

public void ResetZoom()

Returns any

Resets the zoom level to default.

public Task ResetZoomAsync()

Returns any

public string SaveAnnotationsToJson()

Returns any

public Task<string> SaveAnnotationsToJsonAsync()

Returns any

public void StartCreatingAnnotation()

Returns any

public Task StartCreatingAnnotationAsync()

Returns any

public void StartDeletingAnnotation()

Returns any

public Task StartDeletingAnnotationAsync()

Returns any

UpdateSettingsValue(string, object)

Section titled "UpdateSettingsValue(string, object)"
public void UpdateSettingsValue(string key, object value)

Parameters

  • key: string
  • value: object

Returns any

UpdateSettingsValueAsync(string, object)

Section titled "UpdateSettingsValueAsync(string, object)"
public Task UpdateSettingsValueAsync(string key, object value)

Parameters

  • key: string
  • value: object

Returns any

public void ZoomIn(double percentage)

Parameters

  • percentage: double

Returns any

public Task ZoomInAsync(double percentage)

Parameters

  • percentage: double

Returns any

public void ZoomOut(double percentage)

Parameters

  • percentage: double

Returns any

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

public Task ZoomOutAsync(double percentage)

Parameters

  • percentage: double

Returns any

[Parameter]
public EventCallback<IgbDashboardTileChangingContentEventArgs> ChangingContent { get; set; }
[Parameter]
public EventCallback<IgbDashboardTileFilterStringErrorsParsingEventArgs> FilterStringErrorsParsing { get; set; }
[Parameter]
public EventCallback<IgbUserAnnotationInformationEventArgs> UserAnnotationInformationRequested { get; set; }

UserAnnotationToolTipContentUpdating

Section titled "UserAnnotationToolTipContentUpdating"
[Parameter]
public EventCallback<IgbUserAnnotationToolTipContentUpdatingEventArgs> UserAnnotationToolTipContentUpdating { get; set; }
[Parameter]
public string ChangingContentScript { get; set; }
[Parameter]
public string FilterStringErrorsParsingScript { get; set; }

UserAnnotationInformationRequestedScript

Section titled "UserAnnotationInformationRequestedScript"
[Parameter]
public string UserAnnotationInformationRequestedScript { get; set; }

UserAnnotationToolTipContentUpdatingScript

Section titled "UserAnnotationToolTipContentUpdatingScript"
[Parameter]
public string UserAnnotationToolTipContentUpdatingScript { get; set; }