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.

``

``

IgrFinancialPriceSeries

new IgrFinancialPriceSeries(props: IIgrFinancialPriceSeriesProps): IgrFinancialPriceSeries

Returns IgrFinancialPriceSeries

Inherited from: IgrFinancialSeries

actualAreaFillOpacity: number

Inherited from: IgrFinancialSeries

actualBrush: string

Inherited from: IgrFinancialSeries

actualFocusBrush: string

Inherited from: IgrFinancialSeries

actualFocusMode: SeriesSelectionMode

Inherited from: IgrFinancialSeries

actualHighlightedValuesFadeOpacity: number

Inherited from: IgrFinancialSeries

actualHighlightingFadeOpacity: number

Inherited from: IgrFinancialSeries

actualHighlightingMode: SeriesHighlightingMode

Inherited from: IgrFinancialSeries

actualHitTestMode: SeriesHitTestMode

Inherited from: IgrFinancialSeries

actualLayers: IgrSeriesLayerCollection

Inherited from: IgrFinancialSeries

actualLegendItemBadgeBrush: string

Inherited from: IgrFinancialSeries

actualLegendItemBadgeOutline: string

Inherited from: IgrFinancialSeries

actualLegendItemBadgeTemplate: IgDataTemplate

Inherited from: IgrFinancialSeries

actualMarkerFillOpacity: number

Inherited from: IgrFinancialSeries

actualOutline: string

Inherited from: IgrFinancialSeries

actualResolution: number

Inherited from: IgrFinancialSeries

actualSelectionBrush: string

Inherited from: IgrFinancialSeries

actualSelectionMode: SeriesSelectionMode

Inherited from: IgrFinancialSeries

actualThickness: number
actualTrendLineBrush: string

Inherited from: IgrFinancialSeries

areaFillOpacity: number

Inherited from: IgrFinancialSeries

assigningCategoryStyle: object

Inherited from: IgrFinancialSeries

attachTooltipToRoot: boolean

Inherited from: IgrFinancialSeries

autoCalloutLabelFormat: string

Inherited from: IgrFinancialSeries

autoCalloutLabelFormatSpecifiers: any[]

Inherited from: IgrFinancialSeries

autoCalloutValueLabelFormat: string

autoCalloutValueLabelFormatSpecifiers

Section titled "autoCalloutValueLabelFormatSpecifiers"

Inherited from: IgrFinancialSeries

autoCalloutValueLabelFormatSpecifiers: any[]

Inherited from: IgrFinancialSeries

brush: string
categoryCollisionMode: CategoryCollisionMode
closeMemberAsLegendLabel: string
closeMemberAsLegendUnit: string

Inherited from: IgrFinancialSeries

closeMemberPath: string

Inherited from: IgrFinancialSeries

coercionMethods: any

Inherited from: IgrFinancialSeries

dashArray: number[]

Inherited from: IgrFinancialSeries

dataLegendGroup: string

Inherited from: IgrFinancialSeries

dataSource: any

Inherited from: IgrFinancialSeries

discreteLegendItemTemplate: IgDataTemplate
displayType: PriceDisplayType

Inherited from: IgrFinancialSeries

expectFunctions: boolean

Inherited from: IgrFinancialSeries

finalValue: number

Inherited from: IgrFinancialSeries

focusBrush: string

Inherited from: IgrFinancialSeries

highlightedCloseMemberPath: string

Inherited from: IgrFinancialSeries

highlightedDataSource: any

Inherited from: IgrFinancialSeries

highlightedHighMemberPath: string

Inherited from: IgrFinancialSeries

highlightedLegendItemVisibility: Visibility

Inherited from: IgrFinancialSeries

highlightedLowMemberPath: string

Inherited from: IgrFinancialSeries

highlightedOpenMemberPath: string

Inherited from: IgrFinancialSeries

highlightedTitleSuffix: string

Inherited from: IgrFinancialSeries

highlightedValuesDataLegendGroup: string

Inherited from: IgrFinancialSeries

highlightedValuesDisplayMode: SeriesHighlightedValuesDisplayMode

highlightedValuesExtraPropertyOverlays

Section titled "highlightedValuesExtraPropertyOverlays"

Inherited from: IgrFinancialSeries

highlightedValuesExtraPropertyOverlays: IgrSeriesLayerPropertyOverlayCollection

Inherited from: IgrFinancialSeries

highlightedValuesFadeOpacity: number

Inherited from: IgrFinancialSeries

highlightedVolumeMemberPath: string

Inherited from: IgrFinancialSeries

