IgxDashboardTileComponent

Constructors

new IgxDashboardTileComponent(renderer: Renderer2, _elRef: ViewContainerRef, ngZone: NgZone, injector: Injector): IgxDashboardTileComponent

Returns IgxDashboardTileComponent

Properties

_childTemplateRef

_childTemplateRef: TemplateRef<any>

_dynamicContent

_dynamicContent: ViewContainerRef

container

container: Element

contentCustomizations

contentCustomizations: QueryList<IgxDashboardTileCustomizationComponent>

ngAcceptInputType_actualBrushes

ngAcceptInputType_actualBrushes: string | string[]

ngAcceptInputType_actualOutlines

ngAcceptInputType_actualOutlines: string | string[]

ngAcceptInputType_autoCalloutsVisible

ngAcceptInputType_autoCalloutsVisible: string | boolean

ngAcceptInputType_baseTheme

ngAcceptInputType_baseTheme: any

ngAcceptInputType_brushes

ngAcceptInputType_brushes: string | string[]

ngAcceptInputType_crosshairsAnnotationEnabled

ngAcceptInputType_crosshairsAnnotationEnabled: string | boolean

ngAcceptInputType_crosshairsDisplayMode

ngAcceptInputType_crosshairsDisplayMode: any

ngAcceptInputType_customizations

ngAcceptInputType_customizations: string | IgxDashboardTileCustomizationCollection

ngAcceptInputType_density

ngAcceptInputType_density: any

ngAcceptInputType_excludedProperties

ngAcceptInputType_excludedProperties: string | string[]

ngAcceptInputType_finalValueAnnotationsVisible

ngAcceptInputType_finalValueAnnotationsVisible: string | boolean

ngAcceptInputType_highlightedValuesDisplayMode

ngAcceptInputType_highlightedValuesDisplayMode: any

ngAcceptInputType_includedProperties

ngAcceptInputType_includedProperties: string | string[]

ngAcceptInputType_isUserAnnotationsEnabled

ngAcceptInputType_isUserAnnotationsEnabled: string | boolean

ngAcceptInputType_isVisTypeRadial

ngAcceptInputType_isVisTypeRadial: string | boolean

ngAcceptInputType_isVisTypeStacked

ngAcceptInputType_isVisTypeStacked: string | boolean

ngAcceptInputType_outlines

ngAcceptInputType_outlines: string | string[]

ngAcceptInputType_selectedSeriesItems

ngAcceptInputType_selectedSeriesItems: any

ngAcceptInputType_shouldAvoidAxisAnnotationCollisions

ngAcceptInputType_shouldAvoidAxisAnnotationCollisions: string | boolean

ngAcceptInputType_shouldDisplayMockData

ngAcceptInputType_shouldDisplayMockData: string | boolean

ngAcceptInputType_shouldUseSkeletonStyleForMockData

ngAcceptInputType_shouldUseSkeletonStyleForMockData: string | boolean

ngAcceptInputType_trendLineBrushes

ngAcceptInputType_trendLineBrushes: string | string[]

ngAcceptInputType_trendLineType

ngAcceptInputType_trendLineType: any

ngAcceptInputType_trendLineTypes

ngAcceptInputType_trendLineTypes: any

ngAcceptInputType_validVisualizationTypePriorityThreshold

ngAcceptInputType_validVisualizationTypePriorityThreshold: string | number

ngAcceptInputType_validVisualizationTypes

ngAcceptInputType_validVisualizationTypes: string | DashboardTileVisualizationType[]

ngAcceptInputType_valueLines

ngAcceptInputType_valueLines: any

ngAcceptInputType_valueLinesBrushes

ngAcceptInputType_valueLinesBrushes: string | string[]

ngAcceptInputType_visualizationType

ngAcceptInputType_visualizationType: string | DashboardTileVisualizationType

ɵcmp

ɵcmp: ɵɵComponentDeclaration<IgxDashboardTileComponent, "igx-dashboard-tile", never, object, object, ["contentCustomizations"], ["*"], true, never>

ɵfac

ɵfac: ɵɵFactoryDeclaration<IgxDashboardTileComponent, never>

Accessors

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

get actualCustomizations(): IgxDashboardTileCustomizationComponent[]

Returns IgxDashboardTileCustomizationComponent[]

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

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

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

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

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

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

get changingContent(): EventEmitter<object>

Returns EventEmitter<object>

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

Gets or sets the crosshairs to be displayed.

get crosshairsDisplayMode(): CrosshairsDisplayMode

Returns CrosshairsDisplayMode

set crosshairsDisplayMode(v: CrosshairsDisplayMode): void

Parameters

v: CrosshairsDisplayMode

Returns void

customizations

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

get customizations(): IgxDashboardTileCustomizationCollection

Returns IgxDashboardTileCustomizationCollection

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

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

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

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(): IgxFilterExpressionCollection

Returns IgxFilterExpressionCollection

filterStringErrorsParsing

get filterStringErrorsParsing(): EventEmitter<object>

