1. Catalog
  2. Code
  3. Dashboards
  • Home
  • What is TileDB?
  • Get Started
  • Explore Content
  • Accounts
    • Individual Accounts
      • Apply for the Free Tier
      • Profile
        • Overview
        • Cloud Credentials
        • Storage Paths
        • REST API Tokens
        • Credits
    • Organization Admins
      • Create an Organization
      • Profile
        • Overview
        • Members
        • Cloud Credentials
        • Storage Paths
        • Billing
      • API Tokens
    • Organization Members
      • Organization Invitations
      • Profile
        • Overview
        • Members
        • Cloud Credentials
        • Storage Paths
        • Billing
      • API Tokens
  • Catalog
    • Introduction
    • Data
      • Arrays
      • Tables
      • Single-Cell (SOMA)
      • Genomics (VCF)
      • Biomedical Imaging
      • Vector Search
      • Files
    • Code
      • Notebooks
      • Dashboards
      • User-Defined Functions
      • Task Graphs
      • ML Models
    • Groups
    • Marketplace
    • Search
  • Collaborate
    • Introduction
    • Organizations
    • Access Control
      • Introduction
      • Share Assets
      • Asset Permissions
      • Public Assets
    • Logging
    • Marketplace
  • Analyze
    • Introduction
    • Slice Data
    • Multi-Region Redirection
    • Notebooks
      • Launch a Notebook
      • Usage
      • Widgets
      • Notebook Image Dependencies
    • Dashboards
      • Dashboards
      • Streamlit
    • Preview
    • User-Defined Functions
    • Task Graphs
    • Serverless SQL
    • Monitor
      • Task Log
      • Task Graph Log
  • Scale
    • Introduction
    • Task Graphs
    • API Usage
  • Structure
    • Why Structure Is Important
    • Arrays
      • Introduction
      • Quickstart
      • Foundation
        • Array Data Model
        • Key Concepts
          • Storage
            • Arrays
            • Dimensions
            • Attributes
            • Cells
            • Domain
            • Tiles
            • Data Layout
            • Compression
            • Encryption
            • Tile Filters
            • Array Schema
            • Schema Evolution
            • Fragments
            • Fragment Metadata
            • Commits
            • Indexing
            • Array Metadata
            • Datetimes
            • Groups
            • Object Stores
          • Compute
            • Writes
            • Deletions
            • Consolidation
            • Vacuuming
            • Time Traveling
            • Reads
            • Query Conditions
            • Aggregates
            • User-Defined Functions
            • Distributed Compute
            • Concurrency
            • Parallelism
        • Storage Format Spec
      • Tutorials
        • Basics
          • Basic Dense Array
          • Basic Sparse Array
          • Array Metadata
          • Compression
          • Encryption
          • Data Layout
          • Tile Filters
          • Datetimes
          • Multiple Attributes
          • Variable-Length Attributes
          • String Dimensions
          • Nullable Attributes
          • Multi-Range Reads
          • Query Conditions
          • Aggregates
          • Deletions
          • Catching Errors
          • Configuration
          • Basic S3 Example
          • Basic TileDB Cloud
          • fromDataFrame
          • Palmer Penguins
        • Advanced
          • Schema Evolution
          • Advanced Writes
            • Write at a Timestamp
            • Get Fragment Info
            • Consolidation
              • Fragments
              • Fragment List
              • Consolidation Plan
              • Commits
              • Fragment Metadata
              • Array Metadata
            • Vacuuming
              • Fragments
              • Commits
              • Fragment Metadata
              • Array Metadata
          • Advanced Reads
            • Get Fragment Info
            • Time Traveling
              • Introduction
              • Fragments
              • Array Metadata
              • Schema Evolution
          • Array Upgrade
          • Backends
            • Amazon S3
            • Azure Blob Storage
            • Google Cloud Storage
            • MinIO
            • Lustre
          • Virtual Filesystem
          • User-Defined Functions
          • Distributed Compute
          • Result Estimation
          • Incomplete Queries
        • Management
          • Array Schema
          • Groups
          • Object Management
        • Performance
          • Summary of Factors
          • Dense vs. Sparse
          • Dimensions vs. Attributes
          • Compression
          • Tiling and Data Layout
          • Tuning Writes
          • Tuning Reads
      • API Reference
    • Tables
      • Introduction
      • Quickstart
      • Foundation
        • Data Model
        • Key Concepts
          • Indexes
          • Columnar Storage
          • Compression
          • Data Manipulation
          • Optimize Tables
          • ACID
          • Serverless SQL
          • SQL Connectors
          • Dataframes
          • CSV Ingestion
      • Tutorials
        • Basics
          • Ingestion with SQL
          • CSV Ingestion
          • Basic S3 Example
          • Running Locally
        • Advanced
          • Scalable Ingestion
          • Scalable Queries
      • API Reference
    • AI & ML
      • Vector Search
        • Introduction
        • Quickstart
        • Foundation
          • Data Model
          • Key Concepts
            • Vector Search
            • Vector Databases
            • Algorithms
            • Distance Metrics
            • Updates
            • Deployment Methods
            • Architecture
            • Distributed Compute
          • Storage Format Spec
        • Tutorials
          • Basics
            • Ingestion & Querying
            • Updates
            • Deletions
            • Basic S3 Example
            • Running Locally
          • Advanced
            • Versioning
            • Time Traveling
            • Consolidation
            • Distributed Compute
            • RAG LLM
            • LLM Memory
            • File Search
            • Image Search
            • Protein Search
          • Performance
        • API Reference
      • ML Models
        • Introduction
        • Quickstart
        • Foundation
          • Basics
          • Storage
          • Cloud Execution
          • Why TileDB for Machine Learning
        • Tutorials
          • Ingestion
            • Data Ingestion
              • Dense Datasets
              • Sparse Datasets
            • ML Model Ingestion
          • Management
            • Array Schema
            • Machine Learning: Groups
            • Time Traveling
    • Life Sciences
      • Single-cell
        • Introduction
        • Quickstart
        • Foundation
          • Data Model
          • Key Concepts
            • Data Structures
            • Use of Apache Arrow
            • Join IDs
            • State Management
            • TileDB Cloud URIs
          • SOMA API Specification
        • Tutorials
          • Data Ingestion
          • Bulk Ingestion Tutorial
          • Data Access
          • Distributed Compute
          • Basic S3 Example
          • Multi-Experiment Queries
          • Appending Data to a SOMA Experiment
          • Add New Measurements
          • SQL Queries
          • Running Locally
          • Shapes in TileDB-SOMA
          • Drug Discovery App
        • Spatial
          • Introduction
          • Foundation
            • Spatial Data Model
            • Data Structures
          • Tutorials
            • Spatial Data Ingestion
            • Access Spatial Data
            • Manage Coordinate Spaces
        • API Reference
      • Population Genomics
        • Introduction
        • Quickstart
        • Foundation
          • Data Model
          • Key Concepts
            • The N+1 Problem
            • Architecture
            • Arrays
            • Ingestion
            • Reads
            • Variant Statistics
            • Annotations
            • User-Defined Functions
            • Tables and SQL
            • Distributed Compute
          • Storage Format Spec
        • Tutorials
          • Basics
            • Basic Ingestion
            • Basic Queries
            • Export to VCF
            • Add New Samples
            • Deleting Samples
            • Basic S3 Example
            • Basic TileDB Cloud
          • Advanced
            • Scalable Ingestion
            • Scalable Queries
            • Query Transforms
            • Handling Large Queries
            • Annotations
              • Finding Annotations
              • Embedded Annotations
              • External Annotations
              • Annotation VCFs
              • Ingesting Annotations
            • Variant Statistics
            • Tables and SQL
            • User-Defined Functions
            • Sample Metadata
            • Split VCF
          • Performance
        • API Reference
          • Command Line Interface
          • Python API
          • Cloud API
      • Biomedical Imaging
        • Introduction
        • Foundation
          • Data Model
          • Key Concepts
            • Arrays
            • Ingestion
            • Reads
            • User Defined Functions
          • Storage Format Spec
        • Quickstart
        • Tutorials
          • Basics
            • Ingestion
            • Read
              • OpenSlide
              • TileDB-Py
          • Advanced
            • Batched Ingestion
            • Chunked Ingestion
            • Machine Learning
              • PyTorch
            • Napari
    • Files
  • API Reference
  • Self-Hosting
    • Installation
    • Upgrades
    • Administrative Tasks
    • Image Customization
      • Customize User-Defined Function Images
      • AWS ECR Container Registry
      • Customize Jupyter Notebook Images
    • Single Sign-On
      • Configure Single Sign-On
      • OpenID Connect
      • Okta SCIM
      • Microsoft Entra
  • Glossary

