IIgrCalloutLayerProps

Optional actualAppearanceMode

Section titled "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

Section titled "actualAreaFillOpacity"

Inherited from: IIgrAnnotationLayerProps

Gets the actual opacity applied to the area fill visual.

``

actualAreaFillOpacity?: string | number

Optional actualBrush

Section titled "actualBrush"

Inherited from: IIgrAnnotationLayerProps

Gets the effective brush for the current series object.

``

actualBrush?: string

Optional actualDashArray

Section titled "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

Section titled "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

Section titled "actualFocusBrush"

Inherited from: IIgrAnnotationLayerProps

Gets the effective emphasis brush for the current series object.

actualFocusBrush?: string

Optional actualFocusMode

Section titled "actualFocusMode"

Inherited from: IIgrAnnotationLayerProps

Gets actual Selection mode

actualFocusMode?: string | SeriesSelectionMode

Optional actualHighlightedValuesFadeOpacity

Section titled "actualHighlightedValuesFadeOpacity"

Inherited from: IIgrAnnotationLayerProps

Gets actual HighlightedValues fade opacity

actualHighlightedValuesFadeOpacity?: string | number

Optional actualHighlightingFadeOpacity

Section titled "actualHighlightingFadeOpacity"

Inherited from: IIgrAnnotationLayerProps

Gets actual highlighting fade opacity

actualHighlightingFadeOpacity?: string | number

Optional actualHighlightingMode

Section titled "actualHighlightingMode"

Inherited from: IIgrAnnotationLayerProps

Gets actual highlighting mode

actualHighlightingMode?: string | SeriesHighlightingMode

Optional actualHitTestMode

Section titled "actualHitTestMode"

Inherited from: IIgrAnnotationLayerProps

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

``

actualHitTestMode?: string | SeriesHitTestMode

Optional actualHorizontalAppearanceMode

Section titled "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

Section titled "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

Section titled "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

Section titled "actualLegendItemBadgeBrush"

Inherited from: IIgrAnnotationLayerProps

Gets the effective legend badge fill for the current series.

actualLegendItemBadgeBrush?: string

Optional actualLegendItemBadgeOutline

Section titled "actualLegendItemBadgeOutline"

Inherited from: IIgrAnnotationLayerProps

Gets the effective legend badge outline for the current series.

actualLegendItemBadgeOutline?: string

Optional actualLegendItemBadgeTemplate

Section titled "actualLegendItemBadgeTemplate"

Inherited from: IIgrAnnotationLayerProps

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

actualLegendItemBadgeTemplate?: IgDataTemplate

Optional actualMarkerFillOpacity

Section titled "actualMarkerFillOpacity"

Inherited from: IIgrAnnotationLayerProps

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

actualMarkerFillOpacity?: string | number

Optional actualOutline

Section titled "actualOutline"

Inherited from: IIgrAnnotationLayerProps

Gets the effective outline for the current series object.

``

actualOutline?: string

Optional actualResolution

Section titled "actualResolution"

Inherited from: IIgrAnnotationLayerProps

actualResolution?: string | number

Optional actualSelectionBrush

Section titled "actualSelectionBrush"

Inherited from: IIgrAnnotationLayerProps

Gets the effective emphasis brush for the current series object.

actualSelectionBrush?: string

Optional actualSelectionMode

Section titled "actualSelectionMode"

Inherited from: IIgrAnnotationLayerProps

Gets actual Selection mode

actualSelectionMode?: string | SeriesSelectionMode

Optional actualShiftAmount

Section titled "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

Section titled "actualThickness"

Inherited from: IIgrAnnotationLayerProps

Gets the effective Thickness for the current series object.

actualThickness?: string | number

Optional actualVerticalAppearanceMode

Section titled "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

Section titled "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

Section titled "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 allowedPositions

Section titled "allowedPositions"

Gets or sets the allowed positions that the callout layer is allowed to use.

allowedPositions?: string | IgrCalloutPlacementPositionsCollection

Optional appearanceMode

Section titled "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

Section titled "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

Section titled "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

Section titled "autoCalloutLabelFormat"

Inherited from: IIgrAnnotationLayerProps

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

