IgcValueLayerComponent

Represents an annotation layer that displays crosshair lines that cross through the closest value of the target series under the cursor.

Constructors

new IgcValueLayerComponent(): IgcValueLayerComponent

Returns IgcValueLayerComponent

Properties

htmlTagName

htmlTagName: string

actualAppearanceMode

Inherited from: IgcAnnotationLayerComponent

actualAppearanceMode: AnnotationAppearanceMode

actualAreaFillOpacity

Inherited from: IgcAnnotationLayerComponent

actualAreaFillOpacity: number

actualBrush

Inherited from: IgcAnnotationLayerComponent

actualBrush: string

actualDashArray

Inherited from: IgcAnnotationLayerComponent

actualDashArray: number[]

actualDashCap

Inherited from: IgcAnnotationLayerComponent

actualDashCap: PenLineCap

actualFocusBrush

Inherited from: IgcAnnotationLayerComponent

actualFocusBrush: string

actualFocusMode

Inherited from: IgcAnnotationLayerComponent

actualFocusMode: SeriesSelectionMode

actualHighlightedValuesFadeOpacity

Inherited from: IgcAnnotationLayerComponent

actualHighlightedValuesFadeOpacity: number

actualHighlightingFadeOpacity

Inherited from: IgcAnnotationLayerComponent

actualHighlightingFadeOpacity: number

actualHighlightingMode

Inherited from: IgcAnnotationLayerComponent

actualHighlightingMode: SeriesHighlightingMode

actualHitTestMode

Inherited from: IgcAnnotationLayerComponent

actualHitTestMode: SeriesHitTestMode

actualHorizontalAppearanceMode

Inherited from: IgcAnnotationLayerComponent

actualHorizontalAppearanceMode: AnnotationAppearanceMode

actualHorizontalDashArray

Inherited from: IgcAnnotationLayerComponent

actualHorizontalDashArray: number[]

actualHorizontalShiftAmount

Inherited from: IgcAnnotationLayerComponent

actualHorizontalShiftAmount: number

actualLayers

Inherited from: IgcAnnotationLayerComponent

actualLayers: IgcSeriesLayerCollection

actualLegendItemBadgeBrush

Inherited from: IgcAnnotationLayerComponent

actualLegendItemBadgeBrush: string

actualLegendItemBadgeOutline

Inherited from: IgcAnnotationLayerComponent

actualLegendItemBadgeOutline: string

actualLegendItemBadgeTemplate

Inherited from: IgcAnnotationLayerComponent

actualLegendItemBadgeTemplate: IgDataTemplate

actualMarkerFillOpacity

Inherited from: IgcAnnotationLayerComponent

actualMarkerFillOpacity: number

actualOutline

Inherited from: IgcAnnotationLayerComponent

actualOutline: string

actualResolution

Inherited from: IgcAnnotationLayerComponent

actualResolution: number

actualSelectionBrush

Inherited from: IgcAnnotationLayerComponent

actualSelectionBrush: string

actualSelectionMode

Inherited from: IgcAnnotationLayerComponent

actualSelectionMode: SeriesSelectionMode

actualShiftAmount

Inherited from: IgcAnnotationLayerComponent

actualShiftAmount: number

actualThickness

Inherited from: IgcAnnotationLayerComponent

actualThickness: number

actualValueLayerBrush

actualValueLayerBrush: string

actualVerticalAppearanceMode

Inherited from: IgcAnnotationLayerComponent

actualVerticalAppearanceMode: AnnotationAppearanceMode

actualVerticalDashArray

Inherited from: IgcAnnotationLayerComponent

actualVerticalDashArray: number[]

actualVerticalShiftAmount

Inherited from: IgcAnnotationLayerComponent

actualVerticalShiftAmount: number

appearanceMode

Inherited from: IgcAnnotationLayerComponent

appearanceMode: AnnotationAppearanceMode

areaFillOpacity

Inherited from: IgcAnnotationLayerComponent

areaFillOpacity: number

attachTooltipToRoot

Inherited from: IgcAnnotationLayerComponent

attachTooltipToRoot: boolean

autoCalloutLabelFormat

Inherited from: IgcAnnotationLayerComponent

autoCalloutLabelFormat: string

autoCalloutLabelFormatSpecifiers

Inherited from: IgcAnnotationLayerComponent

autoCalloutLabelFormatSpecifiers: any[]

autoCalloutValueLabelFormat

Inherited from: IgcAnnotationLayerComponent

autoCalloutValueLabelFormat: string

autoCalloutValueLabelFormatSpecifiers

