@progress/kendo-vue-charts 3.5.0 → 3.5.1-dev.202208150613

package/dist/esm/field-types/mousewheel-zoom.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/field-types/negative-bubble-values.interface.d.ts

@@ -0,0 +1,13 @@
+/**
+ * The appearance settings for the negative values in the Bubble series.
+ */
+export interface NegativeBubbleValues {
+    /**
+     * The color of the negative bubble Chart values.
+     */
+    color?: string;
+    /**
+     * If set to `true`, the Chart displays the negative bubbles. By default, the negative bubbles are not displayed.
+     */
+    visible?: boolean;
+}

package/dist/esm/field-types/negative-bubble-values.interface.js

@@ -0,0 +1,2 @@
+export {};
+// tslint:enable:max-line-length

package/dist/esm/field-types/note-label-position.d.ts

@@ -0,0 +1,41 @@
+/**
+ * The position of a note label.
+ *
+ * @example
+ * ```jsx
+ * import {
+ *  Chart,
+ *  ChartValueAxis,
+ *  ChartValueAxisItem
+ * } from '@progress/kendo-vue-charts';
+ *
+ * <template>
+ *  <Chart>
+ *    <ChartValueAxis>
+ *      <ChartValueAxisItem :notes="notes" />
+ *    </ChartValueAxis>
+ *  </Chart>
+ *  </template>
+ * <script>
+ * export default {
+ *   components: {
+ *      Chart,
+ *      ChartValueAxis,
+ *      ChartValueAxisItem
+ *   },
+ *   computed: {
+ *      notes(){
+ *          return { dataItems: this.dataItems, label: { position: this.position } }
+ *      }
+ *   },
+ *   data () {
+ *       return {
+ *           dataItems: [{value: 1, label: { text: 'Foo' }}],
+ *           position: "outside"
+ *       };
+ *   }
+ * }
+ * </script>
+ * ```
+ */
+export declare type NoteLabelPosition = 'inside' | 'outside';

package/dist/esm/field-types/note-label-position.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/field-types/note-line.interface.d.ts

@@ -0,0 +1,22 @@
+import { DashType } from './dash-type';
+/**
+ * The appearance settings for the note-connecting line.
+ */
+export interface NoteLine {
+    /**
+     * The color of the note line. Accepts a valid CSS color string, including hex and rgb.
+     */
+    color?: string;
+    /**
+     * The dash type of the note line.
+     */
+    dashType?: DashType;
+    /**
+     * The length of the connecting line in pixels.
+     */
+    length?: number;
+    /**
+     * The width of the connecting line in pixels.
+     */
+    width?: number;
+}

package/dist/esm/field-types/note-line.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/field-types/note-position.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Specifies the position of a note.
+ *
+ * @example
+ * ```jsx
+ * import {
+ *  Chart,
+ *  ChartValueAxis,
+ *  ChartValueAxisItem
+ * } from '@progress/kendo-жуе-charts';
+ *
+ * <template>
+ *  <Chart>
+ *    <ChartValueAxis>
+ *      <ChartValueAxisItem :notes="note" />
+ *    </ChartValueAxis>
+ *  </Chart>
+ *  </template>
+ * <script>
+ * export default {
+ *   components: {
+ *      Chart,
+ *      ChartValueAxis,
+ *      ChartValueAxisItem
+ *   },
+ *   computed: {
+ *      notes(){
+ *          return { dataItems: this.dataItems, position: this.position }
+ *      }
+ *   },
+ *   data () {
+ *       return {
+ *             dataItems: [{value: 1}],
+ *             position: "right"
+ *       };
+ *   }
+ * }
+ * </script>
+ * ```
+ */
+export declare type NotePosition = 'top' | 'bottom' | 'left' | 'right';

package/dist/esm/field-types/note-position.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/field-types/overlay.interface.d.ts

@@ -0,0 +1,15 @@
+/**
+ * The appearance settings for the overlay of the series elements.
+ */
+export interface Overlay {
+    /**
+     * The gradient of the Chart series.
+     *
+     * The supported values are:
+     * * `"glass"`—Applicable for the Bar, Column, and Candlestick series.
+     * * `"none"`
+     * * `"roundedBevel"`—Applicable for the Donut and Pie series.
+     * * `"sharpBevel"`—Applicable for the Donut and Pie series.
+     */
+    gradient?: 'glass' | 'none' | 'roundedBevel' | 'sharpBevel';
+}

