IIgrPolarLineSeriesBaseProps

Optional actualAreaFillOpacity

Section titled "actualAreaFillOpacity"

Inherited from: IIgrPolarBaseProps

Gets the actual opacity applied to the area fill visual.

``

actualAreaFillOpacity?: string | number

Optional actualBrush

Section titled "actualBrush"

Inherited from: IIgrPolarBaseProps

Gets the effective brush for the current series object.

``

actualBrush?: string

Optional actualFocusBrush

Section titled "actualFocusBrush"

Inherited from: IIgrPolarBaseProps

Gets the effective emphasis brush for the current series object.

actualFocusBrush?: string

Optional actualFocusMode

Section titled "actualFocusMode"

Inherited from: IIgrPolarBaseProps

Gets actual Selection mode

actualFocusMode?: string | SeriesSelectionMode

Optional actualHighlightedValuesFadeOpacity

Section titled "actualHighlightedValuesFadeOpacity"

Inherited from: IIgrPolarBaseProps

Gets actual HighlightedValues fade opacity

actualHighlightedValuesFadeOpacity?: string | number

Optional actualHighlightingFadeOpacity

Section titled "actualHighlightingFadeOpacity"

Inherited from: IIgrPolarBaseProps

Gets actual highlighting fade opacity

actualHighlightingFadeOpacity?: string | number

Optional actualHighlightingMode

Section titled "actualHighlightingMode"

Inherited from: IIgrPolarBaseProps

Gets actual highlighting mode

actualHighlightingMode?: string | SeriesHighlightingMode

Optional actualHitTestMode

Section titled "actualHitTestMode"

Inherited from: IIgrPolarBaseProps

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

``

actualHitTestMode?: string | SeriesHitTestMode

Optional actualItemSearchMode

Section titled "actualItemSearchMode"

Inherited from: IIgrPolarBaseProps

actualItemSearchMode?: string | ScatterItemSearchMode

Optional actualLegendItemBadgeBrush

Section titled "actualLegendItemBadgeBrush"

Inherited from: IIgrPolarBaseProps

Gets the effective legend badge fill for the current series.

actualLegendItemBadgeBrush?: string

Optional actualLegendItemBadgeOutline

Section titled "actualLegendItemBadgeOutline"

Inherited from: IIgrPolarBaseProps

Gets the effective legend badge outline for the current series.

actualLegendItemBadgeOutline?: string

Optional actualLegendItemBadgeTemplate

Section titled "actualLegendItemBadgeTemplate"

Inherited from: IIgrPolarBaseProps

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

actualLegendItemBadgeTemplate?: IgDataTemplate

Optional actualMarkerBrush

Section titled "actualMarkerBrush"

Inherited from: IIgrPolarBaseProps

Gets the effective marker brush for the current series object.

ActualMarkerBrush property gets the effective marker brush for the current series object. For example, you can use it like this:

``

actualMarkerBrush?: string

Optional actualMarkerFillOpacity

Section titled "actualMarkerFillOpacity"

Inherited from: IIgrPolarBaseProps

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

actualMarkerFillOpacity?: string | number

Optional actualMarkerOutline

Section titled "actualMarkerOutline"

Inherited from: IIgrPolarBaseProps

Gets the effective marker outline for the current series object.

`ActualMarkerOutline` property gets the effective marker outline for the current series object. You can use it like this:

``

actualMarkerOutline?: string

Optional actualMarkerTemplate

Section titled "actualMarkerTemplate"

Inherited from: IIgrPolarBaseProps

Gets the effective marker template for the current series object.

ActualMarkerTemplate property gets the effective marker template for the current series object. You can use it like this:

actualMarkerTemplate?: IgDataTemplate

Optional actualMarkerType

Section titled "actualMarkerType"

Inherited from: IIgrPolarBaseProps

Represents the resolved marker type for the series.

actualMarkerType?: string | MarkerType

