IgrDataToolTipLayer

Represents an annotation layer that displays grouped tooltips with summaries for series.

Constructors

new IgrDataToolTipLayer(props: IIgrDataToolTipLayerProps): IgrDataToolTipLayer

Returns IgrDataToolTipLayer

Accessors

actualAppearanceMode

Inherited from: IgrAnnotationLayer

Gets or sets the mode used for shifting the annotation layer color based on the target series.

get actualAppearanceMode(): AnnotationAppearanceMode

Returns AnnotationAppearanceMode

set actualAppearanceMode(v: AnnotationAppearanceMode): void

Parameters

v: AnnotationAppearanceMode

Returns void

actualAreaFillOpacity

Inherited from: IgrAnnotationLayer

Gets the actual opacity applied to the area fill visual.

get actualAreaFillOpacity(): number

Returns number

set actualAreaFillOpacity(v: number): void

Parameters

v: number

Returns void

actualBrush

Inherited from: IgrAnnotationLayer

Gets the effective brush for the current series object.

get actualBrush(): string

Returns string

set actualBrush(v: string): void

Parameters

v: string

Returns void

actualCloseLabel

Inherited from: IgrAnnotationLayer

Gets the text that is displayed for the Close label in the tooltip.

get actualCloseLabel(): string

Returns string

actualDashArray

Inherited from: IgrAnnotationLayer

Gets or sets the mode used for shifting the annotation layer color based on the target series.

get actualDashArray(): number[]

Returns number[]

set actualDashArray(v: number[]): void

Parameters

v: number[]

Returns void

actualDashCap

Inherited from: IgrAnnotationLayer

Gets or sets the mode used for shifting the annotation layer color based on the target series.

get actualDashCap(): PenLineCap

Returns PenLineCap

set actualDashCap(v: PenLineCap): void

Parameters

v: PenLineCap

Returns void

actualFocusBrush

Inherited from: IgrAnnotationLayer

Gets the effective emphasis brush for the current series object.

get actualFocusBrush(): string

Returns string

set actualFocusBrush(v: string): void

Parameters

v: string

Returns void

actualFocusMode

Inherited from: IgrAnnotationLayer

Gets actual Selection mode

get actualFocusMode(): SeriesSelectionMode

Returns SeriesSelectionMode

set actualFocusMode(v: SeriesSelectionMode): void

Parameters

v: SeriesSelectionMode

Returns void

actualGroupedPositionModeX

Gets the actual resolved tooltip position mode on the X axis for grouped series.

get actualGroupedPositionModeX(): DataTooltipGroupedPositionX

Returns DataTooltipGroupedPositionX

set actualGroupedPositionModeX(v: DataTooltipGroupedPositionX): void

Parameters

v: DataTooltipGroupedPositionX

Returns void

actualGroupedPositionModeY

Gets the actual resolved tooltip position mode on the Y axis for grouped series.

get actualGroupedPositionModeY(): DataTooltipGroupedPositionY

Returns DataTooltipGroupedPositionY

set actualGroupedPositionModeY(v: DataTooltipGroupedPositionY): void

Parameters

v: DataTooltipGroupedPositionY

Returns void

actualGroupingMode

Gets the actual resolved tooltip layer grouping mode.

get actualGroupingMode(): DataToolTipLayerGroupingMode

Returns DataToolTipLayerGroupingMode

set actualGroupingMode(v: DataToolTipLayerGroupingMode): void

Parameters

v: DataToolTipLayerGroupingMode

Returns void

actualHighLabel

Inherited from: IgrAnnotationLayer

Gets the text that is displayed for the High label in the tooltip.

get actualHighLabel(): string

Returns string

actualHighlightedValuesFadeOpacity

Inherited from: IgrAnnotationLayer

Gets actual HighlightedValues fade opacity

get actualHighlightedValuesFadeOpacity(): number

Returns number

set actualHighlightedValuesFadeOpacity(v: number): void

Parameters

v: number

Returns void

actualHighlightingFadeOpacity

Inherited from: IgrAnnotationLayer

Gets actual highlighting fade opacity

get actualHighlightingFadeOpacity(): number

Returns number

set actualHighlightingFadeOpacity(v: number): void

Parameters

v: number

Returns void

actualHighlightingMode

Inherited from: IgrAnnotationLayer

Gets actual highlighting mode

get actualHighlightingMode(): SeriesHighlightingMode

Returns SeriesHighlightingMode

set actualHighlightingMode(v: SeriesHighlightingMode): void

Parameters

v: SeriesHighlightingMode

Returns void

actualHitTestMode

Inherited from: IgrAnnotationLayer

Resolved method of hit testing to use when pointing to items in the chart.

get actualHitTestMode(): SeriesHitTestMode

Returns SeriesHitTestMode

set actualHitTestMode(v: SeriesHitTestMode): void

Parameters

v: SeriesHitTestMode

Returns void

actualHorizontalAppearanceMode

Inherited from: IgrAnnotationLayer

Gets or sets the mode used for shifting the annotation layer color based on the target series.

get actualHorizontalAppearanceMode(): AnnotationAppearanceMode

Returns AnnotationAppearanceMode

set actualHorizontalAppearanceMode(v: AnnotationAppearanceMode): void

Parameters

v: AnnotationAppearanceMode

Returns void

actualHorizontalDashArray

Inherited from: IgrAnnotationLayer

Gets or sets the mode used for shifting the annotation layer color based on the target series.

get actualHorizontalDashArray(): number[]

Returns number[]

set actualHorizontalDashArray(v: number[]): void

Parameters

v: number[]

Returns void

actualHorizontalShiftAmount

Inherited from: IgrAnnotationLayer

Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0.

get actualHorizontalShiftAmount(): number

Returns number

set actualHorizontalShiftAmount(v: number): void

Parameters

v: number

Returns void

actualLayers

Inherited from: IgrAnnotationLayer

Gets the actual extra layers for the series.

get actualLayers(): IgrSeriesLayerCollection

Returns IgrSeriesLayerCollection

set actualLayers(v: IgrSeriesLayerCollection): void

Parameters

v: IgrSeriesLayerCollection

Returns void

actualLegendItemBadgeBrush

Inherited from: IgrAnnotationLayer

Gets the effective legend badge fill for the current series.

get actualLegendItemBadgeBrush(): string

Returns string

set actualLegendItemBadgeBrush(v: string): void

Parameters

v: string

Returns void

actualLegendItemBadgeOutline

Inherited from: IgrAnnotationLayer

Gets the effective legend badge outline for the current series.

get actualLegendItemBadgeOutline(): string

Returns string

set actualLegendItemBadgeOutline(v: string): void

Parameters

v: string

Returns void

actualLegendItemBadgeTemplate

Inherited from: IgrAnnotationLayer

Gets the actual legend item badge template used by the series.

get actualLegendItemBadgeTemplate(): IgDataTemplate

Returns IgDataTemplate

set actualLegendItemBadgeTemplate(v: IgDataTemplate): void

Parameters

v: IgDataTemplate

Returns void

actualLowLabel

Inherited from: IgrAnnotationLayer

Gets the text that is displayed for the Low label in the tooltip.

get actualLowLabel(): string

Returns string

actualMarkerFillOpacity

Inherited from: IgrAnnotationLayer

Gets the actual opacity applied to the fill of the markers.

get actualMarkerFillOpacity(): number

Returns number

set actualMarkerFillOpacity(v: number): void

Parameters

v: number

Returns void

actualOpenLabel

Inherited from: IgrAnnotationLayer

Gets the text that is displayed for the Open label in the tooltip.

get actualOpenLabel(): string

Returns string

actualOutline

Inherited from: IgrAnnotationLayer

Gets the effective outline for the current series object.

get actualOutline(): string

Returns string

set actualOutline(v: string): void

Parameters

v: string

Returns void

actualRadiusLabel

Inherited from: IgrAnnotationLayer

Gets the text that is displayed for the Value label in the tooltip.

get actualRadiusLabel(): string

Returns string

actualResolution

Inherited from: IgrAnnotationLayer

get actualResolution(): number

Returns number

set actualResolution(v: number): void

Parameters

v: number

Returns void

actualSelectionBrush

Inherited from: IgrAnnotationLayer

Gets the effective emphasis brush for the current series object.

get actualSelectionBrush(): string

Returns string

set actualSelectionBrush(v: string): void

Parameters

v: string

Returns void

actualSelectionMode

Inherited from: IgrAnnotationLayer

Gets actual Selection mode

get actualSelectionMode(): SeriesSelectionMode

Returns SeriesSelectionMode

set actualSelectionMode(v: SeriesSelectionMode): void

Parameters

v: SeriesSelectionMode

Returns void

actualShiftAmount

Inherited from: IgrAnnotationLayer

Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0.

get actualShiftAmount(): number

Returns number

set actualShiftAmount(v: number): void

Parameters

v: number

Returns void

actualThickness

Inherited from: IgrAnnotationLayer

Gets the effective Thickness for the current series object.

get actualThickness(): number

Returns number

set actualThickness(v: number): void

Parameters

v: number

Returns void

actualValueLabel

Inherited from: IgrAnnotationLayer

Gets the text that is displayed for the Value label in the tooltip.

get actualValueLabel(): string

Returns string

actualVerticalAppearanceMode

Inherited from: IgrAnnotationLayer

Gets or sets the mode used for shifting the annotation layer color based on the target series.

get actualVerticalAppearanceMode(): AnnotationAppearanceMode

Returns AnnotationAppearanceMode

set actualVerticalAppearanceMode(v: AnnotationAppearanceMode): void

Parameters

v: AnnotationAppearanceMode

Returns void

actualVerticalDashArray

Inherited from: IgrAnnotationLayer

Gets or sets the mode used for shifting the annotation layer color based on the target series.

get actualVerticalDashArray(): number[]

Returns number[]

set actualVerticalDashArray(v: number[]): void

Parameters

v: number[]

Returns void

actualVerticalShiftAmount

Inherited from: IgrAnnotationLayer

Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0.

get actualVerticalShiftAmount(): number

Returns number

set actualVerticalShiftAmount(v: number): void

Parameters

v: number

Returns void

actualVolumeLabel

Inherited from: IgrAnnotationLayer

Gets the text that is displayed for the Volume label in the tooltip.

get actualVolumeLabel(): string

Returns string

appearanceMode

Inherited from: IgrAnnotationLayer

Gets or sets the mode used for shifting the annotation layer color based on the target series.

