IIgrDataToolTipLayerProps

Properties

Optional actualAppearanceMode

Inherited from: IIgrAnnotationLayerProps

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

actualAppearanceMode?: string | AnnotationAppearanceMode

Optional actualAreaFillOpacity

Inherited from: IIgrAnnotationLayerProps

Gets the actual opacity applied to the area fill visual.

actualAreaFillOpacity?: string | number

Optional actualBrush

Inherited from: IIgrAnnotationLayerProps

Gets the effective brush for the current series object.

actualBrush?: string

Optional actualDashArray

Inherited from: IIgrAnnotationLayerProps

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

actualDashArray?: string | number[]

Optional actualDashCap

Inherited from: IIgrAnnotationLayerProps

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

actualDashCap?: any

Optional actualFocusBrush

Inherited from: IIgrAnnotationLayerProps

Gets the effective emphasis brush for the current series object.

actualFocusBrush?: string

Optional actualFocusMode

Inherited from: IIgrAnnotationLayerProps

Gets actual Selection mode

actualFocusMode?: string | SeriesSelectionMode

Optional actualGroupedPositionModeX

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

actualGroupedPositionModeX?: any

Optional actualGroupedPositionModeY

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

actualGroupedPositionModeY?: any

Optional actualGroupingMode

Gets the actual resolved tooltip layer grouping mode.

actualGroupingMode?: any

Optional actualHighlightedValuesFadeOpacity

Inherited from: IIgrAnnotationLayerProps

Gets actual HighlightedValues fade opacity

actualHighlightedValuesFadeOpacity?: string | number

Optional actualHighlightingFadeOpacity

Inherited from: IIgrAnnotationLayerProps

Gets actual highlighting fade opacity

actualHighlightingFadeOpacity?: string | number

Optional actualHighlightingMode

Inherited from: IIgrAnnotationLayerProps

Gets actual highlighting mode

actualHighlightingMode?: string | SeriesHighlightingMode

Optional actualHitTestMode

Inherited from: IIgrAnnotationLayerProps

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

actualHitTestMode?: string | SeriesHitTestMode

Optional actualHorizontalAppearanceMode

Inherited from: IIgrAnnotationLayerProps

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

actualHorizontalAppearanceMode?: string | AnnotationAppearanceMode

Optional actualHorizontalDashArray

Inherited from: IIgrAnnotationLayerProps

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

actualHorizontalDashArray?: string | number[]

Optional actualHorizontalShiftAmount

Inherited from: IIgrAnnotationLayerProps

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

actualHorizontalShiftAmount?: string | number

Optional actualLegendItemBadgeBrush

Inherited from: IIgrAnnotationLayerProps

Gets the effective legend badge fill for the current series.

actualLegendItemBadgeBrush?: string

Optional actualLegendItemBadgeOutline

Inherited from: IIgrAnnotationLayerProps

Gets the effective legend badge outline for the current series.

actualLegendItemBadgeOutline?: string

Optional actualLegendItemBadgeTemplate

Inherited from: IIgrAnnotationLayerProps

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

actualLegendItemBadgeTemplate?: IgDataTemplate

Optional actualMarkerFillOpacity

Inherited from: IIgrAnnotationLayerProps

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

actualMarkerFillOpacity?: string | number

Optional actualOutline

Inherited from: IIgrAnnotationLayerProps

Gets the effective outline for the current series object.

actualOutline?: string

Optional actualResolution

Inherited from: IIgrAnnotationLayerProps

actualResolution?: string | number

Optional actualSelectionBrush

Inherited from: IIgrAnnotationLayerProps

Gets the effective emphasis brush for the current series object.

actualSelectionBrush?: string

Optional actualSelectionMode

Inherited from: IIgrAnnotationLayerProps

Gets actual Selection mode

actualSelectionMode?: string | SeriesSelectionMode

Optional actualShiftAmount

Inherited from: IIgrAnnotationLayerProps

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

actualShiftAmount?: string | number

Optional actualThickness

Inherited from: IIgrAnnotationLayerProps

Gets the effective Thickness for the current series object.

actualThickness?: string | number

Optional actualVerticalAppearanceMode

Inherited from: IIgrAnnotationLayerProps

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

actualVerticalAppearanceMode?: string | AnnotationAppearanceMode

