IIgrUserAnnotationLayerProps
Properties
Section titled "Properties"Optional actualAreaFillOpacity
Section titled "actualAreaFillOpacity"Inherited from: IIgrSeriesProps
Gets the actual opacity applied to the area fill visual.
``
actualAreaFillOpacity?: string | number Optional actualBrush
Section titled "actualBrush"Inherited from: IIgrSeriesProps
Gets the effective brush for the current series object.
``
actualBrush?: string Optional actualFocusBrush
Section titled "actualFocusBrush"Inherited from: IIgrSeriesProps
Gets the effective emphasis brush for the current series object.
actualFocusBrush?: string Optional actualFocusMode
Section titled "actualFocusMode"Inherited from: IIgrSeriesProps
Gets actual Selection mode
actualFocusMode?: string | SeriesSelectionMode Optional actualHighlightedValuesFadeOpacity
Section titled "actualHighlightedValuesFadeOpacity"Inherited from: IIgrSeriesProps
Gets actual HighlightedValues fade opacity
actualHighlightedValuesFadeOpacity?: string | number Optional actualHighlightingFadeOpacity
Section titled "actualHighlightingFadeOpacity"Inherited from: IIgrSeriesProps
Gets actual highlighting fade opacity
actualHighlightingFadeOpacity?: string | number Optional actualHighlightingMode
Section titled "actualHighlightingMode"Inherited from: IIgrSeriesProps
Gets actual highlighting mode
actualHighlightingMode?: string | SeriesHighlightingMode Optional actualHitTestMode
Section titled "actualHitTestMode"Inherited from: IIgrSeriesProps
Resolved method of hit testing to use when pointing to items in the chart.
``
actualHitTestMode?: string | SeriesHitTestMode Optional actualLegendItemBadgeBrush
Section titled "actualLegendItemBadgeBrush"Inherited from: IIgrSeriesProps
Gets the effective legend badge fill for the current series.
actualLegendItemBadgeBrush?: string Optional actualLegendItemBadgeOutline
Section titled "actualLegendItemBadgeOutline"Inherited from: IIgrSeriesProps
Gets the effective legend badge outline for the current series.
actualLegendItemBadgeOutline?: string Optional actualLegendItemBadgeTemplate
Section titled "actualLegendItemBadgeTemplate"Inherited from: IIgrSeriesProps
Gets the actual legend item badge template used by the series.
actualLegendItemBadgeTemplate?: IgDataTemplate Optional actualMarkerFillOpacity
Section titled "actualMarkerFillOpacity"Inherited from: IIgrSeriesProps
Gets the actual opacity applied to the fill of the markers.
actualMarkerFillOpacity?: string | number Optional actualOutline
Section titled "actualOutline"Inherited from: IIgrSeriesProps
Gets the effective outline for the current series object.
``
actualOutline?: string Optional actualResolution
Section titled "actualResolution"Inherited from: IIgrSeriesProps
actualResolution?: string | number Optional actualSelectionBrush
Section titled "actualSelectionBrush"Inherited from: IIgrSeriesProps
Gets the effective emphasis brush for the current series object.
actualSelectionBrush?: string Optional actualSelectionMode
Section titled "actualSelectionMode"Inherited from: IIgrSeriesProps
Gets actual Selection mode
actualSelectionMode?: string | SeriesSelectionMode Optional actualThickness
Section titled "actualThickness"Inherited from: IIgrSeriesProps
Gets the effective Thickness for the current series object.
actualThickness?: string | number Optional areaFillOpacity
Section titled "areaFillOpacity"Inherited from: IIgrSeriesProps
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: IIgrSeriesProps
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: IIgrSeriesProps
Gets or sets the AutoCalloutLabel format string to use for the AutoCalloutLabel.
autoCalloutLabelFormat?: string Optional autoCalloutLabelFormatSpecifiers
Section titled "autoCalloutLabelFormatSpecifiers"Inherited from: IIgrSeriesProps
Gets or sets the format specifiers to use with the AutoCalloutLabelFormat string.
autoCalloutLabelFormatSpecifiers?: any[] Optional autoCalloutValueLabelFormat
Section titled "autoCalloutValueLabelFormat"Inherited from: IIgrSeriesProps
Gets or sets the AutoCalloutLabel format string to use for the AutoCalloutLabel.
autoCalloutValueLabelFormat?: string Optional autoCalloutValueLabelFormatSpecifiers
Section titled "autoCalloutValueLabelFormatSpecifiers"Inherited from: IIgrSeriesProps
Gets or sets the format specifiers to use with the AutoCalloutValueLabelFormat string.
autoCalloutValueLabelFormatSpecifiers?: any[] Optional brush
Section titled "brush"Inherited from: IIgrSeriesProps
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
Section titled "children"Inherited from: IIgrSeriesProps
children?: ReactNode Optional coercionMethods
Section titled "coercionMethods"Inherited from: IIgrSeriesProps
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 dashArray
Section titled "dashArray"Inherited from: IIgrSeriesProps
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: IIgrSeriesProps
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: IIgrSeriesProps
dataSource?: any Optional discreteLegendItemTemplate
Section titled "discreteLegendItemTemplate"Inherited from: IIgrSeriesProps
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: IIgrSeriesProps
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: IIgrSeriesProps
The final value of this series.
finalValue?: string | number Optional focusBrush
Section titled "focusBrush"Inherited from: IIgrSeriesProps
Gets or sets the Focus brush to use for the series.
focusBrush?: string Optional highlightedDataSource
Section titled "highlightedDataSource"Inherited from: IIgrSeriesProps
highlightedDataSource?: any Optional highlightedLegendItemVisibility
Section titled "highlightedLegendItemVisibility"Inherited from: IIgrSeriesProps
Gets or sets whether the highlighted values layer should have a legend item.
highlightedLegendItemVisibility?: any Optional highlightedTitleSuffix
Section titled "highlightedTitleSuffix"Inherited from: IIgrSeriesProps
Gets or sets the HighlightedTitleSuffix property.
highlightedTitleSuffix?: string Optional highlightedValuesDataLegendGroup
Section titled "highlightedValuesDataLegendGroup"Inherited from: IIgrSeriesProps
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: IIgrSeriesProps
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: IIgrSeriesProps
Gets or sets the target opacity to fade to for fade style HighlightedValues.
highlightedValuesFadeOpacity?: string | number Optional highlightingFadeOpacity
Section titled "highlightingFadeOpacity"Inherited from: IIgrSeriesProps
Gets or sets the target opacity to fade to for fade style highlighting.
highlightingFadeOpacity?: string | number Optional hitTestMode
Section titled "hitTestMode"Inherited from: IIgrSeriesProps
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 index
Section titled "index"Inherited from: IIgrSeriesProps
Gets the Index property.
index?: string | number Optional isActualLegendFinancial
Section titled "isActualLegendFinancial"Inherited from: IIgrSeriesProps
Gets or sets whether the ActualLegend is FinancialLegend or normal Legend.
isActualLegendFinancial?: string | boolean Optional isComponentHighlightingModeIgnored
Section titled "isComponentHighlightingModeIgnored"Inherited from: IIgrSeriesProps
Gets or sets whether the component level highlight mode is ignored.
isComponentHighlightingModeIgnored?: string | boolean Optional isDefaultToolTipSelected
Section titled "isDefaultToolTipSelected"Inherited from: IIgrSeriesProps
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: IIgrSeriesProps
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: IIgrSeriesProps
Gets or sets whether highlighting should be enabled for this series, if this type of series supports highlighting.
``
``
isHighlightingEnabled?: string | boolean Optional legend
Section titled "legend"Inherited from: IIgrSeriesProps
Gets or sets the legend used for the current series.
legend?: any Optional legendItemBadgeMode
Section titled "legendItemBadgeMode"Inherited from: IIgrSeriesProps
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: IIgrSeriesProps
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: IIgrSeriesProps
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: IIgrSeriesProps
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: IIgrSeriesProps
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
Section titled "lineCap"Inherited from: IIgrSeriesProps
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: IIgrSeriesProps
Gets or sets the brush that specifies current series object's line join style.
lineJoin?: any Optional markerFillOpacity
Section titled "markerFillOpacity"Inherited from: IIgrSeriesProps
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: IIgrSeriesProps
Gets or sets the whether the chart reacts to mouse move events.
mouseOverEnabled?: string | boolean Inherited from: IIgrSeriesProps
Sets or gets a required unique name for the series.
name: string Optional opacity
Section titled "opacity"Inherited from: IIgrSeriesProps
opacity?: string | number Optional outline
Section titled "outline"Inherited from: IIgrSeriesProps
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: IIgrSeriesProps
Gets or sets the outline mode to use for the series.
outlineMode?: string | SeriesOutlineMode Optional percentChange
Section titled "percentChange"Inherited from: IIgrSeriesProps
The percent change from the beginning to the end of this series.
percentChange?: string | number Optional renderRequested
Section titled "renderRequested"Inherited from: IIgrSeriesProps
This event is raised every time a render has been requested from a series.
``
``
renderRequested?: object Optional resolution
Section titled "resolution"Inherited from: IIgrSeriesProps
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: IIgrSeriesProps
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: IIgrSeriesProps
Gets or sets the selection brush to use for the series.
selectionBrush?: string Optional selectionThickness
Section titled "selectionThickness"Inherited from: IIgrSeriesProps
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: IIgrSeriesProps
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: IIgrSeriesProps
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: IIgrSeriesProps
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: IIgrSeriesProps
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 shouldAnimateOnDataSourceSwap
Section titled "shouldAnimateOnDataSourceSwap"Inherited from: IIgrSeriesProps
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: IIgrSeriesProps
Gets or sets whether this series should suppress it's auto callouts
shouldHideAutoCallouts?: string | boolean Optional shouldRemoveHighlightedDataOnLayerHidden
Section titled "shouldRemoveHighlightedDataOnLayerHidden"Inherited from: IIgrSeriesProps
Gets or sets whether the opacity should be automatically shifted for the safe actual brush.
shouldRemoveHighlightedDataOnLayerHidden?: string | boolean Optional shouldShiftOpacityForSafeActualBrush
Section titled "shouldShiftOpacityForSafeActualBrush"Inherited from: IIgrSeriesProps
Gets or sets whether the opacity should be automatically shifted for the safe actual brush.
shouldShiftOpacityForSafeActualBrush?: string | boolean Optional showDefaultTooltip
Section titled "showDefaultTooltip"Inherited from: IIgrSeriesProps
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 stylingAxisAnnotation
Section titled "stylingAxisAnnotation"Event raised when updating style of UserAxisAnnotation
stylingAxisAnnotation?: object Optional stylingPointAnnotation
Section titled "stylingPointAnnotation"Event raised when updating style of UserPointAnnotation
stylingPointAnnotation?: object Optional stylingSliceAnnotation
Section titled "stylingSliceAnnotation"Event raised when updating style of UserSliceAnnotation
stylingSliceAnnotation?: object Optional stylingStripAnnotation
Section titled "stylingStripAnnotation"Event raised when updating style of UserStripAnnotation
stylingStripAnnotation?: object Optional thickness
Section titled "thickness"Inherited from: IIgrSeriesProps
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
Section titled "title"Inherited from: IIgrSeriesProps
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: IIgrSeriesProps
tooltipTemplate?: any Optional transitionDuration
Section titled "transitionDuration"Inherited from: IIgrSeriesProps
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: IIgrSeriesProps
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: IIgrSeriesProps
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: IIgrSeriesProps
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: IIgrSeriesProps
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: IIgrSeriesProps
Fired when a transition out has completed.
transitionOutCompleted?: object Optional transitionOutDuration
Section titled "transitionOutDuration"Inherited from: IIgrSeriesProps
Gets or sets the duration of the current series' transition out morph.
transitionOutDuration?: string | number Optional transitionOutEasingFunction
Section titled "transitionOutEasingFunction"Inherited from: IIgrSeriesProps
Gets or sets the EasingFunction used to morph the current series during the initial transition.
transitionOutEasingFunction?: object Optional transitionOutSpeedType
Section titled "transitionOutSpeedType"Inherited from: IIgrSeriesProps
Gets or sets the duration of the current series' transition out morph.
transitionOutSpeedType?: string | TransitionOutSpeedType Optional useItemWiseColors
Section titled "useItemWiseColors"Inherited from: IIgrSeriesProps
Gets or sets whether the series should use individual palette colors for each item.
useItemWiseColors?: string | boolean Optional userAnnotationInformationRequested
Section titled "userAnnotationInformationRequested"userAnnotationInformationRequested?: object Optional useSingleShadow
Section titled "useSingleShadow"Inherited from: IIgrSeriesProps
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 visibility
Section titled "visibility"Inherited from: IIgrSeriesProps
visibility?: any Optional visibleRangeMarginBottom
Section titled "visibleRangeMarginBottom"Inherited from: IIgrSeriesProps
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: IIgrSeriesProps
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: IIgrSeriesProps
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: IIgrSeriesProps
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: IIgrSeriesProps
Gets or sets the visible range mode to use.
visibleRangeMode?: string | SeriesVisibleRangeMode