IIgrValueLayerProps

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

Gets the effective brush for the current value layer. Can be null for value modes that target multiple series.

actualValueLayerBrush?: string

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

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

Gets or sets the color to use for the horizontal line. Leave null for an automatic value.

horizontalLineStroke?: string

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

Gets or sets whether to draw annotations over the axes where the crosshair meets with them.

isAxisAnnotationEnabled?: 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 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 overlayText

Gets or sets the text that will be displayed as the overlay annotation.

overlayText?: string

Optional overlayTextAngle

Gets or sets the angle rotation (in degrees) of the overlay text in relation to shape of data annotation.

overlayTextAngle?: string | number

Optional overlayTextBackground

Gets or sets the background the overlay text.

overlayTextBackground?: string

Optional overlayTextBackgroundMatchLayer

Gets or sets whether the overlay text background matches brush of the layer

overlayTextBackgroundMatchLayer?: string | boolean

Optional overlayTextBackgroundMode

Gets or sets the mode used for shifting the background of overlay text based on the target series.

overlayTextBackgroundMode?: string | AnnotationAppearanceMode

Optional overlayTextBackgroundShift

Gets or sets the shift of the overlay background based on OverlayTextBackgroundMode. Value must range between -1.0 to 1.0, where 0 means no color shift.

overlayTextBackgroundShift?: string | number

Optional overlayTextBorderColor

Gets or sets the border stroke of the overlay text.

overlayTextBorderColor?: string

Optional overlayTextBorderMatchLayer

Gets or sets whether the overlay text border matches brush of the layer

overlayTextBorderMatchLayer?: string | boolean

Optional overlayTextBorderMode

Gets or sets the mode used for shifting the border of overlay text based on the target series.

overlayTextBorderMode?: string | AnnotationAppearanceMode

Optional overlayTextBorderRadius

Gets or sets the border corner of the overlay text.

overlayTextBorderRadius?: string | number

Optional overlayTextBorderShift

Gets or sets the shift of the overlay border based on OverlayTextBorderMode. Value must range between -1.0 to 1.0, where 0 means no color shift.

overlayTextBorderShift?: string | number

Optional overlayTextBorderThickness

Gets or sets the border thickness of the overlay text.

overlayTextBorderThickness?: string | number

Optional overlayTextColor

Gets or sets the color the overlay text.

overlayTextColor?: string

Optional overlayTextColorMatchLayer

Gets or sets whether the overlay text color matches brush of the layer

overlayTextColorMatchLayer?: string | boolean

Optional overlayTextColorMode

Gets or sets the mode used for shifting the background of overlay text based on the target series.

overlayTextColorMode?: string | AnnotationAppearanceMode

Optional overlayTextColorShift

Gets or sets the shift of the overlay text color based on OverlayTextColorMode. Value must range between -1.0 to 1.0, where 0 means no color shift.

overlayTextColorShift?: string | number

Optional overlayTextHorizontalMargin

Gets or sets the horizontal margin of the overlay text in relation to shape of data annotation.

overlayTextHorizontalMargin?: string | number

Optional overlayTextHorizontalPadding

Gets or sets the horizontal padding of the overlay text in relation to shape of data annotation.

overlayTextHorizontalPadding?: string | number

Optional overlayTextLocation

Gets or sets location of the overlay text in relation to shape of data annotation.

overlayTextLocation?: string | OverlayTextLocation

Optional overlayTextStyle

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

overlayTextStyle?: string

Optional overlayTextVerticalMargin

Gets or sets the vertical margin of the overlay text in relation to shape of data annotation.

overlayTextVerticalMargin?: string | number

Optional overlayTextVerticalPadding

Gets or sets the vertical padding of the overlay text in relation to shape of data annotation.

overlayTextVerticalPadding?: string | number

Optional overlayTextVisible

Gets or sets whether the overlay text is visible in shape of data annotation

overlayTextVisible?: string | boolean

Optional percentChange