Inherited from: IgcAnnotationLayerComponent

autoCalloutValueLabelFormatSpecifiers: any[]

brush

Inherited from: IgcAnnotationLayerComponent

brush: string

coercionMethods

Inherited from: IgcAnnotationLayerComponent

coercionMethods: any

cursorPosition

Inherited from: IgcAnnotationLayerComponent

cursorPosition: IgPoint

cursorPositionUpdatesOnMove

Inherited from: IgcAnnotationLayerComponent

cursorPositionUpdatesOnMove: boolean

dashArray

Inherited from: IgcAnnotationLayerComponent

dashArray: number[]

dataLegendGroup

Inherited from: IgcAnnotationLayerComponent

dataLegendGroup: string

dataSource

Inherited from: IgcAnnotationLayerComponent

dataSource: any

discreteLegendItemTemplate

Inherited from: IgcAnnotationLayerComponent

discreteLegendItemTemplate: IgDataTemplate

expectFunctions

Inherited from: IgcAnnotationLayerComponent

expectFunctions: boolean

finalValue

Inherited from: IgcAnnotationLayerComponent

finalValue: number

focusBrush

Inherited from: IgcAnnotationLayerComponent

focusBrush: string

highlightedDataSource

Inherited from: IgcAnnotationLayerComponent

highlightedDataSource: any

highlightedLegendItemVisibility

Inherited from: IgcAnnotationLayerComponent

highlightedLegendItemVisibility: Visibility

highlightedTitleSuffix

Inherited from: IgcAnnotationLayerComponent

highlightedTitleSuffix: string

highlightedValuesDataLegendGroup

Inherited from: IgcAnnotationLayerComponent

highlightedValuesDataLegendGroup: string

highlightedValuesDisplayMode

Inherited from: IgcAnnotationLayerComponent

highlightedValuesDisplayMode: SeriesHighlightedValuesDisplayMode

highlightedValuesExtraPropertyOverlays

Inherited from: IgcAnnotationLayerComponent

highlightedValuesExtraPropertyOverlays: IgcSeriesLayerPropertyOverlayCollection

highlightedValuesFadeOpacity

Inherited from: IgcAnnotationLayerComponent

highlightedValuesFadeOpacity: number

highlightingFadeOpacity

Inherited from: IgcAnnotationLayerComponent

highlightingFadeOpacity: number

hitTestMode

Inherited from: IgcAnnotationLayerComponent

hitTestMode: SeriesHitTestMode

horizontalAppearanceMode

Inherited from: IgcAnnotationLayerComponent

horizontalAppearanceMode: AnnotationAppearanceMode

horizontalDashArray

Inherited from: IgcAnnotationLayerComponent

horizontalDashArray: number[]

horizontalLineStroke

horizontalLineStroke: string

horizontalShiftAmount

Inherited from: IgcAnnotationLayerComponent

horizontalShiftAmount: number

index

Inherited from: IgcAnnotationLayerComponent

index: number

isActualLegendFinancial

Inherited from: IgcAnnotationLayerComponent

isActualLegendFinancial: boolean

isAxisAnnotationEnabled

isAxisAnnotationEnabled: boolean

isComponentHighlightingModeIgnored

Inherited from: IgcAnnotationLayerComponent

isComponentHighlightingModeIgnored: boolean

isDefaultCrosshairDisabled

Inherited from: IgcAnnotationLayerComponent

isDefaultCrosshairDisabled: boolean

isDefaultToolTipSelected

Inherited from: IgcAnnotationLayerComponent

isDefaultToolTipSelected: boolean

isDropShadowEnabled

Inherited from: IgcAnnotationLayerComponent

isDropShadowEnabled: boolean

isHighlightingEnabled

Inherited from: IgcAnnotationLayerComponent

isHighlightingEnabled: boolean

layers

Inherited from: IgcAnnotationLayerComponent

layers: IgcSeriesLayerCollection

legend

Inherited from: IgcAnnotationLayerComponent

legend: any

legendItemBadgeMode

Inherited from: IgcAnnotationLayerComponent

legendItemBadgeMode: LegendItemBadgeMode

legendItemBadgeShape

Inherited from: IgcAnnotationLayerComponent

legendItemBadgeShape: LegendItemBadgeShape

legendItemBadgeTemplate

Inherited from: IgcAnnotationLayerComponent

legendItemBadgeTemplate: IgDataTemplate

legendItemTemplate

Inherited from: IgcAnnotationLayerComponent

legendItemTemplate: IgDataTemplate

legendItemVisibility

Inherited from: IgcAnnotationLayerComponent

