LocalFocus Widgets API

Change selections, hide dropdowns

Version 1.0



Introduction


Users can create iframe based widgets with LocalFocus. The Widget API consists of small functions that helps developers add simple functionalities, change selections in a chart or hide dropdowns.

The Widgets API works by appending parameters to the widget urls. Multiple parameters can be serialized, to activate or deactivate more items.



In depth


Activate items in dropdowns


One or more dropdown items can be activated via the url in charts, maps and tables.


Parameter

activate=[item label] Activate an item in any dropdown. Replace values between brackets.

activate|[dropdown label]=[item label] Activate an item in a specific dropdown. Replace values between brackets. Notice the vertical bar character.


Chart examples

Activate Category B in any dropdown:

https://localfocuswidgets.net/64357eb39f5c6?activate=Category%20B


Map examples

Activate Category B in the dropdown Category:

https://localfocuswidgets.net/642ec8fae9cba?activate|Category=Category%20B

Activate Category B and Category A in the dropdown Category:

https://localfocuswidgets.net/642ec8fae9cba?activate|Category=Category%20B&activate|Category=Category%20A


Deactivate items in dropdowns


One or more dropdown items can be deactivated via the url in maps.


Parameter

deactivate=[item label] Deactivate an item in any dropdown. Replace values between brackets.

deactivate|[dropdown label]=[item label] Deactivate an item in a specific dropdown. Replace values between brackets. Notice the vertical bar character.


Map examples

Deactivate Category B in any dropdown:

https://localfocuswidgets.net/642ec95e7b1e5?deactivate=Category%20B

Dectivate Category B in the dropdown Category:

https://localfocuswidgets.net/642ec95e7b1e5?deactivate|Category=Category%20B


Hide dropdowns from the user


All dropdowns and search fields can be hidden via the url in charts, maps and tables.


Parameter

hide=dropdowns Hide dropdowns.


Chart examples

Hide dropdown:

https://localfocuswidgets.net/64357eb39f5c6?hide=dropdowns


Map examples

Hide dropdown:

https://localfocuswidgets.net/6437d73e5ca1a?hide=dropdowns