Optional actualOutline

Section titled "actualOutline"

Inherited from: IIgrPolarBaseProps

Gets the effective outline for the current series object.

``

actualOutline?: string

Optional actualResolution

Section titled "actualResolution"

Inherited from: IIgrPolarBaseProps

actualResolution?: string | number

Optional actualSelectionBrush

Section titled "actualSelectionBrush"

Inherited from: IIgrPolarBaseProps

Gets the effective emphasis brush for the current series object.

actualSelectionBrush?: string

Optional actualSelectionMode

Section titled "actualSelectionMode"

Inherited from: IIgrPolarBaseProps

Gets actual Selection mode

actualSelectionMode?: string | SeriesSelectionMode

Optional actualThickness

Section titled "actualThickness"

Inherited from: IIgrPolarBaseProps

Gets the effective Thickness for the current series object.

actualThickness?: string | number

Optional actualTrendLineBrush

Section titled "actualTrendLineBrush"

Inherited from: IIgrPolarBaseProps

Gets the effective TrendLineBrush for this series.

actualTrendLineBrush?: string

Optional angleAxis

Section titled "angleAxis"

Inherited from: IIgrPolarBaseProps

Gets the effective angle axis for the current series object.

angleAxis?: IgrNumericAngleAxis

Optional angleAxisName

Section titled "angleAxisName"

Inherited from: IIgrPolarBaseProps

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

angleAxisName?: string

Optional angleMemberAsLegendLabel

Section titled "angleMemberAsLegendLabel"

Inherited from: IIgrPolarBaseProps

Gets or sets the label displayed before series' angle value in the Data Legend.

angleMemberAsLegendLabel?: string

Optional angleMemberAsLegendUnit

Section titled "angleMemberAsLegendUnit"

Inherited from: IIgrPolarBaseProps

Gets or sets the unit displayed after series' angle value in the Data Legend.

angleMemberAsLegendUnit?: string

Optional angleMemberPath

Section titled "angleMemberPath"

Inherited from: IIgrPolarBaseProps

Gets or sets the path to use to find the angle values for the series.

angleMemberPath?: string

Optional areaFillOpacity

Section titled "areaFillOpacity"

Inherited from: IIgrPolarBaseProps

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 assigningPolarMarkerStyle

Section titled "assigningPolarMarkerStyle"

Inherited from: IIgrPolarBaseProps

Event raised when Assigning Polar Marker Style

assigningPolarMarkerStyle?: object

Optional assigningPolarStyle

Section titled "assigningPolarStyle"

Inherited from: IIgrPolarBaseProps

Event raised when Assigning Category Style

assigningPolarStyle?: object

Optional attachTooltipToRoot

Section titled "attachTooltipToRoot"

Inherited from: IIgrPolarBaseProps

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

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

autoCalloutLabelFormat?: string

Optional autoCalloutLabelFormatSpecifiers

Section titled "autoCalloutLabelFormatSpecifiers"

Inherited from: IIgrPolarBaseProps

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

autoCalloutLabelFormatSpecifiers?: any[]

Optional autoCalloutValueLabelFormat

Section titled "autoCalloutValueLabelFormat"

Inherited from: IIgrPolarBaseProps

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

autoCalloutValueLabelFormat?: string

Optional autoCalloutValueLabelFormatSpecifiers

Section titled "autoCalloutValueLabelFormatSpecifiers"

Inherited from: IIgrPolarBaseProps

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

autoCalloutValueLabelFormatSpecifiers?: any[]

Inherited from: IIgrPolarBaseProps

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

children?: ReactNode

Optional clipSeriesToBounds

Section titled "clipSeriesToBounds"

Inherited from: IIgrPolarBaseProps

Gets or sets whether to clip the series to the bounds. Setting this to true can effect performance.

clipSeriesToBounds?: string | boolean

Optional coercionMethods

Section titled "coercionMethods"