autoCalloutLabelFormat?: string

Optional autoCalloutLabelFormatSpecifiers

Section titled "autoCalloutLabelFormatSpecifiers"

Inherited from: IIgrAnnotationLayerProps

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

autoCalloutLabelFormatSpecifiers?: any[]

Optional autoCalloutLabelPrecision

Section titled "autoCalloutLabelPrecision"

Gets or sets the precision to use when values are used for the auto callout labels.

autoCalloutLabelPrecision?: string | number

Optional autoCalloutValueLabelFormat

Section titled "autoCalloutValueLabelFormat"

Inherited from: IIgrAnnotationLayerProps

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

autoCalloutValueLabelFormat?: string

Optional autoCalloutValueLabelFormatSpecifiers

Section titled "autoCalloutValueLabelFormatSpecifiers"

Inherited from: IIgrAnnotationLayerProps

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

autoCalloutValueLabelFormatSpecifiers?: any[]

Optional autoCalloutVisibilityMode

Section titled "autoCalloutVisibilityMode"

Gets or sets the rules for when the callouts should be visible.

autoCalloutVisibilityMode?: string | AutoCalloutVisibilityMode

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 calloutBackground

Section titled "calloutBackground"

Gets or sets the brush that specifies how the backgrounds for the callouts of the layer are painted. Leave unset for an automatic value.

calloutBackground?: string

Optional calloutBadgeBackground

Section titled "calloutBadgeBackground"

Gets or sets the badge background in callout annotation.

calloutBadgeBackground?: string

Optional calloutBadgeCorner

Section titled "calloutBadgeCorner"

Gets or sets the corner radius of badge in callout annotation

calloutBadgeCorner?: string | number

Optional calloutBadgeGap

Section titled "calloutBadgeGap"

Gets or sets the gap between badge and text in callout annotation

calloutBadgeGap?: string | number

Optional calloutBadgeHeight

Section titled "calloutBadgeHeight"

Gets or sets the the badge height in callout annotation.

calloutBadgeHeight?: string | number

Optional calloutBadgeImageMemberPath

Section titled "calloutBadgeImageMemberPath"

Gets or sets the mapping property for an image displayed in the badge of callout annotation Examples #1: "DataColumnName" that contains full URL to an image: https://dl.infragistics.com/x/img/flags/USA.png Examples #2: "https://dl.infragistics.com/x/img/flags/{ISO3}.png" where "ISO3" is name of data column that contains image name: USA

calloutBadgeImageMemberPath?: string

Optional calloutBadgeMatchSeries

Section titled "calloutBadgeMatchSeries"

Gets or sets whether or not the callout badge matches appearance of target series.

calloutBadgeMatchSeries?: string | boolean

Optional calloutBadgeOutline

Section titled "calloutBadgeOutline"

Gets or sets the badge outline in callout annotation.

calloutBadgeOutline?: string

Optional calloutBadgeThickness

Section titled "calloutBadgeThickness"

Gets or sets the the badge thickness in callout annotation.

calloutBadgeThickness?: string | number

Optional calloutBadgeVisible

Section titled "calloutBadgeVisible"

Gets or sets the badge is visible in callout annotation.

calloutBadgeVisible?: string | boolean

Optional calloutBadgeWidth

Section titled "calloutBadgeWidth"

Gets or sets the the badge width in callout annotation.

calloutBadgeWidth?: string | number

Optional calloutCollisionMode

Section titled "calloutCollisionMode"

Gets or sets the strategy to use for avoiding collisions between the callouts in this layer. Leave unset for an automatic value.

calloutCollisionMode?: any

Optional calloutContentUpdating

Section titled "calloutContentUpdating"

Raised to allow you to decide on the content for an automatically created callout.

calloutContentUpdating?: object

Optional calloutCornerRadius

Section titled "calloutCornerRadius"

Gets or sets the corner radius to use for the callout borders.

calloutCornerRadius?: string | number

Optional calloutDarkTextColor

Section titled "calloutDarkTextColor"

Gets or sets the dark color to use for the callout text. Leave unset for an automatic value.

calloutDarkTextColor?: string

Optional calloutExpandsAxisBufferEnabled

