import UserSettingsController from 'flexicious-react-datagrid/js/flexgrid/persistence/UserSettingsController.js'UserSettingsController
Extends:
Class responsible for preference persistence.
Static Method Summary
| Static Public Methods | ||
| public static |
instance(): * |
|
Method Summary
| Public Methods | ||
| public |
clearPreferences(userSettingsOptions: *) Clears preferences |
|
| public |
|
|
| public |
getColumnOrder(userSettingsOptions: *): Array Gets the order of columns |
|
| public |
getColumnVisibility(userSettingsOptions: *): * |
|
| public |
getColumnWidths(userSettingsOptions: *): * Gets the widths of the columns |
|
| public |
getCompactPreferencesString(userSettingsOptions: *): String |
|
| public |
getFirstColumn(col: *): * |
|
| public |
getIsColumnOnly(col: *): Boolean |
|
| public |
getLegacyPreferences(userSettingsOptions: *): Array |
|
| public |
getPreferencesString(userSettingsOptions: *): * Gets the preferences string for the supplied grid |
|
| public |
getPropertyValues(userSettingsOptions: *, property: *): Array |
|
| public |
loadPreferences(userSettingsOptions: *) Loads preferences |
|
| public |
parseCompactPreferencesString(userSettingsOptions: *, val: *): Array |
|
| public |
parsePreferences(userSettingsOptions: *, val: *): * |
|
| public |
persistPreferences(userSettingsOptions: *, name: *, isDefault: *) Saves the preferences |
|
| public |
rearrangeColumns(col: *, val: *, userSettingsOptions: *) |
|
| public |
removeUndefined(source: *): Array |
|
| public |
setColumnOrder(userSettingsOptions: *, val: *) Sets the order of columns |
|
| public |
setColumnVisibility(userSettingsOptions: *, val: *) Sets the visibility of the columns |
|
| public |
setColumnWidths(userSettingsOptions: *, val: *) Sets the widths of the columns |
|
| public |
setPreferences(userSettingsOptions: *, arrayCollection: *) Applies previously set preferences.. |
|
| public |
setPropertyValues(userSettingsOptions: *, val: *, property: *) |
|
Inherited Summary
| From class TypedObject | ||
| public |
typeCache: {} |
|
| public |
|
|
| public |
Returns a list of strings that represent the object hierarchy for this object. |
|
| public |
implementsOrExtends(name: *): Boolean Returns true if the class name to check is in the list of class names defined for this class. |
|
Static Public Methods
Public Methods
public clearPreferences(userSettingsOptions: *) source
Clears preferences
Params:
| Name | Type | Attribute | Description |
| userSettingsOptions | * |
public getClassNames(): Array source
Returns a list of strings that represent the object hierarchy for this object.
Override:
TypedObject#getClassNamespublic getColumnOrder(userSettingsOptions: *): Array source
Gets the order of columns
Params:
| Name | Type | Attribute | Description |
| userSettingsOptions | * |
public getColumnVisibility(userSettingsOptions: *): * source
Params:
| Name | Type | Attribute | Description |
| userSettingsOptions | * |
Return:
| * |
public getColumnWidths(userSettingsOptions: *): * source
Gets the widths of the columns
Params:
| Name | Type | Attribute | Description |
| userSettingsOptions | * |
|
Return:
| * |
public getCompactPreferencesString(userSettingsOptions: *): String source
Params:
| Name | Type | Attribute | Description |
| userSettingsOptions | * |
public getLegacyPreferences(userSettingsOptions: *): Array source
Params:
| Name | Type | Attribute | Description |
| userSettingsOptions | * |
public getPreferencesString(userSettingsOptions: *): * source
Gets the preferences string for the supplied grid
Params:
| Name | Type | Attribute | Description |
| userSettingsOptions | * |
Return:
| * |
public getPropertyValues(userSettingsOptions: *, property: *): Array source
Params:
| Name | Type | Attribute | Description |
| userSettingsOptions | * | ||
| property | * |
public loadPreferences(userSettingsOptions: *) source
Loads preferences
Params:
| Name | Type | Attribute | Description |
| userSettingsOptions | * |
public parseCompactPreferencesString(userSettingsOptions: *, val: *): Array source
Params:
| Name | Type | Attribute | Description |
| userSettingsOptions | * | ||
| val | * |
public parsePreferences(userSettingsOptions: *, val: *): * source
Params:
| Name | Type | Attribute | Description |
| userSettingsOptions | * | ||
| val | * |
Return:
| * |
public persistPreferences(userSettingsOptions: *, name: *, isDefault: *) source
Saves the preferences
Params:
| Name | Type | Attribute | Description |
| userSettingsOptions | * | ||
| name | * | ||
| isDefault | * |
public rearrangeColumns(col: *, val: *, userSettingsOptions: *) source
Params:
| Name | Type | Attribute | Description |
| col | * | ||
| val | * | ||
| userSettingsOptions | * |
public setColumnOrder(userSettingsOptions: *, val: *) source
Sets the order of columns
Params:
| Name | Type | Attribute | Description |
| userSettingsOptions | * |
|
|
| val | * |
|
public setColumnVisibility(userSettingsOptions: *, val: *) source
Sets the visibility of the columns
Params:
| Name | Type | Attribute | Description |
| userSettingsOptions | * | ||
| val | * |
public setColumnWidths(userSettingsOptions: *, val: *) source
Sets the widths of the columns
Params:
| Name | Type | Attribute | Description |
| userSettingsOptions | * |
|
|
| val | * |
|
public setPreferences(userSettingsOptions: *, arrayCollection: *) source
Applies previously set preferences..
Params:
| Name | Type | Attribute | Description |
| userSettingsOptions | * |
|
|
| arrayCollection | * |
|
public setPropertyValues(userSettingsOptions: *, val: *, property: *) source
Params:
| Name | Type | Attribute | Description |
| userSettingsOptions | * |
|
|
| val | * |
|
|
| property | * |
|