Search:  

Previous pageData Integration Next page
Query Embed dialog - Ajax tab 

This tab is shown for view that are displayed on a surface, and determines when they are rendered, and how it may subsequently be updated.

The tab consists of the following sections:

  • Initial Content
  • Transitions
  • Reload Content
  • Loading Indicators

Initial Content

Show initial content

Defines whether the query embed should render anything initially. If unchecked, nothing will be shown initially (but it may render subsequently in response to a Transition). Default is checked, to render content initially.

Deliver initial content

  • With the page (default)

The content for the query embed is prepared as part of the initial page delivered to the browser.

Note: If the query may take some time to prepare, this option may create an undesirable delay to the delivery of the page.

  • Via a separate ajax remote call

The page is loaded without the contents of the query embed, and then an ajax call is made to the server to provide the initial contents of the query embed, which is then displayed when ready.

A sub option is available to prevent this call, when an element in the page has a specified id.

 

Transitions

Transitions present a new set of parameters to the page without causing a full reload of the page. Transitions may optionally be broadcast on particular 'channels'. This section determines whether the query embed reacts to these

React to transitions

If checked, then the query embed will react to transitions. Default is unchecked.

Limit to channels

If specified, the query embed will only respond to transitions set to a particular channel. This field can contain one channel name or a comma separated list of channels it will listen to.

Hide content on mouse-out

Where transitions are sent as a result of a user hovering the mouse over a field elsewhere on the page, then checking this option makes tis query embed be hidden when the user moves the mouse away from that field.

 

Reload Content

This setting specifies that the query embed should reload at the specified interval.

If the data returned by the query embed would not result in a change, then the display remains unchanged, otherwise the display is updated with the new data.

There are two options:

  • Don't reload content (default)
  • Reload content every specified number of seconds

Note: To reduce server loading, reloading will not occur when the browser window is not visible. A reload will occur as soon as the browser window does become visible again.

Note: If the page is inactive for a long time (hours) the browser may choose to stop sending ajax requests. Unser interaction, eg reloading the page, will resume reloads.

 

Loading Indicators

When the page is displayed, but the query embed is awaiting new data in response to an ajaxed in initial content, or to a transition, then a loading indicator can be shown to the user while they are waiting.

Note: Reload Content every specified number of seconds does not show a loading indicator, (as most often the content is not changing, and it would be distracting to interrupt the user with an indicator on a regular interval)

There are two separate loading indicators:

Initial content

The indicator shown while waiting for initial content to be delivered.

  • Default

The default loading indicator is shown

  • Component

The surface of the selected component is shown as a loading indicator

  • None

No loading indicator is shown

Note: in order for an Initial Loading Indicator to be shown, on the Component tab, Style, Embed style, "minimum height" must be specified, otherwise the indicator will not be shown as its area would be undefined. The width need not be defined as that defaults to 100% of available space.

Transitions

The indicator shown while waiting for new content to appear in response to a transition.

  • As per initial content

The same indicator settings are used as defined by the Initial Content setting

  • Default

The default loading indicator is shown

  • Component

The surface of the selected component is shown as a loading indicator

  • None

No loading indicator is shown

Note: The loading indicator will cover the area rendered by the existing content, so unlike the Initial Content loading indicator this will show even if no minimum height is specified for the embed style.

 

Managing data