@rokkit/chart 1.0.0-next.12 → 1.0.0-next.122

package/dist/lib/brewing/types.d.ts

@@ -0,0 +1,162 @@
+export type ChartMargin = {
+    /**
+     * - Top margin
+     */
+    top: number;
+    /**
+     * - Right margin
+     */
+    right: number;
+    /**
+     * - Bottom margin
+     */
+    bottom: number;
+    /**
+     * - Left margin
+     */
+    left: number;
+};
+export type ChartDimensions = {
+    /**
+     * - Total chart width
+     */
+    width: number;
+    /**
+     * - Total chart height
+     */
+    height: number;
+    /**
+     * - Chart margins
+     */
+    margin: ChartMargin;
+    /**
+     * - Chart width without margins
+     */
+    innerWidth: number;
+    /**
+     * - Chart height without margins
+     */
+    innerHeight: number;
+};
+export type ChartScales = {
+    /**
+     * - X-axis scale function
+     */
+    x: Function;
+    /**
+     * - Y-axis scale function
+     */
+    y: Function;
+    /**
+     * - Color scale function
+     */
+    color: Function;
+};
+export type ScaleFields = {
+    /**
+     * - X-axis field
+     */
+    x: string;
+    /**
+     * - Y-axis field
+     */
+    y: string;
+    /**
+     * - Color field
+     */
+    color: string;
+};
+export type TickData = {
+    /**
+     * - Tick value
+     */
+    value: any;
+    /**
+     * - Tick position in pixels
+     */
+    position: number;
+    /**
+     * - Formatted tick label
+     */
+    formattedValue: string;
+};
+export type AxisData = {
+    /**
+     * - Tick data
+     */
+    ticks: TickData[];
+    /**
+     * - Axis label
+     */
+    label: string;
+    /**
+     * - SVG transform attribute value
+     */
+    transform: string;
+    /**
+     * - SVG transform for the label
+     */
+    labelTransform: string;
+};
+export type BarData = {
+    /**
+     * - Original data point
+     */
+    data: Object;
+    /**
+     * - X position
+     */
+    x: number;
+    /**
+     * - Y position
+     */
+    y: number;
+    /**
+     * - Width of the bar
+     */
+    width: number;
+    /**
+     * - Height of the bar
+     */
+    height: number;
+    /**
+     * - Color of the bar
+     */
+    color: string;
+};
+export type LegendItem = {
+    /**
+     * - Legend item value
+     */
+    value: any;
+    /**
+     * - Item color
+     */
+    color: string;
+    /**
+     * - Y position
+     */
+    y: number;
+    /**
+     * - Shape type ('rect' or 'circle')
+     */
+    shape: string;
+    /**
+     * - Size of the marker
+     */
+    markerSize: number;
+};
+export type LegendData = {
+    /**
+     * - Legend items
+     */
+    items: LegendItem[];
+    /**
+     * - Legend title
+     */
+    title: string;
+    /**
+     * - SVG transform attribute value
+     */
+    transform: string;
+};

package/dist/lib/context.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Creates chart context and provides it to child components
+ *
+ * @param {Object} options Initial chart options
+ * @returns {Object} Chart context with all stores and methods
+ */
+export function createChartContext(options?: Object): Object;
+/**
+ * Gets chart context provided by parent component
+ *
+ * @returns {Object} Chart context
+ */
+export function getChartContext(): Object;

package/dist/lib/scales.svelte.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Creates appropriate scales based on data and dimensions
+ *
+ * @param {Array} data The dataset
+ * @param {string} xKey Field to use for x-axis
+ * @param {string} yKey Field to use for y-axis
+ * @param {Object} dimensions Chart dimensions
+ * @param {Object} options Additional options
+ * @returns {Object} Object containing xScale, yScale, and colorScale
+ */
+export function createScales(data: any[], xKey: string, yKey: string, dimensions: Object, options?: Object): Object;
+/**
+ * Calculates the actual chart dimensions after applying margins
+ *
+ * @param {Object} dimensions Original dimensions
+ * @returns {Object} Dimensions with calculated inner width and height
+ */
+export function calculateChartDimensions(width: any, height: any, margin: any): Object;
+/**
+ * Gets the axis origin value
+ *
+ * @param {Object} scale D3 scale
+ * @returns {number} Origin value
+ */
+export function getOriginValue(scale: Object): number;
+/**
+ * Creates axis ticks
+ *
+ * @param {Object} scale D3 scale
+ * @param {string} axis Axis type ('x' or 'y')
+ * @param {number} count Number of ticks
+ * @param {number} fontSize Font size for determining tick density
+ * @returns {Array} Array of tick objects
+ */
+export function createTicks(scale: Object, axis: string, count?: number, fontSize?: number): any[];

