JavaScript API

i·views 5.4

Class: View

$k. View

new $k.View()

A view built with/by view configuration

Methods

configurationElement() : $k.SemanticElement

Get configuration element

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

domainModel() : object

Get domain model

Version:
  • Experimental feature, might be removed at any time
Since:
  • 5.4.0
Returns:
Type Description
object SemanticElement or TopicCollection

getPanelsToActivate()

Get the panel configurations activated by the current action.

Only supported in the following application environment(s): View configuration mapper

Since:
  • 5.3.2
Deprecated
  • Use the corresponding function of the action

    panelView() : $k.PanelView

    Get this view's panel view

    Since:
    • 5.4.0
    Returns:
    Type Description
    $k.PanelView

    parentView() : $k.View

    Get this view's parent view

    Since:
    • 5.3.2
    Returns:
    Type Description
    $k.View

    renderContext() : RenderContext

    Get render context

    Only supported in the following application environment(s): View configuration mapper

    Since:
    • 5.0.0
    Returns:
    Type Description
    RenderContext

    roles() : Array

    Get the roles of the view, if any assigned.

    Since:
    • 5.4.0
    Returns:
    Type Description
    Array Array of Strings

    semanticElement() : $k.SemanticElement

    Get semantic element

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

    session() : $k.Session

    Get the current session

    Only supported in the following application environment(s): View configuration mapper

    Since:
    • 5.2.0
    Returns:
    Type Description
    $k.Session

    setState(state) : object

    Set the state of the view

    Name Type Description
    state object
    Version:
    • Experimental feature, might be removed at any time
    Since:
    • 5.4.0
    Returns:
    Type Description
    object

    state() : object

    Get the state of the view - varies according to view type and implementation

    Version:
    • Experimental feature, might be removed at any time
    Since:
    • 5.4.0
    Returns:
    Type Description
    object

    subViews() : $k.View

    Get this view's sub-views or an empty array if there are none

    Since:
    • 5.4.0
    Returns:
    Type Description
    $k.View

    viewsWithRole(role) : Array

    Get all views with the given role searching from this view down to all sub-views.

    Name Type Description
    role string
    Since:
    • 5.4.0
    Returns:
    Type Description
    Array Array of Views

    viewType() : string

    Get the view type

    Since:
    • 5.4.0
    Returns:
    Type Description
    string the view type: edit, query, etc.