Hierarchy

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

Properties

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
props: Readonly<IIgrDashboardTileProps> & Readonly<{
    children?: ReactNode;
}>
refs: {
    [key: string]: ReactInstance;
}

Type declaration

  • [key: string]: ReactInstance
state: Readonly<{}>
contextType?: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
static contextType = Ctx
context!: React.ContextType<typeof Ctx>
render () {
return <>My context's value: {this.context}</>;
}
}

Accessors

  • get actualBrushes(): string[]
  • Gets the actual palette of brushes to use for coloring the chart series.

    Returns string[]

  • set actualBrushes(v): void
  • Parameters

    • v: string[]

    Returns void

  • get actualOutlines(): string[]
  • Gets the actual palette of brushes to use for outlines on the chart series.

    Returns string[]

  • set actualOutlines(v): void
  • Parameters

    • v: string[]

    Returns void

  • get autoCalloutsVisible(): boolean
  • Gets or sets if the auto value callouts should be displayed.

    Returns boolean

  • set autoCalloutsVisible(v): void
  • Parameters

    • v: boolean

    Returns void

  • get backgroundColor(): string
  • Gets or sets the color to use for the background of the component.

    Returns string

  • set backgroundColor(v): void
  • Parameters

    • v: string

    Returns void

  • get baseTheme(): BaseControlTheme
  • Gets or sets the base built in theme to use for the checkbox.

    Returns BaseControlTheme

  • set baseTheme(v): void
  • Parameters

    • v: BaseControlTheme

    Returns void

  • get brushes(): string[]
  • 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

    Returns string[]

  • set brushes(v): void
  • Parameters

    • v: string[]

    Returns void

  • get categoryAxisMajorStroke(): string
  • Gets the brush to use for the Category axis major strokes, if applicable.

    Returns string

  • set categoryAxisMajorStroke(v): void
  • Parameters

    • v: string

    Returns void

  • get crosshairsAnnotationEnabled(): boolean
  • Gets or sets whether annotations are shown along the axis for crosshair values

    Returns boolean

  • set crosshairsAnnotationEnabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get crosshairsDisplayMode(): CrosshairsDisplayMode
  • Gets or sets the crosshairs to be displayed.

    Returns CrosshairsDisplayMode

  • set crosshairsDisplayMode(v): void
  • Parameters

    • v: CrosshairsDisplayMode

    Returns void

  • get dataSource(): any
  • 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.

    Returns any

  • set dataSource(v): void
  • Parameters

    • v: any

    Returns void

  • get density(): ControlDisplayDensity
  • Gets or sets the display density to use for the toolbar.

    Returns ControlDisplayDensity

  • set density(v): void
  • Parameters

    • v: ControlDisplayDensity

    Returns void

  • get excludedProperties(): string[]
  • Gets or sets a set of property paths that should be excluded from consideration by the category chart.

    Returns string[]

  • set excludedProperties(v): void
  • Parameters

    • v: string[]

    Returns void

  • get filterExpressions(): IgrFilterExpressionCollection
  • 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.

    Returns IgrFilterExpressionCollection

  • get finalValueAnnotationsVisible(): boolean
  • Gets or sets whether annotations for the final value of each series is displayed on the axis.

    Returns boolean

  • set finalValueAnnotationsVisible(v): void
  • Parameters

    • v: boolean

    Returns void

  • get groupDescriptions(): IgrDashboardTileSortDescriptionCollection
  • 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.

    Returns IgrDashboardTileSortDescriptionCollection

  • get groupSorts(): string
  • Gets or sets the sorts to apply after grouping has been applied.

    Returns string

  • set groupSorts(v): void
  • Parameters

    • v: string

    Returns void

  • get height(): string
  • Returns string

  • set height(value): void
  • Parameters

    • value: string

    Returns void

  • get highlightFilterExpressions(): IgrFilterExpressionCollection
  • 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.

    Returns IgrFilterExpressionCollection

  • get highlightedDataSource(): any
  • 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.

    Returns any

  • set highlightedDataSource(v): void
  • Parameters

    • v: any

    Returns void

  • get highlightedValuesDisplayMode(): SeriesHighlightedValuesDisplayMode
  • 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.

    Returns SeriesHighlightedValuesDisplayMode

  • set highlightedValuesDisplayMode(v): void
  • Parameters

    • v: SeriesHighlightedValuesDisplayMode

    Returns void

  • get includedProperties(): string[]
  • 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.

    Returns string[]

  • set includedProperties(v): void
  • Parameters

    • v: string[]

    Returns void

  • get initialFilter(): string
  • Gets or sets the filter to apply to the chart. This property will become ignored if the filter is changed outside of this property.

    Returns string

  • set initialFilter(v): void
  • Parameters

    • v: string

    Returns void

  • get initialFilterExpressions(): IgrFilterExpressionCollection
  • Gets the initial filters that are applied to the chart.

    Returns IgrFilterExpressionCollection

  • get initialGroups(): string
  • Gets or sets the groupings to apply to the chart. This property will become ignored if sorts are changed outside of this property.

    Returns string

  • set initialGroups(v): void
  • Parameters

    • v: string

    Returns void

  • get initialHighlightFilter(): string
  • Gets or sets the filter to apply to the chart. This property will become ignored if the filter is changed outside of this property.

    Returns string

  • set initialHighlightFilter(v): void
  • Parameters

    • v: string

    Returns void

  • get initialHighlightFilterExpressions(): IgrFilterExpressionCollection
  • Gets the initial highlight filters that are applied to the chart.

    Returns IgrFilterExpressionCollection

  • get initialSorts(): string
  • Gets or sets the sorts to apply to the chart. This property will become ignored if sorts are changed outside of this property.

    Returns string

  • set initialSorts(v): void
  • Parameters

    • v: string

    Returns void

  • get initialSummaries(): string
  • Gets or sets the summaries to apply to the chart. This property will become ignored if sorts are changed outside of this property.

    Returns string

  • set initialSummaries(v): void
  • Parameters

    • v: string

    Returns void

  • get isVisTypeRadial(): boolean
  • Returns boolean

  • get isVisTypeStacked(): boolean
  • Returns boolean

  • get nativeElement(): HTMLElement
  • Returns HTMLElement

  • get outlines(): string[]
  • 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

    Returns string[]

  • set outlines(v): void
  • Parameters

    • v: string[]

    Returns void

  • get selectedSeriesItems(): IgrChartSelectedItemCollection
  • Gets the currently selected data items. Adding or removing data items from this collection will select or deselect the visuals associated with those items.

    Returns IgrChartSelectedItemCollection

  • set selectedSeriesItems(v): void
  • Parameters

    • v: IgrChartSelectedItemCollection

    Returns void

  • get shouldAvoidAxisAnnotationCollisions(): boolean
  • Gets or sets whether annotations for the final value of each series is displayed on the axis.

    Returns boolean

  • set shouldAvoidAxisAnnotationCollisions(v): void
  • Parameters

    • v: boolean

    Returns void

  • get shouldDisplayMockData(): boolean
  • 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.

    Returns boolean

  • set shouldDisplayMockData(v): void
  • Parameters

    • v: boolean

    Returns void

  • get shouldUseSkeletonStyleForMockData(): boolean
  • Gets or sets whether the dashboard tile should use a faded skeleton style for mock data.

    Returns boolean

  • set shouldUseSkeletonStyleForMockData(v): void
  • Parameters

    • v: boolean

    Returns void

  • get tileTitle(): string
  • Gets or sets text to display above the plot area.

    Returns string

  • set tileTitle(v): void
  • Parameters

    • v: string

    Returns void

  • get trendLineBrushes(): string[]
  • 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

    Returns string[]

  • set trendLineBrushes(v): void
  • Parameters

    • v: string[]

    Returns void

  • get trendLineType(): 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

    Returns TrendLineType

  • set trendLineType(v): void
  • Parameters

    • v: TrendLineType

    Returns void

  • get trendLineTypes(): IgrTrendLineTypeCollection
  • Gets or sets what trendlines to use in the chart.

    Returns IgrTrendLineTypeCollection

  • set trendLineTypes(v): void
  • Parameters

    • v: IgrTrendLineTypeCollection

    Returns void

  • get validVisualizationTypePriorityThreshold(): number
  • Gets or sets the crosshairs to be displayed.

    Returns number

  • set validVisualizationTypePriorityThreshold(v): void
  • Parameters

    • v: number

    Returns void

  • get valueLines(): IgrValueModeCollection
  • Gets or sets what value lines to use in the chart.

    Returns IgrValueModeCollection

  • set valueLines(v): void
  • Parameters

    • v: IgrValueModeCollection

    Returns void

  • get valueLinesBrushes(): string[]
  • 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

    Returns string[]

  • set valueLinesBrushes(v): void
  • Parameters

    • v: string[]

    Returns void

  • get valueLinesGlobalAverageBrush(): string
  • Gets or sets the color for GlobalAverage value lines.

    Returns string

  • set valueLinesGlobalAverageBrush(v): void
  • Parameters

    • v: string

    Returns void

  • get valueLinesGlobalMaximumBrush(): string
  • Gets or sets the color for GlobalMaximum value lines.

    Returns string

  • set valueLinesGlobalMaximumBrush(v): void
  • Parameters

    • v: string

    Returns void

  • get valueLinesGlobalMinimumBrush(): string
  • Gets or sets the color for GlobalMinimum value lines.

    Returns string

  • set valueLinesGlobalMinimumBrush(v): void
  • Parameters

    • v: string

    Returns void

  • get width(): string
  • Returns string

  • set width(value): void
  • Parameters

    • value: string

    Returns void

