@blukavantui/charts-community 0.0.0-stage → 1.2.0

package/dist/types.d.ts

@@ -0,0 +1,137 @@
+/** Shared Web chart contracts; native inputs are normalized by the private adapter. */
+export type ComponentColor = 'Default' | 'Primary' | 'Secondary' | 'Success' | 'Processing' | 'Warning' | 'Error' | 'Danger' | 'Magenta' | 'Red' | 'Volcano' | 'Orange' | 'Gold' | 'Lime' | 'Green' | 'Cyan' | 'Blue' | 'GeekBlue' | 'Purple';
+export type ChartColor = ComponentColor | `#${string}`;
+export type ChartFormat = 'png' | 'svg';
+export type ValueFormat = 'Currency' | 'Number' | 'Percent';
+export type LegendStyle = 'Standard' | 'ValueList' | 'Compact' | 'SummaryCards';
+export type LegendPosition = 'Top' | 'Left' | 'Right' | 'Bottom';
+export interface ChartIdentity {
+    Key: string;
+    Label: string;
+    Color?: ChartColor;
+}
+export interface ChartDatum extends ChartIdentity {
+    Value: number | null;
+}
+export interface ChartCategory extends ChartIdentity {
+}
+export interface ChartOptions {
+    Title?: string;
+    Description?: string;
+    /** Plot height in pixels, excluding title, toolbar and data table. */
+    Height?: number;
+    ValueFormat?: ValueFormat;
+    CurrencyCode?: string;
+    Locale?: string;
+    UseCustomPrecision?: boolean;
+    /** Display precision only; the data alternative retains the original values. */
+    DecimalPlaces?: number;
+    AccessibleLabel?: string;
+    ExtendedClass?: string;
+    /** Change to reset map/treemap view state. */
+    ResetKey?: string;
+    /** Plain-text replacements for shared controls and announcements. */
+    Messages?: Record<string, string>;
+    ShowHeader?: boolean;
+    ShowToolbar?: boolean;
+    ShowLegend?: boolean;
+    LegendStyle?: LegendStyle;
+    LegendPosition?: LegendPosition;
+    LegendShowValues?: boolean;
+    /** Percentages only appear for meaningful partitions, separately for each nested ring. */
+    LegendShowPercentages?: boolean;
+    ShowTooltip?: boolean;
+    ShowLabels?: boolean;
+    ShowDataTable?: boolean;
+    /** Optional fill textures. Off by default; exact-value data remains available. */
+    ShowPatterns?: boolean;
+    EnableSelection?: boolean;
+    EnableAnimation?: boolean;
+    IsLoading?: boolean;
+    EmptyMessage?: string;
+    SelectedKey?: string | null;
+    ExportFootnote?: string;
+}
+export interface MixedSeries {
+    Key: string;
+    Name: string;
+    Type: 'Bar' | 'Line';
+    /** One value per category. null means missing; zero is a real value. */
+    Values: (number | null)[];
+    /** Shared BluKavant ComponentColor or a custom hex color. */
+    Color?: ChartColor;
+    IsDashed?: boolean;
+}
+export interface MixedChartOptions extends ChartOptions {
+    Categories: ChartCategory[];
+    Series: MixedSeries[];
+    BarLayout?: 'Stacked' | 'Grouped';
+    SmoothLines?: boolean;
+}
+export interface HeatmapCell {
+    Key: string;
+    XKey: string;
+    YKey: string;
+    Value: number | null;
+}
+export interface HeatmapOptions extends ChartOptions {
+    XCategories: ChartCategory[];
+    YCategories: ChartCategory[];
+    Cells: HeatmapCell[];
+    ColorScale?: ComponentColor | 'Automatic' | 'Teal' | 'Diverging';
+    MinValue?: number;
+    MaxValue?: number;
+}
+export interface MixedPoint {
+    Key: string;
+    CategoryLabel: string;
+    SeriesKey: string;
+    SeriesName: string;
+    Value: number | null;
+}
+export interface HeatmapPoint extends HeatmapCell {
+    XLabel: string;
+    YLabel: string;
+}
+export interface ChartEvents<Point> {
+    PointClick?: (point: Point, origin?: 'Chart' | 'Table') => void;
+    SelectionChange?: (selection: {
+        Key: string | null;
+        Reason?: 'User' | 'DataChanged';
+    }) => void;
+    Ready?: () => void;
+    StateChange?: (state: {
+        State: 'Loading' | 'Ready' | 'Empty' | 'Error';
+        Revision: number;
+    }) => void;
+    PatternsChange?: (state: {
+        ShowPatterns: boolean;
+    }) => void;
+    ExportStarted?: (result: {
+        Format: ChartFormat;
+        FileName: string;
+        RequestId: string;
+    }) => void;
+    /** @deprecated Use ExportStarted. Completion means download initiated, not file saved. */
+    ExportComplete?: (result: {
+        Format: ChartFormat;
+        FileName: string;
+    }) => void;
+    Error?: (error: {
+        Message: string;
+        Code?: string;
+        RequestId?: string;
+    }) => void;
+}
+export interface ChartInstance<Options> {
+    update(options: Partial<Options>): void;
+    resize(): void;
+    /** Silent application-controlled selection. Does not emit SelectionChange. */
+    setSelection(key: string | null): void;
+    /** Transient emphasis, useful for Grid row hover/click. */
+    highlight(key: string | null): void;
+    /** PNG defaults to 2× the plot resolution. Initiates a browser download. */
+    download(format?: ChartFormat, filename?: string, requestId?: string): Promise<void>;
+    /** Idempotent. Releases observers, events and the ECharts instance. */
+    destroy(): void;
+}

package/dist/validation.d.ts

@@ -0,0 +1,8 @@
+import type { ChartCategory, ChartOptions, MixedChartOptions, HeatmapOptions } from './types.ts';
+export declare function assert(condition: unknown, message: string): asserts condition;
+export declare function categories(items: ChartCategory[], name: string): Set<string>;
+export declare function value(value: unknown): value is number | null;
+export declare function base(options: ChartOptions): void;
+export declare function validateMixed(options: MixedChartOptions): void;
+export declare function validateHeatmap(options: HeatmapOptions): void;
+export declare function escapeText(text: string): string;