Optional actualVerticalDashArray

Inherited from: IIgrAnnotationLayerProps

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

actualVerticalDashArray?: string | number[]

Optional actualVerticalShiftAmount

Inherited from: IIgrAnnotationLayerProps

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

actualVerticalShiftAmount?: string | number

Optional appearanceMode

Inherited from: IIgrAnnotationLayerProps

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

appearanceMode?: string | AnnotationAppearanceMode

Optional areaFillOpacity

Inherited from: IIgrAnnotationLayerProps

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

areaFillOpacity?: string | number

Optional attachTooltipToRoot

Inherited from: IIgrAnnotationLayerProps

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

attachTooltipToRoot?: string | boolean

Optional autoCalloutLabelFormat

Inherited from: IIgrAnnotationLayerProps

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

autoCalloutLabelFormat?: string

Optional autoCalloutLabelFormatSpecifiers

Inherited from: IIgrAnnotationLayerProps

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

autoCalloutLabelFormatSpecifiers?: any[]

Optional autoCalloutValueLabelFormat

Inherited from: IIgrAnnotationLayerProps

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

autoCalloutValueLabelFormat?: string

Optional autoCalloutValueLabelFormatSpecifiers

Inherited from: IIgrAnnotationLayerProps

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

autoCalloutValueLabelFormatSpecifiers?: any[]

Optional badgeMarginBottom

badgeMarginBottom?: string | number

Optional badgeMarginLeft

badgeMarginLeft?: string | number

Optional badgeMarginRight

badgeMarginRight?: string | number

Optional badgeMarginTop

badgeMarginTop?: string | number

Optional badgeShape

Gets or sets the BadgeShape for the data legend.

badgeShape?: any

Optional brush

Inherited from: IIgrAnnotationLayerProps

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.

brush?: string

Optional children

Inherited from: IIgrAnnotationLayerProps

children?: ReactNode

Optional coercionMethods

Inherited from: IIgrAnnotationLayerProps

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

coercionMethods?: any

Optional cursorPosition

Inherited from: IIgrAnnotationLayerProps

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.

cursorPosition?: any

Optional cursorPositionUpdatesOnMove

Inherited from: IIgrAnnotationLayerProps

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

cursorPositionUpdatesOnMove?: string | boolean

Optional dashArray

Inherited from: IIgrAnnotationLayerProps

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.

dashArray?: string | number[]

Optional dataLegendGroup

Inherited from: IIgrAnnotationLayerProps

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

dataLegendGroup?: string

Optional dataSource

Inherited from: IIgrAnnotationLayerProps

dataSource?: any

Optional defaultPositionOffsetX

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

defaultPositionOffsetX?: string | number

Optional defaultPositionOffsetY

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

defaultPositionOffsetY?: string | number

Optional discreteLegendItemTemplate

Inherited from: IIgrAnnotationLayerProps

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

discreteLegendItemTemplate?: IgDataTemplate

Optional 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

excludedColumns?: string[]

Optional 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

excludedSeries?: string[]

Optional expectFunctions

Inherited from: IIgrAnnotationLayerProps

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.

expectFunctions?: string | boolean

Optional finalValue

Inherited from: IIgrAnnotationLayerProps

The final value of this series.

finalValue?: string | number

Optional focusBrush

Inherited from: IIgrAnnotationLayerProps

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

focusBrush?: string

Optional groupedPositionModeX

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

groupedPositionModeX?: any

Optional groupedPositionModeY

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

groupedPositionModeY?: any

Optional groupingMode

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

groupingMode?: any

Optional groupRowMarginBottom

groupRowMarginBottom?: string | number

Optional groupRowMarginLeft

groupRowMarginLeft?: string | number

Optional groupRowMarginRight

groupRowMarginRight?: string | number

Optional groupRowMarginTop

groupRowMarginTop?: string | number

Optional groupRowVisible

Gets or sets whether to show Header row.

groupRowVisible?: string | boolean

Optional groupTextColor

Gets or sets the Group text color.

groupTextColor?: string

Optional groupTextMarginBottom

groupTextMarginBottom?: string | number

Optional groupTextMarginLeft

groupTextMarginLeft?: string | number

Optional groupTextMarginRight

groupTextMarginRight?: string | number

Optional groupTextMarginTop

groupTextMarginTop?: string | number

