Dataflow Blocks Reference

Various blocks are available for creating your dataflow model. When you open the dataflow view, the blocks palette appears at the left of the dataflow window and contains blocks available to your dataflow model.


Variables

These blocks hold values.

Block Icon Description
String String block icon Holds values as a sequence of characters
Number Number block icon Holds values that describe a measurable quantity as a number
Boolean Boolean block icon Holds values that can be only TRUE or FALSE
Color Color block icon Holds values that describe a solid, gradient, or image fill that can be set with a DGLux5 fill pop-up.
Table Table block icon Holds values as a set of records

Data Services

Data Services blocks.

Block Icon Description
List Node List Node block icon Returns metadata about a node and its children
Get Default Parameters Get Default Parameters block icon Returns the default parameters and parameter values associated with a data action.
String Loader String Loader block icon Accesses a URL, and either returns the string located in that file or performs other actions based on HTTP request methods
String Uploader String Uploader block icon Saves a string as a new file in this project
List Files List Files block icon Returns a table that lists the contents of a project directory
Get Children Get Children block icon Returns a table that lists the children of a data node
Get Node Get Node block icon Returns metadata about a data node
Project Info Project Info block icon Returns information about the current user's session and the current project
Relativize Relativize block icon Converts a full file path to a relative file path, and manages changes to the non-relativized part of the path
Multi-Histories Multi-Histories block icon Retrieves a table of information about the value histories of multiple data nodes
Zip Upload Zip Upload block icon Adds, into the specified folder, all of the files from a ZIP file that is specified as binary
Zip Download Zip Download block icon Returns, as binary, a ZIP file that combines the files at the specified paths
Zip Parser Zip Parser block icon Takes a ZIP file as input and returns a table that contains the ZIP file’s contents.
Load Value no icon Retrieves information about the value of a data node
Load History no icon Retrieves information about the value history of a data node

Browser API

Browser API blocks.

Block Icon Description
JSONP Loader JNSONP Loader block icon Retrieves JSONP data from the specified URL
Geo-Location Geo-Location block icon Retrieves the user’s latitude and longitude
Device Orientation Device Orientation block icon Returns the DeviceOrientationEvent alpha, beta, and gamma of the device, if available
Device Motion Device Motion block icon Returns the current DeviceMotionEvent acceleration, acceleration including gravity, and rotation of the device, if available
Web Document Web Document block icon Sends and retrieves a variety of information to and from the browser, including device information, header title, and search and hash strings
Local Storage Local Storage block icon Allows your project to store information in the user’s browser, over multiple sessions and browser windows
Blob URL no icon Creates a temporary URL that holds a binary object or string
IFrame Message IFrame Message block icon Allows messages to be passed between an IFrame and its parent
Export HTML Export HTML block icon Exports the current .dg5 file as HTML
Get View Property Get View Property block icon Retrieves the HTML5 view property for a specified DGLux5 component
JavaScript JavaScript block icon Enables loading and running JavaScript and accessing JavaScript and HTML APIs
Close Warning Dialog no icon Causes a warning dialog to be displayed when the user tries to close this page

Logic

Logic dataflow blocks.

Block Icon Description
And And block icon Returns one value if all its input properties are TRUE and another value if one or more input properties is FALSE
Or Or block icon Returns one value if one or more of its input properties is TRUE, and another value if all input properties are FALSE
Not Not block icon Returns FALSE when its input is TRUE and returns TRUE when its input is FALSE
If If block icon Specifies a logical test to perform, and returns one value if the condition evaluates to TRUE and another value if it evaluates to FALSE
Case Case block icon Evaluates a list of conditions and returns the result corresponding to the first condition that is met.
Hub Hub block icon Outputs the most recently updated value from multiple inputs
Event Gate Event Gate block icon Listens for changes to multiple inputs and fires a new event when all of the inputs have changed
Script Script block icon Holds a custom script
Trace Trace block icon Monitors changes to specified properties and logs changes in the browser's JavaScript console
Stop Watch Stop Watch block icon Counts up when enabled
Delay Delay block icon Accepts an input value, waits a predetermined amount of time, and then returns the input as output
State State block icon Activates and deactivates the defined state upon invoke and revert triggers
Mouse Event Mouse Event block icon Fires a trigger when the defined mouse event occurs
Keyboard Event Keyboard Event block icon Fires a trigger when the defined keyboard event occurs
Scroll Event Scroll Event block icon Fires a trigger when the defined scroll event occurs
Resize Event Resize Event block icon Listens for a resize event, and fires a trigger when such an event is detected
Drag Position Drag Position block icon Allows the user to move an object by dragging that object or one of its children
Drag Size Drag Size block icon Allows the user to resize an object by dragging that object or one of its children
Repeater no icon Returns a table that, for each row in an input table, lists the parameter values of an input dataflow symbol
Catch Error Catch Error block icon Outputs the latest error from the dataflow blocks in an error group
Map Series Data no icon

