Merge pull request #627 from vizzuhq/add-dimension-contiguous

Add isContiguous to dimension

Author: schaumb

CHANGELOG.md

@@ -24,6 +24,7 @@
 - Move split align sort and reverse to AxisChannel
 - Add new sorting strategy: 'byLabel'.
 - Enable split and align on mainAxis.
+- Add 'isContiguous' property for dimension series
 
 ## [0.16.0] - 2024-11-28
 

src/apps/weblib/cinterface.cpp

@@ -298,14 +298,16 @@ void data_addDimension(APIHandles::Chart chart,
     const char **categories,
     std::uint32_t categoriesCount,
     const std::uint32_t *categoryIndices,
-    std::uint32_t categoryIndicesCount)
+    std::uint32_t categoryIndicesCount,
+    bool isContiguous)
 {
 	Interface::getInstance().addDimension(chart,
 	    name,
 	    categories,
 	    categoriesCount,
 	    categoryIndices,
-	    categoryIndicesCount);
+	    categoryIndicesCount,
+	    isContiguous);
 }
 
 void data_addMeasure(APIHandles::Chart chart,

src/apps/weblib/cinterface.h

@@ -82,7 +82,8 @@ extern void data_addDimension(APIHandles::Chart chart,
     const char **categories,
     std::uint32_t categoriesCount,
     const std::uint32_t *categoryIndices,
-    std::uint32_t categoryIndicesCount);
+    std::uint32_t categoryIndicesCount,
+    bool isContiguous);
 extern void data_addMeasure(APIHandles::Chart chart,
     const char *name,
     const char *unit,

src/apps/weblib/interface.cpp

@@ -319,13 +319,14 @@ void Interface::addDimension(ObjectRegistryHandle chart,
     const char **categories,
     std::uint32_t categoriesCount,
     const std::uint32_t *categoryIndices,
-    std::uint32_t categoryIndicesCount)
+    std::uint32_t categoryIndicesCount,
+    bool isContiguous)
 {
-	if (categories) {
-		getChart(chart)->getTable().addColumn(name,
-		    {categories, categoriesCount},
-		    {categoryIndices, categoryIndicesCount});
-	}
+	getChart(chart)->getTable().add_dimension(
+	    {categories, categoriesCount},
+	    {categoryIndices, categoryIndicesCount},
+	    name,
+	    {{{"isContiguous", isContiguous ? "true" : "false"}}});
 }
 
 void Interface::addMeasure(ObjectRegistryHandle chart,
@@ -334,22 +335,22 @@ void Interface::addMeasure(ObjectRegistryHandle chart,
     const double *values,
     std::uint32_t count)
 {
-	getChart(chart)->getTable().addColumn(name,
-	    unit,
-	    {values, count});
+	getChart(chart)->getTable().add_measure({values, count},
+	    name,
+	    {{std::pair{"unit", unit}}});
 }
 
 void Interface::addRecord(ObjectRegistryHandle chart,
     const char *const *cells,
     std::uint32_t count)
 {
-	getChart(chart)->getTable().pushRow({cells, count});
+	getChart(chart)->getTable().add_record({cells, count});
 }
 
 const char *Interface::dataMetaInfo(ObjectRegistryHandle chart)
 {
 	thread_local std::string res;
-	res = getChart(chart)->getTable().getInfos();
+	res = getChart(chart)->getTable().as_string();
 	return res.c_str();
 }
 

src/apps/weblib/interface.h

@@ -100,7 +100,8 @@ class Interface
 	    const char **categories,
 	    std::uint32_t categoriesCount,
 	    const std::uint32_t *categoryIndices,
-	    std::uint32_t categoryIndicesCount);
+	    std::uint32_t categoryIndicesCount,
+	    bool isContiguous);
 	void addMeasure(ObjectRegistryHandle chart,
 	    const char *name,
 	    const char *unit,

src/apps/weblib/ts-api/cvizzu.types.d.ts

@@ -103,7 +103,8 @@ export interface CVizzu {
 		categories: CArrayPtr,
 		categoriesCount: number,
 		categoryIndices: CArrayPtr,
-		categoryIndicesCount: number
+		categoryIndicesCount: number,
+		isContiguous: boolean
 	): void
 	_data_addMeasure(
 		chart: CChartPtr,

src/apps/weblib/ts-api/data.ts

@@ -83,19 +83,25 @@ export class Data {
 
 		if (this._isIndexedDimension(series)) {
 			this._validateIndexedDimension(series)
-			this._addDimension(series.name, series.values ?? [], series.categories)
+			this._addDimension(
+				series.name,
+				series.values ?? [],
+				series.categories,
+				series.isContiguous ?? false
+			)
 		} else {
 			const values = series?.values ?? ([] as DataTypes[])
 			const seriesType = series?.type ?? this._detectType(values)
 
-			if (seriesType === 'dimension') {
+			if (this._isDetectedDimension(series, seriesType)) {
 				const { indexes, categories } = this._convertDimension(values)
-				this._addDimension(series.name, indexes, categories)
+				this._addDimension(series.name, indexes, categories, series.isContiguous ?? false)
 			} else if (this._isMeasure(series, seriesType)) {
 				if (!series.unit) series.unit = ''
 				this._addMeasure(series.name, series.unit, values)
 			} else {
-				throw new Error('invalid series type: ' + series.type)
+				const seriesBase = series as D.SeriesBase
+				throw new Error('invalid series type: ' + seriesBase.type)
 			}
 		}
 	}
@@ -107,11 +113,15 @@ export class Data {
 		return true
 	}
 
+	private _isDetectedDimension(series: D.Series, type: string | null): series is D.Dimension {
+		return (
+			type === 'dimension' ||
+			('isContiguous' in series && typeof series.isContiguous === 'boolean')
+		)
+	}
+
 	private _isMeasure(series: D.Series, type: string | null): series is D.Measure {
-		if (type === 'measure' || ('unit' in series && typeof series.unit === 'string')) {
-			return true
-		}
-		return false
+		return type === 'measure' || ('unit' in series && typeof series.unit === 'string')
 	}
 
 	private _validateIndexedDimension(series: D.IndexDimension): void {
@@ -151,7 +161,12 @@ export class Data {
 		return null
 	}
 
-	private _addDimension(name: string, indexes: number[], categories: string[]): void {
+	private _addDimension(
+		name: string,
+		indexes: number[],
+		categories: string[],
+		isContiguous: boolean
+	): void {
 		if (typeof name !== 'string') {
 			throw new Error('first parameter should be string')
 		}
@@ -164,6 +179,10 @@ export class Data {
 			throw new Error('third parameter should be an array')
 		}
 
+		if (typeof isContiguous !== 'boolean') {
+			throw new Error('fourth parameter should be boolean')
+		}
+
 		if (!this._isStringArray(categories)) {
 			throw new Error('third parameter should be an array of strings')
 		}
@@ -172,7 +191,7 @@ export class Data {
 			throw new Error('the measure index array element should be number')
 		}
 
-		this._cData.addDimension(name, indexes, categories)
+		this._cData.addDimension(name, indexes, categories, isContiguous)
 	}
 
 	private _isStringArray(values: unknown[]): values is string[] {

src/apps/weblib/ts-api/module/cdata.ts

@@ -35,11 +35,15 @@ export class CData extends CObject {
 		return { series: JSON.parse(info) }
 	}
 
-	addDimension(name: string, indexes: number[], categories: string[]): void {
+	addDimension(
+		name: string,
+		indexes: number[],
+		categories: string[],
+		isContiguous: boolean
+	): void {
 		const categoriesPointer = new Uint32Array(categories.length)
 		for (let i = 0; i < categories.length; i++) {
-			const categoryPointer = this._toCString(categories[i]!)
-			categoriesPointer[i] = categoryPointer
+			categoriesPointer[i] = this._toCString(categories[i]!)
 		}
 
 		const categoriesPointerArrayLen = categories.length * 4
@@ -66,7 +70,8 @@ export class CData extends CObject {
 				categoriesPtrArr,
 				categories.length,
 				indexesArr,
-				indexes.length
+				indexes.length,
+				isContiguous
 			)
 		} finally {
 			this._wasm._free(cname)

src/apps/weblib/typeschema-api/data.yaml

@@ -69,6 +69,11 @@ definitions:
                 type: array
                 items:
                     $ref: DimensionValue
+            isContiguous:
+                description: |
+                    If set to true, the dimension handled as a contiguous dimension 
+                    like timestamps.
+                type: boolean
 
     IndexDimension:
         $extends: SeriesBase
@@ -97,6 +102,11 @@ definitions:
                 type: array
                 items:
                     type: number
+            isContiguous:
+                description: |
+                    If set to true, the dimension handled as a contiguous dimension 
+                    like timestamps.
+                type: boolean
         required: [categories]
 
     ImplicitStringDimension:
@@ -238,7 +248,11 @@ definitions:
             length:
                 description: Count of values in the series.
                 type: number
-        required: [type, categories, length]
+            isContiguous:
+                description: |
+                    The dimension handled as a contiguous dimension like timestamps.
+                type: boolean
+        required: [type, categories, length, isContiguous]
 
     MeasureInfo:
         $extends: SeriesBase

src/base/conv/auto_json.h

@@ -336,11 +336,15 @@ struct JSONObj : protected JSONRepeat<'{', '}'>
 		return std::move(*this);
 	}
 
-	template <class T> JSONObj &&mergeObj(const T &obj) &&
+	template <bool isStatic = true, class T>
+	JSONObj &mergeObj(const T &obj)
 	{
 		auto pre_size = json.size();
 
-		staticObj(obj);
+		if constexpr (isStatic)
+			staticObj(obj);
+		else
+			dynamicObj(obj);
 
 		json.pop_back();
 
@@ -351,7 +355,7 @@ struct JSONObj : protected JSONRepeat<'{', '}'>
 		else
 			was = true;
 
-		return std::move(*this);
+		return *this;
 	}
 };