Section titled "calloutExpandsAxisBufferEnabled"

Gets or sets whether or not callouts expand axis buffer for extra space for their render around data points.

calloutExpandsAxisBufferEnabled?: string | boolean

Optional calloutExpandsAxisBufferMaxHeight

Section titled "calloutExpandsAxisBufferMaxHeight"

Gets or sets the maximum vertical axis buffer for positioning callouts. This property takes precedence over the CalloutExpandsAxisBufferMinHeight property.

calloutExpandsAxisBufferMaxHeight?: string | number

Optional calloutExpandsAxisBufferMaxWidth

Section titled "calloutExpandsAxisBufferMaxWidth"

Gets or sets the maximum horizontal axis buffer for positioning callouts. This property takes precedence over the CalloutExpandsAxisBufferMinWidth property.

calloutExpandsAxisBufferMaxWidth?: string | number

Optional calloutExpandsAxisBufferMinHeight

Section titled "calloutExpandsAxisBufferMinHeight"

Gets or sets the minimum vertical axis buffer for positioning callouts. This property does not take precedence over the CalloutExpandsAxisBufferMaxHeight property.

calloutExpandsAxisBufferMinHeight?: string | number

Optional calloutExpandsAxisBufferMinWidth

Section titled "calloutExpandsAxisBufferMinWidth"

Gets or sets the minimum horizontal axis buffer for positioning callouts. This property does not take precedence over the CalloutExpandsAxisBufferMaxWidth property.

calloutExpandsAxisBufferMinWidth?: string | number

Optional calloutExpandsAxisBufferOnInitialVisibility

Section titled "calloutExpandsAxisBufferOnInitialVisibility"

Gets or sets whether or not recalculate callouts expand axis buffer on rendering frame. This property is not used when the CalloutExpandsAxisBufferEnabled property is false or AutoCalloutVisibilityMode is not Dedicated.

calloutExpandsAxisBufferOnInitialVisibility?: string | boolean

Optional calloutExpandsAxisBufferOnlyWhenVisible

Section titled "calloutExpandsAxisBufferOnlyWhenVisible"

Gets or sets whether or not callouts expand axis buffer only when callouts are visible in the chart. This property is not used when the CalloutExpandsAxisBufferEnabled property is false or AutoCalloutVisibilityMode is not Dedicated.

calloutExpandsAxisBufferOnlyWhenVisible?: string | boolean

Optional calloutInterpolatedValuePrecision

Section titled "calloutInterpolatedValuePrecision"

Gets or sets the precision to use displaying values for interpolated crosshair positions.

calloutInterpolatedValuePrecision?: string | number

Optional calloutLabelUpdating

Section titled "calloutLabelUpdating"

Raised to allow you to decide on the label for an automatically created callout.

calloutLabelUpdating?: object

Optional calloutLeaderBrush

Section titled "calloutLeaderBrush"

Gets or sets the brush that specifies how the leader lines for the callouts of the layer are painted.

calloutLeaderBrush?: string

Optional calloutLightTextColor

Section titled "calloutLightTextColor"

Gets or sets the light color to use for the callout text. Leave unset for an automatic value.

calloutLightTextColor?: string

Optional calloutOutline

Section titled "calloutOutline"

Gets or sets the brush that specifies how the outlines for the callouts of the layer are painted.

calloutOutline?: string

Optional calloutPaddingBottom

Section titled "calloutPaddingBottom"

Gets or sets the bottom padding to use within the callout. Leaving this NaN will use an automatic value related to the axis label margins.

calloutPaddingBottom?: string | number

Optional calloutPaddingLeft

Section titled "calloutPaddingLeft"

Gets or sets the left padding to use withing the callout. Leaving this NaN will use an automatic value related to the axis label margins.

calloutPaddingLeft?: string | number

Optional calloutPaddingRight

Section titled "calloutPaddingRight"

Gets or sets the right padding to use within the callout. Leaving this NaN will use an automatic value related to the axis label margins.

calloutPaddingRight?: string | number

Optional calloutPaddingTop

Section titled "calloutPaddingTop"

Gets or sets the top padding to use within the callout. Leaving this NaN will use an automatic value related to the axis label margins.