String Operations

These String Operations blocks return information about strings or perform manipulations on strings.

Block Icon Description
Concatenate Concatenate block icon Joins multiple text strings into one string
Left Left block icon Returns the specified number of leftmost characters from a string
Length Length block icon Returns the number of characters in a string
Right Right block icon Returns the specified number of rightmost characters from a string
Substring Substring block icon Returns a specific substring from a string
Replace Replace block icon Replaces a substring of a text value
Trim Trim block icon Removes all leading and trailing whitespace from text
Split no icon Separates an input string into pieces, as defined by a delimiter, and returns the pieces as rows in an output table

Math Operations

Math Operations blocks perform arithmetical operations on numbers.

Error values, and text that cannot be resolved to numbers, cause a NaN error result to be returned. The following are accepted and excluded arguments for Math Operations blocks:

  • Numbers, logical values, and numbers represented as strings are accepted.
  • Error values, and text that cannot be resolved to numbers, are ignored in the calculation.
Block Icon Description
Add Add block icon Adds its arguments
Divide Divide block icon Divides its arguments
Factorial Factorial block icon Returns the single factorial of a number
Logarithm Logarithm block icon Calculates the logarithm of a number using a specified base
Modulo Modulo block icon Returns the quotient and remainder from division
Multiply Multiply block icon Multiplies its arguments
Power Power block icon Returns the result of raising a number to an exponent
Root Root block icon Returns the nth root of a number
Scale Scale block icon Returns the result of re-scaling a number from one defined set of lower and upper limits to another.
Subtract Subtract block icon Subtracts its arguments

Number Formatting

Number Formatting blocks perform formatting operations on numbers.

The following are accepted and excluded arguments for Number Formatting blocks:

  • Numbers, logical values, and numbers represented as strings are accepted.
  • Error values, and text that cannot be resolved to numbers, cause a NaN error result to be returned.
BlockIcon Description
Absolute Absolute block icon Returns the absolute value of a number
Bound Bound block icon Returns the value of a number within the defined minimum and maximum
Round Round block icon Rounds a number using a specified precision
Round Up Round Up block icon Rounds a number up using the specified precision
Round Down Round Down block icon Rounds a number down using the specified precision
Gradient Mapping Gradient Mapping block icon Correlates a number range to a color gradient and returns an output color that corresponds to an input number
Format Number Format Number block icon Returns a number or string based on defined formatting criteria
Parse Number Parse Number block icon Returns a number parsed out of a string

Statistical Functions

The Statistical Functions blocks calculate statistical functions on a list of input values. See also: How to Add and Remove Input/Output Properties.

The following are accepted and excluded arguments for Statistical Functions blocks:

  • Values of the input n property can be numbers, arrays, or references that contain numbers.
  • Numbers, logical values, and numbers represented as strings are included in calculations.
  • Input values are ignored if they are error values, null, or text that cannot be parsed as a number.
  • Input values of zero are included in calculations.
Block Icon Description
Average Average block icon Returns the mean of its arguments
Maximum Maximum block icon Returns the greatest value in a list of arguments
Median Median block icon Returns the median of its arguments
Minimum Minimum block icon Returns the smallest value in a list of arguments
Mode Mode block icon Returns the most common value in a list of arguments
Standard Deviation Standard Deviation block icon Calculates standard deviation based on a list of arguments
Variance Variance block icon Calculates the statistical variance of a list of arguments

Trigonometric Functions

These Trigonometric Functions blocks perform trigonometry operations on an input number and return an output number.

