Data Filter

dtf<<Add Favorites(name|string)

Description

Associates the current filter selection with the specified name and saves it in the Favorites list.

Returns

The favorite as a string.

Example

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );

df = dt << Data Filter(

Add Filter(

Columns( :age, :sex, :height, :weight ),

Where( :sex == "F" ),

Where( :height >= 55 & :height <= 65 )

Mode( Select )

);

Wait( 1 ); // for demonstration purposes

fav1 = df << Add Favorites( "Female Average Ht" );

dtf<<Add Filter(columns(column <,col>), <Where(clause)>)

Add one or more filter columns in a new OR group.

dtf<<Auto Clear(0|1)

Clears all currently selected rows before setting a new selection.

dtf<<Clear

Clears the currently selected rows.

dtf<<Close

Closes the data filter window.

dtf<<Columns(col1, col2, ...)

Sets the columns to use in the data filter.

dtf<<Data Table Window

Shows the data table that the data filter window is using.

dtf<<Delete All

Removes all filters that are set.

dtf<<Delete(col1, col2, ...

Removes the specified columns from the data filter.

dtf<<Display(col, <Size(x, y)>, "Blocks Display"|"List Display"|"Single Category Display"|"Checkbox Display")

Sets how the specified categorical column levels are displayed in the filter. The specified column must be categorical.

dtf<<Get Script

Returns the data filter script as text in the log.

Example

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );

df = dt << Data Filter(

Add Filter( Columns( :age, :sex ), Where( :age == 12 ) )

);

txt = df << Get Script;

Show( txt );

dtf<<Local Data Filter

Embeds the data filter in the specified window.

dtf<<Location(x, y)

Moves the data filter window to the specified location. X and y are measured in pixels. 0,0 is the top left of the monitor.

dtf<<Make Filter Change Handler(Function(a))

Returns the number of rows that are filtered in the data filter. The number of filtered rows is returned in the argument to Function().

Example

dist = Distribution( Automatic Recalc( 1 ), Continuous Distribution( Column( :POP ) ) );

filter = dist << Local Data Filter( Add Filter( Columns( :Region ) ) );

f = Function( {a}, Print( a ) );

rs = filter << Make Filter Change Handler( f );

dtf<<Make Subset

Creates a new subset data table that contains the rows that are selected in the data filter.

dtf<<Match(Filter Columns(:col1, :col2, ...), Where(WHERE clause)

Sets the filter conditions for each column. The WHERE clause is used for all the columns listed. To use different WHERE clauses for different columns, send the Match message separately for each column.

dtf<<Mode(Select(0|1)|Show(0|1)|Include(0|1))

Sets the action, or mode, that is used when rows are selected using the data filter.

dtf<<Save and restore current row states

Saves the current row states for the data table, and then restores those states when the data filter is closed.

dtf<<Show Columns Selector(0|1)

Displays or hides the column selector after completing a filter.

dtf<<to Clipboard

Creates a WHERE clause from the current state of the data filter and places it on the clipboard, where it can be pasted elsewhere.

dtf<<to Data Table

Creates a WHERE clause from the current state of the data filter and saves it as a property to the data table.

dtf<<to Journal

Creates a WHERE clause from the current state of the data filter and appends it to the current journal. If there is no current journal, a new journal is opened and the WHERE clause is added to it.

dtf<<to Row State Column

Creates a row state column whose formula is the WHERE clause.

dtf<<to Script Window

Creates a WHERE clause from the current state of the data filter and appends it to the current script window. If there is no current script window, a new script window is opened and the WHERE clause is added to it.

dtf<<Use Floating Window(0|1)

Sets whether the data filter window floats on top of its associated data table or behaves as a normal window.

dtf<<Where(WHERE clause)

Sets a condition for selecting rows.