UNPKG

igniteui-angular-charts

Version:

Ignite UI Angular charting components for building rich data visualizations for modern web apps.

207 lines (206 loc) 13 kB
import { IgxSeriesComponent } from "./igx-series-component"; import { Visibility } from "igniteui-angular-core"; import { IgxAnnotationLayerComponent } from "./igx-annotation-layer-component"; import { CrosshairLayer } from "./CrosshairLayer"; import * as i0 from "@angular/core"; /** * Represents an annotation layer that displays crosshair lines that cross through the closest value of the target series under the cursor. */ export declare class IgxCrosshairLayerComponent extends IgxAnnotationLayerComponent { protected createImplementation(): CrosshairLayer; /** * @hidden */ get i(): CrosshairLayer; constructor(); /** * Gets whether the series is an annotation layer displayed only when hovering over the chart. */ get isAnnotationHoverLayer(): boolean; static ngAcceptInputType_isAnnotationHoverLayer: boolean | string; /** * Gets whether the series is an crosshair annotation layer. */ get isAnnotationCrosshairLayer(): boolean; static ngAcceptInputType_isAnnotationCrosshairLayer: boolean | string; /** * 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(): IgxSeriesComponent; set targetSeries(v: IgxSeriesComponent); /** * 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); static ngAcceptInputType_useInterpolation: boolean | string; /** * Gets or sets whether to draw annotations over the axes where the crosshair meets with them. */ get isAxisAnnotationEnabled(): boolean; set isAxisAnnotationEnabled(v: boolean); static ngAcceptInputType_isAxisAnnotationEnabled: boolean | 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); static ngAcceptInputType_xAxisAnnotationBackgroundCornerRadius: number | string; /** * Gets or sets the precision to use displaying values for interpolated crosshair positions. */ get xAxisAnnotationInterpolatedValuePrecision(): number; set xAxisAnnotationInterpolatedValuePrecision(v: number); static ngAcceptInputType_xAxisAnnotationInterpolatedValuePrecision: number | string; /** * 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); static ngAcceptInputType_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. */ get xAxisAnnotationPaddingTop(): number; set xAxisAnnotationPaddingTop(v: number); static ngAcceptInputType_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. */ get xAxisAnnotationPaddingRight(): number; set xAxisAnnotationPaddingRight(v: number); static ngAcceptInputType_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. */ get xAxisAnnotationPaddingBottom(): number; set xAxisAnnotationPaddingBottom(v: number); static ngAcceptInputType_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. */ get yAxisAnnotationPaddingLeft(): number; set yAxisAnnotationPaddingLeft(v: number); static ngAcceptInputType_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. */ get yAxisAnnotationPaddingTop(): number; set yAxisAnnotationPaddingTop(v: number); static ngAcceptInputType_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. */ get yAxisAnnotationPaddingRight(): number; set yAxisAnnotationPaddingRight(v: number); static ngAcceptInputType_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. */ get yAxisAnnotationPaddingBottom(): number; set yAxisAnnotationPaddingBottom(v: number); static ngAcceptInputType_yAxisAnnotationPaddingBottom: number | string; /** * 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); static ngAcceptInputType_xAxisAnnotationStrokeThickness: number | string; /** * 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); static ngAcceptInputType_yAxisAnnotationBackgroundCornerRadius: number | string; /** * Gets or sets the precision to use displaying values for interpolated crosshair positions. */ get yAxisAnnotationInterpolatedValuePrecision(): number; set yAxisAnnotationInterpolatedValuePrecision(v: number); static ngAcceptInputType_yAxisAnnotationInterpolatedValuePrecision: number | string; /** * 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); static ngAcceptInputType_yAxisAnnotationStrokeThickness: number | string; /** * Gets or sets whether to display the vertical line. */ get verticalLineVisibility(): Visibility; set verticalLineVisibility(v: Visibility); static ngAcceptInputType_verticalLineVisibility: Visibility | string; /** * Gets or sets whether to display the horizontal line. */ get horizontalLineVisibility(): Visibility; set horizontalLineVisibility(v: Visibility); static ngAcceptInputType_horizontalLineVisibility: Visibility | string; /** * Gets or sets whether to skip unknown values when searching for series values. */ get skipUnknownValues(): boolean; set skipUnknownValues(v: boolean); static ngAcceptInputType_skipUnknownValues: boolean | string; /** * Gets or sets whether axis annotation are skipped for zero-value fragments in a given position. */ get skipAxisAnnotationOnZeroValueFragments(): boolean; set skipAxisAnnotationOnZeroValueFragments(v: boolean); static ngAcceptInputType_skipAxisAnnotationOnZeroValueFragments: boolean | string; /** * Gets or sets whether axis annotation are skipped for invalid data in a given position. */ get skipAxisAnnotationOnInvalidData(): boolean; set skipAxisAnnotationOnInvalidData(v: boolean); static ngAcceptInputType_skipAxisAnnotationOnInvalidData: boolean | string; findByName(name: string): any; protected _styling(container: any, component: any, parent?: any): void; static ɵfac: i0.ɵɵFactoryDeclaration<IgxCrosshairLayerComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<IgxCrosshairLayerComponent, "igx-crosshair-layer", never, { "horizontalLineStroke": { "alias": "horizontalLineStroke"; "required": false; }; "verticalLineStroke": { "alias": "verticalLineStroke"; "required": false; }; "targetSeriesName": { "alias": "targetSeriesName"; "required": false; }; "targetSeries": { "alias": "targetSeries"; "required": false; }; "useInterpolation": { "alias": "useInterpolation"; "required": false; }; "isAxisAnnotationEnabled": { "alias": "isAxisAnnotationEnabled"; "required": false; }; "xAxisAnnotationTextColor": { "alias": "xAxisAnnotationTextColor"; "required": false; }; "xAxisAnnotationBackground": { "alias": "xAxisAnnotationBackground"; "required": false; }; "xAxisAnnotationBackgroundCornerRadius": { "alias": "xAxisAnnotationBackgroundCornerRadius"; "required": false; }; "xAxisAnnotationInterpolatedValuePrecision": { "alias": "xAxisAnnotationInterpolatedValuePrecision"; "required": false; }; "xAxisAnnotationOutline": { "alias": "xAxisAnnotationOutline"; "required": false; }; "xAxisAnnotationPaddingLeft": { "alias": "xAxisAnnotationPaddingLeft"; "required": false; }; "xAxisAnnotationPaddingTop": { "alias": "xAxisAnnotationPaddingTop"; "required": false; }; "xAxisAnnotationPaddingRight": { "alias": "xAxisAnnotationPaddingRight"; "required": false; }; "xAxisAnnotationPaddingBottom": { "alias": "xAxisAnnotationPaddingBottom"; "required": false; }; "yAxisAnnotationPaddingLeft": { "alias": "yAxisAnnotationPaddingLeft"; "required": false; }; "yAxisAnnotationPaddingTop": { "alias": "yAxisAnnotationPaddingTop"; "required": false; }; "yAxisAnnotationPaddingRight": { "alias": "yAxisAnnotationPaddingRight"; "required": false; }; "yAxisAnnotationPaddingBottom": { "alias": "yAxisAnnotationPaddingBottom"; "required": false; }; "xAxisAnnotationStrokeThickness": { "alias": "xAxisAnnotationStrokeThickness"; "required": false; }; "yAxisAnnotationTextColor": { "alias": "yAxisAnnotationTextColor"; "required": false; }; "yAxisAnnotationBackground": { "alias": "yAxisAnnotationBackground"; "required": false; }; "yAxisAnnotationBackgroundCornerRadius": { "alias": "yAxisAnnotationBackgroundCornerRadius"; "required": false; }; "yAxisAnnotationInterpolatedValuePrecision": { "alias": "yAxisAnnotationInterpolatedValuePrecision"; "required": false; }; "yAxisAnnotationOutline": { "alias": "yAxisAnnotationOutline"; "required": false; }; "yAxisAnnotationStrokeThickness": { "alias": "yAxisAnnotationStrokeThickness"; "required": false; }; "verticalLineVisibility": { "alias": "verticalLineVisibility"; "required": false; }; "horizontalLineVisibility": { "alias": "horizontalLineVisibility"; "required": false; }; "skipUnknownValues": { "alias": "skipUnknownValues"; "required": false; }; "skipAxisAnnotationOnZeroValueFragments": { "alias": "skipAxisAnnotationOnZeroValueFragments"; "required": false; }; "skipAxisAnnotationOnInvalidData": { "alias": "skipAxisAnnotationOnInvalidData"; "required": false; }; }, {}, never, never, true, never>; }