package/dist/lib/utils.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Creates appropriate scales based on data and dimensions
+ *
+ * @param {Array} data The dataset
+ * @param {string} xKey Field to use for x-axis
+ * @param {string} yKey Field to use for y-axis
+ * @param {Object} dimensions Chart dimensions
+ * @param {Object} [options] Additional options
+ * @param {string} [options.colorKey] Field to use for color mapping
+ * @returns {Object} Object containing xScale, yScale, and colorScale
+ */
+export function createScales(data: any[], xKey: string, yKey: string, dimensions: Object, options?: {
+    colorKey?: string | undefined;
+}): Object;
+/**
+ * Calculates the actual chart dimensions after applying margins
+ *
+ * @param {Object} dimensions Original dimensions
+ * @returns {Object} Dimensions with calculated inner width and height
+ */
+export function calculateChartDimensions(dimensions: Object): Object;
+/**
+ * Normalizes data for use with D3 charts
+ *
+ * @param {Array|Object} inputData Raw data or dataset object
+ * @returns {Array} Normalized data array
+ */
+export function normalizeData(inputData: any[] | Object): any[];
+/**
+ * Generates a unique ID for SVG elements
+ *
+ * @param {string} prefix Prefix for the ID
+ * @returns {string} A unique ID
+ */
+export function uniqueId(prefix?: string): string;
+/**
+ * Formats tooltip content for a data point
+ *
+ * @param {Object} d Data point
+ * @param {Object} options Tooltip format options
+ * @returns {string} Formatted tooltip HTML content
+ */
+export function formatTooltipContent(d: Object, options?: Object): string;
+/**
+ * Generates a tooltip formatter function
+ *
+ * @param {Object} options Tooltip format options
+ * @returns {Function} A function that formats tooltip content
+ */
+export function createTooltipFormatter(options?: Object): Function;
+/**
+ * Calculates the transform attribute for SVG elements
+ *
+ * @param {number} x X position
+ * @param {number} y Y position
+ * @returns {string} Transform attribute value
+ */
+export function transform(x: number, y: number): string;

package/dist/old_lib/brewer.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Get fill patterns for a set of values
+ *
+ * @param {Array} values - Array of values
+ * @param {Object} swatch - Object with keys for color, gray, and pattern
+ * @param {Boolean} gray - Boolean to determine if gray or color
+ * @returns {Object} - Object with keys for pattern and color
+ */
+export function getFillPatterns(values: any[], swatch: Object, gray?: boolean): Object;

package/dist/old_lib/chart.d.ts

@@ -0,0 +1,40 @@
+export function chart(data: any, aes: any): Chart;
+declare class Chart {
+    constructor(data: any, opts: any);
+    width: number;
+    height: number;
+    flipCoords: any;
+    x: any;
+    y: any;
+    value: any;
+    valueLabel: any;
+    valueFormat: any;
+    fill: any;
+    color: any;
+    shape: any;
+    padding(value: any): this;
+    spacing: number;
+    margin(value: any): this;
+    domain: {
+        x: any[];
+        y: any[];
+    };
+    stat: any;
+    data: any;
+    refresh(): this;
+    range: {
+        x: any[];
+        y: any[];
+    } | undefined;
+    origin: {
+        x: any;
+        y: any;
+    } | undefined;
+    scale: {
+        x: any;
+        y: any;
+    } | undefined;
+    aggregate(value: any, stat: any): void;
+    ticks(axis: any, count: any, fontSize?: number): any;
+}
+export {};