calloutPaddingTop?: string | number

Optional calloutPositionPadding

Section titled "calloutPositionPadding"

Gets or sets the padding to add to the callout positioning. Leave unset for an automatic value.

calloutPositionPadding?: string | number

Optional calloutRenderStyleUpdating

Section titled "calloutRenderStyleUpdating"

Event raised when updating style of callout layer

calloutRenderStyleUpdating?: object

Optional calloutSeriesSelecting

Section titled "calloutSeriesSelecting"

Raised to allow you to select a target series for a data bound callout.

calloutSeriesSelecting?: object

Optional calloutStrokeThickness

Section titled "calloutStrokeThickness"

Gets or sets the stroke thickness for the callout backing. Leave unset for an automatic value.

calloutStrokeThickness?: string | number

Optional calloutStyleUpdating

Section titled "calloutStyleUpdating"

Event raised when updating style of callout layer

calloutStyleUpdating?: object

Optional calloutSuspendedWhenShiftingToVisible

Section titled "calloutSuspendedWhenShiftingToVisible"

Gets or sets whether or not suspend refresh of callouts while they shift from hidden to visible

calloutSuspendedWhenShiftingToVisible?: string | boolean

Optional calloutTextColor

Section titled "calloutTextColor"

Gets or sets the color to use for the callout text. Leave unset for an automatic value.

calloutTextColor?: string

Optional children

Section titled "children"

Inherited from: IIgrAnnotationLayerProps

children?: ReactNode

Optional coercionMethods

Section titled "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 collisionChannel

Section titled "collisionChannel"

Gets or sets a channel name to identify other callout layers within the chart to share collision information with.

collisionChannel?: string

Optional contentMemberPath

Section titled "contentMemberPath"

Gets or sets the content mapping property for the callouts.

contentMemberPath?: string

Optional cursorPosition

Section titled "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

Section titled "cursorPositionUpdatesOnMove"

Inherited from: IIgrAnnotationLayerProps

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

cursorPositionUpdatesOnMove?: string | boolean

Optional dashArray

Section titled "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

Section titled "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

Section titled "dataSource"

Inherited from: IIgrAnnotationLayerProps

dataSource?: any

Optional discreteLegendItemTemplate

Section titled "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 expectFunctions

Section titled "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

Section titled "finalValue"

Inherited from: IIgrAnnotationLayerProps

The final value of this series.

finalValue?: string | number

Optional focusBrush

Section titled "focusBrush"

Inherited from: IIgrAnnotationLayerProps

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

focusBrush?: string

Optional highlightedDataSource

Section titled "highlightedDataSource"

Inherited from: IIgrAnnotationLayerProps

highlightedDataSource?: any

Optional highlightedLegendItemVisibility

Section titled "highlightedLegendItemVisibility"

Inherited from: IIgrAnnotationLayerProps

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

highlightedLegendItemVisibility?: any

Optional highlightedTitleSuffix

Section titled "highlightedTitleSuffix"

Inherited from: IIgrAnnotationLayerProps

Gets or sets the HighlightedTitleSuffix property.

highlightedTitleSuffix?: string

Optional highlightedValueLabelMode

Section titled "highlightedValueLabelMode"

Gets or sets whether to use values, rather than labels for auto callout labels.

highlightedValueLabelMode?: any

Optional highlightedValuesDataLegendGroup

Section titled "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

Section titled "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

Section titled "highlightedValuesFadeOpacity"

Inherited from: IIgrAnnotationLayerProps

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

highlightedValuesFadeOpacity?: string | number

Optional highlightingFadeOpacity

Section titled "highlightingFadeOpacity"

Inherited from: IIgrAnnotationLayerProps

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

highlightingFadeOpacity?: string | number

Optional hitTestMode

Section titled "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

Section titled "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

Section titled "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

Section titled "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

Inherited from: IIgrAnnotationLayerProps

Gets the Index property.

index?: string | number

Optional isActualLegendFinancial

Section titled "isActualLegendFinancial"

Inherited from: IIgrAnnotationLayerProps

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

isActualLegendFinancial?: string | boolean

Optional isAutoCalloutBehaviorEnabled

