@rokkit/chart 1.0.0-next.14 → 1.0.0-next.140

package/src/lib/brewing/axes.svelte.js

@@ -0,0 +1,265 @@
+// import { scaleBand } from 'd3-scale'
+
+import {} from './types.js'
+
+/**
+ * @typedef {import('./types').TickData} TickData
+ * @typedef {import('./types').AxisData} AxisData
+ * @typedef {import('./types').ChartScales} ChartScales
+ * @typedef {import('./types').ChartDimensions} ChartDimensions
+ */
+
+const IDENTITY = (v) => v
+
+/**
+ * @param {Object} xScale
+ * @param {number|null} tickCount
+ * @returns {Array}
+ */
+function xTicksFromContinuous(xScale, tickCount) {
+	return tickCount !== null ? xScale.ticks(tickCount) : xScale.ticks()
+}
+
+/**
+ * @param {Array} domain
+ * @param {number} tickCount
+ * @returns {Array}
+ */
+function downsampleDomain(domain, tickCount) {
+	const step = Math.max(1, Math.floor(domain.length / tickCount))
+	return domain.filter((_, i) => i % step === 0)
+}
+
+/**
+ * @param {Object} xScale
+ * @param {number|null} tickCount
+ * @returns {Array}
+ */
+function xTicksFromBand(xScale, tickCount) {
+	const domain = xScale.domain()
+	if (tickCount === null || tickCount >= domain.length) return domain
+	return downsampleDomain(domain, tickCount)
+}
+
+/**
+ * @param {Object} xScale
+ * @param {number|null} tickCount
+ * @returns {Array}
+ */
+function resolveXTicks(xScale, tickCount) {
+	return xScale.ticks ? xTicksFromContinuous(xScale, tickCount) : xTicksFromBand(xScale, tickCount)
+}
+
+/**
+ * @param {Object} xScale
+ * @param {unknown} value
+ * @returns {number}
+ */
+function xPosition(xScale, value) {
+	return xScale.bandwidth ? xScale(value) + xScale.bandwidth() / 2 : xScale(value)
+}
+
+/**
+ * @param {Object} scale
+ * @param {Array} values
+ * @param {Function} formatter
+ * @param {(scale: Object, v: unknown) => number} getPosition
+ * @returns {Array}
+ */
+function mapTicks(scale, values, formatter, getPosition) {
+	return values.map((value) => ({
+		value,
+		position: getPosition(scale, value),
+		formattedValue: formatter(value)
+	}))
+}
+
+/**
+ * @param {Object} options
+ * @returns {{ tickCount: number|null, formatter: Function, label: string }}
+ */
+function parseAxisOptions(options) {
+	const opts = options || {}
+	return {
+		tickCount: opts.tickCount !== undefined ? opts.tickCount : null,
+		formatter: opts.tickFormat ? opts.tickFormat : IDENTITY,
+		label: opts.label ? opts.label : ''
+	}
+}
+
+/**
+ * Creates x-axis tick data for rendering
+ *
+ * @param {Object} scales - Chart scales
+ * @param {Function} scales.x - X-axis scale
+ * @param {Object} dimensions - Chart dimensions
+ * @param {Object} options - Axis options
+ * @param {number} [options.tickCount] - Number of ticks to show
+ * @param {Function} [options.tickFormat] - Tick formatting function
+ * @param {string} [options.label] - Axis label
+ * @returns {AxisData} Axis rendering data
+ */
+export function createXAxis(scales, dimensions, options) {
+	if (!scales.x) return { ticks: [] }
+	const { tickCount, formatter, label } = parseAxisOptions(options)
+	const ticks = mapTicks(scales.x, resolveXTicks(scales.x, tickCount), formatter, xPosition)
+	return {
+		ticks,
+		label,
+		transform: `translate(0, ${dimensions.innerHeight})`,
+		labelTransform: `translate(${dimensions.innerWidth / 2}, 35)`
+	}
+}
+
+/**
+ * @param {Object} yScale
+ * @param {number|null} tickCount
+ * @returns {Array}
+ */
+function yTicksFromDomain(yScale, tickCount) {
+	const domain = yScale.domain()
+	if (tickCount === null || domain.length <= tickCount) return domain
+	return downsampleDomain(domain, tickCount)
+}
+
+/**
+ * @param {Object} yScale
+ * @param {number|null} tickCount
+ * @returns {Array}
+ */
+function resolveYTicks(yScale, tickCount) {
+	if (yScale.ticks) return tickCount !== null ? yScale.ticks(tickCount) : yScale.ticks()
+	if (yScale.domain) return yTicksFromDomain(yScale, tickCount)
+	return []
+}
+
+/**
+ * @param {Object} scale
+ * @param {unknown} value
+ * @returns {unknown}
+ */
+function yPositionPassthrough(scale, value) {
+	return scale(value)
+}
+
+/**
+ * Creates y-axis tick data for rendering
+ *
+ * @param {Object} scales - Chart scales
+ * @param {Function} scales.y - Y-axis scale
+ * @param {Object} dimensions - Chart dimensions
+ * @param {Object} options - Axis options
+ * @param {number} [options.tickCount] - Number of ticks to show
+ * @param {Function} [options.tickFormat] - Tick formatting function
+ * @param {string} [options.label] - Axis label
+ * @returns {AxisData} Axis rendering data
+ */
+export function createYAxis(scales, dimensions, options) {
+	if (!scales.y) return { ticks: [] }
+	const { tickCount, formatter, label } = parseAxisOptions(options)
+	const ticks = mapTicks(scales.y, resolveYTicks(scales.y, tickCount), formatter, yPositionPassthrough)
+	return {
+		ticks,
+		label,
+		transform: 'translate(0, 0)',
+		labelTransform: `translate(-40, ${dimensions.innerHeight / 2}) rotate(-90)`
+	}
+}
+
+/**
+ * @param {Object} scales
+ * @param {Object} dimensions
+ * @param {number|null} xTickCount
+ * @returns {Array}
+ */
+function buildXLines(scales, dimensions, xTickCount) {
+	return createXAxis(scales, dimensions, { tickCount: xTickCount }).ticks.map((tick) => ({
+		x1: tick.position,
+		y1: 0,
+		x2: tick.position,
+		y2: dimensions.innerHeight
+	}))
+}
+
+/**
+ * @param {Object} scales
+ * @param {Object} dimensions
+ * @param {number|null} yTickCount
+ * @returns {Array}
+ */
+function buildYLines(scales, dimensions, yTickCount) {
+	return createYAxis(scales, dimensions, { tickCount: yTickCount }).ticks.map((tick) => ({
+		x1: 0,
+		y1: tick.position,
+		x2: dimensions.innerWidth,
+		y2: tick.position
+	}))
+}
+
+/**
+ * @param {Object} opts
+ * @returns {{ direction: string, xTickCount: number|null, yTickCount: number|null }}
+ */
+function parseGridOptions(opts) {
+	const o = opts || {}
+	return {
+		direction: o.direction !== undefined ? o.direction : 'both',
+		xTickCount: o.xTickCount !== undefined ? o.xTickCount : null,
+		yTickCount: o.yTickCount !== undefined ? o.yTickCount : null
+	}
+}
+
+/**
+ * @param {string} direction
+ * @returns {{ showX: boolean, showY: boolean }}
+ */
+function gridDirections(direction) {
+	return {
+		showX: direction === 'x' || direction === 'both',
+		showY: direction === 'y' || direction === 'both'
+	}
+}
+
+/**
+ * Creates grid line data for rendering
+ *
+ * @param {Object} scales - Chart scales
+ * @param {Object} dimensions - Chart dimensions
+ * @param {Object} options - Grid options
+ * @param {string} [options.direction='both'] - Grid direction ('x', 'y', or 'both')
+ * @param {number} [options.xTickCount] - Number of x-axis ticks
+ * @param {number} [options.yTickCount] - Number of y-axis ticks
+ * @returns {Object} Grid rendering data
+ */
+export function createGrid(scales, dimensions, options) {
+	const { direction, xTickCount, yTickCount } = parseGridOptions(options)
+	const { showX, showY } = gridDirections(direction)
+	return {
+		xLines: showX && scales.x ? buildXLines(scales, dimensions, xTickCount) : [],
+		yLines: showY && scales.y ? buildYLines(scales, dimensions, yTickCount) : []
+	}
+}
+
+/**
+ * Creates DOM attributes for a tick element
+ *
+ * @param {TickData} tick - Tick data
+ * @param {string} axis - Axis type ('x' or 'y')
+ * @returns {Object} Attributes for the tick
+ */
+export function createTickAttributes(tick, axis) {
+	if (axis === 'x') {
+		return {
+			'data-plot-tick': 'major',
+			transform: `translate(${tick.position}, 0)`,
+			'text-anchor': 'middle'
+		}
+	} else {
+		return {
+			'data-plot-tick': 'major',
+			transform: `translate(0, ${tick.position})`,
+			'text-anchor': 'end',
+			'dominant-baseline': 'middle'
+		}
+	}
+}