package/dist/old_lib/grid.d.ts

@@ -0,0 +1,72 @@
+/**
+ * @typedef GridPoint
+ * @property {number} x - x-coordinate of the point
+ * @property {number} y - y-coordinate of the point
+ * @property {number} r - radius of the point
+ */
+/**
+ * @typedef SwatchGrid
+ * @property {number}      width  - width of the grid
+ * @property {number}      height - height of the grid
+ * @property {GridPoint[]} data   - data points of the grid
+ */
+/**
+ * @tyoedef {Object} GridOptions
+ * @property {number} [pad=0]     - The padding between the items
+ * @property {number} [columns=0] - The number of columns
+ * @property {number} [rows=0]    - The number of rows
+ */
+/**
+ * Calculates a grid of centres to fit a list of items of `size` within the number of `columns` and `rows`.
+ *
+ * - Attempts to find a best fit square if both columns and rows are not specified
+ * - Value in columns is prioritized over rows for recalculating the grid
+ * - Supports padding between the items
+ *
+ * @param {number}      count   - number of items
+ * @param {number}      size    - size of the items
+ * @param {GridOptions} options - options for the grid
+ * @returns {SwatchGrid}
+ */
+export function swatchGrid(count: number, size: number, options: GridOptions): SwatchGrid;
+/**
+ * Spreads values as patterns with colors from a palette
+ *
+ * @param {number[]} values   - values to spread
+ * @param {string[]} patterns - patterns to spread
+ * @param {string[]} palette  - colors to spread
+ * @returns {Record<number, { id: string, pattern: string, color: string }>}
+ */
+export function spreadValuesAsPatterns(values: number[], patterns: string[], palette: string[]): Record<number, {
+    id: string;
+    pattern: string;
+    color: string;
+}>;
+export type GridPoint = {
+    /**
+     * - x-coordinate of the point
+     */
+    x: number;
+    /**
+     * - y-coordinate of the point
+     */
+    y: number;
+    /**
+     * - radius of the point
+     */
+    r: number;
+};
+export type SwatchGrid = {
+    /**
+     * - width of the grid
+     */
+    width: number;
+    /**
+     * - height of the grid
+     */
+    height: number;
+    /**
+     * - data points of the grid
+     */
+    data: GridPoint[];
+};

package/dist/old_lib/index.d.ts

@@ -0,0 +1,4 @@
+export { swatch } from "./swatch";
+export { swatchGrid } from "./grid";
+export * from "./chart";
+export * from "./brewer";

package/dist/old_lib/plots.d.ts

@@ -0,0 +1,3 @@
+export function plotter(node: any, options: any): {
+    update: (input: any) => void;
+};

package/dist/old_lib/swatch.d.ts

