IgrDashboardTile

Constructors

new IgrDashboardTile(props: IIgrDashboardTileProps): IgrDashboardTile

Returns IgrDashboardTile

Properties

actualBrushes

actualBrushes: string[]

actualOutlines

actualOutlines: string[]

autoCalloutsVisible

autoCalloutsVisible: boolean

backgroundColor

backgroundColor: string

baseTheme

baseTheme: BaseControlTheme

brushes

brushes: string[]

categoryAxisMajorStroke

categoryAxisMajorStroke: string

changingContent

changingContent: object

crosshairsAnnotationEnabled

crosshairsAnnotationEnabled: boolean

crosshairsDisplayMode

crosshairsDisplayMode: CrosshairsDisplayMode

dataSource

dataSource: any

density

density: ControlDisplayDensity

excludedProperties

excludedProperties: string[]

filterStringErrorsParsing

filterStringErrorsParsing: object

finalValueAnnotationsVisible

finalValueAnnotationsVisible: boolean

groupSorts

groupSorts: string

height

height: string

highlightedDataSource

highlightedDataSource: any

highlightedValuesDisplayMode

highlightedValuesDisplayMode: SeriesHighlightedValuesDisplayMode

includedProperties

includedProperties: string[]

initialFilter

initialFilter: string

initialGroups

initialGroups: string

initialHighlightFilter

initialHighlightFilter: string

initialSorts

initialSorts: string

initialSummaries

initialSummaries: string

isUserAnnotationsEnabled

isUserAnnotationsEnabled: boolean

outlines

outlines: string[]

selectedSeriesItems

selectedSeriesItems: IgrChartSelectedItemCollection

shouldAvoidAxisAnnotationCollisions

shouldAvoidAxisAnnotationCollisions: boolean

shouldDisplayMockData

shouldDisplayMockData: boolean

shouldUseSkeletonStyleForMockData

shouldUseSkeletonStyleForMockData: boolean

tileTitle

tileTitle: string

trendLineBrushes

trendLineBrushes: string[]

trendLineType

trendLineType: TrendLineType

trendLineTypes

trendLineTypes: IgrTrendLineTypeCollection

userAnnotationInformationRequested

userAnnotationInformationRequested: object

userAnnotationToolTipContentUpdating

userAnnotationToolTipContentUpdating: object

validVisualizationTypePriorityThreshold

validVisualizationTypePriorityThreshold: number

validVisualizationTypes

validVisualizationTypes: DashboardTileVisualizationType[]

valueLines

valueLines: IgrValueModeCollection

valueLinesBrushes

valueLinesBrushes: string[]

valueLinesGlobalAverageBrush

valueLinesGlobalAverageBrush: string

valueLinesGlobalMaximumBrush

valueLinesGlobalMaximumBrush: string

valueLinesGlobalMinimumBrush

valueLinesGlobalMinimumBrush: string

visualizationType

visualizationType: DashboardTileVisualizationType

width

width: string

Accessors

actualCustomizations

get actualCustomizations(): IgrDashboardTileCustomization<IIgrDashboardTileCustomizationProps>[]

Returns IgrDashboardTileCustomization<IIgrDashboardTileCustomizationProps>[]

contentCustomizations

get contentCustomizations(): IgrDashboardTileCustomization<IIgrDashboardTileCustomizationProps>[]

Returns IgrDashboardTileCustomization<IIgrDashboardTileCustomizationProps>[]

customizations

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

get customizations(): IgrDashboardTileCustomizationCollection

Returns IgrDashboardTileCustomizationCollection

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

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

get groupSortDescriptions(): IgrDashboardTileSortDescriptionCollection

Returns IgrDashboardTileSortDescriptionCollection

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

initialFilterExpressions

Gets the initial filters that are applied to the chart.

get initialFilterExpressions(): IgrFilterExpressionCollection

Returns IgrFilterExpressionCollection

initialGroupDescriptions

Gets the initial groupings that are applied to the chart.

get initialGroupDescriptions(): IgrDashboardTileSortDescriptionCollection

Returns IgrDashboardTileSortDescriptionCollection

initialGroupSortDescriptions

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