Block Icon Description
Arc Cosine Arc Cosine block icon Returns the arccosine, or inverse cosine, of a number, in degrees
Arc Sine Arc Sine block icon Returns the arcsine, or inverse sine, of a number, in degrees
Arc Tangent Arc Tangent block icon Returns the arctangent, or inverse tangent, of a number, in degrees
Cosine Cosine block icon Returns the cosine of the given angle
Cotangent Cotangent block icon Returns the cotangent of an angle, in degrees
Degree Degree block icon Converts radians to degrees
Radian Radian block icon Converts degrees to radians
Sine Sine block icon Returns the sine of the given angle
Tangent Tangent block icon Returns the tangent of the given angle

Table Operations

These Table Operations blocks perform various operations for creating and managing tables.

Block Icon Description
CSV Parser CSV Parser block icon Converts a CSV string into a table
CSV Writer CSV Writer block icon Takes an input table and returns the table as a CSV string
JSON Parser JSON Parser block icon Converts a JSON string into a table
Column Mapping Column Mapping block icon Returns a new table that can include specified columns from the input table and can include new columns that contain calculated values
Sort Sort block icon Returns a new table that reorders the input table’s rows
Filter Filter block icon Returns a new table that contains only the rows from the input table that meet a condition
Group By Group By block icon Returns a new table that contains one row for each group of rows in the input table
Join Join block icon Returns a new table that joins the rows of two input tables
Page Page block icon Returns a specified portion of the input table based on paging parameters
Rollup Rollup block icon Returns a new table that contains one row for each date and time interval in the input table
Aggregation Aggregation block icon Returns a value that reflects the table records in the specified column
Select Rows Select Rows block icon Returns a table that contains only the specified rows from the input table
Select Columns no icon Returns a table that contains only the defined column names from the input table
Get Columns Get Columns block icon Returns a table that contains the names and data types of the input table's columns
Table Row Cells Table Row Cells block icon Returns values from the specified cells in a certain row
Add Row Add Row block icon Adds a row to the input table
Remove Rows no icon Deletes rows from the input table
Edit Rows Edits Rows block icon Replaces values in the input table
Transpose Transpose block icon Transposes a table, so that the columns in the input table are rows in the output table
Realtime Recorder Realtime Recorder block icon Monitors changes to specified values and creates a table to record current and historical values
Series Realtime Recorder no icon Monitors the single current value of each specified metric and creates a table of those current values without storing historical values

Date Time Operations

These Date Time Operations blocks perform formatting and other operations on dates, times, and ranges.

Block Icon Description
Date Time Date Time block icon Takes multiple inputs that represent a year, month, day, hour, minute, second, and millisecond and returns the sequential serial number that represents the date and time
Date Format Date Format block icon Reformats a date and time string or converts a serial number to a date and time string
Parse Date Time Parse Date Time block icon Converts a serial number or a date and time string to multiple outputs that represent the serial number, year, month, day, hour, minute, second, millisecond, and weekday
Date Math Date Math block icon Adds time to or subtracts time from the input date and time
Date Range Date Range block icon Returns a formatted date and time range based on the defined formatting options

Constants

These Constants blocks are special Number blocks that hold mathematical constants when the blocks are created.

Block Icon Description
Pi Pi block icon A Number block that holds the mathematical constant pi
E e block icon A Number block that holds the mathematical constant e
SQRT2 SQRT2 block icon A Number block that holds the mathematical constant for the square root of 2
LN2 LN2 block icon A Number block that holds the mathematical constant for the natural logarithm of 2
LN10 LN10 block icon A Number block that holds the mathematical constant for the natural logarithm of 10
LOG2E Log2e block icon A Number block that holds the mathematical constant for the base-2 logarithm of the constant e
LOG10E log10e block icon A Number block that holds the mathematical constant for the base-10 logarithm of the constant e

Actions

These blocks appear automatically when you create an action.

Action Block Description
Set State State
Open Web Open Web
Download File Download File
Play Sound Play Sound
Open Page Open Page
Close Page Close Dashboard
Logout Logout
Data Invoke Action

Bindings

These blocks appear automatically when you create a data to property binding or use the Binding Dialog.

Block Description
Query Binding or Value Binding Contains all of the information that is configured in the Binding Dialog