Optional groupTextStyle

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

groupTextStyle?: string

Optional headerFormatCulture

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

headerFormatCulture?: string

Optional headerFormatDate

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

headerFormatDate?: any

Optional headerFormatSpecifiers

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

headerFormatSpecifiers?: any[]

Optional headerFormatString

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

headerFormatString?: string

Optional headerFormatTime

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

headerFormatTime?: any

Optional headerRowMarginBottom

headerRowMarginBottom?: string | number

Optional headerRowMarginLeft

headerRowMarginLeft?: string | number

Optional headerRowMarginRight

headerRowMarginRight?: string | number

Optional headerRowMarginTop

headerRowMarginTop?: string | number

Optional headerRowVisible

Gets or sets whether to show Header row.

headerRowVisible?: string | boolean

Optional headerText

Gets or sets the HeaderText for the data legend.

headerText?: string

Optional headerTextColor

Gets or sets the header text color.

headerTextColor?: string

Optional headerTextMarginBottom

headerTextMarginBottom?: string | number

Optional headerTextMarginLeft

headerTextMarginLeft?: string | number

Optional headerTextMarginRight

headerTextMarginRight?: string | number

Optional headerTextMarginTop

headerTextMarginTop?: string | number

Optional headerTextStyle

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

headerTextStyle?: string

Optional highlightedDataSource

Inherited from: IIgrAnnotationLayerProps

highlightedDataSource?: any

Optional highlightedLegendItemVisibility

Inherited from: IIgrAnnotationLayerProps

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

highlightedLegendItemVisibility?: any

Optional highlightedTitleSuffix

Inherited from: IIgrAnnotationLayerProps

Gets or sets the HighlightedTitleSuffix property.

highlightedTitleSuffix?: string

Optional highlightedValuesDataLegendGroup

Inherited from: IIgrAnnotationLayerProps

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

highlightedValuesDataLegendGroup?: string

Optional highlightedValuesDisplayMode

Inherited from: IIgrAnnotationLayerProps

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.

highlightedValuesDisplayMode?: any

Optional highlightedValuesFadeOpacity

Inherited from: IIgrAnnotationLayerProps

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

highlightedValuesFadeOpacity?: string | number

Optional highlightingFadeOpacity

Inherited from: IIgrAnnotationLayerProps

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

highlightingFadeOpacity?: string | number

Optional hitTestMode

Inherited from: IIgrAnnotationLayerProps

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

hitTestMode?: string | SeriesHitTestMode

Optional horizontalAppearanceMode

Inherited from: IIgrAnnotationLayerProps

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

horizontalAppearanceMode?: string | AnnotationAppearanceMode

Optional horizontalDashArray

Inherited from: IIgrAnnotationLayerProps

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

horizontalDashArray?: string | number[]

Optional horizontalShiftAmount

Inherited from: IIgrAnnotationLayerProps

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

horizontalShiftAmount?: string | number

Optional 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

includedColumns?: string[]

Optional 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

includedSeries?: string[]

Optional index

Inherited from: IIgrAnnotationLayerProps

Gets the Index property.

index?: string | number

Optional isActualLegendFinancial

Inherited from: IIgrAnnotationLayerProps

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

isActualLegendFinancial?: string | boolean

Optional isComponentHighlightingModeIgnored

Inherited from: IIgrAnnotationLayerProps

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

isComponentHighlightingModeIgnored?: string | boolean

Optional isDefaultCrosshairDisabled

Inherited from: IIgrAnnotationLayerProps

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

isDefaultCrosshairDisabled?: string | boolean

Optional isDefaultToolTipSelected

Inherited from: IIgrAnnotationLayerProps

Gets if the default tooltip has been selected for display.

To use the default tooltip set ShowDefaultTooltip to true.

isDefaultToolTipSelected?: string | boolean

Optional isDropShadowEnabled

Inherited from: IIgrAnnotationLayerProps

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.

isDropShadowEnabled?: string | boolean

Optional isHighlightingEnabled

Inherited from: IIgrAnnotationLayerProps

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

isHighlightingEnabled?: string | boolean

Optional 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

labelDisplayMode?: any

Optional labelTextColor

Gets or sets the units text color.

labelTextColor?: string

Optional labelTextMarginBottom

labelTextMarginBottom?: string | number

