@spotfire/mods-api - npm Package Compare versions

Comparing version 2.1.0-preview.0 to 2.1.0-preview.1

package.json

 {
     "name": "@spotfire/mods-api",
-    "version": "2.1.0-preview.0",
+    "version": "2.1.0-preview.1",
     "description": "API typings and schemas for Spotfire® Mods",
@@ -5,0 +5,0 @@ "files": [

visualization-mods/api.d.ts

@@ -1,12 +0,7 @@
-/**
- * Copyright © 2024 Cloud Software Group, Inc.
- * This file is subject to the license terms contained
- * in the license file that is distributed with this file.
- * 
- * Spotfire Visualization Mods API declaration.
- * Version: 2.0
- */
-
+/*
+* Copyright © 2023. Cloud Software Group, Inc.
+* This file is subject to the license terms contained
+* in the license file that is distributed with this file.
+*/
 export as namespace Spotfire;
-
 /**
@@ -23,4 +18,3 @@ * Predicate to determine if a current read operation for {@link DataView.allRows} should be aborted when there is new, non-streaming, data available. If this predicate returns true the {@link DataView.allRows} promise will be rejected and no rows will be returned.
  */
-export declare interface AnalysisProperty<T extends AnalysisPropertyDataType = AnalysisPropertyDataType>
-    extends AnalysisPropertyValue<T> {
+export declare interface AnalysisProperty<T extends AnalysisPropertyDataType = AnalysisPropertyDataType> extends AnalysisPropertyValue<T> {
     /**
@@ -265,15 +259,3 @@ * Set the value of this instance.
      */
-    name:
-        | "String"
-        | "Integer"
-        | "LongInteger"
-        | "Real"
-        | "SingleReal"
-        | "Currency"
-        | "Boolean"
-        | "Date"
-        | "DateTime"
-        | "Time"
-        | "TimeSpan"
-        | "Binary";
+    name: "String" | "Integer" | "LongInteger" | "Real" | "SingleReal" | "Currency" | "Boolean" | "Date" | "DateTime" | "Time" | "TimeSpan" | "Binary";
     /**
@@ -306,3 +288,3 @@ * Gets a value indicating whether the data type is numeric or not, that is,
  */
-export declare interface DataView {
+declare interface DataView_2 {
     /**
@@ -315,3 +297,3 @@ * Mark a set of rows.
      */
-    mark(rows: DataViewRow[], markingOperation?: MarkingOperation): void;
+    mark(rows: DataViewRow[], operation?: MarkingOperation): void;
     /**
@@ -333,2 +315,7 @@ * Clears the current marking
     /**
+     * Gets a value indicating whether the data view is the result of a streaming update.
+     * @version 2.1
+     */
+    isStreamingUpdate: boolean;
+    /**
      * Gets any errors generated while creating the dataview.
@@ -384,2 +371,3 @@ * Returns empty array if none occurred.
 }
+export { DataView_2 as DataView }
 
@@ -632,3 +620,3 @@ /**
  */
-export declare type DataViewProxy = DataViewProxyMethods & Readable<DataView>;
+export declare type DataViewProxy = DataViewProxyMethods & Readable<DataView_2>;
 
@@ -727,3 +715,3 @@ /**
      * Show error message. Showing any error message will hide the Mods UI.
-     * @param messages - The error message.
+     * @param message - The error message.
      * @param category - Optional error categorization. Useful if multiple error message are to be shown. Error messages will be sorted based on the category.
@@ -744,5 +732,3 @@ */
 export declare type ExtractValueType<readableArray extends ReadonlyArray<Readable<any>>> = {
-    [readableName in keyof readableArray]: readableArray[readableName] extends Readable<infer readableNameType>
-        ? readableNameType
-        : never;
+    [readableName in keyof readableArray]: readableArray[readableName] extends Readable<infer readableNameType> ? readableNameType : never;
 };
@@ -1338,4 +1324,3 @@
  */
-export declare type ReadableProxy<Node> = Readable<Node> &
-    Omit<Pick<Node, MethodKeys<Node>>, OmittedReadableProxyMethods>;
+export declare type ReadableProxy<Node> = Readable<Node> & Omit<Pick<Node, MethodKeys<Node>>, OmittedReadableProxyMethods>;
 
@@ -1352,3 +1337,4 @@ /**
      * Subscribe to changes in the content for the specified readables when the reader was created.
-     * @example Subscribe to changes in the {@link DataView}.
+     * @example
+     * Subscribe to changes in the {@link DataView}.
      *
@@ -1370,3 +1356,4 @@ * ```
      * Any current subscription for this reader will be cancelled.
-     * @example Read content of a mod property once.
+     * @example
+     * Read content of a mod property once.
      *
@@ -1395,3 +1382,4 @@ * ```
      *
-     * @example Check if the data view has changed in the subscribe loop.
+     * @example
+     * Check if the data view has changed in the subscribe loop.
      *
@@ -1520,5 +1508,3 @@ * ```
      */
-    property<T extends AnalysisPropertyDataType = AnalysisPropertyDataType>(
-        name: string
-    ): ReadableProxy<AnalysisProperty<T>>;
+    property<T extends AnalysisPropertyDataType = AnalysisPropertyDataType>(name: string): ReadableProxy<AnalysisProperty<T>>;
     /**
@@ -1525,0 +1511,0 @@ * Provides access to the {@link Page}s in the Spotfire document.

visualization-mods/schema.json

@@ -26,6 +26,7 @@ {
                 "allowNonAggregatingMeasures": {
-                    "type": "boolean",
-                    "title": "Allow non-aggregating measures",
-                    "description": "Specifies if this axis supports non-aggregating expressions (expressions without an aggregation method) when it is in continuous mode.",
-                    "default": false
+                    "type": "string",
+                    "enum": ["no", "yes", "prefer"],
+                    "title": "Non-aggregating measures",
+                    "description": "Specifies if this axis supports non-aggregating expressions (expressions without an aggregation method) when it is in continuous mode, and whether it prefers to have a non-aggregating expression. The default is 'no'.",
+                    "default": "no"
                 },
@@ -39,8 +40,22 @@ "automaticConfiguration": {
                         "expressionHeuristics": {
-                            "type": "string",
                             "title": "Expression heuristics",
-                            "enum": ["none", "default"],
-                            "default": "default",
-                            "description": "Specifies the heuristics to use when this axis is assigned an initial expression. Use 'none' to skip the heuristics and leave this axis with an empty expression."
-                        },
+                            "description": "Specifies the heuristics to use when this axis is assigned an initial expression. Use 'none' to skip the heuristics and leave this axis with an empty expression. Use 'default' to set an expression using Spotfire default heuristics. Use an object with an 'expression' property to set a specified expression.",
+                            "anyOf": [
+                                {
+                                    "type": "string",
+                                    "default": "default",
+                                    "enum": ["none", "default"]
+                                },
+                                {
+                                    "type": "object",
+                                    "examples": [ { "expression": "Count()" }, { "expression": "${Axis.X.Expression}" } ],
+                                    "properties": {
+                                        "expression": {
+                                            "type": "string",
+                                            "description": "The initial expression to set."
+                                        }
+                                    }
+                                }
+                            ]
+                         },
                         "priority": {
@@ -47,0 +62,0 @@ "type": "integer",

No alert changes

Improved metrics

Total package byte prevSize

2655187

increased by0.88%

Lines of code

54866

increased by0.84%

No dependency changes