tsichart-core 2.0.0-beta.6 → 2.0.0

package/dist/index.d.ts

@@ -409,6 +409,40 @@ declare class LineChartData extends ChartComponentData {
     mergeDataToDisplayStateAndTimeArrays(data: any, aggregateExpressionOptions?: any): void;
 }
 
+/**
+ * Configuration options for the LineChart component.
+ *
+ * Provides type safety for LineChart-specific configuration with all properties being optional.
+ * Based on ChartOptions class, allowing partial configuration where defaults are applied internally.
+ *
+ * @remarks
+ * This type includes all properties from ChartOptions as optional fields:
+ * - **Appearance**: theme, color, legend, tooltip, grid, isArea, interpolationFunction
+ * - **Axis Configuration**: xAxisHidden, yAxisHidden, yAxisState, yExtent, aggTopMargin
+ * - **Brush Settings**: brushMoveAction, brushMoveEndAction, brushContextMenuActions, brushHandlesVisible,
+ *   brushRangeVisible, snapBrush, minBrushWidth, keepBrush, brushClearable, autoTriggerBrushContextMenu
+ * - **Interaction**: focusHidden, onMouseover, onMouseout, onSticky, onUnsticky, shouldSticky
+ * - **Markers**: markers, onMarkersChange, labelSeriesWithMarker
+ * - **Swim Lanes**: swimLaneOptions (for stacked charts with multiple y-axes)
+ * - **Time Configuration**: timeFrame, offset, is24HourTime, dateLocale, xAxisTimeFormat
+ * - **UI Controls**: hideChartControlPanel, suppressResizeListener
+ * - **Data Display**: includeEnvelope, includeDots
+ * - **Styling**: strings (for i18n), noAnimate
+ *
+ * @example
+ * ```typescript
+ * const lineChartOptions: ILineChartOptions = {
+ *   theme: 'dark',
+ *   legend: 'shown',
+ *   yAxisState: 'stacked',
+ *   brushHandlesVisible: true,
+ *   interpolationFunction: 'curveMonotoneX',
+ *   labelSeriesWithMarker: true
+ * };
+ * ```
+ */
+type ILineChartOptions = Partial<Omit<ChartOptions, 'onSelect' | 'onInput' | 'onKeydown' | 'onInstanceClick' | 'hierarchyOptions' | 'withContextMenu' | 'timeSeriesIdProperties' | 'isTemporal' | 'spMeasures' | 'scatterPlotRadius' | 'spAxisLabels'>>;
+
 declare class LineChart extends TemporalXAxisComponent {
     private targetElement;
     private focus;
@@ -547,7 +581,7 @@ declare class LineChart extends TemporalXAxisComponent {
     private getAdditionalOffsetFromHorizontalMargin;
     private drawHorizontalMarkers;
     private createSwimlaneLabels;
-    render(data: any, options: any, aggregateExpressionOptions: any): void;
+    render(data: any, options: ILineChartOptions, aggregateExpressionOptions: any): void;
     private createPlot;
 }
 
@@ -1684,8 +1718,28 @@ declare class Utils {
     static offsetToUTC(date: Date, offset?: number): Date;
     static parseUserInputDateTime(timeText: any, offset: any): number;
     static getBrighterColor(color: string): any;
-    static createSplitByColors(displayState: any, aggKey: string, ignoreIsOnlyAgg?: boolean): any[];
-    static colorSplitBy(displayState: any, splitByIndex: number, aggKey: string, ignoreIsOnlyAgg?: boolean): any;
+    private static splitByColorCache;
+    /**
+     * Creates an array of colors for split-by series
+     * @param displayState - The current display state
+     * @param aggKey - The aggregate key
+     * @param ignoreIsOnlyAgg - Whether to ignore the "only aggregate" optimization
+     * @returns Array of color strings for each split-by
+     */
+    static createSplitByColors(displayState: any, aggKey: string, ignoreIsOnlyAgg?: boolean): string[];
+    /**
+     * Helper method to check if an aggregate is the only visible one
+     */
+    private static isOnlyVisibleAggregate;
+    /**
+     * Helper method to generate color variations for split-bys
+     */
+    private static generateSplitByColorVariations;
+    /**
+     * Clears the split-by color cache (useful when display state changes significantly)
+     */
+    static clearSplitByColorCache(): void;
+    static colorSplitBy(displayState: any, splitByIndex: number, aggKey: string, ignoreIsOnlyAgg?: boolean): string;
     static getTheme(theme: any): string;
     static clearSelection(): void;
     static mark(filter: any, text: any): any;
@@ -1742,3 +1796,4 @@ declare class Utils {
 }
 
 export { AggregateExpression, AvailabilityChart, AxisState, CategoricalPlot, ChartComponentData, ChartDataOptions, ChartOptions, ColorPicker, ContextMenu, DateTimeButtonRange, DateTimeButtonSingle, DateTimePicker, EllipsisMenu, EventsPlot, EventsTable, EventsTableData, GeoProcessGraphic, Grid, GroupedBarChart, GroupedBarChartData, Heatmap, HeatmapCanvas, HeatmapData, Hierarchy, HierarchyNavigation, HierarchyNode, HistoryPlayback, Legend, LineChart, LineChartData, LinePlot, Marker, ModelAutocomplete, ModelSearch, PieChart, PieChartData, PlaybackControls, ProcessGraphic, ScatterPlot, ScatterPlotData, SingleDateTimePicker, Slider, Strings, TimeSeriesEvent, TimeSeriesEventCell, TimezonePicker, Tooltip, TsqExpression, TsqRange, UXClient, Utils, UXClient as default };
+export type { ILineChartOptions };