Filter Overview

Filter is the important entities of GudHub. It is responsible for the sorting and structuring data.

There are several items that have filter: table, . Some of them use it inside the code, others allows to use it in the application. The programmer decides which item will have the filter.

Every data that display items has its own filtering set. The filtration takes field values for finding and selecting needed data. Also, you can configure filter for different fields and select the type of the filtration.

The filter accepts different types of search values (string, number etc.) and can be applied for different types of fields.

It accepts two arrays as arguments:

import GudHub from '@gudhub/core';
const gudhub = await new GudHub();
let items = [{
  "item_id": 2987986,
  "fields": [{
        "field_id": 645888,
        "field_value": "John",
      }],
  },
  {
  "item_id": 2987996,
  "fields": [{
        "field_id": 645888,
        "field_value": "Johana",
      }]
  }
];

let filter_list = [{
    "data_type": "text",
    "field_id": 645888,
    "search_type": "search",
    "selected_search_option_variable": "Value",
    "valuesArray": ["john"]
    }
];

gudhub.filter(items, filter_list);

Filter is not applied without search values.

Filter allows you to add several filters for the same item at the same time. In turn, the fields can have only one filter. But, as fields can contain multiple value, filters can search for a few ones.

As for filters JSON, all filters data is contained in filters_list which in turn located in the certain item. For example:

filters_list: [{
    "data_type": "text",
    "field_id": 603733,
    "search_type": "contain_or",
    "selected_search_option_variable": "Value",
    "valuesArray": ["field value",...],
},...]

As you can see, filters_list consists of the filter object. If there is no filter in item, list is empty.

getFilteredItems

There is also a separate method that returns items with filters applied to them. This method accepts the same arrays as the filter method plus a few new arguments. getFilteredItems can be call in two ways:

• Directly through Utils
• Through Lib

They are not that different, but have some differences.

Through Utils

Accepts all arguments separately.

import GudHub from '@gudhub/core';
const gudhub = await new GudHub();
let items = [{
  "item_id": 2987986,
  "fields": [{
        "field_id": 645888,
        "field_value": "John",
      }],
  },
  {
  "item_id": 2987996,
  "fields": [{
        "field_id": 645888,
        "field_value": "Johana",
      }]
  }
];

let filter_list = [{
  "data_type": "text",
  "field_id": 645888,
  "search_type": "search",
  "selected_search_option_variable": "Value",
  "valuesArray": ["john"]
  }
];

let element_app_id = 2343552;

let app_id = 13453;

let item_id = 122345;

let field_group = [];

let filteredItems = await gudhub.utils.getFilteredItems(items, filters_list, element_app_id, app_id, item_id, field_group);
console.log(filteredItems);

Through Lib

Accepts some arguments as properties of an object named options.

import GudHub from '@gudhub/core';
const gudhub = await new GudHub();

let items = [{
  "item_id": 2987986,
  "fields": [{
        "field_id": 645888,
        "field_value": "John",
      }],
  },
  {
  "item_id": 2987996,
  "fields": [{
        "field_id": 645888,
        "field_value": "Johana",
      }]
  }
];

let filter_list = [{
  "data_type": "text",
  "field_id": 645888,
  "search_type": "search",
  "selected_search_option_variable": "Value",
  "valuesArray": ["john"]
  }
];

let options = {
  element_app_id: "665778",
  app_id: "342323",
  item_id: "3424222",
  field_group: "34323"
};


let filteredItems = await gudhub.getFilteredItems(items, filters_list, options);
console.log(filteredItems);

Search Types

The filter can accept multiple values for searching at the same time. For comfortable filtering you can choose on what basis the filter will select the fields. For example, you want to get all results that contain you value or on the contrary all results without your value. So, you can configure filter for such needs due to search_type. It has a large range of values:

• contain_or
• contain_and
• not_contain_or
• not_contain_and
• equal_or
• equal_and
• not_equal_or
• not_equal_and
• phone_equal_or
• distance
• search
• bigger
• lower
• range
• date_in
• date_out
• recurring_date
• value

For convenience, we can divide some of them into groups:

1. Contains
2. Equals
3. Number filters
4. Date filters

The rest of filters will be described separately.

All details about them you can read in the next chapters.