On this page

  • Create dashboard
  • Overview
  • Sharing & Activity
  • Settings
  • Versioning
  • Launch dashboard
  • Rename dashboard
  • Delete dashboard
  1. Catalog
  2. Code
  3. Dashboards

Dashboard Assets

dashboards
catalog
Learn how you can catalog and manage your dashboards in TileDB.
Supercharge your analysis with low- and no-code applications.

TileDB allows you to create, manage, and launch dashboards inside its secure infrastructure. Dashboards are easy-to-build, low- or no-code applications, which provide a powerful way to interact with the your data without necessitating learning complex APIs.

Create dashboard

Section Analyze includes all the information you need to know about how to create and execute dashboards.

Once created, your dashboard will appear under Assets -> Code -> Dashboards.

Browse all your dashboards in a single place. Browse all your dashboards in a single place.

Overview

The Overview tab provides basic information about a dashboard:

  • Description - If you provided a description to the dashboard (e.g., from Settings), it is visible here. The description is indexed and searchable in the catalog. Therefore, it’s recommended to add a meaningful description for all your assets.
  • TileDB URI - The unique resource identifier for TileDB, based on which you can refer to the dashboard. It contains the namespace and the UUID of the asset.
  • UUID - The unique identifier for the dashboard.
  • Original URI - The location on cloud storage where the asset is stored. This property is visible only to the admin of the asset.
  • Notebook link - Dashboards are essentially special notebooks. You can view the underlying notebook by following this link.
  • Permissions - What rights the current user has on this asset.
  • License - If available, under which license the asset is available. Editable through Settings, if you are the admin of the asset.
  • Tags - Any tags on the asset, if available, which will be searchable in the TileDB catalog.