@@ -0,0 +1,285 @@
+export const swatch: import("svelte/store").Writable<{
+    palette: {
+        gold: {
+            "50": string;
+            "100": string;
+            "200": string;
+            "300": string;
+            "400": string;
+            "500": string;
+            "600": string;
+            "700": string;
+            "800": string;
+            "900": string;
+            "950": string;
+        };
+        lavender: {
+            "50": string;
+            "100": string;
+            "200": string;
+            "300": string;
+            "400": string;
+            "500": string;
+            "600": string;
+            "700": string;
+            "800": string;
+            "900": string;
+            "950": string;
+        };
+        teal: {
+            "50": string;
+            "100": string;
+            "200": string;
+            "300": string;
+            "400": string;
+            "500": string;
+            "600": string;
+            "700": string;
+            "800": string;
+            "900": string;
+            "950": string;
+        };
+        rose: {
+            "50": string;
+            "100": string;
+            "200": string;
+            "300": string;
+            "400": string;
+            "500": string;
+            "600": string;
+            "700": string;
+            "800": string;
+            "900": string;
+            "950": string;
+        };
+        sky: {
+            "50": string;
+            "100": string;
+            "200": string;
+            "300": string;
+            "400": string;
+            "500": string;
+            "600": string;
+            "700": string;
+            "800": string;
+            "900": string;
+            "950": string;
+        };
+        yellow: {
+            "50": string;
+            "100": string;
+            "200": string;
+            "300": string;
+            "400": string;
+            "500": string;
+            "600": string;
+            "700": string;
+            "800": string;
+            "900": string;
+            "950": string;
+        };
+        pink: {
+            "50": string;
+            "100": string;
+            "200": string;
+            "300": string;
+            "400": string;
+            "500": string;
+            "600": string;
+            "700": string;
+            "800": string;
+            "900": string;
+            "950": string;
+        };
+        lime: {
+            "50": string;
+            "100": string;
+            "200": string;
+            "300": string;
+            "400": string;
+            "500": string;
+            "600": string;
+            "700": string;
+            "800": string;
+            "900": string;
+            "950": string;
+        };
+        red: {
+            "50": string;
+            "100": string;
+            "200": string;
+            "300": string;
+            "400": string;
+            "500": string;
+            "600": string;
+            "700": string;
+            "800": string;
+            "900": string;
+            "950": string;
+        };
+        cyan: {
+            "50": string;
+            "100": string;
+            "200": string;
+            "300": string;
+            "400": string;
+            "500": string;
+            "600": string;
+            "700": string;
+            "800": string;
+            "900": string;
+            "950": string;
+        };
+        orange: {
+            "50": string;
+            "100": string;
+            "200": string;
+            "300": string;
+            "400": string;
+            "500": string;
+            "600": string;
+            "700": string;
+            "800": string;
+            "900": string;
+            "950": string;
+        };
+        violet: {
+            "50": string;
+            "100": string;
+            "200": string;
+            "300": string;
+            "400": string;
+            "500": string;
+            "600": string;
+            "700": string;
+            "800": string;
+            "900": string;
+            "950": string;
+        };
+        emerald: {
+            "50": string;
+            "100": string;
+            "200": string;
+            "300": string;
+            "400": string;
+            "500": string;
+            "600": string;
+            "700": string;
+            "800": string;
+            "900": string;
+            "950": string;
+        };
+        wood: {
+            "50": string;
+            "100": string;
+            "200": string;
+            "300": string;
+            "400": string;
+            "500": string;
+            "600": string;
+            "700": string;
+            "800": string;
+            "900": string;
+            "950": string;
+        };
+        blue: {
+            "50": string;
+            "100": string;
+            "200": string;
+            "300": string;
+            "400": string;
+            "500": string;
+            "600": string;
+            "700": string;
+            "800": string;
+            "900": string;
+            "950": string;
+        };
+        amber: {
+            "50": string;
+            "100": string;
+            "200": string;
+            "300": string;
+            "400": string;
+            "500": string;
+            "600": string;
+            "700": string;
+            "800": string;
+            "900": string;
+            "950": string;
+        };
+        purple: {
+            "50": string;
+            "100": string;
+            "200": string;
+            "300": string;
+            "400": string;
+            "500": string;
+            "600": string;
+            "700": string;
+            "800": string;
+            "900": string;
+            "950": string;
+        };
+        zinc: {
+            "50": string;
+            "100": string;
+            "200": string;
+            "300": string;
+            "400": string;
+            "500": string;
+            "600": string;
+            "700": string;
+            "800": string;
+            "900": string;
+            "950": string;
+        };
+        stone: {
+            "50": string;
+            "100": string;
+            "200": string;
+            "300": string;
+            "400": string;
+            "500": string;
+            "600": string;
+            "700": string;
+            "800": string;
+            "900": string;
+            "950": string;
+        };
+        indigo: {
+            "50": string;
+            "100": string;
+            "200": string;
+            "300": string;
+            "400": string;
+            "500": string;
+            "600": string;
+            "700": string;
+            "800": string;
+            "900": string;
+            "950": string;
+        };
+        gray: {
+            "50": string;
+            "100": string;
+            "200": string;
+            "300": string;
+            "400": string;
+            "500": string;
+            "600": string;
+            "700": string;
+            "800": string;
+            "900": string;
+            "950": string;
+        };
+    };
+    patterns: typeof patterns;
+    keys: {
+        gray: string[];
+        color: string[];
+        symbol: string[];
+        pattern: string[];
+    };
+}>;
+import * as patterns from '../patterns';