package/dist/esm/field-types/overlay.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/field-types/padding.interface.d.ts

@@ -0,0 +1,6 @@
+import { Margin } from './margin.interface';
+/**
+ * The padding configuration for each side (see the [basic usage example]({% slug  api_charts_charttitleprops %})).
+ */
+export interface Padding extends Margin {
+}

package/dist/esm/field-types/padding.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/field-types/plot-band-label.interface.d.ts

@@ -0,0 +1,87 @@
+import { drawing } from '@progress/kendo-drawing';
+import { PlotBandLabelVisualArgs } from '../common/property-types';
+import { Border } from './border.interface';
+import { Margin } from './margin.interface';
+import { Padding } from './padding.interface';
+/**
+ * The appearance configuration for the plot band label.
+ */
+export interface PlotBandLabel {
+    /**
+     * The horizontal alignment of the label text.
+     *
+     * By default, the label is aligned to the left.
+     *
+     * The supported values are:
+     * - `"center"`—The label is positioned in the center of the plot band.
+     * - `"right"`—The label is positioned on the right side of the plot band.
+     * - `"left"`—The label is positioned on the left side of the plot band.
+     */
+    align?: 'center' | 'right' | 'left';
+    /**
+     * The background color of the label. Accepts a valid CSS color string, including hex and rgb.
+     */
+    background?: string;
+    /**
+     * The border of the label.
+     */
+    border?: Border;
+    /**
+     * The color of the plot band label text.
+     * Accepts a valid [CSS `color`](https://developer.mozilla.org/en-US/docs/Web/CSS/color)
+     * configuration string, including hex and rgb.
+     */
+    color?: string;
+    /**
+     * The font of the plot band label text.
+     * Accepts a valid [CSS `font`](https://developer.mozilla.org/en-US/docs/Web/CSS/font)
+     * configuration string.
+     */
+    font?: string;
+    /**
+     * The margin of the label. A numeric value sets all margins.
+     */
+    margin?: Margin | number;
+    /**
+     * The padding of the label. A numeric value sets all paddings.
+     */
+    padding?: Padding | number;
+    /**
+     * The vertical position of the label inside the plot band.
+     *
+     * By default, the label is aligned to the top.
+     *
+     * The supported values are:
+     * - `"bottom"`—The label is positioned on the bottom of the plot band.
+     * - `"center"`—The label is positioned in the center of the plot band.
+     * - `"top"`—The label is positioned on the top of the plot band.
+     */
+    position?: 'bottom' | 'center' | 'top';
+    /**
+     * The rotation angle of the label. By default, the label is not rotated.
+     */
+    rotation?: number;
+    /**
+     * The text of the label.
+     *
+     * > The text can be split into multiple lines by using line feed characters ("\n").
+     */
+    text?: string;
+    /**
+     * If set to `false`, the will not display the plot band label.
+     * By default, the plot band labels are not displayed.
+     */
+    visible?: boolean;
+    /**
+     * A function that can be used to create a custom visual for the label.
+     *
+     * The available argument fields are:
+     *
+     * - `text`—The label text.
+     * - `rect`—The geometry [`Rect`]({% slug api_kendo-drawing_geometry_rect %}) that defines where the visual has to be rendered.
+     * - `options`—The label options.
+     * - `createVisual`—A function that can be used to get the default visual.
+     * - `sender`—A reference to the Chart instance.
+     */
+    visual?: (e: PlotBandLabelVisualArgs) => drawing.Element;
+}

package/dist/esm/field-types/plot-band-label.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/field-types/plot-band.interface.d.ts

@@ -0,0 +1,30 @@
+import { PlotBandLabel } from './plot-band-label.interface';
+/**
+ * A plot band ([see example]({% slug plotbands_chart_charts %})).
+ */
+export interface PlotBand {
+    /**
+     * The color of the plot band.
+     */
+    color?: string;
+    /**
+     * The start position of the plot band in axis units.
+     */
+    from?: number | Date;
+    /**
+     * The opacity of the plot band.
+     */
+    opacity?: number;
+    /**
+     * The end position of the plot band in axis units.
+     */
+    to?: number | Date;
+    /**
+     * The label configuration of the plot band.
+     *
+     * To display a label, set the text option.
+     *
+     * See [Plot Bands - Labels]({% slug plotbands_chart_charts %}#toc-labels) for sample usage.
+     */
+    label?: PlotBandLabel;
+}

