IIgrDashboardTileProps

Properties

Optional actualBrushes

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

actualBrushes?: string | string[]

Optional actualOutlines

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

actualOutlines?: string | string[]

Optional autoCalloutsVisible

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

autoCalloutsVisible?: string | boolean

Optional backgroundColor

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

backgroundColor?: string

Optional baseTheme

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

baseTheme?: any

Optional brushes

Gets or sets the palette of brushes to use for coloring the dashboard tile. 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

brushes?: string | string[]

Optional categoryAxisMajorStroke

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

categoryAxisMajorStroke?: string

Optional changingContent

changingContent?: object

Optional children

children?: ReactNode

Optional crosshairsAnnotationEnabled

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

crosshairsAnnotationEnabled?: string | boolean

Optional crosshairsDisplayMode

Gets or sets the crosshairs to be displayed.

crosshairsDisplayMode?: any

Optional dataSource

Gets or sets a collection of data items used to generate the dashboard tile. 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.

dataSource?: any

Optional density

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

density?: any

Optional excludedProperties

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

excludedProperties?: string[]

Optional filterStringErrorsParsing

filterStringErrorsParsing?: object

Optional finalValueAnnotationsVisible

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

finalValueAnnotationsVisible?: string | boolean

Optional groupSorts

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

groupSorts?: string

Optional height

height?: string

Optional highlightedDataSource

Gets or sets a collection of data items used to generate the dashboard tile. 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.

highlightedDataSource?: any

Optional 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.

highlightedValuesDisplayMode?: any

Optional 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.

includedProperties?: string[]

Optional 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.

initialFilter?: string

Optional initialGroups

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

initialGroups?: string

Optional 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.

initialHighlightFilter?: string

Optional initialSorts

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

initialSorts?: string

Optional initialSummaries

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

initialSummaries?: string

Optional isUserAnnotationsEnabled

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

isUserAnnotationsEnabled?: string | boolean

Optional outlines

Gets or sets the palette of brushes to use for outlines on the dashboard tile. 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

outlines?: string | string[]

Optional 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.

selectedSeriesItems?: any

Optional shouldAvoidAxisAnnotationCollisions

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

shouldAvoidAxisAnnotationCollisions?: string | boolean

Optional 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.

shouldDisplayMockData?: string | boolean

Optional shouldUseSkeletonStyleForMockData

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

shouldUseSkeletonStyleForMockData?: string | boolean

Optional tileTitle

Gets or sets text to display above the plot area.

tileTitle?: string

Optional trendLineBrushes

Gets or sets the palette of brushes to used for coloring trend lines in this chart. 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

trendLineBrushes?: string | string[]

Optional trendLineType

Gets or sets the formula used for calculating trend lines in this chart. This property applies only to these chart types: point, line, spline, and bubble

trendLineType?: any

Optional trendLineTypes

Gets or sets what trendlines to use in the chart.

trendLineTypes?: any

Optional userAnnotationInformationRequested

Occurs to request additional information for an annotation being added.

userAnnotationInformationRequested?: object

Optional userAnnotationToolTipContentUpdating

Occurs to request additional information for an annotation being added.

userAnnotationToolTipContentUpdating?: object

Optional validVisualizationTypePriorityThreshold

Gets or sets the crosshairs to be displayed.

validVisualizationTypePriorityThreshold?: string | number

Optional validVisualizationTypes

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

validVisualizationTypes?: DashboardTileVisualizationType[]

Optional valueLines

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

valueLines?: any

Optional valueLinesBrushes

Gets or sets the palette of brushes to use for coloring the value lines present in the ValueLines property. 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

valueLinesBrushes?: string | string[]

Optional valueLinesGlobalAverageBrush

Gets or sets the color for GlobalAverage value lines.

valueLinesGlobalAverageBrush?: string

Optional valueLinesGlobalMaximumBrush

Gets or sets the color for GlobalMaximum value lines.

valueLinesGlobalMaximumBrush?: string

Optional valueLinesGlobalMinimumBrush

Gets or sets the color for GlobalMinimum value lines.

valueLinesGlobalMinimumBrush?: string

Optional visualizationType

Gets or sets the crosshairs to be displayed.

visualizationType?: string | DashboardTileVisualizationType

Optional width

width?: string