igniteui-react-charts

import { IgPoint } from "igniteui-react-core"; import { ValueLayerValueMode } from "./ValueLayerValueMode"; import { IgrSeries } from "./igr-series"; import { IgrAxis } from "./igr-axis"; import { OverlayTextLocation } from "./OverlayTextLocation"; import { AnnotationAppearanceMode } from "./AnnotationAppearanceMode"; import { IgrOverlayTextUpdatingEventArgs } from "./igr-overlay-text-updating-event-args"; import { IgrAnnotationLayer, IIgrAnnotationLayerProps } from "./igr-annotation-layer"; import { ValueLayer } from "./ValueLayer"; /** * Represents an annotation layer that displays crosshair lines that cross through the closest value of the target series under the cursor. */ export declare class IgrValueLayer extends IgrAnnotationLayer<IIgrValueLayerProps> { protected createImplementation(): ValueLayer; /** * @hidden */ get i(): ValueLayer; constructor(props: IIgrValueLayerProps); /** * Gets whether the series is an crosshair annotation layer. */ get isAnnotationValueLayer(): boolean; /** * Gets or sets the value mode for the overlay. */ get valueMode(): ValueLayerValueMode; set valueMode(v: ValueLayerValueMode); /** * Gets or sets the color to use for the horizontal line. Leave null for an automatic value. */ get horizontalLineStroke(): string; set horizontalLineStroke(v: string); /** * Gets or sets the color to use for vertical line. Leave null for an automatic value. */ get verticalLineStroke(): string; set verticalLineStroke(v: string); /** * Gets or sets the name of the series to target this annotation to. If null, this annotation targets all series simultaneously. */ get targetSeriesName(): string; set targetSeriesName(v: string); /** * Gets or sets the series to target this annotation to. If null, this annotation targets all series simultaneously. */ get targetSeries(): IgrSeries; set targetSeries(v: IgrSeries); /** * Gets or sets the name of the axis to target this annotation to. If null, this annotation targets all axis simultaneously. */ get targetAxisName(): string; set targetAxisName(v: string); /** * Gets or sets the axis to target this annotation to. If null, this annotation targets all value axis simultaneously. */ get targetAxis(): IgrAxis; set targetAxis(v: IgrAxis); /** * Gets or sets whether to use value interpolation when drawing a line through the best value for the cursor position. */ get useInterpolation(): boolean; set useInterpolation(v: boolean); /** * Gets or sets whether to draw annotations over the axes where the crosshair meets with them. */ get isAxisAnnotationEnabled(): boolean; set isAxisAnnotationEnabled(v: boolean); /** * Sets or gets a function which takes an object that produces a formatted label for the x axis annotation. */ get xAxisAnnotationFormatLabel(): (item: any) => string; set xAxisAnnotationFormatLabel(v: (item: any) => string); /** * Sets or gets a function which takes an object that produces a formatted label for the y axis annotation. */ get yAxisAnnotationFormatLabel(): (item: any) => string; set yAxisAnnotationFormatLabel(v: (item: any) => string); /** * Gets or sets the color to use for the x axis annotation text. Leave unset for an automatic value. */ get xAxisAnnotationTextColor(): string; set xAxisAnnotationTextColor(v: string); /** * Gets or sets the color to use for the x axis annotation backing. Leave unset for an automatic value. */ get xAxisAnnotationBackground(): string; set xAxisAnnotationBackground(v: string); /** * Gets or sets the corner radius to use for the x axis annotation backing. Leave unset for an automatic value. */ get xAxisAnnotationBackgroundCornerRadius(): number; set xAxisAnnotationBackgroundCornerRadius(v: number); /** * Gets or sets the precision to use displaying values for interpolated crosshair positions. */ get xAxisAnnotationInterpolatedValuePrecision(): number; set xAxisAnnotationInterpolatedValuePrecision(v: number); /** * Gets or sets the color to use for the x axis annotation outline. Leave unset for an automatic value. */ get xAxisAnnotationOutline(): string; set xAxisAnnotationOutline(v: string); /** * Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. */ get xAxisAnnotationPaddingLeft(): number; set xAxisAnnotationPaddingLeft(v: number); /** * Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. */ get xAxisAnnotationPaddingTop(): number; set xAxisAnnotationPaddingTop(v: number); /** * Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. */ get xAxisAnnotationPaddingRight(): number; set xAxisAnnotationPaddingRight(v: number); /** * Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. */ get xAxisAnnotationPaddingBottom(): number; set xAxisAnnotationPaddingBottom(v: number); /** * Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. */ get yAxisAnnotationPaddingLeft(): number; set yAxisAnnotationPaddingLeft(v: number); /** * Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. */ get yAxisAnnotationPaddingTop(): number; set yAxisAnnotationPaddingTop(v: number); /** * Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. */ get yAxisAnnotationPaddingRight(): number; set yAxisAnnotationPaddingRight(v: number); /** * Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. */ get yAxisAnnotationPaddingBottom(): number; set yAxisAnnotationPaddingBottom(v: number); /** * Gets or sets the stroke thickness for the x axis annotation backing. Leave unset for an automatic value. */ get xAxisAnnotationStrokeThickness(): number; set xAxisAnnotationStrokeThickness(v: number); /** * Gets or sets the color to use for the y axis annotation text. Leave unset for an automatic value. */ get yAxisAnnotationTextColor(): string; set yAxisAnnotationTextColor(v: string); /** * Gets or sets the color to use for the y axis annotation backing. Leave unset for an automatic value. */ get yAxisAnnotationBackground(): string; set yAxisAnnotationBackground(v: string); /** * Gets or sets the corner radius to use for the y axis annotation backing. Leave unset for an automatic value. */ get yAxisAnnotationBackgroundCornerRadius(): number; set yAxisAnnotationBackgroundCornerRadius(v: number); /** * Gets or sets the precision to use displaying values for interpolated crosshair positions. */ get yAxisAnnotationInterpolatedValuePrecision(): number; set yAxisAnnotationInterpolatedValuePrecision(v: number); /** * Gets or sets the color to use for the y axis annotation outline. Leave unset for an automatic value. */ get yAxisAnnotationOutline(): string; set yAxisAnnotationOutline(v: string); /** * Gets or sets the stroke thickness for the y axis annotation backing. Leave unset for an automatic value. */ get yAxisAnnotationStrokeThickness(): number; set yAxisAnnotationStrokeThickness(v: number); /** * Gets or sets whether to skip unknown values when searching for series values. */ get skipUnknownValues(): boolean; set skipUnknownValues(v: boolean); /** * Gets or sets location of the overlay text in relation to shape of data annotation. */ get overlayTextLocation(): OverlayTextLocation; set overlayTextLocation(v: OverlayTextLocation); /** * Gets or sets the horizontal margin of the overlay text in relation to shape of data annotation. */ get overlayTextHorizontalMargin(): number; set overlayTextHorizontalMargin(v: number); /** * Gets or sets the vertical margin of the overlay text in relation to shape of data annotation. */ get overlayTextVerticalMargin(): number; set overlayTextVerticalMargin(v: number); /** * Gets or sets the horizontal padding of the overlay text in relation to shape of data annotation. */ get overlayTextHorizontalPadding(): number; set overlayTextHorizontalPadding(v: number); /** * Gets or sets the vertical padding of the overlay text in relation to shape of data annotation. */ get overlayTextVerticalPadding(): number; set overlayTextVerticalPadding(v: number); /** * Gets or sets the angle rotation (in degrees) of the overlay text in relation to shape of data annotation. */ get overlayTextAngle(): number; set overlayTextAngle(v: number); /** * Gets or sets the color the overlay text. */ get overlayTextColor(): string; set overlayTextColor(v: string); /** * Gets or sets the background the overlay text. */ get overlayTextBackground(): string; set overlayTextBackground(v: string); /** * Gets or sets the border stroke of the overlay text. */ get overlayTextBorderColor(): string; set overlayTextBorderColor(v: string); /** * Gets or sets the border corner of the overlay text. */ get overlayTextBorderRadius(): number; set overlayTextBorderRadius(v: number); /** * Gets or sets the border thickness of the overlay text. */ get overlayTextBorderThickness(): number; set overlayTextBorderThickness(v: number); /** * Gets or sets whether the overlay text is visible in shape of data annotation */ get overlayTextVisible(): boolean; set overlayTextVisible(v: boolean); /** * Gets or sets the text that will be displayed as the overlay annotation. */ get overlayText(): string; set overlayText(v: string); /** * Gets or sets the shift of the overlay text color based on OverlayTextColorMode. Value must range between -1.0 to 1.0, where 0 means no color shift. */ get overlayTextColorShift(): number; set overlayTextColorShift(v: number); /** * Gets or sets the mode used for shifting the background of overlay text based on the target series. */ get overlayTextColorMode(): AnnotationAppearanceMode; set overlayTextColorMode(v: AnnotationAppearanceMode); /** * Gets or sets whether the overlay text color matches brush of the layer */ get overlayTextColorMatchLayer(): boolean; set overlayTextColorMatchLayer(v: boolean); /** * Gets or sets the shift of the overlay background based on OverlayTextBackgroundMode. Value must range between -1.0 to 1.0, where 0 means no color shift. */ get overlayTextBackgroundShift(): number; set overlayTextBackgroundShift(v: number); /** * Gets or sets the mode used for shifting the background of overlay text based on the target series. */ get overlayTextBackgroundMode(): AnnotationAppearanceMode; set overlayTextBackgroundMode(v: AnnotationAppearanceMode); /** * Gets or sets whether the overlay text background matches brush of the layer */ get overlayTextBackgroundMatchLayer(): boolean; set overlayTextBackgroundMatchLayer(v: boolean); /** * Gets or sets the shift of the overlay border based on OverlayTextBorderMode. Value must range between -1.0 to 1.0, where 0 means no color shift. */ get overlayTextBorderShift(): number; set overlayTextBorderShift(v: number); /** * Gets or sets the mode used for shifting the border of overlay text based on the target series. */ get overlayTextBorderMode(): AnnotationAppearanceMode; set overlayTextBorderMode(v: AnnotationAppearanceMode); /** * Gets or sets whether the overlay text border matches brush of the layer */ get overlayTextBorderMatchLayer(): boolean; set overlayTextBorderMatchLayer(v: boolean); /** * Gets or Sets the style to use for the display text. */ get overlayTextStyle(): string; set overlayTextStyle(v: string); /** * Gets the effective brush for the current value layer. Can be null for value * modes that target multiple series. */ get actualValueLayerBrush(): string; set actualValueLayerBrush(v: string); get isSummarizationSupported(): boolean; findByName(name: string): any; protected _styling(container: any, component: any, parent?: any): void; getSeriesValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number; private _stylingOverlayText; private _stylingOverlayText_wrapped; /** * Event raised when updating style of overlay text */ get stylingOverlayText(): (s: IgrValueLayer, e: IgrOverlayTextUpdatingEventArgs) => void; set stylingOverlayText(ev: (s: IgrValueLayer, e: IgrOverlayTextUpdatingEventArgs) => void); } export interface IIgrValueLayerProps extends IIgrAnnotationLayerProps { /** * Gets or sets the value mode for the overlay. */ valueMode?: ValueLayerValueMode | string; /** * Gets or sets the color to use for the horizontal line. Leave null for an automatic value. */ horizontalLineStroke?: string; /** * Gets or sets the color to use for vertical line. Leave null for an automatic value. */ verticalLineStroke?: string; /** * Gets or sets the name of the series to target this annotation to. If null, this annotation targets all series simultaneously. */ targetSeriesName?: string; /** * Gets or sets the series to target this annotation to. If null, this annotation targets all series simultaneously. */ targetSeries?: IgrSeries; /** * Gets or sets the name of the axis to target this annotation to. If null, this annotation targets all axis simultaneously. */ targetAxisName?: string; /** * Gets or sets the axis to target this annotation to. If null, this annotation targets all value axis simultaneously. */ targetAxis?: IgrAxis; /** * Gets or sets whether to use value interpolation when drawing a line through the best value for the cursor position. */ useInterpolation?: boolean | string; /** * Gets or sets whether to draw annotations over the axes where the crosshair meets with them. */ isAxisAnnotationEnabled?: boolean | string; /** * Sets or gets a function which takes an object that produces a formatted label for the x axis annotation. */ xAxisAnnotationFormatLabel?: (item: any) => string; /** * Sets or gets a function which takes an object that produces a formatted label for the y axis annotation. */ yAxisAnnotationFormatLabel?: (item: any) => string; /** * Gets or sets the color to use for the x axis annotation text. Leave unset for an automatic value. */ xAxisAnnotationTextColor?: string; /** * Gets or sets the color to use for the x axis annotation backing. Leave unset for an automatic value. */ xAxisAnnotationBackground?: string; /** * Gets or sets the corner radius to use for the x axis annotation backing. Leave unset for an automatic value. */ xAxisAnnotationBackgroundCornerRadius?: number | string; /** * Gets or sets the precision to use displaying values for interpolated crosshair positions. */ xAxisAnnotationInterpolatedValuePrecision?: number | string; /** * Gets or sets the color to use for the x axis annotation outline. Leave unset for an automatic value. */ xAxisAnnotationOutline?: string; /** * Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. */ xAxisAnnotationPaddingLeft?: number | string; /** * Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. */ xAxisAnnotationPaddingTop?: number | string; /** * Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. */ xAxisAnnotationPaddingRight?: number | string; /** * Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. */ xAxisAnnotationPaddingBottom?: number | string; /** * Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. */ yAxisAnnotationPaddingLeft?: number | string; /** * Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. */ yAxisAnnotationPaddingTop?: number | string; /** * Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. */ yAxisAnnotationPaddingRight?: number | string; /** * Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. */ yAxisAnnotationPaddingBottom?: number | string; /** * Gets or sets the stroke thickness for the x axis annotation backing. Leave unset for an automatic value. */ xAxisAnnotationStrokeThickness?: number | string; /** * Gets or sets the color to use for the y axis annotation text. Leave unset for an automatic value. */ yAxisAnnotationTextColor?: string; /** * Gets or sets the color to use for the y axis annotation backing. Leave unset for an automatic value. */ yAxisAnnotationBackground?: string; /** * Gets or sets the corner radius to use for the y axis annotation backing. Leave unset for an automatic value. */ yAxisAnnotationBackgroundCornerRadius?: number | string; /** * Gets or sets the precision to use displaying values for interpolated crosshair positions. */ yAxisAnnotationInterpolatedValuePrecision?: number | string; /** * Gets or sets the color to use for the y axis annotation outline. Leave unset for an automatic value. */ yAxisAnnotationOutline?: string; /** * Gets or sets the stroke thickness for the y axis annotation backing. Leave unset for an automatic value. */ yAxisAnnotationStrokeThickness?: number | string; /** * Gets or sets whether to skip unknown values when searching for series values. */ skipUnknownValues?: boolean | string; /** * Gets or sets location of the overlay text in relation to shape of data annotation. */ overlayTextLocation?: OverlayTextLocation | string; /** * Gets or sets the horizontal margin of the overlay text in relation to shape of data annotation. */ overlayTextHorizontalMargin?: number | string; /** * Gets or sets the vertical margin of the overlay text in relation to shape of data annotation. */ overlayTextVerticalMargin?: number | string; /** * Gets or sets the horizontal padding of the overlay text in relation to shape of data annotation. */ overlayTextHorizontalPadding?: number | string; /** * Gets or sets the vertical padding of the overlay text in relation to shape of data annotation. */ overlayTextVerticalPadding?: number | string; /** * Gets or sets the angle rotation (in degrees) of the overlay text in relation to shape of data annotation. */ overlayTextAngle?: number | string; /** * Gets or sets the color the overlay text. */ overlayTextColor?: string; /** * Gets or sets the background the overlay text. */ overlayTextBackground?: string; /** * Gets or sets the border stroke of the overlay text. */ overlayTextBorderColor?: string; /** * Gets or sets the border corner of the overlay text. */ overlayTextBorderRadius?: number | string; /** * Gets or sets the border thickness of the overlay text. */ overlayTextBorderThickness?: number | string; /** * Gets or sets whether the overlay text is visible in shape of data annotation */ overlayTextVisible?: boolean | string; /** * Gets or sets the text that will be displayed as the overlay annotation. */ overlayText?: string; /** * Gets or sets the shift of the overlay text color based on OverlayTextColorMode. Value must range between -1.0 to 1.0, where 0 means no color shift. */ overlayTextColorShift?: number | string; /** * Gets or sets the mode used for shifting the background of overlay text based on the target series. */ overlayTextColorMode?: AnnotationAppearanceMode | string; /** * Gets or sets whether the overlay text color matches brush of the layer */ overlayTextColorMatchLayer?: boolean | string; /** * Gets or sets the shift of the overlay background based on OverlayTextBackgroundMode. Value must range between -1.0 to 1.0, where 0 means no color shift. */ overlayTextBackgroundShift?: number | string; /** * Gets or sets the mode used for shifting the background of overlay text based on the target series. */ overlayTextBackgroundMode?: AnnotationAppearanceMode | string; /** * Gets or sets whether the overlay text background matches brush of the layer */ overlayTextBackgroundMatchLayer?: boolean | string; /** * Gets or sets the shift of the overlay border based on OverlayTextBorderMode. Value must range between -1.0 to 1.0, where 0 means no color shift. */ overlayTextBorderShift?: number | string; /** * Gets or sets the mode used for shifting the border of overlay text based on the target series. */ overlayTextBorderMode?: AnnotationAppearanceMode | string; /** * Gets or sets whether the overlay text border matches brush of the layer */ overlayTextBorderMatchLayer?: boolean | string; /** * Gets or Sets the style to use for the display text. */ overlayTextStyle?: string; /** * Gets the effective brush for the current value layer. Can be null for value * modes that target multiple series. */ actualValueLayerBrush?: string; /** * Event raised when updating style of overlay text */ stylingOverlayText?: (s: IgrValueLayer, e: IgrOverlayTextUpdatingEventArgs) => void; }