showView

Displays the specified content on the specified layout.

Field Configurations

Key	Type	Description	Default Value
"params" (required)	Object	undefined	null

Parameters

Key	Type	Description	Default Value
"async"	Boolean	Specifies whether the action should perform asynchronously.	null
"content"	String,Object	Content to be displayed. This resembles the content of a static template.	null
"events"	Event	The events for the new view.	null
"isCancelable"	Boolean	Determines whether the pop-up closes when you press outside or the Back button.	true
"layout"	String	The name of the layout.	null
"name"	String	The name of the view. Used by the closeView Action to close it.	null
"namedStyle"	String	The name of a style to use for this view.	"default"
"onViewStack"	Boolean	This field is deprecated. Please use or omit the replace prefix in the target. DEPRECATED Use replace prefix in the target.	null
"popUpDeltaX"	UnitSize	Shift in the X direction of the pop-up.	0
"popUpDeltaY"	UnitSize	Shift in the Y direction of the pop-up.	0
"popUpHeight"	UnitSize	The height of the pop-up.	"245dp"
"popUpWidth"	UnitSize	The width of the pop-up.	"395dp"
"query"	String	The query for a database request.	null
"queryParams"	Array	The params for the query.	null
"staticTemplate"	String	Client template that will be used in case the query is not defined or has no data.	null
"style"	Style	The styles for the new view.	null
"table"	String	The table for a database request.	null
"target"	ShowViewTarget	Location where the new layout should be displayed.	"tabActive"
"template"	String	The template which should be applied to the database result.	null
"templateData"	String,Object	Data for the template to apply.	null
"templateIsNode"	Boolean	Determines if the template is a complete node or just the content.	false
"title"	String	The title of the new view.	null
"transition"	Boolean	If set to false, will deactivate the fade-in/fade-out effect when a new view opens or closes.	true
"type"	ShowViewType	The type of the shown view	"layered"
"view"	String	The name of the view configuration to use.	null

Inherited

From Base Action

Base Action

Field Configurations

Key	Type	Description	Default Value
"dynamicParams"	Object	Dynamic params to retrieve data from a specific context e.g. a userSetting.	null
"leadingDelimiter"	String	The leading mustache delimiter to use.	null
"params"	Object,Array	Object containing the properties of the action.	null
"trailingDelimiter"	String	The trailing mustache delimiter to use.	null
"type"	String	Type name of the action.	null

Examples

Example 1: As a new view

Show ExampleHide Example

Open a new view.

{
  "type": "showView",
  "params": {
    "target": "view",
    "layout": "view_showViewExampleView",
    "staticTemplate": "view_showViewExampleView",
    "namedStyle": "home"
  }
}

Example 2: As a pop-up

Show ExampleHide Example

Open a new view as a pop-up.

{
  "type": "showView",
  "params": {
    "target": "popUp",
    "layout": "popUp_showViewExamplePopUp",
    "isCancelable": true,
    "popUpWidth": "80%",
    "popUpHeight": "40%",
    "content": {
      "backButton": {
        "actions": [
          {
            "type": "closePopUp"
          }
        ]
      }
    }
  }
}

Example 3: As a menu

Show ExampleHide Example

Open a new view as a menu on the right side.

{
  "type": "showView",
  "params": {
    "target": "menuRight",
    "name": "view_showViewExampleMenuRight",
    "layout": "view_showViewExampleMenuRight",
    "content": {
      "backButton": {
        "actions": [
          {
            "type": "closeView",
            "params": {
              "name": "view_showViewExampleMenuRight"
            }
          }
        ]
      }
    }
  }
}

Example 4: With static content

Show ExampleHide Example

Open a new view with statically inserted content.

{
  "type": "showView",
  "params": {
    "layout": "view_showViewExampleStatic",
    "target": "menuRight",
    "content": {
      "backgroundColor": {
        "value": "#aaaaaa"
      },
      "text": {
        "value": "Rechts",
        "fontColor": "#000000"
      }
    }
  }
}

Example 5: With content from a database

Show ExampleHide Example

Open a new view with content retrieved from a database query.

{
  "type": "showView",
  "params": {
    "layout": "view_showViewExampleQuery",
    "target": "view",
    "table": "locations",
    "query": "byId",
    "queryParams": [
      "42"
    ],
    "template": "location"
  }
}