get appearanceMode(): AnnotationAppearanceMode

Returns AnnotationAppearanceMode

set appearanceMode(v: AnnotationAppearanceMode): void

Parameters

v: AnnotationAppearanceMode

Returns void

areaFillOpacity

Inherited from: IgrAnnotationLayer

Gets or sets the opacity applied to the area fill visual. This property only applies to series that have area visual.

get areaFillOpacity(): number

Returns number

set areaFillOpacity(v: number): void

Parameters

v: number

Returns void

attachTooltipToRoot

Inherited from: IgrAnnotationLayer

Gets or sets whether the tooltip will be attached to the root, when set to false it will be a child of the chart.

get attachTooltipToRoot(): boolean

Returns boolean

set attachTooltipToRoot(v: boolean): void

Parameters

v: boolean

Returns void

autoCalloutLabelFormat

Inherited from: IgrAnnotationLayer

Gets or sets the AutoCalloutLabel format string to use for the AutoCalloutLabel.

get autoCalloutLabelFormat(): string

Returns string

set autoCalloutLabelFormat(v: string): void

Parameters

v: string

Returns void

autoCalloutLabelFormatSpecifiers

Inherited from: IgrAnnotationLayer

Gets or sets the format specifiers to use with the AutoCalloutLabelFormat string.

get autoCalloutLabelFormatSpecifiers(): any[]

Returns any[]

set autoCalloutLabelFormatSpecifiers(v: any[]): void

Parameters

v: any[]

Returns void

autoCalloutValueLabelFormat

Inherited from: IgrAnnotationLayer

Gets or sets the AutoCalloutLabel format string to use for the AutoCalloutLabel.

get autoCalloutValueLabelFormat(): string

Returns string

set autoCalloutValueLabelFormat(v: string): void

Parameters

v: string

Returns void

autoCalloutValueLabelFormatSpecifiers

Inherited from: IgrAnnotationLayer

Gets or sets the format specifiers to use with the AutoCalloutValueLabelFormat string.

get autoCalloutValueLabelFormatSpecifiers(): any[]

Returns any[]

set autoCalloutValueLabelFormatSpecifiers(v: any[]): void

Parameters

v: any[]

Returns void

badgeMarginBottom

get badgeMarginBottom(): number

Returns number

set badgeMarginBottom(v: number): void

Parameters

v: number

Returns void

badgeMarginLeft

get badgeMarginLeft(): number

Returns number

set badgeMarginLeft(v: number): void

Parameters

v: number

Returns void

badgeMarginRight

get badgeMarginRight(): number

Returns number

set badgeMarginRight(v: number): void

Parameters

v: number

Returns void

badgeMarginTop

get badgeMarginTop(): number

Returns number

set badgeMarginTop(v: number): void

Parameters

v: number

Returns void

badgeShape

Gets or sets the BadgeShape for the data legend.

get badgeShape(): LegendItemBadgeShape

Returns LegendItemBadgeShape

set badgeShape(v: LegendItemBadgeShape): void

Parameters

v: LegendItemBadgeShape

Returns void

brush

Inherited from: IgrAnnotationLayer

Gets or sets the brush to use for the series.

The Brush along with the Outline and Negative Brush can be used to affect the visuals of the Series.

get brush(): string

Returns string

set brush(v: string): void

Parameters

v: string

Returns void

coercionMethods

Inherited from: IgrAnnotationLayer

Gets or sets the coercion methods to use when loading data from data sources. Should be specified before setting any member paths, if being used. Setting it later will not cause data to be reimported into the chart.

<-- position: content member-->

get coercionMethods(): any

Returns any

set coercionMethods(v: any): void

Parameters

v: any

Returns void

cursorPosition

Inherited from: IgrAnnotationLayer

Gets or sets the world position to use instead of the pointer position for this annotation layer. If you set this value, rather than responding to the pointer, this layer will be fixed on the provided world position. A world position has x and y values that range from 0 to 1 that represent the global position of the cursor relative to the entire ranges of the axes. The default of (NaN, NaN) means that the layer should react to pointer movement.

get cursorPosition(): IgPoint

Returns IgPoint

set cursorPosition(v: IgPoint): void

Parameters

v: IgPoint

Returns void

cursorPositionUpdatesOnMove

Inherited from: IgrAnnotationLayer

Gets or sets whether the annotation layer updates on moving cursor position

get cursorPositionUpdatesOnMove(): boolean

Returns boolean

set cursorPositionUpdatesOnMove(v: boolean): void

Parameters

v: boolean

Returns void

dashArray

Inherited from: IgrAnnotationLayer

Gets or sets a collection of Double values that indicate the pattern of dashes and gaps that is used to outline the current series object.

get dashArray(): number[]

Returns number[]

set dashArray(v: number[]): void

Parameters

v: number[]

Returns void

dataLegendGroup

Inherited from: IgrAnnotationLayer

Gets or sets a name used for grouping multiple series in the Data Legend If not set, series will be grouped by series family, e.g. Category, Range, Financial, Scatter

get dataLegendGroup(): string

Returns string

set dataLegendGroup(v: string): void

Parameters

v: string

Returns void

dataLegendKey

Inherited from: IgrAnnotationLayer

Gets unique key used to identify the series in data legend

get dataLegendKey(): string

Returns string

dataSource

Inherited from: IgrAnnotationLayer

get dataSource(): any

Returns any

set dataSource(value: any): void

Parameters

value: any

Returns void

defaultPositionOffsetX

Gets or sets the default offset of the tooltip layer on the X axis.

get defaultPositionOffsetX(): number

Returns number

set defaultPositionOffsetX(v: number): void

Parameters

v: number

Returns void

defaultPositionOffsetY

Gets or sets the default offset of the tooltip layer on the Y axis.

get defaultPositionOffsetY(): number

Returns number

set defaultPositionOffsetY(v: number): void

Parameters

v: number

Returns void

discreteLegendItemTemplate

Inherited from: IgrAnnotationLayer

Gets or sets the DiscreteLegendItemTemplate property. The legend item control content is created according to the DiscreteLegendItemTemplate on-demand by the series object itself.

get discreteLegendItemTemplate(): IgDataTemplate

Returns IgDataTemplate

set discreteLegendItemTemplate(v: IgDataTemplate): void

Parameters

v: IgDataTemplate

Returns void

excludedColumns

Gets or sets names of data columns or their labels to exclude from displaying in the data tooltip, e.g. "High, Low" or "H, L" The ExcludedColumns property takes precedence over values of IncludedColumns property

get excludedColumns(): string[]

Returns string[]

set excludedColumns(v: string[]): void

Parameters

v: string[]

Returns void

excludedSeries

Gets or sets indexes, titles, or names of series to exclude from displaying in the data legend, e.g. "0, 1" or "Series1 Title, Series2 Title" The ExcludedSeries property takes precedence over values of IncludedSeries property

get excludedSeries(): string[]

Returns string[]

set excludedSeries(v: string[]): void

Parameters

v: string[]

Returns void

expectFunctions

Inherited from: IgrAnnotationLayer

Gets or sets whether the series should expect that properties in its items source may be functions that need to be evaluated to yield their value. This defaults to false, as there will be a subtle performance impact to using this feature. This value must be set before assigning an item's source to take effect.

expectFunctions is used to decide whether the series should expect that its data source members need to be called as functions to get their values.

get expectFunctions(): boolean

Returns boolean

set expectFunctions(v: boolean): void

Parameters

v: boolean

Returns void

finalValue

Inherited from: IgrAnnotationLayer

The final value of this series.

get finalValue(): number

Returns number

set finalValue(v: number): void

Parameters

v: number

Returns void

focusBrush

Inherited from: IgrAnnotationLayer

Gets or sets the Focus brush to use for the series.

get focusBrush(): string

Returns string

set focusBrush(v: string): void

Parameters

v: string

Returns void

groupedPositionModeX

Gets or sets the tooltip position mode on the X axis for grouped series.

get groupedPositionModeX(): DataTooltipGroupedPositionX

Returns DataTooltipGroupedPositionX

set groupedPositionModeX(v: DataTooltipGroupedPositionX): void

Parameters

v: DataTooltipGroupedPositionX

Returns void

groupedPositionModeY

Gets or sets the tooltip position mode on the Y axis for grouped series.

get groupedPositionModeY(): DataTooltipGroupedPositionY

Returns DataTooltipGroupedPositionY

set groupedPositionModeY(v: DataTooltipGroupedPositionY): void

Parameters

v: DataTooltipGroupedPositionY

Returns void

groupingMode

Gets or sets the grouping mode to apply to use for the tooltip layer.

get groupingMode(): DataToolTipLayerGroupingMode

Returns DataToolTipLayerGroupingMode

set groupingMode(v: DataToolTipLayerGroupingMode): void

Parameters

v: DataToolTipLayerGroupingMode

Returns void

groupRowMarginBottom

get groupRowMarginBottom(): number

Returns number

set groupRowMarginBottom(v: number): void

Parameters

v: number

Returns void

groupRowMarginLeft

get groupRowMarginLeft(): number

Returns number

set groupRowMarginLeft(v: number): void

Parameters

v: number

Returns void

groupRowMarginRight

get groupRowMarginRight(): number

Returns number

set groupRowMarginRight(v: number): void

Parameters

v: number

Returns void

groupRowMarginTop

get groupRowMarginTop(): number

Returns number

set groupRowMarginTop(v: number): void

Parameters

v: number

Returns void

groupRowVisible

Gets or sets whether to show Header row.

get groupRowVisible(): boolean

Returns boolean

set groupRowVisible(v: boolean): void

Parameters

v: boolean

Returns void

groupTextColor

Gets or sets the Group text color.

get groupTextColor(): string

Returns string

set groupTextColor(v: string): void

Parameters

v: string

Returns void

groupTextMarginBottom

get groupTextMarginBottom(): number

Returns number

set groupTextMarginBottom(v: number): void

Parameters

v: number

Returns void

groupTextMarginLeft

get groupTextMarginLeft(): number

Returns number

set groupTextMarginLeft(v: number): void

Parameters

v: number

Returns void

groupTextMarginRight

get groupTextMarginRight(): number

Returns number

set groupTextMarginRight(v: number): void

Parameters

v: number

Returns void

groupTextMarginTop

get groupTextMarginTop(): number

Returns number

set groupTextMarginTop(v: number): void

Parameters

v: number

Returns void

groupTextStyle

Gets or Sets the style to use for the Group text.