package/src/lib/brewing/bars.svelte.js

@@ -0,0 +1,177 @@
+import { SvelteSet } from 'svelte/reactivity'
+import {} from './types.js'
+
+/**
+ * @typedef {import('./types').BarData} BarData
+ * @typedef {import('./types').ScaleFields} ScaleFields
+ * @typedef {import('./types').ChartScales} ChartScales
+ * @typedef {import('./types').ChartDimensions} ChartDimensions
+ */
+
+const DEFAULT_COLOR = '#4682b4'
+
+/**
+ * @param {Object} d - data item
+ * @param {{ fields: Object, scales: Object, dimensions: Object, defaultColor: string }} ctx
+ * @returns {BarData}
+ */
+function buildBar(d, ctx) {
+	const { fields, scales, dimensions, defaultColor } = ctx
+	const { x: xField, y: yField, color: colorField } = fields
+	const barWidth = scales.x.bandwidth ? scales.x.bandwidth() : 10
+	const barX = scales.x.bandwidth ? scales.x(d[xField]) : scales.x(d[xField]) - barWidth / 2
+	return {
+		data: d,
+		x: barX,
+		y: scales.y(d[yField]),
+		width: barWidth,
+		height: dimensions.innerHeight - scales.y(d[yField]),
+		color: colorField && scales.color ? scales.color(d[colorField]) : defaultColor
+	}
+}
+
+/**
+ * @param {Object} options
+ * @param {Object} fields
+ * @param {Object} scales
+ * @returns {{ ctx: Object }|null} null if input is invalid
+ */
+function parseBarsInput(options, fields, scales) {
+	if (!scales.x || !scales.y) return null
+	const opts = options || {}
+	return {
+		fields,
+		scales,
+		dimensions: opts.dimensions,
+		defaultColor: opts.defaultColor !== undefined ? opts.defaultColor : DEFAULT_COLOR
+	}
+}
+
+/**
+ * Creates bar data for rendering
+ *
+ * @param {Array} data - Chart data
+ * @param {Object} fields - Field mappings
+ * @param {string} fields.x - X-axis field
+ * @param {string} fields.y - Y-axis field
+ * @param {string} fields.color - Color field (optional)
+ * @param {Object} scales - Chart scales
+ * @param {Function} scales.x - X-axis scale
+ * @param {Function} scales.y - Y-axis scale
+ * @param {Function} scales.color - Color scale
+ * @param {Object} options - Options including dimensions and defaultColor
+ * @param {Object} options.dimensions - Chart dimensions
+ * @param {string} [options.defaultColor='#4682b4'] - Default color if no color scale
+ * @returns {BarData[]} Bar data for rendering
+ */
+export function createBars(data, fields, scales, options) {
+	if (!data || !data.length) return []
+	const ctx = parseBarsInput(options, fields, scales)
+	if (!ctx) return []
+	return data.map((d) => buildBar(d, ctx))
+}
+
+/**
+ * Filter bars based on a selection criteria
+ *
+ * @param {BarData[]} bars - Bar data array
+ * @param {Object} selection - Selection criteria
+ * @returns {BarData[]} Filtered bars
+ */
+export function filterBars(bars, selection) {
+	if (!selection) return bars
+
+	return bars.filter((bar) => {
+		for (const [key, value] of Object.entries(selection)) {
+			if (bar.data[key] !== value) return false
+		}
+		return true
+	})
+}
+
+/**
+ * @param {Object} item - data item
+ * @param {Object} scales - chart scales
+ * @param {{ yField: string, colorField: string, group: unknown, barX: number, barWidth: number, dimensions: Object }} ctx
+ * @returns {BarData}
+ */
+function buildGroupBar(item, scales, ctx) {
+	const { yField, colorField, group, barX, barWidth, dimensions } = ctx
+	return {
+		data: item,
+		group,
+		x: barX,
+		y: scales.y(item[yField]),
+		width: barWidth,
+		height: dimensions.innerHeight - scales.y(item[yField]),
+		color: scales.color ? scales.color(item[colorField]) : DEFAULT_COLOR
+	}
+}
+
+/**
+ * @param {Object} scales
+ * @param {{ groupItems: Array, groupField: string, group: unknown, i: number, yField: string, colorField: string, barWidth: number, padding: number, dimensions: Object, xPos: number }} ctx
+ * @returns {BarData|null}
+ */
+function buildOneGroupBar(scales, ctx) {
+	const { groupItems, groupField, group, i, yField, colorField, barWidth, padding, dimensions, xPos } = ctx
+	const item = groupItems.find((d) => d[groupField] === group)
+	if (!item) return null
+	const barX = xPos + i * (barWidth + padding)
+	return buildGroupBar(item, scales, { yField, colorField, group, barX, barWidth, dimensions })
+}
+
+/**
+ * @param {Object} fields
+ * @param {Object} options
+ * @returns {{ xField: string, yField: string, groupField: string, colorField: string, dimensions: Object, padding: number }}
+ */
+function parseGroupedBarsConfig(fields, options) {
+	const opts = options || {}
+	return {
+		xField: fields.x,
+		yField: fields.y,
+		groupField: fields.group,
+		colorField: fields.color !== undefined ? fields.color : fields.group,
+		dimensions: opts.dimensions,
+		padding: opts.padding !== undefined ? opts.padding : 0.1
+	}
+}
+
+/**
+ * Creates a grouped bars layout
+ *
+ * @param {Array} data - Chart data
+ * @param {Object} fields - Field mappings
+ * @param {Object} scales - Chart scales
+ * @param {Object} options - Options including dimensions and padding
+ * @param {Object} options.dimensions - Chart dimensions
+ * @param {number} [options.padding=0.1] - Padding between bars in a group
+ * @returns {Object} Grouped bar data
+ */
+export function createGroupedBars(data, fields, scales, options) {
+	if (!data || !data.length || !fields.group) return { groups: [], bars: [] }
+
+	const { xField, yField, groupField, colorField, dimensions, padding } =
+		parseGroupedBarsConfig(fields, options)
+
+	const groups = [...new SvelteSet(data.map((d) => d[groupField]))]
+	const xValues = [...new SvelteSet(data.map((d) => d[xField]))]
+
+	const xScale = scales.x
+	const groupWidth = xScale.bandwidth ? xScale.bandwidth() : 20
+	const barWidth = (groupWidth - padding * (groups.length - 1)) / groups.length
+
+	const bars = []
+	xValues.forEach((xValue) => {
+		const groupItems = data.filter((d) => d[xField] === xValue)
+		const xPos = xScale(xValue)
+		groups.forEach((group, i) => {
+			const ctx = { groupItems, groupField, group, i, yField, colorField, barWidth, padding, dimensions, xPos }
+			const bar = buildOneGroupBar(scales, ctx)
+			if (bar) bars.push(bar)
+		})
+	})
+
+	return { groups, bars }
+}

