Class RemoveFunction


  • public class RemoveFunction
    extends Object
    A mapping function to remove an AnalyticsValue from an AnalyticsValue or an AnalyticsValueStream. For each document, the value exists if it doesn't equal the value of the second parameter.

    The first parameter can be any type of analytics expression. If the parameter is multi-valued, then the return will be multi-valued. (Required)
    The second parameter, which is the value to remove from the first parameter, must be an AnalyticsValue, aka single-valued. (Required)

    The resulting Value or ValueStream will be typed with the closest super-type of the two parameters. (e.g. "remove"(int,float) will return a float)