Section titled "isAutoCalloutBehaviorEnabled"

Gets or sets how to select the final value to annotate.

isAutoCalloutBehaviorEnabled?: string | boolean

Optional isCalloutOffsettingEnabled

Section titled "isCalloutOffsettingEnabled"

Gets or sets whether to allow the callouts to be variable distances from the target points, for supporting collision modes.

isCalloutOffsettingEnabled?: string | boolean

Optional isComponentHighlightingModeIgnored

Section titled "isComponentHighlightingModeIgnored"

Inherited from: IIgrAnnotationLayerProps

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

isComponentHighlightingModeIgnored?: string | boolean

Optional isCustomCalloutRenderStyleEnabled

Section titled "isCustomCalloutRenderStyleEnabled"

Gets or sets whether to allow for custom callout styles.

isCustomCalloutRenderStyleEnabled?: string | boolean

Optional isCustomCalloutStyleEnabled

Section titled "isCustomCalloutStyleEnabled"

Gets or sets whether to allow for custom callout styles.

isCustomCalloutStyleEnabled?: string | boolean

Optional isDefaultCrosshairDisabled

Section titled "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

Section titled "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

Section titled "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

Section titled "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 keyMemberPath

Section titled "keyMemberPath"

Gets or sets the key mapping property for the callouts.

keyMemberPath?: string

Optional labelFormat

Section titled "labelFormat"

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

labelFormat?: string

Optional labelFormatSpecifiers

Section titled "labelFormatSpecifiers"

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

labelFormatSpecifiers?: any[]

Optional labelMemberPath

Section titled "labelMemberPath"

Gets or sets the label mapping property for the callouts.

labelMemberPath?: string

Inherited from: IIgrAnnotationLayerProps

Gets or sets the legend used for the current series.

legend?: any

Optional legendItemBadgeMode

Section titled "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

Section titled "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

Section titled "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

Section titled "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

Section titled "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

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

Section titled "lineJoin"

Inherited from: IIgrAnnotationLayerProps

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

lineJoin?: any

Optional markerFillOpacity

Section titled "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

Section titled "mouseOverEnabled"

Inherited from: IIgrAnnotationLayerProps

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

mouseOverEnabled?: string | boolean

Inherited from: IIgrAnnotationLayerProps

Sets or gets a required unique name for the series.

name: string

Inherited from: IIgrAnnotationLayerProps

opacity?: string | number

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

Section titled "outlineMode"

Inherited from: IIgrAnnotationLayerProps

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

outlineMode?: string | SeriesOutlineMode

Optional percentChange

Section titled "percentChange"

Inherited from: IIgrAnnotationLayerProps

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

percentChange?: string | number

Optional renderRequested

Section titled "renderRequested"

Inherited from: IIgrAnnotationLayerProps

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

``

``

renderRequested?: object

Optional resolution

Section titled "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

Section titled "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

Section titled "selectionBrush"

Inherited from: IIgrAnnotationLayerProps

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

selectionBrush?: string

Optional selectionThickness

Section titled "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

Section titled "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

Section titled "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

Section titled "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

Section titled "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

Section titled "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

Section titled "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

Section titled "shouldHideAutoCallouts"

Inherited from: IIgrAnnotationLayerProps

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

shouldHideAutoCallouts?: string | boolean

Optional shouldRemoveHighlightedDataOnLayerHidden

Section titled "shouldRemoveHighlightedDataOnLayerHidden"

Inherited from: IIgrAnnotationLayerProps

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

shouldRemoveHighlightedDataOnLayerHidden?: string | boolean

Optional shouldRenderAsOverlay

Section titled "shouldRenderAsOverlay"

Inherited from: IIgrAnnotationLayerProps

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

shouldRenderAsOverlay?: string | boolean

Optional shouldShiftOpacityForSafeActualBrush

Section titled "shouldShiftOpacityForSafeActualBrush"

Inherited from: IIgrAnnotationLayerProps

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

shouldShiftOpacityForSafeActualBrush?: string | boolean

Optional shouldTruncateOnBoundaryCollisions

Section titled "shouldTruncateOnBoundaryCollisions"