legendItemVisibility: Visibility

lineCap

Inherited from: IgcAnnotationLayerComponent

lineCap: PenLineCap

lineJoin

Inherited from: IgcAnnotationLayerComponent

lineJoin: PenLineJoin

markerFillOpacity

Inherited from: IgcAnnotationLayerComponent

markerFillOpacity: number

mouseOverEnabled

Inherited from: IgcAnnotationLayerComponent

mouseOverEnabled: boolean

name

Inherited from: IgcAnnotationLayerComponent

name: string

opacity

Inherited from: IgcAnnotationLayerComponent

opacity: number

outline

Inherited from: IgcAnnotationLayerComponent

outline: string

outlineMode

Inherited from: IgcAnnotationLayerComponent

outlineMode: SeriesOutlineMode

overlayText

overlayText: string

overlayTextAngle

overlayTextAngle: number

overlayTextBackground

overlayTextBackground: string

overlayTextBackgroundMatchLayer

overlayTextBackgroundMatchLayer: boolean

overlayTextBackgroundMode

overlayTextBackgroundMode: AnnotationAppearanceMode

overlayTextBackgroundShift

overlayTextBackgroundShift: number

overlayTextBorderColor

overlayTextBorderColor: string

overlayTextBorderMatchLayer

overlayTextBorderMatchLayer: boolean

overlayTextBorderMode

overlayTextBorderMode: AnnotationAppearanceMode

overlayTextBorderRadius

overlayTextBorderRadius: number

overlayTextBorderShift

overlayTextBorderShift: number

overlayTextBorderThickness

overlayTextBorderThickness: number

overlayTextColor

overlayTextColor: string

overlayTextColorMatchLayer

overlayTextColorMatchLayer: boolean

overlayTextColorMode

overlayTextColorMode: AnnotationAppearanceMode

overlayTextColorShift

overlayTextColorShift: number

overlayTextHorizontalMargin

overlayTextHorizontalMargin: number

overlayTextHorizontalPadding

overlayTextHorizontalPadding: number

overlayTextLocation

overlayTextLocation: OverlayTextLocation

overlayTextStyle

overlayTextStyle: string

overlayTextVerticalMargin

overlayTextVerticalMargin: number

overlayTextVerticalPadding

overlayTextVerticalPadding: number

overlayTextVisible

overlayTextVisible: boolean

percentChange

Inherited from: IgcAnnotationLayerComponent

percentChange: number

renderRequested

Inherited from: IgcAnnotationLayerComponent

renderRequested: object

resolution

Inherited from: IgcAnnotationLayerComponent

resolution: number

safeActualBrush

Inherited from: IgcAnnotationLayerComponent

safeActualBrush: string

selectionBrush

Inherited from: IgcAnnotationLayerComponent

selectionBrush: string

selectionThickness

Inherited from: IgcAnnotationLayerComponent

selectionThickness: number

shadowBlur

Inherited from: IgcAnnotationLayerComponent

shadowBlur: number

shadowColor

Inherited from: IgcAnnotationLayerComponent

shadowColor: string

shadowOffsetX

Inherited from: IgcAnnotationLayerComponent

shadowOffsetX: number

shadowOffsetY

Inherited from: IgcAnnotationLayerComponent

shadowOffsetY: number

shiftAmount

Inherited from: IgcAnnotationLayerComponent

shiftAmount: number

shouldAnimateOnDataSourceSwap

Inherited from: IgcAnnotationLayerComponent

shouldAnimateOnDataSourceSwap: boolean

shouldHideAutoCallouts

Inherited from: IgcAnnotationLayerComponent

shouldHideAutoCallouts: boolean

shouldRemoveHighlightedDataOnLayerHidden

Inherited from: IgcAnnotationLayerComponent

shouldRemoveHighlightedDataOnLayerHidden: boolean

shouldRenderAsOverlay

Inherited from: IgcAnnotationLayerComponent

shouldRenderAsOverlay: boolean

shouldShiftOpacityForSafeActualBrush

Inherited from: IgcAnnotationLayerComponent

shouldShiftOpacityForSafeActualBrush: boolean

showDefaultTooltip

Inherited from: IgcAnnotationLayerComponent

showDefaultTooltip: boolean

skipUnknownValues

skipUnknownValues: boolean

stylingOverlayText

stylingOverlayText: object

targetAxis

targetAxis: IgcAxisComponent

targetAxisName

targetAxisName: string

targetSeries

targetSeries: IgcSeriesComponent

targetSeriesName

targetSeriesName: string

thickness

