Constructors

Section titled "Constructors"

IgrDashboardTile 

new IgrDashboardTile(props: IIgrDashboardTileProps): IgrDashboardTile

Returns IgrDashboardTile

Accessors

Section titled "Accessors"

actualBrushes

Section titled "actualBrushes"

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

 
get actualBrushes(): string[]

Returns string[] 

set actualBrushes(v: string[]): void

Parameters

  • v: string[]

Returns void

actualCustomizations

Section titled "actualCustomizations"

actualOutlines

Section titled "actualOutlines"

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

 
get actualOutlines(): string[]

Returns string[] 

set actualOutlines(v: string[]): void

Parameters

  • v: string[]

Returns void

autoCalloutsVisible

Section titled "autoCalloutsVisible"

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

 
get autoCalloutsVisible(): boolean

Returns boolean 

set autoCalloutsVisible(v: boolean): void

Parameters

  • v: boolean

Returns void

backgroundColor

Section titled "backgroundColor"

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

 
get backgroundColor(): string

Returns string 

set backgroundColor(v: string): void

Parameters

  • v: string

Returns void

baseTheme

Section titled "baseTheme"

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

 
get baseTheme(): BaseControlTheme

Returns BaseControlTheme 

set baseTheme(v: BaseControlTheme): void

Parameters

  • v: BaseControlTheme

Returns void

brushes

Section titled "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

 
get brushes(): string[]

Returns string[] 

set brushes(v: string[]): void

Parameters

  • v: string[]

Returns void

categoryAxisMajorStroke

Section titled "categoryAxisMajorStroke"

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

 
get categoryAxisMajorStroke(): string

Returns string 

set categoryAxisMajorStroke(v: string): void

Parameters

  • v: string

Returns void

changingContent

Section titled "changingContent" 
get changingContent(): object

Returns object 

set changingContent(ev: object): void

Parameters

  • ev: object

Returns void

contentCustomizations

Section titled "contentCustomizations"

crosshairsAnnotationEnabled

Section titled "crosshairsAnnotationEnabled"

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

 
get crosshairsAnnotationEnabled(): boolean

Returns boolean 

set crosshairsAnnotationEnabled(v: boolean): void

Parameters

  • v: boolean

Returns void

crosshairsDisplayMode

Section titled "crosshairsDisplayMode"

Gets or sets the crosshairs to be displayed.

 
get crosshairsDisplayMode(): CrosshairsDisplayMode

Returns CrosshairsDisplayMode 

set crosshairsDisplayMode(v: CrosshairsDisplayMode): void

Parameters

  • v: CrosshairsDisplayMode

Returns void

customizations

Section titled "customizations"

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

 
get customizations(): IgrDashboardTileCustomizationCollection

Returns IgrDashboardTileCustomizationCollection

dataSource

Section titled "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.

 
get dataSource(): any

Returns any 

set dataSource(v: any): void

Parameters

  • v: any

Returns void

density

Section titled "density"

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

 
get density(): ControlDisplayDensity

Returns ControlDisplayDensity 

set density(v: ControlDisplayDensity): void

Parameters

  • v: ControlDisplayDensity

Returns void

excludedProperties

Section titled "excludedProperties"

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

 
get excludedProperties(): string[]

Returns string[] 

set excludedProperties(v: string[]): void

Parameters

  • v: string[]

Returns void

filterExpressions

Section titled "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.

 
get filterExpressions(): IgrFilterExpressionCollection

Returns IgrFilterExpressionCollection

filterStringErrorsParsing

Section titled "filterStringErrorsParsing" 
get filterStringErrorsParsing(): object

Returns object 

set filterStringErrorsParsing(ev: object): void

Parameters

  • ev: object

Returns void

finalValueAnnotationsVisible

Section titled "finalValueAnnotationsVisible"

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

 
get finalValueAnnotationsVisible(): boolean

Returns boolean 

set finalValueAnnotationsVisible(v: boolean): void

Parameters

  • v: boolean

Returns void

groupDescriptions

Section titled "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.

 
get groupDescriptions(): IgrDashboardTileSortDescriptionCollection

Returns IgrDashboardTileSortDescriptionCollection

groupSortDescriptions

Section titled "groupSortDescriptions"

groupSorts

Section titled "groupSorts"

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

 
get groupSorts(): string

Returns string 

set groupSorts(v: string): void

Parameters

  • v: string

Returns void

height

Section titled "height" 
get height(): string

Returns string 

set height(value: string): void

Parameters

  • value: string

Returns void

highlightedDataSource

Section titled "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.

 
get highlightedDataSource(): any

Returns any 

set highlightedDataSource(v: any): void