package/dist/esm/field-types/plot-band.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/field-types/series-labels-position.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Configures the position of the series labels.
+ *
+ * - `"above"`—The label is positioned at the top of the marker. Applicable for series that render points, including the Bubble series.
+ * - `"below"`—The label is positioned at the bottom of the marker. Applicable for series that render points, including the Bubble series.
+ * - `"center"`—The label is positioned at the point center. Applicable for the Bar, Column, Donut, Pie, Funnel, RadarColumn, and Waterfall series.
+ * - `"insideBase"`—The label is positioned inside, near the base of the bar. Applicable for the Bar, Column, and Waterfall series.
+ * - `"insideEnd"`—The label is positioned inside, near the end of the point. Applicable for the Bar, Column, Donut, Pie, RadarColumn, and Waterfall series.
+ * - `"left"`—The label is positioned to the left of the marker. Applicable for series that render points, including the Bubble series.
+ * - `"outsideEnd"`—The label is positioned outside, near the end of the point. Applicable for the Bar, Column, Donut, Pie, RadarColumn, and Waterfall series. Not applicable for stacked series.
+ * - `"right"`—The label is positioned to the right of the marker. Applicable for series that render points, including the Bubble series.
+ * - `"top"`—The label is positioned at the top of the segment. Applicable for the Funnel series.
+ * - `"bottom"`—The label is positioned at the bottom of the segment. Applicable for the Funnel series.
+ * - `"auto"`—The from and to labels are positioned at the top or bottom (for the RangeArea series), or to the left or right (for the VerticalRangeArea series), so that they are outside the filled area. Applicable for the RangeArea and VerticalRangeArea series.
+ */
+export declare type SeriesLabelsPosition = 'auto' | 'above' | 'below' | 'center' | 'insideBase' | 'insideEnd' | 'left' | 'outsideEnd' | 'right' | 'top' | 'bottom';

package/dist/esm/field-types/series-labels-position.js

@@ -0,0 +1,18 @@
+/* eslint-disable max-line-length */
+/**
+ * Configures the position of the series labels.
+ *
+ * - `"above"`—The label is positioned at the top of the marker. Applicable for series that render points, including the Bubble series.
+ * - `"below"`—The label is positioned at the bottom of the marker. Applicable for series that render points, including the Bubble series.
+ * - `"center"`—The label is positioned at the point center. Applicable for the Bar, Column, Donut, Pie, Funnel, RadarColumn, and Waterfall series.
+ * - `"insideBase"`—The label is positioned inside, near the base of the bar. Applicable for the Bar, Column, and Waterfall series.
+ * - `"insideEnd"`—The label is positioned inside, near the end of the point. Applicable for the Bar, Column, Donut, Pie, RadarColumn, and Waterfall series.
+ * - `"left"`—The label is positioned to the left of the marker. Applicable for series that render points, including the Bubble series.
+ * - `"outsideEnd"`—The label is positioned outside, near the end of the point. Applicable for the Bar, Column, Donut, Pie, RadarColumn, and Waterfall series. Not applicable for stacked series.
+ * - `"right"`—The label is positioned to the right of the marker. Applicable for series that render points, including the Bubble series.
+ * - `"top"`—The label is positioned at the top of the segment. Applicable for the Funnel series.
+ * - `"bottom"`—The label is positioned at the bottom of the segment. Applicable for the Funnel series.
+ * - `"auto"`—The from and to labels are positioned at the top or bottom (for the RangeArea series), or to the left or right (for the VerticalRangeArea series), so that they are outside the filled area. Applicable for the RangeArea and VerticalRangeArea series.
+ */
+// tslint:enable:max-line-length
+export {};

package/dist/esm/field-types/series-line.interface.d.ts