Inherited from: IIgrAnnotationLayerProps

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

percentChange?: 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 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 skipUnknownValues

Gets or sets whether to skip unknown values when searching for series values.

skipUnknownValues?: string | boolean

Optional stylingOverlayText

Event raised when updating style of overlay text

stylingOverlayText?: object

Optional targetAxis

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

targetAxis?: IgrAxis

Optional targetAxisName

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

targetAxisName?: string

Optional targetSeries

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

targetSeries?: IgrSeries

Optional targetSeriesName

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

targetSeriesName?: 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 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 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 a line through the best value for the cursor position.

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 valueMode

Gets or sets the value mode for the overlay.

valueMode?: string | ValueLayerValueMode

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 verticalLineStroke

Gets or sets the color to use for vertical line. Leave null for an automatic value.

verticalLineStroke?: string

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

Optional xAxisAnnotationBackground

Gets or sets the color to use for the x axis annotation backing. Leave unset for an automatic value.

xAxisAnnotationBackground?: string

Optional xAxisAnnotationBackgroundCornerRadius

Gets or sets the corner radius to use for the x axis annotation backing. Leave unset for an automatic value.

xAxisAnnotationBackgroundCornerRadius?: string | number

Optional xAxisAnnotationFormatLabel

Sets or gets a function which takes an object that produces a formatted label for the x axis annotation.

xAxisAnnotationFormatLabel?: object

Optional xAxisAnnotationInterpolatedValuePrecision

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

xAxisAnnotationInterpolatedValuePrecision?: string | number

Optional xAxisAnnotationOutline

Gets or sets the color to use for the x axis annotation outline. Leave unset for an automatic value.

xAxisAnnotationOutline?: string

Optional xAxisAnnotationPaddingBottom

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

xAxisAnnotationPaddingBottom?: string | number

Optional xAxisAnnotationPaddingLeft

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

xAxisAnnotationPaddingLeft?: string | number

Optional xAxisAnnotationPaddingRight

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

xAxisAnnotationPaddingRight?: string | number

Optional xAxisAnnotationPaddingTop

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

xAxisAnnotationPaddingTop?: string | number

Optional xAxisAnnotationStrokeThickness

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

xAxisAnnotationStrokeThickness?: string | number

Optional xAxisAnnotationTextColor

Gets or sets the color to use for the x axis annotation text. Leave unset for an automatic value.

xAxisAnnotationTextColor?: string

Optional yAxisAnnotationBackground

Gets or sets the color to use for the y axis annotation backing. Leave unset for an automatic value.

yAxisAnnotationBackground?: string

Optional yAxisAnnotationBackgroundCornerRadius

Gets or sets the corner radius to use for the y axis annotation backing. Leave unset for an automatic value.

yAxisAnnotationBackgroundCornerRadius?: string | number

Optional yAxisAnnotationFormatLabel

Sets or gets a function which takes an object that produces a formatted label for the y axis annotation.

yAxisAnnotationFormatLabel?: object

Optional yAxisAnnotationInterpolatedValuePrecision

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

yAxisAnnotationInterpolatedValuePrecision?: string | number

Optional yAxisAnnotationOutline

Gets or sets the color to use for the y axis annotation outline. Leave unset for an automatic value.

yAxisAnnotationOutline?: string

Optional yAxisAnnotationPaddingBottom

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

yAxisAnnotationPaddingBottom?: string | number

Optional yAxisAnnotationPaddingLeft

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

yAxisAnnotationPaddingLeft?: string | number

Optional yAxisAnnotationPaddingRight

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

yAxisAnnotationPaddingRight?: string | number

Optional yAxisAnnotationPaddingTop

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

yAxisAnnotationPaddingTop?: string | number

Optional yAxisAnnotationStrokeThickness

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

yAxisAnnotationStrokeThickness?: string | number

Optional yAxisAnnotationTextColor

Gets or sets the color to use for the y axis annotation text. Leave unset for an automatic value.

yAxisAnnotationTextColor?: string