Interface ConfigApi

Configuration-related functionality.

Accessed from the window at window.sas.vi.config.

Example

window.sas.vi.config.getSolutions();
interface ConfigApi {
    getAppConfigBundle<T>(appConfigId: string, bundleName: string): Promise<AppConfigBundle<T>>;
    getCurrentVersions(): VersionSummary;
    getEnabledOptionalServices(): Record<string, boolean>;
    getHardExpansionLimit(): Promise<number>;
    getSharedDialogContainer(): HTMLElement;
    getSoftExpansionLimit(): Promise<number>;
    getSolutionExtension(name: string): Promise<undefined | SolutionExtension | HomepageSolutionExtension>;
    getSolutions(): Map<string, Solution>;
    registerDocumentManager(config: SviDocumentManager): void;
    registerOpenConfigurationCallback(bundleName: string, callback: (() => void)): void;
    registerSolution(key: string, label: string, version?: string): void;
    registerSolutionExtension(config: SolutionExtension | HomepageSolutionExtension): Promise<void>;
    updateAppConfigBundle<T>(bundle: AppConfigBundle<T>): Promise<AppConfigBundle<T>>;
}

Methods

getAppConfigBundle getCurrentVersions getEnabledOptionalServices getHardExpansionLimit getSharedDialogContainer getSoftExpansionLimit getSolutionExtension getSolutions registerDocumentManager registerOpenConfigurationCallback registerSolution registerSolutionExtension updateAppConfigBundle

Methods

getAppConfigBundle

  • getAppConfigBundle<T>(appConfigId, bundleName): Promise<AppConfigBundle<T>>

  • Type Parameters

    • T extends object

    Parameters

    • appConfigId: string

      {string} The identifier for the application configuration that the bundle belongs to.

    • bundleName: string

      {string} The name of the configuration bundle.

    Returns Promise<AppConfigBundle<T>>

    Method

    Description

    Send a GET request to retrieve an application configuration bundle.

getCurrentVersions

  • getCurrentVersions(): VersionSummary

  • Returns VersionSummary

    The software version number and the installed version of the API.

    Method

    Description

    Gets the current software version number and API version of the application.

getEnabledOptionalServices

  • getEnabledOptionalServices(): Record<string, boolean>

  • Returns Record<string, boolean>

    A map of service identifiers to their enabled status (true or false).

    Method

    Description

    Get the services which are an optional part of the SAS Visual Investigator deployment.

getHardExpansionLimit

  • getHardExpansionLimit(): Promise<number>

  • Returns Promise<number>

    A Promise containing the hard expansion limit.

    Method

    Description

    Gets the hard expansion limit of the network nodes.

getSharedDialogContainer

  • getSharedDialogContainer(): HTMLElement

  • Returns HTMLElement

    A reference to the HTML element that is the default container for modal dialog boxes to be spawned within the application.

    Method

getSoftExpansionLimit

  • getSoftExpansionLimit(): Promise<number>

  • Returns Promise<number>

    A Promise containing the soft expansion limit.

    Method

    Description

    Gets the soft expansion limit of the network nodes.

getSolutionExtension

getSolutions

  • getSolutions(): Map<string, Solution>

  • Returns Map<string, Solution>

    The currently registered solutions.

    Method

    Description

    Gets the registered solutions and their labels and versions.

registerDocumentManager

  • registerDocumentManager(config): void

  • Parameters

    Returns void

    Method

    Description

    Registers a document manager with the application.

registerOpenConfigurationCallback

  • registerOpenConfigurationCallback(bundleName, callback): void

  • Parameters

    • bundleName: string

      {string} The name of the configuration bundle.

    • callback: (() => void)

      {function(): void} A function which should open a view to allow the user to modify the given configuration bundle.

        • (): void

        • Returns void

    Returns void

    Method

    Description

    Register a callback to override the default action when selecting the configuration bundle in the administration application.

registerSolution

  • registerSolution(key, label, version?): void

  • Parameters

    • key: string

      {string} Unique identifier for the solution.

    • label: string

      {string} Localized name of the solution to be displayed.

    • Optionalversion: string

      {string} Version of the solution.

    Returns void

    Method

    Description

    Registers a new solution and version in the SAS Visual Investigator About dialog box. If a solution with that key already exists it will not be overwritten.

registerSolutionExtension

  • registerSolutionExtension(config): Promise<void>

  • Parameters

    Returns Promise<void>

    A Promise that resolves when the solution has been sent to the cache.

    Method

    Description

    Registers a solution extension with the application.

updateAppConfigBundle

  • updateAppConfigBundle<T>(bundle): Promise<AppConfigBundle<T>>

  • Type Parameters

    • T extends object

    Parameters

    • bundle: AppConfigBundle<T>

      {AppConfigBundle} The updated application configuration bundle.

    Returns Promise<AppConfigBundle<T>>

    A Promise resolving to the saved configuration bundle.

    Method

    Description

    Send a PUT request to save an application configuration bundle.

Settings

Member Visibility

On This Page

Methods