Optional labelTextMarginLeft

labelTextMarginLeft?: string | number

Optional labelTextMarginRight

labelTextMarginRight?: string | number

Optional labelTextMarginTop

labelTextMarginTop?: string | number

Optional labelTextStyle

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

labelTextStyle?: string

Optional layoutMode

Gets or sets the layout of content in the data legend

layoutMode?: any

Optional legend

Inherited from: IIgrAnnotationLayerProps

Gets or sets the legend used for the current series.

legend?: any

Optional legendItemBadgeMode

Inherited from: IIgrAnnotationLayerProps

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

legendItemBadgeMode?: any

Optional legendItemBadgeShape

Inherited from: IIgrAnnotationLayerProps

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

legendItemBadgeShape?: any

Optional legendItemBadgeTemplate

Inherited from: IIgrAnnotationLayerProps

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

legendItemBadgeTemplate?: IgDataTemplate

Optional legendItemTemplate

Inherited from: IIgrAnnotationLayerProps

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

legendItemTemplate?: IgDataTemplate

Optional legendItemVisibility

Inherited from: IIgrAnnotationLayerProps

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.

legendItemVisibility?: any

Optional lineCap

Inherited from: IIgrAnnotationLayerProps

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.

lineCap?: any

Optional lineJoin

Inherited from: IIgrAnnotationLayerProps

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

lineJoin?: any

Optional markerFillOpacity

Inherited from: IIgrAnnotationLayerProps

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

markerFillOpacity?: string | number

Optional mouseOverEnabled

Inherited from: IIgrAnnotationLayerProps

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

mouseOverEnabled?: string | boolean

name

Inherited from: IIgrAnnotationLayerProps

Sets or gets a required unique name for the series.

name: string

Optional opacity

Inherited from: IIgrAnnotationLayerProps

opacity?: string | number

Optional outline

Inherited from: IIgrAnnotationLayerProps

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.

outline?: string

Optional outlineMode

Inherited from: IIgrAnnotationLayerProps

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

outlineMode?: string | SeriesOutlineMode

Optional percentChange

Inherited from: IIgrAnnotationLayerProps

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

percentChange?: string | number

Optional positionOffsetX

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

positionOffsetX?: string | number

Optional positionOffsetY

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

positionOffsetY?: string | number

Optional renderRequested

Inherited from: IIgrAnnotationLayerProps

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

renderRequested?: object

Optional resolution

Inherited from: IIgrAnnotationLayerProps

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.

resolution?: string | number

Optional safeActualBrush

Inherited from: IIgrAnnotationLayerProps

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

safeActualBrush?: string

Optional selectionBrush

Inherited from: IIgrAnnotationLayerProps

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

selectionBrush?: string

Optional selectionThickness

Inherited from: IIgrAnnotationLayerProps

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

selectionThickness?: string | number

Optional shadowBlur

Inherited from: IIgrAnnotationLayerProps

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.

shadowBlur?: string | number

Optional shadowColor

Inherited from: IIgrAnnotationLayerProps

Gets or sets the drop shadow color.

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

shadowColor?: string

Optional shadowOffsetX

Inherited from: IIgrAnnotationLayerProps

Gets or sets the drop shadow x-offset.

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

shadowOffsetX?: string | number

Optional shadowOffsetY

Inherited from: IIgrAnnotationLayerProps

Gets or sets the drop shadow y-offset.

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

shadowOffsetY?: string | number

Optional shiftAmount

Inherited from: IIgrAnnotationLayerProps

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

shiftAmount?: string | number

Optional shouldAnimateOnDataSourceSwap

Inherited from: IIgrAnnotationLayerProps

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.

shouldAnimateOnDataSourceSwap?: string | boolean

Optional shouldHideAutoCallouts

Inherited from: IIgrAnnotationLayerProps

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

shouldHideAutoCallouts?: string | boolean

Optional shouldRemoveHighlightedDataOnLayerHidden

Inherited from: IIgrAnnotationLayerProps

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

shouldRemoveHighlightedDataOnLayerHidden?: string | boolean

Optional shouldRenderAsOverlay

Inherited from: IIgrAnnotationLayerProps

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

shouldRenderAsOverlay?: string | boolean

Optional shouldShiftOpacityForSafeActualBrush

Inherited from: IIgrAnnotationLayerProps

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

