@progress/kendo-charts 2.12.3-develop.4 → 2.13.0-develop.2

package/dist/npm/option-types/y-axis-item/crosshair.tooltip.interface.d.ts

@@ -0,0 +1,6 @@
+import { AxisCrosshairTooltip } from '../axis-crosshair-tooltip.interface';
+
+/**
+ * Represents the Y-axis crosshair tooltip options.
+ */
+export interface YAxisCrosshairTooltip extends AxisCrosshairTooltip {}

package/dist/npm/option-types/y-axis-item/labels.interface.d.ts

@@ -0,0 +1,107 @@
+import { drawing } from '@progress/kendo-drawing';
+import {
+    AxisLabelContentArgs,
+    AxisLabelVisualArgs,
+    AxisLabelsPosition,
+    Border,
+    DateFormats,
+    LabelRotation,
+    Margin,
+    Padding,
+} from '../../property-types';
+
+/**
+ * Represents the `yAxis.labels` options.
+ */
+export interface YAxisLabels {
+    /**
+     * Specifies the background color of the labels. Accepts a valid CSS color string, including HEX and RGB.
+     */
+    background?: string;
+
+    /**
+     * Specifies the border of the labels.
+     */
+    border?: Border;
+
+    /**
+     * Specifies the text color of the labels. Accepts a valid CSS color string, including HEX and RGB.
+     */
+    color?: string;
+
+    /**
+     * Specifies the function which returns the label content.
+     * You can split the text into multiple lines by using the line feed characters (`"\n"`).
+     */
+    content?: (e: AxisLabelContentArgs) => string;
+
+    /**
+     * Specifies the culture to use when formatting date values.
+     */
+    culture?: string;
+
+    /**
+     * Specifies the format for displaying the labels when the X values are dates. Uses the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting) method of IntlService.
+     * Contains one placeholder (`"{0}"`) which represents the category value.
+     * Charts select the appropriate format for the current `yAxis.baseUnit`. Setting the
+     * `categoryAxis.labels.format` option overrides the date formats.
+     */
+    dateFormats?: DateFormats;
+
+    /**
+     * Specifies the font style of the labels.
+     */
+    font?: string;
+
+    /**
+     * Specifies the format for displaying the labels. Uses the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
+     * Contains one placeholder (`"{0}"`) which represents the category value.
+     */
+    format?: string;
+
+    /**
+     * Specifies the margin of the labels. A numeric value sets all margins.
+     */
+    margin?: Margin | number;
+
+    /**
+     * If set to `true`, the Chart mirrors the axis labels and ticks. If the labels are normally on the
+     * left side of the axis, the mirroring of the axis renders them to the right.
+     */
+    mirror?: boolean;
+
+    /**
+     * Specifies the padding of the labels. A numeric value sets all paddings.
+     */
+    padding?: Padding | number;
+
+    /**
+     * Specifies the position of the axis labels. By default, labels are positioned next to the axis.
+     */
+    position?: AxisLabelsPosition;
+
+    /**
+     * Specifies the rotation angle of the labels. By default, the labels are not rotated.
+     */
+    rotation?: LabelRotation | number | 'auto';
+
+    /**
+     * Specifies the number of labels to skip.
+     */
+    skip?: number;
+
+    /**
+     * Specifies the label rendering step&mdash;renders every `n`<sup>th</sup> label. By default, every label is rendered.
+     */
+    step?: number;
+
+    /**
+     * If set to `true`, the Chart displays the Y-axis labels. By default, the Y-axis labels are visible.
+     */
+    visible?: boolean;
+
+    /**
+     * Specifies a function that can be used to create a custom visual for the labels.
+     */
+    visual?: (e: AxisLabelVisualArgs) => drawing.Element;
+}

package/dist/npm/option-types/y-axis-item/notes.icon.interface.d.ts

