Introduction

Enhance the visual appeal of your dashboard by integrating customizable filters that seamlessly integrate with the Sisense Dashboard filters shelf. Add capability by configuring filters to apply to the whole dashboard or to selected widgets, allowing side-by-side comparisons and better data storytelling.

It's all possible with Adaptive Filters and configuration is made simple through the widget design panel with a no-code approach, allowing for flexibility in functionality, aesthetics, and colour schemes. The filters support multiple selection, single selection, and date range selection options.

Everything from colors, padding, alignment, font-size to hiding the heading if desired, or changing the sort order, is at your finger tips. This is a well used Sisense add-on and the options have been developed based on customer requests.

The same dimension can be used with different filtering by applying our filters to specific widgets rather than the whole dashboard. This opens up big possibilities such as side-by-side comparisons

Date Picker supports US and International date formats. Single-Select can be forced to remain single-select. Multi-Select includes great features such as:

• Displays the selections and adds a +x more if more selections are made than will fit in the space.

• Places selected items at the top of the list (so you can deselect something without needing to search for it).

• Allows for searching of items by typing in the first few letters.

Customer-driven advanced functionality such as the ability to set the widget not to show certain options that were returned. For example, you may not want your dropdown to display an NA record.

The ability to set the path through specific or multiple fact tables to display exactly the options you want users to choose from (critical when RLS has been applied on a connected dimension).

Getting Started

Before Installing this Add-on, please make sure you've installed and configured the RAPID Plugin Manager.

Download the latest RAPID BI Plugins from the Members Area.

More information can be found here: https://www.rapidbi.com.au/members/index.php?/Knowledgebase/Article/View/getting-started

Installation

1. Download the plugin

2. Extract the zip file to `\Plugins` folder in Sisense (File Manager can be accessed via. Admin > Server & Hardware > System Management > File Manager (top right hand corner))

3. Ensure that the RAPID Plugins Manager has also been installed and enabled in the addons page.

4. After rebuild, the plugin should be accessible through the advanced widget editor. You will need to refresh your browser.

How to use

Adding Widget to Dashboard

1. On a dashboard, select the + Widget button in the top right-hand corner.

2. When the New Widget Prompt appears, select Advanced Configuration in the bottom left-hand corner.

3. When the Widget Editor appears, select the widget type in the top left hand corner and select the RAPID DeckGL Maps plugin.

Widget Overview

Below is an image outlining the key areas of the initial Widget Editor view.

1. Items Panel

area_type:

This is the area type dimension that contains the ID of the location shape. It should correspond to the uploaded geoJSON property ID specified in the upload process (see uploading new shapes below)

height:

This metric is relevant for 3d maps. It will adjust the height of displayed shapes relative to the formula or measure item placed here.

colour:

It will adjust the colour gradient shading of shapes based on the formula or measure item placed here. This panel also supports series categories, but support is limited at this stage (it will provide distinct colors for each named category, but no legend or configuration of these colors at this stage).

info_box_details:

This panel can contain up to three items describing the shapes on the map. When placed in the panel, these items can be used in the tooltip display (see customizing tooltips below).

2. Widget Preview

The widget preview window will show the widget as it will appear in the dashboard. If no results are shown, please check that the area_type selected corresponds with any of the uploaded shapes and that there is at least a colour item populated.

3. Design Panel

Map Styling

Map Design (Dark || Light || Satellite):

Changes the underlying map style based on the selection.

Dimension (2D || 3D):

Changes the map rendering type from 3D to 2D and allows height panel to take effect.

Shapes Style

Height Multiplier (number):

Increases relative difference between shape heights by multiplier entered here.

Opacity (Slider %):

Affects how transparent / opaque shapes are on the map.

Note: When Opacity is 100%, strokes / lines between shapes may not be immediately visible without adjusting map viewport pitch.

Color on Hover (Enabled || Disabled):

Adjusts Shape Color on Hover functionality - when enabled, the shape color will change when the viewer hovers over the shape with the mouse cursor.

