Data Formatting Functions

JavaScript Functions › Data Formatting Functions

Data Formatting Functions

The following linePrint* and table* functions simplify data formatting:

linePrintBegin
The linePrintBegin function creates a table into which line-by-line output will be written. This is useful when displaying 3270-style fixed width command output.
- Syntax
```
linePrintBegin([format])
```
- Parameters
- format—An optional format indicator that, if provided, must be one of the following values:
  - NOBOX: Do not put a box around the output.
  - FULLWIDTH: Use the available width of the window.
- Example
```
linePrintBegin("FULLWIDTH");
```
linePrint
The linePrint function writes a line of text into a line-by-line output table previously established by the linePrintBegin() function.
- Syntax
```
linePrint(text [,format])
```
- Parameters
- text—The text to be rendered
- format—An optional format indicator that, if provided, must be one of the following values:
  - MSGID: Hyperlink the first word to message help as a message ID.
  - CMDID: Hyperlink this text to command help as a command ID.
  - NUM: Insert line numbers at the beginning of each row.
  - TRANSPARENT: Use container's background color.
  - HTML: The text contains HTML so substitute problematic characters.
- Example
```
linePrint("N13511 19 USERS LOGGED ON",MSGID);
```
linePrintEnd
The linePrintEnd function closes the line-by-line output table created by linePrintBegin( ).
- Syntax
```
linePrintEnd()
```
- Parameters
  None.
- Example
```
linePrintEnd();
```
tableBegin
The tableBegin function creates the containing table structure and must be the first table statement issued.
- Syntax
```
tableBegin([title])
```
- Parameters
- title—The text to place in the title bar of this table
- Example
```
tableBegin("User list");
```
tableAlign
The tableAlign function sets the column alignment for each column in a table and must be issued before a tableHeading or tableRow statement. The value must be either left, center, or right, and defaults to left. All values are positional.
- Syntax
```
tableAlign(["left"|"center"|"right"|""][,…])
```
- Parameters
  Each parameter represents a table column and must contain one of the following values: left, center, right, or empty string.
- Example
```
tableAlign("","","right");
```
tableWrap
The tableWrap function sets the column wrapping for each column in a table and must be issued before a tableHeading or tableRow statement. The value must be either wrap, nowrap, or empty string, which defaults to wrap. All values are positional.
- Syntax
```
tableWrap(["wrap"|"nowrap"|""][,…])
```
- Parameters
  Each parameter represents a table column and must contain one of the following values: wrap, nowrap, or empty string.
- Example
```
tableWrap("","nowrap");
```
tableSorted
The tableSorted function sets the sorted indicator in a column heading indicating whether the column is sorted in ascending or descending order. The function must be issued before a tableHeading or tableRow statement. The value must be either A (ascending), D (descending), or empty string – not sorted. All values are positional.
- Syntax
```
tableSorted(["A"|"D"|""][,…])
```
- Parameters
  Each parameter represents a table column and must contain one of the following values: A, D, or empty string.
- Example
```
tableSorted ("","A");
```
tableUrl
The tableUrl function defines URLs for sort functions. If a column has a sort function URL, then the column heading has a button-like appearance and is a link. All values are positional.
- Syntax
```
tableUrl(url[,…])
```
- Parameters
  Each parameter represents a table column and must contain a valid URL for a JavaScript sort function, or empty string.
- Example
```
tableUrl("sort('name')","sort('date')");
```
tableHeading
The tableHeading function sets the headings for each column of a table and must be issued before a tableRow statement. The value must be a string. All values are positional. To set the column headings for a 3-column table to tic, tac, and toe, code tableHeading("tic","tac","toe").
- Syntax
```
tableHeading([string][,…])
```
- Parameters
  Each parameter represents a table column and must contain a string value.
- Example
```
tableHeading("Date","Time","User","Message");
```
tableHeadingComplex
The tableHeadingComplex function sets the headings for each column of a table and must be issued before a tableRow statement. It allows you to specify how many columns a table heading will span. The value must be a string. All values are positional.
- Syntax
```
tableHeadingComplex([string, colspan][,…])
```
- Parameters
  Each parameter pair represents a table column heading and the number of columns it will span. The column heading is a string value and the column span value is numeric.
- Examples
```
tableHeadingComplex("Date",1,"Time",1,"Values",3);
tableHeadingComplex("1st",1,"2nd",1,"3rd",1);
```
tableRow
The tableRow function sets the data for each column. The values provided must be strings and all values are optional and positional.
- Syntax
```
tableRow([string][,…])
```
- Parameters
  Each parameter represents a table column and must contain a string value.
- Example
```
tableRow("19-Mar-2003","12:34:09","usr1","Hello world");
```
tableRowSpan
The tableRowSpan function sets the data for each column and allows the data to span multiple columns. The values provided must be string-number pairs and all values are optional and positional.
- Syntax
```
tableRowSpan([string, colspan][,…])
```
- Parameters
  Each parameter pair represents a table column and must contain a string value followed by a numeric.
- Example
```
tableRowSpan("19-Mar-2003",1,"12:34:09",1,"usr1",1,"Hello world",4);
```
tableEnd
The tableEnd function closes the containing table structure and must be the last table statement issued. There are no parameters.
- Syntax
```
tableEnd()
```
- Parameters
  None.
- Example
```
tableEnd();
```