package/src/lib/brewing/dimensions.svelte.js

@@ -0,0 +1,56 @@
+import {} from './types.js'
+
+/**
+ * @typedef {import('./types').ChartMargin} ChartMargin
+ * @typedef {import('./types').ChartDimensions} ChartDimensions
+ */
+
+/**
+ * Default chart margin
+ * @type {ChartMargin}
+ */
+export const DEFAULT_MARGIN = { top: 20, right: 30, bottom: 40, left: 50 }
+
+/**
+ * Creates chart dimensions based on width, height and margins
+ *
+ * @param {number} width - Total chart width
+ * @param {number} height - Total chart height
+ * @param {ChartMargin} margin - Chart margins
+ * @returns {ChartDimensions} Chart dimensions
+ */
+export function createDimensions(width = 600, height = 400, margin = DEFAULT_MARGIN) {
+	return {
+		width,
+		height,
+		margin: { ...margin },
+		innerWidth: width - margin.left - margin.right,
+		innerHeight: height - margin.top - margin.bottom
+	}
+}
+
+/**
+ * Updates existing dimensions with new values
+ *
+ * @param {ChartDimensions} dimensions - Current dimensions
+ * @param {Object} updates - Values to update
+ * @param {number} [updates.width] - New width
+ * @param {number} [updates.height] - New height
+ * @param {ChartMargin} [updates.margin] - New margin
+ * @returns {ChartDimensions} Updated dimensions
+ */
+export function updateDimensions(dimensions, updates = {}) {
+	const newDimensions = { ...dimensions }
+
+	if (updates.width !== undefined) newDimensions.width = updates.width
+	if (updates.height !== undefined) newDimensions.height = updates.height
+	if (updates.margin !== undefined) newDimensions.margin = { ...updates.margin }
+
+	// Recalculate inner dimensions
+	newDimensions.innerWidth =
+		newDimensions.width - newDimensions.margin.left - newDimensions.margin.right
+	newDimensions.innerHeight =
+		newDimensions.height - newDimensions.margin.top - newDimensions.margin.bottom
+
+	return newDimensions
+}

