dataFrame.column.compare — outside()

The outside() method of the compare object returns a boolean mask indicating which values fall outside the specified minimum and maximum values. Boundaries can be included or excluded using the inclusive option.

dataFrame.column(columnName).compare.outside(minValue, maxValue, { inclusive: false })

Scope

column

Family

compare

Returns

mask

columnName (string)

The name of the column to compare values from.

minValue (number)

The lower bound of the comparison range.

maxValue (number)

The upper bound of the comparison range.

options (object)

Comparison options.

inclusive (boolean)

Whether the range boundaries should be included in the comparison.

• Is inclusive: 1
• Is not inclusive: 0
• Default: 0

mask ( boolean[] )

A boolean mask indicating the rows whose values fall outside the specified range.

• Between the values: 1
• Otherwise: 0

// higlight rows where the 'revenue' falls outside of of the range 1000 - 2000
var mask = df.column('revenue').compare.outside(1000, 2000);

// set mask to dataFrame
df.column('outside_1-2k').set(mask)