Methods

  • Parameters

    • listener: ICommandAvailabilityListener

    Returns void

  • Parameters

    • listener: ICommandStateChangedListener

    Returns void

  • Returns void

  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

  • Returns void

  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    Returns void

  • Returns void

  • Returns void

  • Parameters

    • name: string

    Returns any

  • Parameters

    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Returns ToolActionInfo[]

  • Parameters

    • key: string

    Returns any

  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns any

  • Returns boolean

  • Returns void

  • Returns void

  • Parameters

    • listener: ICommandAvailabilityListener

    Returns void

  • Parameters

    • listener: ICommandStateChangedListener

    Returns void

  • Parameters

    • key: string

    Returns void

  • Returns DetailedReactHTMLElement<{
        children: any[];
        className: string;
        ref: ((ref) => void);
    }, any>

  • Resets the zoom level to default.

    Returns void

  • Type parameters

    Type Parameters

    • K extends never

    Parameters

    • state: {} | ((prevState, props) => {} | Pick<{}, K>) | Pick<{}, K>
    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean

  • Parameters

    • key: string
    • value: any

    Returns void

  • Returns void

  • Parameters

    • percentage: number

    Returns void

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

    Parameters

    • percentage: number

    Returns void

  • Parameters

    • internal: any

    Returns IgrDashboardTile