Inherited from: IIgrPolarBaseProps

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

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

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

dataSource?: any

Optional discreteLegendItemTemplate

Section titled "discreteLegendItemTemplate"

Inherited from: IIgrPolarBaseProps

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

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

The final value of this series.

finalValue?: string | number

Optional focusBrush

Section titled "focusBrush"

Inherited from: IIgrPolarBaseProps

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

focusBrush?: string

Optional highlightedAngleMemberPath

Section titled "highlightedAngleMemberPath"

Inherited from: IIgrPolarBaseProps

Gets or sets the highlighted angle value mapping property for the current series object.

highlightedAngleMemberPath?: string

Optional highlightedDataSource

Section titled "highlightedDataSource"

Inherited from: IIgrPolarBaseProps

highlightedDataSource?: any

Optional highlightedLegendItemVisibility

Section titled "highlightedLegendItemVisibility"

Inherited from: IIgrPolarBaseProps

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

highlightedLegendItemVisibility?: any

Optional highlightedRadiusMemberPath

Section titled "highlightedRadiusMemberPath"

Inherited from: IIgrPolarBaseProps

Gets or sets the highlighted radius value mapping property for the current series object.

highlightedRadiusMemberPath?: string

Optional highlightedTitleSuffix

Section titled "highlightedTitleSuffix"

Inherited from: IIgrPolarBaseProps

Gets or sets the HighlightedTitleSuffix property.

highlightedTitleSuffix?: string

Optional highlightedValuesDataLegendGroup

Section titled "highlightedValuesDataLegendGroup"

Inherited from: IIgrPolarBaseProps

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

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

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

highlightedValuesFadeOpacity?: string | number

Optional highlightingFadeOpacity

Section titled "highlightingFadeOpacity"

Inherited from: IIgrPolarBaseProps

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

highlightingFadeOpacity?: string | number

Optional hitTestMode

Section titled "hitTestMode"

Inherited from: IIgrPolarBaseProps

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

Inherited from: IIgrPolarBaseProps

Gets the Index property.

index?: string | number

Optional isActualLegendFinancial

Section titled "isActualLegendFinancial"

Inherited from: IIgrPolarBaseProps

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

isActualLegendFinancial?: string | boolean

Optional isComponentHighlightingModeIgnored

Section titled "isComponentHighlightingModeIgnored"

Inherited from: IIgrPolarBaseProps

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

isComponentHighlightingModeIgnored?: string | boolean

Optional isCustomMarkerCircular

Section titled "isCustomMarkerCircular"

Inherited from: IIgrPolarBaseProps

Gets or sets whether the marker for the current series object should be treated as circular.

isCustomMarkerCircular?: string | boolean

Optional isCustomPolarMarkerStyleAllowed

Section titled "isCustomPolarMarkerStyleAllowed"

Inherited from: IIgrPolarBaseProps

Gets or sets whether this Polar series should allow custom style overrides of its individual marker visuals.

isCustomPolarMarkerStyleAllowed?: string | boolean

Optional isCustomPolarStyleAllowed

Section titled "isCustomPolarStyleAllowed"

Inherited from: IIgrPolarBaseProps

Gets or sets whether this Polar series should allow custom style overrides of its individual visuals.

isCustomPolarStyleAllowed?: string | boolean

Optional isDefaultToolTipSelected

Section titled "isDefaultToolTipSelected"

Inherited from: IIgrPolarBaseProps

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

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

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

``

``

isHighlightingEnabled?: string | boolean

Optional itemSearchMode

Section titled "itemSearchMode"

Inherited from: IIgrPolarBaseProps

Gets or sets the mode the series will use to find the closest point to the cursor.

itemSearchMode?: string | ScatterItemSearchMode

Optional itemSearchThreshold

Section titled "itemSearchThreshold"

Inherited from: IIgrPolarBaseProps

Gets or sets the threshold to use when searching for items using ItemSearchMode.