Inherited from: IgcAnnotationLayerComponent

thickness: number

title

Inherited from: IgcAnnotationLayerComponent

title: any

tooltipContainerTemplate

Inherited from: IgcAnnotationLayerComponent

tooltipContainerTemplate: TemplateFunction

tooltipTemplate

Inherited from: IgcAnnotationLayerComponent

tooltipTemplate: TemplateFunction

transitionDuration

Inherited from: IgcAnnotationLayerComponent

transitionDuration: number

transitionEasingFunction

Inherited from: IgcAnnotationLayerComponent

transitionEasingFunction: object

transitionInDuration

Inherited from: IgcAnnotationLayerComponent

transitionInDuration: number

transitionInEasingFunction

Inherited from: IgcAnnotationLayerComponent

transitionInEasingFunction: object

transitionInSpeedType

Inherited from: IgcAnnotationLayerComponent

transitionInSpeedType: TransitionInSpeedType

transitionOutCompleted

Inherited from: IgcAnnotationLayerComponent

transitionOutCompleted: object

transitionOutDuration

Inherited from: IgcAnnotationLayerComponent

transitionOutDuration: number

transitionOutEasingFunction

Inherited from: IgcAnnotationLayerComponent

transitionOutEasingFunction: object

transitionOutSpeedType

Inherited from: IgcAnnotationLayerComponent

transitionOutSpeedType: TransitionOutSpeedType

useIndex

Inherited from: IgcAnnotationLayerComponent

useIndex: boolean

useInterpolation

useInterpolation: boolean

useItemWiseColors

Inherited from: IgcAnnotationLayerComponent

useItemWiseColors: boolean

useLegend

Inherited from: IgcAnnotationLayerComponent

useLegend: boolean

useSingleShadow

Inherited from: IgcAnnotationLayerComponent

useSingleShadow: boolean

valueMode

valueMode: ValueLayerValueMode

verticalAppearanceMode

Inherited from: IgcAnnotationLayerComponent

verticalAppearanceMode: AnnotationAppearanceMode

verticalDashArray

Inherited from: IgcAnnotationLayerComponent

verticalDashArray: number[]

verticalLineStroke

verticalLineStroke: string

verticalShiftAmount

Inherited from: IgcAnnotationLayerComponent

verticalShiftAmount: number

visibility

Inherited from: IgcAnnotationLayerComponent

visibility: Visibility

visibleRangeMarginBottom

Inherited from: IgcAnnotationLayerComponent

visibleRangeMarginBottom: number

visibleRangeMarginLeft

Inherited from: IgcAnnotationLayerComponent

visibleRangeMarginLeft: number

visibleRangeMarginRight

Inherited from: IgcAnnotationLayerComponent

visibleRangeMarginRight: number

visibleRangeMarginTop

Inherited from: IgcAnnotationLayerComponent

visibleRangeMarginTop: number

visibleRangeMode

Inherited from: IgcAnnotationLayerComponent

visibleRangeMode: SeriesVisibleRangeMode

xAxisAnnotationBackground

xAxisAnnotationBackground: string

xAxisAnnotationBackgroundCornerRadius

xAxisAnnotationBackgroundCornerRadius: number

xAxisAnnotationFormatLabel

xAxisAnnotationFormatLabel: object

xAxisAnnotationInterpolatedValuePrecision

xAxisAnnotationInterpolatedValuePrecision: number

xAxisAnnotationOutline

xAxisAnnotationOutline: string

xAxisAnnotationPaddingBottom

xAxisAnnotationPaddingBottom: number

xAxisAnnotationPaddingLeft

xAxisAnnotationPaddingLeft: number

xAxisAnnotationPaddingRight

xAxisAnnotationPaddingRight: number

xAxisAnnotationPaddingTop

xAxisAnnotationPaddingTop: number

xAxisAnnotationStrokeThickness

xAxisAnnotationStrokeThickness: number

xAxisAnnotationTextColor

xAxisAnnotationTextColor: string

yAxisAnnotationBackground

yAxisAnnotationBackground: string

yAxisAnnotationBackgroundCornerRadius

yAxisAnnotationBackgroundCornerRadius: number

yAxisAnnotationFormatLabel

yAxisAnnotationFormatLabel: object

yAxisAnnotationInterpolatedValuePrecision

yAxisAnnotationInterpolatedValuePrecision: number

yAxisAnnotationOutline

yAxisAnnotationOutline: string

yAxisAnnotationPaddingBottom

yAxisAnnotationPaddingBottom: number

yAxisAnnotationPaddingLeft

yAxisAnnotationPaddingLeft: number

