QueryViewer control properties

Official Content
This documentation is valid for:

Control properties

QueryViewer control properties are:

Auto Refresh Group property Allows the association of different QueryViewer controls that provide related information (or the same information, with a different output) to be automatically updated when one of them is changed.
ControlName property ControlName, used to reference the control in the GeneXus object code.

 

Event Parameters Group  
Drag And Drop Data property Contains the name of the variable where DragAndDrop event parameters will be charged.
Item Expand Data property Contains the name of the variable where ItemExpand event parameters will be charged.
Item Collapse Data property Contains the name of the variable where ItemCollapse event parameters will be charged.
Filter Changed Data property Contains the name of the variable where FilterChanged event parameters will be charged.
Item Click Data property Contains the name of the variable where ItemClick event parameters will be charged. 
Item Double Click Data property Contains the name of the variable where ItemDoubleClick event parameters will be charged.

 

Data Bindings  
Object property Contains the name of the Query object or Data Provider object displayed in the QueryViewer Control.
Axes Property Allows configuring Query elements properties on runtime
Parameters Allows sending values to the Query Object or Data Provider Object at runtime.

 

Appearance  
Class property Personalize the control look & feel changing the QueryViewer class node within the associated theme (1)
Shrink To Fit property Allows specifying if the used Column Width (Table and Pivot Table) is the minimum to display the contents of all cells.(2)
Auto Resize property Allows reducing the size of the container in case the Query is displayed as Table or Pivot Table. However, if the Query is displayed as Chart, the Chart itself fulfill the Query container.
Width property Determines the width of the control.
Height property Determines the height of the control.
Axes Selectors property Allows showing or hiding the lists of values (dialogs) that query elements have.
Disable Expand Collapse property Inabilitates the possibility of Expand/Collapse values of a determined Query element.
Allow Change Axes Order property Allows changing the Query elements order. When the property value it's True, the order of the values of the Query elements is the same of the &Axes collection elements order.
DisableColumnSort Property Allows disabling the possibility of sorting the values of the Query elements.

 

Export  
Export Properties group It allows exporting the Pivot Table or Table to XML, HTML, XLSX, XLS and PDF formats.

 

Output  
Type Property Allows developers to select the output type to be used.
Chart Type property Allows developers to select the type of chart to be used.
Title property Specifies the control title (valid for charts only)
Plot series Allows  determinating if the differents Series of a Query are shown in the same chart or separate ones.
XAxis Title property Allows writing the caption that will appear on the X axis.
YAxisTitle Property Allows writing the caption that will appear on the Y axis.
XAxis Labels property Set the position of the chart axis labels.
X Axis intersection at Zero Property Allows determinating if the intersection between X axe and Y axe it's made static (at the Zero value), or it's calculated dynamically (depending on the nature of Data values).
Show Values property Set if the chart values are shown in control.
Paging property Set if paging is required, if Type is set to Table or Pivot Table, By default set to true.
Page size property Page size, applies when paging = true
Show Data Labels In property Allows indicating how to display the labels of the elements values in a Pivot Table: on the Data, Row or Column area.

 

State management  
Remember Layout property Allows keeping the latest Table/Pivot Table status (for the same user in the same browser).

 

All these properties can be set at design time and runtime. To simplify the use of the properties at runtime, some Domains are automatically added to the Knowledge Base when a QueryViewer control is used for the first time.

Control properties (in run-time only)

IsExternalQuery Allows indicating that the query is defined in GXquery and not in the Knowledge Base itself. It is related to the ExternalQueryResult property.
ExternalQueryResult Allows to load the result of the Execute method of the GXquery API before showing the query. It is related to the IsExternalQuery property.

(1) - Available since GeneXus 15 Upgrade 7

(1) - Deprecated since GeneXus 16 upgrade 3


Was this page helpful?
What Is This?
Your feedback about this content is important. Let us know what you think.