Extends
Methods
(static) forDomain(domain, withoutInheritanceopt) → {$k.StructuredQuery}
Returns the query for all objects of the domain
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
domain | $k. | Domain or internal name of a type | ||
withoutInheritance | boolean | <optional> | false | If true do not return objects of subdomains |
- Since
- 4.1.0
- Type:
- $k.
StructuredQuery
(static) forDomains(domain, withoutInheritanceopt) → {$k.StructuredQuery}
Returns the query for all objects of the domains
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
domain | Array.<$k.Domain> | | Domains or internal names of types | ||
withoutInheritance | boolean | <optional> | false | If true do not return objects of subdomains |
- Since
- 4.1.0
- Type:
- $k.
StructuredQuery
definedParameters() → {Array.<$k.QueryParameter>}
Returns the parameters of the query
- Since
- 4.0.0
- Overrides
- Type:
- Array.<$k.QueryParameter>
explainElements(elements, parametersopt) → {Array.<$k.SemanticElement>}
Returns elements involved in the query
| Name | Type | Attributes | Description |
|---|---|---|---|
elements | Array.<$k.SemanticElement> | Elements to explain. Elements that do not match the query are ignored. | |
parameters | object | <optional> | The parameters object where the keys match the names of parameters defined in the query |
- Since
- 4.0.0
- Overrides
When the query could not be solved, e.g. missing parameters
- Type:
- Array.<$k.SemanticElement>
filterElements(elements, searchStringopt, parametersopt) → {Array.<$k.SemanticElement>}
Returns all elements that match the query. The two optional parameters can be given in any order.
| Name | Type | Attributes | Description |
|---|---|---|---|
elements | Array.<$k.SemanticElement> | ||
searchString | string | <optional> | |
parameters | object | <optional> | The parameters object where the keys match the names of parameters defined in the query |
- Since
- 4.0.0
- Overrides
When the query could not be solved, e.g. missing parameters
- Type:
- Array.<$k.SemanticElement>
var hits = $k.Registry.query("experts").filterElements(persons);findElements(searchStringopt, parametersopt) → {Array.<$k.SemanticElement>}
Search and return all found semantic elements. The two parameters can be given in any order.
| Name | Type | Attributes | Description |
|---|---|---|---|
searchString | string | <optional> | |
parameters | object | <optional> | The parameters object where the keys match the names of parameters defined in the query |
- Since
- 4.0.0
- Overrides
When the query could not be solved, e.g. missing parameters
- Type:
- Array.<$k.SemanticElement>
var hits = $k.Registry.query("directSearch").findElements("Test");var hits = $k.Registry.query("compositeSearch").findElements("Test", { context: "portal" });findHits(searchStringopt, parametersopt) → {Array.<$k.Hit>}
Search and return all found hits. The two arguments can be given in any order.
| Name | Type | Attributes | Description |
|---|---|---|---|
searchString | string | <optional> | |
parameters | object | <optional> | The parameters object where the keys match the names of parameters defined in the query |
- Since
- 4.0.0
- Overrides
When the query could not be solved, e.g. missing parameters
- Type:
- Array.<$k.Hit>
var hits = $k.Registry.query("directSearch").findHits("Test*");findResultSize(searchStringopt, parametersopt) → {number}
Search and return the number of found semantic elements. The two arguments can be given in any order.
| Name | Type | Attributes | Description |
|---|---|---|---|
searchString | string | <optional> | |
parameters | object | <optional> | The parameters object where the keys match the names of parameters defined in the query |
- Since
- 5.3.3
- Overrides
When the query could not be solved, e.g. missing parameters
- Type:
- number
fullExplainElements(elements, parametersopt) → {Array.<$k.SemanticElement>}
Returns all elements involved in the query
| Name | Type | Attributes | Description |
|---|---|---|---|
elements | Array.<$k.SemanticElement> | Elements to fully explain. Elements that do not match the query are ignored. | |
parameters | object | <optional> | The parameters object where the keys match the names of parameters defined in the query |
- Since
- 4.3.1
- Overrides
When the query could not be solved, e.g. missing parameters
- Type:
- Array.<$k.SemanticElement>
name() → {string}
Returns the name
- Since
- 4.0.0
- Overrides
- Type:
- string
parentFolders() → {Array.<$k.Folder>}
Returns the folders that contain this element
- Overrides
- Type:
- Array.<$k.Folder>
renderElements(tableConfiguration, keyFilteropt, detailFilteropt) → {Array.<object>}
Search and render found semantic elements using the given table configuration
| Name | Type | Attributes | Description |
|---|---|---|---|
tableConfiguration | $k. | ||
keyFilter | object | <optional> | Alternative 1 (preferred): a $k.JSONRenderContext Alternative 2 (compatibility only): A filter. See $k.JSONRenderContext.prototype.setFilters(). |
detailFilter | object | <optional> | Only used if the key filter is not a $k.JSONRenderContext. See $k.JSONRenderContext.prototype.setLevelsOfDetail() |
- Since
- 4.1.0
- Overrides
- Deprecated
- This function is deprecated and might be removed in future releases
When the query could not be solved, e.g. missing parameters
The rendered objects
- Type:
- Array.<object>
renderHits(tableConfiguration, keyFilteropt, detailFilteropt) → {Array.<object>}
Search and render found hits using the given table configuration
| Name | Type | Attributes | Description |
|---|---|---|---|
tableConfiguration | $k. | ||
keyFilter | object | <optional> | Alternative 1 (preferred): a $k.JSONRenderContext Alternative 2 (compatibility only): A filter. See $k.JSONRenderContext.prototype.setFilters(). |
detailFilter | object | <optional> | Only used if the key filter is not a $k.JSONRenderContext. See $k.JSONRenderContext.prototype.setLevelsOfDetail() |
- Since
- 4.1.0
- Overrides
- Deprecated
- This function is deprecated and might be removed in future releases
When the query could not be solved, e.g. missing parameters
The rendered objects
- Type:
- Array.<object>
searchString() → {string}
Returns the search string
- Since
- 4.0.0
- Overrides
- Type:
- string
setDomain(domain)
Restrict the query results to objects/types of the domains
| Name | Type | Description |
|---|---|---|
domain | $k. | The domain or internal name of a type |
- Since
- 4.1.0
- Overrides
setDomains(domains)
Restrict the query results to objects/types of the domains
| Name | Type | Description |
|---|---|---|
domains | Array.<$k.Domain> | | The domains or internal names of types |
- Since
- 4.0.0
- Overrides
setFacetFilters(facetFiltersArray)
Set the selected facets and terms for the query
| Name | Type | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
facetFiltersArray | Array.<object> | Array with selected facets and terms Properties
|
- Since
- 5.1.3
- Overrides
setName(name)
Sets the name of the query
| Name | Type | Description |
|---|---|---|
name | string | The name |
- Version
- Experimental feature, might be removed at any time
- Since
- 5.3.2
- Overrides
setParameter(parameterId, value)
Set a parameter of the query.
| Name | Type | Description |
|---|---|---|
parameterId | string | The ID of the parameter |
value | The value of the parameter. The type (string etc.) depends on the parameter. Arrays of values can be passed, too. The value undefined or null disables the parameterized condition. |
- Since
- 4.0.0
- Overrides
When the value is not suitable for the parameter
setParameters(parameters)
Set the parameters of the query from the properties of the object
| Name | Type | Description |
|---|---|---|
parameters | object | The parameters object where the keys match the names of parameters defined in the query |
- Since
- 4.0.0
- Overrides
When a value is not a suitable parameter
setSearchString(searchString)
Set the string to search for
| Name | Type | Description |
|---|---|---|
searchString | string |
- Since
- 4.0.0
- Overrides