山海鲸可视化

https://www.shanhaibi.com/docs/
Admin
山海鲸可视化 is a zero-code digital twin visualization toolset that enables users to create, manage, and...
Tokens:816,007
Snippets:4,603
Trust Score:7.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET /api/v1/project/list

Source: https://www.shanhaibi.com/docs/v1/ch6gtt3l544k6aig

项目管理接口，用于获取项目列表。

```APIDOC
## GET /api/v1/project/list

### Description
项目管理接口，用于获取项目列表。

### Method
GET

### Endpoint
/api/v1/project/list

### Response
#### Success Response (200)
- **id** (string) - 项目ID
- **name** (string) - 项目名称
- **createTime** (number) - 创建时间戳
- **folder** (string) - 文件夹id
- **report** (string) - 报表系统id
- **new** (boolean) - 是否是新项目
- **snapshotted** (boolean) - 是否有封面截图
- **version** (number) - 项目版本
- **boardsCount** (number) - 看板数量
- **showPlayer** (boolean) - 是否显示控制条
- **cloudRendering** (boolean) - 是否启用云服务
- **widgetPlan** (string) - 组件计划
- **visitorMode** (boolean) - 访客模式
- **directAccess** (boolean) - 直接访问
- **embedWeb** (boolean) - 嵌入网页
- **embedIpWhiteList** (array) - IP白名单
- **shareId** (string) - 分享ID
- **cloudHosting** (boolean) - 云托管
- **allowZooming** (boolean) - 允许缩放
- **clientVersion** (number) - 客户端版本
- **cachedExpireTime** (number) - 缓存过期时间

#### Response Example
[
    {
        "id": "ktujbphysm4h",
        "name": "我的空白项目",
        "createTime": 1702445569332,
        "folder": "",
        "report": "",
        "new": true,
        "snapshotted": true,
        "version": 3,
        "boardsCount": 1,
        "showPlayer": true,
        "cloudRendering": false,
        "widgetPlan": "",
        "visitorMode": true,
        "directAccess": true,
        "embedWeb": true,
        "embedIpWhiteList": [],
        "shareId": "",
        "cloudHosting": false,
        "allowZooming": true,
        "clientVersion": 4,
        "cachedExpireTime": 0
    }
]
```

--------------------------------

### 项目管理接口 GET /api/v1/project/list

Source: https://www.shanhaibi.com/docs/v1/ch6gtt3l544k6aig

获取项目列表，返回 JSON 数组，每个项目包含 id、name、createTime 等字段。

```http
GET /api/v1/project/list
```

```json
[
    {
        "id": "ktujbphysm4h",//项目ID
        "name": "我的空白项目",//项目名称
        "createTime": 1702445569332,//创建时间戳
        "folder": "",//文件夹id
        "report": "",//报表系统id
        "new": true,//是否是新项目
        "snapshotted": true,//是否有封面截图
        "version": 3,//项目版本
        "boardsCount": 1,//看板数量
        "showPlayer": true,//是否显示控制条
        "cloudRendering": false,//是否启用云服务
        "widgetPlan": "",
        "visitorMode": true,
        "directAccess": true,
        "embedWeb": true,
        "embedIpWhiteList": [],
        "shareId": "",
        "cloudHosting": false,
        "allowZooming": true,
        "clientVersion": 4,
        "cachedExpireTime": 0
    },
]
```

--------------------------------

### ready() 生命周期函数签名

Source: https://www.shanhaibi.com/docs/v1/tx9rigt2ff6e0m1h

在项目的所有组件初始化完成时调用，此时所有组件都已加载并初始化完毕，可以访问其他组件。

```typescript
ready?(): void
```

--------------------------------

### SampleExtension - 山海鲸二开代码

Source: https://www.shanhaibi.com/docs/v1/lreauo3ern9bk88p

山海鲸二开代码文件，用于处理iFrame与山海鲸组件之间的通信。监听iFrame消息并更新多行文本组件，同时向iFrame发送按钮点击消息。

```typescript
// 二次开发API参考 https://www.shanhaibi.com/docs/v1/tx9rigt2ff6e0m1h/

export class SampleExtension {
  redButton = Element.empty();
  greenButton = Element.empty();
  infoBox = Element.empty();

  async mounted() {
    this.iframe.onMessage((ev) => {
      const msg = ev.data.msg;
      if (msg) {
        const line = "收到iframe发送的消息：" + msg;
        const text = this.infoBox.getOption("text");
        this.infoBox.setOption("text", text ? text + "\n" + line : line);
      }
    });
    this.redButton.addEventListener("click", (ev) => {
      this.iframe.postMessage(
        {
          msg: "点击了红按钮",
        },
        "*"
      );
    });
    this.greenButton.addEventListener("click", (ev) => {
      this.iframe.postMessage(
        {
          msg: "点击了绿按钮",
        },
        "*"
      );
    });
  }
}
```
Tokens:
Raw