You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 4-6.RSVP →
Socket
Book a DemoInstallSign in
Socket
Book a DemoInstallSign in

ag-charts-types

Package Overview
Dependencies
Maintainers
1
Versions
30
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

ag-charts-types - npm Package Compare versions

Comparing version

11.2.4
to
11.3.0

93

dist/types/src/chart/annotationsOptions.d.ts

@@ -10,4 +10,4 @@ import type { AgStateSerializableDate } from '../api/stateTypes';

'vertical-line'?: AgCrossLineAnnotationStyles;
'disjoint-channel'?: AgChannelAnnotationStyles;
'parallel-channel'?: AgChannelAnnotationStyles;
'disjoint-channel'?: AgDisjointChannelAnnotationStyles;
'parallel-channel'?: AgParallelChannelAnnotationStyles;
'fibonacci-retracement'?: AgFibonacciAnnotationStyles;

@@ -35,13 +35,13 @@ 'fibonacci-retracement-trend-based'?: AgFibonacciAnnotationStyles;

handle?: AgAnnotationHandleStyles;
text?: AgLineAnnotationText;
text?: AgLineAnnotationTextStyles;
}
export interface AgCrossLineAnnotationStyles extends AgLineAnnotationStyles {
export interface AgCrossLineAnnotationStyles extends Lockable, Visible, StrokeOptions, LineOptions {
axisLabel?: AgAnnotationAxisLabel;
handle?: AgAnnotationHandleStyles;
text?: AgLineAnnotationTextStyles;
}
export interface AgChannelAnnotationStyles extends Extendable, Lockable, Visible, StrokeOptions, LineOptions {
handle?: AgAnnotationHandleStyles;
export interface AgDisjointChannelAnnotationStyles extends AgChannelAnnotationStyles {
}
export interface AgParallelChannelAnnotationStyles extends AgChannelAnnotationStyles {
middle?: AgChannelAnnotationMiddle;
/** The fill colour for the middle of the channel. */
background?: AgChannelAnnotationBackground;
text?: AgChannelAnnotationTextOptions;
}

@@ -53,7 +53,7 @@ export interface AgFibonacciAnnotationStyles extends AgLineAnnotationStyles {

showFill?: boolean;
/** Whether the Fibonacci range lines are multicoloured. */
/** Whether the Fibonacci range lines are multicolored. */
isMultiColor?: boolean;
/** The colours to cycle through for the strokes of the Fibonacci lines. */
/** The colors to cycle through for the strokes of the Fibonacci lines. */
strokes?: CssColor[];
/** The colour for the strokes of the Fibonacci lines if isMultiColor is `false`. */
/** The color for the strokes of the Fibonacci lines if isMultiColor is `false`. */
rangeStroke?: CssColor;

@@ -71,2 +71,3 @@ /** The number of fibonacci range bands. */

export interface AgNoteAnnotationStyles extends AgTextAnnotationStyles, StrokeOptions, FillOptions {
/** The fill and stroke for note icon. */
background?: AgNoteAnnotationBackground;

@@ -81,3 +82,3 @@ }

statistics?: AgMeasurerAnnotationStatistics;
text?: AgLineAnnotationTextOptions;
text?: AgLineAnnotationTextStyles;
}

@@ -145,3 +146,11 @@ export interface AgQuickMeasurerAnnotationStyles extends Visible {

}
export interface AgParallelChannelAnnotation extends AnnotationLinePoints, Extendable, Lockable, Visible, StrokeOptions, LineOptions {
export interface AgChannelAnnotationStyles extends Extendable, Lockable, Visible, StrokeOptions, LineOptions {
/** Configuration for the drag handles. */
handle?: AgAnnotationHandle;
/** Configuration for the channel text. */
text?: AgChannelAnnotationTextStyles;
/** The fill color for the middle of the channel. */
background?: AgChannelAnnotationBackground;
}
export interface AgParallelChannelAnnotation extends AgChannelAnnotationStyles, AnnotationLinePoints {
/** Configuration for the parallel-channel annotation.*/

@@ -151,12 +160,8 @@ type: 'parallel-channel';

height: number;
/** Configuration for the drag handles. */
handle?: AgAnnotationHandle;
/** Configuration for the channel text. */
text?: AgChannelAnnotationText;
/** Configuration for the line in the middle of the channel. */
middle?: AgChannelAnnotationMiddle;
/** The fill colour for the middle of the channel. */
background?: AgChannelAnnotationBackground;
/** Configuration for the channel text. */
text?: AgChannelAnnotationText;
}
export interface AgDisjointChannelAnnotation extends AnnotationLinePoints, Extendable, Lockable, Visible, StrokeOptions, LineOptions {
export interface AgDisjointChannelAnnotation extends AgChannelAnnotationStyles, AnnotationLinePoints {
/** Configuration for the disjoint-channel annotation.*/

@@ -168,38 +173,30 @@ type: 'disjoint-channel';

endHeight: number;
/** Configuration for the drag handles. */
handle?: AgAnnotationHandle;
/** The fill colour for the middle of the channel. */
background?: AgChannelAnnotationBackground;
/** Configuration for the channel text. */
text?: AgChannelAnnotationText;
}
export interface AgCalloutAnnotation extends TextualStartEndAnnotation, FillOptions, StrokeOptions {
export interface AgCalloutAnnotation extends AgCalloutAnnotationStyles {
/** Configuration for the callout annotation. */
type: 'callout';
/** The starting point of the annotation. */
start: AgAnnotationPoint;
/** The end point of the annotation. */
end: AgAnnotationPoint;
/** The text content. */
text: string;
}
export interface AgCommentAnnotation extends TextualPointAnnotation, FillOptions {
export interface AgCommentAnnotation extends AgCommentAnnotationStyles, AgAnnotationPoint {
/** Configuration for the comment annotation. */
type: 'comment';
/** The text content. */
text: string;
}
export interface AgNoteAnnotation extends TextualPointAnnotation, FillOptions, StrokeOptions {
export interface AgNoteAnnotation extends AgNoteAnnotationStyles, AgAnnotationPoint {
/** Configuration for the note annotation. */
type: 'note';
/** The fill and stroke for note icon. */
background?: AgNoteAnnotationBackground;
/** The text content. */
text: string;
}
export interface AgTextAnnotation extends TextualPointAnnotation {
export interface AgTextAnnotation extends AgTextAnnotationStyles, AgAnnotationPoint {
/** Configuration for the text annotation. */
type: 'text';
}
interface TextualPointAnnotation extends TextualAnnotation, AgAnnotationPoint {
}
interface TextualStartEndAnnotation extends TextualAnnotation {
/** The starting point of the annotation. */
start: AgAnnotationPoint;
/** The end point of the annotation. */
end: AgAnnotationPoint;
}
interface TextualAnnotation extends Lockable, Visible, FontOptions {
/** Configuration for the drag handle. */
handle?: AgAnnotationHandle;
/** The text content. */

@@ -279,3 +276,3 @@ text: string;

}
export interface AgAnnotationHandle extends FillOptions, StrokeOptions, LineDashOptions {
export interface AgAnnotationHandle extends AgAnnotationHandleStyles {
}

@@ -296,13 +293,13 @@ export interface AgChannelAnnotationMiddle extends Visible, StrokeOptions, LineOptions {

}
export interface AgLineAnnotationText extends AgLineAnnotationTextOptions {
export interface AgLineAnnotationText extends AgLineAnnotationTextStyles {
label?: string;
}
export interface AgChannelAnnotationText extends AgChannelAnnotationTextOptions {
export interface AgChannelAnnotationText extends AgChannelAnnotationTextStyles {
label?: string;
}
export interface AgLineAnnotationTextOptions extends FontOptions {
export interface AgLineAnnotationTextStyles extends FontOptions {
position?: 'top' | 'center' | 'bottom';
alignment?: 'left' | 'center' | 'right';
}
export interface AgChannelAnnotationTextOptions extends FontOptions {
export interface AgChannelAnnotationTextStyles extends FontOptions {
position?: 'top' | 'inside' | 'bottom';

@@ -309,0 +306,0 @@ alignment?: 'left' | 'center' | 'right';

31

dist/types/src/chart/axisOptions.d.ts
import type { Formatter, Styler } from './callbackOptions';
import type { CssColor, Degree, FontFamily, FontSize, FontStyle, FontWeight, PixelSize } from './types';
import type { CssColor, Degree, FontFamilyFull, FontSize, FontStyle, FontWeight, PixelSize } from './types';
export interface AgAxisBoundSeries {

@@ -13,3 +13,3 @@ /** Key used by the series for values on the related axis. */

/** Direction of the axis the title belongs to. */
direction: 'x' | 'y';
direction: 'x' | 'y' | 'angle' | 'radius';
/** Metadata about series bound to the axis the title belongs to. */

@@ -32,3 +32,3 @@ boundSeries: AgAxisBoundSeries[];

/** The font family to use for the title. */
fontFamily?: FontFamily;
fontFamily?: FontFamilyFull;
/** The colour to use for the title. */

@@ -57,3 +57,3 @@ color?: CssColor;

}
export interface AgContinuousAxisOptions<TDatum extends Date | number = number, TInterval extends TimeInterval | number = number> {
export interface AgContinuousAxisOptions<TDatum extends Date | number = number, TInterval extends TimeInterval | TimeIntervalUnit | number = number> {
/** If `true`, the range will be rounded up to ensure nice equal spacing between the ticks. */

@@ -68,3 +68,3 @@ nice?: boolean;

}
export interface AgAxisContinuousIntervalOptions<T extends TimeInterval | number> extends AgAxisBaseIntervalOptions {
export interface AgAxisContinuousIntervalOptions<T extends TimeInterval | TimeIntervalUnit | number> extends AgAxisBaseIntervalOptions {
/** The axis interval. Expressed in the units of the axis. If the configured interval results in too many items given the chart size, it will be ignored. */

@@ -115,3 +115,3 @@ step?: T;

/** The font family to use for the labels */
fontFamily?: FontFamily;
fontFamily?: FontFamilyFull;
/** Padding in pixels between the axis label and the tick. */

@@ -126,2 +126,4 @@ spacing?: PixelSize;

readonly fractionDigits?: number;
readonly unit?: TimeIntervalUnit;
readonly step?: number;
readonly boundSeries: AgAxisBoundSeries[];

@@ -148,8 +150,20 @@ readonly domain: any[];

}
export interface FormattableLabel {
export interface AgNumericAxisFormattableLabelOptions extends AgBaseAxisLabelOptions {
/** Format string used when rendering labels. */
format?: string;
}
export interface AgBaseAxisFormattableLabelOptions extends AgBaseAxisLabelOptions, FormattableLabel {
export interface AgTimeAxisFormattableLabelUnitFormat {
millisecond?: string;
second?: string;
hour?: string;
day?: string;
month?: string;
year?: string;
}
export type AgTimeAxisFormattableLabelFormat = string | AgTimeAxisFormattableLabelUnitFormat;
export interface AgTimeAxisFormattableLabelOptions extends AgBaseAxisLabelOptions {
/** Format string used when rendering labels. */
format?: AgTimeAxisFormattableLabelFormat;
}
export type AgFormattableLabelOptions = AgNumericAxisFormattableLabelOptions & AgTimeAxisFormattableLabelOptions;
export interface AgAxisGridStyle {

@@ -161,2 +175,3 @@ /** The colour of the grid line. */

}
export type TimeIntervalUnit = 'millisecond' | 'second' | 'minute' | 'hour' | 'day' | 'month' | 'year';
export interface TimeInterval {

@@ -163,0 +178,0 @@ /**

19

dist/types/src/chart/chartOptions.d.ts

@@ -14,3 +14,3 @@ import type { AgInitialStateOptions } from '../api/initialStateOptions';

import type { AgChartTooltipOptions } from './tooltipOptions';
import type { CssColor, FontFamily, FontSize, FontStyle, FontWeight, PixelSize, TextAlign, TextWrap } from './types';
import type { CssColor, FontFamilyFull, FontSize, FontStyle, FontWeight, PixelSize, TextAlign, TextWrap } from './types';
import type { AgZoomOptions } from './zoomOptions';

@@ -79,3 +79,3 @@ export interface AgChartPaddingOptions {

/** The font family to use for the text. */
fontFamily?: FontFamily;
fontFamily?: FontFamilyFull;
/** The colour to use for the text. */

@@ -224,4 +224,19 @@ color?: CssColor;

suppressFieldDotNotation?: boolean;
/**
* A nonce to be used by any dynamically injected CSS `<style>` tags to assist with Content Security Policy.
*
*
* See [https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Global_attributes/nonce](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Global_attributes/nonce).
*
* Default: `undefined`
*/
styleNonce?: string;
/** A map of event names to event listeners. */
listeners?: AgBaseChartListeners<TDatum>;
/**
* Load fonts automatically from Google's CDN.
*
* Default: `false`
*/
loadGoogleFonts?: boolean;
/** Configuration for the Navigator. */

@@ -228,0 +243,0 @@ navigator?: AgNavigatorOptions;

98

dist/types/src/chart/contextMenuOptions.d.ts

@@ -0,15 +1,100 @@

import type { Listener } from './callbackOptions';
import type { AgChartContextMenuEvent, AgNodeContextMenuActionEvent, AgSeriesAreaContextMenuActionEvent } from './eventOptions';
import type { AgChartLegendContextMenuEvent } from './legendOptions';
export type AgContextMenuItemLiteral = 'defaults' | 'download' | 'zoom-to-cursor' | 'pan-to-cursor' | 'toggle-series-visibility' | 'toggle-other-series' | 'separator';
export type AgContextMenuItemShowOn = 'always' | 'series-area' | 'series-node' | 'legend-item';
export type AgContextMenuItemType = 'action' | 'separator';
interface ItemMixin {
/**
* The type of UI element that this item represents.
*
* Default: `'action'`
*/
type?: AgContextMenuItemType;
/**
* Which clicked element this menu item should be shown for.
*
* Default: `'always'`
*/
showOn?: AgContextMenuItemShowOn;
/** The text label of this menu item. This property is required for Accessibility compliance. */
label: string;
/**
* State of this menu-item.
*
* Default: `true` */
enabled?: boolean;
/** The submenu items. If undefined or empty, then this item will just be treat like a regular menu item. Otherwise, this menu item will have a submenu popup attached to it. */
items?: AgContextMenuItem[];
}
export interface AgContextMenuItemAlways extends ItemMixin {
/**
* Which clicked element this menu item should be shown for. `'always'` menu items are always shown.
*
* Default: `'always'`
*/
showOn?: 'always';
/** Function called when clicking on this menu item. */
action?: (event: AgChartContextMenuEvent) => void;
}
export interface AgContextMenuItemSeriesArea extends ItemMixin {
/**
* Which clicked element this menu item should be shown for. `'series-area'` menu items are shown when clicking anywhere within the series area bounds.
*/
showOn: 'series-area';
/** Function called when clicking on this menu item. */
action?: (event: AgSeriesAreaContextMenuActionEvent) => void;
}
export interface AgContextMenuItemSeriesNode extends ItemMixin {
/**
* Which clicked element this menu item should be shown for. `'series-node'` menu items are shown when clicking when clicking on a datum node.
*/
showOn: 'series-node';
/** Function called when clicking on this menu item. */
action?: (event: AgNodeContextMenuActionEvent) => void;
}
export interface AgContextMenuItemLegendItem extends ItemMixin {
/**
* Which clicked element this menu item should be shown for. `'legend-item'` menu items are shown when clicking on a legend item.
*/
showOn: 'legend-item';
/** Function called when clicking on this menu item. */
action?: (event: AgChartLegendContextMenuEvent) => void;
}
export type AgContextMenuItem = AgContextMenuItemLiteral | AgContextMenuItemAlways | AgContextMenuItemSeriesArea | AgContextMenuItemSeriesNode | AgContextMenuItemLegendItem;
export interface AgContextMenuOptions {
/** Whether to show the context menu. */
/**
* Whether to show the context menu.
*
* Default: `true`
*/
enabled?: boolean;
/** Custom actions displayed in the context menu when right-clicking anywhere on the chart. */
/**
* List of menu items (and submenus) for the context menu.
*
* Default: `['defaults']`
*/
items?: AgContextMenuItem[];
/**
* Custom actions displayed in the context menu when right-clicking anywhere on the chart.
* @deprecated v11.3.0 use `items` instead.
*/
extraActions?: AgContextMenuAction<AgChartContextMenuEvent>[];
/** Custom actions displayed in the context menu when right-clicking anywhere on the series area. */
/**
* Custom actions displayed in the context menu when right-clicking anywhere on the series area.
* @deprecated v11.3.0 use `items` instead.
*/
extraSeriesAreaActions?: AgContextMenuAction<AgSeriesAreaContextMenuActionEvent>[];
/** Custom actions displayed in the context menu when right-clicking on a series node. */
/**
* Custom actions displayed in the context menu when right-clicking on a series node.
* @deprecated v11.3.0 use `items` instead.
*/
extraNodeActions?: AgContextMenuAction<AgNodeContextMenuActionEvent>[];
/** Custom actions displayed in the context menu when right-clicking on a legend item. */
/**
* Custom actions displayed in the context menu when right-clicking on a legend item.
* @deprecated v11.3.0 use `items` instead.
*/
extraLegendItemActions?: AgContextMenuAction<AgChartLegendContextMenuEvent>[];
}
/** @deprecated v11.3.0 use `AgContextMenuItem` instead. */
export interface AgContextMenuAction<TEvent = AgNodeContextMenuActionEvent> {

@@ -19,3 +104,4 @@ /** The text to display in the context menu for the custom action. */

/** Callback function for the custom action. */
action: (event: TEvent) => void;
action: Listener<TEvent>;
}
export {};

4

dist/types/src/chart/crosshairOptions.d.ts

@@ -1,2 +0,2 @@

import type { FormattableLabel } from './axisOptions';
import type { AgFormattableLabelOptions } from './axisOptions';
import type { Renderer } from './callbackOptions';

@@ -22,3 +22,3 @@ import type { CssColor, Opacity, PixelSize } from './types';

}
export interface AgCrosshairLabel extends AgBaseCrosshairLabel, FormattableLabel {
export interface AgCrosshairLabel extends AgBaseCrosshairLabel, AgFormattableLabelOptions {
}

@@ -25,0 +25,0 @@ export interface AgBaseCrosshairLabel {

4

dist/types/src/chart/crossLineOptions.d.ts

@@ -1,2 +0,2 @@

import type { AxisValue, CssColor, FontFamily, FontSize, FontStyle, FontWeight, Opacity, PixelSize } from './types';
import type { AxisValue, CssColor, FontFamilyFull, FontSize, FontStyle, FontWeight, Opacity, PixelSize } from './types';
export interface AgCrossLineThemeOptions extends Omit<AgBaseCrossLineOptions, 'type'> {

@@ -40,3 +40,3 @@ }

/** The font family to use for the label. */
fontFamily?: FontFamily;
fontFamily?: FontFamilyFull;
/** Padding in pixels between the label and the edge of the Cross Line. */

@@ -43,0 +43,0 @@ padding?: PixelSize;

2

dist/types/src/chart/eventOptions.d.ts

@@ -91,3 +91,3 @@ import type { AgAnnotation } from './annotationsOptions';

/** The listener to call when the annotations are changed. */
annotations?: (event: AgAnnotationsEvent) => void;
annotations?: Listener<AgAnnotationsEvent>;
/** The listener to call when the zoom is changed. */

@@ -94,0 +94,0 @@ zoom?: Listener<AgZoomEvent>;

4

dist/types/src/chart/gradientLegendOptions.d.ts
import type { AgAxisContinuousIntervalOptions, AgAxisLabelFormatterParams } from './axisOptions';
import type { Formatter } from './callbackOptions';
import type { AgChartLegendPosition } from './legendOptions';
import type { CssColor, FontFamily, FontSize, FontStyle, FontWeight, PixelSize } from './types';
import type { CssColor, FontFamilyFull, FontSize, FontStyle, FontWeight, PixelSize } from './types';
export interface AgGradientLegendLabelOptions {

@@ -13,3 +13,3 @@ /** The font style to use for the labels. */

/** The font family to use for the labels. */
fontFamily?: FontFamily;
fontFamily?: FontFamilyFull;
/** The colour to use for the labels. */

@@ -16,0 +16,0 @@ color?: CssColor;

6

dist/types/src/chart/legendOptions.d.ts
import type { AgColorType } from '../series/cartesian/commonOptions';
import type { Formatter } from './callbackOptions';
import type { AgPreventableEvent } from './eventOptions';
import type { AgMarkerShape, CssColor, FontFamily, FontSize, FontStyle, FontWeight, Opacity, PixelSize } from './types';
import type { AgMarkerShape, CssColor, FontFamilyFull, FontSize, FontStyle, FontWeight, Opacity, PixelSize } from './types';
export type AgChartLegendPosition = 'top' | 'right' | 'bottom' | 'left';

@@ -41,3 +41,3 @@ export type AgChartLegendOrientation = 'horizontal' | 'vertical';

/** The font family to use for the legend. */
fontFamily?: FontFamily;
fontFamily?: FontFamilyFull;
/** Function used to render legend labels. Where `id` is a series ID, `itemId` is component ID within a series, such as a field name or an item index. */

@@ -152,3 +152,3 @@ formatter?: Formatter<AgChartLegendLabelFormatterParams>;

/** The font family to use for the pagination label. */
fontFamily?: FontFamily;
fontFamily?: FontFamilyFull;
}

@@ -155,0 +155,0 @@ export interface AgInitialStateLegendOptions {

4

dist/types/src/chart/localeOptions.d.ts
import type { Formatter } from './callbackOptions';
export interface AgLocaleThemeableOptions {
export interface AgLocaleOptions {
/** A record of locale texts keyed by id. */

@@ -16,3 +16,1 @@ localeText?: Record<string, string>;

}
export interface AgLocaleOptions extends AgLocaleThemeableOptions {
}

49

dist/types/src/chart/navigatorOptions.d.ts

@@ -1,17 +0,20 @@

import type { AgAreaSeriesOptions } from '../series/cartesian/areaOptions';
import type { AgBarSeriesOptions } from '../series/cartesian/barOptions';
import type { AgBoxPlotSeriesOptions } from '../series/cartesian/boxPlotOptions';
import type { AgBubbleSeriesOptions } from '../series/cartesian/bubbleOptions';
import type { AgCandlestickSeriesOptions } from '../series/cartesian/candlestickOptions';
import type { AgHeatmapSeriesOptions } from '../series/cartesian/heatmapOptions';
import type { AgHistogramSeriesOptions } from '../series/cartesian/histogramOptions';
import type { AgLineSeriesOptions } from '../series/cartesian/lineOptions';
import type { AgOhlcSeriesOptions } from '../series/cartesian/ohlcOptions';
import type { AgRangeAreaSeriesOptions } from '../series/cartesian/rangeAreaOptions';
import type { AgRangeBarSeriesOptions } from '../series/cartesian/rangeBarOptions';
import type { AgScatterSeriesOptions } from '../series/cartesian/scatterOptions';
import type { AgWaterfallSeriesOptions } from '../series/cartesian/waterfallOptions';
import type { AgAreaSeriesOptions, AgAreaSeriesThemeableOptions } from '../series/cartesian/areaOptions';
import type { AgBarSeriesOptions, AgBarSeriesThemeableOptions } from '../series/cartesian/barOptions';
import type { AgBoxPlotSeriesOptions, AgBoxPlotSeriesThemeableOptions } from '../series/cartesian/boxPlotOptions';
import type { AgBubbleSeriesOptions, AgBubbleSeriesThemeableOptions } from '../series/cartesian/bubbleOptions';
import type { AgCandlestickSeriesOptions, AgCandlestickSeriesThemeableOptions } from '../series/cartesian/candlestickOptions';
import type { AgHeatmapSeriesOptions, AgHeatmapSeriesThemeableOptions } from '../series/cartesian/heatmapOptions';
import type { AgHistogramSeriesOptions, AgHistogramSeriesThemeableOptions } from '../series/cartesian/histogramOptions';
import type { AgLineSeriesOptions, AgLineSeriesThemeableOptions } from '../series/cartesian/lineOptions';
import type { AgOhlcSeriesOptions, AgOhlcSeriesThemeableOptions } from '../series/cartesian/ohlcOptions';
import type { AgRangeAreaSeriesOptions, AgRangeAreaSeriesThemeableOptions } from '../series/cartesian/rangeAreaOptions';
import type { AgRangeBarSeriesOptions, AgRangeBarSeriesThemeableOptions } from '../series/cartesian/rangeBarOptions';
import type { AgScatterSeriesOptions, AgScatterSeriesThemeableOptions } from '../series/cartesian/scatterOptions';
import type { AgWaterfallSeriesOptions, AgWaterfallSeriesThemeableOptions } from '../series/cartesian/waterfallOptions';
import type { AgAxisLabelFormatterParams } from './axisOptions';
import type { Formatter } from './callbackOptions';
import type { CssColor, FontFamily, FontSize, FontStyle, FontWeight, Opacity, PixelSize } from './types';
import type { CssColor, FontFamilyFull, FontSize, FontStyle, FontWeight, Opacity, PixelSize } from './types';
type SharedProperties<A, B> = {
[K in keyof A & keyof B as A[K] extends B[K] ? (B[K] extends A[K] ? K : never) : never]: A[K];
};
export interface AgNavigatorMiniChartIntervalOptions {

@@ -39,3 +42,3 @@ /** Maximum gap in pixels between labels. */

/** The font family to use for the labels. */
fontFamily?: FontFamily;
fontFamily?: FontFamilyFull;
/** Padding in pixels between the axis labels and the Mini Chart. */

@@ -86,2 +89,3 @@ spacing?: PixelSize;

export type AgMiniChartSeriesOptions = AgLineMiniChartSeriesOptions | AgScatterMiniChartSeriesOptions | AgBubbleMiniChartSeriesOptions | AgAreaMiniChartSeriesOptions | AgBarMiniChartSeriesOptions | AgBoxPlotMiniChartSeriesOptions | AgHistogramMiniChartSeriesOptions | AgHeatmapMiniChartSeriesOptions | AgWaterfallMiniChartSeriesOptions | AgRangeBarMiniChartSeriesOptions | AgRangeAreaMiniChartSeriesOptions | AgCandlestickMiniChartSeriesOptions | AgOhlcMiniChartSeriesOptions;
export type AgMiniChartSeriesThemeableOptions = SharedProperties<AgLineMiniChartSeriesOptions, AgLineSeriesThemeableOptions> | SharedProperties<AgScatterMiniChartSeriesOptions, AgScatterSeriesThemeableOptions> | SharedProperties<AgBubbleMiniChartSeriesOptions, AgBubbleSeriesThemeableOptions> | SharedProperties<AgAreaMiniChartSeriesOptions, AgAreaSeriesThemeableOptions> | SharedProperties<AgBarMiniChartSeriesOptions, AgBarSeriesThemeableOptions> | SharedProperties<AgBoxPlotMiniChartSeriesOptions, AgBoxPlotSeriesThemeableOptions> | SharedProperties<AgHistogramMiniChartSeriesOptions, AgHistogramSeriesThemeableOptions> | SharedProperties<AgHeatmapMiniChartSeriesOptions, AgHeatmapSeriesThemeableOptions> | SharedProperties<AgWaterfallMiniChartSeriesOptions, AgWaterfallSeriesThemeableOptions> | SharedProperties<AgRangeBarMiniChartSeriesOptions, AgRangeBarSeriesThemeableOptions> | SharedProperties<AgRangeAreaMiniChartSeriesOptions, AgRangeAreaSeriesThemeableOptions> | SharedProperties<AgCandlestickMiniChartSeriesOptions, AgCandlestickSeriesThemeableOptions> | SharedProperties<AgOhlcMiniChartSeriesOptions, AgOhlcSeriesThemeableOptions>;
export interface AgNavigatorMiniChartOptions {

@@ -97,2 +101,12 @@ /** Whether to show a Mini Chart in the Navigator. */

}
export interface AgNavigatorMiniChartThemeableOptions {
/** Whether to show a Mini Chart in the Navigator. */
enabled?: boolean;
/** Override series used in Mini Chart. */
series?: AgMiniChartSeriesThemeableOptions;
/** Configuration for the Mini Chart's axis labels. */
label?: AgNavigatorMiniChartLabelOptions;
/** Configuration for the padding inside the Mini Chart. */
padding?: AgNavigatorMiniChartPadding;
}
export interface AgNavigatorMaskOptions {

@@ -142,1 +156,6 @@ /** The fill colour used by the mask. */

}
export interface AgNavigatorThemeableOptions extends Omit<AgNavigatorOptions, 'miniChart'> {
/** Mini Chart options. */
miniChart?: AgNavigatorMiniChartThemeableOptions;
}
export {};

6

dist/types/src/chart/operationOptions.d.ts

@@ -1,2 +0,2 @@

import type { AgGradientColor, AgPatternColor } from '../series/cartesian/commonOptions';
import type { AgGradientColor, AgImageFill, AgPatternColor } from '../series/cartesian/commonOptions';
import type { AgChartThemeParams } from './themeParamsOptions';

@@ -6,3 +6,3 @@ export type WithThemeParams<T> = ExtendLiteralLeaves<T, Operation, ExcludeLeaves>;

type Leaf<T = ExcludeLeaves> = Operation | T;
type ExcludeLeaves = string | symbol | number | undefined | AgGradientColor | AgPatternColor;
type ExcludeLeaves = string | symbol | number | undefined | AgGradientColor | AgPatternColor | AgImageFill;
/**

@@ -76,3 +76,5 @@ * Modify a type T by extending it's leaves with the type V, excluding any leaf that extends E.

$isPattern: [Leaf];
} | {
$isImage: [Leaf];
};
export {};

11

dist/types/src/chart/polarAxisOptions.d.ts

@@ -1,3 +0,3 @@

import type { AgBaseAxisFormattableLabelOptions, AgBaseAxisLabelOptions, AgBaseAxisOptions, AgContinuousAxisOptions } from './axisOptions';
import type { AgBaseCrossLineOptions } from './crossLineOptions';
import type { AgBaseAxisLabelOptions, AgBaseAxisOptions, AgContinuousAxisOptions, AgFormattableLabelOptions } from './axisOptions';
import type { AgBaseCrossLineOptions, AgCrossLineThemeOptions } from './crossLineOptions';
import type { Degree, Ratio } from './types';

@@ -26,2 +26,5 @@ export type AgPolarAxisShape = 'polygon' | 'circle';

}
export interface AgAngleAxesCrossLineThemeOptions {
crossLines?: AgAngleCrossLineThemeOptions;
}
export interface AgAngleNumberAxisOptions extends Omit<AgBaseAxisOptions<AgAngleAxisFormattableLabelOptions>, 'interval'>, AgContinuousAxisOptions {

@@ -48,3 +51,3 @@ type: 'angle-number';

}
export interface AgAngleAxisFormattableLabelOptions extends AgBaseAxisFormattableLabelOptions, OrientableLabel {
export interface AgAngleAxisFormattableLabelOptions extends AgFormattableLabelOptions, OrientableLabel {
}

@@ -55,2 +58,4 @@ export interface AgAngleAxisLabelOptions extends AgBaseAxisLabelOptions, OrientableLabel {

}
export interface AgAngleCrossLineThemeOptions extends AgCrossLineThemeOptions {
}
export {};

9

dist/types/src/chart/radiusAxisOptions.d.ts

@@ -1,6 +0,6 @@

import type { AgAxisCaptionOptions, AgBaseAxisFormattableLabelOptions, AgBaseAxisLabelOptions, AgBaseAxisOptions, AgContinuousAxisOptions } from './axisOptions';
import type { AgAxisCaptionOptions, AgBaseAxisLabelOptions, AgBaseAxisOptions, AgContinuousAxisOptions, AgNumericAxisFormattableLabelOptions } from './axisOptions';
import type { AgBaseCrossLineLabelOptions, AgBaseCrossLineOptions } from './crossLineOptions';
import type { AgPolarAxisShape } from './polarAxisOptions';
import type { Degree, Ratio } from './types';
interface AgRadiusAxisFormattableLabelOptions extends AgBaseAxisFormattableLabelOptions {
interface AgRadiusAxisFormattableLabelOptions extends AgNumericAxisFormattableLabelOptions {
}

@@ -56,2 +56,7 @@ interface AgRadiusAxisLabelOptions extends AgBaseAxisLabelOptions {

}
export interface AgRadiusCrossLineThemeOptions extends Omit<AgRadiusCrossLineOptions, 'type'> {
}
export interface AgRadiusAxesCrossLineThemeOptions {
crossLines?: AgRadiusCrossLineThemeOptions;
}
interface AgRadiusCrossLineLabelOptions extends AgBaseCrossLineLabelOptions {

@@ -58,0 +63,0 @@ positionAngle?: Degree;

8

dist/types/src/chart/themeOptions.d.ts

@@ -9,3 +9,3 @@ import type { AgInitialStateThemeableOptions } from '../api/initialStateOptions';

import type { AgCandlestickSeriesThemeableOptions } from '../series/cartesian/candlestickOptions';
import type { AgBaseCartesianThemeOptions, AgCartesianAxesTheme } from '../series/cartesian/cartesianOptions';
import type { AgBaseCartesianThemeOptions, AgCartesianAxesTheme, AgContinuousCartesianAxesTheme } from '../series/cartesian/cartesianOptions';
import type { AgColorType, AgColorTypeStrict } from '../series/cartesian/commonOptions';

@@ -47,3 +47,2 @@ import type { AgConeFunnelSeriesThemeableOptions } from '../series/cartesian/coneFunnelOptions';

import type { AgChartToolbarThemeableOptions } from './chartToolbarOptions';
import type { AgLocaleThemeableOptions } from './localeOptions';
import type { AgChartThemeParams } from './themeParamsOptions';

@@ -112,2 +111,3 @@ import type { CssColor } from './types';

export interface AgHistogramSeriesThemeOverrides extends AgBaseCartesianThemeOptions {
axes?: AgContinuousCartesianAxesTheme;
series?: AgHistogramSeriesThemeableOptions;

@@ -178,3 +178,3 @@ }

}
export type AgBaseGaugePresetThemeOptions = Pick<AgBaseChartOptions<any>, 'animation' | 'background' | 'container' | 'contextMenu' | 'footnote' | 'height' | 'listeners' | 'locale' | 'minHeight' | 'minWidth' | 'padding' | 'subtitle' | 'title' | 'tooltip' | 'width'>;
export type AgBaseGaugePresetThemeOptions = Pick<AgBaseChartOptions<any>, 'animation' | 'background' | 'contextMenu' | 'footnote' | 'height' | 'listeners' | 'locale' | 'minHeight' | 'minWidth' | 'padding' | 'subtitle' | 'title' | 'tooltip' | 'width'>;
type AgRadialGaugeTheme = AgBaseGaugePresetThemeOptions & AgRadialGaugeThemeableOptions;

@@ -199,5 +199,3 @@ export interface AgRadialGaugeTargetTheme extends Omit<AgRadialGaugeTarget, 'value' | 'text'> {

initialState?: AgInitialStateThemeableOptions;
locale?: AgLocaleThemeableOptions;
}
export type AgGaugeThemeOverrides = AgRadialGaugeThemeOverrides | AgLinearGaugeThemeOverrides;
export interface AgChartThemeOverrides {

@@ -204,0 +202,0 @@ /** Common theme overrides for series. */

6

dist/types/src/chart/themeParamsOptions.d.ts

@@ -1,2 +0,2 @@

import type { CssColor, FontFamily, FontSize, FontWeight, PixelSize } from './types';
import type { CssColor, FontFamilyFull, FontSize, FontWeight, PixelSize } from './types';
export interface AgBaseChartThemeParams {

@@ -61,3 +61,3 @@ /**

*/
chromeFontFamily?: FontFamily;
chromeFontFamily?: FontFamilyFull;
/**

@@ -100,3 +100,3 @@ * Font size used for text in tooltips, menus, dialogs, toolbars, buttons and text inputs.

/** Font family used for all text. */
fontFamily?: FontFamily;
fontFamily?: FontFamilyFull;
/** Default font weight used for all text. */

@@ -103,0 +103,0 @@ fontWeight?: FontWeight;

4

dist/types/src/chart/types.d.ts
export type FontStyle = 'normal' | 'italic' | 'oblique';
export type FontWeight = 'normal' | 'bold' | 'bolder' | 'lighter' | number;
export type FontFamily = string;
export type GoogleFontFamily = {
googleFont: FontFamily;
};
export type FontFamilyFull = FontFamily | GoogleFontFamily | (FontFamily | GoogleFontFamily)[];
export type FontSize = number;

@@ -5,0 +9,0 @@ export type AgMarkerShape = 'circle' | 'cross' | 'diamond' | 'heart' | 'plus' | 'pin' | 'square' | 'star' | 'triangle' | AgMarkerShapeFn;

2

dist/types/src/chartBuilderOptions.d.ts

@@ -51,2 +51,4 @@ import type { AgInitialStateOptions } from './api/initialStateOptions';

theme?: AgChartTheme | AgChartThemeName;
/** The element to place the rendered chart into. */
container?: HTMLElement | null;
}

@@ -53,0 +55,0 @@ export type AgLinearGaugeOptions = AgBaseGaugePresetOptions & AgLinearGaugePreset;

1

dist/types/src/main.d.ts

@@ -41,3 +41,2 @@ export * from './api/initialStateOptions';

export * from './presets/sparkline/sparklineOptions';
export * from './presets/presetOptions';
export * from './series/cartesian/areaOptions';

@@ -44,0 +43,0 @@ export * from './series/cartesian/barOptions';

5

dist/types/src/presets/financial/priceVolumeOptions.d.ts

@@ -70,2 +70,7 @@ export type AgPriceVolumeChartType = 'candlestick' | 'hollow-candlestick' | 'ohlc' | 'line' | 'step-line' | 'hlc' | 'high-low';

zoom?: boolean;
/** Whether to enable chart synchronization.
*
* Default: `false`
*/
sync?: boolean;
}

8

dist/types/src/presets/gauge/commonOptions.d.ts
import type { AgAxisLabelFormatterParams } from '../../chart/axisOptions';
import type { Formatter } from '../../chart/callbackOptions';
import type { AgSeriesListeners } from '../../chart/eventOptions';
import type { CssColor, Degree, FontFamily, FontSize, FontStyle, FontWeight, InteractionRange, PixelSize } from '../../chart/types';
import type { AgSeriesHighlightStyle } from '../../series/seriesOptions';
export interface GaugeDatum {
value: number;
segmentStart: number;
segmentEnd: number;
}
export interface AgBaseGaugeThemeableOptions {

@@ -18,4 +12,2 @@ /** The cursor to use for the gauge. This config is identical to the CSS `cursor` property. */

nodeClickRange?: InteractionRange;
/** A map of event names to event listeners. */
listeners?: AgSeriesListeners<GaugeDatum>;
}

@@ -22,0 +14,0 @@ export interface AgGaugeScaleLabel {

13

dist/types/src/presets/gauge/linearGaugeOptions.d.ts

@@ -1,2 +0,1 @@

import type { DatumCallbackParams } from '../../chart/callbackOptions';
import type { AgChartAutoSizedLabelOptions } from '../../chart/labelOptions';

@@ -6,8 +5,4 @@ import type { AgSeriesTooltip, AgSeriesTooltipRendererParams } from '../../chart/tooltipOptions';

import type { FillOptions, LineDashOptions, StrokeOptions } from '../../series/cartesian/commonOptions';
import type { AgBaseGaugeThemeableOptions, AgGaugeCornerMode, AgGaugeScaleLabel, AgGaugeSegmentation, FillsOptions, GaugeDatum } from './commonOptions';
import type { AgBaseGaugeThemeableOptions, AgGaugeCornerMode, AgGaugeScaleLabel, AgGaugeSegmentation, FillsOptions } from './commonOptions';
export type AgLinearGaugeTargetPlacement = 'before' | 'after' | 'middle';
export interface AgLinearGaugeLabelFormatterParams {
}
export interface AgLinearGaugeItemStylerParams extends DatumCallbackParams<GaugeDatum>, Required<AgLinearGaugeStyle> {
}
export interface AgLinearGaugeScaleInterval {

@@ -37,4 +32,2 @@ /** Array of values in scale units for specified intervals along the scale. The values in this array must be compatible with the scale type. */

}
export interface AgLinearGaugeStyle {
}
export interface AgLinearGaugeBarStyle extends FillsOptions, FillOptions, StrokeOptions, LineDashOptions {

@@ -66,3 +59,3 @@ /** Whether the bar should be shown. */

export type AgLinearGaugeLabelPlacement = 'inside-start' | 'outside-start' | 'inside-end' | 'outside-end' | 'inside-center' | 'bar-inside' | 'bar-inside-end' | 'bar-outside-end' | 'bar-end';
export interface AgLinearGaugeLabelOptions extends AgChartAutoSizedLabelOptions<never, AgLinearGaugeLabelFormatterParams> {
export interface AgLinearGaugeLabelOptions extends AgChartAutoSizedLabelOptions<never, unknown> {
/** Text to always display. */

@@ -81,3 +74,3 @@ text?: string;

}
export interface AgLinearGaugeThemeableOptions extends AgLinearGaugeStyle, AgBaseGaugeThemeableOptions {
export interface AgLinearGaugeThemeableOptions extends AgBaseGaugeThemeableOptions {
/** Direction to display the gauge in. */

@@ -84,0 +77,0 @@ direction?: Direction;

9

dist/types/src/presets/gauge/radialGaugeOptions.d.ts

@@ -1,2 +0,1 @@

import type { DatumCallbackParams } from '../../chart/callbackOptions';
import type { AgChartAutoSizedLabelOptions, AgChartAutoSizedSecondaryLabelOptions, AgChartLabelOptions } from '../../chart/labelOptions';

@@ -6,3 +5,3 @@ import type { AgSeriesTooltip, AgSeriesTooltipRendererParams } from '../../chart/tooltipOptions';

import type { FillOptions, LineDashOptions, StrokeOptions } from '../../series/cartesian/commonOptions';
import type { AgBaseGaugeThemeableOptions, AgGaugeCornerMode, AgGaugeScaleLabel, AgGaugeSegmentation, FillsOptions, GaugeDatum } from './commonOptions';
import type { AgBaseGaugeThemeableOptions, AgGaugeCornerMode, AgGaugeScaleLabel, AgGaugeSegmentation, FillsOptions } from './commonOptions';
export type AgRadialGaugeTargetPlacement = 'inside' | 'outside' | 'middle';

@@ -12,4 +11,2 @@ export interface AgRadialGaugeLabelFormatterParams {

}
export interface AgRadialGaugeItemStylerParams extends DatumCallbackParams<GaugeDatum>, Required<AgRadialGaugeStyle> {
}
export interface AgRadialGaugeScaleInterval {

@@ -37,4 +34,2 @@ /** Array of values in scale units for specified intervals along the scale. The values in this array must be compatible with the scale type. */

}
export interface AgRadialGaugeStyle {
}
export interface AgRadialGaugeBarStyle extends FillsOptions, FillOptions, StrokeOptions, LineDashOptions {

@@ -83,3 +78,3 @@ /** Whether the bar should be shown. */

}
export interface AgRadialGaugeThemeableOptions extends AgRadialGaugeStyle, AgBaseGaugeThemeableOptions {
export interface AgRadialGaugeThemeableOptions extends AgBaseGaugeThemeableOptions {
/** Outer radius of the gauge. */

@@ -86,0 +81,0 @@ outerRadius?: PixelSize;

2

dist/types/src/presets/sparkline/sparklineAxisOptions.d.ts

@@ -32,3 +32,3 @@ import type { CssColor, PixelSize, Ratio } from '../../chart/types';

}
export interface AgSparklineTimeAxisOptions extends AgSparklineBaseAxisOptions, AgSparklineContinuousAxisOptions<Date> {
export interface AgSparklineTimeAxisOptions extends AgSparklineBaseAxisOptions, AgSparklineContinuousAxisOptions<Date | number> {
type: 'time';

@@ -35,0 +35,0 @@ }

17

dist/types/src/presets/sparkline/sparklineOptions.d.ts

@@ -54,2 +54,10 @@ import type { Renderer } from '../../chart/callbackOptions';

tooltip?: AgSparklineTooltip;
/**
* A nonce to be used by any dynamically injected CSS <style> tags to assist with Content Security Policy.
*
* See: [MDN none reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Global_attributes/nonce)
*
* Default: `undefined`
*/
styleNonce?: string;
}

@@ -60,8 +68,11 @@ export interface AgSparklineDataKeysOptions {

}
export interface AgBarSparklinePreset extends AgSparklineBaseThemeableOptions, AgSparklineDataKeysOptions, Omit<AgBarSeriesOptions, 'showInLegend' | 'showInMiniChart' | 'grouped' | 'stacked' | 'stackGroup' | 'errorBar' | 'tooltip' | 'xKey' | 'yKey'> {
type AgSparklineSeriesOmit = 'showInLegend' | 'showInMiniChart' | 'grouped' | 'stacked' | 'stackGroup' | 'tooltip' | 'listeners' | 'errorBar' | 'xKey' | 'yKey';
export interface AgAreaSparklinePreset extends AgSparklineBaseThemeableOptions, AgSparklineDataKeysOptions, Omit<AgAreaSeriesOptions, AgSparklineSeriesOmit> {
}
export interface AgLineSparklinePreset extends AgSparklineBaseThemeableOptions, AgSparklineDataKeysOptions, Omit<AgLineSeriesOptions, 'showInLegend' | 'showInMiniChart' | 'stacked' | 'stackGroup' | 'errorBar' | 'tooltip' | 'xKey' | 'yKey'> {
export interface AgBarSparklinePreset extends AgSparklineBaseThemeableOptions, AgSparklineDataKeysOptions, Omit<AgBarSeriesOptions, AgSparklineSeriesOmit> {
}
export interface AgAreaSparklinePreset extends AgSparklineBaseThemeableOptions, AgSparklineDataKeysOptions, Omit<AgAreaSeriesOptions, 'showInLegend' | 'showInMiniChart' | 'stacked' | 'stackGroup' | 'tooltip' | 'xKey' | 'yKey'> {
export interface AgLineSparklinePreset extends AgSparklineBaseThemeableOptions, AgSparklineDataKeysOptions, Omit<AgLineSeriesOptions, AgSparklineSeriesOmit> {
type: 'line';
}
export type AgSparklinePresets = AgBarSparklinePreset | AgLineSparklinePreset | AgAreaSparklinePreset;
export {};

50

dist/types/src/series/cartesian/cartesianOptions.d.ts
import type { AgAnnotationsOptions } from '../../chart/annotationsOptions';
import type { AgAxisBaseTickOptions, AgAxisCaptionOptions, AgAxisContinuousIntervalOptions, AgAxisLabelStylerParams, AgBaseAxisLabelOptions, AgBaseAxisLabelStyleOptions, AgBaseAxisOptions, AgContinuousAxisOptions, FormattableLabel, TimeInterval } from '../../chart/axisOptions';
import type { AgAxisBaseTickOptions, AgAxisCaptionOptions, AgAxisContinuousIntervalOptions, AgAxisLabelStylerParams, AgBaseAxisLabelOptions, AgBaseAxisLabelStyleOptions, AgBaseAxisOptions, AgContinuousAxisOptions, AgNumericAxisFormattableLabelOptions, AgTimeAxisFormattableLabelOptions, TimeInterval, TimeIntervalUnit } from '../../chart/axisOptions';
import type { Styler } from '../../chart/callbackOptions';

@@ -24,4 +24,14 @@ import type { AgBaseThemeableChartOptions } from '../../chart/chartOptions';

}
export interface AgCartesianAxisLabelOptions extends AgBaseCartesianAxisLabelOptions, FormattableLabel {
export interface AgTimeAxisParentLevel {
/** Enables parent level labels and ticks. */
enabled?: boolean;
/** Configuration for the axis labels, shown next to the ticks. */
label?: AgCartesianTimeAxisLabelOptions;
/** Configuration for the axis ticks. */
tick?: AgAxisBaseTickOptions;
}
export interface AgCartesianAxisLabelOptions extends AgBaseCartesianAxisLabelOptions, AgNumericAxisFormattableLabelOptions {
}
export interface AgCartesianTimeAxisLabelOptions extends AgBaseCartesianAxisLabelOptions, AgTimeAxisFormattableLabelOptions {
}
export interface AgBaseCartesianAxisLabelOptions extends AgBaseAxisLabelOptions {

@@ -49,3 +59,3 @@ /** If specified and axis labels may collide, they are rotated so that they are positioned at the supplied angle. This is enabled by default for category. If the `rotation` property is specified, it takes precedence. */

}
export type AgGroupedCategoryDepthLabelOptions = Pick<AgBaseAxisLabelOptions, 'enabled' | 'avoidCollisions' | 'color' | 'fontFamily' | 'fontSize' | 'fontStyle' | 'fontWeight'>;
export type AgGroupedCategoryDepthLabelOptions = Pick<AgBaseAxisLabelOptions, 'enabled' | 'avoidCollisions' | 'rotation' | 'spacing' | 'color' | 'fontFamily' | 'fontSize' | 'fontStyle' | 'fontWeight'>;
export type AgGroupedCategoryDepthTickOptions = Pick<AgAxisBaseTickOptions, 'enabled' | 'stroke' | 'width'>;

@@ -77,6 +87,21 @@ export interface AgGroupedCategoryDepthOptions {

}
export interface AgOrdinalTimeAxisOptions extends AgBaseCartesianAxisOptions {
export interface AgUnitTimeAxisOptions extends Omit<AgBaseCartesianAxisOptions<AgCartesianTimeAxisLabelOptions>, 'interval'>, Omit<AgContinuousAxisOptions<Date | number, TimeInterval | TimeIntervalUnit | number>, 'nice'> {
type: 'time';
/** Options for labels and ticks for the parent level intervals. */
parentLevel?: AgTimeAxisParentLevel;
/** The size of each band. */
unit?: TimeInterval | TimeIntervalUnit;
/** The size of the gap between the categories as a proportion, between 0 and 1. This value is a fraction of the “step”, which is the interval between the start of a band and the start of the next band. */
paddingInner?: Ratio;
/** The padding on the outside i.e. left and right of the first and last category. In association with `paddingInner`, this value can be between 0 and 1. */
paddingOuter?: Ratio;
/** This property is for grouped column/bar series plotted on a category axis. It is a proportion between 0 and 1 which determines the size of the gap between the bars or columns within a single group along the axis. */
groupPaddingInner?: Ratio;
}
export interface AgOrdinalTimeAxisOptions extends AgBaseCartesianAxisOptions<AgCartesianTimeAxisLabelOptions> {
type: 'ordinal-time';
/** Options for labels and ticks for the parent level intervals. */
parentLevel?: AgTimeAxisParentLevel;
/** Configuration for the axis ticks interval. */
interval?: AgAxisContinuousIntervalOptions<TimeInterval | number>;
interval?: AgAxisContinuousIntervalOptions<TimeInterval | TimeIntervalUnit | number>;
/** The size of the gap between the categories as a proportion, between 0 and 1. This value is a fraction of the “step”, which is the interval between the start of a band and the start of the next band. */

@@ -97,8 +122,12 @@ paddingInner?: Ratio;

}
export interface AgTimeAxisOptions extends Omit<AgBaseCartesianAxisOptions, 'interval'>, AgContinuousAxisOptions<Date | number, TimeInterval | number> {
export interface AgContinuousTimeAxisOptions extends Omit<AgBaseCartesianAxisOptions<AgCartesianTimeAxisLabelOptions>, 'interval'>, AgContinuousAxisOptions<Date | number, TimeInterval | TimeIntervalUnit | number> {
type: 'time';
/** Options for labels and ticks for the parent level intervals. */
parentLevel?: AgTimeAxisParentLevel;
}
export interface AgTimeAxisOptions extends AgContinuousTimeAxisOptions, AgUnitTimeAxisOptions {
}
export type AgCartesianAxisPosition = 'top' | 'right' | 'bottom' | 'left';
export type AgCartesianAxisType = 'category' | 'grouped-category' | 'ordinal-time' | 'number' | 'log' | 'time';
export type AgCartesianAxisOptions = AgNumberAxisOptions | AgLogAxisOptions | AgCategoryAxisOptions | AgOrdinalTimeAxisOptions | AgGroupedCategoryAxisOptions | AgTimeAxisOptions;
export type AgCartesianAxisType = AgCartesianAxisOptions['type'];
type AgCartesianAxisThemeSpecialOptions = 'position' | 'type' | 'crossLines';

@@ -136,3 +165,6 @@ /** This is the configuration shared by all types of axis. */

'grouped-category'?: AgGroupedCategoryAxisThemeOptions;
/** This extends the common axis configuration with options specific to unit-time axes. */
'unit-time'?: AgUnitTimeAxisThemeOptions;
}
export type AgContinuousCartesianAxesTheme = Pick<AgCartesianAxesTheme, 'number' | 'log' | 'time'>;
export interface AgNumberAxisThemeOptions extends Omit<AgNumberAxisOptions, 'type' | 'crossLines'>, AgCartesianAxisThemeOptions<AgNumberAxisOptions>, AgCartesianAxesCrossLineThemeOptions {

@@ -148,4 +180,6 @@ }

}
export interface AgTimeAxisThemeOptions extends Omit<AgTimeAxisOptions, 'type' | 'crossLines'>, AgCartesianAxisThemeOptions<AgTimeAxisOptions>, AgCartesianAxesCrossLineThemeOptions {
export interface AgTimeAxisThemeOptions extends Omit<AgContinuousTimeAxisOptions, 'type' | 'crossLines'>, AgCartesianAxisThemeOptions<AgContinuousTimeAxisOptions>, AgCartesianAxesCrossLineThemeOptions {
}
export interface AgUnitTimeAxisThemeOptions extends Omit<AgUnitTimeAxisOptions, 'type' | 'crossLines'>, AgCartesianAxisThemeOptions<AgUnitTimeAxisOptions>, AgCartesianAxesCrossLineThemeOptions {
}
export interface AgCartesianCrossLineOptions extends AgBaseCrossLineOptions<AgCartesianCrossLineLabelOptions> {

@@ -152,0 +186,0 @@ }

29

dist/types/src/series/cartesian/commonOptions.d.ts

@@ -24,3 +24,3 @@ import type { CssColor, FontFamily, FontSize, FontStyle, FontWeight, Opacity, PixelSize, Ratio } from '../../chart/types';

}
export type AgColorType = CssColor | AgGradientColor | AgPatternColor;
export type AgColorType = CssColor | AgGradientColor | AgPatternColor | AgImageFill;
export type AgColorTypeStrict = CssColor | AgGradientColorStrict;

@@ -50,2 +50,4 @@ export type AgGradientColorMode = 'continuous' | 'discrete';

pattern?: AgPatternName;
/** The svg path for a custom pattern */
path?: string;
/** Width of the pattern unit. */

@@ -55,2 +57,6 @@ width?: number;

height?: number;
/** The rotation angle of the pattern. */
rotation?: number;
/** The scaling of the pattern. */
scale?: number;
/** The colour for filling closed shapes in the pattern. */

@@ -71,2 +77,23 @@ fill?: CssColor;

}
export interface AgImageFill {
type: 'image';
/** URL of the image. */
url: string;
/** The colour for filling the background in the pattern. */
backgroundFill?: CssColor;
/** The colour for filling the background in the pattern. */
backgroundFillOpacity?: Opacity;
/** Height of the image. */
width?: number;
/** Width of the image. */
height?: number;
/** A string indicating how to repeat the pattern's unit.*/
repeat?: AgColorRepeat;
/** The fit mode of the image. */
fit?: AgImageFillFit;
/** The rotation angle of the image. */
rotation?: number;
}
export type AgColorRepeat = 'repeat' | 'repeat-x' | 'repeat-y' | 'no-repeat';
export type AgImageFillFit = 'stretch' | 'cover' | 'contain' | 'none';
export type AgPatternName = 'vertical-lines' | 'horizontal-lines' | 'forward-slanted-lines' | 'backward-slanted-lines' | 'squares' | 'circles' | 'triangles' | 'diamonds' | 'stars' | 'hearts' | 'crosses';

@@ -73,0 +100,0 @@ /**

4

dist/types/src/series/cartesian/coneFunnelOptions.d.ts

@@ -1,2 +0,2 @@

import type { AgBaseAxisFormattableLabelOptions } from '../../chart/axisOptions';
import type { AgFormattableLabelOptions } from '../../chart/axisOptions';
import type { DatumCallbackParams } from '../../chart/callbackOptions';

@@ -14,3 +14,3 @@ import type { AgChartLabelOptions } from '../../chart/labelOptions';

}
export interface AgConeFunnelSeriesStageLabelOptions extends AgBaseAxisFormattableLabelOptions {
export interface AgConeFunnelSeriesStageLabelOptions extends AgFormattableLabelOptions {
/** Placement of the label in relation to the chart. */

@@ -17,0 +17,0 @@ placement?: 'before' | 'after';

4

dist/types/src/series/cartesian/funnelOptions.d.ts

@@ -1,2 +0,2 @@

import type { AgBaseAxisFormattableLabelOptions } from '../../chart/axisOptions';
import type { AgFormattableLabelOptions } from '../../chart/axisOptions';
import type { DatumCallbackParams, Styler } from '../../chart/callbackOptions';

@@ -11,3 +11,3 @@ import type { AgDropShadowOptions } from '../../chart/dropShadowOptions';

}
export interface AgFunnelSeriesStageLabelOptions extends AgBaseAxisFormattableLabelOptions {
export interface AgFunnelSeriesStageLabelOptions extends AgFormattableLabelOptions {
/** Placement of the label in relation to the chart. */

@@ -14,0 +14,0 @@ placement?: 'before' | 'after';

4

dist/types/src/series/cartesian/rangeAreaOptions.d.ts

@@ -35,2 +35,4 @@ import type { AgDropShadowOptions } from '../../chart/dropShadowOptions';

tooltip?: AgSeriesTooltip<AgRangeAreaSeriesTooltipRendererParams>;
/** Set to `true` to connect across missing data points. */
connectMissingData?: boolean;
}

@@ -58,4 +60,2 @@ export interface AgRangeAreaSeriesOptionsKeys {

type: 'range-area';
/** Set to `true` to connect across missing data points. */
connectMissingData?: boolean;
}

12

dist/types/src/series/polar/polarOptions.d.ts
import type { AgBaseThemeableChartOptions } from '../../chart/chartOptions';
import type { AgAngleCategoryAxisOptions, AgAngleNumberAxisOptions } from '../../chart/polarAxisOptions';
import type { AgRadiusCategoryAxisOptions, AgRadiusNumberAxisOptions } from '../../chart/radiusAxisOptions';
import type { AgAngleAxesCrossLineThemeOptions, AgAngleCategoryAxisOptions, AgAngleNumberAxisOptions } from '../../chart/polarAxisOptions';
import type { AgRadiusAxesCrossLineThemeOptions, AgRadiusCategoryAxisOptions, AgRadiusNumberAxisOptions } from '../../chart/radiusAxisOptions';
import type { AgDonutSeriesOptions } from './donutOptions';

@@ -20,9 +20,9 @@ import type { AgNightingaleSeriesOptions } from './nightingaleOptions';

}
export interface AgAngleCategoryAxisThemeOptions extends Omit<AgAngleCategoryAxisOptions, 'type'> {
export interface AgAngleCategoryAxisThemeOptions extends Omit<AgAngleCategoryAxisOptions, 'type' | 'crossLines'>, AgAngleAxesCrossLineThemeOptions {
}
export interface AgAngleNumberAxisThemeOptions extends Omit<AgAngleNumberAxisOptions, 'type'> {
export interface AgAngleNumberAxisThemeOptions extends Omit<AgAngleNumberAxisOptions, 'type' | 'crossLines'>, AgAngleAxesCrossLineThemeOptions {
}
export interface AgRadiusCategoryAxisThemeOptions extends Omit<AgRadiusCategoryAxisOptions, 'type'> {
export interface AgRadiusCategoryAxisThemeOptions extends Omit<AgRadiusCategoryAxisOptions, 'type' | 'crossLines'>, AgRadiusAxesCrossLineThemeOptions {
}
export interface AgRadiusNumberAxisThemeOptions extends Omit<AgRadiusNumberAxisOptions, 'type'> {
export interface AgRadiusNumberAxisThemeOptions extends Omit<AgRadiusNumberAxisOptions, 'type' | 'crossLines'>, AgRadiusAxesCrossLineThemeOptions {
}

@@ -29,0 +29,0 @@ export interface AgPolarAxesTheme {

2

dist/types/src/series/seriesOptions.d.ts

@@ -30,3 +30,3 @@ import type { AgSeriesListeners } from '../chart/eventOptions';

}
export interface AgBaseCartesianThemeableOptions<TDatum> extends AgBaseSeriesOptions<TDatum> {
export interface AgBaseCartesianThemeableOptions<TDatum> extends AgBaseSeriesThemeableOptions<TDatum> {
/** Whether to include the series in the Mini Chart. */

@@ -33,0 +33,0 @@ showInMiniChart?: boolean;

2

LICENSE.txt
The MIT License
Copyright (c) 2015-2024 AG GRID LTD
Copyright (c) 2015-2025 AG GRID LTD

@@ -5,0 +5,0 @@ Permission is hereby granted, free of charge, to any person obtaining a copy

2

package.json
{
"name": "ag-charts-types",
"version": "11.2.4",
"version": "11.3.0",
"description": "Advanced Charting / Charts supporting Javascript / Typescript / React / Angular / Vue",

@@ -5,0 +5,0 @@ "main": "./dist/package/main.cjs.js",

dist/types/src/presets/presetOptions.d.ts