elastic.js: Module: FieldValueFactorFunction


        FieldValueFactorFunction ( field )

Multiply the score by the value of the field, multiplied by the factor.

Returns	Name	Description
`String`	`_type()`	The type of ejs object. For internal use only.
`Object`	`factor(factor)`	Sets the factor.
`Object`	`filter(oFilter)`	Adds a filter whose matching documents will have the score function applied.
`Object`	`modifier(modifier)`	Sets the modifier.
`String`	`toJSON()`	Retrieves the internal `agg` object. This is typically used by internal API functions so use with caution.


        String _type ( )

The type of ejs object. For internal use only.


        Object factor ( factor )

Sets the factor.


        Object filter ( oFilter )

Adds a filter whose matching documents will have the score function applied.


        Object modifier ( modifier )

Sets the modifier.

Parameters: modifier <Float> the modifier, one of none, log, log1p, log2p, ln, ln1p, ln2p, square, sqrt or reciprocal
Returns: returns this so that calls can be chained.


        String toJSON ( )

Retrieves the internal agg object. This is typically used by internal API functions so use with caution.