itemSearchThreshold?: string | number

Inherited from: IIgrPolarBaseProps

Gets or sets the legend used for the current series.

legend?: any

Optional legendItemBadgeMode

Section titled "legendItemBadgeMode"

Inherited from: IIgrPolarBaseProps

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

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

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

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

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

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

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

lineJoin?: any

Optional markerBrush

Section titled "markerBrush"

Inherited from: IIgrPolarBaseProps

Gets or sets the brush that specifies how the current series object's marker interiors are painted.

MarkerBrush property gets or sets the brush that specifies how the current series object's marker interiors are painted. You can use it like this:

``

``

markerBrush?: string

Optional markerFillMode

Section titled "markerFillMode"

Inherited from: IIgrPolarBaseProps

Gets or sets whether the marker fill is based on the marker outline of the series rather than the marker brushes collection.

markerFillMode?: string | MarkerFillMode

Optional markerFillOpacity

Section titled "markerFillOpacity"

Inherited from: IIgrPolarBaseProps

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 markerOutline

Section titled "markerOutline"

Inherited from: IIgrPolarBaseProps

Gets or sets the brush that specifies how the current series object's marker outlines are painted.

MarkerOutline property gets or sets the brush that specifies how the current series object's marker outlines are painted. You can use it like this:

``

``

markerOutline?: string

Optional markerOutlineMode

Section titled "markerOutlineMode"

Inherited from: IIgrPolarBaseProps

Gets or sets whether the marker outline is based on the marker brush of the series rather than the marker outlines collection.

markerOutlineMode?: string | MarkerOutlineMode

Optional markerTemplate

Section titled "markerTemplate"

Inherited from: IIgrPolarBaseProps

Gets or sets the MarkerTemplate for the current series object.

MarkerTemplate property gets or sets the MarkerTemplate for the current series object. For example, you can use it like this:

markerTemplate?: IgDataTemplate

Optional markerThickness

Section titled "markerThickness"

Inherited from: IIgrPolarBaseProps

Gets or sets thickness of the marker outline

markerThickness?: string | number

Optional markerType

Section titled "markerType"

Inherited from: IIgrPolarBaseProps

Gets or sets the marker type for the current series object. This property is ignored when the MarkerTemplate property is set

MarkerType property gets or sets the marker type for the current series object. For example, you can set it like this:

``

``

markerType?: string | MarkerType

Optional maximumMarkers

Section titled "maximumMarkers"

Inherited from: IIgrPolarBaseProps

Gets or sets the maximum number of markers displayed by the current series. If more than the specified number of markers are visible, the polar series will automatically choose a representative set.

maximumMarkers?: string | number

Optional mouseOverEnabled

Section titled "mouseOverEnabled"

Inherited from: IIgrPolarBaseProps

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

mouseOverEnabled?: string | boolean

Inherited from: IIgrPolarBaseProps

Sets or gets a required unique name for the series.

name: string

Inherited from: IIgrPolarBaseProps

opacity?: string | number

Inherited from: IIgrPolarBaseProps

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

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

outlineMode?: string | SeriesOutlineMode

Optional percentChange

Section titled "percentChange"

Inherited from: IIgrPolarBaseProps

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

percentChange?: string | number

Optional radiusAxis

Section titled "radiusAxis"

Inherited from: IIgrPolarBaseProps

Gets the effective radius axis for the current series object.

radiusAxis?: IgrNumericRadiusAxis

Optional radiusAxisName

Section titled "radiusAxisName"

Inherited from: IIgrPolarBaseProps

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

radiusAxisName?: string

Optional radiusMemberAsLegendLabel

Section titled "radiusMemberAsLegendLabel"

Inherited from: IIgrPolarBaseProps

Gets or sets the label displayed before series' radius value in the Data Legend.

radiusMemberAsLegendLabel?: string

Optional radiusMemberAsLegendUnit

Section titled "radiusMemberAsLegendUnit"