@@ -0,0 +1,28 @@
+import { LineStyle } from './line-style';
+/**
+ * The appearance settings for the line of the Area, Candlestick, OHLC, and Waterfall series.
+ */
+export interface SeriesLine {
+    /**
+     * The color of the line. Accepts a valid CSS color string, including hex and rgb.
+     */
+    color?: string;
+    /**
+     * The line opacity. By default, the line is opaque (`opacity = 1`).
+     */
+    opacity?: number;
+    /**
+     * The drawing style of the line. Applicable for the Area, Range Area, Polar Area, and Radar Area series.
+     *
+     * The supported values are:
+     * * `"normal" (default)`—The values are connected with a straight line.
+     * * `"step"`—The values are connected with a right-angled line. Supported only for the Area and Range Area series.
+     * * `"smooth"`—The values are connected with a smooth line.
+     */
+    style?: LineStyle;
+    /**
+     * The line width in pixels.
+     * By default, the width is set to `0` and the line is not visible.
+     */
+    width?: number;
+}

package/dist/esm/field-types/series-line.interface.js

@@ -0,0 +1,2 @@
+export {};
+// tslint:enable:max-line-length

package/dist/esm/field-types/series-stack.interface.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Configures the Stacked series.
+ */
+export interface SeriesStack {
+    /**
+     * The optional stack group name. The `group` option is supported for the Bar and Column series.
+     */
+    group?: string;
+    /**
+     * The type of stack to plot.
+     *
+     * The supported types are:
+     * * `"normal"`—The value of the stack is the sum of all points in the category (or group).
+     * * `"100%"`—The value of the stack is always 100% (1.00). Points within the category (or group) are represented in percentage.
+     */
+    type?: 'normal' | '100%';
+}

package/dist/esm/field-types/series-stack.interface.js

@@ -0,0 +1,2 @@
+export {};
+// tslint:enable:max-line-length

package/dist/esm/field-types/series-type.d.ts

@@ -0,0 +1,38 @@
+/**
+ * The series type.
+ *
+ * @example
+ * ```jsx
+ * import {
+ *  Chart,
+ *  ChartSeries,
+ *  ChartSeriesItem
+ * } from '@progress/kendo-vue-charts';
+ *
+ * <template>
+ *  <Chart>
+ *    <ChartSeries>
+ *      <ChartSeriesItem :type="'line'" :data-items="dataItems" :type="seriesType" />
+ *    </ChartSeries>
+ *  </Chart>
+ * </template>
+ * <script>
+ * export default {
+ *   components: {
+ *      Chart,
+ *      ChartCategoryAxis,
+ *      ChartCategoryAxisItem,
+ *      ChartSeries,
+ *      ChartSeriesItem
+ *   },
+ *   data () {
+ *       return {
+ *          dataItems: [1, 2, 3],
+ *          seriesType: "verticalLine"
+ *       };
+ *   }
+ * }
+ * </script>
+ * ```
+ */
+export declare type SeriesType = 'area' | 'bar' | 'boxPlot' | 'bubble' | 'bullet' | 'candlestick' | 'column' | 'donut' | 'funnel' | 'horizontalWaterfall' | 'line' | 'ohlc' | 'pie' | 'polarArea' | 'polarLine' | 'polarScatter' | 'radarArea' | 'radarColumn' | 'radarLine' | 'rangeArea' | 'rangeBar' | 'rangeColumn' | 'scatter' | 'scatterLine' | 'verticalArea' | 'verticalBoxPlot' | 'verticalBullet' | 'verticalLine' | 'verticalRangeArea' | 'waterfall';

package/dist/esm/field-types/series-type.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/field-types/week-start-day.enum.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Specifies the `weekStartDay` of a [ChartCategoryAxisItem]({% slug api_charts_chartcategoryaxisitemprops %}).
+ */
+export declare enum WeekStartDay {
+    /**
+     * Specifies Sunday as the first day of the week.
+     */
+    Sunday = 0,
+    /**
+     * Specifies Monday as the first day of the week.
+     */
+    Monday = 1,
+    /**
+     * Specifies Tuesday as the first day of the week.
+     */
+    Tuesday = 2,
+    /**
+     * Specifies Wednesday as the first day of the week.
+     */
+    Wednesday = 3,
+    /**
+     * Specifies Thursday as the first day of the week.
+     */
+    Thursday = 4,
+    /**
+     * Specifies Friday as the first day of the week.
+     */
+    Friday = 5,
+    /**
+     * Specifies Saturday as the first day of the week.
+     */
+    Saturday = 6
+}

package/dist/esm/field-types/week-start-day.enum.js