Parameters

  • v: any

Returns void

highlightedValuesDisplayMode

Section titled "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.

 
get highlightedValuesDisplayMode(): SeriesHighlightedValuesDisplayMode

Returns SeriesHighlightedValuesDisplayMode 

set highlightedValuesDisplayMode(v: SeriesHighlightedValuesDisplayMode): void

Parameters

  • v: SeriesHighlightedValuesDisplayMode

Returns void

highlightFilterExpressions

Section titled "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.

 
get highlightFilterExpressions(): IgrFilterExpressionCollection

Returns IgrFilterExpressionCollection

includedProperties

Section titled "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.

 
get includedProperties(): string[]

Returns string[] 

set includedProperties(v: string[]): void

Parameters

  • v: string[]

Returns void

initialFilter

Section titled "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.

 
get initialFilter(): string

Returns string 

set initialFilter(v: string): void

Parameters

  • v: string

Returns void

initialFilterExpressions

Section titled "initialFilterExpressions"

Gets the initial filters that are applied to the chart.

 
get initialFilterExpressions(): IgrFilterExpressionCollection

Returns IgrFilterExpressionCollection

initialGroupDescriptions

Section titled "initialGroupDescriptions"

Gets the initial groupings that are applied to the chart.

 
get initialGroupDescriptions(): IgrDashboardTileSortDescriptionCollection

Returns IgrDashboardTileSortDescriptionCollection

initialGroups

Section titled "initialGroups"

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

 
get initialGroups(): string

Returns string 

set initialGroups(v: string): void

Parameters

  • v: string

Returns void

initialGroupSortDescriptions

Section titled "initialGroupSortDescriptions"

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

 
get initialGroupSortDescriptions(): IgrDashboardTileSortDescriptionCollection

Returns IgrDashboardTileSortDescriptionCollection

initialHighlightFilter

Section titled "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.

 
get initialHighlightFilter(): string

Returns string 

set initialHighlightFilter(v: string): void

Parameters

  • v: string

Returns void

initialHighlightFilterExpressions

Section titled "initialHighlightFilterExpressions"

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

 
get initialHighlightFilterExpressions(): IgrFilterExpressionCollection

Returns IgrFilterExpressionCollection

initialSortDescriptions

Section titled "initialSortDescriptions"

Gets the initial sorts that are applied to the chart.

 
get initialSortDescriptions(): IgrDashboardTileSortDescriptionCollection

Returns IgrDashboardTileSortDescriptionCollection

initialSorts

Section titled "initialSorts"

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

 
get initialSorts(): string

Returns string 

set initialSorts(v: string): void

Parameters

  • v: string

Returns void

initialSummaries

Section titled "initialSummaries"

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

 
get initialSummaries(): string

Returns string 

set initialSummaries(v: string): void

Parameters

  • v: string

Returns void

initialSummaryDescriptions

Section titled "initialSummaryDescriptions"

Gets the initial summaries that are applied to the chart.

 
get initialSummaryDescriptions(): IgrDashboardTileSummaryDescriptionCollection

Returns IgrDashboardTileSummaryDescriptionCollection

isUserAnnotationsEnabled

Section titled "isUserAnnotationsEnabled"

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

 
get isUserAnnotationsEnabled(): boolean

Returns boolean 

set isUserAnnotationsEnabled(v: boolean): void

Parameters

  • v: boolean

Returns void

isVisTypeRadial

Section titled "isVisTypeRadial" 
get isVisTypeRadial(): boolean

Returns boolean

isVisTypeStacked

Section titled "isVisTypeStacked" 
get isVisTypeStacked(): boolean

Returns boolean

nativeElement

Section titled "nativeElement" 
get nativeElement(): HTMLElement

Returns HTMLElement

outlines

Section titled "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

 
get outlines(): string[]

Returns string[] 

set outlines(v: string[]): void

Parameters

  • v: string[]

Returns void

selectedSeriesItems

Section titled "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.

 
get selectedSeriesItems(): IgrChartSelectedItemCollection

Returns IgrChartSelectedItemCollection 

set selectedSeriesItems(v: IgrChartSelectedItemCollection): void

Parameters

  • v: IgrChartSelectedItemCollection

Returns void

shouldAvoidAxisAnnotationCollisions

Section titled "shouldAvoidAxisAnnotationCollisions"

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

 
get shouldAvoidAxisAnnotationCollisions(): boolean

Returns boolean 

set shouldAvoidAxisAnnotationCollisions(v: boolean): void

Parameters

  • v: boolean

Returns void

shouldDisplayMockData

Section titled "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.

 
get shouldDisplayMockData(): boolean

