Represents a DataChartComponent spline series.
``
``
Constructors
Section titled "Constructors"IgrSplineSeries
new IgrSplineSeries(props: IIgrSplineSeriesProps): IgrSplineSeries Returns IgrSplineSeries
Properties
Section titled "Properties"actualAreaFillOpacity
Section titled "actualAreaFillOpacity"Inherited from: IgrSplineSeriesBase
actualAreaFillOpacity: number actualBrush
Section titled "actualBrush"Inherited from: IgrSplineSeriesBase
actualBrush: string actualFocusBrush
Section titled "actualFocusBrush"Inherited from: IgrSplineSeriesBase
actualFocusBrush: string actualFocusMode
Section titled "actualFocusMode"Inherited from: IgrSplineSeriesBase
actualFocusMode: SeriesSelectionMode actualHighlightedValuesFadeOpacity
Section titled "actualHighlightedValuesFadeOpacity"Inherited from: IgrSplineSeriesBase
actualHighlightedValuesFadeOpacity: number actualHighlightingFadeOpacity
Section titled "actualHighlightingFadeOpacity"Inherited from: IgrSplineSeriesBase
actualHighlightingFadeOpacity: number actualHighlightingMode
Section titled "actualHighlightingMode"Inherited from: IgrSplineSeriesBase
actualHighlightingMode: SeriesHighlightingMode actualHitTestMode
Section titled "actualHitTestMode"Inherited from: IgrSplineSeriesBase
actualHitTestMode: SeriesHitTestMode actualLayers
Section titled "actualLayers"Inherited from: IgrSplineSeriesBase
actualLayers: IgrSeriesLayerCollection actualLegendItemBadgeBrush
Section titled "actualLegendItemBadgeBrush"Inherited from: IgrSplineSeriesBase
actualLegendItemBadgeBrush: string actualLegendItemBadgeOutline
Section titled "actualLegendItemBadgeOutline"Inherited from: IgrSplineSeriesBase
actualLegendItemBadgeOutline: string actualLegendItemBadgeTemplate
Section titled "actualLegendItemBadgeTemplate"Inherited from: IgrSplineSeriesBase
actualLegendItemBadgeTemplate: IgDataTemplate actualMarkerBrush
Section titled "actualMarkerBrush"Inherited from: IgrSplineSeriesBase
actualMarkerBrush: string actualMarkerFillOpacity
Section titled "actualMarkerFillOpacity"Inherited from: IgrSplineSeriesBase
actualMarkerFillOpacity: number actualMarkerOutline
Section titled "actualMarkerOutline"Inherited from: IgrSplineSeriesBase
actualMarkerOutline: string actualMarkerTemplate
Section titled "actualMarkerTemplate"Inherited from: IgrSplineSeriesBase
actualMarkerTemplate: IgDataTemplate actualMarkerType
Section titled "actualMarkerType"Inherited from: IgrSplineSeriesBase
actualMarkerType: MarkerType actualOutline
Section titled "actualOutline"Inherited from: IgrSplineSeriesBase
actualOutline: string actualResolution
Section titled "actualResolution"Inherited from: IgrSplineSeriesBase
actualResolution: number actualSelectionBrush
Section titled "actualSelectionBrush"Inherited from: IgrSplineSeriesBase
actualSelectionBrush: string actualSelectionMode
Section titled "actualSelectionMode"Inherited from: IgrSplineSeriesBase
actualSelectionMode: SeriesSelectionMode actualThickness
Section titled "actualThickness"Inherited from: IgrSplineSeriesBase
actualThickness: number actualTrendLineBrush
Section titled "actualTrendLineBrush"Inherited from: IgrSplineSeriesBase
actualTrendLineBrush: string areaFillOpacity
Section titled "areaFillOpacity"Inherited from: IgrSplineSeriesBase
areaFillOpacity: number assigningCategoryMarkerStyle
Section titled "assigningCategoryMarkerStyle"Inherited from: IgrSplineSeriesBase
assigningCategoryMarkerStyle: object assigningCategoryStyle
Section titled "assigningCategoryStyle"Inherited from: IgrSplineSeriesBase
assigningCategoryStyle: object attachTooltipToRoot
Section titled "attachTooltipToRoot"Inherited from: IgrSplineSeriesBase
attachTooltipToRoot: boolean autoCalloutLabelFormat
Section titled "autoCalloutLabelFormat"Inherited from: IgrSplineSeriesBase
autoCalloutLabelFormat: string autoCalloutLabelFormatSpecifiers
Section titled "autoCalloutLabelFormatSpecifiers"Inherited from: IgrSplineSeriesBase
autoCalloutLabelFormatSpecifiers: any[] autoCalloutValueLabelFormat
Section titled "autoCalloutValueLabelFormat"Inherited from: IgrSplineSeriesBase
autoCalloutValueLabelFormat: string autoCalloutValueLabelFormatSpecifiers
Section titled "autoCalloutValueLabelFormatSpecifiers"Inherited from: IgrSplineSeriesBase
autoCalloutValueLabelFormatSpecifiers: any[] brush
Section titled "brush"Inherited from: IgrSplineSeriesBase
brush: string categoryCollisionMode
Section titled "categoryCollisionMode"Inherited from: IgrSplineSeriesBase
categoryCollisionMode: CategoryCollisionMode coercionMethods
Section titled "coercionMethods"Inherited from: IgrSplineSeriesBase
coercionMethods: any consolidatedItemHitTestBehavior
Section titled "consolidatedItemHitTestBehavior"Inherited from: IgrSplineSeriesBase
consolidatedItemHitTestBehavior: ConsolidatedItemHitTestBehavior dashArray
Section titled "dashArray"Inherited from: IgrSplineSeriesBase
dashArray: number[] dataLegendGroup
Section titled "dataLegendGroup"Inherited from: IgrSplineSeriesBase
dataLegendGroup: string dataSource
Section titled "dataSource"Inherited from: IgrSplineSeriesBase
dataSource: any discreteLegendItemTemplate
Section titled "discreteLegendItemTemplate"Inherited from: IgrSplineSeriesBase
discreteLegendItemTemplate: IgDataTemplate expectFunctions
Section titled "expectFunctions"Inherited from: IgrSplineSeriesBase
expectFunctions: boolean finalValue
Section titled "finalValue"Inherited from: IgrSplineSeriesBase
finalValue: number focusBrush
Section titled "focusBrush"Inherited from: IgrSplineSeriesBase
focusBrush: string highlightedDataSource
Section titled "highlightedDataSource"Inherited from: IgrSplineSeriesBase
highlightedDataSource: any highlightedLegendItemVisibility
Section titled "highlightedLegendItemVisibility"Inherited from: IgrSplineSeriesBase
highlightedLegendItemVisibility: Visibility highlightedTitleSuffix
Section titled "highlightedTitleSuffix"Inherited from: IgrSplineSeriesBase
highlightedTitleSuffix: string highlightedValueMemberPath
Section titled "highlightedValueMemberPath"Inherited from: IgrSplineSeriesBase
highlightedValueMemberPath: string highlightedValuesDataLegendGroup
Section titled "highlightedValuesDataLegendGroup"Inherited from: IgrSplineSeriesBase
highlightedValuesDataLegendGroup: string highlightedValuesDisplayMode
Section titled "highlightedValuesDisplayMode"Inherited from: IgrSplineSeriesBase
highlightedValuesDisplayMode: SeriesHighlightedValuesDisplayMode highlightedValuesExtraPropertyOverlays
Section titled "highlightedValuesExtraPropertyOverlays"Inherited from: IgrSplineSeriesBase
highlightedValuesExtraPropertyOverlays: IgrSeriesLayerPropertyOverlayCollection highlightedValuesFadeOpacity
Section titled "highlightedValuesFadeOpacity"Inherited from: IgrSplineSeriesBase
highlightedValuesFadeOpacity: number highlightingFadeOpacity
Section titled "highlightingFadeOpacity"Inherited from: IgrSplineSeriesBase
highlightingFadeOpacity: number hitTestMode
Section titled "hitTestMode"Inherited from: IgrSplineSeriesBase
hitTestMode: SeriesHitTestMode index
Section titled "index"Inherited from: IgrSplineSeriesBase
index: number isActualLegendFinancial
Section titled "isActualLegendFinancial"Inherited from: IgrSplineSeriesBase
isActualLegendFinancial: boolean isComponentHighlightingModeIgnored
Section titled "isComponentHighlightingModeIgnored"Inherited from: IgrSplineSeriesBase
isComponentHighlightingModeIgnored: boolean isCustomCategoryMarkerStyleAllowed
Section titled "isCustomCategoryMarkerStyleAllowed"Inherited from: IgrSplineSeriesBase
isCustomCategoryMarkerStyleAllowed: boolean isCustomCategoryStyleAllowed
Section titled "isCustomCategoryStyleAllowed"Inherited from: IgrSplineSeriesBase
isCustomCategoryStyleAllowed: boolean isCustomMarkerCircular
Section titled "isCustomMarkerCircular"Inherited from: IgrSplineSeriesBase
isCustomMarkerCircular: boolean isDefaultToolTipSelected
Section titled "isDefaultToolTipSelected"Inherited from: IgrSplineSeriesBase
isDefaultToolTipSelected: boolean isDropShadowEnabled
Section titled "isDropShadowEnabled"Inherited from: IgrSplineSeriesBase
isDropShadowEnabled: boolean isHighlightingEnabled
Section titled "isHighlightingEnabled"Inherited from: IgrSplineSeriesBase
isHighlightingEnabled: boolean isSplineShapePartOfRange
Section titled "isSplineShapePartOfRange"Inherited from: IgrSplineSeriesBase
isSplineShapePartOfRange: boolean isTransitionInEnabled
Section titled "isTransitionInEnabled"Inherited from: IgrSplineSeriesBase
isTransitionInEnabled: boolean layers
Section titled "layers"Inherited from: IgrSplineSeriesBase
layers: IgrSeriesLayerCollection legend
Section titled "legend"Inherited from: IgrSplineSeriesBase
legend: any legendItemBadgeMode
Section titled "legendItemBadgeMode"Inherited from: IgrSplineSeriesBase
legendItemBadgeMode: LegendItemBadgeMode legendItemBadgeShape
Section titled "legendItemBadgeShape"Inherited from: IgrSplineSeriesBase
legendItemBadgeShape: LegendItemBadgeShape legendItemBadgeTemplate
Section titled "legendItemBadgeTemplate"Inherited from: IgrSplineSeriesBase
legendItemBadgeTemplate: IgDataTemplate legendItemTemplate
Section titled "legendItemTemplate"Inherited from: IgrSplineSeriesBase
legendItemTemplate: IgDataTemplate legendItemVisibility
Section titled "legendItemVisibility"Inherited from: IgrSplineSeriesBase
legendItemVisibility: Visibility lineCap
Section titled "lineCap"Inherited from: IgrSplineSeriesBase
lineCap: PenLineCap lineJoin
Section titled "lineJoin"Inherited from: IgrSplineSeriesBase
lineJoin: PenLineJoin markerBrush
Section titled "markerBrush"Inherited from: IgrSplineSeriesBase
markerBrush: string markerCollisionAvoidance
Section titled "markerCollisionAvoidance"Inherited from: IgrSplineSeriesBase
markerCollisionAvoidance: CategorySeriesMarkerCollisionAvoidance markerFillMode
Section titled "markerFillMode"Inherited from: IgrSplineSeriesBase
markerFillMode: MarkerFillMode markerFillOpacity
Section titled "markerFillOpacity"Inherited from: IgrSplineSeriesBase
markerFillOpacity: number markerOutline
Section titled "markerOutline"Inherited from: IgrSplineSeriesBase
markerOutline: string markerOutlineMode
Section titled "markerOutlineMode"Inherited from: IgrSplineSeriesBase
markerOutlineMode: MarkerOutlineMode markerTemplate
Section titled "markerTemplate"Inherited from: IgrSplineSeriesBase
markerTemplate: IgDataTemplate markerThickness
Section titled "markerThickness"Inherited from: IgrSplineSeriesBase
markerThickness: number markerType
Section titled "markerType"Inherited from: IgrSplineSeriesBase
markerType: MarkerType mouseOverEnabled
Section titled "mouseOverEnabled"Inherited from: IgrSplineSeriesBase
mouseOverEnabled: boolean Inherited from: IgrSplineSeriesBase
name: string opacity
Section titled "opacity"Inherited from: IgrSplineSeriesBase
opacity: number outline
Section titled "outline"Inherited from: IgrSplineSeriesBase
outline: string outlineMode
Section titled "outlineMode"Inherited from: IgrSplineSeriesBase
outlineMode: SeriesOutlineMode percentChange
Section titled "percentChange"Inherited from: IgrSplineSeriesBase
percentChange: number renderRequested
Section titled "renderRequested"Inherited from: IgrSplineSeriesBase
renderRequested: object resolution
Section titled "resolution"Inherited from: IgrSplineSeriesBase
resolution: number safeActualBrush
Section titled "safeActualBrush"Inherited from: IgrSplineSeriesBase
safeActualBrush: string selectionBrush
Section titled "selectionBrush"Inherited from: IgrSplineSeriesBase
selectionBrush: string selectionThickness
Section titled "selectionThickness"Inherited from: IgrSplineSeriesBase
selectionThickness: number shadowBlur
Section titled "shadowBlur"Inherited from: IgrSplineSeriesBase
shadowBlur: number shadowColor
Section titled "shadowColor"Inherited from: IgrSplineSeriesBase
shadowColor: string shadowOffsetX
Section titled "shadowOffsetX"Inherited from: IgrSplineSeriesBase
shadowOffsetX: number shadowOffsetY
Section titled "shadowOffsetY"Inherited from: IgrSplineSeriesBase
shadowOffsetY: number shouldAnimateOnDataSourceSwap
Section titled "shouldAnimateOnDataSourceSwap"Inherited from: IgrSplineSeriesBase
shouldAnimateOnDataSourceSwap: boolean shouldHideAutoCallouts
Section titled "shouldHideAutoCallouts"Inherited from: IgrSplineSeriesBase
shouldHideAutoCallouts: boolean shouldRemoveHighlightedDataOnLayerHidden
Section titled "shouldRemoveHighlightedDataOnLayerHidden"Inherited from: IgrSplineSeriesBase
shouldRemoveHighlightedDataOnLayerHidden: boolean shouldShiftOpacityForSafeActualBrush
Section titled "shouldShiftOpacityForSafeActualBrush"Inherited from: IgrSplineSeriesBase
shouldShiftOpacityForSafeActualBrush: boolean showDefaultTooltip
Section titled "showDefaultTooltip"Inherited from: IgrSplineSeriesBase
showDefaultTooltip: boolean splineType
Section titled "splineType"Inherited from: IgrSplineSeriesBase
splineType: SplineType thickness
Section titled "thickness"Inherited from: IgrSplineSeriesBase
thickness: number title
Section titled "title"Inherited from: IgrSplineSeriesBase
title: any tooltipContainerTemplate
Section titled "tooltipContainerTemplate"Inherited from: IgrSplineSeriesBase
tooltipContainerTemplate: any tooltipTemplate
Section titled "tooltipTemplate"Inherited from: IgrSplineSeriesBase
tooltipTemplate: any transitionDuration
Section titled "transitionDuration"Inherited from: IgrSplineSeriesBase
transitionDuration: number transitionEasingFunction
Section titled "transitionEasingFunction"Inherited from: IgrSplineSeriesBase
transitionEasingFunction: object transitionInDuration
Section titled "transitionInDuration"Inherited from: IgrSplineSeriesBase
transitionInDuration: number transitionInEasingFunction
Section titled "transitionInEasingFunction"Inherited from: IgrSplineSeriesBase
transitionInEasingFunction: object transitionInMode
Section titled "transitionInMode"Inherited from: IgrSplineSeriesBase
transitionInMode: CategoryTransitionInMode transitionInSpeedType
Section titled "transitionInSpeedType"Inherited from: IgrSplineSeriesBase
transitionInSpeedType: TransitionInSpeedType transitionOutCompleted
Section titled "transitionOutCompleted"Inherited from: IgrSplineSeriesBase
transitionOutCompleted: object transitionOutDuration
Section titled "transitionOutDuration"Inherited from: IgrSplineSeriesBase
transitionOutDuration: number transitionOutEasingFunction
Section titled "transitionOutEasingFunction"Inherited from: IgrSplineSeriesBase
transitionOutEasingFunction: object transitionOutSpeedType
Section titled "transitionOutSpeedType"Inherited from: IgrSplineSeriesBase
transitionOutSpeedType: TransitionOutSpeedType trendLineBrush
Section titled "trendLineBrush"Inherited from: IgrSplineSeriesBase
trendLineBrush: string trendLineDashArray
Section titled "trendLineDashArray"Inherited from: IgrSplineSeriesBase
trendLineDashArray: number[] trendLinePeriod
Section titled "trendLinePeriod"Inherited from: IgrSplineSeriesBase
trendLinePeriod: number trendLineThickness
Section titled "trendLineThickness"Inherited from: IgrSplineSeriesBase
trendLineThickness: number trendLineType
Section titled "trendLineType"Inherited from: IgrSplineSeriesBase
trendLineType: TrendLineType useHighMarkerFidelity
Section titled "useHighMarkerFidelity"Inherited from: IgrSplineSeriesBase
useHighMarkerFidelity: boolean useItemWiseColors
Section titled "useItemWiseColors"Inherited from: IgrSplineSeriesBase
useItemWiseColors: boolean useSingleShadow
Section titled "useSingleShadow"Inherited from: IgrSplineSeriesBase
useSingleShadow: boolean valueMemberAsLegendLabel
Section titled "valueMemberAsLegendLabel"Inherited from: IgrSplineSeriesBase
valueMemberAsLegendLabel: string valueMemberAsLegendUnit
Section titled "valueMemberAsLegendUnit"Inherited from: IgrSplineSeriesBase
valueMemberAsLegendUnit: string valueMemberPath
Section titled "valueMemberPath"Inherited from: IgrSplineSeriesBase
valueMemberPath: string visibility
Section titled "visibility"Inherited from: IgrSplineSeriesBase
visibility: Visibility visibleRangeMarginBottom
Section titled "visibleRangeMarginBottom"Inherited from: IgrSplineSeriesBase
visibleRangeMarginBottom: number visibleRangeMarginLeft
Section titled "visibleRangeMarginLeft"Inherited from: IgrSplineSeriesBase
visibleRangeMarginLeft: number visibleRangeMarginRight
Section titled "visibleRangeMarginRight"Inherited from: IgrSplineSeriesBase
visibleRangeMarginRight: number visibleRangeMarginTop
Section titled "visibleRangeMarginTop"Inherited from: IgrSplineSeriesBase
visibleRangeMarginTop: number visibleRangeMode
Section titled "visibleRangeMode"Inherited from: IgrSplineSeriesBase
visibleRangeMode: SeriesVisibleRangeMode xAxis
Section titled "xAxis"Inherited from: IgrSplineSeriesBase
xAxis: IgrCategoryAxisBase xAxisName
Section titled "xAxisName"Inherited from: IgrSplineSeriesBase
xAxisName: string yAxis
Section titled "yAxis"Inherited from: IgrSplineSeriesBase
yAxis: IgrNumericYAxis yAxisName
Section titled "yAxisName"Inherited from: IgrSplineSeriesBase
yAxisName: string Accessors
Section titled "Accessors"actualCloseLabel
Section titled "actualCloseLabel"Inherited from: IgrSplineSeriesBase
Gets the text that is displayed for the Close label in the tooltip.
get actualCloseLabel(): string Returns string
actualHighLabel
Section titled "actualHighLabel"Inherited from: IgrSplineSeriesBase
Gets the text that is displayed for the High label in the tooltip.
get actualHighLabel(): string Returns string
actualLowLabel
Section titled "actualLowLabel"Inherited from: IgrSplineSeriesBase
Gets the text that is displayed for the Low label in the tooltip.
get actualLowLabel(): string Returns string
actualOpenLabel
Section titled "actualOpenLabel"Inherited from: IgrSplineSeriesBase
Gets the text that is displayed for the Open label in the tooltip.
get actualOpenLabel(): string Returns string
actualRadiusLabel
Section titled "actualRadiusLabel"Inherited from: IgrSplineSeriesBase
Gets the text that is displayed for the Value label in the tooltip.
get actualRadiusLabel(): string Returns string
actualValueLabel
Section titled "actualValueLabel"Inherited from: IgrSplineSeriesBase
Gets the text that is displayed for the Value label in the tooltip.
get actualValueLabel(): string Returns string
actualVolumeLabel
Section titled "actualVolumeLabel"Inherited from: IgrSplineSeriesBase
Gets the text that is displayed for the Volume label in the tooltip.
get actualVolumeLabel(): string Returns string
dataLegendKey
Section titled "dataLegendKey"Inherited from: IgrSplineSeriesBase
Gets unique key used to identify the series in data legend
get dataLegendKey(): string Returns string
effectiveIsMarkerCircular
Section titled "effectiveIsMarkerCircular"Inherited from: IgrSplineSeriesBase
Gets whether the markers for the current series are in circular shape
get effectiveIsMarkerCircular(): boolean Returns boolean
hasMarkers
Section titled "hasMarkers"Inherited from: IgrSplineSeriesBase
Returns whether the current series supports visual markers.
HasMarkers property is overriden, it returns whether the current series supports visual markers. You can use it like this:
``
get hasMarkers(): boolean Returns boolean
hasOnlyMarkers
Section titled "hasOnlyMarkers"Inherited from: IgrSplineSeriesBase
Gets whether the series has only marker as visuals
get hasOnlyMarkers(): boolean Returns boolean
hasValueAxis
Section titled "hasValueAxis"Inherited from: IgrSplineSeriesBase
Gets whether the current series shows an area shape.
get hasValueAxis(): boolean Returns boolean
hasVisibleMarkers
Section titled "hasVisibleMarkers"Inherited from: IgrSplineSeriesBase
Returns whether the current series has a visible marker style.
get hasVisibleMarkers(): boolean Returns boolean
isAnnotationCalloutLayer
Section titled "isAnnotationCalloutLayer"Inherited from: IgrSplineSeriesBase
Gets whether the series is an callout annotation layer.
get isAnnotationCalloutLayer(): boolean Returns boolean
isAnnotationCrosshairLayer
Section titled "isAnnotationCrosshairLayer"Inherited from: IgrSplineSeriesBase
Gets whether the series is an crosshair annotation layer.
get isAnnotationCrosshairLayer(): boolean Returns boolean
isAnnotationDataLayer
Section titled "isAnnotationDataLayer"Inherited from: IgrSplineSeriesBase
Gets whether the series is a data annotation layer that support binding to data source DataAnnotationShapeLayer, DataAnnotationSliceLayer, DataAnnotationStripLayer
get isAnnotationDataLayer(): boolean Returns boolean
isAnnotationFinalValue
Section titled "isAnnotationFinalValue"Inherited from: IgrSplineSeriesBase
Gets whether the series is final value annotation layer.
get isAnnotationFinalValue(): boolean Returns boolean
isAnnotationHoverLayer
Section titled "isAnnotationHoverLayer"Inherited from: IgrSplineSeriesBase
Gets whether the series is an annotation layer displayed only when hovering over the chart. Crosshair Layer, Category Highlight Layer, Category Tooltip Layer, Item Tooltip Layer
get isAnnotationHoverLayer(): boolean Returns boolean
isAnnotationLayer
Section titled "isAnnotationLayer"Inherited from: IgrSplineSeriesBase
Gets whether the series is an annotation layer.
``
get isAnnotationLayer(): boolean Returns boolean
isAnnotationValueLayer
Section titled "isAnnotationValueLayer"Inherited from: IgrSplineSeriesBase
Gets whether the series is a value annotation layer.
get isAnnotationValueLayer(): boolean Returns boolean
isArea
Section titled "isArea"Inherited from: IgrSplineSeriesBase
Gets whether the current series shows an area shape.
get isArea(): boolean Returns boolean
isAreaOrLine
Section titled "isAreaOrLine"Inherited from: IgrSplineSeriesBase
Gets whether the current series shows an area or line shape.
get isAreaOrLine(): boolean Returns boolean
isBar
Section titled "isBar"Inherited from: IgrSplineSeriesBase
Gets whether the current series shows a horizontal column shape.
get isBar(): boolean Returns boolean
isCategory
Section titled "isCategory"Inherited from: IgrSplineSeriesBase
Gets whether or not this series is Category series
get isCategory(): boolean Returns boolean
isColoredItemwise
Section titled "isColoredItemwise"Inherited from: IgrSplineSeriesBase
get isColoredItemwise(): boolean Returns boolean
isColumn
Section titled "isColumn"Inherited from: IgrSplineSeriesBase
Gets whether the current series shows a column shape.
get isColumn(): boolean Returns boolean
isDefaultCrosshairBehaviorDisabled
Section titled "isDefaultCrosshairBehaviorDisabled"Inherited from: IgrSplineSeriesBase
Gets whether the default crosshair behavior should be disabled if this series is present.
IsDefaultCrosshairBehaviorDisabled defaults to true for annotation layers. When not using annotaion layers, you can show crosshairs by setting the chart's CrosshairVisibility to true.
``
get isDefaultCrosshairBehaviorDisabled(): boolean Returns boolean
isDefaultTooltipBehaviorDisabled
Section titled "isDefaultTooltipBehaviorDisabled"Inherited from: IgrSplineSeriesBase
Gets whether the default tooltip behavior should be disabled if this series is present.
``
get isDefaultTooltipBehaviorDisabled(): boolean Returns boolean
isFinancial
Section titled "isFinancial"Inherited from: IgrSplineSeriesBase
Gets whether the current series is a financial type series.
``
get isFinancial(): boolean Returns boolean
isFinancialIndicator
Section titled "isFinancialIndicator"Inherited from: IgrSplineSeriesBase
Gets whether the series is financial indicator
get isFinancialIndicator(): boolean Returns boolean
isFinancialOverlay
Section titled "isFinancialOverlay"Inherited from: IgrSplineSeriesBase
Gets whether the series is financial overlay
get isFinancialOverlay(): boolean Returns boolean
isFinancialSeries
Section titled "isFinancialSeries"Inherited from: IgrSplineSeriesBase
Gets whether the series has financial OHLC/candlestick visuals
get isFinancialSeries(): boolean Returns boolean
isFinancialWaterfall
Section titled "isFinancialWaterfall"Inherited from: IgrSplineSeriesBase
Gets whether the series is financial waterfall
get isFinancialWaterfall(): boolean Returns boolean
isFragment
Section titled "isFragment"Inherited from: IgrSplineSeriesBase
Gets whether the current series is a stack fragment.
``
get isFragment(): boolean Returns boolean
isGeographic
Section titled "isGeographic"Inherited from: IgrSplineSeriesBase
Gets whether the current series is a geographic series.
``
get isGeographic(): boolean Returns boolean
isHighlightOverlay
Section titled "isHighlightOverlay"Inherited from: IgrSplineSeriesBase
Gets whether the series is a highlight overlay.
get isHighlightOverlay(): boolean Returns boolean
isIndexed
Section titled "isIndexed"Inherited from: IgrSplineSeriesBase
Gets if the series uses an index, which can be used to auto-assign it a color.
``
get isIndexed(): boolean Returns boolean
isLayer
Section titled "isLayer"Inherited from: IgrSplineSeriesBase
get isLayer(): boolean Returns boolean
isLineContour
Section titled "isLineContour"Inherited from: IgrSplineSeriesBase
Gets whether the current series shows a line contour shape.
get isLineContour(): boolean Returns boolean
isLineOnly
Section titled "isLineOnly"Inherited from: IgrSplineSeriesBase
Gets whether the current series shows only line shapes.
get isLineOnly(): boolean Returns boolean
isMarkerlessDisplayPreferred
Section titled "isMarkerlessDisplayPreferred"Inherited from: IgrSplineSeriesBase
Overridden by derived series classes to indicate when markerless display is preferred or not.
get isMarkerlessDisplayPreferred(): boolean Returns boolean
isNegativeColorSupported
Section titled "isNegativeColorSupported"Inherited from: IgrSplineSeriesBase
Overridden by derived series classes to indicate when negative colors are supported or not.
get isNegativeColorSupported(): boolean Returns boolean
isPie
Section titled "isPie"Inherited from: IgrSplineSeriesBase
Gets whether the current series shows a pie shape.
get isPie(): boolean Returns boolean
isPixel
Section titled "isPixel"Inherited from: IgrSplineSeriesBase
Gets whether the current series shows pixels.
get isPixel(): boolean Returns boolean
isPolar
Section titled "isPolar"Inherited from: IgrSplineSeriesBase
Gets whether the current series is a polar type series.
``
get isPolar(): boolean Returns boolean
isPolygon
Section titled "isPolygon"Inherited from: IgrSplineSeriesBase
Gets whether the current series shows a polygon shape.
get isPolygon(): boolean Returns boolean
isPolyline
Section titled "isPolyline"Inherited from: IgrSplineSeriesBase
Gets whether the current series shows a polyline shape.
get isPolyline(): boolean Returns boolean
isRadial
Section titled "isRadial"Inherited from: IgrSplineSeriesBase
Gets whether the current series is a radial type series.
``
get isRadial(): boolean Returns boolean
isRange
Section titled "isRange"Inherited from: IgrSplineSeriesBase
Gets whether the current series is a range type series.
``
get isRange(): boolean Returns boolean
isScatter
Section titled "isScatter"Inherited from: IgrSplineSeriesBase
Gets whether the current series is a scatter type series.
``
get isScatter(): boolean Returns boolean
isShape
Section titled "isShape"Inherited from: IgrSplineSeriesBase
Gets whether the current series is a shape type series.
get isShape(): boolean Returns boolean
isShapeControl
Section titled "isShapeControl"Inherited from: IgrSplineSeriesBase
Gets whether the current series shows interactive shape controls.
get isShapeControl(): boolean Returns boolean
isSpline
Section titled "isSpline"Gets whether the current series shows a spline shape.
get isSpline(): boolean Returns boolean
isStacked
Section titled "isStacked"Inherited from: IgrSplineSeriesBase
Gets whether the current series is a stacked type series.
``
get isStacked(): boolean Returns boolean
isStep
Section titled "isStep"Inherited from: IgrSplineSeriesBase
Gets whether the current series shows step shapes.
get isStep(): boolean Returns boolean
isSummarizationSupported
Section titled "isSummarizationSupported"Inherited from: IgrSplineSeriesBase
Gets whether the series supports summarization in Data Legend and Data Tooltip.
get isSummarizationSupported(): boolean Returns boolean
isTile
Section titled "isTile"Inherited from: IgrSplineSeriesBase
Gets whether the current series shows a tile imagery.
get isTile(): boolean Returns boolean
isToolTipLayer
Section titled "isToolTipLayer"Inherited from: IgrSplineSeriesBase
Gets whether the series is an annotation layer.
get isToolTipLayer(): boolean Returns boolean
isUsableInLegend
Section titled "isUsableInLegend"Inherited from: IgrSplineSeriesBase
Gets if the series should appear in any legends.
``
get isUsableInLegend(): boolean Returns boolean
isUserAnnotationLayer
Section titled "isUserAnnotationLayer"Inherited from: IgrSplineSeriesBase
Gets whether the series is final value annotation layer.
get isUserAnnotationLayer(): boolean Returns boolean
isUserAnnotationToolTipLayer
Section titled "isUserAnnotationToolTipLayer"Inherited from: IgrSplineSeriesBase
Gets whether the series is final user annotation tooltip layer.
get isUserAnnotationToolTipLayer(): boolean Returns boolean
isValueAxisInverted
Section titled "isValueAxisInverted"Inherited from: IgrSplineSeriesBase
Gets whether the current series shows an area shape.
get isValueAxisInverted(): boolean Returns boolean
isValueOverlay
Section titled "isValueOverlay"Inherited from: IgrSplineSeriesBase
Gets whether the series is a value overlay.
get isValueOverlay(): boolean Returns boolean
isVertical
Section titled "isVertical"Inherited from: IgrSplineSeriesBase
Gets whether the current series is oriented vertically.
``
get isVertical(): boolean Returns boolean
isWaterfall
Section titled "isWaterfall"Inherited from: IgrSplineSeriesBase
Gets whether the current series shows a waterfall column shape.
get isWaterfall(): boolean Returns boolean
seriesInternal
Section titled "seriesInternal"Inherited from: IgrSplineSeriesBase
get seriesInternal(): any Returns any
get i(): Series Returns Series
Methods
Section titled "Methods"bindAxes
Section titled "bindAxes"Inherited from: IgrSplineSeriesBase
bindAxes(axes: IgrAxis<IIgrAxisProps>[]): void Parameters
- axes:
IgrAxis<IIgrAxisProps>[]
Returns void
bindSeries
Section titled "bindSeries"Inherited from: IgrSplineSeriesBase
bindSeries(series: IgrSeries<IIgrSeriesProps>[]): void Parameters
- series:
IgrSeries<IIgrSeriesProps>[]
Returns void
canUseAsXAxis
Section titled "canUseAsXAxis"Inherited from: IgrSplineSeriesBase
Determine if object can be used as XAxis
canUseAsXAxis(axis: any): boolean Parameters
- axis:
any- The object to check
You can use the
CanUseAsXAxismethod to determine if object can be used as XAxisvar x = this.financialSeries.CanUseAsXAxis(this.xAxis);
Returns boolean
canUseAsYAxis
Section titled "canUseAsYAxis"Inherited from: IgrSplineSeriesBase
Determine if object can be used as YAxis
canUseAsYAxis(axis: any): boolean Parameters
- axis:
any- The object to check
You can use the
CanUseAsYAxismethod to determine if object can be used as YAxisN/A
Returns boolean
componentDidMount
Section titled "componentDidMount"Inherited from: IgrSplineSeriesBase
componentDidMount(): void Returns void
findByName
Section titled "findByName"Inherited from: IgrSplineSeriesBase
findByName(name: string): any Parameters
- name:
string
Returns any
fromWorldPosition
Section titled "fromWorldPosition"Inherited from: IgrSplineSeriesBase
Converts a point from world coordinates to coordinates within the viewport of the series.
fromWorldPosition(world: IgPoint): IgPoint Parameters
- world:
IgPoint- The world position from which to convert.
Returns IgPoint
getCategoryWidth
Section titled "getCategoryWidth"Inherited from: IgrSplineSeriesBase
Returns the width of the category grouping this series is in.
You can use the GetCategoryWidth to get the width of the category grouping a series is in.
var x = this.financialSeries.CanUseAsXAxis(this.xAxis);
N/A
getCategoryWidth(): number Returns number
getEffectiveViewport
Section titled "getEffectiveViewport"Inherited from: IgrSplineSeriesBase
Gets the effective viewport, adjusted to account for margins and other factors.
getEffectiveViewport(): IgRect Returns IgRect
getExactItemIndex
Section titled "getExactItemIndex"Inherited from: IgrSplineSeriesBase
Gets the precise item index, if possible, based on the closeness to the previous or next whole integer. If the series cannot provide this information, GetExactItemIndex will return the same integer value as GetItemIndex.
getExactItemIndex(world: IgPoint): number Parameters
- world:
IgPoint- The world position for which to return the index.
Returns number
getItem
Section titled "getItem"Inherited from: IgrSplineSeriesBase
Gets the item that is the best match for the specified world coordinates.
getItem(world: IgPoint): any Parameters
- world:
IgPoint- The world coordinates to use.
The
getItemmethod is used to gets the item that is the best match for the specified world coordinates.let item: number = this.series.getItem({x:.5,y:.5});
Returns any
getItemIndex
Section titled "getItemIndex"Inherited from: IgrSplineSeriesBase
Gets the index of the item based on world coordinates.
getItemIndex(world: IgPoint): number Parameters
- world:
IgPoint- The world coordinates to use.
Returns number
getItemSpan
Section titled "getItemSpan"Inherited from: IgrSplineSeriesBase
For a category plotted series, returns the current width of the items within the categories. This only returns a value if the items have some form of width (e.g. columns, bars, etc.) otherwise 0 is returned.
``
getItemSpan(): number Returns number
getItemValue
Section titled "getItemValue"Inherited from: IgrSplineSeriesBase
getItemValue(item: any, memberPathName: string): any Parameters
- item:
any - memberPathName:
string
Returns any
getMainContentViewport
Section titled "getMainContentViewport"Inherited from: IgrSplineSeriesBase
getMainContentViewport(): IgRect Returns IgRect
getMemberPathValue
Section titled "getMemberPathValue"Inherited from: IgrSplineSeriesBase
Gets the value of a requested member path from the series.
getMemberPathValue(memberPathName: string): string Parameters
- memberPathName:
string- The property name of a valid member path for the series
Returns string
getNextOrExactIndex
Section titled "getNextOrExactIndex"Inherited from: IgrSplineSeriesBase
getNextOrExactIndex(world: IgPoint, skipUnknowns: boolean): number Parameters
- world:
IgPoint - skipUnknowns:
boolean
Returns number
getOffsetValue
Section titled "getOffsetValue"Inherited from: IgrSplineSeriesBase
Returns the offset value for this series if grouped on a category axis.
You can use the GetOffsetValue to get the offset value for this series if grouped on a category axis.
var g = series.getOffsetValue();
N/A
getOffsetValue(): number Returns number
getPreviousOrExactIndex
Section titled "getPreviousOrExactIndex"Inherited from: IgrSplineSeriesBase
getPreviousOrExactIndex(world: IgPoint, skipUnknowns: boolean): number Parameters
- world:
IgPoint - skipUnknowns:
boolean
Returns number
getSeriesHighValue
Section titled "getSeriesHighValue"Inherited from: IgrSplineSeriesBase
getSeriesHighValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number Parameters
- world:
IgPoint - useInterpolation:
boolean - skipUnknowns:
boolean
Returns number
getSeriesHighValuePosition
Section titled "getSeriesHighValuePosition"Inherited from: IgrSplineSeriesBase
getSeriesHighValuePosition(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint Parameters
- world:
IgPoint - useInterpolation:
boolean - skipUnknowns:
boolean
Returns IgPoint
getSeriesLowValue
Section titled "getSeriesLowValue"Inherited from: IgrSplineSeriesBase
getSeriesLowValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number Parameters
- world:
IgPoint - useInterpolation:
boolean - skipUnknowns:
boolean
Returns number
getSeriesLowValuePosition
Section titled "getSeriesLowValuePosition"Inherited from: IgrSplineSeriesBase
getSeriesLowValuePosition(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint Parameters
- world:
IgPoint - useInterpolation:
boolean - skipUnknowns:
boolean
Returns IgPoint
getSeriesValue
Section titled "getSeriesValue"Inherited from: IgrSplineSeriesBase
getSeriesValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number Parameters
- world:
IgPoint - useInterpolation:
boolean - skipUnknowns:
boolean
Returns number
getSeriesValueBoundingBox
Section titled "getSeriesValueBoundingBox"Inherited from: IgrSplineSeriesBase
If possible, will return the best available value bounding box within the series that has the best value match for the world position provided.
getSeriesValueBoundingBox(world: IgPoint): IgRect Parameters
- world:
IgPoint- The world coordinate for which to get a value bounding box for
Returns IgRect
getSeriesValueFromSeriesPixel
Section titled "getSeriesValueFromSeriesPixel"Inherited from: IgrSplineSeriesBase
getSeriesValueFromSeriesPixel(mouse: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number Parameters
- mouse:
IgPoint - useInterpolation:
boolean - skipUnknowns:
boolean
Returns number
getSeriesValueMarkerBoundingBox
Section titled "getSeriesValueMarkerBoundingBox"Inherited from: IgrSplineSeriesBase
If possible, will return the best available value marker bounding box within the series that has the best value match for the world position provided.
getSeriesValueMarkerBoundingBox(world: IgPoint): IgRect Parameters
- world:
IgPoint- The world coordinates for which to get a value marker bounding box for
You can use the
GetCategoryWidthto get the width of the category grouping a series is in.var x = financialSeries.GetSeriesValueMarkerBoundingBox(new IgxPoint());N/A
Returns IgRect
getSeriesValuePosition
Section titled "getSeriesValuePosition"Inherited from: IgrSplineSeriesBase
getSeriesValuePosition(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint Parameters
- world:
IgPoint - useInterpolation:
boolean - skipUnknowns:
boolean
Returns IgPoint
getSeriesValuePositionFromSeriesPixel
Section titled "getSeriesValuePositionFromSeriesPixel"Inherited from: IgrSplineSeriesBase
getSeriesValuePositionFromSeriesPixel(mouse: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint Parameters
- mouse:
IgPoint - useInterpolation:
boolean - skipUnknowns:
boolean
Returns IgPoint
getSeriesValueType
Section titled "getSeriesValueType"Inherited from: IgrSplineSeriesBase
Gets a numeric value from the numeric axis associated with this series that matches the desired value mode.
getSeriesValueType(mode: string | ValueLayerValueMode): number[] Parameters
- mode:
string | ValueLayerValueMode- The type of value desired from the series numeric axis.
Returns number[]
getSeriesValueTypePosition
Section titled "getSeriesValueTypePosition"Inherited from: IgrSplineSeriesBase
Gets position of series value for specified layer value mode
getSeriesValueTypePosition(mode: string | ValueLayerValueMode): IgPoint Parameters
- mode:
string | ValueLayerValueMode
Returns IgPoint
getSeriesValueTypePositionFromValue
Section titled "getSeriesValueTypePositionFromValue"Inherited from: IgrSplineSeriesBase
getSeriesValueTypePositionFromValue(values: number[]): IgPoint Parameters
- values:
number[]
Returns IgPoint
getUnscaledPosition
Section titled "getUnscaledPosition"Inherited from: IgrSplineSeriesBase
Gets an unscaled position in terms of axis values from a viewport position.
getUnscaledPosition(pos: IgPoint): IgPoint Parameters
- pos:
IgPoint- The viewport relative position
Returns IgPoint
hideToolTips
Section titled "hideToolTips"Inherited from: IgrSplineSeriesBase
Hides any internal tooltips presented by the series, if any.
hideToolTips(): void Returns void
hideToolTipsImmediate
Section titled "hideToolTipsImmediate"Inherited from: IgrSplineSeriesBase
Hides any internal tooltips presented by the series, if any.
hideToolTipsImmediate(): void Returns void
moveCursorPoint
Section titled "moveCursorPoint"Inherited from: IgrSplineSeriesBase
Moves the cursor point to the provided world position. Some series may react to the current cursor position.
moveCursorPoint(point: IgPoint): void Parameters
- point:
IgPoint- The cursor point, in world coordinates.
MoveCursorPointcan be used on annotation layers to programitically show the annotation at the given point.this.crosshair.moveCursorPoint({x:.5,y:.5});
Returns void
notifyIndexedPropertiesChanged
Section titled "notifyIndexedPropertiesChanged"Inherited from: IgrSplineSeriesBase
Called to notify about changes to indexed-based properties, e.g. Brushes, Outlines, MarkerBrushes, MarkerOutlines and refresh series
notifyIndexedPropertiesChanged(): void Returns void
notifyVisualPropertiesChanged
Section titled "notifyVisualPropertiesChanged"Inherited from: IgrSplineSeriesBase
Notifies the series that a visual property has changed, requiring a visual update.
notifyVisualPropertiesChanged(): void Returns void
playTransitionIn
Section titled "playTransitionIn"Inherited from: IgrSplineSeriesBase
Plays the assigned transition out animation, if any.
playTransitionIn(): void Returns void
playTransitionOut
Section titled "playTransitionOut"Inherited from: IgrSplineSeriesBase
Plays the assigned transition out animation, if any.
playTransitionOut(): void Returns void
playTransitionOutAndRemove
Section titled "playTransitionOutAndRemove"Inherited from: IgrSplineSeriesBase
Plays the assigned transition out animation, if any.
playTransitionOutAndRemove(): void Returns void
provideData
Section titled "provideData"Inherited from: IgrSplineSeriesBase
provideData(data: any[]): void Parameters
- data:
any[]
Returns void
provideHighlightedData
Section titled "provideHighlightedData"Inherited from: IgrSplineSeriesBase
provideHighlightedData(data: any[]): void Parameters
- data:
any[]
Returns void
removeAllAlternateViews
Section titled "removeAllAlternateViews"Inherited from: IgrSplineSeriesBase
Removes all alternate views of this series.
removeAllAlternateViews(): void Returns void
removeAlternateView
Section titled "removeAlternateView"Inherited from: IgrSplineSeriesBase
Removes an alternate view of this series.
removeAlternateView(viewIdentifier: string): void Parameters
- viewIdentifier:
string- The string identifier for the view to remove.
Returns void
removeAxes
Section titled "removeAxes"Inherited from: IgrSplineSeriesBase
Call to null out the axes of the series;
removeAxes(): void Returns void
render
Section titled "render"Inherited from: IgrSplineSeriesBase
render(): any Returns any
renderSeries
Section titled "renderSeries"Inherited from: IgrSplineSeriesBase
Renders the series.
renderSeries(animate: boolean): void Parameters
- animate:
boolean- True if the change should be animated.
this.series.renderSeries(true);
Returns void
replayTransitionIn
Section titled "replayTransitionIn"Inherited from: IgrSplineSeriesBase
Replays the assigned transition in animation, if any.
``
replayTransitionIn(): void Returns void
resolveTooltipBrush
Section titled "resolveTooltipBrush"Inherited from: IgrSplineSeriesBase
Gets the brush for tooltip labels.
resolveTooltipBrush(): string Returns string
scrollIntoView
Section titled "scrollIntoView"Inherited from: IgrSplineSeriesBase
Scrolls the series to display the item for the specified data item. The series is scrolled by the minimum amount required to place the specified data item within the central 80% of the visible axis.
scrollIntoView(item: any): boolean Parameters
- item:
any- The data item (item) to scroll to.
The
ScrollIntoViewmethod is used to notifies the target axis or series that it should scroll the requested data item into view.this.series.scrollIntoView(dataItem);
Returns boolean
setNegativeColors
Section titled "setNegativeColors"Inherited from: IgrSplineSeriesBase
setNegativeColors(negativeBrush: string, negativeOutline: string): void Parameters
- negativeBrush:
string - negativeOutline:
string
Returns void
shouldComponentUpdate
Section titled "shouldComponentUpdate"Inherited from: IgrSplineSeriesBase
shouldComponentUpdate(nextProps: any, nextState: any): boolean Parameters
- nextProps:
any - nextState:
any
Returns boolean
simulateHover
Section titled "simulateHover"Inherited from: IgrSplineSeriesBase
Simulates a pointer hover over the series surface.
simulateHover(point: IgPoint): void Parameters
- point:
IgPoint- The pointer position relative to the series viewport over which to hover.
When tooltips are enabled,
SimulateHovercan be used to automatically display the tooltip over a particular series item.this.series.simulateHover({x:250,y:250});
Returns void
styleUpdated
Section titled "styleUpdated"Inherited from: IgrSplineSeriesBase
Called when this series' Style is updated.
styleUpdated(): void Returns void
toWorldPosition
Section titled "toWorldPosition"Inherited from: IgrSplineSeriesBase
Converts a point from coordinates within the series plot area to a world position within axis space.
toWorldPosition(seriesPoint: IgPoint): IgPoint Parameters
- seriesPoint:
IgPoint- The pixel location within the plot area of the series.
this.series.toWorldPosition({x:500,y:500});
Returns IgPoint
toWorldRect
Section titled "toWorldRect"Inherited from: IgrSplineSeriesBase
Converts a rect from coordinates within the series plot area to a world position within axis space.
toWorldRect(rect: IgRect): IgRect Parameters
- rect:
IgRect- The pixel rect within the plot area of the series.
Returns IgRect
_createFromInternal
Section titled "_createFromInternal"Inherited from: IgrSplineSeriesBase
_createFromInternal(internal: any): IgrSeries Parameters
- internal:
any