get groupTextStyle(): string

Returns string

set groupTextStyle(v: string): void

Parameters

v: string

Returns void

hasMarkers

Inherited from: IgrAnnotationLayer

Returns whether the current series supports visual markers.

get hasMarkers(): boolean

Returns boolean

hasOnlyMarkers

Inherited from: IgrAnnotationLayer

Gets whether the series has only marker as visuals

get hasOnlyMarkers(): boolean

Returns boolean

hasValueAxis

Inherited from: IgrAnnotationLayer

Gets whether the current series shows an area shape.

get hasValueAxis(): boolean

Returns boolean

hasVisibleMarkers

Inherited from: IgrAnnotationLayer

Returns whether the current series has a visible marker style.

get hasVisibleMarkers(): boolean

Returns boolean

headerFormatCulture

Gets or sets globalization culture when displaying header as date time This property is ignored when setting HeaderFormatSpecifiers or HeaderFormatString properties

get headerFormatCulture(): string

Returns string

set headerFormatCulture(v: string): void

Parameters

v: string

Returns void

headerFormatDate

Gets or sets date format for the header This property is ignored when setting HeaderFormatSpecifiers or HeaderFormatString properties

get headerFormatDate(): DataLegendHeaderDateMode

Returns DataLegendHeaderDateMode

set headerFormatDate(v: DataLegendHeaderDateMode): void

Parameters

v: DataLegendHeaderDateMode

Returns void

headerFormatSpecifiers

Gets or sets the format specifiers to use with the HeaderFormatString string.

get headerFormatSpecifiers(): any[]

Returns any[]

set headerFormatSpecifiers(v: any[]): void

Parameters

v: any[]

Returns void

headerFormatString

Gets or sets the format string for header text displayed in the data legend.

get headerFormatString(): string

Returns string

set headerFormatString(v: string): void

Parameters

v: string

Returns void

headerFormatTime

Gets or sets time format for the header This property is ignored when setting HeaderFormatSpecifiers or HeaderFormatString properties

get headerFormatTime(): DataLegendHeaderTimeMode

Returns DataLegendHeaderTimeMode

set headerFormatTime(v: DataLegendHeaderTimeMode): void

Parameters

v: DataLegendHeaderTimeMode

Returns void

headerRowMarginBottom

get headerRowMarginBottom(): number

Returns number

set headerRowMarginBottom(v: number): void

Parameters

v: number

Returns void

headerRowMarginLeft

get headerRowMarginLeft(): number

Returns number

set headerRowMarginLeft(v: number): void

Parameters

v: number

Returns void

headerRowMarginRight

get headerRowMarginRight(): number

Returns number

set headerRowMarginRight(v: number): void

Parameters

v: number

Returns void

headerRowMarginTop

get headerRowMarginTop(): number

Returns number

set headerRowMarginTop(v: number): void

Parameters

v: number

Returns void

headerRowVisible

Gets or sets whether to show Header row.

get headerRowVisible(): boolean

Returns boolean

set headerRowVisible(v: boolean): void

Parameters

v: boolean

Returns void

headerText

Gets or sets the HeaderText for the data legend.

get headerText(): string

Returns string

set headerText(v: string): void

Parameters

v: string

Returns void

headerTextColor

Gets or sets the header text color.

get headerTextColor(): string

Returns string

set headerTextColor(v: string): void

Parameters

v: string

Returns void

headerTextMarginBottom

get headerTextMarginBottom(): number

Returns number

set headerTextMarginBottom(v: number): void

Parameters

v: number

Returns void

headerTextMarginLeft

get headerTextMarginLeft(): number

Returns number

set headerTextMarginLeft(v: number): void

Parameters

v: number

Returns void

headerTextMarginRight

get headerTextMarginRight(): number

Returns number

set headerTextMarginRight(v: number): void

Parameters

v: number

Returns void

headerTextMarginTop

get headerTextMarginTop(): number

Returns number

set headerTextMarginTop(v: number): void

Parameters

v: number

Returns void

headerTextStyle

Gets or Sets the style to use for the header text.

get headerTextStyle(): string

Returns string

set headerTextStyle(v: string): void

Parameters

v: string

Returns void

highlightedDataSource

Inherited from: IgrAnnotationLayer

get highlightedDataSource(): any

Returns any

set highlightedDataSource(value: any): void

Parameters

value: any

Returns void

highlightedLegendItemVisibility

Inherited from: IgrAnnotationLayer

Gets or sets whether the highlighted values layer should have a legend item.

get highlightedLegendItemVisibility(): Visibility

Returns Visibility

set highlightedLegendItemVisibility(v: Visibility): void

Parameters

v: Visibility

Returns void

highlightedTitleSuffix

Inherited from: IgrAnnotationLayer

Gets or sets the HighlightedTitleSuffix property.

get highlightedTitleSuffix(): string

Returns string

set highlightedTitleSuffix(v: string): void

Parameters

v: string

Returns void

highlightedValuesDataLegendGroup

Inherited from: IgrAnnotationLayer

Gets or sets a name used for grouping highlighted series in the Data Legend If not set, series will default to parent series' DataLegendGroup, e.g. Category, Range, Financial, Scatter

get highlightedValuesDataLegendGroup(): string

Returns string

set highlightedValuesDataLegendGroup(v: string): void

Parameters

v: string

Returns void

highlightedValuesDisplayMode

Inherited from: IgrAnnotationLayer

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.

get highlightedValuesDisplayMode(): SeriesHighlightedValuesDisplayMode

Returns SeriesHighlightedValuesDisplayMode

set highlightedValuesDisplayMode(v: SeriesHighlightedValuesDisplayMode): void

Parameters

v: SeriesHighlightedValuesDisplayMode

Returns void

highlightedValuesExtraPropertyOverlays

Inherited from: IgrAnnotationLayer

Gets the current extra layers for the series.

get highlightedValuesExtraPropertyOverlays(): IgrSeriesLayerPropertyOverlayCollection

Returns IgrSeriesLayerPropertyOverlayCollection

set highlightedValuesExtraPropertyOverlays(v: IgrSeriesLayerPropertyOverlayCollection): void

Parameters

v: IgrSeriesLayerPropertyOverlayCollection

Returns void

highlightedValuesFadeOpacity

Inherited from: IgrAnnotationLayer

Gets or sets the target opacity to fade to for fade style HighlightedValues.

get highlightedValuesFadeOpacity(): number

Returns number

set highlightedValuesFadeOpacity(v: number): void

Parameters

v: number

Returns void

highlightingFadeOpacity

Inherited from: IgrAnnotationLayer

Gets or sets the target opacity to fade to for fade style highlighting.

get highlightingFadeOpacity(): number

Returns number

set highlightingFadeOpacity(v: number): void

Parameters

v: number

Returns void

hitTestMode

Inherited from: IgrAnnotationLayer

Method of hit testing to use when pointing to items in this series.

The HitTestMode can be set to either:

Auto: automatically decide the appropriate hit test mode for the series.
ColorEncoded: use a color encoded off screen buffer for hit testing. Should always be O(1) time for determining a hit series. This increases frame render time and memory usage, however. Consider using this if hit testing time is degrading performance.
Computational: use a computational based approach to determine whether the series has been hit. This uses loose bounding boxes, in some cases, and can range in time complexity between O(1) and O(log n) to find a hit. This decreases frame render time compared to color encoded

get hitTestMode(): SeriesHitTestMode

Returns SeriesHitTestMode

set hitTestMode(v: SeriesHitTestMode): void

Parameters

v: SeriesHitTestMode

Returns void

horizontalAppearanceMode

Inherited from: IgrAnnotationLayer

Gets or sets the mode used for shifting the annotation layer color based on the target series.

get horizontalAppearanceMode(): AnnotationAppearanceMode

Returns AnnotationAppearanceMode

set horizontalAppearanceMode(v: AnnotationAppearanceMode): void

Parameters

v: AnnotationAppearanceMode

Returns void

horizontalDashArray

Inherited from: IgrAnnotationLayer

Gets or sets the mode used for shifting the annotation layer color based on the target series.

get horizontalDashArray(): number[]

Returns number[]

set horizontalDashArray(v: number[]): void

Parameters

v: number[]

Returns void

horizontalShiftAmount

Inherited from: IgrAnnotationLayer

Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0.

get horizontalShiftAmount(): number

Returns number

set horizontalShiftAmount(v: number): void

Parameters

v: number

Returns void

includedColumns

Gets or sets names of data columns or their labels to include in displaying in the data tooltip, e.g. "High, Low" or "H, L" The ExcludedColumns property takes precedence over values of IncludedColumns property

get includedColumns(): string[]

Returns string[]

set includedColumns(v: string[]): void

Parameters

v: string[]

Returns void

includedSeries

Gets or sets indexes, titles, or names of series to include in displaying in the data legend, e.g. "0, 1" or "Series1 Title, Series2 Title" The ExcludedSeries property takes precedence over values of IncludedSeries property

get includedSeries(): string[]

Returns string[]

set includedSeries(v: string[]): void

Parameters

v: string[]

Returns void

index

Inherited from: IgrAnnotationLayer

Gets the Index property.

get index(): number

Returns number

set index(v: number): void

Parameters

v: number

Returns void

isActualLegendFinancial

Inherited from: IgrAnnotationLayer

Gets or sets whether the ActualLegend is FinancialLegend or normal Legend.

get isActualLegendFinancial(): boolean

Returns boolean

set isActualLegendFinancial(v: boolean): void

Parameters

v: boolean

Returns void

isAnnotationCalloutLayer

Inherited from: IgrAnnotationLayer

Gets whether the series is an callout annotation layer.

get isAnnotationCalloutLayer(): boolean

Returns boolean

isAnnotationCrosshairLayer

Inherited from: IgrAnnotationLayer

Gets whether the series is an crosshair annotation layer.

get isAnnotationCrosshairLayer(): boolean

Returns boolean

isAnnotationDataLayer

Inherited from: IgrAnnotationLayer

Gets whether the series is a data annotation layer that support binding to data source DataAnnotationShapeLayer, DataAnnotationSliceLayer, DataAnnotationStripLayer

get isAnnotationDataLayer(): boolean

Returns boolean

isAnnotationFinalValue

Inherited from: IgrAnnotationLayer

Gets whether the series is final value annotation layer.

get isAnnotationFinalValue(): boolean

Returns boolean

isAnnotationHoverLayer

Gets whether the series is an annotation layer displayed only when hovering over the chart.

