@spotfire/mods-api - npm Package Compare versions

Comparing version 1.0.0 to 1.1.0

package.json

 {
     "name": "@spotfire/mods-api",
-    "version": "1.0.0",
+    "version": "1.1.0",
     "description": "Mods API.",
@@ -5,0 +5,0 @@ "files": [

visualization-mods/api.d.ts

 /*
- * 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.
- */
+* 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;
@@ -19,4 +19,3 @@
  */
-export declare interface AnalysisProperty<T extends AnalysisPropertyDataType = AnalysisPropertyDataType>
-    extends AnalysisPropertyValue<T> {
+export declare interface AnalysisProperty<T extends AnalysisPropertyDataType = AnalysisPropertyDataType> extends AnalysisPropertyValue<T> {
     /**
@@ -245,2 +244,8 @@ * Set the value of this instance.
     columnCount: number;
+    /**
+     * Gets the unique id for this instance.
+     * The id is stable during the data table life cycle, thus it can be used to store as a reference to this data table in a {@link ModProperty} or {@link AnalysisProperty}.
+     * @version 1.1
+     */
+    id: string;
 }
@@ -256,15 +261,3 @@
      */
-    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";
     /**
@@ -643,3 +636,3 @@ * Gets a value indicating whether the data type is numeric or not, that is,
      * Gets a {@link DataViewCategoricalValue} representing the value of the axis with the specified `axisName`.
-     * This method will throw an error if there is no categorical axis by that name.
+     * This method will throw an error if there is no categorical axis by that name or if the expression is empty.
      * Use {@link DataView.categoricalAxis} to check the current existence of a categorical value.
@@ -651,3 +644,3 @@ * @param axisName - The name of the axis to get the value for.
      * Gets a {@link DataViewContinuousValue} representing the value of the axis with the specified `axisName`.
-     * This method will throw an error if there is no continuous axis by that name.
+     * This method will throw an error if there is no continuous axis by that name or if the expression is empty.
      * Use {@link DataView.continuousAxis} to check the current existence of a continuous value.
@@ -658,2 +651,24 @@ * @param axisName - The name of the axis to get the value for.
     /**
+     * Gets the leaf {@link DataViewHierarchyNode} for the specified axis,
+     * or null for dual mode axes with continuous axis expression.
+     * This method will throw an error for continuous mode axes
+     * or if there is no axis by that name.
+     * @param axisName - The name of the axis
+     * @version 1.1
+     */
+    leafNode(axisName: string): DataViewHierarchyNode | null;
+    /**
+     * Calculates an element id for this row, suitable for identifying rows between data views.
+     * When stable identifiers is not used, only rows in immediately following data view are guaranteed to re-use previous id.
+     * If a row is filtered out in a new data view, this row is thus not guaranteed to yield the same id when it re-appears.
+     *
+     * @note A stable element id is only stable in the current session, thus it should not be stored in the document,
+     * e.g. as a {@link ModProperty} or {@link AnalysisProperty}.
+     * @version 1.1
+     *
+     * @param useStableId - When true, the id will be a (longer) stable id guarranteed to be the same over time.
+     * @param omitAxisNames - Axis names to omit when creating the identifier. Can be used to group multiple elements split by these axes, for example to create animation effects in one data view.
+     */
+    elementId(useStableId?: boolean, omitAxisNames?: string[]): string;
+    /**
      * Gets the {@link DataViewColorInfo} for the row, if a color axis is defined in the mod manifest.
@@ -710,5 +725,3 @@ * The underlying data value can be retrieved by using {@link DataViewRow.categorical}("Color") or {@link DataViewRow.continuous}("Color"), depending on the mode of the color axis.
 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;
 };
@@ -973,3 +986,3 @@
      * Sets the main {@link DataTable} in the Mod visualization.
-     * @param tableName - The name of the {@link DataTable} to be used as main table.
+     * @param tableName - The name or id of the {@link DataTable} to be used as main table.
      */
@@ -1030,2 +1043,8 @@ setMainTable(tableName: string): void;
     index: number;
+    /**
+     * Gets the unique id for this instance.
+     * The id is stable during the page life cycle, thus it can be used to store as a reference to this page in a {@link ModProperty} or {@link AnalysisProperty}.
+     * @version 1.1
+     */
+    id: string;
 }
@@ -1220,2 +1239,7 @@
     /**
+     * Specifies whether the radio button is enabled.
+     * @version 1.1
+     */
+    enabled?: boolean;
+    /**
      * Specifies the value represented by the radio button.
@@ -1296,4 +1320,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>;
 
@@ -1324,3 +1347,3 @@ /**
      */
-    subscribe(callback: (...values: T) => void, onReadError?: (error: string) => void): void;
+    subscribe(callback: (...values: T) => void, onReadError?: (error: string) => void): ReaderSubscription;
     /**
@@ -1342,3 +1365,3 @@ * Read the content once for the readables specified when the reader was created.
      */
-    once(callback: (...values: T) => void, onReadError?: (error: string) => void): void;
+    once(callback: (...values: T) => void, onReadError?: (error: string) => void): ReaderSubscription;
     /**
@@ -1355,2 +1378,15 @@ * Checks if any of the readables have a new value available. If this function returns true,
 /**
+ * Represents a {@link Reader} subscription.
+ * @version 1.1
+ * @public
+ */
+export declare interface ReaderSubscription {
+    /**
+     * Immediately cancel the current subscription.
+     * Neither the callback or the error callback will be invoked afterwards.
+     */
+    cancel(): void;
+}
+
+/**
  * Represents contextual information needed when rendering a Mod, either in the UI or as part of an export.
@@ -1441,5 +1477,3 @@ * @public
      */
-    property<T extends AnalysisPropertyDataType = AnalysisPropertyDataType>(
-        name: string
-    ): ReadableProxy<AnalysisProperty<T>>;
+    property<T extends AnalysisPropertyDataType = AnalysisPropertyDataType>(name: string): ReadableProxy<AnalysisProperty<T>>;
     /**
@@ -1455,3 +1489,3 @@ * Provides access to the {@link Page}s in the Spotfire document.
      * Sets the specified {@link Page} as the active page.
-     * @param name - The name/title of the page to set as active.
+     * @param name - The name/title or id of the page to set as active.
      */
@@ -1565,2 +1599,2 @@ setActivePage(name: string): void;
 
-export {};
+export { }

visualization-mods/schema.json

@@ -159,4 +159,4 @@ {
             "description": "Specifies the version of the Mod JavaScript API used by the code of this Mod. Set the lowest possible version number that the Mod requires to ensure best possible backward compatibility with older Spotfire systems. Using a newer API version than specified will result in runtime errors, even if the current Spotfire system includes that API.",
-            "default": "1.0",
-            "examples": ["1.0"],
+            "default": "1.1",
+            "examples": ["1.0", "1.1"],
             "pattern": "^(.*)$"
@@ -163,0 +163,0 @@ },

No alert changes

Improved metrics

Total package byte prevSize

79788

increased by2.97%

Lines of code

1888

increased by1.78%

No dependency changes