Returns EventEmitter<object>

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

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(): IgxDashboardTileSortDescriptionCollection

Returns IgxDashboardTileSortDescriptionCollection

groupSortDescriptions

get groupSortDescriptions(): IgxDashboardTileSortDescriptionCollection

Returns IgxDashboardTileSortDescriptionCollection

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

get height(): string

Returns string

set height(value: string): void

Parameters

value: string

Returns void

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

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

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(): IgxFilterExpressionCollection

Returns IgxFilterExpressionCollection

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

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

Gets the initial filters that are applied to the chart.

get initialFilterExpressions(): IgxFilterExpressionCollection

Returns IgxFilterExpressionCollection

initialGroupDescriptions

Gets the initial groupings that are applied to the chart.

get initialGroupDescriptions(): IgxDashboardTileSortDescriptionCollection

Returns IgxDashboardTileSortDescriptionCollection

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

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

get initialGroupSortDescriptions(): IgxDashboardTileSortDescriptionCollection

Returns IgxDashboardTileSortDescriptionCollection

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

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

get initialHighlightFilterExpressions(): IgxFilterExpressionCollection

Returns IgxFilterExpressionCollection

initialSortDescriptions

Gets the initial sorts that are applied to the chart.

get initialSortDescriptions(): IgxDashboardTileSortDescriptionCollection

Returns IgxDashboardTileSortDescriptionCollection

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

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

Gets the initial summaries that are applied to the chart.

get initialSummaryDescriptions(): IgxDashboardTileSummaryDescriptionCollection

Returns IgxDashboardTileSummaryDescriptionCollection

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

get isVisTypeRadial(): boolean

Returns boolean

isVisTypeStacked

get isVisTypeStacked(): boolean

Returns boolean

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

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(): IgxChartSelectedItemCollection

Returns IgxChartSelectedItemCollection

set selectedSeriesItems(v: IgxChartSelectedItemCollection): void

Parameters

v: IgxChartSelectedItemCollection

Returns void

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

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

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

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(): IgxDashboardTileSortDescriptionCollection

Returns IgxDashboardTileSortDescriptionCollection

summaryDescriptions

Gets the current summaries that are applied to the grid.

get summaryDescriptions(): IgxDashboardTileSummaryDescriptionCollection

Returns IgxDashboardTileSummaryDescriptionCollection

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

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

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

Gets or sets what trendlines to use in the chart.

get trendLineTypes(): IgxTrendLineTypeCollection

Returns IgxTrendLineTypeCollection

set trendLineTypes(v: IgxTrendLineTypeCollection): void

Parameters

v: IgxTrendLineTypeCollection

Returns void

userAnnotationInformationRequested

Occurs to request additional information for an annotation being added.

get userAnnotationInformationRequested(): EventEmitter<object>

Returns EventEmitter<object>

userAnnotationToolTipContentUpdating

Occurs to request additional information for an annotation being added.

get userAnnotationToolTipContentUpdating(): EventEmitter<object>

Returns EventEmitter<object>

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

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

get validVisualizationTypes(): DashboardTileVisualizationType[]

Returns DashboardTileVisualizationType[]

set validVisualizationTypes(v: DashboardTileVisualizationType[]): void

Parameters

v: DashboardTileVisualizationType[]

Returns void

valueLines

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

get valueLines(): IgxValueModeCollection

Returns IgxValueModeCollection

set valueLines(v: IgxValueModeCollection): void

Parameters

v: IgxValueModeCollection

Returns void

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

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

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

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

Gets or sets the crosshairs to be displayed.

get visualizationType(): DashboardTileVisualizationType

Returns DashboardTileVisualizationType

set visualizationType(v: DashboardTileVisualizationType): void

Parameters

v: DashboardTileVisualizationType

Returns void

width

get width(): string

Returns string

set width(value: string): void

Parameters

value: string

Returns void

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

findByName

findByName(name: string): any

Parameters

name: string

Returns any

finishAnnotationFlow

finishAnnotationFlow(flowInformation: IgxUserAnnotationInformation): void

Parameters

flowInformation: IgxUserAnnotationInformation

Returns void

getDesiredToolbarActions

getDesiredToolbarActions(): ToolActionInfo[]

Returns ToolActionInfo[]

getSettingsValue

getSettingsValue(key: string): any

Parameters

key: string

Returns any

hasModifiedSettings

hasModifiedSettings(): boolean

Returns boolean

loadAnnotationsFromJson

loadAnnotationsFromJson(jsonString: string): void

Parameters

jsonString: string

Returns void

ngAfterViewInit

ngAfterViewInit(): void

Returns void

ngOnDestroy

ngOnDestroy(): void

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

resetAnnotations

resetAnnotations(): void

Returns void

resetZoom

Resets the zoom level to default.

resetZoom(): void

Returns void

saveAnnotationsToJson

saveAnnotationsToJson(): string

Returns string

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): IgxDashboardTileComponent

Parameters

internal: any