get isAnnotationHoverLayer(): boolean

Returns boolean

isAnnotationLayer

Inherited from: IgrAnnotationLayer

Gets whether this series is an annotation layer.

get isAnnotationLayer(): boolean

Returns boolean

isAnnotationValueLayer

Inherited from: IgrAnnotationLayer

Gets whether the series is a value annotation layer.

get isAnnotationValueLayer(): boolean

Returns boolean

isArea

Inherited from: IgrAnnotationLayer

Gets whether the current series shows an area shape.

get isArea(): boolean

Returns boolean

isAreaOrLine

Inherited from: IgrAnnotationLayer

Gets whether the current series shows an area or line shape.

get isAreaOrLine(): boolean

Returns boolean

isBar

Inherited from: IgrAnnotationLayer

Gets whether the current series shows a horizontal column shape.

get isBar(): boolean

Returns boolean

isCategory

Inherited from: IgrAnnotationLayer

Gets whether the current series is a category type series.

get isCategory(): boolean

Returns boolean

isColoredItemwise

Inherited from: IgrAnnotationLayer

get isColoredItemwise(): boolean

Returns boolean

isColumn

Inherited from: IgrAnnotationLayer

Gets whether the current series shows a column shape.

get isColumn(): boolean

Returns boolean

isComponentHighlightingModeIgnored

Inherited from: IgrAnnotationLayer

Gets or sets whether the component level highlight mode is ignored.

get isComponentHighlightingModeIgnored(): boolean

Returns boolean

set isComponentHighlightingModeIgnored(v: boolean): void

Parameters

v: boolean

Returns void

isDefaultCrosshairBehaviorDisabled

Inherited from: IgrAnnotationLayer

Gets whether or not the default crosshair behavior is disabled.

get isDefaultCrosshairBehaviorDisabled(): boolean

Returns boolean

isDefaultCrosshairDisabled

Inherited from: IgrAnnotationLayer

Gets or sets whether the series viewer's default crosshair should be disabled by the presence of this layer.

get isDefaultCrosshairDisabled(): boolean

Returns boolean

set isDefaultCrosshairDisabled(v: boolean): void

Parameters

v: boolean

Returns void

isDefaultTooltipBehaviorDisabled

Gets whether the default tooltip behaviors for the chart are disabled if this layer is present.

get isDefaultTooltipBehaviorDisabled(): boolean

Returns boolean

isDefaultToolTipSelected

Inherited from: IgrAnnotationLayer

Gets if the default tooltip has been selected for display.

To use the default tooltip set ShowDefaultTooltip to true.

get isDefaultToolTipSelected(): boolean

Returns boolean

set isDefaultToolTipSelected(v: boolean): void

Parameters

v: boolean

Returns void

isDropShadowEnabled

Inherited from: IgrAnnotationLayer

Gets or sets whether drop shadow should be enabled for this series.

IsDropShadowEnabled is used to decide whether drop shadow should be enabled for this series.

get isDropShadowEnabled(): boolean

Returns boolean

set isDropShadowEnabled(v: boolean): void

Parameters

v: boolean

Returns void

isFinancial

Inherited from: IgrAnnotationLayer

Gets whether the current series is a financial type series.

get isFinancial(): boolean

Returns boolean

isFinancialIndicator

Inherited from: IgrAnnotationLayer

Gets whether the series is financial indicator

get isFinancialIndicator(): boolean

Returns boolean

isFinancialOverlay

Inherited from: IgrAnnotationLayer

Gets whether the series is financial overlay

get isFinancialOverlay(): boolean

Returns boolean

isFinancialSeries

Inherited from: IgrAnnotationLayer

Gets whether the series has financial OHLC/candlestick visuals

get isFinancialSeries(): boolean

Returns boolean

isFinancialWaterfall

Inherited from: IgrAnnotationLayer

Gets whether the series is financial waterfall

get isFinancialWaterfall(): boolean

Returns boolean

isFragment

Inherited from: IgrAnnotationLayer

Gets whether the current series is a stack fragment.

get isFragment(): boolean

Returns boolean

isGeographic

Inherited from: IgrAnnotationLayer

Gets whether the current series is a geographic series.

get isGeographic(): boolean

Returns boolean

isHighlightingEnabled

Inherited from: IgrAnnotationLayer

Gets or sets whether highlighting should be enabled for this series, if this type of series supports highlighting.

get isHighlightingEnabled(): boolean

Returns boolean

set isHighlightingEnabled(v: boolean): void

Parameters

v: boolean

Returns void

isHighlightOverlay

Inherited from: IgrAnnotationLayer

Gets whether the series is a highlight overlay.

get isHighlightOverlay(): boolean

Returns boolean

isIndexed

Inherited from: IgrAnnotationLayer

Gets if the series uses an index, which can be used to auto-assign it a color.

get isIndexed(): boolean

Returns boolean

isLayer

Inherited from: IgrAnnotationLayer

get isLayer(): boolean

Returns boolean

isLineContour

Inherited from: IgrAnnotationLayer

Gets whether the current series shows a line contour shape.

get isLineContour(): boolean

Returns boolean

isLineOnly

Inherited from: IgrAnnotationLayer

Gets whether the current series shows only line shapes.

get isLineOnly(): boolean

Returns boolean

isMarkerlessDisplayPreferred

Inherited from: IgrAnnotationLayer

Overridden by derived series classes to indicate when markerless display is preferred or not.

get isMarkerlessDisplayPreferred(): boolean

Returns boolean

isNegativeColorSupported

Inherited from: IgrAnnotationLayer

Overridden by derived series classes to indicate when negative colors are supported or not.

get isNegativeColorSupported(): boolean

Returns boolean

isPie

Inherited from: IgrAnnotationLayer

Gets whether the current series shows a pie shape.

get isPie(): boolean

Returns boolean

isPixel

Inherited from: IgrAnnotationLayer

Gets whether the current series shows pixels.

get isPixel(): boolean

Returns boolean

isPolar

Inherited from: IgrAnnotationLayer

Gets whether the current series is a polar type series.

get isPolar(): boolean

Returns boolean

isPolygon

Inherited from: IgrAnnotationLayer

Gets whether the current series shows a polygon shape.

get isPolygon(): boolean

Returns boolean

isPolyline

Inherited from: IgrAnnotationLayer

Gets whether the current series shows a polyline shape.

get isPolyline(): boolean

Returns boolean

isRadial

Inherited from: IgrAnnotationLayer

Gets whether the current series is a radial type series.

get isRadial(): boolean

Returns boolean

isRange

Inherited from: IgrAnnotationLayer

Gets whether the current series is a range type series.

get isRange(): boolean

Returns boolean

isScatter

Inherited from: IgrAnnotationLayer

Gets whether the current series is a scatter type series.

get isScatter(): boolean

Returns boolean

isShape

Inherited from: IgrAnnotationLayer

Gets whether the current series is a shape type series.

get isShape(): boolean

Returns boolean

isShapeControl

Inherited from: IgrAnnotationLayer

Gets whether the current series shows interactive shape controls.

get isShapeControl(): boolean

Returns boolean

isSpline

Inherited from: IgrAnnotationLayer

Gets whether the current series shows a spline shape.

get isSpline(): boolean

Returns boolean

isStacked

Inherited from: IgrAnnotationLayer

Gets whether the current series is a stacked type series.

get isStacked(): boolean

Returns boolean

isStep

Inherited from: IgrAnnotationLayer

Gets whether the current series shows step shapes.

get isStep(): boolean

Returns boolean

isSummarizationSupported

Inherited from: IgrAnnotationLayer

Gets whether the series supports summarization in Data Legend and Data Tooltip.

get isSummarizationSupported(): boolean

Returns boolean

isTile

Inherited from: IgrAnnotationLayer

Gets whether the current series shows a tile imagery.

get isTile(): boolean

Returns boolean

isToolTipLayer

Gets whether the series is an annotation layer.

get isToolTipLayer(): boolean

Returns boolean

isUsableInLegend

Inherited from: IgrAnnotationLayer

Gets if the series should appear in any legends.

get isUsableInLegend(): boolean

Returns boolean

isUserAnnotationLayer

Inherited from: IgrAnnotationLayer

Gets whether the series is final value annotation layer.

get isUserAnnotationLayer(): boolean

Returns boolean

isUserAnnotationToolTipLayer

Inherited from: IgrAnnotationLayer

Gets whether the series is final user annotation tooltip layer.

get isUserAnnotationToolTipLayer(): boolean

Returns boolean

isValueAxisInverted

Inherited from: IgrAnnotationLayer

Gets whether the current series shows an area shape.

get isValueAxisInverted(): boolean

Returns boolean

isValueOverlay

Inherited from: IgrAnnotationLayer

Gets whether the series is a value overlay.

get isValueOverlay(): boolean

Returns boolean

isVertical

Inherited from: IgrAnnotationLayer

Gets whether the current series is oriented vertically.

get isVertical(): boolean

Returns boolean

isWaterfall

Inherited from: IgrAnnotationLayer

Gets whether the current series shows a waterfall column shape.

get isWaterfall(): boolean

Returns boolean

labelDisplayMode

Gets or sets the mode for displaying labels before series values in the data legend, e.g. O: H: L: C: for financial series

get labelDisplayMode(): DataLegendLabelMode

Returns DataLegendLabelMode

set labelDisplayMode(v: DataLegendLabelMode): void

Parameters

v: DataLegendLabelMode

Returns void

labelTextColor

Gets or sets the units text color.

get labelTextColor(): string

Returns string

set labelTextColor(v: string): void

Parameters

v: string

Returns void

labelTextMarginBottom

get labelTextMarginBottom(): number

Returns number

set labelTextMarginBottom(v: number): void

Parameters

v: number

Returns void

labelTextMarginLeft

get labelTextMarginLeft(): number

Returns number

set labelTextMarginLeft(v: number): void

Parameters

v: number

Returns void

labelTextMarginRight

get labelTextMarginRight(): number

Returns number

set labelTextMarginRight(v: number): void

Parameters

v: number

Returns void

labelTextMarginTop

get labelTextMarginTop(): number

Returns number

set labelTextMarginTop(v: number): void

Parameters

v: number

Returns void

labelTextStyle

Gets or Sets the style to use for the units text.

get labelTextStyle(): string

Returns string

set labelTextStyle(v: string): void

Parameters

v: string

Returns void

layers

Inherited from: IgrAnnotationLayer

