JavaScript API

i·views 5.4

Class: ViewConfiguration

$k. ViewConfiguration

new $k.ViewConfiguration()

Configuration of a semantic element editor

Extends

Methods

static$k.ViewConfiguration.forElement(semanticElement, context) : object

Returns the configuration for the semantic element

Name Type Description
semanticElement $k.SemanticElement
context $k.SemanticElement optional

Context of the configuration
Since:
  • 4.1.0
Returns:
Type Description
object The rendered JSON object

static$k.ViewConfiguration.from(configurationElement) : $k.ViewConfiguration

Returns the confguration defined by the element

Name Type Description
configurationElement $k.SemanticElement

The configuration element
Since:
  • 4.1.0
Returns:
Type Description
$k.ViewConfiguration

static$k.ViewConfiguration.synchronize(object) : $k.ViewConfiguration

Update the semantic element from the JSON string / literal object

Name Type Description
object object

JSON string or literal object
Since:
  • 4.1.0
Deprecated
  • A manual synchronization/update is not supported anymore. Please use bult-in update action with viewconfig.postActionScriptAttribute.
    See:
    Throws:
    Type Description
    $k.exception.SchemaError

    Got an synchronisation error
    Returns:
    Type Description
    $k.ViewConfiguration

    configElement() : $k.SemanticElement

    Since:
    • 4.1.0
    Returns:
    Type Description
    $k.SemanticElement

    createView(domainModel) : $k.View

    Create a new view with the given domain model from this configuration. This is useful primarily for debug and test scripts.

    Name Type Description
    domainModel object

    SemanticElement or SemanticElementCollection
    Version:
    • Experimental feature, might be removed at any time
    Since:
    • 5.4.1
    Returns:
    Type Description
    $k.View

    relationTargetSearch(searchString) : Array.<$k.SemanticElement>

    Name Type Description
    searchString string optional

    Search string for the target element
    Version:
    • Experimental feature, might be removed at any time
    Since:
    • 4.1.0
    Returns:
    Type Description
    Array.<$k.SemanticElement> The rendered object

    render(semanticElement, keyFilter, detailFilter) : object

    Render the element as a literal object

    Name Type Description
    semanticElement $k.SemanticElement optional
    keyFilter object optional

    Internal Error: no text for this language or unsupported language
    detailFilter object optional

    Internal Error: no text for this language or unsupported language
    Since:
    • 4.1.0
    Deprecated
    • This function is deprecated and might be removed in future releases
      See:
      • $k.ViewConfiguration#synchronize
      Returns:
      Type Description
      object The rendered object

      renderFacets(semanticElements, keyFilter, detailFilter) : object

      Render the facets for the elements

      Name Type Description
      semanticElements Array.<$k.SemanticElement> optional
      keyFilter object optional

      Internal Error: no text for this language or unsupported language
      detailFilter object optional

      Internal Error: no text for this language or unsupported language
      Version:
      • Experimental feature, might be removed at any time
      Since:
      • 5.1.3
      Deprecated
      • This function is deprecated and might be removed in future releases
        Returns:
        Type Description
        object The rendered object

        toJSON()

        Deprecated
        • This function is deprecated and might be removed in future releases

          Intherited methods

          setRenderContext(renderContextObject)