Web SDK documentation
  1. Injectables
  2. DataGridService

File

core/data-grid/data-grid.service.ts

Index

Properties
Methods

Constructor

constructor(userPreferencesService: UserPreferencesService)
Parameters :
Name Type Optional
userPreferencesService UserPreferencesService No

Methods

applyConfigToColumns
applyConfigToColumns(config: GridConfig, columns: Column[], storageKey?: string)
Parameters :
Name Type Optional
config GridConfig No
columns Column[] No
storageKey string Yes
Returns : Column[]
clearConfig
clearConfig(key: string)
Parameters :
Name Type Optional
key string No
Returns : void
getConfig
Use getConfig$(key: string): Observable instead.
getConfig(key: string)
Parameters :
Name Type Optional
key string No
Returns : GridConfig
getConfig$
getConfig$(key: string)
Parameters :
Name Type Optional
key string No
Returns : Observable<GridConfig>
getQueryObj
getQueryObj(columns: Column[], defaultFilter: object)
Parameters :
Name Type Optional Default value
columns Column[] No
defaultFilter object No {}
Returns : any
getUserConfiguredColumns
Use getUserConfiguredColumns$(Column[] | Observable, string) instead.
getUserConfiguredColumns(columns: Column[], storageKey?: string)
Parameters :
Name Type Optional
columns Column[] No
storageKey string Yes
Returns : {}
getUserConfiguredColumns$
getUserConfiguredColumns$(columns: Column[] | Observable<Column[]>, storageKey?: string)
Parameters :
Name Type Optional
columns Column[] | Observable<Column[]> No
storageKey string Yes
Returns : any
saveConfig
Use saveConfig$(config: GridConfig, key: string): Promise instead.
saveConfig(config: GridConfig, key: string)
Parameters :
Name Type Optional
config GridConfig No
key string No
Returns : void
saveConfig$
saveConfig$(config: GridConfig, key: string)
Parameters :
Name Type Optional
config GridConfig No
key string No
Returns : Observable<GridConfig>

Properties

Protected DEFAULT_PAGE_SIZE
Type : number
Default value : 20
Protected queriesUtil
Type : QueriesUtil

results matching ""

    No results matching ""