Gets the current extra layers for the series.

get layers(): IgrSeriesLayerCollection

Returns IgrSeriesLayerCollection

set layers(v: IgrSeriesLayerCollection): void

Parameters

v: IgrSeriesLayerCollection

Returns void

layoutMode

Gets or sets the layout of content in the data legend

get layoutMode(): DataLegendLayoutMode

Returns DataLegendLayoutMode

set layoutMode(v: DataLegendLayoutMode): void

Parameters

v: DataLegendLayoutMode

Returns void

legend

Inherited from: IgrAnnotationLayer

Gets or sets the legend used for the current series.

get legend(): any

Returns any

set legend(v: any): void

Parameters

v: any

Returns void

legendItemBadgeMode

Inherited from: IgrAnnotationLayer

Gets or sets the mode of legend badge representing the current series in a legend. This property will be ignored when the LegendItemTemplate/LegendItemBadgeTemplate property is set on the series

get legendItemBadgeMode(): LegendItemBadgeMode

Returns LegendItemBadgeMode

set legendItemBadgeMode(v: LegendItemBadgeMode): void

Parameters

v: LegendItemBadgeMode

Returns void

legendItemBadgeShape

Inherited from: IgrAnnotationLayer

Gets or sets the type of legend badge representing the current series in a legend. This property will be ignored when the LegendItemTemplate/LegendItemBadgeTemplate property is set on the series

get legendItemBadgeShape(): LegendItemBadgeShape

Returns LegendItemBadgeShape

set legendItemBadgeShape(v: LegendItemBadgeShape): void

Parameters

v: LegendItemBadgeShape

Returns void

legendItemBadgeTemplate

Inherited from: IgrAnnotationLayer

Gets or sets the LegendItemBadgeTemplate property. The legend item badge is created according to the LegendItemBadgeTemplate on-demand by the series object itself.

get legendItemBadgeTemplate(): IgDataTemplate

Returns IgDataTemplate

set legendItemBadgeTemplate(v: IgDataTemplate): void

Parameters

v: IgDataTemplate

Returns void

legendItemTemplate

Inherited from: IgrAnnotationLayer

Gets or sets the LegendItemTemplate property. The legend item control content is created according to the LegendItemTemplate on-demand by the series object itself.

get legendItemTemplate(): IgDataTemplate

Returns IgDataTemplate

set legendItemTemplate(v: IgDataTemplate): void

Parameters

v: IgDataTemplate

Returns void

legendItemVisibility

Inherited from: IgrAnnotationLayer

Gets or sets whether or not the current series will have a legend item displayed in a legend.

The LegendItemVisibilty can be used to exclude only certain Series from the Legend.

get legendItemVisibility(): Visibility

Returns Visibility

set legendItemVisibility(v: Visibility): void

Parameters

v: Visibility

Returns void

lineCap

Inherited from: IgrAnnotationLayer

Gets or sets the style of the starting point of any lines or polylines representing this series. Not every series type has a line at which it would be appropriate to display a start cap, so this property does not affect every series type. LineSeries, for example, is affected by StartCap, but ColumnSeries is not.

get lineCap(): PenLineCap

Returns PenLineCap

set lineCap(v: PenLineCap): void

Parameters

v: PenLineCap

Returns void

lineJoin

Inherited from: IgrAnnotationLayer

Gets or sets the brush that specifies current series object's line join style.

get lineJoin(): PenLineJoin

Returns PenLineJoin

set lineJoin(v: PenLineJoin): void

Parameters

v: PenLineJoin

Returns void

markerFillOpacity

Inherited from: IgrAnnotationLayer

Gets or sets the opacity applied to the fill of the markers. This property only applies to series that have area visual.

get markerFillOpacity(): number

Returns number

set markerFillOpacity(v: number): void

Parameters

v: number

Returns void

mouseOverEnabled

Inherited from: IgrAnnotationLayer

Gets or sets the whether the chart reacts to mouse move events.

get mouseOverEnabled(): boolean

Returns boolean

set mouseOverEnabled(v: boolean): void

Parameters

v: boolean

Returns void

name

Inherited from: IgrAnnotationLayer

get name(): string

Returns string

set name(value: string): void

Parameters

value: string

Returns void

opacity

Inherited from: IgrAnnotationLayer

get opacity(): number

Returns number

set opacity(v: number): void

Parameters

v: number

Returns void

outline

Inherited from: IgrAnnotationLayer

Gets or sets the brush to use for the outline of the series. Some series types, such as LineSeries, do not display outlines. Therefore, this property does not affect some charts.

The Outline along with the Brush and NegativeBrush can be used to affect the visuals of the Series.

get outline(): string

Returns string

set outline(v: string): void

Parameters

v: string

Returns void

outlineMode

Inherited from: IgrAnnotationLayer

Gets or sets the outline mode to use for the series.

get outlineMode(): SeriesOutlineMode

Returns SeriesOutlineMode

set outlineMode(v: SeriesOutlineMode): void

Parameters

v: SeriesOutlineMode

Returns void

percentChange

Inherited from: IgrAnnotationLayer

The percent change from the beginning to the end of this series.

get percentChange(): number

Returns number

set percentChange(v: number): void

Parameters

v: number

Returns void

positionOffsetX

Gets or sets the offset of the tooltip layer on the X axis.

get positionOffsetX(): number

Returns number

set positionOffsetX(v: number): void

Parameters

v: number

Returns void

positionOffsetY

Gets or sets the offset of the tooltip layer on the Y axis.

get positionOffsetY(): number

Returns number

set positionOffsetY(v: number): void

Parameters

v: number

Returns void

renderRequested

Inherited from: IgrAnnotationLayer

This event is raised every time a render has been requested from a series.

get renderRequested(): object

Returns object

set renderRequested(ev: object): void

Parameters

ev: object

Returns void

resolution

Inherited from: IgrAnnotationLayer

Gets or sets the current series object's rendering resolution.

Setting the Resolution on a Series to a higher value can help with performance, but it will lower the graphical fidelity of the line. As such, it can be increased up until the fidelity is unacceptable.

get resolution(): number

Returns number

set resolution(v: number): void

Parameters

v: number

Returns void

safeActualBrush

Inherited from: IgrAnnotationLayer

Gets the effective brush for the current series object with opacity removed so its contrasty for use as a font color.

get safeActualBrush(): string

Returns string

set safeActualBrush(v: string): void

Parameters

v: string

Returns void

selectionBrush

Inherited from: IgrAnnotationLayer

Gets or sets the selection brush to use for the series.

get selectionBrush(): string

Returns string

set selectionBrush(v: string): void

Parameters

v: string

Returns void

selectionThickness

Inherited from: IgrAnnotationLayer

Gets or sets the width of the current series object's line thickness when the series is selected.

get selectionThickness(): number

Returns number

set selectionThickness(v: number): void

Parameters

v: number

Returns void

seriesInternal

Inherited from: IgrAnnotationLayer

get seriesInternal(): any

Returns any

shadowBlur

Inherited from: IgrAnnotationLayer

Gets or sets the shadow blur. This property is ignored when Series.UseSingleShadow is set to true.

ShadowBlur can be set in conjection with IsDropShadowEnabled to further define the drop shadow effect.

get shadowBlur(): number

Returns number

set shadowBlur(v: number): void

Parameters

v: number

Returns void

shadowColor

Inherited from: IgrAnnotationLayer

Gets or sets the drop shadow color.

ShadowColor can be set in conjection with IsDropShadowEnabled to further define the drop shadow effect.

get shadowColor(): string

Returns string

set shadowColor(v: string): void

Parameters

v: string

Returns void

shadowOffsetX

Inherited from: IgrAnnotationLayer

Gets or sets the drop shadow x-offset.

ShadowOffsetX can be set in conjection with IsDropShadowEnabled to further define the drop shadow effect.

get shadowOffsetX(): number

Returns number

set shadowOffsetX(v: number): void

Parameters

v: number

Returns void

shadowOffsetY

Inherited from: IgrAnnotationLayer

Gets or sets the drop shadow y-offset.

ShadowOffsetY can be set in conjection with IsDropShadowEnabled to further define the drop shadow effect.

get shadowOffsetY(): number

Returns number

set shadowOffsetY(v: number): void

Parameters

v: number

Returns void

shiftAmount

Inherited from: IgrAnnotationLayer

Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0.

get shiftAmount(): number

Returns number

set shiftAmount(v: number): void

Parameters

v: number

Returns void

shouldAnimateOnDataSourceSwap

Inherited from: IgrAnnotationLayer

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.

get shouldAnimateOnDataSourceSwap(): boolean

Returns boolean

set shouldAnimateOnDataSourceSwap(v: boolean): void

Parameters

v: boolean

Returns void

shouldHideAutoCallouts

Inherited from: IgrAnnotationLayer

Gets or sets whether this series should suppress it's auto callouts

get shouldHideAutoCallouts(): boolean

Returns boolean

set shouldHideAutoCallouts(v: boolean): void

Parameters

v: boolean

Returns void

shouldRemoveHighlightedDataOnLayerHidden

Inherited from: IgrAnnotationLayer

Gets or sets whether the opacity should be automatically shifted for the safe actual brush.

get shouldRemoveHighlightedDataOnLayerHidden(): boolean

Returns boolean

set shouldRemoveHighlightedDataOnLayerHidden(v: boolean): void

Parameters

v: boolean

Returns void

shouldRenderAsOverlay

Inherited from: IgrAnnotationLayer

Gets or sets whether this layer renders as an overlay or not.

get shouldRenderAsOverlay(): boolean

Returns boolean

set shouldRenderAsOverlay(v: boolean): void

Parameters

v: boolean

Returns void

shouldShiftOpacityForSafeActualBrush

Inherited from: IgrAnnotationLayer

Gets or sets whether the opacity should be automatically shifted for the safe actual brush.

get shouldShiftOpacityForSafeActualBrush(): boolean

Returns boolean

set shouldShiftOpacityForSafeActualBrush(v: boolean): void

Parameters

v: boolean

Returns void

shouldUpdateWhenSeriesDataChanges

Gets or sets whether the data legend should update when the series data is mutated.

get shouldUpdateWhenSeriesDataChanges(): boolean

Returns boolean

set shouldUpdateWhenSeriesDataChanges(v: boolean): void

Parameters

v: boolean

Returns void

showDefaultTooltip

Inherited from: IgrAnnotationLayer

Gets or sets whether default tooltip will be shown.