Highlight Color (#000000 - #ffffff):

When Color on Hover is enabled, this option changes the hover color. This has no effect when Color on Hover is disabled.

Stroke Color (#000000 - #ffffff):

This changes the color of the stokes / lines between the shapes. 

Note: This may not be visible when opacity is set to 100%.

Tooltip Background (#000000 - #ffffff):

This changes the background of the tooltips displayed on mouse hover over shapes.

Tooltip Text (WYSIWYG Editor):

This is a template for what to display in the shape tooltip. Parameters can be used in the format of ${panel_name} or ${info_box_title.item_name}. Please see customizing tooltips below for more information.

Advanced (Available only to administrator users)

Map Filter (item selection):

Allows the map to filter the dashboard on click of the shape by the specified item. Items are selectable based on the info_box_details & area_type.

Shapes Uploader

Shapes Type (text):

This will be the internal representation of the uploaded shape set - and is used to determine the shape version.

In the case where a shapeset needs to be reuploaded, using the same value here will overwrite the previous shapeset.

GeoJSON ID (text):

This is a reference to the properties.id key name within the geoJSON. This is the ID we expect to link to the Sisense area_type geography ID.

Friendly Name (text):

This is the name of the area_type id on the Sisense item. This item should contain the related ids to the geoJSON id. specified above.

Chunk Size (number):

This increases the number of shapes that are fetched within a single request, and will affect the number of requests made when the DECK GL plugin populates the map. Tuning this number may yield better performance, by increasing query concurrency.

File Dropper (valid geoJSON file):

This dropper is used to upload a valid geoJSON file for use in the widget.

Upload Button:

This uploads the selected geoJSON with settings above, it will display progress of the upload over time.

Adding Items to Widgets

To add fields to the 3D DeckGL Maps widget, navigate to the left items panel and select the 'Add +' option. This will bring up a selection box with the fields available to choose from. 

Uploading new Shapes

1. Go to the Widget Editor page and select the Advanced > Shapes Uploader option from the design panel.
2. In the Shapes Type field, enter a name for your custom shape set. This name will be used internally by the DECK GL Plugin and should be unique. If you want to overwrite an existing shape set, use the same name as before.
3. In the GeoJSON ID field, enter the name of the property that identifies each shape in your GeoJSON file. This property should match the value of the area_type field in your Sisense data model. For example, if your GeoJSON file contains shapes of US states, and your geoJSON properties has a field called state_id, then you should enter state_id as the GeoJSON ID.
4. In the Friendly Name field, enter the name of the field in your Sisense data model that contains the corresponding ids of the shapes. For example, if your Sisense data model has a field called "State IDs (for Shapes)", then you should enter "State IDs (for Shapes)" as the Friendly Name.
5. In the Chunk Size field, enter a number that determines how many shapes are fetched in each request. This can affect the performance and loading time of your map. You can experiment with different values to find the optimal one for your data size and network speed.
6. In the File Dropper area, drag and drop your GeoJSON file or click to browse and select it. Make sure your file is valid and follows the GeoJSON specification.
7. Click the Upload button to start the upload process. You will see a progress bar and a message indicating the status of the upload. Once the upload is complete, you will see a confirmation message and a preview of your shapes on a map.

Customizing Tooltips

The Tooltip Text is a template that defines what information will be displayed when you hover over a shape on the map. You can use a WYSIWYG (What You See Is What You Get) editor to customize the appearance and content of the tooltip. You can also use parameters to insert dynamic values from your data model or the map itself. Here are some examples of how to use parameters in the Tooltip Text:

• If you want to show the id of the shape, you can use the parameter ${area_type}. This will insert the value of the Shape ID field that you selected in the Data panel.
• If you want to show the value of the shape, you can use the parameter ${height}. This will insert the value of the Value field that you selected in the height panel. For example, if you selected the population_density field as the Value, and you hover over the shape of California, the tooltip will show the population density of California.
• If you want to show other fields from your data model, you can use the parameter ${field_name} as long as the field exists in the info_box_details. This will insert the value of the field that matches the name you specify. For example, if you have a field called capital in your data model and in the info_box_details that contains the name of the capital city of each state, and you want to show it in the tooltip, you can use the parameter ${capital}. This will insert the value of the capital field for each shape. For example, if you hover over the shape of California, the tooltip will show Sacramento as the capital.

You can use these parameters in any combination and format them using the WYSIWYG editor. You can also add static text to the tooltip. You can preview the tooltip by hovering over the shapes on the map in the Preview pane. You can also adjust the tooltip settings such as the size, and background color in the Tooltip section of the Design panel.

Advanced Usage

Combination with the RAPID Switcher can allow users to switch between different shape sets on the same map.

Ensure that the area_type(s) associated with the uploaded shapes are consistent in the DECKGL Plugin and Adaptive Switcher Plugins to switch between shapesets.

The Adaptive Switcher plugin allows you to create dynamic dashboards that can switch between different data sources, filters, and widgets based on user input. You can use this plugin to create a dashboard that can switch between different shape sets on the same map, depending on the user’s selection.

For example, suppose you have uploaded two shape sets using the Shapes Uploader feature: one for US states and one for US counties. You want to create a dashboard that can show the population density of each state or county on a map, and allow the user to switch between the two levels of granularity. This is possible by including one of the area types on the DECK GL Plugin and adding both area types to the Adaptive Switcher.