@@ -0,0 +1,34 @@
+/**
+ * Specifies the `weekStartDay` of a [ChartCategoryAxisItem]({% slug api_charts_chartcategoryaxisitemprops %}).
+ */
+export var WeekStartDay;
+(function (WeekStartDay) {
+    /**
+     * Specifies Sunday as the first day of the week.
+     */
+    WeekStartDay[WeekStartDay["Sunday"] = 0] = "Sunday";
+    /**
+     * Specifies Monday as the first day of the week.
+     */
+    WeekStartDay[WeekStartDay["Monday"] = 1] = "Monday";
+    /**
+     * Specifies Tuesday as the first day of the week.
+     */
+    WeekStartDay[WeekStartDay["Tuesday"] = 2] = "Tuesday";
+    /**
+     * Specifies Wednesday as the first day of the week.
+     */
+    WeekStartDay[WeekStartDay["Wednesday"] = 3] = "Wednesday";
+    /**
+     * Specifies Thursday as the first day of the week.
+     */
+    WeekStartDay[WeekStartDay["Thursday"] = 4] = "Thursday";
+    /**
+     * Specifies Friday as the first day of the week.
+     */
+    WeekStartDay[WeekStartDay["Friday"] = 5] = "Friday";
+    /**
+     * Specifies Saturday as the first day of the week.
+     */
+    WeekStartDay[WeekStartDay["Saturday"] = 6] = "Saturday";
+})(WeekStartDay || (WeekStartDay = {}));

package/dist/esm/main.d.ts

@@ -0,0 +1,13 @@
+import { Chart, ChartVue2 } from './Chart';
+import { ChartProps } from './ChartProps';
+import { Sparkline, SparklineVue2 } from './Sparkline';
+import { SparklineProps } from './SparklineProps';
+import { StockChart, StockChartVue2 } from './StockChart';
+import { StockChartProps } from './StockChartProps';
+export * from './tooltip/main';
+export * from './components/main';
+export * from './common/api-types';
+export * from './common/events';
+export * from './common/charts';
+export * from './methods/';
+export { Chart, ChartVue2, ChartProps, Sparkline, SparklineVue2, SparklineProps, StockChart, StockChartVue2, StockChartProps };

package/dist/esm/main.js

@@ -0,0 +1,10 @@
+import { Chart, ChartVue2 } from './Chart.js';
+import { Sparkline, SparklineVue2 } from './Sparkline.js';
+import { StockChart, StockChartVue2 } from './StockChart.js';
+export * from './tooltip/main.js';
+export * from './components/main.js';
+export * from './common/api-types.js';
+export * from './common/events.js';
+export * from './common/charts.js';
+export * from './methods/.js';
+export { Chart, ChartVue2, Sparkline, SparklineVue2, StockChart, StockChartVue2 };

package/dist/esm/methods/index.d.ts

@@ -0,0 +1,36 @@
+import { Group } from '@progress/kendo-drawing';
+import { ChartAxisType, ChartPaneType } from './../common/api-types';
+import { Charts } from './../common/charts';
+/**
+ * Returns the axis with the specified name.
+ *
+ * @param {Chart} chartComponent - The instance of the Kendo UI for Vue Chart component.
+ * @param {string} name - The axis name.
+ * @returns {ChartAxis} - The axis with a corresponding name.
+ */
+declare const findAxisByName: (chartComponent: Charts, name: string) => ChartAxisType | undefined;
+/**
+ * Returns the pane at the specified index.
+ *
+ * @param {Chart} chartComponent - The instance of the Kendo UI for Vue Chart component.
+ * @param {number} index - The pane index.
+ * @returns {ChartPane} - The pane at the specified index.
+ */
+declare const findPaneByIndex: (chartComponent: Charts, index: number) => ChartPaneType | undefined;
+/**
+ * Returns the pane with the specified name.
+ *
+ * @param {Chart} chartComponent - The instance of the Kendo UI for Vue Chart component.
+ * @param {string} name - The name of the pane.
+ * @returns {ChartPane} - The pane with the provided name.
+ */
+declare const findPaneByName: (chartComponent: Charts, name: string) => ChartPaneType | undefined;
+/**
+ * Exports a Chart component as a Drawing `Scene`.
+ *
+ * @param {Chart} chartComponent - The instance of the Kendo UI for Vue Chart component.
+ * @param {any} options - The parameters for the export operation.
+ * @returns {Group} - The root Group of the scene.
+ */
+declare const exportVisual: (chartComponent: Charts, options?: any) => Group | undefined;
+export { findAxisByName, findPaneByIndex, findPaneByName, exportVisual };