@@ -0,0 +1,32 @@
+import { Border, MarkerType } from '../../property-types';
+
+/**
+ * Represents the Y-axis notes icon options.
+ */
+export interface YAxisNotesIcon {
+
+  /**
+   * Sets the background color of the notes icon.
+   */
+  background?: string;
+
+  /**
+   * Configures the border of the notes icon.
+   */
+  border?: Border;
+
+  /**
+   * Sets the size of the notes icon.
+   */
+  size?: number;
+
+  /**
+   * Sets the shape of the notes icon.
+   */
+  type?: MarkerType;
+
+  /**
+   * Sets the visibility of the notes icon.
+   */
+  visible?: boolean;
+}

package/dist/npm/option-types/y-axis-item/notes.interface.d.ts

@@ -0,0 +1,40 @@
+import { drawing } from '@progress/kendo-drawing';
+import { AxisNoteVisualArgs, NoteLine, NotePosition } from '../../property-types';
+import { YAxisNotesIcon } from './notes.icon.interface';
+import { YAxisNotesLabel } from './notes.label.interface';
+
+/**
+ * Represents the configuration options of the Y-axis notes.
+ */
+export interface YAxisNotes {
+
+  /**
+   * Specifies the items of the notes.
+   */
+  data?: any[];
+
+  /**
+   * Specifies the line of the notes.
+   */
+  line?: NoteLine;
+
+  /**
+   * Specifies the position of the Y-axis notes.
+   */
+  position?: NotePosition;
+
+  /**
+   * Specifies a function for creating custom visuals for the notes.
+   */
+  visual?: (e: AxisNoteVisualArgs) => drawing.Element;
+
+  /**
+   * Specifies the icon of the notes.
+   */
+  icon?: YAxisNotesIcon;
+
+  /**
+   * Specifies the label of the notes.
+   */
+  label?: YAxisNotesLabel;
+}

package/dist/npm/option-types/y-axis-item/notes.label.interface.d.ts

@@ -0,0 +1,58 @@
+import { AxisNoteContentArgs, Border, NoteLabelPosition } from '../../property-types';
+
+/**
+ * Represents the Y-axis notes label options.
+ */
+export interface YAxisNotesLabel {
+
+  /**
+   * Sets the background color of the label.
+   * Accepts a valid CSS color string, including HEX and RGB.
+   */
+  background?: string;
+
+  /**
+   * Configures the border of the label.
+   */
+  border?: Border;
+
+  /**
+   * Sets the text color of the label.
+   * Accepts a valid CSS color string, including HEX and RGB.
+   */
+  color?: string;
+
+  /**
+   * Sets the function which returns the label content.
+   * You can split the text into multiple lines by using line feed characters (`"\n"`).
+   */
+  content?: (e: AxisNoteContentArgs) => string;
+
+  /**
+   * Sets the font style of the label.
+   */
+  font?: string;
+
+  /**
+   * Sets the format for displaying the notes label.
+   * Uses the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting) and contains one placeholder (`"{0}"`) which represents the axis value.
+   */
+  format?: string;
+
+  /**
+   * Sets the position of the labels.
+   */
+  position?: NoteLabelPosition;
+
+  /**
+   * Sets the rotation angle of the label.
+   * By default, the label is not rotated.
+   */
+  rotation?: number;
+
+  /**
+   * Determines if the Chart displays the Y-axis notes label.
+   * By default, the Y-axis notes label is visible.
+   */
+  visible?: boolean;
+}

package/dist/npm/option-types/y-axis-item/title.interface.d.ts

