Interface TabApi

This API provides the functionality related to tabs.

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

Example

window.sas.vi.tab.openTab("objectName", "objectId");
interface TabApi {
    closeTab(objectType: string, objectId: string): Promise<boolean>;
    isOpenTabDirty(objectType: string, objectId: string): boolean;
    openTab(objectType: string, objectId: string, suppressNavigation?: boolean, mode?: PageModeEvent): Promise<void>;
    setOpenTabDirty(objectType: string, objectId: string, dirtyState: boolean): Promise<void>;
}

Methods

closeTab isOpenTabDirty openTab setOpenTabDirty

Methods

closeTab

  • closeTab(objectType, objectId): Promise<boolean>

  • Parameters

    • objectType: string

      {string} Type of the object to be closed.

    • objectId: string

      {string} ID of the object to be closed.

    Returns Promise<boolean>

    A Promise resolving once the tab has been successfully removed (resolves to true) or once the tab could not be removed or found (resolving to false).

    Method

    Description

    Close the tab of a specified object.

isOpenTabDirty

  • isOpenTabDirty(objectType, objectId): boolean

  • Parameters

    • objectType: string

      {string} Tab's object type.

    • objectId: string

      {string} An open tab's object ID.

    Returns boolean

    true/false if the tab is dirty/not.

    Method

    Description

    Checks to see if an open tab is dirty.

openTab

  • openTab(objectType, objectId, suppressNavigation?, mode?): Promise<void>

  • Parameters

    • objectType: string

      {string} Type of the object to be opened.

    • objectId: string

      {string} ID of the object to be opened.

    • OptionalsuppressNavigation: boolean

      {boolean} Allows the tab to be opened without navigating to it.

    • Optionalmode: PageModeEvent

      {PageModeEvent} Mode to open the tab in.

    Returns Promise<void>

    A Promise that resolves when the tab is opened.

    Method

    Description

    Opens the tab of a specified object.

setOpenTabDirty

  • setOpenTabDirty(objectType, objectId, dirtyState): Promise<void>

  • Parameters

    • objectType: string

      {string} Open tab's object type.

    • objectId: string

      {string} Open tab's object ID.

    • dirtyState: boolean

      {boolean} Sets the tab's dirty state.

    Returns Promise<void>

    Method

    Description

    Sets the dirty state of an open tab.

Settings

Member Visibility

On This Page

Methods