QueryViewer

QueryViewerNode Description

This page explains the usage of QueryViewer nodes. These nodes can be used in web panels created with K2BWebPanelDesigner to include QueryViewer user controls in the web panel, without having to include user regions.

As this node is based on the QueryViewer user control, we advise you to read this user control's documentation.

Runtime Appearance

This node's runtime appearance varies greatly depending on the value of its properties. The easiest example of this is the "Type" and "Chart Type" properties, that determine how the query will be rendered in runtime.

QueryViewerDefinition QueryViewerRuntime
QueryViewer definition End result

Properties

Most of this node's properties are based on the properties of the QueryViewer user control. Because of this, a link to the original GXtechnical documentation is given in all cases where it's possible.

Category Name Value
General Control Name (Id) The grid's name. Must be unique within the web panel.
Auto Refresh Group See the corresponding QueryViewer user control documentation for this property here.
Data Bindings Object See the corresponding QueryViewer user control documentation for this property here.
Use Cache See the corresponding QueryViewer user control documentation for this property here.
Appearance Shrink To Fit See the corresponding QueryViewer user control documentation for this property here.
Auto Resize See the corresponding QueryViewer user control documentation for this property here.
Width The width of the control.
Height The height of the control.
Hide Measures Properties Box See the corresponding QueryViewer user control documentation for this property here.
Axes Selectors See the corresponding QueryViewer user control documentation for this property here.
Disable Expand Collapse See the corresponding QueryViewer user control documentation for this property here.
Allow Changes Axes Order See the corresponding QueryViewer user control documentation for this property here.
Disable Column Sort See the corresponding QueryViewer user control documentation for this property here.
Appearance/Font Font Family The font family used in the control.
Font Size The font size used in the control.
Font Color The font color used in the control.
Export Export Header See the corresponding QueryViewer user control documentation for this property here.
Export Header Size See the corresponding QueryViewer user control documentation for this property here.
Export To XML See the corresponding QueryViewer user control documentation for this property here.
Export To HTML See the corresponding QueryViewer user control documentation for this property here.
Export To XLS See the corresponding QueryViewer user control documentation for this property here.
Export To XLSX See the corresponding QueryViewer user control documentation for this property here.
Export To PDF See the corresponding QueryViewer user control documentation for this property here.
Output Type See the corresponding QueryViewer user control documentation for this property here.
Chart Type See the corresponding QueryViewer user control documentation for this property here.
x Axis Title See the corresponding QueryViewer user control documentation for this property here.
y Axis Title See the corresponding QueryViewer user control documentation for this property here.
Preferred Renderer For Query Viewer Charts See the corresponding QueryViewer user control documentation for this property here.
Preferred Renderer For Query Viewer Pivots And Tables See the corresponding QueryViewer user control documentation for this property here.
Paging See the corresponding QueryViewer user control documentation for this property here.
Page Size See the corresponding QueryViewer user control documentation for this property here.
XAxis Labels See the corresponding QueryViewer user control documentation for this property here.
Show Values See the corresponding QueryViewer user control documentation for this property here.
Show Data Labels See the corresponding QueryViewer user control documentation for this property here.
State Management Remember Layout See the corresponding QueryViewer user control documentation for this property here.

User subroutines associated to this node

There are no user subroutines associated directly to this node. However, in many scenarios it is necessary to include code in other events to achieve the desired behaviour. For example, taking the instance shown in the "Runtime appearance" section, the developer may need to add this code to match the Query's parameters to the variables present in the web panel.

QueryViewerevent
Sample code showing a possible integration with the QueryViewer object

To integrate the Query Viewer user control to the rest of the web panel, K2BWebPanelDesigner generates several variables, that can be seen in the following image (once again, this image corresponds to the example above):

QueryViewerGeneratedVariables
Variables generated by K2BWebPanelDesigner

To know more about the usage of these variables, check the user control's documentation.