yAxisAnnotationPaddingRight

yAxisAnnotationPaddingRight: number

yAxisAnnotationPaddingTop

yAxisAnnotationPaddingTop: number

yAxisAnnotationStrokeThickness

yAxisAnnotationStrokeThickness: number

yAxisAnnotationTextColor

yAxisAnnotationTextColor: string

Accessors

actualCloseLabel

Inherited from: IgcAnnotationLayerComponent

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

get actualCloseLabel(): string

Returns string

actualHighLabel

Inherited from: IgcAnnotationLayerComponent

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

get actualHighLabel(): string

Returns string

actualLowLabel

Inherited from: IgcAnnotationLayerComponent

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

get actualLowLabel(): string

Returns string

actualOpenLabel

Inherited from: IgcAnnotationLayerComponent

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

get actualOpenLabel(): string

Returns string

actualRadiusLabel

Inherited from: IgcAnnotationLayerComponent

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

get actualRadiusLabel(): string

Returns string

actualValueLabel

Inherited from: IgcAnnotationLayerComponent

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

get actualValueLabel(): string

Returns string

actualVolumeLabel

Inherited from: IgcAnnotationLayerComponent

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

get actualVolumeLabel(): string

Returns string

dataLegendKey

Inherited from: IgcAnnotationLayerComponent

Gets unique key used to identify the series in data legend

get dataLegendKey(): string

Returns string

hasMarkers

Inherited from: IgcAnnotationLayerComponent

Returns whether the current series supports visual markers.

get hasMarkers(): boolean

Returns boolean

hasOnlyMarkers

Inherited from: IgcAnnotationLayerComponent

Gets whether the series has only marker as visuals

get hasOnlyMarkers(): boolean

Returns boolean

hasValueAxis

Inherited from: IgcAnnotationLayerComponent

Gets whether the current series shows an area shape.

get hasValueAxis(): boolean

Returns boolean

hasVisibleMarkers

Inherited from: IgcAnnotationLayerComponent

Returns whether the current series has a visible marker style.

get hasVisibleMarkers(): boolean

Returns boolean

isAnnotationCalloutLayer

Inherited from: IgcAnnotationLayerComponent

Gets whether the series is an callout annotation layer.

get isAnnotationCalloutLayer(): boolean

Returns boolean

isAnnotationCrosshairLayer

Inherited from: IgcAnnotationLayerComponent

Gets whether the series is an crosshair annotation layer.

get isAnnotationCrosshairLayer(): boolean

Returns boolean

isAnnotationDataLayer

Inherited from: IgcAnnotationLayerComponent

Gets whether the series is a data annotation layer that support binding to data source DataAnnotationShapeLayer, DataAnnotationSliceLayer, DataAnnotationStripLayer

get isAnnotationDataLayer(): boolean

Returns boolean

isAnnotationFinalValue

Inherited from: IgcAnnotationLayerComponent

Gets whether the series is final value annotation layer.

get isAnnotationFinalValue(): boolean

Returns boolean

isAnnotationHoverLayer

Inherited from: IgcAnnotationLayerComponent

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

Inherited from: IgcAnnotationLayerComponent

Gets whether this series is an annotation layer.

get isAnnotationLayer(): boolean

Returns boolean

isAnnotationValueLayer

Gets whether the series is an crosshair annotation layer.

get isAnnotationValueLayer(): boolean

Returns boolean

isArea

Inherited from: IgcAnnotationLayerComponent

Gets whether the current series shows an area shape.

get isArea(): boolean

Returns boolean

isAreaOrLine

Inherited from: IgcAnnotationLayerComponent

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

get isAreaOrLine(): boolean

Returns boolean

isBar

Inherited from: IgcAnnotationLayerComponent

Gets whether the current series shows a horizontal column shape.

get isBar(): boolean

Returns boolean

isCategory

Inherited from: IgcAnnotationLayerComponent

Gets whether the current series is a category type series.

get isCategory(): boolean

Returns boolean

isColoredItemwise

Inherited from: IgcAnnotationLayerComponent

get isColoredItemwise(): boolean

Returns boolean

isColumn

Inherited from: IgcAnnotationLayerComponent

Gets whether the current series shows a column shape.

get isColumn(): boolean

Returns boolean

isDefaultCrosshairBehaviorDisabled

Inherited from: IgcAnnotationLayerComponent

Gets whether or not the default crosshair behavior is disabled.

get isDefaultCrosshairBehaviorDisabled(): boolean

Returns boolean

isDefaultTooltipBehaviorDisabled