Returns boolean 

set shouldDisplayMockData(v: boolean): void

Parameters

  • v: boolean

Returns void

shouldUseSkeletonStyleForMockData

Section titled "shouldUseSkeletonStyleForMockData"

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

 
get shouldUseSkeletonStyleForMockData(): boolean

Returns boolean 

set shouldUseSkeletonStyleForMockData(v: boolean): void

Parameters

  • v: boolean

Returns void

sortDescriptions

Section titled "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.

 
get sortDescriptions(): IgrDashboardTileSortDescriptionCollection

Returns IgrDashboardTileSortDescriptionCollection

summaryDescriptions

Section titled "summaryDescriptions"

Gets the current summaries that are applied to the grid.

 
get summaryDescriptions(): IgrDashboardTileSummaryDescriptionCollection

Returns IgrDashboardTileSummaryDescriptionCollection

tileTitle

Section titled "tileTitle"

Gets or sets text to display above the plot area.

 
get tileTitle(): string

Returns string 

set tileTitle(v: string): void

Parameters

  • v: string

Returns void

trendLineBrushes

Section titled "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

 
get trendLineBrushes(): string[]

Returns string[] 

set trendLineBrushes(v: string[]): void

Parameters

  • v: string[]

Returns void

trendLineType

Section titled "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

 
get trendLineType(): TrendLineType

Returns TrendLineType 

set trendLineType(v: TrendLineType): void

Parameters

  • v: TrendLineType

Returns void

trendLineTypes

Section titled "trendLineTypes"

Gets or sets what trendlines to use in the chart.

 
get trendLineTypes(): IgrTrendLineTypeCollection

Returns IgrTrendLineTypeCollection 

set trendLineTypes(v: IgrTrendLineTypeCollection): void

Parameters

  • v: IgrTrendLineTypeCollection

Returns void

userAnnotationInformationRequested

Section titled "userAnnotationInformationRequested"

Occurs to request additional information for an annotation being added.

 
get userAnnotationInformationRequested(): object

Returns object 

set userAnnotationInformationRequested(ev: object): void

Parameters

  • ev: object

Returns void

userAnnotationToolTipContentUpdating

Section titled "userAnnotationToolTipContentUpdating"

Occurs to request additional information for an annotation being added.

 
get userAnnotationToolTipContentUpdating(): object

Returns object 

set userAnnotationToolTipContentUpdating(ev: object): void

Parameters

  • ev: object

Returns void

validVisualizationTypePriorityThreshold

Section titled "validVisualizationTypePriorityThreshold"

Gets or sets the crosshairs to be displayed.

 
get validVisualizationTypePriorityThreshold(): number

Returns number 

set validVisualizationTypePriorityThreshold(v: number): void

Parameters

  • v: number

Returns void

validVisualizationTypes

Section titled "validVisualizationTypes"

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

 
get validVisualizationTypes(): DashboardTileVisualizationType[]

Returns DashboardTileVisualizationType[] 

set validVisualizationTypes(v: DashboardTileVisualizationType[]): void

Parameters

Returns void

valueLines

Section titled "valueLines"

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

 
get valueLines(): IgrValueModeCollection

Returns IgrValueModeCollection 

set valueLines(v: IgrValueModeCollection): void

Parameters

  • v: IgrValueModeCollection

Returns void

valueLinesBrushes

Section titled "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

 
get valueLinesBrushes(): string[]

Returns string[] 

set valueLinesBrushes(v: string[]): void

Parameters

  • v: string[]

Returns void

valueLinesGlobalAverageBrush

Section titled "valueLinesGlobalAverageBrush"

Gets or sets the color for GlobalAverage value lines.

 
get valueLinesGlobalAverageBrush(): string

Returns string 

set valueLinesGlobalAverageBrush(v: string): void

Parameters

  • v: string

Returns void

valueLinesGlobalMaximumBrush

Section titled "valueLinesGlobalMaximumBrush"

Gets or sets the color for GlobalMaximum value lines.

 
get valueLinesGlobalMaximumBrush(): string

Returns string 

set valueLinesGlobalMaximumBrush(v: string): void

Parameters

  • v: string

Returns void

valueLinesGlobalMinimumBrush

Section titled "valueLinesGlobalMinimumBrush"

Gets or sets the color for GlobalMinimum value lines.

 
get valueLinesGlobalMinimumBrush(): string

Returns string 

set valueLinesGlobalMinimumBrush(v: string): void

Parameters

  • v: string

Returns void

visualizationType

Section titled "visualizationType"

Gets or sets the crosshairs to be displayed.

 
get visualizationType(): DashboardTileVisualizationType