The default tooltips display all the information relevant to the particular series item (series title, data values, axis values etc.) and are styled to match the series' style. When using default tooltips, you should also set the series Title.

get showDefaultTooltip(): boolean

Returns boolean

set showDefaultTooltip(v: boolean): void

Parameters

v: boolean

Returns void

summaryLabelText

Gets or sets the units text for the data legend.

get summaryLabelText(): string

Returns string

set summaryLabelText(v: string): void

Parameters

v: string

Returns void

summaryLabelTextColor

Gets or sets the units text color.

get summaryLabelTextColor(): string

Returns string

set summaryLabelTextColor(v: string): void

Parameters

v: string

Returns void

summaryLabelTextStyle

Gets or Sets the style to use for the units text.

get summaryLabelTextStyle(): string

Returns string

set summaryLabelTextStyle(v: string): void

Parameters

v: string

Returns void

summaryRowMarginBottom

get summaryRowMarginBottom(): number

Returns number

set summaryRowMarginBottom(v: number): void

Parameters

v: number

Returns void

summaryRowMarginLeft

get summaryRowMarginLeft(): number

Returns number

set summaryRowMarginLeft(v: number): void

Parameters

v: number

Returns void

summaryRowMarginRight

get summaryRowMarginRight(): number

Returns number

set summaryRowMarginRight(v: number): void

Parameters

v: number

Returns void

summaryRowMarginTop

get summaryRowMarginTop(): number

Returns number

set summaryRowMarginTop(v: number): void

Parameters

v: number

Returns void

summaryTitleText

Gets or sets the SummaryTitleText for the data legend.

get summaryTitleText(): string

Returns string

set summaryTitleText(v: string): void

Parameters

v: string

Returns void

summaryTitleTextColor

Gets or sets the summary text color.

get summaryTitleTextColor(): string

Returns string

set summaryTitleTextColor(v: string): void

Parameters

v: string

Returns void

summaryTitleTextMarginBottom

get summaryTitleTextMarginBottom(): number

Returns number

set summaryTitleTextMarginBottom(v: number): void

Parameters

v: number

Returns void

summaryTitleTextMarginLeft

get summaryTitleTextMarginLeft(): number

Returns number

set summaryTitleTextMarginLeft(v: number): void

Parameters

v: number

Returns void

summaryTitleTextMarginRight

get summaryTitleTextMarginRight(): number

Returns number

set summaryTitleTextMarginRight(v: number): void

Parameters

v: number

Returns void

summaryTitleTextMarginTop

get summaryTitleTextMarginTop(): number

Returns number

set summaryTitleTextMarginTop(v: number): void

Parameters

v: number

Returns void

summaryTitleTextStyle

Gets or Sets the style to use for the summary text.

get summaryTitleTextStyle(): string

Returns string

set summaryTitleTextStyle(v: string): void

Parameters

v: string

Returns void

summaryType

Gets or sets the SummaryType for the data legend.

get summaryType(): DataLegendSummaryType

Returns DataLegendSummaryType

set summaryType(v: DataLegendSummaryType): void

Parameters

v: DataLegendSummaryType

Returns void

summaryUnitsText

Gets or sets the units text for the data legend.

get summaryUnitsText(): string

Returns string

set summaryUnitsText(v: string): void

Parameters

v: string

Returns void

summaryUnitsTextColor

Gets or sets the units text color.

get summaryUnitsTextColor(): string

Returns string

set summaryUnitsTextColor(v: string): void

Parameters

v: string

Returns void

summaryUnitsTextStyle

Gets or Sets the style to use for the units text.

get summaryUnitsTextStyle(): string

Returns string

set summaryUnitsTextStyle(v: string): void

Parameters

v: string

Returns void

summaryValueTextColor

Gets or sets the units text color.

get summaryValueTextColor(): string

Returns string

set summaryValueTextColor(v: string): void

Parameters

v: string

Returns void

summaryValueTextStyle

Gets or Sets the style to use for the units text.

get summaryValueTextStyle(): string

Returns string

set summaryValueTextStyle(v: string): void

Parameters

v: string

Returns void

targetAxis

Gets or sets the Axis to target this annotation to. If null, this annotation layer will not render content.

get targetAxis(): IgrAxis

Returns IgrAxis

set targetAxis(v: IgrAxis): void

Parameters

v: IgrAxis

Returns void

targetAxisName

Gets or sets the name to use to resolve targetAxis from markup.

get targetAxisName(): string

Returns string

set targetAxisName(v: string): void

Parameters

v: string

Returns void

thickness

Inherited from: IgrAnnotationLayer

Gets or sets the width of the current series object's line thickness.

Depending on the Series type, this can be the main brush used, or just the outline. For example, when using a LineSeries it will affect the thickness of the lines drawn, whereas when using a ColumnSeries it will affect the outer border thickness of the columns.

get thickness(): number

Returns number

set thickness(v: number): void

Parameters

v: number

Returns void

title

Inherited from: IgrAnnotationLayer

Gets or sets the Title property. The legend item control is created according to the Title on-demand by the series object itself.

The Series Title may be used in tooltips and legends.

get title(): any

Returns any

set title(v: any): void

Parameters

v: any

Returns void

titleTextColor

Gets or sets the display text color.

get titleTextColor(): string

Returns string

set titleTextColor(v: string): void

Parameters

v: string

Returns void

titleTextMarginBottom

get titleTextMarginBottom(): number

Returns number

set titleTextMarginBottom(v: number): void

Parameters

v: number

Returns void

titleTextMarginLeft

get titleTextMarginLeft(): number

Returns number

set titleTextMarginLeft(v: number): void

Parameters

v: number

Returns void

titleTextMarginRight

get titleTextMarginRight(): number

Returns number

set titleTextMarginRight(v: number): void

Parameters

v: number

Returns void

titleTextMarginTop

get titleTextMarginTop(): number

Returns number

set titleTextMarginTop(v: number): void

Parameters

v: number

Returns void

titleTextStyle

Gets or Sets the style to use for the display text.

get titleTextStyle(): string

Returns string

set titleTextStyle(v: string): void

Parameters

v: string

Returns void

toolTipBackground

Gets or sets the background of the tooltip containers.

get toolTipBackground(): string

Returns string

set toolTipBackground(v: string): void

Parameters

v: string

Returns void

toolTipBorderBrush

Gets or sets the border color of the tooltip containers.

get toolTipBorderBrush(): string

Returns string

set toolTipBorderBrush(v: string): void

Parameters

v: string

Returns void

toolTipBorderThickness

Gets or sets the border thickness of the tooltip containers.

get toolTipBorderThickness(): number

Returns number

set toolTipBorderThickness(v: number): void

Parameters

v: number

Returns void

tooltipContainerTemplate

Inherited from: IgrAnnotationLayer

get tooltipContainerTemplate(): any

Returns any

set tooltipContainerTemplate(value: any): void

Parameters

value: any

Returns void

tooltipTemplate

Inherited from: IgrAnnotationLayer

get tooltipTemplate(): any

Returns any

set tooltipTemplate(value: any): void

Parameters

value: any

Returns void

transitionDuration

Inherited from: IgrAnnotationLayer

Gets or sets the duration of the current series' morph.

The TransitionDuration can be used to play animation when data is added or removed from a Series. To play an initial animation see TransitionInDuration.

get transitionDuration(): number

Returns number

set transitionDuration(v: number): void

Parameters

v: number

Returns void

transitionEasingFunction

Inherited from: IgrAnnotationLayer

Gets or sets the easing function used to morph the current series.

The TransitioninDuration and TransitionEasingFunction can be used to play animation when data is added or removed from a Series. To play an initial animation see TransitionInDuration.

get transitionEasingFunction(): object

Returns object

set transitionEasingFunction(v: object): void

Parameters

v: object

Returns void

transitionInDuration

Inherited from: IgrAnnotationLayer

Gets or sets the duration of the current series' transition in morph.

The TransitionInDuration can be used with IsTransitionInEnabled to cofigure the animation when a new datasource is loaded.

get transitionInDuration(): number

Returns number

set transitionInDuration(v: number): void

Parameters

v: number

Returns void

transitionInEasingFunction

Inherited from: IgrAnnotationLayer

Gets or sets the EasingFunction used to morph the current series during the initial transition.

The TransitionInEasingFunction can be used with IsTransitionInEnabled to cofigure the animation when a new datasource is loaded.

get transitionInEasingFunction(): object

Returns object

set transitionInEasingFunction(v: object): void

Parameters

v: object

Returns void

transitionInSpeedType

Inherited from: IgrAnnotationLayer

Gets or sets the duration of the current series' transition in morph.

The TransitionInSpeedType can be used with IsTransitionInEnabled to cofigure the animation when a new datasource is loaded.

get transitionInSpeedType(): TransitionInSpeedType

Returns TransitionInSpeedType

set transitionInSpeedType(v: TransitionInSpeedType): void

Parameters

v: TransitionInSpeedType

Returns void

transitionOutCompleted

Inherited from: IgrAnnotationLayer

Fired when a transition out has completed.

get transitionOutCompleted(): object

Returns object

set transitionOutCompleted(ev: object): void

Parameters

ev: object

Returns void

transitionOutDuration

Inherited from: IgrAnnotationLayer

Gets or sets the duration of the current series' transition out morph.

get transitionOutDuration(): number

Returns number

set transitionOutDuration(v: number): void

Parameters

v: number

Returns void

transitionOutEasingFunction

Inherited from: IgrAnnotationLayer

Gets or sets the EasingFunction used to morph the current series during the initial transition.

get transitionOutEasingFunction(): object

Returns object

set transitionOutEasingFunction(v: object): void

Parameters

v: object

Returns void

transitionOutSpeedType

Inherited from: IgrAnnotationLayer

Gets or sets the duration of the current series' transition out morph.

get transitionOutSpeedType(): TransitionOutSpeedType

Returns TransitionOutSpeedType

set transitionOutSpeedType(v: TransitionOutSpeedType): void

Parameters

v: TransitionOutSpeedType

Returns void

unitsDisplayMode

Gets or sets the UnitsMode for the data legend.

get unitsDisplayMode(): DataLegendUnitsMode

Returns DataLegendUnitsMode

set unitsDisplayMode(v: DataLegendUnitsMode): void

Parameters

v: DataLegendUnitsMode

Returns void

unitsText

Gets or sets the units text for the data legend.

get unitsText(): string

Returns string

set unitsText(v: string): void

