Knowledge Base - Levels plugin

 

What is it

Using Geocode Factory's Levels plugin you can create hierarchical levels of checkboxes that filter through the data displayed on your maps. These different levels of checkboxes allow your users to browse the map with the added functionality of being able to select different combinations of available dependancies as filters, on the fly.

To come up with our users' desired combination of filters to apply to your data pool, the level plugin works as follows:  As a rule, the lower level checkboxe(s) selected are a condition that is met first, before progressively meeting the condition(s) of each subsequent higher level checkbox that is selected.

all-cities-men


Installation

Overview

Note: In order to use Geocode Factory's Community Builder levels plugin, you need to have the Geocode Factory 5 component already installed.

If you plan on using the levels plugin for filtering data of other 3rd party extension(s) (ex: SobiPro, K2, CB, Mosets, etc) you will also need to have installed the(se) extension(s) as well as the appropriate Geocode Factory Gateway plugin(s).

For examlpe, in our levels plugin documentation we will be using the data provided by a Community Builder Joomla installation. In this case, we have already installed the Community Builder extension as well as the Geocode Factory profile and gateway plugins for Community Builder.

Please note that the profile and gateway plugins for Community Builder (or any other 3rd party extension) are not included in your Geocode Factory 5 package by default. These are optional extras.

Access and Download

Please read the Download, install and update manual for more information.

Installation

The Geocode Factory Levels plugin file "plg_geofactory_levels.zip" is installed using the standard Joomla installer (please see the main GF5 documentation).

jinstallpage

 


Joomla Plugin configuration

Inside the joomla “Plugin Manager” you will find the installed levels plugin. To locate it more easily, you can use the filter by adding the text “levels” for example, as in the following image:

levels plugin joomla manager

Configuring the Levels plugin is easy, you don't have many options. Basically you only need to make sure it is published. 

levels plugin configuration

If you plan on making the plugin available to all users (guests, registered, etc), you do not need to configure anything else here. Otherwise, simply select the usertype availability from the "Access" dropdownmenu and save.


 

Levels and Markersets

 

Overview

 

Unlike most other Geocode Factory plugins, the only place where the plugin set-up takes place is within the markersets manager.

As we mentioned in the beginning, Geocode Factory's Levels plugin allows you to create hierarchical levels of checkboxes that filter through the data to be displayed on your maps. These different levels of checkboxes allow your users to select different combinations of dependancies from the available checkbox options.

As you may already know, a checkbox in Geocode Factory represents a markerset. Each level can have one or more markersets/checkboxes assigned to it. And of course each markerset in Geocode Factory can have one or more sets of filtering criteria applied to it.

How it Works - Our Example

To illustrate, we will showcase the following example of a map displaying site users from the Community Builder extension.

Our first level has checkboxes that filter the cities our users are located in, while the second level displays checkboxes that filter our users' Sex.

In the first image, all users from the three available cities are displayed on the map (8 in total), as you see here:

all-levels

In the second image, we will unselect the the "Men" checkbox to display the women only (from all the three available cities again). As you see in the following image we don't have any women in Milan.

all-cities-women

 

In our final illustration we select to see the men located in Zurich and Milan only:

milan-zurich-men

 

Now, let's have a look at how to set them up.


Levels and Markersets Set-up

 

Overview

How you set up your markersets depends on what you would like to do and the data you have to do it with. Please remember that the level plugin works as follows:  The lower level checkbox (es) selected is (are) a condition that is met first, before progressively meeting the condition(s) of each subsequent higher level checkbox that is selected.

 

Setting Up the Marksersets

Top level (Level 1)

So the first thing you need to do is to create a new (or edit an old) markerset and assign it as a Top level (Level 1) checkbox in your level dependancy hierarchy/structure. To do this is fairly simple:

1-) Go to your markerset manager.

2-) Create a new (or edit an existing) markerset configuring it as you like (for further information consult the documentation on Markersets ).

You can apply any combination of filters you desire from the the specific settings tab of your markerset. In our example, we used the "Filter Generator" to match our Community Builder custom field data for "City". In the following image you see the case of the "Paris" markerset:

paris-specific-settings

The name of our Community Builder custom field is "cb_city" as seen in the following image from our CB field manager:

cb-custom-field-city

 

3-) The last option on the first tab "Basic Markerset Settings" is where you assign the level to your markersets, as seen in the following image. Set this to "Top Level" (this is the default so it is probably already set here).

top-level-assignment

 4-) Repeat this process for as many markersets as you want to have appear as Level 1 (Top Level). You MUST have at least one markerset assigned as Top Level. In our example above we had three markersets: Milan, Zurich and Paris.

 

Level 2

The next thing you need to do is to create a new (or edit an old) markerset and assign it as a Level 2 checkbox in your level dependancy hierarchy/structure. To do this:

1-) Go to your markerset manager.

2-) Create a new (or edit an existing) markerset configuring it as you like (for further information consult the documentation on Markersets ). You can apply any combination of filters you desire from the the specific settings tab of your markerset.

In our example, we used the "Filter Generator" to match our Community Builder custom field for "Sex" . In the following image you see the case of the "Women" markerset:

sex-specific-settings

The name of our Community Builder custom field is "cb_sex" as seen in the following image from our CB field manager:

cb-custom-field-sex

3-) The last option on the first tab "Basic Markerset Settings" is where you assign the level to your markersets as seen in the following image. Set this to "1" (Because "Top level"  =  Level 1, the option "1" here = Level 2, option "2" will = Level 3, etc ).

level-assignment-for-sex-markerset

 4-) Repeat this process for as many markersets as you want to have appear as Level 2. You MUST have at least one markerset assigned as Level 2. In our example above we had 2 markersets: Men and Women.

 

Level 3 and more levels

You must have at least two levels - Level 1 and Level 2- for the Levels plugin to work. Extra levels are optional.

You can repeat the process as shown above for adding further levels, it is the same idea.

 

Please note:

For the map to produce any results, the user must select at least one checkbox from each level. For example, if you select Milan, Zurich and/or Paris but without selecting Men and/or Women you will not have any results displayed. Same thing if you select Men and/or Women but do not select any of the cities.

 

More about the "Specific Settings" tab:

The filtering options on the "Specific Settings" tab are generated based on the currently selected/used pattern (and 3rd party extension GF gateway). In this tab you can select various different filters for the current markerset allowing you to fully customize your data pool. Please consult the Specific Settings tab section documentation of the 3rd party extension you are using for more information.

Applies To

Geocode Factory 5