Interface DocMixin

interface DocMixin {
    mBuild(arg): Promise<IUnbuildApp>;
    mCloneBookmark(sourceBookmarkId, title, description?, state?): Promise<string>;
    mCreateBookmarkFromMeta(bookmarkMeta, title, description?): Promise<string>;
    mCreateSessionListbox(fieldName, options?): Promise<{
        layout: IGenericBaseLayoutExt;
        obj: IGenericObject;
        props: IGenericObjectPropertiesExt;
        flattenData(): INxCellListBox[];
    }>;
    mExtensionObjectsAll(): Promise<IExtension[]>;
    mGetBookmarkMeta(bookmarkId, state?): Promise<IMBookmarkMeta>;
    mGetBookmarkValues(bookmarkId, state?): Promise<IBookmarkValue[]>;
    mGetBookmarksMeta(state?): Promise<IMBookmarkMeta[]>;
    mGetFields(): Promise<string[]>;
    mGetSyntheticTables(): Promise<ITableRecord[]>;
    mGetTables(): Promise<string[]>;
    mGetTablesAndFields(): Promise<{
        field: string;
        table: string;
    }[]>;
    mSelectInField(): Promise<boolean>;
    mSelectionsAll(): Promise<ISelectionListObject>;
    mSelectionsSimple(): Promise<{
        field: string;
        values: string[];
    }[]>;
    mSelectionsSimpleGrouped(): Promise<{
        field: string;
        value: string;
    }[]>;
    mUnbuild(sections?): Promise<IUnbuildApp>;
    mVariableCreate(name, definition?, comment?): Promise<IGenericVariableProperties>;
    mVariableGetAll(showSession?, showReserved?): Promise<INxVariableListItem[]>;
    mVariableUpdateById(id, name?, definition?, comment?): Promise<IGenericVariableProperties>;
    mVariableUpdateByName(name, newName, definition?, comment?): Promise<IGenericVariableProperties>;
}

Methods

mBuild mCloneBookmark mCreateBookmarkFromMeta mCreateSessionListbox mExtensionObjectsAll mGetBookmarkMeta mGetBookmarkValues mGetBookmarksMeta mGetFields mGetSyntheticTables mGetTables mGetTablesAndFields mSelectInField mSelectionsAll mSelectionsSimple mSelectionsSimpleGrouped mUnbuild mVariableCreate mVariableGetAll mVariableUpdateById mVariableUpdateByName

Methods

mBuild

mCloneBookmark

  • mCloneBookmark(sourceBookmarkId, title, description?, state?): Promise<string>
  • Experimental

    Parameters

    • sourceBookmarkId: string
    • title: string
    • Optional description: string
    • Optional state: string

    Returns Promise<string>

mCreateBookmarkFromMeta

  • mCreateBookmarkFromMeta(bookmarkMeta, title, description?): Promise<string>
  • Experimental

    Parameters

    Returns Promise<string>

mCreateSessionListbox

  • mCreateSessionListbox(fieldName, options?): Promise<{
        layout: IGenericBaseLayoutExt;
        obj: IGenericObject;
        props: IGenericObjectPropertiesExt;
        flattenData(): INxCellListBox[];
    }>

  • Parameters

    • fieldName: string
    • Optional options: {
          destroyOnComplete?: boolean;
          getAllData?: boolean;
          state?: string;
          type?: string;
      }

      Additional options

      • Optional destroyOnComplete?: boolean

        Destroy the session object at the end

      • Optional getAllData?: boolean

        By default the first 10 000 values will be extracted and returned. If need all set this option to true

      • Optional state?: string

        Create the object in specific state. Defaults to $

      • Optional type?: string

        Type of the object. Defaults to session-listbox

    Returns Promise<{
        layout: IGenericBaseLayoutExt;
        obj: IGenericObject;
        props: IGenericObjectPropertiesExt;
        flattenData(): INxCellListBox[];
    }>

mExtensionObjectsAll

mGetBookmarkMeta

mGetBookmarkValues

mGetBookmarksMeta

mGetFields

mGetSyntheticTables

mGetTables

mGetTablesAndFields

  • mGetTablesAndFields(): Promise<{
        field: string;
        table: string;
    }[]>

  • Returns Promise<{
        field: string;
        table: string;
    }[]>

mSelectInField

mSelectionsAll

mSelectionsSimple

  • mSelectionsSimple(): Promise<{
        field: string;
        values: string[];
    }[]>

  • Returns Promise<{
        field: string;
        values: string[];
    }[]>

mSelectionsSimpleGrouped

  • mSelectionsSimpleGrouped(): Promise<{
        field: string;
        value: string;
    }[]>

  • Returns Promise<{
        field: string;
        value: string;
    }[]>

mUnbuild

  • mUnbuild(sections?): Promise<IUnbuildApp>
  • Experimental

    Parameters

    • Optional sections: ("script" | "variables" | "appProperties" | "connections" | "bookmarks" | "measures" | "dimensions" | "objects")[]

    Returns Promise<IUnbuildApp>

mVariableCreate

mVariableGetAll

mVariableUpdateById

  • mVariableUpdateById(id, name?, definition?, comment?): Promise<IGenericVariableProperties>

  • Parameters

    • id: string

      id of the variable to be updated

    • Optional name: string

      variable new name

    • Optional definition: string

      variable new definition (expression)

    • Optional comment: string

      variable new comment

    Returns Promise<IGenericVariableProperties>

mVariableUpdateByName

  • mVariableUpdateByName(name, newName, definition?, comment?): Promise<IGenericVariableProperties>

  • Parameters

    • name: string

      name of the variable to be updates

    • newName: string

      variable new name

    • Optional definition: string

      variable new definition (expression)

    • Optional comment: string

      variable new comment

    Returns Promise<IGenericVariableProperties>

Settings

Member Visibility

Theme

On This Page