Parameters

v: string

Returns void

unitsTextColor

Gets or sets the units text color.

get unitsTextColor(): string

Returns string

set unitsTextColor(v: string): void

Parameters

v: string

Returns void

unitsTextMarginBottom

get unitsTextMarginBottom(): number

Returns number

set unitsTextMarginBottom(v: number): void

Parameters

v: number

Returns void

unitsTextMarginLeft

get unitsTextMarginLeft(): number

Returns number

set unitsTextMarginLeft(v: number): void

Parameters

v: number

Returns void

unitsTextMarginRight

get unitsTextMarginRight(): number

Returns number

set unitsTextMarginRight(v: number): void

Parameters

v: number

Returns void

unitsTextMarginTop

get unitsTextMarginTop(): number

Returns number

set unitsTextMarginTop(v: number): void

Parameters

v: number

Returns void

unitsTextStyle

Gets or Sets the style to use for the units text.

get unitsTextStyle(): string

Returns string

set unitsTextStyle(v: string): void

Parameters

v: string

Returns void

useIndex

Inherited from: IgrAnnotationLayer

Gets or sets whether this series should take up an index for auto brush coloring.

get useIndex(): boolean

Returns boolean

set useIndex(v: boolean): void

Parameters

v: boolean

Returns void

useInterpolation

Gets or sets whether to use value interpolation when drawing the tooltips.

get useInterpolation(): boolean

Returns boolean

set useInterpolation(v: boolean): void

Parameters

v: boolean

Returns void

useItemWiseColors

Inherited from: IgrAnnotationLayer

Gets or sets whether the series should use individual palette colors for each item.

get useItemWiseColors(): boolean

Returns boolean

set useItemWiseColors(v: boolean): void

Parameters

v: boolean

Returns void

useLegend

Inherited from: IgrAnnotationLayer

Gets or sets whether this series interacts with the chart legend.

get useLegend(): boolean

Returns boolean

set useLegend(v: boolean): void

Parameters

v: boolean

Returns void

useSingleShadow

Inherited from: IgrAnnotationLayer

Gets or sets whether drop shadow is applied to the whole series visual or to each of the individual shapes forming the series. When this property is set to true, no Series.ShadowBlur is applied.

get useSingleShadow(): boolean

Returns boolean

set useSingleShadow(v: boolean): void

Parameters

v: boolean

Returns void

valueFormatAbbreviation

Gets or sets mode for abbreviating large numbers displayed in the legend This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

get valueFormatAbbreviation(): DataAbbreviationMode

Returns DataAbbreviationMode

set valueFormatAbbreviation(v: DataAbbreviationMode): void

Parameters

v: DataAbbreviationMode

Returns void

valueFormatCulture

Gets or sets globalization culture when displaying values as currencies, e.g. use "en-GB" to display British pound symbol when the ValueFormatMode property is set to 'Currency' mode This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

get valueFormatCulture(): string

Returns string

set valueFormatCulture(v: string): void

Parameters

v: string

Returns void

valueFormatMaxFractions

Gets or sets maximum digits for formatting numbers displayed in the legend This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

get valueFormatMaxFractions(): number

Returns number

set valueFormatMaxFractions(v: number): void

Parameters

v: number

Returns void

valueFormatMinFractions

Gets or sets minimum digits for formatting numbers displayed in the legend This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

get valueFormatMinFractions(): number

Returns number

set valueFormatMinFractions(v: number): void

Parameters

v: number

Returns void

valueFormatMode

Gets or sets the mode for displaying values in the data legend, e.g. Currency ($500.25), Decimal (500.25), Integer (500)

get valueFormatMode(): DataLegendValueMode

Returns DataLegendValueMode

set valueFormatMode(v: DataLegendValueMode): void

Parameters

v: DataLegendValueMode

Returns void

valueFormatSpecifiers

Gets or sets the format specifiers to use with the ValueFormatString string.

get valueFormatSpecifiers(): any[]

Returns any[]

set valueFormatSpecifiers(v: any[]): void

Parameters

v: any[]

Returns void

valueFormatString

Gets or sets the format string for values displayed in the data legend.

get valueFormatString(): string

Returns string

set valueFormatString(v: string): void

Parameters

v: string

Returns void

valueFormatUseGrouping

Gets or sets whether or not use grouping separator, e.g, 15,000 for 15000 This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

get valueFormatUseGrouping(): boolean

Returns boolean

set valueFormatUseGrouping(v: boolean): void

Parameters

v: boolean

Returns void

valueRowMarginBottom

get valueRowMarginBottom(): number

Returns number

set valueRowMarginBottom(v: number): void

Parameters

v: number

Returns void

valueRowMarginLeft

get valueRowMarginLeft(): number

Returns number

set valueRowMarginLeft(v: number): void

Parameters

v: number

Returns void

valueRowMarginRight

get valueRowMarginRight(): number

Returns number

set valueRowMarginRight(v: number): void

Parameters

v: number

Returns void

valueRowMarginTop

get valueRowMarginTop(): number

Returns number

set valueRowMarginTop(v: number): void

Parameters

v: number

Returns void

valueRowVisible

Gets or sets whether to show series rows.

get valueRowVisible(): boolean

Returns boolean

set valueRowVisible(v: boolean): void

Parameters

v: boolean

Returns void

valueTextColor

Gets or sets the units text color.

get valueTextColor(): string

Returns string

set valueTextColor(v: string): void

Parameters

v: string

Returns void

valueTextMarginBottom

get valueTextMarginBottom(): number

Returns number

set valueTextMarginBottom(v: number): void

Parameters

v: number

Returns void

valueTextMarginLeft

get valueTextMarginLeft(): number

Returns number

set valueTextMarginLeft(v: number): void

Parameters

v: number

Returns void

valueTextMarginRight

get valueTextMarginRight(): number

Returns number

set valueTextMarginRight(v: number): void

Parameters

v: number

Returns void

valueTextMarginTop

get valueTextMarginTop(): number

Returns number

set valueTextMarginTop(v: number): void

Parameters

v: number

Returns void

valueTextStyle

Gets or Sets the style to use for the units text.

get valueTextStyle(): string

Returns string

set valueTextStyle(v: string): void

Parameters

v: string

Returns void

valueTextUseSeriesColors

Gets or sets whether to use series colors when displaying values in the legend

get valueTextUseSeriesColors(): boolean

Returns boolean

set valueTextUseSeriesColors(v: boolean): void

Parameters

v: boolean

Returns void

valueTextWhenMissingData

Gets or sets text displayed when data column is missing a value, e.g. "no data"

get valueTextWhenMissingData(): string

Returns string

set valueTextWhenMissingData(v: string): void

Parameters

v: string

Returns void

verticalAppearanceMode

Inherited from: IgrAnnotationLayer

Gets or sets the mode used for shifting the annotation layer color based on the target series.

get verticalAppearanceMode(): AnnotationAppearanceMode

Returns AnnotationAppearanceMode

set verticalAppearanceMode(v: AnnotationAppearanceMode): void

Parameters

v: AnnotationAppearanceMode

Returns void

verticalDashArray

Inherited from: IgrAnnotationLayer

Gets or sets the mode used for shifting the annotation layer color based on the target series.

get verticalDashArray(): number[]

Returns number[]

set verticalDashArray(v: number[]): void

Parameters

v: number[]

Returns void

verticalShiftAmount

Inherited from: IgrAnnotationLayer

Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0.

get verticalShiftAmount(): number

Returns number

set verticalShiftAmount(v: number): void

Parameters

v: number

Returns void

visibility

Inherited from: IgrAnnotationLayer

get visibility(): Visibility

Returns Visibility

set visibility(v: Visibility): void

Parameters

v: Visibility

Returns void

visibleRangeMarginBottom

Inherited from: IgrAnnotationLayer

Gets or sets the bottom margin to use when getting a visible axis range for the series.

get visibleRangeMarginBottom(): number

Returns number

set visibleRangeMarginBottom(v: number): void

Parameters

v: number

Returns void

visibleRangeMarginLeft

Inherited from: IgrAnnotationLayer

Gets or sets the left margin to use when getting a visible axis range for the series.

get visibleRangeMarginLeft(): number

Returns number

set visibleRangeMarginLeft(v: number): void

Parameters

v: number

Returns void

visibleRangeMarginRight

Inherited from: IgrAnnotationLayer

Gets or sets the right margin to use when getting a visible axis range for the series.

get visibleRangeMarginRight(): number

Returns number

set visibleRangeMarginRight(v: number): void

Parameters

v: number

Returns void

visibleRangeMarginTop

Inherited from: IgrAnnotationLayer

Gets or sets the top margin to use when getting a visible axis range for the series.

get visibleRangeMarginTop(): number

Returns number

set visibleRangeMarginTop(v: number): void

Parameters

v: number

Returns void

visibleRangeMode

Inherited from: IgrAnnotationLayer

Gets or sets the visible range mode to use.

get visibleRangeMode(): SeriesVisibleRangeMode

Returns SeriesVisibleRangeMode

set visibleRangeMode(v: SeriesVisibleRangeMode): void

Parameters

v: SeriesVisibleRangeMode

Returns void

i

get i(): Series

Returns Series

Methods

bindAxes

bindAxes(axes: IgrAxis<IIgrAxisProps>[]): void

Parameters

axes: IgrAxis<IIgrAxisProps>[]

Returns void

bindSeries

Inherited from: IgrAnnotationLayer

bindSeries(series: IgrSeries<IIgrSeriesProps>[]): void

Parameters

series: IgrSeries<IIgrSeriesProps>[]

Returns void

componentDidMount

Inherited from: IgrAnnotationLayer

componentDidMount(): void

Returns void

ensureBadgeMargin

ensureBadgeMargin(): void

Returns void

ensureGroupRowMargin

ensureGroupRowMargin(): void

Returns void

ensureGroupTextMargin

ensureGroupTextMargin(): void

Returns void

ensureHeaderRowMargin

ensureHeaderRowMargin(): void

Returns void

ensureHeaderTextMargin

ensureHeaderTextMargin(): void

Returns void

ensureLabelTextMargin

ensureLabelTextMargin(): void

Returns void

ensureSummaryRowMargin

ensureSummaryRowMargin(): void

Returns void

ensureSummaryTitleTextMargin

ensureSummaryTitleTextMargin(): void

Returns void

ensureTitleTextMargin

ensureTitleTextMargin(): void

Returns void

ensureUnitsTextMargin