highlightingFadeOpacity: number
highMemberAsLegendLabel: string
highMemberAsLegendUnit: string

Inherited from: IgrFinancialSeries

highMemberPath: string

Inherited from: IgrFinancialSeries

hitTestMode: SeriesHitTestMode

Inherited from: IgrFinancialSeries

index: number

Inherited from: IgrFinancialSeries

isActualLegendFinancial: boolean

Inherited from: IgrFinancialSeries

isComponentHighlightingModeIgnored: boolean

Inherited from: IgrFinancialSeries

isCustomCategoryStyleAllowed: boolean

Inherited from: IgrFinancialSeries

isDefaultToolTipSelected: boolean

Inherited from: IgrFinancialSeries

isDropShadowEnabled: boolean

Inherited from: IgrFinancialSeries

isHighlightingEnabled: boolean

Inherited from: IgrFinancialSeries

isTransitionInEnabled: boolean

Inherited from: IgrFinancialSeries

layers: IgrSeriesLayerCollection

Inherited from: IgrFinancialSeries

legend: any

Inherited from: IgrFinancialSeries

legendItemBadgeMode: LegendItemBadgeMode

Inherited from: IgrFinancialSeries

legendItemBadgeShape: LegendItemBadgeShape

Inherited from: IgrFinancialSeries

legendItemBadgeTemplate: IgDataTemplate

Inherited from: IgrFinancialSeries

legendItemTemplate: IgDataTemplate

Inherited from: IgrFinancialSeries

legendItemVisibility: Visibility

Inherited from: IgrFinancialSeries

lineCap: PenLineCap

Inherited from: IgrFinancialSeries

lineJoin: PenLineJoin
lowMemberAsLegendLabel: string
lowMemberAsLegendUnit: string

Inherited from: IgrFinancialSeries

lowMemberPath: string

Inherited from: IgrFinancialSeries

markerFillOpacity: number

Inherited from: IgrFinancialSeries

mouseOverEnabled: boolean

Inherited from: IgrFinancialSeries

name: string

Inherited from: IgrFinancialSeries

negativeBrush: string
negativeOutline: string

Inherited from: IgrFinancialSeries

opacity: number
openMemberAsLegendLabel: string
openMemberAsLegendUnit: string

Inherited from: IgrFinancialSeries

openMemberPath: string

Inherited from: IgrFinancialSeries

outline: string

Inherited from: IgrFinancialSeries

outlineMode: SeriesOutlineMode

Inherited from: IgrFinancialSeries

percentChange: number

Inherited from: IgrFinancialSeries

renderRequested: object

Inherited from: IgrFinancialSeries

resolution: number

Inherited from: IgrFinancialSeries

safeActualBrush: string

Inherited from: IgrFinancialSeries

selectionBrush: string

Inherited from: IgrFinancialSeries

selectionThickness: number

Inherited from: IgrFinancialSeries

shadowBlur: number

Inherited from: IgrFinancialSeries

shadowColor: string

Inherited from: IgrFinancialSeries

shadowOffsetX: number

Inherited from: IgrFinancialSeries

shadowOffsetY: number

Inherited from: IgrFinancialSeries

shouldAnimateOnDataSourceSwap: boolean

Inherited from: IgrFinancialSeries

shouldHideAutoCallouts: boolean

shouldRemoveHighlightedDataOnLayerHidden

Section titled "shouldRemoveHighlightedDataOnLayerHidden"

Inherited from: IgrFinancialSeries

shouldRemoveHighlightedDataOnLayerHidden: boolean

shouldShiftOpacityForSafeActualBrush

Section titled "shouldShiftOpacityForSafeActualBrush"

Inherited from: IgrFinancialSeries

shouldShiftOpacityForSafeActualBrush: boolean

Inherited from: IgrFinancialSeries

showDefaultTooltip: boolean

Inherited from: IgrFinancialSeries

thickness: number

Inherited from: IgrFinancialSeries

title: any

Inherited from: IgrFinancialSeries

tooltipContainerTemplate: any

Inherited from: IgrFinancialSeries

tooltipTemplate: any

Inherited from: IgrFinancialSeries

transitionDuration: number

Inherited from: IgrFinancialSeries

transitionEasingFunction: object

Inherited from: IgrFinancialSeries

transitionInDuration: number

Inherited from: IgrFinancialSeries

transitionInEasingFunction: object

Inherited from: IgrFinancialSeries

transitionInMode: CategoryTransitionInMode

Inherited from: IgrFinancialSeries