package/src/lib/brewing/index.svelte.js

@@ -0,0 +1,205 @@
+import { createDimensions, updateDimensions } from './dimensions.svelte.js'
+import { createScales, getOrigin } from './scales.svelte.js'
+import { createBars, filterBars, createGroupedBars } from './bars.svelte.js'
+import { createXAxis, createYAxis, createGrid, createTickAttributes } from './axes.svelte.js'
+import { createLegend, filterByLegend, createLegendItemAttributes } from './legends.svelte.js'
+
+/**
+ * Chart Brewing - A collection of pure functions for chart data preparation
+ */
+export {
+	// Dimensions
+	createDimensions,
+	updateDimensions,
+
+	// Scales
+	createScales,
+	getOrigin,
+
+	// Bars
+	createBars,
+	filterBars,
+	createGroupedBars,
+
+	// Axes
+	createXAxis,
+	createYAxis,
+	createGrid,
+	createTickAttributes,
+
+	// Legends
+	createLegend,
+	filterByLegend,
+	createLegendItemAttributes
+}
+
+/**
+ * Main class that manages chart state and provides access to all brewing functions
+ */
+export class ChartBrewer {
+	#data = []
+	#dimensions = createDimensions()
+	#scales = { x: null, y: null, color: null }
+	#fields = { x: null, y: null, color: null }
+	#options = {
+		padding: 0.2,
+		animationDuration: 300
+	}
+
+	/**
+	 * Creates a new ChartBrewer instance
+	 *
+	 * @param {Object} options Configuration options
+	 */
+	constructor(options = {}) {
+		this.#dimensions = createDimensions(options.width, options.height, options.margin)
+
+		if (options.padding !== undefined) this.#options.padding = options.padding
+		if (options.animationDuration !== undefined)
+			this.#options.animationDuration = options.animationDuration
+	}
+
+	/**
+	 * Sets the data for the chart
+	 *
+	 * @param {Array} data Data array
+	 * @returns {ChartBrewer} this for method chaining
+	 */
+	setData(data) {
+		this.#data = Array.isArray(data) ? data : []
+		return this
+	}
+
+	/**
+	 * Sets the field mappings for axes and color
+	 *
+	 * @param {Object} fields Field mappings
+	 * @returns {ChartBrewer} this for method chaining
+	 */
+	setFields({ x, y, color }) {
+		if (x !== undefined) this.#fields.x = x
+		if (y !== undefined) this.#fields.y = y
+		if (color !== undefined) this.#fields.color = color
+		return this
+	}
+
+	/**
+	 * Sets the dimensions of the chart
+	 *
+	 * @param {Object} dimensions Chart dimensions
+	 * @returns {ChartBrewer} this for method chaining
+	 */
+	setDimensions({ width, height, margin }) {
+		this.#dimensions = updateDimensions(this.#dimensions, { width, height, margin })
+		return this
+	}
+
+	/**
+	 * Creates scales based on data and dimensions
+	 *
+	 * @returns {ChartBrewer} this for method chaining
+	 */
+	createScales() {
+		this.#scales = createScales(this.#data, this.#fields, this.#dimensions, {
+			padding: this.#options.padding
+		})
+		return this
+	}
+
+	/**
+	 * Creates bar data for rendering
+	 *
+	 * @returns {Array} Data for rendering bars
+	 */
+	createBars() {
+		return createBars(this.#data, this.#fields, this.#scales, { dimensions: this.#dimensions })
+	}
+
+	/**
+	 * Creates x-axis tick data for rendering
+	 *
+	 * @param {Object} options Axis options
+	 * @returns {Object} Axis rendering data
+	 */
+	createXAxis(options = {}) {
+		return createXAxis(this.#scales, this.#dimensions, options)
+	}
+
+	/**
+	 * Creates y-axis tick data for rendering
+	 *
+	 * @param {Object} options Axis options
+	 * @returns {Object} Axis rendering data
+	 */
+	createYAxis(options = {}) {
+		return createYAxis(this.#scales, this.#dimensions, options)
+	}
+
+	/**
+	 * Creates grid line data for rendering
+	 *
+	 * @param {Object} options Grid options
+	 * @returns {Object} Grid rendering data
+	 */
+	createGrid(options = {}) {
+		return createGrid(this.#scales, this.#dimensions, options)
+	}
+
+	/**
+	 * Creates legend data for rendering
+	 *
+	 * @param {Object} options Legend options
+	 * @returns {Object} Legend rendering data
+	 */
+	createLegend(options = {}) {
+		return createLegend(this.#data, this.#fields, this.#scales, {
+			...options,
+			dimensions: this.#dimensions
+		})
+	}
+
+	/**
+	 * Gets all chart dimensions
+	 *
+	 * @returns {Object} Chart dimensions
+	 */
+	getDimensions() {
+		return { ...this.#dimensions }
+	}
+
+	/**
+	 * Gets all chart scales
+	 *
+	 * @returns {Object} Chart scales
+	 */
+	getScales() {
+		return { ...this.#scales }
+	}
+
+	/**
+	 * Gets the animation duration
+	 *
+	 * @returns {number} Animation duration in ms
+	 */
+	getAnimationDuration() {
+		return this.#options.animationDuration
+	}
+
+	/**
+	 * Gets the data being used
+	 *
+	 * @returns {Array} Chart data
+	 */
+	getData() {
+		return [...this.#data]
+	}
+
+	/**
+	 * Gets the fields configuration
+	 *
+	 * @returns {Object} Fields configuration
+	 */
+	getFields() {
+		return { ...this.#fields }
+	}
+}