Inherited from: IgcAnnotationLayerComponent

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

get isDefaultTooltipBehaviorDisabled(): boolean

Returns boolean

isFinancial

Inherited from: IgcAnnotationLayerComponent

Gets whether the current series is a financial type series.

get isFinancial(): boolean

Returns boolean

isFinancialIndicator

Inherited from: IgcAnnotationLayerComponent

Gets whether the series is financial indicator

get isFinancialIndicator(): boolean

Returns boolean

isFinancialOverlay

Inherited from: IgcAnnotationLayerComponent

Gets whether the series is financial overlay

get isFinancialOverlay(): boolean

Returns boolean

isFinancialSeries

Inherited from: IgcAnnotationLayerComponent

Gets whether the series has financial OHLC/candlestick visuals

get isFinancialSeries(): boolean

Returns boolean

isFinancialWaterfall

Inherited from: IgcAnnotationLayerComponent

Gets whether the series is financial waterfall

get isFinancialWaterfall(): boolean

Returns boolean

isFragment

Inherited from: IgcAnnotationLayerComponent

Gets whether the current series is a stack fragment.

get isFragment(): boolean

Returns boolean

isGeographic

Inherited from: IgcAnnotationLayerComponent

Gets whether the current series is a geographic series.

get isGeographic(): boolean

Returns boolean

isHighlightOverlay

Inherited from: IgcAnnotationLayerComponent

Gets whether the series is a highlight overlay.

get isHighlightOverlay(): boolean

Returns boolean

isIndexed

Inherited from: IgcAnnotationLayerComponent

Gets if the series uses an index, which can be used to auto-assign it a color.

get isIndexed(): boolean

Returns boolean

isLayer

Inherited from: IgcAnnotationLayerComponent

get isLayer(): boolean

Returns boolean

isLineContour

Inherited from: IgcAnnotationLayerComponent

Gets whether the current series shows a line contour shape.

get isLineContour(): boolean

Returns boolean

isLineOnly

Inherited from: IgcAnnotationLayerComponent

Gets whether the current series shows only line shapes.

get isLineOnly(): boolean

Returns boolean

isMarkerlessDisplayPreferred

Inherited from: IgcAnnotationLayerComponent

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

get isMarkerlessDisplayPreferred(): boolean

Returns boolean

isNegativeColorSupported

Inherited from: IgcAnnotationLayerComponent

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

get isNegativeColorSupported(): boolean

Returns boolean

isPie

Inherited from: IgcAnnotationLayerComponent

Gets whether the current series shows a pie shape.

get isPie(): boolean

Returns boolean

isPixel

Inherited from: IgcAnnotationLayerComponent

Gets whether the current series shows pixels.

get isPixel(): boolean

Returns boolean

isPolar

Inherited from: IgcAnnotationLayerComponent

Gets whether the current series is a polar type series.

get isPolar(): boolean

Returns boolean

isPolygon

Inherited from: IgcAnnotationLayerComponent

Gets whether the current series shows a polygon shape.

get isPolygon(): boolean

Returns boolean

isPolyline

Inherited from: IgcAnnotationLayerComponent

Gets whether the current series shows a polyline shape.

get isPolyline(): boolean

Returns boolean

isRadial

Inherited from: IgcAnnotationLayerComponent

Gets whether the current series is a radial type series.

get isRadial(): boolean

Returns boolean

isRange

Inherited from: IgcAnnotationLayerComponent

Gets whether the current series is a range type series.

get isRange(): boolean

Returns boolean

isScatter

Inherited from: IgcAnnotationLayerComponent

Gets whether the current series is a scatter type series.

get isScatter(): boolean

Returns boolean

isShape

Inherited from: IgcAnnotationLayerComponent

Gets whether the current series is a shape type series.

get isShape(): boolean

Returns boolean

isShapeControl

Inherited from: IgcAnnotationLayerComponent

Gets whether the current series shows interactive shape controls.

get isShapeControl(): boolean

Returns boolean

isSpline

Inherited from: IgcAnnotationLayerComponent

Gets whether the current series shows a spline shape.

get isSpline(): boolean

Returns boolean

isStacked

Inherited from: IgcAnnotationLayerComponent

Gets whether the current series is a stacked type series.

get isStacked(): boolean

Returns boolean

isStep

Inherited from: IgcAnnotationLayerComponent

Gets whether the current series shows step shapes.

get isStep(): boolean

Returns boolean

isSummarizationSupported

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

get isSummarizationSupported(): boolean

Returns boolean

isTile

Inherited from: IgcAnnotationLayerComponent

