Filter options

FilterOption

Class representing a filter option.

These are more prescribed options available on certain resources, such as the specimens and index lot resources, and typically are shown as tick boxes.

Source code in ckanext/nhm/lib/filter_options.py

class FilterOption:
    """
    Class representing a filter option.

    These are more prescribed options available on certain resources, such as the
    specimens and index lot resources, and typically are shown as tick boxes.
    """

    def __init__(self, name, label, filter_dsl, hide=False):
        """
        :param name: the name of the option, this is the name passed through in the filter
        :param label: the text to show on the frontend to the user
        :param filter_dsl: an elasticsearch-dsl query object which actually does the filter. This is
                           applied in the ckanext-nhm plugin.
        :param hide: whether to hide the filter on the frontend or show it, default is False (i.e.
                     show the filter option)
        """
        self.name = name
        self.label = label
        self.filter_dsl = filter_dsl
        self.hide = hide

    def as_dict(self):
        """
        Produces a dict with the details required by the frontend to show the filter
        options to the user.

        :returns: a dict with the name and the label for the filter
        """
        return {
            'name': self.name,
            'label': self.label,
        }

__init__(name, label, filter_dsl, hide=False)

Parameters:

Name	Type	Description	Default
name		the name of the option, this is the name passed through in the filter	required
label		the text to show on the frontend to the user	required
filter_dsl		an elasticsearch-dsl query object which actually does the filter. This is applied in the ckanext-nhm plugin.	required
hide		whether to hide the filter on the frontend or show it, default is False (i.e. show the filter option)	False

Source code in ckanext/nhm/lib/filter_options.py

def __init__(self, name, label, filter_dsl, hide=False):
    """
    :param name: the name of the option, this is the name passed through in the filter
    :param label: the text to show on the frontend to the user
    :param filter_dsl: an elasticsearch-dsl query object which actually does the filter. This is
                       applied in the ckanext-nhm plugin.
    :param hide: whether to hide the filter on the frontend or show it, default is False (i.e.
                 show the filter option)
    """
    self.name = name
    self.label = label
    self.filter_dsl = filter_dsl
    self.hide = hide

as_dict()

Produces a dict with the details required by the frontend to show the filter options to the user.

Returns:

Type	Description
	a dict with the name and the label for the filter

Source code in ckanext/nhm/lib/filter_options.py

def as_dict(self):
    """
    Produces a dict with the details required by the frontend to show the filter
    options to the user.

    :returns: a dict with the name and the label for the filter
    """
    return {
        'name': self.name,
        'label': self.label,
    }