public class Filter extends BaseOption
A declarative filter to control of which data labels to display. The declarative filter is designed for use when callback functions are not available, like when the chart options require a pure JSON structure or for use with graphical editors. For programmatic control, use the formatter
instead, and return undefined
to disable a single data label.
Constructor and Description |
---|
Filter() |
Modifier and Type | Method and Description |
---|---|
String |
getOperator()
The operator to compare by.
|
String |
getProperty()
The point property to filter by.
|
Number |
getValue()
The value to compare against.
|
Filter |
setOperator(String operator)
The operator to compare by.
|
Filter |
setProperty(String property)
The point property to filter by.
|
Filter |
setValue(Number value)
The value to compare against.
|
set_hcNulledOption
public static final Filter NULL
public String getOperator()
The operator to compare by. Can be one of >
, <
, >=
, <=
, ==
, ===
, !=
and !==
.
public Filter setOperator(String operator)
The operator to compare by. Can be one of >
, <
, >=
, <=
, ==
, ===
, !=
and !==
.
operator
- the value for the operator optionpublic String getProperty()
The point property to filter by. Point options are passed directly to properties, additionally there are y
value, percentage
and others listed under Highcharts.Point
members.
public Filter setProperty(String property)
The point property to filter by. Point options are passed directly to properties, additionally there are y
value, percentage
and others listed under Highcharts.Point
members.
property
- the value for the property optionpublic Number getValue()
The value to compare against.
Copyright © 2024. All rights reserved.