GoodData Plugins #4: Polar Space Chart

GoodData Dashboard Plugins enable builders to customise GoodData Dashboards in line with their particular person wants or enterprise objectives. If you wish to develop your individual plugin, test the tutorial.

Observe: Missed the second article on this sequence masking our Perception Teams plugin? Learn it right here.

This text describes the Polar Space Chart plugin, which shows multivariate information within the type of a two-dimensional chart. It makes use of a round graph with a number of axes rising from the middle, every representing a distinct variable. The information is plotted utilizing traces that join information factors on every axis, forming a closed form that resembles a spider’s net. This visualization methodology permits for simple comparability of a number of variables and their relationships inside a dataset.

Create Your Polar Space Chart Plugin

If you wish to create your individual Polar Space Chart plugin, beneath are the steps to do it.

Step 1: Clone dashboard-plugin-examples repository

git clone https://github.com/gooddata/gooddata-dashboard-plugins.git

Step 2: Navigate to polar_area_chart_plugin

cd polar_area_chart_plugin

Step 3: Set atmosphere variables

Be sure you have your .env and .env.secrets and techniques recordsdata with the proper values. After you clone the repository, you will notice a .env.secrets and techniques.template file within the polar_area_chart_plugin folder. You will have to take away “template” from the filename to arrange every thing accurately.

For .env, you will want to outline 4 variables:

# GoodData backend (code title)
BACKEND_TYPE=tiger

# GoodData host
BACKEND_URL=

# GoodData workspace id
WORKSPACE=

# GoodData dashboard id
DASHBOARD_ID=

For those who open a GoodData dashboard, you’ll find the BACKEND_URL, WORKSPACE_ID, and the  DASHBOARD_ID within the URL like this:

https://<BACKEND_URL>/dashboards/#/workspace/<WORKSPACE_ID>/dashboard/<DASHBOARD_ID>

For .env.secrets and techniques, you will want just one variable:

# GoodData API token
TIGER_API_TOKEN=

Test the Create an API token documentation for extra data.

Step 4: Test dependencies

Guarantee that the dependencies within the package deal.json file are aligned with the model of the SDK dashboard part you employ in your undertaking (in case you are embedding the dashboards with the GoodData SDK).

{
  ...
  "@gooddata/sdk-ui-dashboard": "^9.2.0" <-- should match within the plugin and your undertaking 
  ...
}

Step 5: Construct a manufacturing model

Construct a manufacturing model of the plugin utilizing the command npm run build-plugin, or yarn build-plugin. If in case you have already constructed this plugin, first delete the dist folder.

Step 6: Add the constructed plugin

Add the constructed plugin to your internet hosting. GoodData doesn’t present internet hosting in your plugin builds. Once you construct your plugin, it’s important to host it your self in a publicly out there location supporting HTTPS.

Additionally, be sure the internet hosting of your plugin is included within the allowed plugin hosts by CSP Coverage (documentation).

Step 7: Create plugin metadata object

Create a plugin metadata object utilizing the npm run add-plugin or yarn add-plugin command. For extra data, run the npm run add-plugin –assist or yarn add-plugin –help command.

Copy the plugin object-id famous within the console output for the following step.

Step 8: Hyperlink the plugin to the dashboard

Run the npm run link-plugin,or yarn link-plugincommand. When you hyperlink the plugin to the dashboard, it turns into seen, and you can begin utilizing it!

Give It a Strive

If you wish to attempt dashboard plugins, try our free trial. If you need to debate dashboard plugins or no matter you may have in your thoughts, attain out to us on our neighborhood Slack.