@@ -0,0 +1,65 @@
+import { drawing } from '@progress/kendo-drawing';
+import { AxisTitlePosition, Border, Margin, Padding, TitleVisualArgs } from '../../property-types';
+
+/**
+ * Represents the configuration options of the Y-axis title.
+ */
+export interface YAxisTitle {
+
+  /**
+   * Specifies the background color of the title. Accepts a valid CSS color string, including HEX and RGB.
+   */
+  background?: string;
+
+  /**
+   * Specifies the border of the title.
+   */
+  border?: Border;
+
+  /**
+   * Specifies the text color of the title. Accepts a valid CSS color string, including HEX and RGB.
+   */
+  color?: string;
+
+  /**
+   * Specifies the font style of the title.
+   */
+  font?: string;
+
+  /**
+   * Specifies the margin of the title. A numeric value sets all margins.
+   */
+  margin?: Margin | number;
+
+  /**
+   * Specifies the padding of the title. A numeric value sets all paddings.
+   */
+  padding?: Padding | number;
+
+  /**
+   * Specifies the position of the title.
+   */
+  position?: AxisTitlePosition;
+
+  /**
+   * Specifies the rotation angle of the title. By default, the title is not rotated.
+   */
+  rotation?: number;
+
+  /**
+   * Specifies the text of the title.
+   * You can split the text into multiple lines by using the line feed characters (`"\n"`).
+   */
+  text?: string;
+
+  /**
+   * If set to `true`, the Chart displays the Scatter Chart Y-axis title.
+   * By default, the Scatter Chart Y-axis title is visible.
+   */
+  visible?: boolean;
+
+  /**
+   * Specifies a function for creating custom visuals for the title.
+   */
+  visual?: (e: TitleVisualArgs) => drawing.Element;
+}

package/dist/npm/option-types/y-axis-item.interface.d.ts

@@ -0,0 +1,154 @@
+import { AxisLine, AxisTicks, BaseUnit, GridLines, PlotBand } from '../property-types';
+import { YAxisCrosshair } from './y-axis-item/crosshair.interface';
+import { YAxisLabels } from './y-axis-item/labels.interface';
+import { YAxisNotes } from './y-axis-item/notes.interface';
+import { YAxisTitle } from './y-axis-item/title.interface';
+/**
+ * Represents the Y-axis options.
+ */
+export interface YAxis {
+
+  /**
+   * When dealing with objects, it specifies the value at which the Y axis crosses this axis, for arrays it denotes the value indices at which the Y axes cross the value axis, and for dates, it represents the date at which the Y axis crosses this axis.
+   *
+   * To denote the far end of the axis, set a value that is greater than or equal to the axis maximum value.
+   */
+  axisCrossingValue?: any | any[];
+
+  /**
+   * Specifies the background color of the axis.
+   */
+  background?: string;
+
+  /**
+   * The category names. Applicable for charts with X and Y category axes.
+   */
+   categories?: any[];
+
+  /**
+   * The base time interval for the axis labels.
+   * The default `baseUnit` is automatically determined from the value range.
+   */
+  baseUnit?: BaseUnit;
+
+  /**
+   * Specifies the color of the axis. Accepts a valid CSS color string, including HEX and RGB.
+   */
+  color?: string;
+
+  /**
+   * The configuration of the axis lines. Also affects the major and minor ticks, but not the grid lines.
+   */
+  line?: AxisLine;
+
+  /**
+   * The configuration of the major grid lines.
+   * These are the lines that are an extension of the major ticks through the body of the Chart.
+   */
+  majorGridLines?: GridLines;
+
+  /**
+   * The configuration of the Scatter Chart Y-axis major ticks.
+   */
+  majorTicks?: AxisTicks;
+
+  /**
+   * The interval between major divisions.
+   * If this is a date axis, the value represents the number of [`yAxis.baseUnits`]({% slug api_charts_yaxis %}#baseunit) between major divisions.
+   * If the [`yAxis.type`]({% slug api_charts_yaxis %}#type) is set to `"log"`, the `majorUnit` value is used for the base of the logarithm.
+   */
+  majorUnit?: number;
+
+  /**
+   * The maximum value of the axis.
+   */
+  max?: any;
+
+  /**
+   * The minimum value of the axis.
+   */
+  min?: any;
+
+  /**
+   * The configuration of the minor grid lines.
+   * These are the lines that are an extension of the minor ticks through the body of the Chart.
+   */
+  minorGridLines?: GridLines;
+
+  /**
+   * The configuration of the Y-axis minor ticks.
+   */
+  minorTicks?: AxisTicks;
+
+  /**
+   * The interval between minor divisions. It defaults to one-fifth (1/5) of [`yAxis.majorUnit`]({% slug api_charts_yaxis %}#majorunit).
+   * If [`yAxis.type`]({% slug api_charts_yaxis %}#type) is set to `"log"`, the `minorUnit` value represents the number of divisions between
+   * two major units and defaults to the major unit minus one.
+   */
+  minorUnit?: number;
+
+  /**
+   * The unique axis name. Used to associate a series with a Y axis by using the [`series.yAxis`]({% slug api_charts_series %}#yaxis) option.
+   */
+  name?: string;
+
+  /**
+   * If set to `true`, the Chart prevents the automatic axis range from snapping to zero.
+   * Setting it to `false` forces the automatic axis range to snap to zero.
+   */
+  narrowRange?: boolean;
+
+  /**
+   * The name of the pane in which the axis has to be rendered.
+   * If not set, the axis is rendered in the first (default) pane.
+   */
+  pane?: string;
+
+  /**
+   * The plot bands of the Y axis.
+   */
+  plotBands?: PlotBand[];
+
+  /**
+   * If set to `true`, the value axis direction is reversed.
+   * By default, the values increase from left to right and from bottom to top.
+   */
+  reverse?: boolean;
+
+  /**
+   * The axis type.
+   *
+   * The options are `numeric` for a numeric axis, `date` for a specialized axis for displaying chronological data, and `log` for a logarithmic axis.
+   *
+   * If the series Y value is of the `date` type, the Chart automatically switches to a date axis.
+   * To avoid this behavior, set the `type`.
+   */
+  type?: 'numeric' | 'log' | 'date';
+
+  /**
+   * If set to `true`, the Chart displays the Y axis. By default, the Y axis is visible.
+   */
+  visible?: boolean;
+
+  /**
+   * The configuration options of the crosshair.
+   * The crosshair is displayed when the [`yAxis.crosshair.visible`]({% slug api_charts_yaxiscrosshair %}#visible) option is set to `true`.
+   */
+  crosshair?: YAxisCrosshair;
+
+  /**
+   * The axis labels configuration.
+   */
+  labels?: YAxisLabels;
+
+  /**
+   * The Y-axis notes configuration.
+   */
+  notes?: YAxisNotes;
+
+  /**
+   * The title configuration of the Scatter Chart Y axis.
+   * To display the title, set the [`yAxis.title.text`]({% slug api_charts_yaxistitle %}#text) option.
+   */
+  title?: YAxisTitle;
+}

