IgcDashboardTileComponent

Constructors

new IgcDashboardTileComponent(): IgcDashboardTileComponent

Returns IgcDashboardTileComponent

Properties

htmlTagName

htmlTagName: string

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: IgcChartSelectedItemCollection

shouldAvoidAxisAnnotationCollisions

shouldAvoidAxisAnnotationCollisions: boolean

shouldDisplayMockData

shouldDisplayMockData: boolean

shouldUseSkeletonStyleForMockData

shouldUseSkeletonStyleForMockData: boolean

tileTitle

tileTitle: string

trendLineBrushes

trendLineBrushes: string[]

trendLineType

trendLineType: TrendLineType

trendLineTypes

trendLineTypes: IgcTrendLineTypeCollection

userAnnotationInformationRequested

userAnnotationInformationRequested: object

userAnnotationToolTipContentUpdating

userAnnotationToolTipContentUpdating: object

validVisualizationTypePriorityThreshold

validVisualizationTypePriorityThreshold: number

validVisualizationTypes

validVisualizationTypes: DashboardTileVisualizationType[]

valueLines

valueLines: IgcValueModeCollection

valueLinesBrushes

valueLinesBrushes: string[]

valueLinesGlobalAverageBrush

valueLinesGlobalAverageBrush: string

valueLinesGlobalMaximumBrush

valueLinesGlobalMaximumBrush: string

valueLinesGlobalMinimumBrush

valueLinesGlobalMinimumBrush: string

visualizationType

visualizationType: DashboardTileVisualizationType

width

width: string

Accessors

actualCustomizations

get actualCustomizations(): IgcDashboardTileCustomizationComponent[]

Returns IgcDashboardTileCustomizationComponent[]

contentCustomizations

get contentCustomizations(): IgcDashboardTileCustomizationComponent[]

Returns IgcDashboardTileCustomizationComponent[]

customizations

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

get customizations(): IgcDashboardTileCustomizationCollection

Returns IgcDashboardTileCustomizationCollection

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

Returns IgcFilterExpressionCollection

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

Returns IgcDashboardTileSortDescriptionCollection

groupSortDescriptions

get groupSortDescriptions(): IgcDashboardTileSortDescriptionCollection

Returns IgcDashboardTileSortDescriptionCollection

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

Returns IgcFilterExpressionCollection

initialFilterExpressions

Gets the initial filters that are applied to the chart.

get initialFilterExpressions(): IgcFilterExpressionCollection

Returns IgcFilterExpressionCollection

initialGroupDescriptions

Gets the initial groupings that are applied to the chart.

get initialGroupDescriptions(): IgcDashboardTileSortDescriptionCollection

Returns IgcDashboardTileSortDescriptionCollection

initialGroupSortDescriptions

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

get initialGroupSortDescriptions(): IgcDashboardTileSortDescriptionCollection

Returns IgcDashboardTileSortDescriptionCollection

initialHighlightFilterExpressions

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

get initialHighlightFilterExpressions(): IgcFilterExpressionCollection

Returns IgcFilterExpressionCollection

initialSortDescriptions

Gets the initial sorts that are applied to the chart.

get initialSortDescriptions(): IgcDashboardTileSortDescriptionCollection

Returns IgcDashboardTileSortDescriptionCollection

initialSummaryDescriptions

Gets the initial summaries that are applied to the chart.

get initialSummaryDescriptions(): IgcDashboardTileSummaryDescriptionCollection

Returns IgcDashboardTileSummaryDescriptionCollection

isVisTypeRadial

get isVisTypeRadial(): boolean

Returns boolean

isVisTypeStacked

get isVisTypeStacked(): boolean

Returns boolean

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

Returns IgcDashboardTileSortDescriptionCollection

summaryDescriptions

Gets the current summaries that are applied to the grid.

get summaryDescriptions(): IgcDashboardTileSummaryDescriptionCollection

Returns IgcDashboardTileSummaryDescriptionCollection

observedAttributes

get observedAttributes(): string[]

Returns string[]

Methods

addCommandAvailabilityListener

addCommandAvailabilityListener(listener: ICommandAvailabilityListener): void

Parameters

listener: ICommandAvailabilityListener

Returns void

addCommandStateChangedListener

addCommandStateChangedListener(listener: ICommandStateChangedListener): void

Parameters

listener: ICommandStateChangedListener

Returns void

afterContentInit

afterContentInit(): void

Returns void

attributeChangedCallback

attributeChangedCallback(name: string, oldValue: string, newValue: string): void

Parameters

name: string
oldValue: string
newValue: string

Returns void

cancelAnnotationFlow

cancelAnnotationFlow(annotationFlowId: string): void

Parameters

annotationFlowId: string

Returns void

clearSettings

clearSettings(): void

Returns void

connectedCallback

connectedCallback(): void

Returns void

destroy

destroy(): void

Returns void

disconnectedCallback

disconnectedCallback(): void

Returns void

findByName

findByName(name: string): any

Parameters

name: string

Returns any

finishAnnotationFlow

finishAnnotationFlow(flowInformation: IgcUserAnnotationInformation): void

Parameters

flowInformation: IgcUserAnnotationInformation

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

notifyContainerResized

notifyContainerResized(): 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): IgcDashboardTileComponent

Parameters

internal: any

Returns IgcDashboardTileComponent

register

register(): void