Returns DashboardTileVisualizationType 

set visualizationType(v: DashboardTileVisualizationType): void

Parameters

Returns void

width

Section titled "width" 
get width(): string

Returns string 

set width(value: string): void

Parameters

  • value: string

Returns void

Methods

Section titled "Methods"

addCommandAvailabilityListener

Section titled "addCommandAvailabilityListener" 
addCommandAvailabilityListener(listener: ICommandAvailabilityListener): void

Parameters

  • listener: ICommandAvailabilityListener

Returns void

addCommandStateChangedListener

Section titled "addCommandStateChangedListener" 
addCommandStateChangedListener(listener: ICommandStateChangedListener): void

Parameters

  • listener: ICommandStateChangedListener

Returns void

cancelAnnotationFlow

Section titled "cancelAnnotationFlow" 
cancelAnnotationFlow(annotationFlowId: string): void

Parameters

  • annotationFlowId: string

Returns void

clearSettings

Section titled "clearSettings" 
clearSettings(): void

Returns void

componentDidMount

Section titled "componentDidMount" 
componentDidMount(): void

Returns void

componentWillUnmount

Section titled "componentWillUnmount" 
componentWillUnmount(): void

Returns void

destroy

Section titled "destroy" 
destroy(): void

Returns void

findByName

Section titled "findByName" 
findByName(name: string): any

Parameters

  • name: string

Returns any

finishAnnotationFlow

Section titled "finishAnnotationFlow" 
finishAnnotationFlow(flowInformation: IgrUserAnnotationInformation): void

Parameters

  • flowInformation: IgrUserAnnotationInformation

Returns void

getDesiredToolbarActions

Section titled "getDesiredToolbarActions" 
getDesiredToolbarActions(): ToolActionInfo[]

Returns ToolActionInfo[]

getSettingsValue

Section titled "getSettingsValue" 
getSettingsValue(key: string): any

Parameters

  • key: string

Returns any

hasModifiedSettings

Section titled "hasModifiedSettings" 
hasModifiedSettings(): boolean

Returns boolean

initializeContent

Section titled "initializeContent" 
initializeContent(): void

Returns void

loadAnnotationsFromJson

Section titled "loadAnnotationsFromJson" 
loadAnnotationsFromJson(jsonString: string): void

Parameters

  • jsonString: string

Returns void

onUIReady

Section titled "onUIReady" 
onUIReady(): void

Returns void

removeCommandAvailabilityListener

Section titled "removeCommandAvailabilityListener" 
removeCommandAvailabilityListener(listener: ICommandAvailabilityListener): void

Parameters

  • listener: ICommandAvailabilityListener

Returns void

removeCommandStateChangedListener

Section titled "removeCommandStateChangedListener" 
removeCommandStateChangedListener(listener: ICommandStateChangedListener): void

Parameters

  • listener: ICommandStateChangedListener

Returns void

removeSettingsValue

Section titled "removeSettingsValue" 
removeSettingsValue(key: string): void

Parameters

  • key: string

Returns void

render

Section titled "render" 
render(): DetailedReactHTMLElement<object, any>

Returns DetailedReactHTMLElement<object, any>

resetAnnotations

Section titled "resetAnnotations" 
resetAnnotations(): void

Returns void

resetZoom

Section titled "resetZoom"

Resets the zoom level to default.

 
resetZoom(): void

Returns void

saveAnnotationsToJson

Section titled "saveAnnotationsToJson" 
saveAnnotationsToJson(): string

Returns string

shouldComponentUpdate

Section titled "shouldComponentUpdate" 
shouldComponentUpdate(nextProps: any, nextState: any): boolean

Parameters

  • nextProps: any
  • nextState: any

Returns boolean

startCreatingAnnotation

Section titled "startCreatingAnnotation" 
startCreatingAnnotation(): void

Returns void

startDeletingAnnotation

Section titled "startDeletingAnnotation" 
startDeletingAnnotation(): void

Returns void

updateSettingsValue

Section titled "updateSettingsValue" 
updateSettingsValue(key: string, value: any): void

Parameters

  • key: string
  • value: any

Returns void

updateStyle

Section titled "updateStyle" 
updateStyle(): void

Returns void

zoomIn

Section titled "zoomIn" 
zoomIn(percentage: number): void

Parameters

  • percentage: number

Returns void

zoomOut

Section titled "zoomOut"

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

 
zoomOut(percentage: number): void

Parameters

  • percentage: number

Returns void

_createFromInternal

Section titled "_createFromInternal" 
_createFromInternal(internal: any): IgrDashboardTile

Parameters

  • internal: any

Returns IgrDashboardTile