Gets or sets whether the callouts that collide with the boundary should be truncated.

shouldTruncateOnBoundaryCollisions?: string | boolean

Optional showDefaultTooltip

Section titled "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 targetSeries

Section titled "targetSeries"

Gets or sets the series to target this annotation to. If null, this annotation targets all series simultaneously.

targetSeries?: IgrSeries

Optional targetSeriesName

Section titled "targetSeriesName"

Gets or sets the name of the series series to target this annotation to. If null, this annotation targets all series simultaneously.

targetSeriesName?: string

Optional textStyle

Section titled "textStyle"

Gets or sets the stroke thickness for the axis annotation backing. Leave unset for an automatic value.

textStyle?: string

Optional thickness

Section titled "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

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 tooltipTemplate

Section titled "tooltipTemplate"

Inherited from: IIgrAnnotationLayerProps

tooltipTemplate?: any

Optional transitionDuration

Section titled "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

Section titled "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

Section titled "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

Section titled "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

Section titled "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

Section titled "transitionOutCompleted"

Inherited from: IIgrAnnotationLayerProps

Fired when a transition out has completed.

transitionOutCompleted?: object

Optional transitionOutDuration

Section titled "transitionOutDuration"

Inherited from: IIgrAnnotationLayerProps

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

transitionOutDuration?: string | number

Optional transitionOutEasingFunction

Section titled "transitionOutEasingFunction"

Inherited from: IIgrAnnotationLayerProps

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

transitionOutEasingFunction?: object

Optional transitionOutSpeedType

Section titled "transitionOutSpeedType"

Inherited from: IIgrAnnotationLayerProps

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

transitionOutSpeedType?: string | TransitionOutSpeedType

Optional useAutoContrastingLabelColors

Section titled "useAutoContrastingLabelColors"

Gets or sets whether to the label color is automatically decided between a light and dark option for contrast.

useAutoContrastingLabelColors?: string | boolean

Optional useIndex

Section titled "useIndex"

Inherited from: IIgrAnnotationLayerProps

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

useIndex?: string | boolean

Optional useInterpolatedValueForAutoCalloutLabels

Section titled "useInterpolatedValueForAutoCalloutLabels"

Gets or sets whether to use values, rather than labels for auto callout labels.

useInterpolatedValueForAutoCalloutLabels?: string | boolean

Optional useItemColorForFill

Section titled "useItemColorForFill"

Gets or sets whether to the series color as the outline of the callout.

useItemColorForFill?: string | boolean

Optional useItemColorForOutline

Section titled "useItemColorForOutline"

Gets or sets whether to the series item color as the outline of the callout.

useItemColorForOutline?: string | boolean

Optional useItemWiseColors

Section titled "useItemWiseColors"

Inherited from: IIgrAnnotationLayerProps

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

useItemWiseColors?: string | boolean

Optional useLegend

Section titled "useLegend"

Inherited from: IIgrAnnotationLayerProps

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

useLegend?: string | boolean

Optional useSeriesColorForOutline

Section titled "useSeriesColorForOutline"

Gets or sets whether to the series color as the outline of the callout.

useSeriesColorForOutline?: string | boolean

Optional useSingleShadow

Section titled "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 useValueForAutoCalloutLabels

Section titled "useValueForAutoCalloutLabels"

Gets or sets whether to use values, rather than labels for auto callout labels.

useValueForAutoCalloutLabels?: string | boolean

Optional verticalAppearanceMode

Section titled "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

Section titled "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

Section titled "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

Section titled "visibility"

Inherited from: IIgrAnnotationLayerProps

visibility?: any

Optional visibleRangeMarginBottom

Section titled "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

Section titled "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

Section titled "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

Section titled "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

Section titled "visibleRangeMode"

Inherited from: IIgrAnnotationLayerProps

Gets or sets the visible range mode to use.

visibleRangeMode?: string | SeriesVisibleRangeMode

Optional xMemberPath

Section titled "xMemberPath"

Gets or sets the label mapping property for the callouts.

xMemberPath?: string

Optional yMemberPath

Section titled "yMemberPath"

Gets or sets the label mapping property for the callouts.

yMemberPath?: string