Gets whether the current series shows a tile imagery.

get isTile(): boolean

Returns boolean

isToolTipLayer

Inherited from: IgcAnnotationLayerComponent

Gets whether the series is an annotation layer.

get isToolTipLayer(): boolean

Returns boolean

isUsableInLegend

Inherited from: IgcAnnotationLayerComponent

Gets if the series should appear in any legends.

get isUsableInLegend(): boolean

Returns boolean

isUserAnnotationLayer

Inherited from: IgcAnnotationLayerComponent

Gets whether the series is final value annotation layer.

get isUserAnnotationLayer(): boolean

Returns boolean

isUserAnnotationToolTipLayer

Inherited from: IgcAnnotationLayerComponent

Gets whether the series is final user annotation tooltip layer.

get isUserAnnotationToolTipLayer(): boolean

Returns boolean

isValueAxisInverted

Inherited from: IgcAnnotationLayerComponent

Gets whether the current series shows an area shape.

get isValueAxisInverted(): boolean

Returns boolean

isValueOverlay

Inherited from: IgcAnnotationLayerComponent

Gets whether the series is a value overlay.

get isValueOverlay(): boolean

Returns boolean

isVertical

Inherited from: IgcAnnotationLayerComponent

Gets whether the current series is oriented vertically.

get isVertical(): boolean

Returns boolean

isWaterfall

Inherited from: IgcAnnotationLayerComponent

Gets whether the current series shows a waterfall column shape.

get isWaterfall(): boolean

Returns boolean

seriesInternal

Inherited from: IgcAnnotationLayerComponent

get seriesInternal(): any

Returns any

observedAttributes

get observedAttributes(): string[]

Returns string[]

Methods

attributeChangedCallback

Inherited from: IgcAnnotationLayerComponent

attributeChangedCallback(name: string, oldValue: string, newValue: string): void

Parameters

name: string
oldValue: string
newValue: string

Returns void

bindAxes

bindAxes(axes: IgcAxisComponent[]): void

Parameters

axes: IgcAxisComponent[]

Returns void

bindSeries

bindSeries(series: IgcSeriesComponent[]): void

Parameters

series: IgcSeriesComponent[]

Returns void

connectedCallback

connectedCallback(): void

Returns void

disconnectedCallback

disconnectedCallback(): void

Returns void

findByName

findByName(name: string): any

Parameters

name: string

Returns any

fromWorldPosition

Inherited from: IgcAnnotationLayerComponent

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

getEffectiveViewport

Inherited from: IgcAnnotationLayerComponent

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

getEffectiveViewport(): IgRect

Returns IgRect

getExactItemIndex

Inherited from: IgcAnnotationLayerComponent

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.

let index: number = this.series.getExactItemIndex({x:.5,y:.5});

Returns number

getItem

Inherited from: IgcAnnotationLayerComponent

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.

let item: number = this.series.getItem({x:.5,y:.5});

Returns any

getItemIndex

Inherited from: IgcAnnotationLayerComponent

Gets the item index associated with the specified world position

getItemIndex(world: IgPoint): number

Parameters

world: IgPoint

Returns number

getItemSpan

Inherited from: IgcAnnotationLayerComponent

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

Inherited from: IgcAnnotationLayerComponent

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

Parameters

item: any
memberPathName: string

Returns any

getMainContentViewport

Inherited from: IgcAnnotationLayerComponent

getMainContentViewport(): IgRect

Returns IgRect

getMemberPathValue

Inherited from: IgcAnnotationLayerComponent

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

Inherited from: IgcAnnotationLayerComponent

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

Parameters

world: IgPoint
skipUnknowns: boolean

Returns number

getPreviousOrExactIndex

Inherited from: IgcAnnotationLayerComponent

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

Parameters

world: IgPoint
skipUnknowns: boolean

Returns number

getSeriesHighValue

Inherited from: IgcAnnotationLayerComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesHighValuePosition

Inherited from: IgcAnnotationLayerComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesLowValue

Inherited from: IgcAnnotationLayerComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesLowValuePosition

Inherited from: IgcAnnotationLayerComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValue

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesValueBoundingBox

Inherited from: IgcAnnotationLayerComponent

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

Inherited from: IgcAnnotationLayerComponent

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

Parameters

mouse: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns number

getSeriesValueMarkerBoundingBox

Inherited from: IgcAnnotationLayerComponent

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

Inherited from: IgcAnnotationLayerComponent

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

Parameters

world: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValuePositionFromSeriesPixel

Inherited from: IgcAnnotationLayerComponent