The basic information about the dashboard. The basic information about the dashboard.

Sharing & Activity

The Sharing screen allows you to securely share your dashboard with other TileDB users, whereas the Activity screen shows you the various accesses performed on the dashboard by you or any other user with whom you have shared your dashboard. They are both covered in detail in the Collaborate section.

Settings

In the dashboard settings, you can modify the following:

  • Description - Note that this is indexed and, thus, searchable in the TileDB catalog.
  • License - The type of license for the dashboard, especially if you are making this publicly available.
  • Tags - These can be used for efficient search in the catalog.
  • Mark as read-only - This is useful if you want to prevent any dashboard changes by you or someone with whom you shared the dashboard.
  • Make public - If you wish to share the dashboard with all the TileDB users. This will appear in the Marketplace tab in the left navigation menu. If you make a dashboard public, you can easily change it back to private in the same manner.
  • Cloud credentials - Credentials should be provided so that TileDB can securely access the dashboard on the cloud store where it is physically stored.
  • Image type - Change the image environment with which to launch the dashboard.
  • Server type - Change the server with which to launch the dashboard.
  • Default region - The region in which you wish to launch the dashboard server by default.
  • Rename dashboard - Read the Rename dashboard subsection below.
  • Delete dashboard - Read the Delete dashboard subsection below.

Tweaking the dashboard settings. Tweaking the dashboard settings.

Versioning

TileDB supports versioning for dashboards. Every time you edit a dashboard, TileDB creates a new version. You can choose the version by selecting the button next to the dashboard name, starting with Latest version - .... This brings up a modal on the right, which allows you to browse and select different dashboard versions.

Browsing and selecting different dashboard versions. Browsing and selecting different dashboard versions.

Launch dashboard

TileDB offers a powerful compute infrastructure, in which you can securly launch your dashboard by selecting the Launch button. Visit the Analyze section for more details on launching dashboards in TileDB.

Rename dashboard

You can rename a dashboard from the Settings tab. This action does not alter or copy the contents of the dashboard; it just registers the asset in the catalog under a different name.

You can programmatically rename a dashboard as follows:

  • Python
tiledb.cloud.asset.update_info(
    "`tiledb://<account>/<previous_name>`",
    name="<new_name>",
    access_credentials_name="<acn>",  # Optional - The cloud credentials that access the dashboard (should already exist in your account settings)
)
Warning

Take caution when renaming dashboards, as any URIs including the previous dashboard name will no longer work.

Delete dashboard

When deleting a dashboard, you have two options:

  • Unregister: This operation removes the dashboard from the TileDB catalog, but it does not physically remove it from the object store. Since the dashboard will persist on storage, you can register it again in the TileDB catalog in the future.
  • Delete: This operation both unregisters and physically removes the dashboard from storage. Note that this operation cannot be undone.

You can delete the dashboard from the Settings tab, which will prompt you to choose among the two operations above.

The two options when removing a dashboard. The two options when removing a dashboard.

You can also programmatically delete or unregister a dashboard as follows:

  • Python
# Unregister a dashboard
tiledb.cloud.asset.deregister(uri="tiledb://<account>/<dashboard_name>")

# Delete a dashboard
tiledb.cloud.asset.delete(uri="tiledb://<account>/<dashboard_name>")
Notebooks
User-Defined Functions