shouldShiftOpacityForSafeActualBrush?: string | boolean

Optional shouldUpdateWhenSeriesDataChanges

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

shouldUpdateWhenSeriesDataChanges?: string | boolean

Optional showDefaultTooltip

Inherited from: IIgrAnnotationLayerProps

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.

showDefaultTooltip?: string | boolean

Optional summaryLabelText

Gets or sets the units text for the data legend.

summaryLabelText?: string

Optional summaryLabelTextColor

Gets or sets the units text color.

summaryLabelTextColor?: string

Optional summaryLabelTextStyle

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

summaryLabelTextStyle?: string

Optional summaryRowMarginBottom

summaryRowMarginBottom?: string | number

Optional summaryRowMarginLeft

summaryRowMarginLeft?: string | number

Optional summaryRowMarginRight

summaryRowMarginRight?: string | number

Optional summaryRowMarginTop

summaryRowMarginTop?: string | number

Optional summaryTitleText

Gets or sets the SummaryTitleText for the data legend.

summaryTitleText?: string

Optional summaryTitleTextColor

Gets or sets the summary text color.

summaryTitleTextColor?: string

Optional summaryTitleTextMarginBottom

summaryTitleTextMarginBottom?: string | number

Optional summaryTitleTextMarginLeft

summaryTitleTextMarginLeft?: string | number

Optional summaryTitleTextMarginRight

summaryTitleTextMarginRight?: string | number

Optional summaryTitleTextMarginTop

summaryTitleTextMarginTop?: string | number

Optional summaryTitleTextStyle

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

summaryTitleTextStyle?: string

Optional summaryType

Gets or sets the SummaryType for the data legend.

summaryType?: any

Optional summaryUnitsText

Gets or sets the units text for the data legend.

summaryUnitsText?: string

Optional summaryUnitsTextColor

Gets or sets the units text color.

summaryUnitsTextColor?: string

Optional summaryUnitsTextStyle

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

summaryUnitsTextStyle?: string

Optional summaryValueTextColor

Gets or sets the units text color.

summaryValueTextColor?: string

Optional summaryValueTextStyle

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

summaryValueTextStyle?: string

Optional targetAxis

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

targetAxis?: IgrAxis

Optional targetAxisName

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

targetAxisName?: string

Optional thickness

Inherited from: IIgrAnnotationLayerProps

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.

thickness?: string | number

Optional title

Inherited from: IIgrAnnotationLayerProps

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.

title?: any

Optional titleTextColor

Gets or sets the display text color.

titleTextColor?: string

Optional titleTextMarginBottom

titleTextMarginBottom?: string | number

Optional titleTextMarginLeft

titleTextMarginLeft?: string | number

Optional titleTextMarginRight

titleTextMarginRight?: string | number

Optional titleTextMarginTop

titleTextMarginTop?: string | number

Optional titleTextStyle

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

titleTextStyle?: string

Optional toolTipBackground

Gets or sets the background of the tooltip containers.

toolTipBackground?: string

Optional toolTipBorderBrush

Gets or sets the border color of the tooltip containers.

toolTipBorderBrush?: string

Optional toolTipBorderThickness

Gets or sets the border thickness of the tooltip containers.

toolTipBorderThickness?: string | number

Optional tooltipTemplate

Inherited from: IIgrAnnotationLayerProps

tooltipTemplate?: any

Optional transitionDuration

Inherited from: IIgrAnnotationLayerProps

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.

transitionDuration?: string | number

Optional transitionEasingFunction

Inherited from: IIgrAnnotationLayerProps

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.

transitionEasingFunction?: object

Optional transitionInDuration

Inherited from: IIgrAnnotationLayerProps

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.

transitionInDuration?: string | number

Optional transitionInEasingFunction

Inherited from: IIgrAnnotationLayerProps

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.

transitionInEasingFunction?: object

Optional transitionInSpeedType

Inherited from: IIgrAnnotationLayerProps

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.

transitionInSpeedType?: string | TransitionInSpeedType

Optional transitionOutCompleted

Inherited from: IIgrAnnotationLayerProps

Fired when a transition out has completed.

transitionOutCompleted?: object

Optional transitionOutDuration

Inherited from: IIgrAnnotationLayerProps

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

transitionOutDuration?: string | number