getSeriesValuePositionFromSeriesPixel(mouse: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint

Parameters

mouse: IgPoint
useInterpolation: boolean
skipUnknowns: boolean

Returns IgPoint

getSeriesValueType

Inherited from: IgcAnnotationLayerComponent

Gets the data values of each axis associated with the specified value type. For example, if you specify mode as Maximum then it will return the maximum numerical value for each axis. For non-numerical axes it will return NaN.

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

Parameters

mode: string | ValueLayerValueMode
- The type of value desired from the series axes.

Returns number[]

getSeriesValueTypePosition

Inherited from: IgcAnnotationLayerComponent

Gets position of series value for specified layer value mode

getSeriesValueTypePosition(mode: string | ValueLayerValueMode): IgPoint

Parameters

mode: string | ValueLayerValueMode

Returns IgPoint

getSeriesValueTypePositionFromValue

Inherited from: IgcAnnotationLayerComponent

getSeriesValueTypePositionFromValue(values: number[]): IgPoint

Parameters

values: number[]

Returns IgPoint

getUnscaledPosition

Inherited from: IgcAnnotationLayerComponent

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

Inherited from: IgcAnnotationLayerComponent

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

hideToolTips(): void

Returns void

hideToolTipsImmediate

Inherited from: IgcAnnotationLayerComponent

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

hideToolTipsImmediate(): void

Returns void

moveCursorPoint

Inherited from: IgcAnnotationLayerComponent

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

notifyIndexedPropertiesChanged

Inherited from: IgcAnnotationLayerComponent

Called to notify about changes to indexed-based properties, e.g. Brushes, Outlines, MarkerBrushes, MarkerOutlines and refresh series

notifyIndexedPropertiesChanged(): void

Returns void

notifyVisualPropertiesChanged

Inherited from: IgcAnnotationLayerComponent

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

notifyVisualPropertiesChanged(): void

Returns void

playTransitionIn

Inherited from: IgcAnnotationLayerComponent

Plays the assigned transition out animation, if any.

playTransitionIn(): void

Returns void

playTransitionOut

Inherited from: IgcAnnotationLayerComponent

Plays the assigned transition out animation, if any.

playTransitionOut(): void

Returns void

playTransitionOutAndRemove

Inherited from: IgcAnnotationLayerComponent

Plays the assigned transition out animation, if any.

playTransitionOutAndRemove(): void

Returns void

provideData

Inherited from: IgcAnnotationLayerComponent

provideData(data: any[]): void

Parameters

data: any[]

Returns void

provideHighlightedData

Inherited from: IgcAnnotationLayerComponent

provideHighlightedData(data: any[]): void

Parameters

data: any[]

Returns void

removeAllAlternateViews

Inherited from: IgcAnnotationLayerComponent

Removes all alternate views of this series.

removeAllAlternateViews(): void

Returns void

removeAlternateView

Inherited from: IgcAnnotationLayerComponent

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

Inherited from: IgcAnnotationLayerComponent

Call to null out the axes of the series;

removeAxes(): void

Returns void

renderSeries

Inherited from: IgcAnnotationLayerComponent

Renders the series.

renderSeries(animate: boolean): void

Parameters

animate: boolean
- True if the change should be animated.
```
this.series.renderSeries(true);
```

Returns void

replayTransitionIn

Inherited from: IgcAnnotationLayerComponent

Replays the assigned transition in animation, if any.

replayTransitionIn(): void

Returns void

resolveTooltipBrush

Inherited from: IgcAnnotationLayerComponent

Gets the brush for tooltip labels.

resolveTooltipBrush(): string

Returns string

scrollIntoView

Inherited from: IgcAnnotationLayerComponent

Requests that the provided item should be brought into view if possible.

scrollIntoView(item: any): boolean

Parameters

item: any
- The item to attempt to bring into view.
```
this.series.scrollIntoView(dataItem);
```

Returns boolean

setNegativeColors

Inherited from: IgcAnnotationLayerComponent

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

Parameters

negativeBrush: string
negativeOutline: string

Returns void

simulateHover

Inherited from: IgcAnnotationLayerComponent

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

styleUpdated

Inherited from: IgcAnnotationLayerComponent

Called when this series' Style is updated.

styleUpdated(): void

Returns void

toWorldPosition

Inherited from: IgcAnnotationLayerComponent

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

Inherited from: IgcAnnotationLayerComponent

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

Inherited from: IgcAnnotationLayerComponent

_createFromInternal(internal: any): IgcSeriesComponent

Parameters

internal: any

Returns IgcSeriesComponent

register

register(): void