ensureUnitsTextMargin(): void

Returns void

ensureValueRowMargin

ensureValueRowMargin(): void

Returns void

ensureValueTextMargin

ensureValueTextMargin(): void

Returns void

findByName

findByName(name: string): any

Parameters

name: string

Returns any

fromWorldPosition

Inherited from: IgrAnnotationLayer

Converts a point from world coordinates to coordinates within the viewport of the series.

fromWorldPosition(world: IgPoint): IgPoint

Parameters

world: IgPoint
- The world position from which to convert.

Returns IgPoint

getEffectiveViewport

Inherited from: IgrAnnotationLayer

Gets the effective viewport, adjusted to account for margins and other factors.

getEffectiveViewport(): IgRect

Returns IgRect

getExactItemIndex

Inherited from: IgrAnnotationLayer

Gets the precise item index, if possible, based on the closeness to the previous or next whole integer. If the series cannot provide this information, GetExactItemIndex will return the same integer value as GetItemIndex.

getExactItemIndex(world: IgPoint): number

Parameters

world: IgPoint

The world position for which to return the index.

let index: number = this.series.getExactItemIndex({x:.5,y:.5});

Returns number

getItem

Inherited from: IgrAnnotationLayer

Gets the item that is the best match for the specified world coordinates.

getItem(world: IgPoint): any

Parameters

world: IgPoint

The world coordinates to use.

let item: number = this.series.getItem({x:.5,y:.5});

Returns any

getItemIndex

Inherited from: IgrAnnotationLayer

Gets the item index associated with the specified world position

getItemIndex(world: IgPoint): number

Parameters

world: IgPoint

Returns number

getItemSpan

Inherited from: IgrAnnotationLayer

For a category plotted series, returns the current width of the items within the categories. This only returns a value if the items have some form of width (e.g. columns, bars, etc.) otherwise 0 is returned.

getItemSpan(): number

Returns number

getItemValue

Inherited from: IgrAnnotationLayer

getItemValue(item: any, memberPathName: string): any

Parameters

item: any
memberPathName: string

Returns any

getMainContentViewport

Inherited from: IgrAnnotationLayer

getMainContentViewport(): IgRect

Returns IgRect

getMemberPathValue

Inherited from: IgrAnnotationLayer

Gets the value of a requested member path from the series.

getMemberPathValue(memberPathName: string): string

Parameters

memberPathName: string
- The property name of a valid member path for the series

Returns string

getNextOrExactIndex

Inherited from: IgrAnnotationLayer

getNextOrExactIndex(world: IgPoint, skipUnknowns: boolean): number

Parameters

world: IgPoint
skipUnknowns: boolean

Returns number

getPreviousOrExactIndex

Inherited from: IgrAnnotationLayer

getPreviousOrExactIndex(world: IgPoint, skipUnknowns: boolean): number

Parameters

world: IgPoint
skipUnknowns: boolean

Returns number

getSeriesHighValue

Inherited from: IgrAnnotationLayer

getSeriesHighValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesHighValuePosition

Inherited from: IgrAnnotationLayer

getSeriesHighValuePosition(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesLowValue

Inherited from: IgrAnnotationLayer

getSeriesLowValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesLowValuePosition

Inherited from: IgrAnnotationLayer

getSeriesLowValuePosition(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValue

Inherited from: IgrAnnotationLayer

getSeriesValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesValueBoundingBox

Inherited from: IgrAnnotationLayer

If possible, will return the best available value bounding box within the series that has the best value match for the world position provided.

getSeriesValueBoundingBox(world: IgPoint): IgRect

Parameters

world: IgPoint
- The world coordinate for which to get a value bounding box for

Returns IgRect

getSeriesValueFromSeriesPixel

Inherited from: IgrAnnotationLayer

getSeriesValueFromSeriesPixel(mouse: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number

Parameters

mouse: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesValueMarkerBoundingBox

Inherited from: IgrAnnotationLayer

If possible, will return the best available value marker bounding box within the series that has the best value match for the world position provided.

getSeriesValueMarkerBoundingBox(world: IgPoint): IgRect

Parameters

world: IgPoint
- The world coordinates for which to get a value marker bounding box for

Returns IgRect

getSeriesValuePosition

Inherited from: IgrAnnotationLayer

getSeriesValuePosition(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValuePositionFromSeriesPixel

Inherited from: IgrAnnotationLayer

getSeriesValuePositionFromSeriesPixel(mouse: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint

Parameters

mouse: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValueType

Inherited from: IgrAnnotationLayer

Gets the data values of each axis associated with the specified value type. For example, if you specify mode as Maximum then it will return the maximum numerical value for each axis. For non-numerical axes it will return NaN.

getSeriesValueType(mode: string | ValueLayerValueMode): number[]

Parameters

mode: string | ValueLayerValueMode
- The type of value desired from the series axes.

Returns number[]

getSeriesValueTypePosition

Inherited from: IgrAnnotationLayer

Gets position of series value for specified layer value mode

getSeriesValueTypePosition(mode: string | ValueLayerValueMode): IgPoint

Parameters

mode: string | ValueLayerValueMode

Returns IgPoint

getSeriesValueTypePositionFromValue

Inherited from: IgrAnnotationLayer

getSeriesValueTypePositionFromValue(values: number[]): IgPoint

Parameters

values: number[]

Returns IgPoint

getUnscaledPosition

Inherited from: IgrAnnotationLayer

Gets an unscaled position in terms of axis values from a viewport position.

getUnscaledPosition(pos: IgPoint): IgPoint

Parameters

pos: IgPoint
- The viewport relative position

Returns IgPoint

hideToolTips

Hides any tooltips presented by the layer, if any.

hideToolTips(): void

Returns void

hideToolTipsImmediate

Hides any tooltips presented by the layer, if any.

hideToolTipsImmediate(): void

Returns void

moveCursorPoint

Inherited from: IgrAnnotationLayer

Moves the cursor point to the provided world position. Some series may react to the current cursor position.

moveCursorPoint(point: IgPoint): void

Parameters

point: IgPoint
- The cursor point, in world coordinates.
MoveCursorPoint can be used on annotation layers to programitically show the annotation at the given point.
```
this.crosshair.moveCursorPoint({x:.5,y:.5});
```

Returns void

notifyIndexedPropertiesChanged

Inherited from: IgrAnnotationLayer

Called to notify about changes to indexed-based properties, e.g. Brushes, Outlines, MarkerBrushes, MarkerOutlines and refresh series

notifyIndexedPropertiesChanged(): void

Returns void

notifyVisualPropertiesChanged

Inherited from: IgrAnnotationLayer

Notifies the series that a visual property has changed, requiring a visual update.

notifyVisualPropertiesChanged(): void

Returns void

playTransitionIn

Inherited from: IgrAnnotationLayer

Plays the assigned transition out animation, if any.

playTransitionIn(): void

Returns void

playTransitionOut

Inherited from: IgrAnnotationLayer

Plays the assigned transition out animation, if any.

playTransitionOut(): void

Returns void

playTransitionOutAndRemove

Inherited from: IgrAnnotationLayer

Plays the assigned transition out animation, if any.

playTransitionOutAndRemove(): void

Returns void

provideData

Inherited from: IgrAnnotationLayer

provideData(data: any[]): void

Parameters

data: any[]

Returns void

provideHighlightedData

Inherited from: IgrAnnotationLayer

provideHighlightedData(data: any[]): void

Parameters

data: any[]

Returns void

removeAllAlternateViews

Inherited from: IgrAnnotationLayer

Removes all alternate views of this series.

removeAllAlternateViews(): void

Returns void

removeAlternateView

Inherited from: IgrAnnotationLayer

Removes an alternate view of this series.

removeAlternateView(viewIdentifier: string): void

Parameters

viewIdentifier: string
- The string identifier for the view to remove.

Returns void

removeAxes

Inherited from: IgrAnnotationLayer

Call to null out the axes of the series;

removeAxes(): void

Returns void

render

Inherited from: IgrAnnotationLayer

render(): any

Returns any

renderSeries

Inherited from: IgrAnnotationLayer

Renders the series.

renderSeries(animate: boolean): void

Parameters

animate: boolean
- True if the change should be animated.
```
this.series.renderSeries(true);
```

Returns void

replayTransitionIn

Inherited from: IgrAnnotationLayer

Replays the assigned transition in animation, if any.

replayTransitionIn(): void

Returns void

resolveTooltipBrush

Inherited from: IgrAnnotationLayer

Gets the brush for tooltip labels.

resolveTooltipBrush(): string

Returns string

scrollIntoView

Inherited from: IgrAnnotationLayer

Requests that the provided item should be brought into view if possible.

scrollIntoView(item: any): boolean

Parameters

item: any
- The item to attempt to bring into view.
```
this.series.scrollIntoView(dataItem);
```

Returns boolean

setNegativeColors

Inherited from: IgrAnnotationLayer

setNegativeColors(negativeBrush: string, negativeOutline: string): void

Parameters

negativeBrush: string
negativeOutline: string

Returns void

shouldComponentUpdate

Inherited from: IgrAnnotationLayer

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

Parameters

nextProps: any
nextState: any

Returns boolean

simulateHover

Inherited from: IgrAnnotationLayer

Simulates a pointer hover over the series surface.

simulateHover(point: IgPoint): void

Parameters

point: IgPoint
- The pointer position relative to the series viewport over which to hover.
When tooltips are enabled, SimulateHover can be used to automatically display the tooltip over a particular series item.
```
this.series.simulateHover({x:250,y:250});
```

Returns void

styleUpdated

Inherited from: IgrAnnotationLayer

Called when this series' Style is updated.

styleUpdated(): void

Returns void

toWorldPosition

Inherited from: IgrAnnotationLayer

Converts a point from coordinates within the series plot area to a world position within axis space.

toWorldPosition(seriesPoint: IgPoint): IgPoint

Parameters

seriesPoint: IgPoint
- The pixel location within the plot area of the series.
```
this.series.toWorldPosition({x:500,y:500});
```

Returns IgPoint

toWorldRect

Inherited from: IgrAnnotationLayer

Converts a rect from coordinates within the series plot area to a world position within axis space.

toWorldRect(rect: IgRect): IgRect

Parameters

rect: IgRect
- The pixel rect within the plot area of the series.

Returns IgRect

_createFromInternal

Inherited from: IgrAnnotationLayer

_createFromInternal(internal: any): IgrSeries

Parameters

internal: any