@sassoftware/vi-api 1.40.4 → 1.44.0

package/init/index.js

@@ -3,8 +3,9 @@ export const ERR_EXISTING_APP_DECLARED = (appName) => `App: '${appName}' has alr
 export const ERR_EXISTING_RESOURCE_BUNDLE_DECLARED = (appName) => `I18n resource bundle: '${appName}' has already been declared.`;
 export const ERR_INIT_TIMEOUT = (name, timeout) => `Ready check for '${name}' timed out after ${timeout ?? APP_INIT_TIMEOUT_MS}ms.`;
 /**
- * Initialisation events for the Visual Investigator application.
- * These can be awaited using window.sas.viInit.whenReady
+ * Initialization events for the Visual Investigator application.
+ *
+ * These can be awaited using `window.sas.viInit.whenReady`
  */
 export var SviInitEvent;
 (function (SviInitEvent) {

package/init/package.json

@@ -4,6 +4,6 @@
         "**/*.d.ts",
         "**/*.js"
     ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
+    "main": "index.js",
+    "types": "index.d.ts"
 }

package/localization/localization-api.d.ts

@@ -1,6 +1,10 @@
 /**
  * This API is used for the localization methods.
- * Accessed from the window at window.sas.vi.localization.
+ *
+ * Accessed from the window at `window.sas.vi.localization`.
+ *
+ * @example window.sas.vi.localization.getLocale();
+ * @category API
  */
 export interface LocalizationApi {
     /**
@@ -16,6 +20,13 @@ export interface LocalizationApi {
      * @returns The current application locale.
      */
     getLocale(): string;
+    /**
+     * @method
+     * @description Gets user's preferred locale format in BCP 47 format. This should be used
+     * to format dates\numbers in VI extensions but not to drive the language.
+     * @returns The user's preferred locale format.
+     */
+    getFormatLocale(): string;
     /**
      * @method
      * @description Gets the application display direction.
@@ -30,7 +41,11 @@ export interface LocalizationApi {
 }
 /**
  * This API is used for solution content localization.
- * Accessed from the window at window.sas.vi.localization.solution.
+ *
+ * Accessed from the window at `window.sas.vi.localization.solution`.
+ *
+ * @example window.sas.vi.metadata.getLocalizationBundle();
+ * @category API
  */
 export interface SolutionLocalizationApi {
     /**
@@ -52,7 +67,7 @@ export interface SolutionLocalizationApi {
      * @returns The localized value for the given resource key, else undefined.
      * @param resourceKey {string} A resource key used to lookup the localized value.
      * @example
-     * getLocalizedResource("colours.red.txt") === "rouge"
+     * getLocalizedResource("colors.red.txt") === "rouge"
      */
     getLocalizedResource(resourceKey: string): string | undefined;
     /**
@@ -64,7 +79,7 @@ export interface SolutionLocalizationApi {
      * @param resourceKey {string} A resource key used to lookup the localized value.
      * @returns The localized string.
      * @example
-     * localize("red", "colours.red.txt") === "rouge"
+     * localize("red", "colors.red.txt") === "rouge"
      */
     localize(str: string, resourceKey?: string): string;
     /**
@@ -76,7 +91,7 @@ export interface SolutionLocalizationApi {
      * @param props {Record<string, string | undefined>} The properties to localize and their resource keys.
      * @returns The localized object.
      * @example
-     * localizeObject({ label: "red" }, { "label": "colours.red.txt" }) === { label: "rouge" }
+     * localizeObject({ label: "red" }, { "label": "colors.red.txt" }) === { label: "rouge" }
      */
     localizeObject<T extends object>(obj: T, props: Record<string, string | undefined>): T;
     /**
@@ -89,7 +104,7 @@ export interface SolutionLocalizationApi {
      * @example
      *  localizeList(
      *      [{ id: "red", label: "Red" }, { id: "blue", label: "Blue"} ],
-     *      (item) => ({ "label": `colours.${item.id}.title` })
+     *      (item) => ({ "label": `colors.${item.id}.title` })
      *  ) === [{ id: "red", label: "Rouge" }, { id: "blue", label: "Bleu"} ]
      */
     localizeList<T extends object>(list: T[], getProps: (obj: T) => Record<string, string | undefined>): T[];
@@ -98,9 +113,9 @@ export interface SolutionLocalizationApi {
  * Stores localized strings by key and value.
  * @example
  *  {
- *      bykey: {
- *          "colours.red.label": "rouge",
- *          "colours.blue.label": "bleu"
+ *      byKey: {
+ *          "colors.red.label": "rouge",
+ *          "colors.blue.label": "bleu"
  *      },
  *      byValue: {
  *          "red": "rouge",

package/localization/package.json

@@ -4,6 +4,6 @@
         "**/*.d.ts",
         "**/*.js"
     ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
+    "main": "index.js",
+    "types": "index.d.ts"
 }

package/metadata/admin/admin-metadata-api.d.ts

@@ -5,8 +5,12 @@ export interface FieldTypeLabels {
 /**
  * {@link MetadataApi} extension provides the functionality related to retrieval of metadata.
  * Additional methods are available only in the SAS Visual Investigator Manage and Investigate interface.
- * Accessed from the window at window.sas.vi.metadata.
+ *
+ * Accessed from the window at `window.sas.vi.metadata`.
+ *
  * @extends MetadataApi
+ * @example window.sas.vi.metadata.getFieldDataTypeLabels();
+ * @category API
  */
 export interface AdminMetadataApi extends MetadataApi {
     /**

package/metadata/admin/index.d.ts

@@ -0,0 +1 @@
+export * from "./admin-metadata-api";

package/metadata/admin/index.js

@@ -0,0 +1 @@
+export * from "./admin-metadata-api";

package/metadata/metadata-api.d.ts

@@ -147,7 +147,11 @@ export interface ReferenceDataOptions {
 }
 /**
  * This API provides the functionality related to retrieval of metadata.
- * Accessed from the window at window.sas.vi.metadata.
+ *
+ * Accessed from the window at `window.sas.vi.metadata`.
+ *
+ * @example window.sas.vi.metadata.getEntityAccessRules(objectType);
+ * @category API
  */
 export interface MetadataApi {
     /**
@@ -160,7 +164,7 @@ export interface MetadataApi {
     /**
      * @method
      * @description Gets create, read, and update access rights for the provided entities via batch call.
-     * @param objectType {string[]} Entity names.
+     * @param {string[]} objectTypes Entity names.
      * @returns Object with a Promise of type EntityAccessRule[] for each rule, where EntityAccessRule maps to the access rule of a given entity name.
      */
     getEntitiesAccessRules(objectTypes: string[]): EntitiesAccessRules;
@@ -233,7 +237,7 @@ export interface MetadataApi {
      */
     getIconForEntity(objectType: string, iconType?: string): string | undefined;
     /**
-     * @deprecated Use `getRootTypes()` and `getResolvedEntities()` instead.
+     * @deprecated Use [getRootTypes()]{@link getRootTypes} and [getResolvedEntities()]{@link getResolvedEntities}` instead.
      *
      * @method
      * @description Gets metadata for both entities and resolved entities.
