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

package/src/lib/utils.js

@@ -1,157 +1,144 @@
-import { scaleBand, scaleLinear } from 'd3-scale'
-import { min, max } from 'd3-array'
-import { ascending, quantile } from 'd3-array'
-import { nest } from 'd3-collection'
-import { omit } from 'ramda'
+import { scaleBand, scaleLinear, scaleOrdinal } from 'd3-scale'
+import { schemeCategory10 } from 'd3-scale-chromatic'
+import { max } from 'd3-array'
 
 /**
- * Calculates a grid of centres to fit a list of items of `size` within the number of `columns` and `rows`.
+ * Creates appropriate scales based on data and dimensions
  *
- * - 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
- * @param {number} size
- * @param {number} pad
- * @param {number} columns
- * @param {number} rows
- * @returns
+ * @param {Array} data The dataset
+ * @param {Object} dimensions Chart dimensions
+ * @param {Object} [options] Additional options
+ * @param {string} options.xKey Field to use for x-axis
+ * @param {string} options.yKey Field to use for y-axis
+ * @param {string} [options.colorKey] Field to use for color mapping
+ * @returns {Object} Object containing xScale, yScale, and colorScale
  */
-export function swatch(count, size, pad = 0, columns, rows) {
-	if (columns > 0) {
-		rows = Math.ceil(count / columns)
-	} else if (rows > 0) {
-		columns = Math.ceil(count / rows)
-	} else {
-		columns = Math.ceil(Math.sqrt(count))
-		rows = Math.ceil(count / columns)
-	}
+export function createScales(data, dimensions, options = {}) {
+	if (!data || data.length === 0) return {}
+
+	const { xKey, yKey, colorKey } = options
+
+	const xScale = scaleBand()
+		.domain(data.map((d) => d[xKey]))
+		.range([0, dimensions.width])
+		.padding(0.2)
 
-	const width = (size + pad) * columns + pad
-	const height = (size + pad) * rows + pad
-	const data = [...Array(count).keys()].map((index) => ({
-		cx: (size + pad) / 2 + (index % columns) * (size + pad),
-		cy: (size + pad) / 2 + Math.floor(index / columns) * (size + pad),
-		r: size / 2
-	}))
+	const yScale = scaleLinear()
+		.domain([0, max(data, (d) => d[yKey]) * 1.1]) // Add 10% padding on top
+		.nice()
+		.range([dimensions.height, 0])
+
+	let colorScale = null
+
+	if (colorKey) {
+		const uniqueCategories = [...new Set(data.map((d) => d[colorKey]))]
+		colorScale = scaleOrdinal().domain(uniqueCategories).range(schemeCategory10)
+	}
 
-	return { width, height, data }
+	return { xScale, yScale, colorScale }
 }
+
 /**
- * Get a scale function mapping the values between a range of lower and upper values
+ * Calculates the actual chart dimensions after applying margins
  *
- * @param {Array} values
- * @param {Array[2]} bounds
- * @param {number} buffer
- * @returns
+ * @param {Object} dimensions Original dimensions
+ * @returns {Object} Dimensions with calculated inner width and height
  */
-export function getScale(values, bounds, buffer = 0, ordinal = false) {
-	if (ordinal || values.some(isNaN)) {
-		return scaleBand().range(bounds).domain(values).padding(0.5)
-	} else {
-		values = values.map((x) => +x)
-
-		let minValue = min([...values, 0])
-		let maxValue = max(values)
-
-		if (minValue < 0 && maxValue > 0) {
-			maxValue = max([-1 * minValue, maxValue])
-			minValue = -1 * maxValue
-		}
-		const margin = (maxValue - minValue) * buffer
-		return scaleLinear()
-			.domain([minValue - margin, maxValue + margin])
-			.range(bounds)
+export function calculateChartDimensions(dimensions) {
+	const { width, height, margin } = dimensions
+
+	return {
+		...dimensions,
+		innerWidth: width - margin.left - margin.right,
+		innerHeight: height - margin.top - margin.bottom
 	}
 }
+
 /**
- * Obtain the scale function for the `x` and `y` fields in the data set.
+ * Normalizes data for use with D3 charts
  *
- * @param {array<dict>} data
- * @param {string} x
- * @param {string} y
- * @param {number} width
- * @param {number} height
- * @returns
+ * @param {Array|Object} inputData Raw data or dataset object
+ * @returns {Array} Normalized data array
  */
-export function getScales(data, x, y, width, height, margin, ordinal) {
-	const xValues = [...new Set(data.map((item) => item[x]))]
-	const yValues = [...new Set(data.map((item) => item[y]))]
+export function normalizeData(inputData) {
+	if (!inputData) return []
 
-	return {
-		x: getScale(xValues, [0 + margin.left, width - margin.right], 0, ordinal.x),
-		y: getScale(yValues, [height - margin.top, margin.bottom], 0.1, ordinal.y)
+	// If it's a dataset class instance, call select() to get the data
+	if (inputData.select && typeof inputData.select === 'function') {
+		return inputData.select()
+	}
+
+	// If it's already an array, return as is
+	if (Array.isArray(inputData)) {
+		return inputData
 	}
+
+	return []
 }
 
 /**
- * Summarize `data` by fields `x` and `y` and return a nested array with
- * key as unique `x` values and value as statistical summaries of `y` values
+ * Generates a unique ID for SVG elements
  *
- * @param {*} data
- * @param {*} x
- * @param {*} y
- * @returns
+ * @param {string} prefix Prefix for the ID
+ * @returns {string} A unique ID
+ */
+export function uniqueId(prefix = 'chart') {
+	return `${prefix}-${Math.random().toString(36).substring(2, 10)}`
+}
+
+/**
+ * Format a single key-value pair for tooltip
+ * @param {string} key
+ * @param {unknown} value
+ * @param {Function|undefined} formatter
+ * @returns {string}
  */
-export function aggregate(data, x, y) {
-	const summary = nest()
-		.key((d) => d[x])
-		.rollup((d) => {
-			let values = d.map((g) => g[y]).sort(ascending)
-			let q1 = quantile(values, 0.25)
-			let q3 = quantile(values, 0.75)
-			let median = quantile(values, 0.5)
-			let interQuantileRange = q3 - q1
-			let min = q1 - 1.5 * interQuantileRange
-			let max = q3 + 1.5 * interQuantileRange
-			return { q1, q3, median, interQuantileRange, min, max }
-		})
-		.entries(data)
-	return summary
+function formatField(key, value, formatter) {
+	const formatted = formatter ? formatter(value) : value
+	return `${key}: ${formatted}`
 }
 
 /**
- * Generate a palette with same size as input data containing values from palette array.
- * After the palette array is exhausted the fallback value is used
+ * Formats tooltip content for a data point
  *
- * @param {Array} values
- * @param {Array} palette
- * @param {*}     fallback
- * @returns
+ * @param {Object} d Data point
+ * @param {Object} options Tooltip format options
+ * @returns {string} Formatted tooltip HTML content
  */
-export function getPaletteForValues(values, palette, fallback) {
-	return values.map((_, index) =>
-		index < palette.length ? palette[index] : fallback
-	)
+export function formatTooltipContent(d, options = {}) {
+	if (!d) return ''
+
+	const { xKey, yKey, xFormat, yFormat } = options
+
+	if (xKey && yKey) {
+		return [
+			formatField(xKey, d[xKey], xFormat),
+			formatField(yKey, d[yKey], yFormat)
+		].join('<br>')
+	}
+
+	return Object.entries(d)
+		.map(([key, value]) => `${key}: ${value}`)
+		.join('<br>')
 }
 
 /**
- * Converts input object array into a nested key,value array.
- * 'key' contains unique values for the attribute specified by the key parameter
- * and value contains array of all remaining attributes in an array.
+ * Generates a tooltip formatter function
  *
- * @param {Array<Object>} data
- * @param {string} key
- * @param {string} label
- * @returns
+ * @param {Object} options Tooltip format options
+ * @returns {Function} A function that formats tooltip content
  */
-export function toNested(data, key, label) {
-	return nest()
-		.key((d) => d[key])
-		.rollup((values) => values.map((value) => omit([key], value)))
-		.entries(data.sort((a, b) => ascending(a[label], b[label])))
+export function createTooltipFormatter(options = {}) {
+	return (d) => formatTooltipContent(d, options)
 }
+
 /**
- * Repeats array items of b using array items of a ask keys
+ * Calculates the transform attribute for SVG elements
  *
- * @param {Array} b
- * @param {Array} a
- * @returns {Object} with keys as items in a and values as items in b
+ * @param {number} x X position
+ * @param {number} y Y position
+ * @returns {string} Transform attribute value
  */
-export function repeatAcross(b, a) {
-	return a.reduce(
-		(acc, item, index) => ({ ...acc, [item]: b[index % b.length] }),
-		{}
-	)
+export function transform(x, y) {
+	return `translate(${x}, ${y})`
 }

package/src/old_lib/brewer.js

@@ -0,0 +1,25 @@
+/**
+ * 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, swatch, gray = false) {
+	const colors = gray ? swatch.keys.gray : swatch.keys.color
+	const max_colors = colors.length
+	const max_patterns = swatch.keys.pattern.length
+
+	const mix = values
+		.map((value, index) => ({
+			[value]: {
+				pattern: swatch.keys.pattern[index % max_patterns],
+				color: colors[index % max_colors]
+			}
+		}))
+		.reduce((acc, current) => ({ ...acc, ...current }), {})
+	return mix
+}
+
+// export function getStrokePatterns() {}

package/src/old_lib/chart.js

@@ -0,0 +1,213 @@
+import { min, max } from 'd3-array'
+import { scaleBand, scaleLinear, scaleTime } from 'd3-scale'
+
+function getOriginValue(scale) {
+	return scale.ticks ? scale(Math.max(0, Math.min(...scale.domain()))) : scale.range()[0]
+}
+
+function getScale(domain, range, padding = 0) {
+	if (domain.some(isNaN)) {
+		return scaleBand().domain(domain).range(range).padding(padding)
+	} else if (domain[0] instanceof Date) {
+		return scaleTime()
+			.domain([min(domain), max(domain)])
+			.range(range)
+			.nice()
+	}
+
+	return scaleLinear()
+		.domain([min([0, ...domain]), max([0, ...domain])])
+		.range(range)
+		.nice()
+}
+
+class Chart {
+	// data = []
+	// width = 512
+	// height = 512
+	// origin = { x: 0, y: 0 }
+	// range = {
+	// 	x: [0, this.width],
+	// 	y: [this.height, 0]
+	// }
+	// x
+	// y
+	// stat = 'identity'
+	// scale
+	// fill
+	// color
+	// value
+	// shape
+	// valueFormat
+	// valueLabel
+	// domain
+	// margin
+	// spacing
+	// padding
+	// flipCoords = false
+
+	constructor(data, opts) {
+		this.width = Number(opts.width) || 2048
+		this.height = Number(opts.height) || 2048
+		this.flipCoords = opts.flipCoords || false
+		this.x = opts.x
+		this.y = opts.y
+		this.value = opts.value || opts.y
+		this.valueLabel = opts.valueLabel || this.value
+		this.valueFormat = opts.valueFormat || ((d) => d)
+		this.fill = opts.fill || opts.x
+		this.color = opts.color || opts.fill
+		this.shape = opts.shape || opts.fill
+
+		this.padding = opts.padding !== undefined ? Number(opts.padding) : 32
+
+		this.spacing =
+			Number(opts.spacing) >= 0 && Number(opts.spacing) <= 0.5 ? Number(opts.spacing) : 0
+		this.margin = {
+			top: Number(opts.margin?.top) || 0,
+			left: Number(opts.margin?.left) || 0,
+			right: Number(opts.margin?.right) || 0,
+			bottom: Number(opts.margin?.bottom) || 0
+		}
+		this.domain = {
+			x: [...new Set(data.map((d) => d[this.x]))],
+			y: [...new Set(data.map((d) => d[this.y]))]
+		}
+		if (this.flipCoords) {
+			this.domain = { y: this.domain.x, x: this.domain.y }
+		}
+		this.stat = opts.stat || 'identity'
+
+		this.data = data.map((d) => ({
+			x: this.flipCoords ? d[this.y] : d[this.x],
+			y: this.flipCoords ? d[this.x] : d[this.y],
+			// fill: d[this.fill],
+			color: d[this.color]
+			// shape: d[this.shape]
+		}))
+
+		this.refresh()
+	}
+
+	padding(value) {
+		this.padding = value
+		return this.refresh()
+	}
+
+	margin(value) {
+		this.margin = value
+		return this.refresh()
+	}
+
+	refresh() {
+		this.range = {
+			x: [this.margin.left + this.padding, this.width - this.margin.right - this.padding],
+			y: [this.height - this.padding - this.margin.bottom, this.margin.top + this.padding]
+		}
+
+		const scale = {
+			x: getScale(this.domain.x, this.range.x, this.spacing),
+			y: getScale(this.domain.y, this.range.y, this.spacing)
+		}
+
+		// scale['value'] = this.value === this.x ? scale.x : scale.y
+
+		this.origin = {
+			x: getOriginValue(scale.x),
+			y: getOriginValue(scale.y)
+		}
+
+		this.scale = scale
+
+		return this
+	}
+
+	// get scale() {
+	// 	return this.scale
+	// }
+	// get origin() {
+	// 	return this.origin
+	// }
+	// get margin() {
+	// 	return this.margin
+	// }
+	// get range() {
+	// 	const [x1, x2] = this.scale.x.range()
+	// 	const [y1, y2] = this.scale.y.range()
+
+	// 	return { x1, y1, x2, y2 }
+	// }
+	// get data() {
+	// 	// aggregate data group by x,y,fill,shape, color
+	// 	// stat = [min, max, avg, std, q1, q3, median, sum, count, box, all]
+
+	// 	return this.data
+	// }
+	// get width() {
+	// 	return this.width
+	// }
+	// get height() {
+	// 	return this.height
+	// }
+	// set width(value) {
+	// 	this.width = value
+	// }
+	// set height(value) {
+	// 	this.height = value
+	// }
+	// get domain() {
+	// 	return this.domain
+	// }
+	// get flipCoords() {
+	// 	return this.flipCoords
+	// }
+	aggregate(value, stat) {
+		this.value = value
+		this.stat = stat
+
+		// this.data = nest(this.data)
+	}
+
+	ticks(axis, count, fontSize = 8) {
+		const scale = this.scale[axis]
+		const [minRange, maxRange] = scale.range()
+		let ticks = []
+		let offset = 0
+
+		count = count || Math.abs((maxRange - minRange) / (fontSize * (axis === 'y' ? 8 : 8)))
+
+		if (scale.ticks) {
+			ticks = scale.ticks(Math.round(count))
+		} else {
+			offset = scale.bandwidth() / 2
+			count = Math.min(Math.round(count), scale.domain().length)
+
+			ticks = scale.domain()
+			if (count < scale.domain().length) {
+				const diff = scale.domain().length - count
+				ticks = ticks.filter((d, i) => i % diff === 0)
+			}
+		}
+
+		ticks = ticks
+			.map((t) => ({
+				label: t,
+				pos: scale(t)
+			}))
+			.map(({ label, pos }) => ({
+				label,
+				offset: {
+					x: axis === 'x' ? offset : 0,
+					y: axis === 'y' ? offset : 0
+				},
+				x: axis === 'x' ? pos : this.origin.x,
+				y: axis === 'y' ? pos : this.origin.y
+			}))
+
+		return ticks
+	}
+}
+
+export function chart(data, aes) {
+	return new Chart(data, aes)
+}

package/src/old_lib/grid.js

@@ -0,0 +1,85 @@
+/**
+ * @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, size, options) {
+	const { pad = 0 } = options || {}
+	let { columns = 0, rows = 0 } = options || {}
+	if (columns > 0) {
+		rows = Math.ceil(count / columns)
+	} else if (rows > 0) {
+		columns = Math.ceil(count / rows)
+	} else {
+		columns = Math.ceil(Math.sqrt(count))
+		rows = Math.ceil(count / columns)
+	}
+
+	const width = (size + pad) * columns + pad
+	const height = (size + pad) * rows + pad
+	const radius = size / 2
+	const data = [...Array(count).keys()].map((index) => ({
+		x: pad + radius + (index % columns) * (size + pad),
+		y: pad + radius + Math.floor(index / columns) * (size + pad),
+		r: radius
+	}))
+
+	return { width, height, data }
+}
+
+/**
+ * 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, patterns, palette) {
+	const result = values
+		.map((value, index) => ({
+			pattern: patterns[index % patterns.length],
+			color: palette[index % palette.length],
+			value
+		}))
+		.reduce(
+			(acc, { value, pattern, color }) => ({
+				...acc,
+				[value]: {
+					id: `${pattern}_${color}`,
+					pattern,
+					color
+				}
+			}),
+			{}
+		)
+	return result
+}

package/src/old_lib/index.js

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

package/src/old_lib/plots.js

@@ -0,0 +1,27 @@
+// skipcq: JS-C1003 - Importing all plots from observablehq/plot
+import * as Plot from '@observablehq/plot'
+
+export function plotter(node, options) {
+	let { data, aes, type, opts } = options
+	// let chart = Plot.lineY(options.data).plot({ grid: true })
+
+	function render() {
+		const chart = Plot[type](data, aes).plot({
+			color: { scheme: 'turbo', range: [0.1, 0.9] },
+			...opts
+		})
+		node.firstChild?.remove() // remove old chart, if any
+		node.append(chart)
+	}
+	render()
+
+	return {
+		update: (input) => {
+			data = input.data
+			aes = input.aes
+			type = input.type
+			opts = input.opts
+			render()
+		}
+	}
+}

package/src/old_lib/swatch.js

@@ -0,0 +1,16 @@
+import { writable } from 'svelte/store'
+import palette from './palette.json'
+// skipcq: JS-C1003 - Importing all patterns
+import * as patterns from '../patterns'
+import { shapes } from '../symbols'
+
+export const swatch = writable({
+	palette,
+	patterns,
+	keys: {
+		gray: ['gray'],
+		color: Object.keys(palette).filter((name) => name !== 'gray'),
+		symbol: shapes,
+		pattern: Object.keys(patterns)
+	}
+})

package/src/old_lib/ticks.js

@@ -0,0 +1,46 @@
+/**
+ * @typedef {Object} TickSteps
+ * @property {number} major - count of major ticks
+ * @property {number} minor - count of minor ticks
+ */
+
+/**
+ * Generate an array of ticks for a given axis and the tick type
+ *
+ * @param {number}    lower - The lower bound of the axis
+ * @param {number}    upper - The upper bound of the axis
+ * @param {TickSteps} steps - The number of steps between major and minor ticks
+ * @param {string}    type  - The type of tick to generate
+ *
+ * @returns {Array} - An array of objects representing the ticks
+ */
+export function ticksByType(lower, upper, steps, type) {
+	if (steps <= 0) return []
+	return Array.from({ length: Math.floor((upper - lower) / steps) + 1 }, (_, i) => ({
+		position: i * steps,
+		label: i * steps,
+		type
+	})).filter((tick) => tick.position > lower && tick.position < upper)
+}
+
+/**
+ * Generate an array of ticks for a given axis
+ *
+ * @param {number}    lower - The lower bound of the axis
+ * @param {number}    upper - The upper bound of the axis
+ * @param {TickSteps} steps - The number of steps between major and minor ticks
+ *
+ * @returns {Array} - An array of objects representing the ticks
+ */
+export function getTicks(lower, upper, steps = { major: 10, minor: 0 }) {
+	const majorTicks = ticksByType(lower, upper, steps.major, 'major')
+	const minorTicks = ticksByType(lower, upper, steps.minor, 'minor').filter(
+		(tick) => !majorTicks.find((major) => major.position === tick.position)
+	)
+	const end = [
+		{ position: upper, label: upper, type: 'end' },
+		{ position: lower, label: lower, type: 'end' }
+	]
+
+	return [...minorTicks, ...majorTicks, ...end].sort((a, b) => a.position - b.position)
+}