Dashboard

This module provides functionality for working with dashboards.

class Dashboard(api, uuid, data={})[source]

Bases: Base

Parameters:
BASE_ENDPOINT = 'dashboards/'
__init__(api, uuid, data={})[source]

Initialize a Dashboard instance.

Parameters:

  • api (GeoboxClient) – The GeoboxClient instance for making requests.

  • uuid (str) – The unique identifier for the Dashboard.

  • data (Dict, optional) – The data of the Dashboard.

classmethod get_dashboards(api, **kwargs)[source]

Get list of Dashboards

Parameters:

api (GeoboxClient) – The GeoboxClient instance for making requests.

Keyword Arguments:

  • q (str) – query filter based on OGC CQL standard. e.g. “field1 LIKE ‘%GIS%’ AND created_at > ‘2021-01-01’”

  • search (str) – search term for keyword-based searching among search_fields or all textual fields if search_fields does not have value. NOTE: if q param is defined this param will be ignored.

  • search_fields (str) – comma separated list of fields for searching.

  • order_by (str) – comma separated list of fields for sorting results [field1 A|D, field2 A|D, …]. e.g. name A, type D. NOTE: “A” denotes ascending order and “D” denotes descending order.

  • return_count (bool) – Whether to return total count. default is False.

  • skip (int) – Number of items to skip. default is 0.

  • limit (int) – Number of items to return. default is 10.

  • user_id (int) – Specific user. privileges required.

  • shared (bool) – Whether to return shared Dashboards. default is False.

Returns:

A list of Dashboard instances or the total number of Dashboards.

Return type:

List[Dashboard] | int

Example

>>> from geobox import GeoboxClient
>>> from geobox.dashboard import Dashboard
>>> client = GeoboxClient()
>>> dashboards = Dashboard.get_dashboards(client)
or
>>> dashboards = client.get_dashboards()
classmethod create_dashboard(api, name, display_name=None, description=None, settings={}, thumbnail=None, user_id=None)[source]

Create a new Dashboard.

Parameters:

  • api (GeoboxClient) – The GeoboxClient instance for making requests.

  • name (str) – The name of the Dashboard.

  • display_name (str, optional) – The display name of the Dashboard.

  • description (str, optional) – The description of the Dashboard.

  • settings (Dict, optional) – The settings of the sceDashboarde.

  • thumbnail (str, optional) – The thumbnail of the Dashboard.

  • user_id (int, optional) – Specific user. privileges required.

Returns:

The newly created Dashboard instance.

Return type:

Dashboard

Raises:

ValidationError – If the Dashboard data is invalid.

Example

>>> from geobox import GeoboxClient
>>> from geobox.dashboard import Dashboard
>>> client = GeoboxClient()
>>> dashboard = Dashboard.create_dashboard(client, name="my_dashboard")
or
>>> dashboard = client.create_dashboard(name="my_dashboard")
classmethod get_dashboard(api, uuid, user_id=None)[source]

Get a Dashboard by its UUID.

Parameters:

  • api (GeoboxClient) – The GeoboxClient instance for making requests.

  • uuid (str) – The UUID of the Dashboard to get.

  • user_id (int, optional) – Specific user. privileges required.

Returns:

The dashboard object.

Return type:

Dashboard

Raises:

NotFoundError – If the Dashboard with the specified UUID is not found.

Example

>>> from geobox import GeoboxClient
>>> from geobox.dashboard import Dashboard
>>> client = GeoboxClient()
>>> dashboard = Dashboard.get_dashboard(client, uuid="12345678-1234-5678-1234-567812345678")
or
>>> dashboard = client.get_dashboard(uuid="12345678-1234-5678-1234-567812345678")
classmethod get_dashboard_by_name(api, name, user_id=None)[source]

Get a dashboard by name

Parameters:

  • api (GeoboxClient) – The GeoboxClient instance for making requests.

  • name (str) – the name of the dashboard to get

  • user_id (int, optional) – specific user. privileges required.

Returns:

returns the dashboard if a dashboard matches the given name, else None

Return type:

Dashboard | None

Example

>>> from geobox import GeoboxClient
>>> from geobox.dashboard import Dashboard
>>> client = GeoboxClient()
>>> dashboard = Dashboard.get_dashboard_by_name(client, name='test')
or
>>> dashboard = client.get_dashboard_by_name(name='test')
update(**kwargs)[source]

Update the Dashboard

Keyword Arguments:

  • name (str) – The name of the Dashboard.

  • display_name (str) – The display name of the Dashboard.

  • description (str) – The description of the Dashboard.

  • settings (Dict) – The settings of the Dashboard.

  • thumbnail (str) – The thumbnail of the Dashboard.

Returns:

The updated Dashboard data.

Return type:

Dict

Raises:

ValidationError – If the Dashboard data is invalid.

Example

>>> from geobox import GeoboxClient
>>> from geobox.dashboard import Dashboard
>>> client = GeoboxClient()
>>> dashboard = Dashboard.get_dashboard(client, uuid="12345678-1234-5678-1234-567812345678")
>>> dashboard.update(display_name="New Display Name")
delete()[source]

Delete the dashboard.

Returns:

None

Return type:

None

Example

>>> from geobox import GeoboxClient
>>> from geobox.dashboard import Dashboard
>>> client = GeoboxClient()
>>> dashboard = Dashboard.get_dashboard(client, uuid="12345678-1234-5678-1234-567812345678")
>>> dashboard.delete()
property thumbnail: str

Get the thumbnail URL of the dashboard.

Returns:

The thumbnail of the dashboard.

Return type:

str

Example

>>> from geobox import GeoboxClient
>>> from geobox.dashboard import Dashboard
>>> client = GeoboxClient()
>>> dashboard = Dashboard.get_dashboard(client, uuid="12345678-1234-5678-1234-567812345678")
>>> dashboard.thumbnail
share(users)[source]

Shares the Dashboard with specified users.

Parameters:

users (List[User]) – The list of user objects to share the Dashboard with.

Returns:

None

Return type:

None

Example

>>> from geobox import GeoboxClient
>>> from geobox.dashboard import Dashboard
>>> client = GeoboxClient()
>>> dashboard = Dashboard.get_dashboard(client, uuid="12345678-1234-5678-1234-567812345678")
>>> users = client.search_users(search='John')
>>> dashboard.share(users=users)
unshare(users)[source]

Unshares the Dashboard with specified users.

Parameters:

users (List[User]) – The list of user objects to unshare the Dashboard with.

Returns:

None

Return type:

None

Example

>>> from geobox import GeoboxClient
>>> from geobox.dashboard import Dashboard
>>> client = GeoboxClient()
>>> dashboard = Dashboard.get_dashboard(client, uuid="12345678-1234-5678-1234-567812345678")
>>> users = client.search_users(search='John')
>>> dashboard.unshare(users=users)
get_shared_users(search=None, skip=0, limit=10)[source]

Retrieves the list of users the dashboard is shared with.

Parameters:

  • search (str, optional) – The search query.

  • skip (int, optional) – The number of users to skip.

  • limit (int, optional) – The maximum number of users to retrieve.

Returns:

The list of shared users.

Return type:

List[User]

Example

>>> from geobox import GeoboxClient
>>> from geobox.dashboard import Dashboard
>>> client = GeoboxClient()
>>> dashboard = Dashboard.get_dashboard(client, uuid="12345678-1234-5678-1234-567812345678")
>>> dashboard.get_shared_users(search='John', skip=0, limit=10)