Inherited from: IIgrPolarBaseProps

Gets or sets the unit displayed after series' radius value in the Data Legend.

radiusMemberAsLegendUnit?: string

Optional radiusMemberPath

Section titled "radiusMemberPath"

Inherited from: IIgrPolarBaseProps

Gets or sets the path to use to get the radius values for the series.

radiusMemberPath?: string

Optional renderRequested

Section titled "renderRequested"

Inherited from: IIgrPolarBaseProps

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

``

``

renderRequested?: object

Optional resolution

Section titled "resolution"

Inherited from: IIgrPolarBaseProps

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

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

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

selectionBrush?: string

Optional selectionThickness

Section titled "selectionThickness"

Inherited from: IIgrPolarBaseProps

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

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

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

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

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

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

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

shouldHideAutoCallouts?: string | boolean

Optional shouldRemoveHighlightedDataOnLayerHidden

Section titled "shouldRemoveHighlightedDataOnLayerHidden"

Inherited from: IIgrPolarBaseProps

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

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

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 thickness

Section titled "thickness"

Inherited from: IIgrPolarBaseProps

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

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

tooltipTemplate?: any

Optional transitionDuration

Section titled "transitionDuration"

Inherited from: IIgrPolarBaseProps

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

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

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

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

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

Fired when a transition out has completed.

transitionOutCompleted?: object

Optional transitionOutDuration

Section titled "transitionOutDuration"

Inherited from: IIgrPolarBaseProps

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

transitionOutDuration?: string | number

Optional transitionOutEasingFunction

Section titled "transitionOutEasingFunction"

Inherited from: IIgrPolarBaseProps

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

transitionOutEasingFunction?: object

Optional transitionOutSpeedType

Section titled "transitionOutSpeedType"

Inherited from: IIgrPolarBaseProps

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

transitionOutSpeedType?: string | TransitionOutSpeedType

Optional trendLineBrush

Section titled "trendLineBrush"

Inherited from: IIgrPolarBaseProps

Gets or sets the brush that specifies how the current series object's trend line is drawn.

trendLineBrush?: string

Optional trendLineDashArray

Section titled "trendLineDashArray"

Inherited from: IIgrPolarBaseProps

Gets or sets a collection of double values that indicate the pattern of dashes and gaps that is used to draw the trend line for the current series object.

trendLineDashArray?: string | number[]

Optional trendLinePeriod

Section titled "trendLinePeriod"

Inherited from: IIgrPolarBaseProps

Gets or sets the moving average period for the current series object.

trendLinePeriod?: string | number

Optional trendLineThickness

Section titled "trendLineThickness"

Inherited from: IIgrPolarBaseProps

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

trendLineThickness?: string | number

Optional trendLineType

Section titled "trendLineType"

Inherited from: IIgrPolarBaseProps

Gets or sets the trend type for the current series object.

trendLineType?: any

Optional trendLineZIndex

Section titled "trendLineZIndex"

Inherited from: IIgrPolarBaseProps

Sets or Gets the Trendline Z index.

trendLineZIndex?: string | number

Optional useCartesianInterpolation

Section titled "useCartesianInterpolation"

Inherited from: IIgrPolarBaseProps

Gets or sets whether Cartesian Interpolation should be used rather than Archimedian spiral based interpolation.

useCartesianInterpolation?: string | boolean

Optional useItemWiseColors

Section titled "useItemWiseColors"

Inherited from: IIgrPolarBaseProps

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

useItemWiseColors?: string | boolean

Optional useSingleShadow

Section titled "useSingleShadow"

Inherited from: IIgrPolarBaseProps

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

visibility?: any

Optional visibleRangeMarginBottom

Section titled "visibleRangeMarginBottom"

Inherited from: IIgrPolarBaseProps

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

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

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

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

Gets or sets the visible range mode to use.

visibleRangeMode?: string | SeriesVisibleRangeMode