package/dist/esm/methods/index.js

@@ -0,0 +1,50 @@
+/**
+ * Returns the axis with the specified name.
+ *
+ * @param {Chart} chartComponent - The instance of the Kendo UI for Vue Chart component.
+ * @param {string} name - The axis name.
+ * @returns {ChartAxis} - The axis with a corresponding name.
+ */
+var findAxisByName = function (chartComponent, name) {
+    if (chartComponent && chartComponent.chartInstance() !== null) {
+        return chartComponent.chartInstance().findAxisByName(name);
+    }
+};
+/**
+ * Returns the pane at the specified index.
+ *
+ * @param {Chart} chartComponent - The instance of the Kendo UI for Vue Chart component.
+ * @param {number} index - The pane index.
+ * @returns {ChartPane} - The pane at the specified index.
+ */
+var findPaneByIndex = function (chartComponent, index) {
+    if (chartComponent && chartComponent.chartInstance() !== null) {
+        return chartComponent.chartInstance().findPaneByIndex(index);
+    }
+};
+/**
+ * Returns the pane with the specified name.
+ *
+ * @param {Chart} chartComponent - The instance of the Kendo UI for Vue Chart component.
+ * @param {string} name - The name of the pane.
+ * @returns {ChartPane} - The pane with the provided name.
+ */
+var findPaneByName = function (chartComponent, name) {
+    if (chartComponent && chartComponent.chartInstance() !== null) {
+        return chartComponent.chartInstance().findPaneByName(name);
+    }
+};
+/**
+ * Exports a Chart component as a Drawing `Scene`.
+ *
+ * @param {Chart} chartComponent - The instance of the Kendo UI for Vue Chart component.
+ * @param {any} options - The parameters for the export operation.
+ * @returns {Group} - The root Group of the scene.
+ */
+var exportVisual = function (chartComponent, options) {
+    if (options === void 0) { options = {}; }
+    if (chartComponent && chartComponent.chartInstance() !== null) {
+        return chartComponent.chartInstance().exportVisual(options);
+    }
+};
+export { findAxisByName, findPaneByIndex, findPaneByName, exportVisual };

package/dist/esm/option-types/axis-defaults/crosshair.interface.d.ts

@@ -0,0 +1,41 @@
+import { DashType } from '../../common/property-types';
+import { AxisDefaultsCrosshairTooltip } from './crosshair.tooltip.interface';
+/**
+ * @hidden
+ */
+export interface AxisDefaultsCrosshair {
+    /**
+     * The color of the crosshair. Accepts a valid CSS color string, including `hex` and `rgb`.
+     */
+    color?: string;
+    /**
+     * The dash type of the crosshair.
+     *
+     * The following dash types are supported:
+     *
+     * - `"dash"`—A line which consists of dashes.
+     * - `"dashDot"`—A line which consists of a repeating pattern of dash-dot.
+     * - `"dot"`—A line which consists of dots.
+     * - `"longDash"`—A line which consists of a repeating pattern of long-dash.
+     * - `"longDashDot"`—A line which consists of a repeating pattern of long-dash-dot.
+     * - `"longDashDotDot"`—A line which consists of a repeating pattern of long-dash-dot-dot.
+     * - `"solid"`—A solid line.
+     */
+    dashType?: DashType | string;
+    /**
+     * The opacity of the crosshair. By default, the crosshair is opaque.
+     */
+    opacity?: number;
+    /**
+     * If set to `true`, the Chart displays the axis crosshair. By default, the axis crosshair is not visible.
+     */
+    visible?: boolean;
+    /**
+     * The width of the crosshair in pixels.
+     */
+    width?: number;
+    /**
+     * The options of the crosshair tooltip. The crosshair tooltip is displayed when the [`axisDefaults.crosshair.tooltip.visible`]({% slug api_charts_chartaxisdefaultscrosshairtooltipprops %}#toc-visible) option is set to `true`.
+     */
+    tooltip?: AxisDefaultsCrosshairTooltip;
+}

package/dist/esm/option-types/axis-defaults/crosshair.interface.js

@@ -0,0 +1,2 @@
+export {};
+// tslint:enable:max-line-length