Home
Macro Language Elements
The section contains detailed specifications for all 1010data Macro Language elements.
Application Development
<widget>
<widget> is used to define all visual components of a QuickApp, including drop-downs, text boxes, tables, and calendars. The form a widget takes is controlled by the class_ attribute.
class_="text"
Using <widget class_="text"> displays text in the QuickApp.

Macro Language Elements
The section contains detailed specifications for all 1010data Macro Language elements.
- Data Transformation
  Data transformation operations use functions and expressions to functionally alter tabular data. These operations take 0, 1, or 2 tables as input and produce a single table as a result.
- Blocks
  Blocks allow users to reuse sections of Macro Language code and to parameterize values in that code for greater flexibility and power.
- Application Development
  - <dynamic>
    The <dynamic> element creates an environment in 1010data that maintains the state of system interactions and controls the running of queries.
  - <render>
    The <render> element provides the ability to configure certain QuickApp widgets when rendered to available output targets. A single <render> element contains one or more elements that specify output targets and settings for the final output.
  - <layout>
    The <layout> element is a nestable pseudo-operation that can be used to organize <widget> elements and other <layout> elements.
  - <widget>
    <widget> is used to define all visual components of a QuickApp, including drop-downs, text boxes, tables, and calendars. The form a widget takes is controlled by the class_ attribute.
    - class_="alert"
      The alert widget displays a message to the user when an event triggers an alert. (Available as of prod-9)
    - class_="bokehchart"
      <widget class_="bokehchart"> allows you to create data visualizations. (Available as of version 13.30)
    - class_="browser"
      Using <widget class_="browser"> creates a file-browser that enables the end-user of the QuickApp to select 1010data objects such as tables, folders, and queries.
    - class_="buildgrid"
      Using <widget class_="buildgrid"> provides an editable, expandable grid for entering data into a temp table.
    - class_="button"
      Using <widget class_="button"> creates a button that can be configured to perform many actions and initiate interactions.
    - class_="chart"
      Using <widget class_="chart"> allows you to create client-side data visualizations rendered by the Kendo UI ®charting engine. (Available as of version 10.16)
    - class_="checkbox"
      Using <widget class_="checkbox"> creates a simple checkbox with a label.
    - class_="checklist"
      Using <widget class_="checklist"> creates a set of checkboxes with horizontal or vertical orientation.
    - class_="color"
      Using <widget class_="color"> creates a widget that allows the end-user to select a color value.
    - class_="date"
      Using <widget class_="date"> creates an input field with an accompanying calendar widget for easier date selection.
    - class_="draggable"
      Using <widget class_="draggable"> creates drag-and-drop biscuits to add columns to different drop zones.(Available as of version 13.04)
    - class_="dropdown"
      Using <widget class_="dropdown"> creates a drop-down menu.
    - class_="dropdownlist"
      Using <widget class_="dropdownlist"> creates a drop-down menu with multi-select capabilities that preserve the order of items clicked. (Available as of prod-9)
    - class_="editgrid" (deprecated)
      Using <widget class_="editgrid"> creates a table whose cells can be edited in the browser.
    - class_="expression"
      The expression widget provides assistance in composing 1010data expressions. (Available as of version 11.18)
    - class_="field"
      Using <widget class_="field"> creates a text input field.
    - class_="font"
      Using <widget class_="font"> creates a widget that allows the end user to select a font and related properties such as size and style.
    - class_="gauge"
      Using <widget class_="gauge"> creates a linear or radial gauge that displays scalar data on a specified range of values. (Available as of prod-9)
    - class_="gmap"
      Using <widget class_="gmap"> creates a graphical map that can be used to display geographical information. This widget is powered by the Google Maps service.
    - class_="graphics"
      Using <widget class_="graphics"> creates a graph generated by 1010data's visualization engine.
    - class_="grid"
      Using <widget class_="grid">, the results from a 1010data query can be displayed in a tabular format.
    - class_="image"
      Using <widget class_="image"> inserts an image into the layout of a QuickApp.
    - class_="lineup"
      The <widget class_="lineup"> is a specialized alternative to <widget class_="sorter">, which allows for selection, ordering, and sorting from a collection of columns or similar objects. (Available as of version 12.06)
    - class_="link"
      Using <widget class_="link"> creates an HTML hyperlink.
    - class_="list"
      Using <widget class_="list"> creates a scrollable box with a list of values that can be selected by clicking or lassoing.
    - class_="logout"
      Sends a logout command to the server.
    - class_="menu"
      Using <widget class_="menu"> creates a hierarchical menu bar with cascading submenus that can submit action or alter variables on selection. (Available as of prod-9)
    - class_="nest"
      Using <widget class_="nest">, widgets can be dynamically generated based on parameterized values.
    - class_="progressbar"
      Using <widget class_="progressbar"> creates a progress bar with several display modes. (Available as of prod-9)
    - class_="querytree"
      Using <widget class_="querytree"> provides a display of hierarchical data with nested parent/child nodes. (Available as of prod-9)
    - class_="radio"
      Using <widget class_="radio"> creates a set of radio buttons with horizontal or vertical orientation.
    - class_="radiobutton"
      Using <widget class_="radiobutton"> creates a button that assigns the value of a specified expression to a dynamic variable when the button is clicked. The button can assume different guises.
    - class_="receiver"
      Using <widget class_="receiver"> updates dynamic variables when it receives JavaScript messages sent from external web applications.
    - class_="slider"
      Using <widget class_="slider"> creates a sliding value widget.
    - class_="sorter"
      Using <widget class_="sorter"> creates a scrollable box with a list of values that can be sorted, or two lists in which values that can be moved from one to the other and sorted within each individual list.
    - class_="spy"
      Detects the size of the display area used to show a QuickApp and changes values in a package variable when the dimensions of the display area change. These values can then be used to change dimensional aspects of the QuickApp.
    - class_="table"
      Using <widget class_="table"> creates a fixed table ideal for displaying a relatively small dataset. The current maximum size for a table widget is 1000 rows and 500 columns. Any results from a 1010data query can be displayed in this table/grid element.
    - class_="taglist"
      Provides an input box for multiple strings which are then parsed into tags. (Available as of version 15.04)
    - class_="terminal"
      Provides an xterm-compatible terminal emulator as a widget.
    - class_="text"
      Using <widget class_="text"> displays text in the QuickApp.
      - <layer>
        One or more <layer> elements can be specified within a <widget class_="text">. Each <layer> contains a 1010data query and can be used to provide data to it. (Available as of version 11.09)
    - class_="textbox"
      Using <widget class_="textbox"> creates a large text field for entering and editing arbitrary text, including 1010data Macro Language code.
    - class_="transmitter"
      Using <widget class_="transmitter"> sends a JavaScript message to the web application in which the QuickApp is contained, notifying it when the values of specified dynamic variables have changed.
    - class_="value"
      A value widget displays the value of its bound variable, formatted appropriately for its type. (Available as of version 11.19)
  - <do>
    A <do> clause within a <dynamic> provides the ability for <dynamic> variables to be updated when some variable within the scope of the <dynamic> is changed.
  - <do action_="sql">
    <do action_="sql"> provides a programmatic API to the SQL metadata store. (Available as of version 17.29)
  - <loop>
    <loop> is a special operation that allows one query to iteratively reference the data from each row in the results of another query.

