vizzu/dist/presets.d.ts

Vizzu is a free, open-source Javascript/C++ library utilizing a generic dataviz engine that generates many types of charts and seamlessly animates between them. It can be used to create static charts but more importantly it is designed for building animat

// This file is auto-generated by preset-dts-gen.js
// Do not edit this file directly.
// Instead, edit the presets in src/apps/weblib/js-api/presets.js
// and run tools/preset-dts-gen/preset-dts-gen.js to regenerate this file.

interface Preset {
	legend?: 'color'|'lightness'|'size'|null;
	title?: string|null;
	reverse?: boolean;
	sort?: 'none'|'byValue';
}

interface Column extends Preset {
	x: string[]|string;
	y: string[]|string;
}

interface GroupedColumn extends Preset {
	groupedBy: string[]|string;
	x: string[]|string;
	y: string[]|string;
}

interface StackedColumn extends Preset {
	x: string[]|string;
	y: string[]|string;
	stackedBy: string[]|string;
}

interface SplittedColumn extends Preset {
	x: string[]|string;
	y: string[]|string;
	splittedBy: string[]|string;
}

interface PercentageColumn extends Preset {
	x: string[]|string;
	y: string[]|string;
	stackedBy: string[]|string;
}

interface Waterfall extends Preset {
	x: string[]|string;
	y: string[]|string;
}

interface Mekko extends Preset {
	x: string[]|string;
	groupedBy: string[]|string;
	y: string[]|string;
	stackedBy: string[]|string;
}

interface Marimekko extends Preset {
	x: string[]|string;
	groupedBy: string[]|string;
	y: string[]|string;
	stackedBy: string[]|string;
}

interface Bar extends Preset {
	x: string[]|string;
	y: string[]|string;
}

interface GroupedBar extends Preset {
	x: string[]|string;
	groupedBy: string[]|string;
	y: string[]|string;
}

interface StackedBar extends Preset {
	x: string[]|string;
	stackedBy: string[]|string;
	y: string[]|string;
}

interface SplittedBar extends Preset {
	x: string[]|string;
	splittedBy: string[]|string;
	y: string[]|string;
}

interface PercentageBar extends Preset {
	x: string[]|string;
	stackedBy: string[]|string;
	y: string[]|string;
}

interface Lollipop extends Preset {
	x: string[]|string;
	y: string[]|string;
}

interface Scatter extends Preset {
	x: string[]|string;
	y: string[]|string;
	dividedBy: string[]|string;
}

interface Bubbleplot extends Preset {
	x: string[]|string;
	y: string[]|string;
	color: string[]|string;
	size: string[]|string;
	dividedBy: string[]|string;
}

interface Area extends Preset {
	x: string[]|string;
	y: string[]|string;
}

interface StackedArea extends Preset {
	x: string[]|string;
	y: string[]|string;
	stackedBy: string[]|string;
}

interface PercentageArea extends Preset {
	x: string[]|string;
	y: string[]|string;
	stackedBy: string[]|string;
}

interface SplittedArea extends Preset {
	x: string[]|string;
	y: string[]|string;
	splittedBy: string[]|string;
}

interface Stream extends Preset {
	x: string[]|string;
	y: string[]|string;
	stackedBy: string[]|string;
}

interface VerticalStream extends Preset {
	x: string[]|string;
	stackedBy: string[]|string;
	y: string[]|string;
}

interface Violin extends Preset {
	x: string[]|string;
	y: string[]|string;
	splittedBy: string[]|string;
}

interface VerticalViolin extends Preset {
	x: string[]|string;
	splittedBy: string[]|string;
	y: string[]|string;
}

interface Line extends Preset {
	x: string[]|string;
	y: string[]|string;
	dividedBy: string[]|string;
}

interface VerticalLine extends Preset {
	x: string[]|string;
	y: string[]|string;
	dividedBy: string[]|string;
}

interface Pie extends Preset {
	angle: string[]|string;
	by: string[]|string;
}

interface PolarColumn extends Preset {
	angle: string[]|string;
	radius: string[]|string;
}

interface PolarStackedColumn extends Preset {
	angle: string[]|string;
	radius: string[]|string;
	stackedBy: string[]|string;
}

interface VariableRadiusPie extends Preset {
	angle: string[]|string;
	by: string[]|string;
	radius: string[]|string;
}

interface RadialBar extends Preset {
	angle: string[]|string;
	radius: string[]|string;
}

interface RadialStackedBar extends Preset {
	angle: string[]|string;
	stackedBy: string[]|string;
	radius: string[]|string;
}

interface Donut extends Preset {
	angle: string[]|string;
	stackedBy: string[]|string;
}

interface NestedDonut extends Preset {
	angle: string[]|string;
	stackedBy: string[]|string;
	radius: string[]|string;
}

interface PolarScatter extends Preset {
	angle: string[]|string;
	radius: string[]|string;
	dividedBy: string[]|string;
}

interface PolarLine extends Preset {
	angle: string[]|string;
	radius: string[]|string;
	dividedBy: string[]|string;
}

interface Treemap extends Preset {
	size: string[]|string;
	color: string[]|string;
}

interface StackedTreemap extends Preset {
	size: string[]|string;
	dividedBy: string[]|string;
	color: string[]|string;
}

interface Heatmap extends Preset {
	x: string[]|string;
	y: string[]|string;
	lightness: string[]|string;
}

interface Bubble extends Preset {
	size: string[]|string;
	color: string[]|string;
}

interface StackedBubble extends Preset {
	size: string[]|string;
	stackedBy: string[]|string;
	color: string[]|string;
}


/** Collection of factory functions for creating preset chart configs. */
export class Presets {
	constructor();
	column(config: Column): any;
	groupedColumn(config: GroupedColumn): any;
	stackedColumn(config: StackedColumn): any;
	splittedColumn(config: SplittedColumn): any;
	percentageColumn(config: PercentageColumn): any;
	waterfall(config: Waterfall): any;
	mekko(config: Mekko): any;
	marimekko(config: Marimekko): any;
	bar(config: Bar): any;
	groupedBar(config: GroupedBar): any;
	stackedBar(config: StackedBar): any;
	splittedBar(config: SplittedBar): any;
	percentageBar(config: PercentageBar): any;
	lollipop(config: Lollipop): any;
	scatter(config: Scatter): any;
	bubbleplot(config: Bubbleplot): any;
	area(config: Area): any;
	stackedArea(config: StackedArea): any;
	percentageArea(config: PercentageArea): any;
	splittedArea(config: SplittedArea): any;
	stream(config: Stream): any;
	verticalStream(config: VerticalStream): any;
	violin(config: Violin): any;
	verticalViolin(config: VerticalViolin): any;
	line(config: Line): any;
	verticalLine(config: VerticalLine): any;
	pie(config: Pie): any;
	polarColumn(config: PolarColumn): any;
	polarStackedColumn(config: PolarStackedColumn): any;
	variableRadiusPie(config: VariableRadiusPie): any;
	radialBar(config: RadialBar): any;
	radialStackedBar(config: RadialStackedBar): any;
	donut(config: Donut): any;
	nestedDonut(config: NestedDonut): any;
	polarScatter(config: PolarScatter): any;
	polarLine(config: PolarLine): any;
	treemap(config: Treemap): any;
	stackedTreemap(config: StackedTreemap): any;
	heatmap(config: Heatmap): any;
	bubble(config: Bubble): any;
	stackedBubble(config: StackedBubble): any;
}