get initialGroupSortDescriptions(): IgrDashboardTileSortDescriptionCollection

Returns IgrDashboardTileSortDescriptionCollection

initialHighlightFilterExpressions

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

get initialHighlightFilterExpressions(): IgrFilterExpressionCollection

Returns IgrFilterExpressionCollection

initialSortDescriptions

Gets the initial sorts that are applied to the chart.

get initialSortDescriptions(): IgrDashboardTileSortDescriptionCollection

Returns IgrDashboardTileSortDescriptionCollection

initialSummaryDescriptions

Gets the initial summaries that are applied to the chart.

get initialSummaryDescriptions(): IgrDashboardTileSummaryDescriptionCollection

Returns IgrDashboardTileSummaryDescriptionCollection

isVisTypeRadial

get isVisTypeRadial(): boolean

Returns boolean

isVisTypeStacked

get isVisTypeStacked(): boolean

Returns boolean

nativeElement

get nativeElement(): HTMLElement

Returns HTMLElement

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

Gets the current summaries that are applied to the grid.

get summaryDescriptions(): IgrDashboardTileSummaryDescriptionCollection

Returns IgrDashboardTileSummaryDescriptionCollection

Methods

addCommandAvailabilityListener

addCommandAvailabilityListener(listener: ICommandAvailabilityListener): void

Parameters

listener: ICommandAvailabilityListener

Returns void

addCommandStateChangedListener

addCommandStateChangedListener(listener: ICommandStateChangedListener): void

Parameters

listener: ICommandStateChangedListener

Returns void

cancelAnnotationFlow

cancelAnnotationFlow(annotationFlowId: string): void

Parameters

annotationFlowId: string

Returns void

clearSettings

clearSettings(): void

Returns void

componentDidMount

componentDidMount(): void

Returns void

componentWillUnmount

componentWillUnmount(): void

Returns void

destroy

destroy(): void

Returns void

findByName

findByName(name: string): any

Parameters

name: string

Returns any

finishAnnotationFlow

finishAnnotationFlow(flowInformation: IgrUserAnnotationInformation): void

Parameters

flowInformation: IgrUserAnnotationInformation

Returns void

getDesiredToolbarActions

getDesiredToolbarActions(): ToolActionInfo[]

Returns ToolActionInfo[]

getSettingsValue

getSettingsValue(key: string): any

Parameters

key: string

Returns any

hasModifiedSettings

hasModifiedSettings(): boolean

Returns boolean

initializeContent

initializeContent(): void

Returns void

loadAnnotationsFromJson

loadAnnotationsFromJson(jsonString: string): void

Parameters

jsonString: string

Returns void

onUIReady

onUIReady(): void

Returns void

removeCommandAvailabilityListener

removeCommandAvailabilityListener(listener: ICommandAvailabilityListener): void

Parameters

listener: ICommandAvailabilityListener

Returns void

removeCommandStateChangedListener

removeCommandStateChangedListener(listener: ICommandStateChangedListener): void

Parameters

listener: ICommandStateChangedListener

Returns void

removeSettingsValue

removeSettingsValue(key: string): void

Parameters

key: string

Returns void

render

render(): DetailedReactHTMLElement<object, any>

Returns DetailedReactHTMLElement<object, any>

resetAnnotations

resetAnnotations(): void

Returns void

resetZoom

Resets the zoom level to default.

resetZoom(): void

Returns void

saveAnnotationsToJson

saveAnnotationsToJson(): string

Returns string

shouldComponentUpdate

shouldComponentUpdate(nextProps: any, nextState: any): boolean

Parameters

nextProps: any
nextState: any

Returns boolean

startCreatingAnnotation

startCreatingAnnotation(): void

Returns void

startDeletingAnnotation

startDeletingAnnotation(): void

Returns void

updateSettingsValue

updateSettingsValue(key: string, value: any): void

Parameters

key: string
value: any

Returns void

updateStyle

updateStyle(): void

Returns void

zoomIn

zoomIn(percentage: number): void

Parameters

percentage: number

Returns void

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

_createFromInternal(internal: any): IgrDashboardTile

Parameters

internal: any