Optional transitionOutEasingFunction

Inherited from: IIgrAnnotationLayerProps

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

transitionOutEasingFunction?: object

Optional transitionOutSpeedType

Inherited from: IIgrAnnotationLayerProps

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

transitionOutSpeedType?: string | TransitionOutSpeedType

Optional unitsDisplayMode

Gets or sets the UnitsMode for the data legend.

unitsDisplayMode?: any

Optional unitsText

Gets or sets the units text for the data legend.

unitsText?: string

Optional unitsTextColor

Gets or sets the units text color.

unitsTextColor?: string

Optional unitsTextMarginBottom

unitsTextMarginBottom?: string | number

Optional unitsTextMarginLeft

unitsTextMarginLeft?: string | number

Optional unitsTextMarginRight

unitsTextMarginRight?: string | number

Optional unitsTextMarginTop

unitsTextMarginTop?: string | number

Optional unitsTextStyle

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

unitsTextStyle?: string

Optional useIndex

Inherited from: IIgrAnnotationLayerProps

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

useIndex?: string | boolean

Optional useInterpolation

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

useInterpolation?: string | boolean

Optional useItemWiseColors

Inherited from: IIgrAnnotationLayerProps

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

useItemWiseColors?: string | boolean

Optional useLegend

Inherited from: IIgrAnnotationLayerProps

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

useLegend?: string | boolean

Optional useSingleShadow

Inherited from: IIgrAnnotationLayerProps

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.

useSingleShadow?: string | boolean

Optional valueFormatAbbreviation

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

valueFormatAbbreviation?: any

Optional 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

valueFormatCulture?: string

Optional valueFormatMaxFractions

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

valueFormatMaxFractions?: string | number

Optional valueFormatMinFractions

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

valueFormatMinFractions?: string | number

Optional valueFormatMode

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

valueFormatMode?: any

Optional valueFormatSpecifiers

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

valueFormatSpecifiers?: any[]

Optional valueFormatString

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

valueFormatString?: string

Optional 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

valueFormatUseGrouping?: string | boolean

Optional valueRowMarginBottom

valueRowMarginBottom?: string | number

Optional valueRowMarginLeft

valueRowMarginLeft?: string | number

Optional valueRowMarginRight

valueRowMarginRight?: string | number

Optional valueRowMarginTop

valueRowMarginTop?: string | number

Optional valueRowVisible

Gets or sets whether to show series rows.

valueRowVisible?: string | boolean

Optional valueTextColor

Gets or sets the units text color.

valueTextColor?: string

Optional valueTextMarginBottom

valueTextMarginBottom?: string | number

Optional valueTextMarginLeft

valueTextMarginLeft?: string | number

Optional valueTextMarginRight

valueTextMarginRight?: string | number

Optional valueTextMarginTop

valueTextMarginTop?: string | number

Optional valueTextStyle

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

valueTextStyle?: string

Optional valueTextUseSeriesColors

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

valueTextUseSeriesColors?: string | boolean

Optional valueTextWhenMissingData

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

valueTextWhenMissingData?: string

Optional verticalAppearanceMode

Inherited from: IIgrAnnotationLayerProps

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

verticalAppearanceMode?: string | AnnotationAppearanceMode

Optional verticalDashArray

Inherited from: IIgrAnnotationLayerProps

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

verticalDashArray?: string | number[]

Optional verticalShiftAmount

Inherited from: IIgrAnnotationLayerProps

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

verticalShiftAmount?: string | number

Optional visibility

Inherited from: IIgrAnnotationLayerProps

visibility?: any

Optional visibleRangeMarginBottom

Inherited from: IIgrAnnotationLayerProps

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

visibleRangeMarginBottom?: string | number

Optional visibleRangeMarginLeft

Inherited from: IIgrAnnotationLayerProps

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

visibleRangeMarginLeft?: string | number

Optional visibleRangeMarginRight

Inherited from: IIgrAnnotationLayerProps

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

visibleRangeMarginRight?: string | number

Optional visibleRangeMarginTop

Inherited from: IIgrAnnotationLayerProps

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

visibleRangeMarginTop?: string | number

Optional visibleRangeMode

Inherited from: IIgrAnnotationLayerProps

Gets or sets the visible range mode to use.

visibleRangeMode?: string | SeriesVisibleRangeMode