Shimoku docs
  • 🚀QuickStart
    • Installation & Setup
    • Minimal APP example
    • Extended Example
    • Templates & tutorials
  • 🤖Artificial Intelligence
    • Classification
      • Train Classification
        • Train Classification Outputs
      • Predict Classification
        • Predict Classification Outputs
    • Generate Insights
      • Generate Insights Outputs
  • 🛠️Building Web App
    • Environment
      • Overview
      • Environment Variables
    • Management
      • Managing Universes
      • Managing Workspaces
      • Managing Boards
    • Menu
      • Changing the Menu Path
      • Updating the Menu Path
      • Deleting the Menu Path
    • Grid
      • Using the Grid
    • Theming
      • Colors Usage
    • Actions
    • Modals
    • IO
  • 💡Elements
    • Summary
    • Charts
      • Table
        • Buttons Column
        • Filters
        • Search bars
        • Colored labels
      • HTML
        • Raw HTML
        • Beautiful Titles
        • Background Indicators
        • Click to New Tab
        • Box With Button
        • Panel
      • Indicators
        • Indicator
        • Grouped Indicators
        • Vertical Indicators
        • Color by Value
        • Gauge Indicator
        • Indicators with Header
      • Scatter Charts
        • Scatter
        • Scatter with Effect
      • Line Charts
        • Line
        • Predictive Line
        • Segmented Line
        • Marked Line
        • Line With Confidence Area
        • Top Bottom Line Charts
        • Summary Line
      • Area Charts
        • Area
        • Stacked Area
        • Segmented Area
        • Top Bottom Area Charts
      • Bar Charts
        • Bar
        • Stacked Bar
        • Horizontal Bar
        • Stacked Horizontal Bar
        • Zero Centered Bar
      • Pie Charts
        • Pie
        • Doughnut
        • Rose
      • Gauge Charts
        • Shimoku Gauge
        • Speed Gauge
      • Input forms
        • Group chained Inputs
        • List input search
        • Conditional inputs
        • Audio input
        • Drag & Drop
      • Line and Bar
      • Waterfall
      • Annotated Chart
      • Heatmap
      • Radar
      • Sunburst
      • Tree
      • Treemap
      • Sankey Diagram
      • Funnel chart
      • iFrame
    • Composite Template Charts
      • Infographics text bubble
      • Chart and Modal Button
      • Chart and Indicators
    • Data Sets
      • Data Set Filters
    • Create your own charts
      • Free Echarts
      • Bento box
    • Features & Navigation
      • Tabs
      • History navigation & Breadcrumb
  • 🔍Advanced usage
    • CLI
    • Workflow Triggers
    • Code Generation
  • 🌍Cloud & Community
    • Shimoku Cloud
    • Shared links
    • Handling Workspaces & Users
      • User authentication
      • Inviting users
      • Creating users
      • Users with multi-workspace access
  • 🌐Releases
    • 2024
      • v.2.6
      • v.2.5
      • v.2.4
      • v.2.3
        • v.2.3.1
      • v.2.2
        • v.2.2.3
        • v.2.2.2
        • v.2.2.1
      • v.2.1
        • v.2.1.2
        • v.2.1.1
      • v.2.0
        • v.2.0.(1..4)
      • v.1.6
        • v.1.6.1
      • v.1.5
    • 2023
      • v.1.4
        • v.1.4.1
        • v.1.4.2
      • v.1.3
      • v.1.2
        • v.1.2.1
      • v.1.1
        • v.1.1.1
      • v.1.0
        • v.1.0.2
        • v.1.0.1
      • v.0.20
      • v.0.19
      • v.0.18
      • v.0.17
        • v.0.17.1
      • v.0.16
        • v.0.16.3
        • v.0.16.2
        • v.0.16.1
      • v.0.15
      • v.0.14
    • 2022
      • v.0.13
        • v.0.13.3
      • v.0.12
      • v.0.11
      • v.0.10
        • v.0.10.4
        • v.0.10.3
        • v.0.10.1
      • v.0.9
      • v.0.8
      • v.0.7
        • v.0.7.1
      • v.0.6
      • v.0.5
      • v.0.4
      • v.0.3
        • v0.3.2
        • v0.3.1
      • v.0.2
Powered by GitBook
On this page

Was this helpful?

  1. Cloud & Community

Shared links

Share and Embed your data insights

PreviousShimoku CloudNextHandling Workspaces & Users

Last updated 1 year ago

Was this helpful?

Shimoku provides the ability to into existing Web applications. This powerful feature, referred to as Interactive Embedding (or Embedding, for short), allows you to provide personalized analytics to your customers, increasing the overall value of your product offering with minimal development effort.

Be aware that this feature allows anyone with internet access to view the content. We advise against posting sensitive or personal data using this functionality.

To be able to embed you must create a board with the public attribute set to true:

> shimoku cloud create board --public

You can assign any number of menu paths to your board when creating it:

> shimoku cloud create board --public --group-menu-paths

In case you already have a board that contains the menu paths that you want you can update it to make it public:

> shimoku cloud update board --is-public true

And that's it!

Now, to access to the link through the Front End, you must click in the chain of your board:

A pop up will show with both a Public URL link and an HTML embed code:

Further methods

# Creates a board and return it's dictionary representation
s.boards.create_board(
    name: str, order: Optional[int] = None,
    is_public: bool = False, is_disabled: bool = False
) -> Dict

# Gets a board, if the board does not exit it returns None
s.boards.get_board(
    uuid: Optional[str] = None, name: Optional[str] = None
) -> Optional[Dict]

# Deletes the specified board, if it exists
s.boards.delete_board(
    uuid: Optional[str] = None, name: Optional[str] = None
)

# Updates the specified board fields, if it exists
s.boards.update_board(
    uuid: Optional[str] = None, name: Optional[str] = None,
    new_name: Optional[str] = None, order: Optional[int] = None,
    is_public: Optional[bool] = None, is_disabled: Optional[bool] = None
)

# Adds a menu path to a specified board, this creates a link object
s.boards.add_menu_path_in_board(
    menu_path_name: Optional[str] = None, menu_path_id: Optional[str] = None,
    uuid: Optional[str] = None, name: Optional[str] = None
)

# Gets all the menu path ids for a specified board
s.boards.get_board_menu_path_ids(
    uuid: Optional[str] = None, name: Optional[str] = None
) -> List[str]:

# Deletes the link between a given an menu path and a given a board
s.boards.remove_menu_path_from_board(
    menu_path_name: Optional[str] = None, menu_path_id: Optional[str] = None,
    uuid: Optional[str] = None, name: Optional[str] = None
)

# Gets all the workspace boards
s.workspaces.get_workspace_boards(
    self, uuid: Optional[str] = None, name: Optional[str] = None
)

# Delete all workspace boards
s.workspaces.delete_all_workspace_boards(
   self, uuid: Optional[str] = None, name: Optional[str] = None
)
🌍
embed boards