---
url: /v6.2/embed/level.md
---
# HENGSHI SENSE 分层级集成嵌入指南

HENGSHI SENSE 作为 BI PaaS 开放能力平台，提供了多种多样的方式可以让 SaaS 应用厂商、行业软件厂商、解决方案厂商在业务场景中把 HENGSHI SENSE 的功能嵌入到自己的应用中。

## 快速上手

![](/images/topic/develop/embedded-level.png)

如图所示，可以通过 iframe 的方式，把 HENGSHI SENSE 的功能嵌入到自己的应用中。

示例代码：

```html {2}
<iframe
  name="topLevel=system"
  src="https://preview.hengshi.com/app">
</iframe>
```

### 嵌入平台整体

使用 `name="topLevel=system"`，将平台所有功能进行嵌入。

```html {2}
<iframe
  name="topLevel=system"
  src="https://preview.hengshi.com/app">
</iframe>
```

![](/images/topic/develop/toplevel-system.png)

### 嵌入单个模块

使用 `name="topLevel=module"`，将一级功能（如应用集市、应用创作、指标分析、数据集市）进行嵌入。

```html {2}
<iframe
  name="topLevel=module"
  src="https://preview.hengshi.com/app">
</iframe>
```

![](/images/topic/develop/toplevel-module.png)

### 嵌入模块内功能

使用 `name="topLevel=feature"`，将二级功能（如我的空间、公共空间、我的创作、团队空间、指标分析、指标集市、指标管理）进行嵌入。

```html {2}
<iframe
  name="topLevel=feature"
  src="https://preview.hengshi.com/app">
</iframe>
```

![](/images/topic/develop/toplevel-feature.png)

### 嵌入单个应用

使用 `name="topLevel=app"`，将单个应用进行嵌入。

```html {2}
<iframe
  name="topLevel=app"
  src="https://preview.hengshi.com/app/123456">
</iframe>
```

![](/images/topic/develop/toplevel-app.png)

### 嵌入单个文件夹

使用 `name="topLevel=folder/<id>"`，将具体文件夹内所有功能进行嵌入。

```html {2}
<iframe
  name="topLevel=folder/123456"
  src="https://preview.hengshi.com/folder/123456">
</iframe>
```

![](/images/topic/develop/toplevel-folder.png)

### topLevel 代表什么？

topLevel 代表了被嵌入连接的顶层是哪里，假设你的嵌入连接是具体的 app （如 `https://preview.hengshi.com/app/123456`），那么当 topLevel=system 时，页面左上角将会持续有回退按钮，能一路回退到平台系统层级的顶层页面（/home），其他值同理。

## 更多参数

除了 `topLevel` 外，我们还提供了一些其他的参数，与 `topLevel` 配合可以更灵活的显示/隐藏 HENGSHI SENSE 的功能。

* `name="noSidebar"`：隐藏左侧目录树。
* `name="noTab"`：隐藏顶部标签页，例如在嵌入单个应用时，隐藏标签页后即可只嵌入应用内具体模块，如只嵌入单个应用仪表盘列表 `<iframe name="topLevel=app,noTab" src="https://preview.hengshi.com/app/123456/dashboard" />`。
* `name="noBack"`：隐藏回退按钮。

### 示例：只嵌入单个应用数据集列表

```html {2}
<iframe
  name="topLevel=app,noTab"
  src="https://preview.hengshi.com/app/123456/dataset">
</iframe>
```

![](/images/topic/develop/toplevel-app-dataset.png)