package/dist/npm/option-types/zoomable.interface.d.ts

@@ -0,0 +1,16 @@
+import { DragAction, MousewheelZoom } from '../property-types';
+/**
+ * Specifies the zoomable options.
+ */
+export interface Zoomable {
+
+  /**
+   * Determines whether the Chart can be zoomed by using the mousewheel.
+   */
+  mousewheel?: boolean | MousewheelZoom;
+
+  /**
+   * Determines whether the Chart can be zoomed by using selection.
+   */
+  selection?: boolean | DragAction;
+}

package/dist/npm/property-types.d.ts

@@ -0,0 +1,151 @@
+// Re-export component field types
+export { AutoBaseUnitSteps } from './field-types/auto-base-unit-steps.interface';
+export { AxisLabelsPosition } from './field-types/axis-labels-position';
+export { AxisLine } from './field-types/axis-line.interface';
+export { AxisTicks } from './field-types/axis-ticks.interface';
+export { AxisTitlePosition } from './field-types/axis-title-position';
+export { BaseUnit } from './field-types/base-unit';
+export { Border } from './field-types/border.interface';
+export { BulletTarget } from './field-types/bullet-target.interface';
+export { BulletTargetLine } from './field-types/bullet-target-line.interface';
+export { CategoryBaseUnit } from './field-types/category-base-unit';
+export { DashType } from './field-types/dash-type';
+export { DateFormats } from './field-types/date-formats.interface';
+export { DragAction } from './field-types/drag-action.interface';
+export { ErrorBarLine } from './field-types/error-bar-line.interface';
+export { FocusHighlight } from './field-types/focus-highlight.interface';
+export { GridLines } from './field-types/grid-lines.interface';
+export { HighlightLine } from './field-types/highlight-line.interface';
+export { LabelConnectors } from './field-types/label-connectors.interface';
+export { LabelRotation } from './field-types/label-rotation.interface';
+export { LegendLabels } from './field-types/legend-labels.interface';
+export { LineStyle } from './field-types/line-style';
+export { LockAxis } from './field-types/lock-axis';
+export { Margin } from './field-types/margin.interface';
+export { MarkerType } from './field-types/marker-type';
+export { ModifierKey } from './field-types/modifier-key';
+export { MousewheelZoom } from './field-types/mousewheel-zoom.interface';
+export { MousewheelSelect } from './field-types/mousewheel-select.interface';
+export { NegativeBubbleValues } from './field-types/negative-bubble-values.interface';
+export { NoteLabelPosition } from './field-types/note-label-position';
+export { NoteLine } from './field-types/note-line.interface';
+export { NotePosition } from './field-types/note-position';
+export { Overlay } from './field-types/overlay.interface';
+export { Padding } from './field-types/padding.interface';
+export { PlotBand } from './field-types/plot-band.interface';
+export { PlotBandLabel } from './field-types/plot-band-label.interface';
+export { SeriesLabelsPosition } from './field-types/series-labels-position';
+export { SeriesLabelsAlignment } from './field-types/series-labels-alignment';
+export { SeriesLine } from './field-types/series-line.interface';
+export { SeriesMean } from './field-types/series-mean.interface';
+export { SeriesMedian } from './field-types/series-median.interface';
+export { SeriesWhiskers } from './field-types/series-whiskers.interface';
+export { SeriesStack } from './field-types/series-stack.interface';
+export { SeriesType } from './field-types/series-type';
+export { TrendlineForecast } from './field-types/trendline-forecast.interface';
+export { WeekStartDay } from './field-types/week-start-day.enum';
+
+// Re-export component callback argument types
+export { AxisLabelContentArgs } from './argument-types/axis-label-content-args.interface';
+export { AxisLabelVisualArgs } from './argument-types/axis-label-visual-args.interface';
+export { AxisNoteVisualArgs } from './argument-types/axis-note-visual-args.interface';
+export { AxisNoteContentArgs } from './argument-types/axis-note-content-args.interface';
+export { ErrorBarsVisualArgs } from './argument-types/error-bars-visual-args.interface';
+export { ErrorBarsValueArgs } from './argument-types/error-bars-value-args.interface';
+export { HighlightToggleArgs } from './argument-types/highlight-toggle-args.interface';
+export { HighlightVisualArgs } from './argument-types/highlight-visual-args.interface';
+export { LegendItemVisualArgs } from './argument-types/legend-item-visual-args.interface';
+export { LegendLabelsContentArgs } from './argument-types/legend-labels-content-args.interface';
+export { MarkersVisualArgs } from './argument-types/markers-visual-args.interface';
+export { SeriesLabelsVisualArgs } from './argument-types/series-labels-visual-args.interface';
+export { SeriesLabelsContentArgs } from './argument-types/series-labels-content-args.interface';
+export { SeriesNoteVisualArgs } from './argument-types/series-note-visual-args.interface';
+export { SeriesNoteContentArgs } from './argument-types/series-note-content-args.interface';
+export { SeriesVisualArgs } from './argument-types/series-visual-args.interface';
+export { TitleVisualArgs } from './argument-types/title-visual-args.interface';
+export { PlotBandLabelVisualArgs } from './argument-types/plot-band-label-visual-args.interface';
+
+// Re-export component option types
+
+export { AxisDefaults } from './option-types/axis-defaults.interface';
+export { AxisDefaultsCrosshair } from './option-types/axis-defaults/crosshair.interface';
+export { AxisDefaultsCrosshairTooltip } from './option-types/axis-defaults/crosshair.tooltip.interface';
+export { AxisDefaultsLabels } from './option-types/axis-defaults/labels.interface';
+export { AxisDefaultsTitle } from './option-types/axis-defaults/title.interface';
+export { CategoryAxis } from './option-types/category-axis-item.interface';
+export { CategoryAxisCrosshair } from './option-types/category-axis-item/crosshair.interface';
+export { CategoryAxisCrosshairTooltip } from './option-types/category-axis-item/crosshair.tooltip.interface';
+export { CategoryAxisLabels } from './option-types/category-axis-item/labels.interface';
+export { CategoryAxisNotes } from './option-types/category-axis-item/notes.interface';
+export { CategoryAxisNotesIcon } from './option-types/category-axis-item/notes.icon.interface';
+export { CategoryAxisNotesLabel } from './option-types/category-axis-item/notes.label.interface';
+export { CategoryAxisRangeLabels } from './option-types/category-axis-item/range-labels.interface';
+export { CategoryAxisSelect } from './option-types/category-axis-item/select.interface';
+export { CategoryAxisTitle } from './option-types/category-axis-item/title.interface';
+export { ChartArea } from './option-types/chart-area.interface';
+export { Legend } from './option-types/legend.interface';
+export { LegendInactiveItems } from './option-types/legend/inactive-items.interface';
+export { LegendItem, LegendItemArea, LegendItemLine, LegendItemHighlight, LegendItemMarkers, LegendItemMarkersBorder, LegendItemType } from './option-types/legend/item.interface';
+export { LegendMarkers } from './option-types/legend/markers.interface';
+export { LegendTitle } from './option-types/legend/legend-title.interface';
+export { MarkersHighlight } from './option-types/series-item/markers-highlight.interface';
+export { NavigatorOptions } from './option-types/navigator.interface';
+export { NavigatorHintOptions } from './option-types/navigator/hint.interface';
+export { NavigatorHintContentArgs } from './option-types/navigator/hint-content-args.interface';
+export { NavigatorSelect } from './option-types/navigator/select.interface';
+export { Pane } from './option-types/pane.interface';
+export { PaneDefaults } from './option-types/pane-defaults.interface';
+export { PaneDefaultsTitle } from './option-types/pane-defaults/title.interface';
+export { PanesTitle } from './option-types/pane/title.interface';
+export { PlotArea } from './option-types/plot-area.interface';
+export { Series } from './option-types/series-item.interface';
+export { SeriesDefaults } from './option-types/series-defaults.interface';
+export { SeriesDefaultsLabels } from './option-types/series-defaults/labels.interface';
+export { SeriesDefaultsLabelsFrom } from './option-types/series-defaults/labels.from.interface';
+export { SeriesDefaultsLabelsTo } from './option-types/series-defaults/labels.to.interface';
+export { SeriesDefaultsNotes } from './option-types/series-defaults/notes.interface';
+export { SeriesDefaultsNotesIcon } from './option-types/series-defaults/notes.icon.interface';
+export { SeriesDefaultsNotesLabel } from './option-types/series-defaults/notes.label.interface';
+export { SeriesDefaultsTooltip } from './option-types/series-defaults/tooltip.interface';
+export { SeriesErrorBars } from './option-types/series-item/error-bars.interface';
+export { SeriesExtremes } from './option-types/series-item/extremes.interface';
+export { SeriesHighlight } from './option-types/series-item/highlight.interface';
+export { SeriesLabels } from './option-types/series-item/labels.interface';
+export { SeriesLabelsFrom } from './option-types/series-item/labels.from.interface';
+export { SeriesLabelsTo } from './option-types/series-item/labels.to.interface';
+export { SeriesMarkers } from './option-types/series-item/markers.interface';
+export { SeriesNotes } from './option-types/series-item/notes.interface';
+export { SeriesNotesIcon } from './option-types/series-item/notes.icon.interface';
+export { SeriesNotesLabel } from './option-types/series-item/notes.label.interface';
+export { SeriesOutliers } from './option-types/series-item/outliers.interface';
+export { SeriesTooltip } from './option-types/series-item/tooltip.interface';
+export { SeriesTrendline } from './option-types/series-item/trendline.interface';
+export { Subtitle } from './option-types/subtitle.interface';
+export { Title } from './option-types/title.interface';
+export { Tooltip } from './option-types/tooltip.interface';
+export { TooltipBorder } from './option-types/tooltip-border.interface';
+export { ValueAxis } from './option-types/value-axis-item.interface';
+export { ValueAxisCrosshair } from './option-types/value-axis-item/crosshair.interface';
+export { ValueAxisCrosshairTooltip } from './option-types/value-axis-item/crosshair.tooltip.interface';
+export { ValueAxisLabels } from './option-types/value-axis-item/labels.interface';
+export { ValueAxisNotes } from './option-types/value-axis-item/notes.interface';
+export { ValueAxisNotesIcon } from './option-types/value-axis-item/notes.icon.interface';
+export { ValueAxisNotesLabel } from './option-types/value-axis-item/notes.label.interface';
+export { ValueAxisTitle } from './option-types/value-axis-item/title.interface';
+export { XAxis } from './option-types/x-axis-item.interface';
+export { XAxisCrosshair } from './option-types/x-axis-item/crosshair.interface';
+export { XAxisCrosshairTooltip } from './option-types/x-axis-item/crosshair.tooltip.interface';
+export { XAxisLabels } from './option-types/x-axis-item/labels.interface';
+export { XAxisNotes } from './option-types/x-axis-item/notes.interface';
+export { XAxisNotesIcon } from './option-types/x-axis-item/notes.icon.interface';
+export { XAxisNotesLabel } from './option-types/x-axis-item/notes.label.interface';
+export { XAxisTitle } from './option-types/x-axis-item/title.interface';
+export { YAxis } from './option-types/y-axis-item.interface';
+export { YAxisCrosshair } from './option-types/y-axis-item/crosshair.interface';
+export { YAxisCrosshairTooltip } from './option-types/y-axis-item/crosshair.tooltip.interface';
+export { YAxisLabels } from './option-types/y-axis-item/labels.interface';
+export { YAxisNotes } from './option-types/y-axis-item/notes.interface';
+export { YAxisNotesIcon } from './option-types/y-axis-item/notes.icon.interface';
+export { YAxisNotesLabel } from './option-types/y-axis-item/notes.label.interface';
+export { YAxisTitle } from './option-types/y-axis-item/title.interface';
+export { Zoomable } from './option-types/zoomable.interface';