transitionInSpeedType: TransitionInSpeedType

Inherited from: IgrFinancialSeries

transitionOutCompleted: object

Inherited from: IgrFinancialSeries

transitionOutDuration: number

Inherited from: IgrFinancialSeries

transitionOutEasingFunction: object

Inherited from: IgrFinancialSeries

transitionOutSpeedType: TransitionOutSpeedType
trendLineBrush: string
trendLineDashArray: number[]
trendLinePeriod: number
trendLineThickness: number
trendLineType: TrendLineType

Inherited from: IgrFinancialSeries

typical: object

Inherited from: IgrFinancialSeries

typicalBasedOn: object

Inherited from: IgrFinancialSeries

useItemWiseColors: boolean

Inherited from: IgrFinancialSeries

useSingleShadow: boolean

Inherited from: IgrFinancialSeries

visibility: Visibility

Inherited from: IgrFinancialSeries

visibleRangeMarginBottom: number

Inherited from: IgrFinancialSeries

visibleRangeMarginLeft: number

Inherited from: IgrFinancialSeries

visibleRangeMarginRight: number

Inherited from: IgrFinancialSeries

visibleRangeMarginTop: number

Inherited from: IgrFinancialSeries

visibleRangeMode: SeriesVisibleRangeMode

Inherited from: IgrFinancialSeries

volumeMemberPath: string

Inherited from: IgrFinancialSeries

xAxis: IgrCategoryAxisBase

Inherited from: IgrFinancialSeries

xAxisName: string

Inherited from: IgrFinancialSeries

yAxis: IgrNumericYAxis

Inherited from: IgrFinancialSeries

yAxisName: string

Inherited from: IgrFinancialSeries

Gets the text that is displayed for the Close label in the tooltip.

get actualCloseLabel(): string

Returns string

Inherited from: IgrFinancialSeries

Gets the text that is displayed for the High label in the tooltip.

get actualHighLabel(): string

Returns string

Inherited from: IgrFinancialSeries

Gets the text that is displayed for the Low label in the tooltip.

get actualLowLabel(): string

Returns string

Inherited from: IgrFinancialSeries

Gets the text that is displayed for the Open label in the tooltip.

get actualOpenLabel(): string

Returns string

Inherited from: IgrFinancialSeries

Gets the text that is displayed for the Value label in the tooltip.

get actualRadiusLabel(): string

Returns string

Inherited from: IgrFinancialSeries

Gets the text that is displayed for the Value label in the tooltip.

get actualValueLabel(): string

Returns string

Inherited from: IgrFinancialSeries

Gets the text that is displayed for the Volume label in the tooltip.

get actualVolumeLabel(): string

Returns string

Inherited from: IgrFinancialSeries

Gets unique key used to identify the series in data legend

get dataLegendKey(): string

Returns string

Inherited from: IgrFinancialSeries

Returns whether the current series supports visual markers.

``

