Options
All
  • Public
  • Public/Protected
  • All
Menu

Module servercache

Index

Variables

enableTableWhitelist

enableTableWhitelist: boolean

primaryKeys

primaryKeys: object

Type declaration

refreshing

refreshing: boolean

storedaccounts

storedaccounts: object

Not for consumer use, please use FetchStoredAccounts()

Type declaration

storeddashboards

storeddashboards: object

Not for consumer use, please use FetchStoredDashboards()

Type declaration

storedmaps

storedmaps: object

Not for consumer use, please use FetchStoredMaps()

Type declaration

storedtables

storedtables: object

Not for consumer use, please use FetchStoredTables()

Type declaration

whiteListedTables

whiteListedTables: string[]

Functions

ColumnType

FetchStoredAccount

  • FetchStoredAccount(accountCode: any): any
  • Parameters

    • accountCode: any

    Returns any

FetchStoredAccounts

  • FetchStoredAccounts(callback?: any): any
  • Parameters

    • Optional callback: any

    Returns any

FetchStoredDashboard

  • FetchStoredDashboard(id: any): any
  • Parameters

    • id: any

    Returns any

FetchStoredDashboards

  • FetchStoredDashboards(callback?: function, includePublicDashboards?: boolean): any
  • Parameters

    • Optional callback: function
    • Default value includePublicDashboards: boolean = false

    Returns any

FetchStoredMap

  • FetchStoredMap(id: any): any
  • Parameters

    • id: any

    Returns any

FetchStoredMaps

  • FetchStoredMaps(callback?: function, includePublicMaps?: boolean): any
  • Populates the client side cache with saved maps optionally returning them using a callback.

    Parameters

    • Optional callback: function

      Function to receive the array of stored maps.

    • Default value includePublicMaps: boolean = false

    Returns any

FetchStoredTable

  • FetchStoredTable(shortTableName: any): any
  • Parameters

    • shortTableName: any

    Returns any

FetchStoredTableById

  • FetchStoredTableById(tableId: any): any
  • Parameters

    • tableId: any

    Returns any

FetchStoredTableByIdPromise

  • FetchStoredTableByIdPromise(longTableId: string): JQueryPromise<StoredTable>
  • Parameters

    • longTableId: string

    Returns JQueryPromise<StoredTable>

FetchStoredTableNamesByTypes

  • FetchStoredTableNamesByTypes(activeOnly?: boolean, types: TableTypes[]): boolean | string[]
  • Parameters

    • Default value activeOnly: boolean = false
    • types: TableTypes[]

    Returns boolean | string[]

FetchStoredTablePromise

  • FetchStoredTablePromise(shortTableName: string, forceRefresh?: boolean): JQueryPromise<StoredTable>
  • Parameters

    • shortTableName: string
    • Optional forceRefresh: boolean

    Returns JQueryPromise<StoredTable>

FetchStoredTables

  • FetchStoredTables(activeOnly?: boolean, includePublicTables?: boolean, tableNamesOnly?: boolean): boolean | any[]
  • Parameters

    • Default value activeOnly: boolean = false
    • Default value includePublicTables: boolean = true
    • Default value tableNamesOnly: boolean = false

    Returns boolean | any[]

GuessTableId

PreprocessTable

  • PreprocessTable(v: any): any
  • Parameters

    • v: any

    Returns any

StoreTable

  • StoreTable(v: any): void
  • Parameters

    • v: any

    Returns void

TablePrimaryKey

  • TablePrimaryKey(tableName: string, id?: string): string
  • Parameters

    • tableName: string
    • Optional id: string

    Returns string

_getSecurityClassification

  • _getSecurityClassification(tags: ITableTag[]): string
  • Parameters

    Returns string

getAccount

  • getAccount(accountCode: string): any
  • Not for consumer use, please use FetchStoredAccount(accountId or ID)

    Parameters

    • accountCode: string

    Returns any

getDashboard

  • getDashboard(id: any): object
  • Not for consumer use, please use FetchStoredTable(shortTableName)

    Parameters

    • id: any

    Returns object

getMap

  • getMap(id: any): any
  • Not for consumer use, please use FetchStoredTable(shortTableName)

    Parameters

    • id: any

    Returns any

getTable

  • Not for consumer use, please use FetchStoredTable(shortTableName)

    Parameters

    • shortTableName: string

    Returns StoredTable

getTableByLongTableId

  • getTableByLongTableId(longTableId: string): StoredTable

getTableTypes

  • Returns the TableTypes enumeration values that this stored table represents.

    Parameters

    Returns Array<TableTypes>

getTablesOfType

getTablesOfTypes

  • Returns all tables in the provided array that represents one of the provided types. If no types are provided, a copy of the tables array will be returned.

    Parameters

    Returns Array<StoredTable>

hasStoredTables

  • hasStoredTables(): boolean
  • Returns boolean

isIStoredTable

  • isIStoredTable(input: any): boolean
  • Parameters

    • input: any

    Returns boolean

subscribeToTableCacheChange

Generated using TypeDoc