package/dist/npm/sankey.d.ts

@@ -321,7 +321,7 @@ export interface SankeyTitle {
 /**
  * @hidden
  */
-interface LegendTitle extends Omit<SankeyTitle, 'description'> { }
+interface SankeyLegendTitle extends Omit<SankeyTitle, 'description'> { }
 
 /**
  * Represents the legend item options of the Sankey component.
@@ -447,7 +447,7 @@ export interface SankeyLegend {
     /**
      * The title options of the legend.
      */
-    title?: LegendTitle;
+    title?: SankeyLegendTitle;
     /**
      * The visibility of the legend.
      */
@@ -652,6 +652,8 @@ export interface SankeyEvent {
     preventDefault(): void;
     /**
      * Indicates whether the default action has been prevented.
+     *
+     * @return {boolean} `true` if the default action has been prevented; otherwise, `false`.
      */
     isDefaultPrevented(): boolean;
 }
@@ -715,7 +717,7 @@ export interface SankeyTooltipEvent extends SankeyEvent {
  * @param data - The data objects.
  * @param dimensions - The dimensions of the data.
  * @param measure - The measure of the data.
- * @returns The Sankey data.
+ * @returns { links: SankeyLink[]; nodes: SankeyNode[] } The Sankey data.
  *
  * @example
  * ```ts