DriveWorks Pro 23

TableFilterByFunction

TableFilterByFunction

Filters a table of data or array based on a single column using the provided Lambda Function.

Syntax

TableFilterByFunction(Input Array, Column Index, Filter Function, [Include Header Row])

Where:

Input Array is the array to iterate over.

Column Index is the column to check for a match.

Filter Function if the result of this function is TRUE, it will be included in the result.

Include Header Row (optional) if TRUE, the header will be included in the filter, FALSE (default) to exclude.

• Input Arrays are assumed to include a header row by default. Set this argument to TRUE if the Input Array does not have a header row.

Filter Function

Please see Higher Order Functions for more information on this type of function.

The DWLambda used for the filter function uses the following syntax:

DWLambda(value, [rowIndex], Function)

value is the value in the specified column of the original table to be evaluated.

• When the Input Array is parsed, the value from each row of the specified column is passed to the function.
• value is a required parameter in the Function argument.

rowIndex (optional) is the index of the row currently being evaluated.

• When the Input Array is parsed the index of each Row is passed to the function.
• Using the rowIndex in the Function argument is optional.
• The Filter Function will not retrieve values from the header row. A rowIndex of 1 will refer to the first data row, which is the first row after the header row or the first row in a table with no headers (in which case Include Header Row must be set to TRUE).

Function is the Lambda function to be executed.

• Each row in the Input Array where this function equals True, will be included in the result.
• Optionally use the rowIndex argument in the function. See Example 2.
• We recommend only using pure functions in the filter.
• Also observe the information on Blocked Functions and Further Restrictions.

Examples

TableFilterByFunction(
	DwLookupBeamSizes, 
	4, 
	DWLambda(
		value, 
		value>11
		)
	,FALSE 
)

TableFilterByFunction(
	DwLookupBeamSizes,
	4, 
	DWLambda(
		value, 
		rowIndex,
		If(
			rowIndex=2,
			FALSE, 
			value>10
			)
		),FALSE
	)

See Also

Higher Order Functions - About higher order functions.

DWLambda - Allows custom, reusable functions to be created.

TableMap - Applies a Lambda Function across a provided array and returns a new array with the result of the Lambda function applied.

TableFilterByRowFunction - Filters an array using the provided Lambda Function applied to each row.