get hasMarkers(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the series has only marker as visuals

get hasOnlyMarkers(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the current series shows an area shape.

get hasValueAxis(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Returns whether the current series has a visible marker style.

get hasVisibleMarkers(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the series is an callout annotation layer.

get isAnnotationCalloutLayer(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the series is an crosshair annotation layer.

get isAnnotationCrosshairLayer(): boolean

Returns boolean

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

Inherited from: IgrFinancialSeries

Gets whether the series is final value annotation layer.

get isAnnotationFinalValue(): boolean

Returns boolean

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

Inherited from: IgrFinancialSeries

Gets whether the series is an annotation layer.

``

get isAnnotationLayer(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the series is a value annotation layer.

get isAnnotationValueLayer(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the current series shows an area shape.

get isArea(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the current series shows an area or line shape.

``

get isAreaOrLine(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the current series shows a horizontal column shape.

get isBar(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the current series is a category type series.

``

get isCategory(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

get isColoredItemwise(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the current series shows a column shape.

get isColumn(): boolean

Returns boolean

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

Inherited from: IgrFinancialSeries

Gets whether the default tooltip behavior should be disabled if this series is present.

``

get isDefaultTooltipBehaviorDisabled(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the current series is a financial type series.

get isFinancial(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the series is financial indicator

get isFinancialIndicator(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the series is financial overlay

get isFinancialOverlay(): boolean

Returns boolean

Gets whether the series has financial OHLC/candlestick visuals

get isFinancialSeries(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the series is financial waterfall

get isFinancialWaterfall(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the current series is a stack fragment.

``

get isFragment(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the current series is a geographic series.

``

get isGeographic(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the series is a highlight overlay.

get isHighlightOverlay(): boolean

Returns boolean

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

Inherited from: IgrFinancialSeries

get isLayer(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the current series shows a line contour shape.

get isLineContour(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the current series shows only line shapes.

get isLineOnly(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Overridden by derived series classes to indicate when markerless display is preferred or not.

get isMarkerlessDisplayPreferred(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Overridden by derived series classes to indicate when negative colors are supported or not.

get isNegativeColorSupported(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the current series shows a pie shape.

get isPie(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the current series shows pixels.

get isPixel(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the current series is a polar type series.

``

get isPolar(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the current series shows a polygon shape.

get isPolygon(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the current series shows a polyline shape.

get isPolyline(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the current series is a radial type series.

``

get isRadial(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the current series is a range type series.

``

get isRange(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the current series is a scatter type series.

``

get isScatter(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the current series is a shape type series.

get isShape(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the current series shows interactive shape controls.

get isShapeControl(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the current series shows a spline shape.

get isSpline(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the current series is a stacked type series.

``

get isStacked(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the current series shows step shapes.

get isStep(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the series supports summarization in Data Legend and Data Tooltip.

get isSummarizationSupported(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the current series shows a tile imagery.

get isTile(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the series is an annotation layer.

get isToolTipLayer(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets if the series should appear in any legends.

``

get isUsableInLegend(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the series is final value annotation layer.

get isUserAnnotationLayer(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the series is final user annotation tooltip layer.

get isUserAnnotationToolTipLayer(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the current series shows an area shape.

get isValueAxisInverted(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the series is a value overlay.

get isValueOverlay(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the current series is oriented vertically.

``

get isVertical(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

Gets whether the current series shows a waterfall column shape.

get isWaterfall(): boolean

Returns boolean

Inherited from: IgrFinancialSeries

get seriesInternal(): any

Returns any

get i(): Series

Returns Series

Inherited from: IgrFinancialSeries

bindAxes(axes: IgrAxis<IIgrAxisProps>[]): void

Parameters

Returns void

Inherited from: IgrFinancialSeries

bindSeries(series: IgrSeries<IIgrSeriesProps>[]): void

Parameters

Returns void

Inherited from: IgrFinancialSeries

Determine if object can be used as XAxis

canUseAsXAxis(axis: any): boolean

Parameters

  • axis: any
    • The object to check

    Use CanUseAsXAxis method to determine if the object can be used as XAxis.

    boolean canX =series.canUseAsXAxis(xAxis);

Returns boolean

Inherited from: IgrFinancialSeries

Determine if object can be used as YAxis

canUseAsYAxis(axis: any): boolean

Parameters

  • axis: any
    • The object to check

    Use CanUseAsYAxis method to determine if the object can be used as YAxis.

    boolean canY =series.canUseAsYAxis(yAxis);

Returns boolean

Inherited from: IgrFinancialSeries

componentDidMount(): void

Returns void

Inherited from: IgrFinancialSeries

findByName(name: string): any

Parameters

  • name: string

Returns any

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

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

Inherited from: IgrFinancialSeries

Gets the effective viewport, adjusted to account for margins and other factors.

getEffectiveViewport(): IgRect

Returns IgRect

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

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 GetItem method gets the item that is the best match for the specified world coordinates.

Returns any

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 GetItemIndex method gets the index of the item that resides at the provided world coordinates.

    number itemindex= series.getItemIndex(world);

Returns number

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

Inherited from: IgrFinancialSeries

getItemValue(item: any, memberPathName: string): any

Parameters

  • item: any
  • memberPathName: string

Returns any

Inherited from: IgrFinancialSeries

getMainContentViewport(): IgRect

Returns IgRect

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

Inherited from: IgrFinancialSeries

getNextOrExactIndex(world: IgPoint, skipUnknowns: boolean): number

Parameters

  • world: IgPoint
  • skipUnknowns: boolean

Returns number

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

Inherited from: IgrFinancialSeries

getPreviousOrExactIndex(world: IgPoint, skipUnknowns: boolean): number

Parameters

  • world: IgPoint
  • skipUnknowns: boolean

Returns number

Inherited from: IgrFinancialSeries

getSeriesCloseValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number

Parameters

  • world: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns number

Inherited from: IgrFinancialSeries

getSeriesCloseValuePosition(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint

Parameters

  • world: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns IgPoint

Inherited from: IgrFinancialSeries

getSeriesHighValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number

Parameters

  • world: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns number

Inherited from: IgrFinancialSeries

getSeriesHighValuePosition(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint

Parameters

  • world: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns IgPoint

Inherited from: IgrFinancialSeries

getSeriesLowValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number

Parameters

  • world: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns number

Inherited from: IgrFinancialSeries

getSeriesLowValuePosition(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint

Parameters

  • world: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns IgPoint

Inherited from: IgrFinancialSeries

getSeriesOpenValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number

Parameters

  • world: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns number

Inherited from: IgrFinancialSeries

getSeriesOpenValuePosition(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint

Parameters

  • world: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns IgPoint

Inherited from: IgrFinancialSeries

getSeriesValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number

Parameters

  • world: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns number

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 GetSeriesValueBoundingBox method return the best available value bounding box within the series that has the best value match for the world position provided.

Returns IgRect

Inherited from: IgrFinancialSeries

getSeriesValueFromSeriesPixel(mouse: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number

Parameters

  • mouse: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns number

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

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

Gets a numeric value from the numeric axis associated with this series that matches the desired value mode.

getSeriesValueType(mode: string | ValueLayerValueMode): number[]

Parameters

Returns number[]

Gets position of series value for specified layer value mode

getSeriesValueTypePosition(mode: string | ValueLayerValueMode): IgPoint

Parameters

Returns IgPoint

getSeriesValueTypePositionFromValue

Section titled "getSeriesValueTypePositionFromValue"
getSeriesValueTypePositionFromValue(values: number[]): IgPoint

Parameters

  • values: number[]

Returns IgPoint

Inherited from: IgrFinancialSeries

getSeriesVolumeValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number

Parameters

  • world: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns number

Inherited from: IgrFinancialSeries

getSeriesVolumeValuePosition(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint

Parameters

  • world: IgPoint
  • useInterpolation: boolean
  • skipUnknowns: boolean

Returns IgPoint

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

Inherited from: IgrFinancialSeries

Hides any internal tooltips presented by the series, if any.

hideToolTips(): void

Returns void

Inherited from: IgrFinancialSeries

Hides any internal tooltips presented by the series, if any.

hideToolTipsImmediate(): void

Returns void

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.

    MoveCursorPoint can be used on annotation layers to programitically show the annotation at the given point.

    this.crosshair.moveCursorPoint({x:.5,y:.5});

Returns void

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

Inherited from: IgrFinancialSeries

Notifies the series that a visual property has changed, requiring a visual update.

notifyVisualPropertiesChanged(): void

Returns void

Inherited from: IgrFinancialSeries

Plays the assigned transition out animation, if any.

playTransitionIn(): void

Returns void

Inherited from: IgrFinancialSeries

Plays the assigned transition out animation, if any.

playTransitionOut(): void

Returns void

Inherited from: IgrFinancialSeries

Plays the assigned transition out animation, if any.

playTransitionOutAndRemove(): void

Returns void

Inherited from: IgrFinancialSeries

provideData(data: any[]): void

Parameters

  • data: any[]

Returns void

Inherited from: IgrFinancialSeries

provideHighlightedData(data: any[]): void

Parameters

  • data: any[]

Returns void

Inherited from: IgrFinancialSeries

Removes all alternate views of this series.

removeAllAlternateViews(): void

Returns void

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

Inherited from: IgrFinancialSeries

Call to null out the axes of the series;

removeAxes(): void

Returns void

Inherited from: IgrFinancialSeries

render(): any

Returns any

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

Inherited from: IgrFinancialSeries

Replays the assigned transition in animation, if any.

``

replayTransitionIn(): void

Returns void

Inherited from: IgrFinancialSeries

Gets the brush for tooltip labels.

resolveTooltipBrush(): string

Returns string

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 ScrollIntoView methos scrolls the series to display the item for the specified data item.

Returns boolean

setNegativeColors(negativeBrush: string, negativeOutline: string): void

Parameters

  • negativeBrush: string
  • negativeOutline: string

Returns void

Inherited from: IgrFinancialSeries

shouldComponentUpdate(nextProps: any, nextState: any): boolean

Parameters

  • nextProps: any
  • nextState: any

Returns boolean

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, SimulateHover can be used to automatically display the tooltip over a particular series item.

    this.series.simulateHover({x:250,y:250});

Returns void

Inherited from: IgrFinancialSeries

Called when this series' Style is updated.

styleUpdated(): void

Returns void

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

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

Inherited from: IgrFinancialSeries

_createFromInternal(internal: any): IgrSeries

Parameters

  • internal: any

Returns IgrSeries