Skip to main content

ValueMatcher

Defined in: js-api/src/dataframe/row.ts:140

Value matcher. See usage example: https://public.datagrok.ai/js/samples/data-frame/value-matching/value-matcher

Constructors​

Constructor​

new ValueMatcher(dart): ValueMatcher

Defined in: js-api/src/dataframe/row.ts:145

Parameters​

ParameterType
dartany

Returns​

ValueMatcher

Properties​

PropertyModifierTypeDefined in
supportedTypesstaticstring[]js-api/src/dataframe/row.ts:141

Accessors​

operator​

Get Signature​

get operator(): string

Defined in: js-api/src/dataframe/row.ts:179

Operation (such as '<', 'EQUALS', 'BEFORE', etc).

Returns​

string


pattern​

Get Signature​

get pattern(): string

Defined in: js-api/src/dataframe/row.ts:176

Expression as entered by user (such as '>42')

Returns​

string

Methods​

match()​

match(value): boolean

Defined in: js-api/src/dataframe/row.ts:183

Whether [x] passes the filter specified by the [expression]. See also validate for the explanation.

Parameters​

ParameterType
valueany

Returns​

boolean


validate()​

validate(value): string | null

Defined in: js-api/src/dataframe/row.ts:186

Validates the specified conditions. Returns null, if valid, error string otherwise

Parameters​

ParameterType
valueany

Returns​

string | null


bool()​

static bool(pattern): ValueMatcher

Defined in: js-api/src/dataframe/row.ts:173

Parameters​

ParameterType
patternstring

Returns​

ValueMatcher


dateTime()​

static dateTime(pattern): ValueMatcher

Defined in: js-api/src/dataframe/row.ts:172

Parameters​

ParameterType
patternstring

Returns​

ValueMatcher


forColumn()​

static forColumn(column, pattern): ValueMatcher

Defined in: js-api/src/dataframe/row.ts:148

Creates a matcher for the specified column.

Parameters​

ParameterType
columnColumn
patternstring

Returns​

ValueMatcher


forType()​

static forType(type, pattern): ValueMatcher

Defined in: js-api/src/dataframe/row.ts:153

Creates a matcher for the specified data type.

Parameters​

ParameterType
typestring
patternstring

Returns​

ValueMatcher


numerical()​

static numerical(pattern): ValueMatcher

Defined in: js-api/src/dataframe/row.ts:170

Parameters​

ParameterType
patternstring

Returns​

ValueMatcher


string()​

static string(pattern): ValueMatcher

Defined in: js-api/src/dataframe/row.ts:171

Parameters​

ParameterType
patternstring

Returns​

ValueMatcher