new $k.JSONRenderContext()
Context for rendering JSON
Methods
globalContext() : Array
Get globalContext
Returns:
| Type | Description |
|---|---|
| Array |
setFilters(keyFilter) : $k.JSONRenderContext
Set filters
| 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 |
Returns:
| Type | Description |
|---|---|
| $k.JSONRenderContext |
setGlobalContext(jseGlobalContext) : $k.JSONRenderContext
Set global context object
| Name | Type | Description |
|---|---|---|
jseGlobalContext |
Array.<object> |
Returns:
| Type | Description |
|---|---|
| $k.JSONRenderContext |
setLevelsOfDetail(levelsOfDetail) : $k.JSONRenderContext
Set levels of detail, e.g. [ "propertyList", "schema" ]
| Name | Type | Description |
|---|---|---|
levelsOfDetail |
Array.<string> |
Returns:
| Type | Description |
|---|---|
| $k.JSONRenderContext |
setPreferredLocatorTypes(preferredLocatorTypes) : $k.JSONRenderContext
Set preferred locator types, e.g. [ "propertyList", "schema" ]
| Name | Type | Description |
|---|---|---|
preferredLocatorTypes |
Array.<string> |
Returns:
| Type | Description |
|---|---|
| $k.JSONRenderContext |
viewContext() : Array
Get view context
- Since:
- 5.1.0
Returns:
| Type | Description |
|---|---|
| Array |