Introducing User Input Elements, Pg. 3

Introducing User Input Elements

Logi Info
v12.6 - Oct 2018

Page 3

1 | 2| 3

This page continues the discussion of the user input elements and topics include:

 

Input Color Picker

The Input Color Picker was significantly improved in this release. Users of earlier Info v12 releases will see a subset of the features described here.

This element provides a visual interface for color selection. The current color selection appears as an icon next to a palette icon.
 

Clicking either icon displays the Color Picker pop-up panel, as shown above, from which new selections can be made.
 

Using It

This element shares many of the standard Input element attributes and includes these special attributes:
 

Attribute Description

Allow Transparency

Specifies whether the Color Picker pop-up panel will include a slider for selecting the transparency of the selected color. The default value is False.

Color Picker Caption

Specifies a custom caption for the Color Picker pop-up panel. The default value is Color Picker.

Default Value

Specifies the selected default color, by name, decimal RGB or RGBA value, or hex RGB value. Prefix hex values with the pound sign, like #112233.

Popup Modal
 

Specifies whether or not the Color Picker pop-up panel will be "system modal". Modal pop-ups disable the rest of the page until the panel is closed and the disabled area behind the panel get shaded in transparent gray.

 

Getting Its Data

The value associated with the color selected from the palette is available in the next Report or Process task with an @Request token. For example, if the element's ID is set to inpColors then the token @Request.inpColors~ will equal that value. This value will always be in hex RGB format: #112233.
 

More Information

For additional information, see the Element Reference entry for Input Color Picker.

  Back to the top

 

Input Chart List

A number of Classic Charts have been deprecated; they are still supported and will work, but their elements are no longer available in Studio. Use Chart Canvas Charts instead for all new development.

This element enables a Classic Chart to become an input control. Once a static Bar or Pie chart has been made the child of this element, users can select one or more bars, or one or more pie regions, by clicking on them. When the page is submitted, the Label values of the selected chart items are passed to the next report or process.
 

As shown above, the selected bars or wedges are displayed in a distinctly different color from the other bars or wedges by default. If the data has been grouped so that it's displayed as groups of several bars each, the entire group will be selected when clicked, rather than individual bars within the group.
 

Using It

This element shares many of the standard Input element attributes and includes these special attributes:
 

Attribute Description

Input Chart Value Column

Specifies the data column whose values which will be returned, such as the IDs for each selected bar in a Bar chart. The chart's Chart Label Column (aka: Label Data Column X-axis) is the default.

Selected Color

Specifies the selected bar or wedge's color, by name, decimal RGB value, or hex RGB value. Prefix hex values with the pound sign, such as #112233.

Selected Transparency

Specifies the transparency level of the selected bar or wedge. The lowest possible value of 0 indicates that the region is opaque, with no transparency. The other end of the scale, 15, indicates a completely transparent bar or wedge.

Unselected Color

Specifies the color of unselected bars or wedges, by name, decimal RGB value, or hex RGB value. Prefix hex values with the pound sign, such as #112233.

Unselected Transparency

Specifies the transparency level of the unselected bars or wedges. The lowest possible value of 0 indicates that the region is opaque, with no transparency. The other end of the scale, 15, indicates a completely transparent bar or wedge.


This element cannot be used within an Input Grid element. A child validation element, Validation.Required, is available to ensure that a selection is made by the user, if desired.
 

Getting Its Data

The Label values of the selected bars or wedges are available in the next Report or Process task with an @Request token. For example, if the element's ID is set to inpMyPie then the token @Request.inpMyPie~ will equal that value.

If no chart item is selected and the page is submitted, then this Request token will exist but it will be empty ("").

If multiple chart items are selected, the resulting Request token will contain a comma-separated list of selected values. When working use with SQL statements, it may be desirable to surround each individual value in the list with single quotes. This can be done using the SingleQuote token modifier. Thus

    @Request.inpCLPie~   which has a value of     1,2,3     becomes   
    @SingleQuote.Request.inpCLPie~  which has a value of     '1','2','3' 


More Information

For additional information, see the Element Reference entry for Input Chart List.

  Back to the top

 

Input Chart Range

A number of Classic Charts have been deprecated; they are still supported and will work, but their elements are no longer available in Studio. Use Chart Canvas Charts instead for all new development.

This element enables a Classic Chart to become an input control. Once a static Line, Spline, or Scatter chart has been made the child of this element, users can select a region in the chart by drawing a selection box (by dragging the mouse) on it. When the page is submitted, the maximum and minimum Label and Data values of the selected chart region are passed to the next Report or Process task.
 

The selected region is displayed in a distinctly different color from the rest of the chart by default.
 

Using It

The attributes of this element include:
 

Attribute Description

ID

(Required) A unique element ID.

MaxXaxisID

Specifies the name of the Request token that will provide the upper X-axis (Label) value in the next report or process.

MaxYaxisID

Specifies the name of the Request token that will provide the upper Y-axis (Data) value in the next report or process.

MinXaxisID

Specifies the name of the Request token that will provide the lower X-axis (Label) value in the next report or process.

MinYaxisID

Specifies the name of the Request token that will provide the lower Y-axis (Data) value in the next report or process.

Region Border Color

Specifies the border color of the region drawn on the chart, by name, decimal RGB value, or hex RGB value. Prefix hex values with the pound sign, like #112233.

Region Color

Specifies the color of the region drawn on the chart, by name, decimal RGB value, or hex RGB value. Prefix hex values with the pound sign, like #112233.

Region Transparency

Specifies the transparency level of the region drawn on the chart. The lowest possible value of 0 indicates that the region is opaque, with no transparency. The other end of the scale, 15, indicates a completely transparent bar or wedge.


This element cannot be used within an Input Grid element.
 

Getting Its Data

The minimum and maximum Label and Data values of the region drawn on the chart are available in the next Report or Process task with @Request tokens. For example, if the element's MaxXaxisID attribute is set to EndDate then the token @Request.EndDate~ will equal the maximum Label value.

If no selection region is drawn and the page is submitted, then the Request tokens will exist but they will be empty ("").
 

Special Event Elements

Two special, child event elements, Area Drawn and Area Cleared, are available for use with this element; both take Action elements as their children.

Area Drawn triggers its child Action element as soon as the user finishes drawing the area on the chart.

After an area has been drawn on the chart, if the user clicks somewhere on the chart again, the drawn area will be removed and Area Cleared will then trigger its child Action element.
 

More Information

For additional information, see the Element Reference entry for Input Chart Range.

 

Input Selection Point & Range

The Input Selection Point and Input Selection Range families of elements are available as children of some Chart Canvas chart Series elements. They provide the ability to interactively select portions of charts using the mouse and to initiate actions using the selected data. These input elements are discussed in our document Input Selection for Chart Canvas Charts.

 

More advanced information relating to many of input elements can be found in our document Working with User Input Elements.
 

  Back to top

  1 | 2 | 3

 


© Copyright 2007-2019 Logi Analytics, Inc. All Rights Reserved