new JSONRenderContext()
Context for rendering JSON
Methods
globalContext() → {Array}
Get the global context
Only supported in the following application environment(s): View-Configuration-Mapper
- Deprecated
- This function is deprecated and might be removed in future releases
Returns:
- Type:
- Array
session() → {$k.Session}
Get the session
Only supported in the following application environment(s): View-Configuration-Mapper
- Deprecated
- This function is deprecated and might be removed in future releases
Returns:
- Type:
- $k.Session
setFilters(keyFilter) → {$k.JSONRenderContext}
Set filters
Parameters:
| Name | Type | Description |
|---|---|---|
keyFilter | object | Alternative 1: An array of strings defining a filter which property names to include. {"exclude": ["key1", ...]}includes all but the listed properties, while{"include": ["key1", ...]}or["key1", ...]includes only the listed properties. Non-optional properties are always included |
- Deprecated
- This function is deprecated and might be removed in future releases
Returns:
- Type:
- $k.JSONRenderContext
setGlobalContext(jseGlobalContext) → {$k.JSONRenderContext}
Set the global context
Only supported in the following application environment(s): View-Configuration-Mapper
Parameters:
| Name | Type | Description |
|---|---|---|
jseGlobalContext | Array.<object> |
- Deprecated
- This function is deprecated and might be removed in future releases
Returns:
- Type:
- $k.JSONRenderContext
setLevelsOfDetail(levelsOfDetail) → {$k.JSONRenderContext}
Set levels of detail, e.g. [ "propertyList", "schema" ]
Parameters:
| Name | Type | Description |
|---|---|---|
levelsOfDetail | Array.<string> |
- Deprecated
- This function is deprecated and might be removed in future releases
Returns:
- Type:
- $k.JSONRenderContext
setPreferredLocatorTypes(preferredLocatorTypes) → {$k.JSONRenderContext}
Set preferred locator types, e.g. [ "propertyList", "schema" ]
Parameters:
| Name | Type | Description |
|---|---|---|
preferredLocatorTypes | Array.<string> |
- Deprecated
- This function is deprecated and might be removed in future releases
Returns:
- Type:
- $k.JSONRenderContext
setSession(session)
Set the session
Only supported in the following application environment(s): View-Configuration-Mapper
Parameters:
| Name | Type | Description |
|---|---|---|
session | object | Either a JSON object or a Session |
- Deprecated
- This function is deprecated and might be removed in future releases