`class_="text"`

Using <widget class_="text"> displays text in the QuickApp.

Syntax

<dynamic>
    <widget class_="text" type_="[plain|html]" text_="[TEXT_TO_DISPLAY]"/>
</dynamic>

Alternate syntax

<dynamic>
  <widget class_="text">
    [PLAIN_TEXT_CONTENT]
    <text>
      [TEXT_CONTENT]
    </text>
    <itext>
      [STYLED_TEXT_CONTENT]
    </itext>
    <html>
      <![CDATA[[HTML_CONTENT]]]>
    </html> 
    <code language_="js">
      <![CDATA[[JAVASCRIPT_CODE]]]>
    </code>   
    <code language_="css">
      <![CDATA[[CSS_CODE]]]>
    </code>
    <layer>
      [1010data_QUERY]
    </layer>
  </widget>
</dynamic>

This extended form of <widget class_="text"> may contain either plain text content or text that is wrapped in one or more <text> or <html> tags. Text wrapped in <text> is HTML-escaped before being displayed; text wrapped in <html> is displayed directly. For more information, see <text> and <html>.

The text widget may also contain <code language_="js"> forms, which are sent to the browser wrapped in HTML <script> tags, and <code language_="css"> forms, which are sent to the browser wrapped in HTML <style> tags. For more information, see <code>.

Note: As a best practice, always wrap HTML, css and javascript in <![CDATA]]> tags as shown in the above syntax. Without these tags, not all spaces will be preserved between HTML elements which may result in undesired output.

The text widget may also contain one or more <layer> clauses, each containing a 1010data query. Each <layer> may bear one or more value*_ (and associated row*_ / col*_ ) attributes, and/or a tablevalue_ attribute. Variables set thus by layer queries have scope only in subsequent items (other <layer> tags, text, and <text> / <html> / <code> forms) within the widget itself; in other words, they do not change the global <dynamic> environment and need not be specified in the <dynamic> clause. For more information, see <layer>.

(Available as of version 11.09)

As of version 11.10, the extended form of <widget class_="text"> respects newlines in plain text contents.

As of version 11.13, the extended form of <widget class_="text"> understands <itext> block forms and displays them translated into HTML. For more information, see <itext>.

Attributes

type_

The type of text to display.

Valid values are:

plain: Plain text is displayed with styling defined by the color_, style_, and alttextstyle_ attributes.
This is the default.
html: Text is displayed with any HTML formatting, if specified. The color_, style_, and alttextstyle_ attributes are ignored.

The default is plain.

text_

Specifies the text to display.

The string specified by the text_ attribute may include HTML escape characters (e.g., use " to include double quotes in the text). For example, text_="She said, "Wow, that's cool!"" will display in the text widget as: She said, "Wow, that's cool!"

This attribute is only valid when type_="plain".

color_

Specifies the color of the displayed text.

The color can be specified as any valid HTML color name, an RGB value, or a hex value.

This attribute is only valid when type_="plain".

style_

Specifies the styling for the displayed text. Accepts CSS (e.g., font-family:courier;font-weight:bold;font-size:26pt;).

This attribute is only valid when type_="plain".

alttext_

Specifies the text to display when the user points to the widget.

This attribute is only valid when type_="plain".

(Available as of version 10.40)

altcolor_

Specifies the color of the displayed text when the user points to the widget.

The color can be specified as any valid HTML color name, an RGB value, or a hex value.

This attribute is only valid when type_="plain".

(Available as of version 10.40)

alttextstyle_

Specifies the styling for the displayed text when the user points to the widget. Accepts CSS (e.g., font-family:courier;font-weight:bold;font-size:26pt;).

This attribute is only valid when type_="plain".

(Available as of version 11.08)

Example: Using `type_="plain"`

<dynamic>
  <widget class_="text" type_="plain" 
   text_="Here's some &quot;plain text&quot; with some style." 
   style_="font-weight:bold;font-size:18pt;font-style:italic;"/>
</dynamic>

Example: Using `alttext_` and `alttextstyle_`

<dynamic>
  <widget class_="text" text_="This text is normal." 
   alttext_="This text is big and bold when you point at it." 
   alttextstyle_="font-weight:bold;font-size:24pt"/>
</dynamic>

Example: Using `type_="html"`

<dynamic>
  <widget class_="text" type_="html" 
   text_="<h1>This is an HTML header</h1><p>This is the first 
   paragraph.</p><p>This second paragraph has the function 
   <code>g_sum(G;S;X)</code> in monospaced font and 
   also has some <i>italicized</i> text for emphasis.</p>"/>
</dynamic>

Example: Using `<code>` and `<html>` within the `text` widget

The following example demonstrates how the <html> block form can be included within a text widget to display HTML text. It also uses the <code> block form to specify CSS to style the HTML. In addition, the value of the dynamic variable yourname, which is entered using the field widget, is referenced within the HTML text.

<dynamic yourname="">
  <layout arrange_="v">
    <widget class_="field" label_="Enter your name:" 
     value_="@yourname"/>
    <widget class_="text" visible_="{@yourname<>''}">
      <code language_="css"><![CDATA[ 
            h3 {
                font-size:24px;
                color:#F26F21;
            }

            p {
                font-family: verdana;
                font-size: 20px;
            }

            a {
                color:#C8102E;
            }
        ]]>
      </code>
      <html>
        <div>
          <h3>Hello, {@yourname}!
          </h3>
          <br/>
          <p>1010data offers the only fully-scalable, self-services 
            insights platform for data management, analysis and 
            application building.
          </p>
          <br/>
          <a target="_blank" href="http://www.1010data.com">
            Click here to learn more
          </a>
        </div>
      </html>
    </widget>
  </layout>
</dynamic>

Example: Using `<layer>` and `<text>` within the `text` widget

<dynamic store="1">
  <layout arrange_="v">
    <widget class_="dropdown" label_="Select a store" 
     value_="@store">
      <table>1;2;3
      </table>
    </widget>
    <widget class_="text">
      <layer value_="@totalsales" row_="1" col_="1">
        <base table="pub.demo.retail.item"/>
        <tabu breaks="store">
          <tcol source="sales" name="sumsales" 
           fun="sum" label="Sales"/>
        </tabu>
        <sel value="store={@store}"/>
        <colord cols="sumsales"/>
      </layer>
      <text>The total sales for store {@store} is ${@totalsales}.
      </text>
    </widget>
  </layout>
</dynamic>

Example: Using `<layer>` with `tablevalue_`

The following example demonstrates how a <layer> is used to specify a query that provides data for the text widget. In this example, the results of the query is saved in a table-value variable named stores. That variable is then accessible to the text specified after the <layer> tag. The text references the stores variable to display the store and city associated with the selection made in the dropdown widget.

<dynamic selection="1">
  <layout arrange_="v">
    <widget class_="dropdown" label_="Select a store" value_="@selection">
      <table>1;2;3
      </table>
    </widget>
    <widget class_="text" visible_="{@selection<>''}">
      <layer tablevalue_="@stores">
        <base table="pub.demo.retail.store"/>
      </layer>
      Store {@stores.store[@selection]} is located in {@stores.city[@selection]}.
    </widget>
  </layout>
</dynamic>