| Parameter | Type | Description |
|---|---|---|
| args | undefined |
To control whether this layer is valid.
The original fetch function of the store.
Implementation of _StoreLayer._fetch
| Parameter | Type | Description |
|---|---|---|
| userRequest | keywordArgs |
Do the actual unwrapping to the store.
| Parameter | Type | Description |
|---|---|---|
| nextLayer | undefined |
Do the actual wrapping (or 'hacking' if you like) to the store.
| Parameter | Type | Description |
|---|---|---|
| store | undefined | The store to be unwrapped. |
| funcName | undefined | |
| layerFuncName | undefined | |
| nextLayer | undefined |
get/set a command (a name-value pair)
| Parameter | Type | Description |
|---|---|---|
| cmdName | string | The name of the command |
| cmdContent | anything |
Optional The content of the command |
The content of the command if cmdContent is undefined
Overrided from _StoreLayer.enabled
| Parameter | Type | Description |
|---|---|---|
| toEnable | bool |
Optional
|
See _FilterLayerMixin.filterDef
| Parameter | Type | Description |
|---|---|---|
| filter | (_ConditionExpr | null) |
Optional
|
| Parameter | Type | Description |
|---|---|---|
| store | undefined |
Get the name of this store layer. The default name retrieved from class name, which should have a pattern of "{name}Layer". If this pattern does not exist, the whole class name will be this layer's name. It's better to override this method if your class name is too complicated.
The name of this layer.
| Parameter | Type | Description |
|---|---|---|
| store | undefined |
If you only want to modify the user request, instead of sending a separate command to server before fetch, just call:
this.useCommand(false);
| Parameter | Type | Description |
|---|---|---|
| toUse | Boolean |
Optional If provided, it's a setter, otherwise, it's a getter |
handle errors when sending commands.
| Parameter | Type | Description |
|---|---|---|
| error | Error |
override from _ServerSideLayer.onCommandLoad
| Parameter | Type | Description |
|---|---|---|
| responce | (in)string | |
| userRequest | (in | out)keywordArgs |
| Parameter | Type | Description |
|---|---|---|
| filter | undefined |
Called when store data is filtered. This event is before onComplete, after onBegin.
| Parameter | Type | Description |
|---|---|---|
| filteredSize | Integer | The number of remaining fetched items after filtering. |
| totalSize | Integer | The number of original fetched items. |