@@ -243,8 +247,8 @@ export interface MetadataApi {
     /**
      * @method
      * @description Gets reference data with the given name.
-     * @param refDataName {string} Reference data list name.
-     * @param [options] {ReferenceDataOptions} Object containing name and filter constraints.
+     * @param {string} name Reference data list name.
+     * @param {ReferenceDataOptions} [options] Object containing name and filter constraints.
      * If constrainingListName is defined, then the refDataName parameter is ignored.
      * parentCode is used to filter list items to those that are children of this list name.
      * @returns Promise containing the reference data or undefined if none exists.

package/metadata/package.json

@@ -4,6 +4,6 @@
         "**/*.d.ts",
         "**/*.js"
     ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
+    "main": "index.js",
+    "types": "index.d.ts"
 }

package/object/object-api.d.ts

@@ -36,7 +36,11 @@ export interface CreateObjectOptions {
 }
 /**
  * This API provides the functionality related to objects within SAS Visual Investigator.
- * Accessed from the window at window.sas.vi.object.
+ *
+ * Accessed from the window at `window.sas.vi.object`.
+ *
+ * @example window.sas.vi.object.getObjectAccessRules(objectType, objectId);
+ * @category API
  */
 export interface ObjectApi {
     /**
@@ -59,19 +63,20 @@ export interface ObjectApi {
      * @param objectType {string} Object type.
      * @param objectId {string} Object ID.
      * @param [includeDisplayLabel = true] {boolean} Checks whether or not to return the object with a display label.
+     * @param [includeChildObjects = false] {boolean} Checks whether or not to return the child objects associated with this object.
      * @return The specified object.
      */
-    getObject(objectType: string, objectId: string, includeDisplayLabel?: boolean): Promise<VIObject>;
+    getObject(objectType: string, objectId: string, includeDisplayLabel?: boolean, includeChildObjects?: boolean): Promise<VIObject>;
     /**
      * @method
      * @description Gets the child objects of an object.
      * @param objectType {string} Object type.
      * @param objectId {string} Gets the child objects relating to the object ID.
      * @param childObjectType {string} Child object type.
-     * @param [maxResponses = 25] {number} Maximum number of child objects to be returned.
+     * @param [limit = 25] {number} Maximum number of child objects to be returned.
      * @return A Promise that resolves to an array of objects, that are child objects of the specified object.
      */
-    getChildObjects(objectType: string, objectId: string, childObjectType: string, maxResponses?: number): Promise<VIObject[]>;
+    getChildObjects(objectType: string, objectId: string, childObjectType: string, limit?: number): Promise<VIObject[]>;
     /**
      * @method
      * @description Updates an existing object with the provided data.
@@ -93,10 +98,11 @@ export interface ObjectApi {
      * @param objectTypeVersion {number} Object type version.
      * @param originalFieldValues {FieldValues} Field values before the object was edited
      * @param newFieldValues {FieldValues} Field values after the object was edited
+     * @param objectVersion {number} Object Version
      * @param [options] {UpdateObjectOptions} Optional extra parameters.
      * @return A Promise that resolves to the updated object when the object has successfully been updated.
      */
-    patchObject(objectType: string, objectId: string, objectTypeId: number, objectTypeVersion: number, originalFieldValues: FieldValues, newFieldValues: FieldValues, options?: UpdateObjectOptions): Promise<VIObject>;
+    patchObject(objectType: string, objectId: string, objectTypeId: number, objectTypeVersion: number, originalFieldValues: FieldValues, newFieldValues: FieldValues, objectVersion: number, options?: UpdateObjectOptions): Promise<VIObject>;
     /**
      * @method
      * @description Deletes an object.
@@ -211,8 +217,8 @@ export interface ObjectApi {
     /**
      * @method
      * @description Validates the fields, controls, and file categories of a child object.
-     * @param pageModel {PageModel} Page model.
-     * @param childObject {StoredObjectMetadata} Child object metadata.
+     * @param {PageModel} model Page model.
+     * @param {StoredObjectMetadata} childObject Child object metadata.
      * @return An observable that resolves to an array of validation results.
      */
     validate(model: PageModel, childObject: StoredObjectMetadata): Promise<ValidationResult[]>;
@@ -547,10 +553,10 @@ export interface CreateDialogModel extends CreateRelationshipDialogModel<CreateD
 export interface CreateDialogResponse {
     relateToModel?: CreateRelateToModel;
 }
-export interface CreateReleationshipDialogResultModel {
+export interface CreateRelationshipDialogResultModel {
     linkReason?: Relationship;
 }
-export interface CreateRelateToModel extends CreateReleationshipDialogResultModel {
+export interface CreateRelateToModel extends CreateRelationshipDialogResultModel {
     newPageModel?: {
         model: PageModel;
     };

package/object/package.json

@@ -4,6 +4,6 @@
         "**/*.d.ts",
         "**/*.js"
     ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
+    "main": "index.js",
+    "types": "index.d.ts"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sassoftware/vi-api",
-  "version": "1.40.4",
+  "version": "1.44.0",
   "description": "Types used in the SAS Visual Investigator API",
   "keywords": [
     "SAS",
@@ -28,8 +28,8 @@
     "./README.md",
     "./LICENSE.txt"
   ],
-  "main": "public-api.js",
-  "types": "public-api.d.ts",
+  "main": "index.js",
+  "types": "index.d.ts",
   "peerDependencies": {
     "@types/angular": "^1.7.3",
     "@types/angular-resource": "^1.5.16"

package/page-admin/package.json

@@ -4,6 +4,6 @@
         "**/*.d.ts",
         "**/*.js"
     ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
+    "main": "index.js",
+    "types": "index.d.ts"
 }

package/page-admin/page-admin-api.d.ts

@@ -10,7 +10,11 @@ export declare enum TemplateType {
 }
 /**
  * This API provides administration functionality related to pages.
- * Accessed from the window at window.sas.vi.pageAdmin.
+ *
+ * Accessed from the window at `window.sas.vi.pageAdmin`.
+ *
+ * @example window.sas.vi.pageAdmin.registerPageType(...);
+ * @category API
  */
 export interface PageAdminApi {
     /**

package/page-model/package.json

@@ -4,6 +4,6 @@
         "**/*.d.ts",
         "**/*.js"
     ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
+    "main": "index.js",
+    "types": "index.d.ts"
 }

package/page-model/page-model-api.d.ts

@@ -149,7 +149,7 @@ export interface IPageEventData {
 /**
  * Page model events which can have pre-event or post-event hooks.
  */
-export declare const enum HookablePageEvents {
+export declare enum HookablePageEvents {
     /**
      * A pagemodel is being saved as an object.
      */
@@ -159,15 +159,13 @@ export interface IPageEvent<T extends IPageEventData> {
     /**
      * @method
      * @description Adds a hook to be executed before a hookable event is triggered.
-     * @param event {string} the event to hook onto.
-     * @param hook {IPrePageEventHook} the hook which defines the callback to run pre-event.
+     * @param {IPrePageEventHook} hook the hook which defines the callback to run pre-event.
      */
     addPreHook(hook: IPrePageEventHook<T>): PageEventHookRemove;
     /**
      * @method
      * @description Adds a hook to be executed after a hookable event is triggered.
-     * @param event {string} the event to hook onto.
-     * @param hook {IPostPageEventHook} the hook which defines the callback to run post-event.
+     * @param {IPostPageEventHook} hook the hook which defines the callback to run post-event.
      */
     addPostHook(hook: IPostPageEventHook<T>): PageEventHookRemove;
     /**
@@ -205,7 +203,10 @@ export interface PageEventsApi extends PageEventsApiBase {
 }
 /**
  * This API is used for PageModel utilities.
- * Accessed from the window at window.sas.vi.pageModel.
+ * Accessed from the window at `window.sas.vi.pageModel`.
+ *
+ * @example window.sas.vi.pageModel.createFromObject(partialPageModel);
+ * @category API
  */
 export interface PageModelApi {
     /**

package/page-model/page-model-api.js

@@ -5,6 +5,16 @@ export var PageMode;
     PageMode["View"] = "view";
     PageMode["Design"] = "design";
 })(PageMode || (PageMode = {}));
+/**
+ * Page model events which can have pre-event or post-event hooks.
+ */
+export var HookablePageEvents;
+(function (HookablePageEvents) {
+    /**
+     * A pagemodel is being saved as an object.
+     */
+    HookablePageEvents["SaveObject"] = "svi:hookable:pagemodel:saveObject";
+})(HookablePageEvents || (HookablePageEvents = {}));
 /**
  * @typedef {object} PageModelApi~CreateFromObjectOptions
  * @property [clone] {boolean} Whether or not to clone the page model data or use the referenced values.

package/page-state/package.json

@@ -4,6 +4,6 @@
         "**/*.d.ts",
         "**/*.js"
     ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
+    "main": "index.js",
+    "types": "index.d.ts"
 }

package/page-state/page-state-api.d.ts

@@ -13,7 +13,10 @@ export interface ObjectPageDesignerState {
 }
 /**
  * This API provides functionality that pertains to the page state.
- * Accessed from the window at window.sas.vi.pageState.
+ * Accessed from the window at `window.sas.vi.pageState`.
+ *
+ * @example window.sas.vi.pageState.getCurrent();
+ * @category API
  */
 export interface PageStateApi {
     /**

package/page-template/package.json

@@ -4,6 +4,6 @@
         "**/*.d.ts",
         "**/*.js"
     ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
+    "main": "index.js",
+    "types": "index.d.ts"
 }

package/page-template/page-template-api.d.ts

@@ -2,7 +2,11 @@ import { Template, TemplateResourceSummary } from "../svi-datahub";
 import { ApplicationType, TemplateType } from "../page-admin/page-admin-api";
 /**
  * This API provides functionality that pertains to the page templates.
- * Accessed from the window at window.sas.vi.pageTemplate.
+ *
+ * Accessed from the window at `window.sas.vi.pageTemplate`.
+ *
+ * @example window.sas.vi.pageTemplate.getPageTemplateById(templateNumber);
+ * @category API
  */
 export interface PageTemplateApi {
     /**

package/property/package.json

@@ -4,6 +4,6 @@
         "**/*.d.ts",
         "**/*.js"
     ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
+    "main": "index.js",
+    "types": "index.d.ts"
 }

package/property/property-api.d.ts

@@ -39,7 +39,7 @@ export type ControlPropertyLocalizer = ToolbarControlPropertyLocalizer | PageCon
 export interface ToolbarControlPropertyLocalizer extends PropertyLocalizer<EntityToolbarItem> {
     localizerType: "toolbar";
     /**
-     * Generate resources to be inluded when the toolbar item is saved.
+     * Generate resources to be included when the toolbar item is saved.
      *
      * @param propertyKey the control attribute
      * @param control the toolbar item
@@ -106,7 +106,11 @@ export interface EditorApi {
 }
 /**
  * This API pertains to page/toolbar control properties in SAS Visual Investigator.
- * Accessed from the window at window.sas.vi.property.
+ *
+ * Accessed from the window at `window.sas.vi.property`.
+ *
+ * @example window.sas.vi.property.registerPropertyLocalizer(localizer);
+ * @category API
  */
 export interface PropertyApi {
     /**

package/reference-data/package.json

@@ -4,6 +4,6 @@
         "**/*.d.ts",
         "**/*.js"
     ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
+    "main": "index.js",
+    "types": "index.d.ts"
 }

package/reference-data/refData.d.ts

@@ -37,8 +37,11 @@ export interface LocalizedLabel extends PersistableObject {
 }
 /**
  * This API provides functionality related to retrieving reference data.
- * Accessed from the window at window.sas.vi.refData.
  *
+ * Accessed from the window at `window.sas.vi.refData`.
+ *
+ * @example window.sas.vi.refData.getReferenceLists();
+ * @category API
  */
 export interface RefDataApi {
     /**

package/resource/package.json

@@ -4,6 +4,6 @@
         "**/*.d.ts",
         "**/*.js"
     ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
+    "main": "index.js",
+    "types": "index.d.ts"
 }

package/resource/resource-api.d.ts

@@ -4,7 +4,11 @@ export interface I18nResources {
 /**
  * @deprecated Use window.sas.viInit.registerResourceBundle to register resources before the rest of the SAS Visual Investigator API is ready.
  * This API provides the resource functionality in SAS Visual Investigator.
- * Accessed from the window at window.sas.vi.resource.
+ *
+ * Accessed from the window at `window.sas.vi.resource`.
+ *
+ * @example window.sas.vi.resource.registerResourceBundle("bundleName", resources);
+ * @category API
  */
 export interface ResourceApi {
     /**

package/score-reps/index.d.ts

@@ -1,6 +1,6 @@
 /* tslint:disable */
 /* eslint-disable */
-// Generated using typescript-generator version 2.15.527 on 2024-05-17 15:11:01.
+// Generated using typescript-generator version 2.15.527 on 2024-10-22 14:13:02.
 
 export interface BaseRep extends TrackedResource {
     links?: Link[];
@@ -55,6 +55,12 @@ export interface EntityElementsRep {
     version?: number;
 }
 
+export interface ScorecardConstants {
+}
+
+export interface Length {
+}
+
 export interface ScorecardDefinitionRep extends BaseRep {
     currentTableName?: string;
     domainId?: string;
@@ -86,7 +92,7 @@ export interface ScorecardSummaryRep extends BaseRep {
     effectiveTimeStamp?: string;
 }
 
-export interface Link extends Serializable {
+export interface Link extends Serializable, Comparable<Link> {
     method?: string;
     rel?: string;
     href?: string;
@@ -117,6 +123,9 @@ export interface TimeTrackedResource extends LastModifiedProviderFromModifiedTim
 export interface ETagAndLastModifiedProvider extends ETaggable, LastModifiedProvider {
 }
 
+export interface Comparable<T> {
+}
+
 export interface Preconditionable {
 }
 

package/score-reps/package.json

@@ -1,5 +1,5 @@
 {
   "name": "@types/score-reps",
-  "version": "6.0.5",
+  "version": "7.4.4",
   "types": "index.d.ts"
 }

package/search/client/client-search-api.d.ts

@@ -1,5 +1,5 @@
 import { MapBoundedBoxFilter, MapBoundedPolygonFilter, MapRadiusFilter, MapShapeFilter, QueryMode, SearchRepresentation, SearchResponse, SummaryVisualizationResponse } from "../../svi-sand";
-import { CreateRelationshipDialogModel, CreateReleationshipDialogResultModel, ObjectIdentifier, SearchOrCreateAndLinkDialogBase } from "../../object/object-api";
+import { CreateRelationshipDialogModel, CreateRelationshipDialogResultModel, ObjectIdentifier, SearchOrCreateAndLinkDialogBase } from "../../object/object-api";
 import { QueryBuilderModel, SearchApi } from "../search-api";
 export declare enum SearchVisualization {
     Summary = "summary",
@@ -53,7 +53,7 @@ export interface SearchObject extends ObjectIdentifier {
     typeLabel?: string;
     uniqueKey?: string;
 }
-export interface SearchAndCreateRelateToModel extends CreateReleationshipDialogResultModel {
+export interface SearchAndCreateRelateToModel extends CreateRelationshipDialogResultModel {
     relateToTargetId?: string;
     relateToTargetType?: string;
 }
@@ -63,8 +63,12 @@ export interface SearchAndCreateResponse {
 /**
  * {@link SearchApi} extension pertains to functionality related to SAS Visual Investigator's search capabilities.
  * These additional methods are available only in the SAS Visual Investigator Investigate and Search interface.
- * Accessed from the window at window.sas.vi.search.
+ *
+ * Accessed from the window at `window.sas.vi.search`.
+ *
  * @extends SearchApi
+ * @example window.sas.vi.search.navigateSearch("query text", "map");
+ * @category API
  */
 export interface ClientSearchApi extends SearchApi {
     /**

package/search/client/index.d.ts

@@ -0,0 +1 @@
+export * from "./client-search-api";

package/search/client/index.js

@@ -0,0 +1 @@
+export * from "./client-search-api";

package/search/package.json

@@ -4,6 +4,6 @@
         "**/*.d.ts",
         "**/*.js"
     ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
+    "main": "index.js",
+    "types": "index.d.ts"
 }

package/search/search-api.d.ts

@@ -45,7 +45,11 @@ export interface QueryBuilderResult {
 }
 /**
  * This API relates to SAS Visual Investigator's search functionality.
- * Accessed from the window at window.sas.vi.search.
+ *
+ * Accessed from the window at `window.sas.vi.search`.
+ *
+ * @example window.sas.vi.search.openQueryBuilderDialog("Dialog Title");
+ * @category API
  */
 export interface SearchApi {
     /**

package/sheet/package.json

@@ -4,6 +4,6 @@
         "**/*.d.ts",
         "**/*.js"
     ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
+    "main": "index.js",
+    "types": "index.d.ts"
 }

package/sheet/sheet-api.d.ts

@@ -2,7 +2,11 @@ import { ObjectIdentifier, ObjectSheetSettings, VIObject } from "../object/objec
 import { NetworkData, Visualization } from "../search/client/client-search-api";
 /**
  * This API relates to SAS Visual Investigator's sheet functionality.
- * Accessed from the window at window.sas.vi.sheet.
+ *
+ * Accessed from the window at `window.sas.vi.sheet`.
+ *
+ * @example window.sas.vi.sheet.getOpenObjects();
+ * @category API
  */
 export interface SheetApi {
     /**