Represents a DataChartComponent financial price series that renders as Candlestick or OHLC representations. Default required members: Open, Low, High, Close
The FinancialPriceSeries class represents a DataChartComponent financial price series that renders as Candlestick or OHLC representations.
``
``
Constructors
Section titled "Constructors"IgrFinancialPriceSeries
new IgrFinancialPriceSeries(props: IIgrFinancialPriceSeriesProps): IgrFinancialPriceSeries Returns IgrFinancialPriceSeries
Properties
Section titled "Properties"actualAreaFillOpacity
Section titled "actualAreaFillOpacity"Inherited from: IgrFinancialSeries
actualAreaFillOpacity: number actualBrush
Section titled "actualBrush"Inherited from: IgrFinancialSeries
actualBrush: string actualFocusBrush
Section titled "actualFocusBrush"Inherited from: IgrFinancialSeries
actualFocusBrush: string actualFocusMode
Section titled "actualFocusMode"Inherited from: IgrFinancialSeries
actualFocusMode: SeriesSelectionMode actualHighlightedValuesFadeOpacity
Section titled "actualHighlightedValuesFadeOpacity"Inherited from: IgrFinancialSeries
actualHighlightedValuesFadeOpacity: number actualHighlightingFadeOpacity
Section titled "actualHighlightingFadeOpacity"Inherited from: IgrFinancialSeries
actualHighlightingFadeOpacity: number actualHighlightingMode
Section titled "actualHighlightingMode"Inherited from: IgrFinancialSeries
actualHighlightingMode: SeriesHighlightingMode actualHitTestMode
Section titled "actualHitTestMode"Inherited from: IgrFinancialSeries
actualHitTestMode: SeriesHitTestMode actualLayers
Section titled "actualLayers"Inherited from: IgrFinancialSeries
actualLayers: IgrSeriesLayerCollection actualLegendItemBadgeBrush
Section titled "actualLegendItemBadgeBrush"Inherited from: IgrFinancialSeries
actualLegendItemBadgeBrush: string actualLegendItemBadgeOutline
Section titled "actualLegendItemBadgeOutline"Inherited from: IgrFinancialSeries
actualLegendItemBadgeOutline: string actualLegendItemBadgeTemplate
Section titled "actualLegendItemBadgeTemplate"Inherited from: IgrFinancialSeries
actualLegendItemBadgeTemplate: IgDataTemplate actualMarkerFillOpacity
Section titled "actualMarkerFillOpacity"Inherited from: IgrFinancialSeries
actualMarkerFillOpacity: number actualOutline
Section titled "actualOutline"Inherited from: IgrFinancialSeries
actualOutline: string actualResolution
Section titled "actualResolution"Inherited from: IgrFinancialSeries
actualResolution: number actualSelectionBrush
Section titled "actualSelectionBrush"Inherited from: IgrFinancialSeries
actualSelectionBrush: string actualSelectionMode
Section titled "actualSelectionMode"Inherited from: IgrFinancialSeries
actualSelectionMode: SeriesSelectionMode actualThickness
Section titled "actualThickness"Inherited from: IgrFinancialSeries
actualThickness: number actualTrendLineBrush
Section titled "actualTrendLineBrush"actualTrendLineBrush: string areaFillOpacity
Section titled "areaFillOpacity"Inherited from: IgrFinancialSeries
areaFillOpacity: number assigningCategoryStyle
Section titled "assigningCategoryStyle"Inherited from: IgrFinancialSeries
assigningCategoryStyle: object attachTooltipToRoot
Section titled "attachTooltipToRoot"Inherited from: IgrFinancialSeries
attachTooltipToRoot: boolean autoCalloutLabelFormat
Section titled "autoCalloutLabelFormat"Inherited from: IgrFinancialSeries
autoCalloutLabelFormat: string autoCalloutLabelFormatSpecifiers
Section titled "autoCalloutLabelFormatSpecifiers"Inherited from: IgrFinancialSeries
autoCalloutLabelFormatSpecifiers: any[] autoCalloutValueLabelFormat
Section titled "autoCalloutValueLabelFormat"Inherited from: IgrFinancialSeries
autoCalloutValueLabelFormat: string autoCalloutValueLabelFormatSpecifiers
Section titled "autoCalloutValueLabelFormatSpecifiers"Inherited from: IgrFinancialSeries
autoCalloutValueLabelFormatSpecifiers: any[] brush
Section titled "brush"Inherited from: IgrFinancialSeries
brush: string categoryCollisionMode
Section titled "categoryCollisionMode"categoryCollisionMode: CategoryCollisionMode closeMemberAsLegendLabel
Section titled "closeMemberAsLegendLabel"closeMemberAsLegendLabel: string closeMemberAsLegendUnit
Section titled "closeMemberAsLegendUnit"closeMemberAsLegendUnit: string closeMemberPath
Section titled "closeMemberPath"Inherited from: IgrFinancialSeries
closeMemberPath: string coercionMethods
Section titled "coercionMethods"Inherited from: IgrFinancialSeries
coercionMethods: any dashArray
Section titled "dashArray"Inherited from: IgrFinancialSeries
dashArray: number[] dataLegendGroup
Section titled "dataLegendGroup"Inherited from: IgrFinancialSeries
dataLegendGroup: string dataSource
Section titled "dataSource"Inherited from: IgrFinancialSeries
dataSource: any discreteLegendItemTemplate
Section titled "discreteLegendItemTemplate"Inherited from: IgrFinancialSeries
discreteLegendItemTemplate: IgDataTemplate displayType
Section titled "displayType"displayType: PriceDisplayType expectFunctions
Section titled "expectFunctions"Inherited from: IgrFinancialSeries
expectFunctions: boolean finalValue
Section titled "finalValue"Inherited from: IgrFinancialSeries
finalValue: number focusBrush
Section titled "focusBrush"Inherited from: IgrFinancialSeries
focusBrush: string highlightedCloseMemberPath
Section titled "highlightedCloseMemberPath"Inherited from: IgrFinancialSeries
highlightedCloseMemberPath: string highlightedDataSource
Section titled "highlightedDataSource"Inherited from: IgrFinancialSeries
highlightedDataSource: any highlightedHighMemberPath
Section titled "highlightedHighMemberPath"Inherited from: IgrFinancialSeries
highlightedHighMemberPath: string highlightedLegendItemVisibility
Section titled "highlightedLegendItemVisibility"Inherited from: IgrFinancialSeries
highlightedLegendItemVisibility: Visibility highlightedLowMemberPath
Section titled "highlightedLowMemberPath"Inherited from: IgrFinancialSeries
highlightedLowMemberPath: string highlightedOpenMemberPath
Section titled "highlightedOpenMemberPath"Inherited from: IgrFinancialSeries
highlightedOpenMemberPath: string highlightedTitleSuffix
Section titled "highlightedTitleSuffix"Inherited from: IgrFinancialSeries
highlightedTitleSuffix: string highlightedValuesDataLegendGroup
Section titled "highlightedValuesDataLegendGroup"Inherited from: IgrFinancialSeries
highlightedValuesDataLegendGroup: string highlightedValuesDisplayMode
Section titled "highlightedValuesDisplayMode"Inherited from: IgrFinancialSeries
highlightedValuesDisplayMode: SeriesHighlightedValuesDisplayMode highlightedValuesExtraPropertyOverlays
Section titled "highlightedValuesExtraPropertyOverlays"Inherited from: IgrFinancialSeries
highlightedValuesExtraPropertyOverlays: IgrSeriesLayerPropertyOverlayCollection highlightedValuesFadeOpacity
Section titled "highlightedValuesFadeOpacity"Inherited from: IgrFinancialSeries
highlightedValuesFadeOpacity: number highlightedVolumeMemberPath
Section titled "highlightedVolumeMemberPath"Inherited from: IgrFinancialSeries
highlightedVolumeMemberPath: string highlightingFadeOpacity
Section titled "highlightingFadeOpacity"Inherited from: IgrFinancialSeries
highlightingFadeOpacity: number highMemberAsLegendLabel
Section titled "highMemberAsLegendLabel"highMemberAsLegendLabel: string highMemberAsLegendUnit
Section titled "highMemberAsLegendUnit"highMemberAsLegendUnit: string highMemberPath
Section titled "highMemberPath"Inherited from: IgrFinancialSeries
highMemberPath: string hitTestMode
Section titled "hitTestMode"Inherited from: IgrFinancialSeries
hitTestMode: SeriesHitTestMode index
Section titled "index"Inherited from: IgrFinancialSeries
index: number isActualLegendFinancial
Section titled "isActualLegendFinancial"Inherited from: IgrFinancialSeries
isActualLegendFinancial: boolean isComponentHighlightingModeIgnored
Section titled "isComponentHighlightingModeIgnored"Inherited from: IgrFinancialSeries
isComponentHighlightingModeIgnored: boolean isCustomCategoryStyleAllowed
Section titled "isCustomCategoryStyleAllowed"Inherited from: IgrFinancialSeries
isCustomCategoryStyleAllowed: boolean isDefaultToolTipSelected
Section titled "isDefaultToolTipSelected"Inherited from: IgrFinancialSeries
isDefaultToolTipSelected: boolean isDropShadowEnabled
Section titled "isDropShadowEnabled"Inherited from: IgrFinancialSeries
isDropShadowEnabled: boolean isHighlightingEnabled
Section titled "isHighlightingEnabled"Inherited from: IgrFinancialSeries
isHighlightingEnabled: boolean isTransitionInEnabled
Section titled "isTransitionInEnabled"Inherited from: IgrFinancialSeries
isTransitionInEnabled: boolean layers
Section titled "layers"Inherited from: IgrFinancialSeries
layers: IgrSeriesLayerCollection legend
Section titled "legend"Inherited from: IgrFinancialSeries
legend: any legendItemBadgeMode
Section titled "legendItemBadgeMode"Inherited from: IgrFinancialSeries
legendItemBadgeMode: LegendItemBadgeMode legendItemBadgeShape
Section titled "legendItemBadgeShape"Inherited from: IgrFinancialSeries
legendItemBadgeShape: LegendItemBadgeShape legendItemBadgeTemplate
Section titled "legendItemBadgeTemplate"Inherited from: IgrFinancialSeries
legendItemBadgeTemplate: IgDataTemplate legendItemTemplate
Section titled "legendItemTemplate"Inherited from: IgrFinancialSeries
legendItemTemplate: IgDataTemplate legendItemVisibility
Section titled "legendItemVisibility"Inherited from: IgrFinancialSeries
legendItemVisibility: Visibility lineCap
Section titled "lineCap"Inherited from: IgrFinancialSeries
lineCap: PenLineCap lineJoin
Section titled "lineJoin"Inherited from: IgrFinancialSeries
lineJoin: PenLineJoin lowMemberAsLegendLabel
Section titled "lowMemberAsLegendLabel"lowMemberAsLegendLabel: string lowMemberAsLegendUnit
Section titled "lowMemberAsLegendUnit"lowMemberAsLegendUnit: string lowMemberPath
Section titled "lowMemberPath"Inherited from: IgrFinancialSeries
lowMemberPath: string markerFillOpacity
Section titled "markerFillOpacity"Inherited from: IgrFinancialSeries
markerFillOpacity: number mouseOverEnabled
Section titled "mouseOverEnabled"Inherited from: IgrFinancialSeries
mouseOverEnabled: boolean Inherited from: IgrFinancialSeries
name: string negativeBrush
Section titled "negativeBrush"Inherited from: IgrFinancialSeries
negativeBrush: string negativeOutline
Section titled "negativeOutline"negativeOutline: string opacity
Section titled "opacity"Inherited from: IgrFinancialSeries
opacity: number openMemberAsLegendLabel
Section titled "openMemberAsLegendLabel"openMemberAsLegendLabel: string openMemberAsLegendUnit
Section titled "openMemberAsLegendUnit"openMemberAsLegendUnit: string openMemberPath
Section titled "openMemberPath"Inherited from: IgrFinancialSeries
openMemberPath: string outline
Section titled "outline"Inherited from: IgrFinancialSeries
outline: string outlineMode
Section titled "outlineMode"Inherited from: IgrFinancialSeries
outlineMode: SeriesOutlineMode percentChange
Section titled "percentChange"Inherited from: IgrFinancialSeries
percentChange: number renderRequested
Section titled "renderRequested"Inherited from: IgrFinancialSeries
renderRequested: object resolution
Section titled "resolution"Inherited from: IgrFinancialSeries
resolution: number safeActualBrush
Section titled "safeActualBrush"Inherited from: IgrFinancialSeries
safeActualBrush: string selectionBrush
Section titled "selectionBrush"Inherited from: IgrFinancialSeries
selectionBrush: string selectionThickness
Section titled "selectionThickness"Inherited from: IgrFinancialSeries
selectionThickness: number shadowBlur
Section titled "shadowBlur"Inherited from: IgrFinancialSeries
shadowBlur: number shadowColor
Section titled "shadowColor"Inherited from: IgrFinancialSeries
shadowColor: string shadowOffsetX
Section titled "shadowOffsetX"Inherited from: IgrFinancialSeries
shadowOffsetX: number shadowOffsetY
Section titled "shadowOffsetY"Inherited from: IgrFinancialSeries
shadowOffsetY: number shouldAnimateOnDataSourceSwap
Section titled "shouldAnimateOnDataSourceSwap"Inherited from: IgrFinancialSeries
shouldAnimateOnDataSourceSwap: boolean shouldHideAutoCallouts
Section titled "shouldHideAutoCallouts"Inherited from: IgrFinancialSeries
shouldHideAutoCallouts: boolean shouldRemoveHighlightedDataOnLayerHidden
Section titled "shouldRemoveHighlightedDataOnLayerHidden"Inherited from: IgrFinancialSeries
shouldRemoveHighlightedDataOnLayerHidden: boolean shouldShiftOpacityForSafeActualBrush
Section titled "shouldShiftOpacityForSafeActualBrush"Inherited from: IgrFinancialSeries
shouldShiftOpacityForSafeActualBrush: boolean showDefaultTooltip
Section titled "showDefaultTooltip"Inherited from: IgrFinancialSeries
showDefaultTooltip: boolean thickness
Section titled "thickness"Inherited from: IgrFinancialSeries
thickness: number title
Section titled "title"Inherited from: IgrFinancialSeries
title: any tooltipContainerTemplate
Section titled "tooltipContainerTemplate"Inherited from: IgrFinancialSeries
tooltipContainerTemplate: any tooltipTemplate
Section titled "tooltipTemplate"Inherited from: IgrFinancialSeries
tooltipTemplate: any transitionDuration
Section titled "transitionDuration"Inherited from: IgrFinancialSeries
transitionDuration: number transitionEasingFunction
Section titled "transitionEasingFunction"Inherited from: IgrFinancialSeries
transitionEasingFunction: object transitionInDuration
Section titled "transitionInDuration"Inherited from: IgrFinancialSeries
transitionInDuration: number transitionInEasingFunction
Section titled "transitionInEasingFunction"Inherited from: IgrFinancialSeries
transitionInEasingFunction: object transitionInMode
Section titled "transitionInMode"Inherited from: IgrFinancialSeries
transitionInMode: CategoryTransitionInMode transitionInSpeedType
Section titled "transitionInSpeedType"Inherited from: IgrFinancialSeries
transitionInSpeedType: TransitionInSpeedType transitionOutCompleted
Section titled "transitionOutCompleted"Inherited from: IgrFinancialSeries
transitionOutCompleted: object transitionOutDuration
Section titled "transitionOutDuration"Inherited from: IgrFinancialSeries
transitionOutDuration: number transitionOutEasingFunction
Section titled "transitionOutEasingFunction"Inherited from: IgrFinancialSeries
transitionOutEasingFunction: object transitionOutSpeedType
Section titled "transitionOutSpeedType"Inherited from: IgrFinancialSeries
transitionOutSpeedType: TransitionOutSpeedType trendLineBrush
Section titled "trendLineBrush"trendLineBrush: string trendLineDashArray
Section titled "trendLineDashArray"trendLineDashArray: number[] trendLinePeriod
Section titled "trendLinePeriod"trendLinePeriod: number trendLineThickness
Section titled "trendLineThickness"trendLineThickness: number trendLineType
Section titled "trendLineType"trendLineType: TrendLineType typical
Section titled "typical"Inherited from: IgrFinancialSeries
typical: object typicalBasedOn
Section titled "typicalBasedOn"Inherited from: IgrFinancialSeries
typicalBasedOn: object useItemWiseColors
Section titled "useItemWiseColors"Inherited from: IgrFinancialSeries
useItemWiseColors: boolean useSingleShadow
Section titled "useSingleShadow"Inherited from: IgrFinancialSeries
useSingleShadow: boolean visibility
Section titled "visibility"Inherited from: IgrFinancialSeries
visibility: Visibility visibleRangeMarginBottom
Section titled "visibleRangeMarginBottom"Inherited from: IgrFinancialSeries
visibleRangeMarginBottom: number visibleRangeMarginLeft
Section titled "visibleRangeMarginLeft"Inherited from: IgrFinancialSeries
visibleRangeMarginLeft: number visibleRangeMarginRight
Section titled "visibleRangeMarginRight"Inherited from: IgrFinancialSeries
visibleRangeMarginRight: number visibleRangeMarginTop
Section titled "visibleRangeMarginTop"Inherited from: IgrFinancialSeries
visibleRangeMarginTop: number visibleRangeMode
Section titled "visibleRangeMode"Inherited from: IgrFinancialSeries
visibleRangeMode: SeriesVisibleRangeMode volumeMemberPath
Section titled "volumeMemberPath"Inherited from: IgrFinancialSeries
volumeMemberPath: string xAxis
Section titled "xAxis"Inherited from: IgrFinancialSeries
xAxis: IgrCategoryAxisBase xAxisName
Section titled "xAxisName"Inherited from: IgrFinancialSeries
xAxisName: string yAxis
Section titled "yAxis"Inherited from: IgrFinancialSeries
yAxis: IgrNumericYAxis yAxisName
Section titled "yAxisName"Inherited from: IgrFinancialSeries
yAxisName: string Accessors
Section titled "Accessors"actualCloseLabel
Section titled "actualCloseLabel"Inherited from: IgrFinancialSeries
Gets the text that is displayed for the Close label in the tooltip.
get actualCloseLabel(): string Returns string
actualHighLabel
Section titled "actualHighLabel"Inherited from: IgrFinancialSeries
Gets the text that is displayed for the High label in the tooltip.
get actualHighLabel(): string Returns string
actualLowLabel
Section titled "actualLowLabel"Inherited from: IgrFinancialSeries
Gets the text that is displayed for the Low label in the tooltip.
get actualLowLabel(): string Returns string
actualOpenLabel
Section titled "actualOpenLabel"Inherited from: IgrFinancialSeries
Gets the text that is displayed for the Open label in the tooltip.
get actualOpenLabel(): string Returns string
actualRadiusLabel
Section titled "actualRadiusLabel"Inherited from: IgrFinancialSeries
Gets the text that is displayed for the Value label in the tooltip.
get actualRadiusLabel(): string Returns string
actualValueLabel
Section titled "actualValueLabel"Inherited from: IgrFinancialSeries
Gets the text that is displayed for the Value label in the tooltip.
get actualValueLabel(): string Returns string
actualVolumeLabel
Section titled "actualVolumeLabel"Inherited from: IgrFinancialSeries
Gets the text that is displayed for the Volume label in the tooltip.
get actualVolumeLabel(): string Returns string
dataLegendKey
Section titled "dataLegendKey"Inherited from: IgrFinancialSeries
Gets unique key used to identify the series in data legend
get dataLegendKey(): string Returns string
hasMarkers
Section titled "hasMarkers"Inherited from: IgrFinancialSeries
Returns whether the current series supports visual markers.
``
get hasMarkers(): boolean Returns boolean
hasOnlyMarkers
Section titled "hasOnlyMarkers"Inherited from: IgrFinancialSeries
Gets whether the series has only marker as visuals
get hasOnlyMarkers(): boolean Returns boolean
hasValueAxis
Section titled "hasValueAxis"Inherited from: IgrFinancialSeries
Gets whether the current series shows an area shape.
get hasValueAxis(): boolean Returns boolean
hasVisibleMarkers
Section titled "hasVisibleMarkers"Inherited from: IgrFinancialSeries
Returns whether the current series has a visible marker style.
get hasVisibleMarkers(): boolean Returns boolean
isAnnotationCalloutLayer
Section titled "isAnnotationCalloutLayer"Inherited from: IgrFinancialSeries
Gets whether the series is an callout annotation layer.
get isAnnotationCalloutLayer(): boolean Returns boolean
isAnnotationCrosshairLayer
Section titled "isAnnotationCrosshairLayer"Inherited from: IgrFinancialSeries
Gets whether the series is an crosshair annotation layer.
get isAnnotationCrosshairLayer(): boolean Returns boolean
isAnnotationDataLayer
Section titled "isAnnotationDataLayer"Inherited from: IgrFinancialSeries
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: IgrFinancialSeries
Gets whether the series is final value annotation layer.
get isAnnotationFinalValue(): boolean Returns boolean
isAnnotationHoverLayer
Section titled "isAnnotationHoverLayer"Inherited from: IgrFinancialSeries
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: IgrFinancialSeries
Gets whether the series is an annotation layer.
``
get isAnnotationLayer(): boolean Returns boolean
isAnnotationValueLayer
Section titled "isAnnotationValueLayer"Inherited from: IgrFinancialSeries
Gets whether the series is a value annotation layer.
get isAnnotationValueLayer(): boolean Returns boolean
isArea
Section titled "isArea"Inherited from: IgrFinancialSeries
Gets whether the current series shows an area shape.
get isArea(): boolean Returns boolean
isAreaOrLine
Section titled "isAreaOrLine"Inherited from: IgrFinancialSeries
Gets whether the current series shows an area or line shape.
``
get isAreaOrLine(): boolean Returns boolean
isBar
Section titled "isBar"Inherited from: IgrFinancialSeries
Gets whether the current series shows a horizontal column shape.
get isBar(): boolean Returns boolean
isCategory
Section titled "isCategory"Inherited from: IgrFinancialSeries
Gets whether the current series is a category type series.
``
get isCategory(): boolean Returns boolean
isColoredItemwise
Section titled "isColoredItemwise"Inherited from: IgrFinancialSeries
get isColoredItemwise(): boolean Returns boolean
isColumn
Section titled "isColumn"Inherited from: IgrFinancialSeries
Gets whether the current series shows a column shape.
get isColumn(): boolean Returns boolean
isDefaultCrosshairBehaviorDisabled
Section titled "isDefaultCrosshairBehaviorDisabled"Inherited from: IgrFinancialSeries
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: IgrFinancialSeries
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: IgrFinancialSeries
Gets whether the current series is a financial type series.
get isFinancial(): boolean Returns boolean
isFinancialIndicator
Section titled "isFinancialIndicator"Inherited from: IgrFinancialSeries
Gets whether the series is financial indicator
get isFinancialIndicator(): boolean Returns boolean
isFinancialOverlay
Section titled "isFinancialOverlay"Inherited from: IgrFinancialSeries
Gets whether the series is financial overlay
get isFinancialOverlay(): boolean Returns boolean
isFinancialSeries
Section titled "isFinancialSeries"Gets whether the series has financial OHLC/candlestick visuals
get isFinancialSeries(): boolean Returns boolean
isFinancialWaterfall
Section titled "isFinancialWaterfall"Inherited from: IgrFinancialSeries
Gets whether the series is financial waterfall
get isFinancialWaterfall(): boolean Returns boolean
isFragment
Section titled "isFragment"Inherited from: IgrFinancialSeries
Gets whether the current series is a stack fragment.
``
get isFragment(): boolean Returns boolean
isGeographic
Section titled "isGeographic"Inherited from: IgrFinancialSeries
Gets whether the current series is a geographic series.
``
get isGeographic(): boolean Returns boolean
isHighlightOverlay
Section titled "isHighlightOverlay"Inherited from: IgrFinancialSeries
Gets whether the series is a highlight overlay.
get isHighlightOverlay(): boolean Returns boolean
isIndexed
Section titled "isIndexed"Inherited from: IgrFinancialSeries
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: IgrFinancialSeries
get isLayer(): boolean Returns boolean
isLineContour
Section titled "isLineContour"Inherited from: IgrFinancialSeries
Gets whether the current series shows a line contour shape.
get isLineContour(): boolean Returns boolean
isLineOnly
Section titled "isLineOnly"Inherited from: IgrFinancialSeries
Gets whether the current series shows only line shapes.
get isLineOnly(): boolean Returns boolean
isMarkerlessDisplayPreferred
Section titled "isMarkerlessDisplayPreferred"Inherited from: IgrFinancialSeries
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: IgrFinancialSeries
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: IgrFinancialSeries
Gets whether the current series shows a pie shape.
get isPie(): boolean Returns boolean
isPixel
Section titled "isPixel"Inherited from: IgrFinancialSeries
Gets whether the current series shows pixels.
get isPixel(): boolean Returns boolean
isPolar
Section titled "isPolar"Inherited from: IgrFinancialSeries
Gets whether the current series is a polar type series.
``
get isPolar(): boolean Returns boolean
isPolygon
Section titled "isPolygon"Inherited from: IgrFinancialSeries
Gets whether the current series shows a polygon shape.
get isPolygon(): boolean Returns boolean
isPolyline
Section titled "isPolyline"Inherited from: IgrFinancialSeries
Gets whether the current series shows a polyline shape.
get isPolyline(): boolean Returns boolean
isRadial
Section titled "isRadial"Inherited from: IgrFinancialSeries
Gets whether the current series is a radial type series.
``
get isRadial(): boolean Returns boolean
isRange
Section titled "isRange"Inherited from: IgrFinancialSeries
Gets whether the current series is a range type series.
``
get isRange(): boolean Returns boolean
isScatter
Section titled "isScatter"Inherited from: IgrFinancialSeries
Gets whether the current series is a scatter type series.
``
get isScatter(): boolean Returns boolean
isShape
Section titled "isShape"Inherited from: IgrFinancialSeries
Gets whether the current series is a shape type series.
get isShape(): boolean Returns boolean
isShapeControl
Section titled "isShapeControl"Inherited from: IgrFinancialSeries
Gets whether the current series shows interactive shape controls.
get isShapeControl(): boolean Returns boolean
isSpline
Section titled "isSpline"Inherited from: IgrFinancialSeries
Gets whether the current series shows a spline shape.
get isSpline(): boolean Returns boolean
isStacked
Section titled "isStacked"Inherited from: IgrFinancialSeries
Gets whether the current series is a stacked type series.
``
get isStacked(): boolean Returns boolean
isStep
Section titled "isStep"Inherited from: IgrFinancialSeries
Gets whether the current series shows step shapes.
get isStep(): boolean Returns boolean
isSummarizationSupported
Section titled "isSummarizationSupported"Inherited from: IgrFinancialSeries
Gets whether the series supports summarization in Data Legend and Data Tooltip.
get isSummarizationSupported(): boolean Returns boolean
isTile
Section titled "isTile"Inherited from: IgrFinancialSeries
Gets whether the current series shows a tile imagery.
get isTile(): boolean Returns boolean
isToolTipLayer
Section titled "isToolTipLayer"Inherited from: IgrFinancialSeries
Gets whether the series is an annotation layer.
get isToolTipLayer(): boolean Returns boolean
isUsableInLegend
Section titled "isUsableInLegend"Inherited from: IgrFinancialSeries
Gets if the series should appear in any legends.
``
get isUsableInLegend(): boolean Returns boolean
isUserAnnotationLayer
Section titled "isUserAnnotationLayer"Inherited from: IgrFinancialSeries
Gets whether the series is final value annotation layer.
get isUserAnnotationLayer(): boolean Returns boolean
isUserAnnotationToolTipLayer
Section titled "isUserAnnotationToolTipLayer"Inherited from: IgrFinancialSeries
Gets whether the series is final user annotation tooltip layer.
get isUserAnnotationToolTipLayer(): boolean Returns boolean
isValueAxisInverted
Section titled "isValueAxisInverted"Inherited from: IgrFinancialSeries
Gets whether the current series shows an area shape.
get isValueAxisInverted(): boolean Returns boolean
isValueOverlay
Section titled "isValueOverlay"Inherited from: IgrFinancialSeries
Gets whether the series is a value overlay.
get isValueOverlay(): boolean Returns boolean
isVertical
Section titled "isVertical"Inherited from: IgrFinancialSeries
Gets whether the current series is oriented vertically.
``
get isVertical(): boolean Returns boolean
isWaterfall
Section titled "isWaterfall"Inherited from: IgrFinancialSeries
Gets whether the current series shows a waterfall column shape.
get isWaterfall(): boolean Returns boolean
seriesInternal
Section titled "seriesInternal"Inherited from: IgrFinancialSeries
get seriesInternal(): any Returns any
get i(): Series Returns Series
Methods
Section titled "Methods"bindAxes
Section titled "bindAxes"Inherited from: IgrFinancialSeries
bindAxes(axes: IgrAxis<IIgrAxisProps>[]): void Parameters
- axes:
IgrAxis<IIgrAxisProps>[]
Returns void
bindSeries
Section titled "bindSeries"Inherited from: IgrFinancialSeries
bindSeries(series: IgrSeries<IIgrSeriesProps>[]): void Parameters
- series:
IgrSeries<IIgrSeriesProps>[]
Returns void
canUseAsXAxis
Section titled "canUseAsXAxis"Inherited from: IgrFinancialSeries
Determine if object can be used as XAxis
canUseAsXAxis(axis: any): boolean Parameters
- axis:
any- The object to check
Use
CanUseAsXAxismethod to determine if the object can be used as XAxis.boolean canX =series.canUseAsXAxis(xAxis);
Returns boolean
canUseAsYAxis
Section titled "canUseAsYAxis"Inherited from: IgrFinancialSeries
Determine if object can be used as YAxis
canUseAsYAxis(axis: any): boolean Parameters
- axis:
any- The object to check
Use
CanUseAsYAxismethod to determine if the object can be used as YAxis.boolean canY =series.canUseAsYAxis(yAxis);
Returns boolean
componentDidMount
Section titled "componentDidMount"Inherited from: IgrFinancialSeries
componentDidMount(): void Returns void
findByName
Section titled "findByName"Inherited from: IgrFinancialSeries
findByName(name: string): any Parameters
- name:
string
Returns any
fromWorldPosition
Section titled "fromWorldPosition"Inherited from: IgrFinancialSeries
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: IgrFinancialSeries
Returns the width of the category grouping this series is in.
The GetCategoryWidth method returns the width of the category grouping this series is in.
``
getCategoryWidth(): number Returns number
getEffectiveViewport
Section titled "getEffectiveViewport"Inherited from: IgrFinancialSeries
Gets the effective viewport, adjusted to account for margins and other factors.
getEffectiveViewport(): IgRect Returns IgRect
getExactItemIndex
Section titled "getExactItemIndex"Inherited from: IgrFinancialSeries
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.
The
GetExactItemIndexmethod 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.
number index = series.getExactItemIndex(world);
Returns number
getItem
Section titled "getItem"Inherited from: IgrFinancialSeries
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 gets the item that is the best match for the specified world coordinates.
Returns any
getItemIndex
Section titled "getItemIndex"Inherited from: IgrFinancialSeries
Gets the index of the item that resides at the provided world coordinates.
getItemIndex(world: IgPoint): number Parameters
- world:
IgPoint- The world coordinates of the requested item.
The
GetItemIndexmethod gets the index of the item that resides at the provided world coordinates.number itemindex= series.getItemIndex(world);
Returns number
getItemSpan
Section titled "getItemSpan"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.
The GetItemSpan method is used 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: IgrFinancialSeries
getItemValue(item: any, memberPathName: string): any Parameters
- item:
any - memberPathName:
string
Returns any
getMainContentViewport
Section titled "getMainContentViewport"Inherited from: IgrFinancialSeries
getMainContentViewport(): IgRect Returns IgRect
getMemberPathValue
Section titled "getMemberPathValue"Inherited from: IgrFinancialSeries
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: IgrFinancialSeries
getNextOrExactIndex(world: IgPoint, skipUnknowns: boolean): number Parameters
- world:
IgPoint - skipUnknowns:
boolean
Returns number
getOffsetValue
Section titled "getOffsetValue"Inherited from: IgrFinancialSeries
Returns the offset value for this series if grouped on a category axis.
The GetOffsetValue method returns the offset value for this series if grouped on a category axis.
``
getOffsetValue(): number Returns number
getPreviousOrExactIndex
Section titled "getPreviousOrExactIndex"Inherited from: IgrFinancialSeries
getPreviousOrExactIndex(world: IgPoint, skipUnknowns: boolean): number Parameters
- world:
IgPoint - skipUnknowns:
boolean
Returns number
getSeriesCloseValue
Section titled "getSeriesCloseValue"Inherited from: IgrFinancialSeries
getSeriesCloseValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number Parameters
- world:
IgPoint - useInterpolation:
boolean - skipUnknowns:
boolean
Returns number
getSeriesCloseValuePosition
Section titled "getSeriesCloseValuePosition"Inherited from: IgrFinancialSeries
getSeriesCloseValuePosition(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint Parameters
- world:
IgPoint - useInterpolation:
boolean - skipUnknowns:
boolean
Returns IgPoint
getSeriesHighValue
Section titled "getSeriesHighValue"Inherited from: IgrFinancialSeries
getSeriesHighValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number Parameters
- world:
IgPoint - useInterpolation:
boolean - skipUnknowns:
boolean
Returns number
getSeriesHighValuePosition
Section titled "getSeriesHighValuePosition"Inherited from: IgrFinancialSeries
getSeriesHighValuePosition(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint Parameters
- world:
IgPoint - useInterpolation:
boolean - skipUnknowns:
boolean
Returns IgPoint
getSeriesLowValue
Section titled "getSeriesLowValue"Inherited from: IgrFinancialSeries
getSeriesLowValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number Parameters
- world:
IgPoint - useInterpolation:
boolean - skipUnknowns:
boolean
Returns number
getSeriesLowValuePosition
Section titled "getSeriesLowValuePosition"Inherited from: IgrFinancialSeries
getSeriesLowValuePosition(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint Parameters
- world:
IgPoint - useInterpolation:
boolean - skipUnknowns:
boolean
Returns IgPoint
getSeriesOpenValue
Section titled "getSeriesOpenValue"Inherited from: IgrFinancialSeries
getSeriesOpenValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number Parameters
- world:
IgPoint - useInterpolation:
boolean - skipUnknowns:
boolean
Returns number
getSeriesOpenValuePosition
Section titled "getSeriesOpenValuePosition"Inherited from: IgrFinancialSeries
getSeriesOpenValuePosition(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint Parameters
- world:
IgPoint - useInterpolation:
boolean - skipUnknowns:
boolean
Returns IgPoint
getSeriesValue
Section titled "getSeriesValue"Inherited from: IgrFinancialSeries
getSeriesValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number Parameters
- world:
IgPoint - useInterpolation:
boolean - skipUnknowns:
boolean
Returns number
getSeriesValueBoundingBox
Section titled "getSeriesValueBoundingBox"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
The
GetSeriesValueBoundingBoxmethod return the best available value bounding box within the series that has the best value match for the world position provided.
Returns IgRect
getSeriesValueFromSeriesPixel
Section titled "getSeriesValueFromSeriesPixel"Inherited from: IgrFinancialSeries
getSeriesValueFromSeriesPixel(mouse: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number Parameters
- mouse:
IgPoint - useInterpolation:
boolean - skipUnknowns:
boolean
Returns number
getSeriesValueMarkerBoundingBox
Section titled "getSeriesValueMarkerBoundingBox"Inherited from: IgrFinancialSeries
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
Returns IgRect
getSeriesValuePosition
Section titled "getSeriesValuePosition"Inherited from: IgrFinancialSeries
getSeriesValuePosition(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint Parameters
- world:
IgPoint - useInterpolation:
boolean - skipUnknowns:
boolean
Returns IgPoint
getSeriesValuePositionFromSeriesPixel
Section titled "getSeriesValuePositionFromSeriesPixel"Inherited from: IgrFinancialSeries
getSeriesValuePositionFromSeriesPixel(mouse: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint Parameters
- mouse:
IgPoint - useInterpolation:
boolean - skipUnknowns:
boolean
Returns IgPoint
getSeriesValueType
Section titled "getSeriesValueType"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"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"getSeriesValueTypePositionFromValue(values: number[]): IgPoint Parameters
- values:
number[]
Returns IgPoint
getSeriesVolumeValue
Section titled "getSeriesVolumeValue"Inherited from: IgrFinancialSeries
getSeriesVolumeValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number Parameters
- world:
IgPoint - useInterpolation:
boolean - skipUnknowns:
boolean
Returns number
getSeriesVolumeValuePosition
Section titled "getSeriesVolumeValuePosition"Inherited from: IgrFinancialSeries
getSeriesVolumeValuePosition(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint Parameters
- world:
IgPoint - useInterpolation:
boolean - skipUnknowns:
boolean
Returns IgPoint
getUnscaledPosition
Section titled "getUnscaledPosition"Inherited from: IgrFinancialSeries
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: IgrFinancialSeries
Hides any internal tooltips presented by the series, if any.
hideToolTips(): void Returns void
hideToolTipsImmediate
Section titled "hideToolTipsImmediate"Inherited from: IgrFinancialSeries
Hides any internal tooltips presented by the series, if any.
hideToolTipsImmediate(): void Returns void
moveCursorPoint
Section titled "moveCursorPoint"Inherited from: IgrFinancialSeries
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: IgrFinancialSeries
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: IgrFinancialSeries
Notifies the series that a visual property has changed, requiring a visual update.
notifyVisualPropertiesChanged(): void Returns void
playTransitionIn
Section titled "playTransitionIn"Inherited from: IgrFinancialSeries
Plays the assigned transition out animation, if any.
playTransitionIn(): void Returns void
playTransitionOut
Section titled "playTransitionOut"Inherited from: IgrFinancialSeries
Plays the assigned transition out animation, if any.
playTransitionOut(): void Returns void
playTransitionOutAndRemove
Section titled "playTransitionOutAndRemove"Inherited from: IgrFinancialSeries
Plays the assigned transition out animation, if any.
playTransitionOutAndRemove(): void Returns void
provideData
Section titled "provideData"Inherited from: IgrFinancialSeries
provideData(data: any[]): void Parameters
- data:
any[]
Returns void
provideHighlightedData
Section titled "provideHighlightedData"Inherited from: IgrFinancialSeries
provideHighlightedData(data: any[]): void Parameters
- data:
any[]
Returns void
removeAllAlternateViews
Section titled "removeAllAlternateViews"Inherited from: IgrFinancialSeries
Removes all alternate views of this series.
removeAllAlternateViews(): void Returns void
removeAlternateView
Section titled "removeAlternateView"Inherited from: IgrFinancialSeries
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: IgrFinancialSeries
Call to null out the axes of the series;
removeAxes(): void Returns void
render
Section titled "render"Inherited from: IgrFinancialSeries
render(): any Returns any
renderSeries
Section titled "renderSeries"Inherited from: IgrFinancialSeries
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: IgrFinancialSeries
Replays the assigned transition in animation, if any.
``
replayTransitionIn(): void Returns void
resolveTooltipBrush
Section titled "resolveTooltipBrush"Inherited from: IgrFinancialSeries
Gets the brush for tooltip labels.
resolveTooltipBrush(): string Returns string
scrollIntoView
Section titled "scrollIntoView"Scrolls the series to display the item for the specified data item. The categorySeries 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
ScrollIntoViewmethos scrolls the series to display the item for the specified data item.
Returns boolean
setNegativeColors
Section titled "setNegativeColors"setNegativeColors(negativeBrush: string, negativeOutline: string): void Parameters
- negativeBrush:
string - negativeOutline:
string
Returns void
shouldComponentUpdate
Section titled "shouldComponentUpdate"Inherited from: IgrFinancialSeries
shouldComponentUpdate(nextProps: any, nextState: any): boolean Parameters
- nextProps:
any - nextState:
any
Returns boolean
simulateHover
Section titled "simulateHover"Inherited from: IgrFinancialSeries
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: IgrFinancialSeries
Called when this series' Style is updated.
styleUpdated(): void Returns void
toWorldPosition
Section titled "toWorldPosition"Inherited from: IgrFinancialSeries
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: IgrFinancialSeries
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: IgrFinancialSeries
_createFromInternal(internal: any): IgrSeries Parameters
- internal:
any