npm - @belife/belife-bim-air - Versions diffs - 1.6.1-zy.86.patch.7 → 1.6.1-zy.86.patch.9 - Mend

@belife/belife-bim-air 1.6.1-zy.86.patch.7 → 1.6.1-zy.86.patch.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (369) hide show

package/docs/feature//346/250/241/345/236/213/347/273/223/346/236/204.md ADDED Viewed

@@ -0,0 +1,217 @@
+# 模型结构
+轻量化模型数据以树状结构进行组织。
+## 树状结构
+轻量化模型由模型节点组成，子模型节点可以包含多个子模型节点，子模型节点可以继续包含子模型节点，可以一直递归下去。
+```mermaid
+graph TD
+    n(Node) --> n1(Child Node)
+    n(Node) --> n2(Child Node)
+    n(Node) --> n3(Child Node)
+    n1--> n4(Child Node)
+    n1 --> n5(Child Node)
+    n1 --> n6(Child Node)
+```
+## 节点结构
+一个节点有三部分组成，分别是属性，几何和子节点。
+```mermaid
+graph LR
+    n(Node) --> n1(Attributes)
+    n(Node) --> n2(Geometry)
+    n(Node) --> n3(Child Nodes)
+```
+属性(Attributes),是指保存在该节点的各种属性，其中比较重要的是标识这个节点的属性分别是：
+Key：这个模型节点的键值，唯一标识这个节点；
+Name：这个模型节点的名字。
+其它更多的属性信息请参考API文档。
+几何(Geometry),指需要进行绘制的几何，这些几何可能是一个，或多个，其它更详细信息请参考API文档。
+子节点(Child Nodes),指该节点所包含的子节点。
+## 构件节点
+由于构件是按照树状结构进行组织的，因此模型里的构件(Component)其实是一个节点(Node)。
+```mermaid
+graph TD
+    n("第一层(Node)") --> n1("门(Node)")
+    n --> n2(Child Node)
+    n --> n3(......)
+    n1--> n4("门实例1(Component Node)")
+    n1 --> n5(Component Node)
+    n1 --> n6(......)
+```
+## 获取模型结构
+要获取模型结构，先要获取该模型的轻量化模型对象。
+```js
+let lightModel = viewModel.findObjectByType("LightModel");
+```
+ViewModel的findObjectByType是根据绘制对象的类型获取绘制对象，LightModel是默认的轻量化对象。也可以通过findObjectByName函数进行模型的查找，详细请查看API文档。
+获取具体模型结构。
+```js
+let modelStructure = model.getStructure();
+```
+modelStructure是一个树状结构，其中每个节点对象包含 	key，name和childNodes三个属性：
+key是节点的键值，
+name是节点的名字,
+childNodes是子节点数组。
+结构的获取一般在模型导入后进行：
+```js
+lightModel.modelLoaded.add(function (model) {
+    let modelStructure = model.getStructure();
+});
+```
+通过LightModel的modelLoaded事件来完成。
+## 实例HTML下载
+可直接<a :href="$withBase('/demo/模型结构.html')" target="_blank"><b>预览模型结构实例</b></a>
+或者复制以下代码保存成html格式打开实例
+```html {89-91}
+<!DOCTYPE html>
+<html>
+<head>
+    <meta charset="UTF-8">
+    <title>模型结构实例</title>
+    <script src="http://120.78.129.125:8111/js/jquery.js"></script>
+    <script src="http://120.78.129.125:8111/js/gs.dev.js"></script>
+    <script src="http://120.78.129.125:8111/js/longan/longan.js"></script>
+    <link href="http://120.78.129.125:8092/demo/plugin/jquery.treemenu.css" rel="stylesheet" type="text/css">
+    <script src="http://120.78.129.125:8092/demo/plugin/jquery.treemenu.js"></script>
+    <style>
+        .property-box {
+            color: #46CFB0;
+            margin: auto auto;
+            padding: 10px;
+            position: absolute;
+            right: 20px;
+            top: 20px;
+            background-color: #2C3E50;
+            min-width: 300px;
+            height: auto;
+            min-height: 50px;
+            border-radius: 5px;
+            box-shadow: 0 0 10px #555;
+        }
+        .property-box .title {
+            font-weight: bold;
+        }
+        .property-box li {
+            list-style: none;
+            font-size: 13px;
+        }
+    </style>
+</head>
+<body style="margin:0px">
+    <div>
+        <div id="viewer">
+        </div>
+        <div class="property-box">
+            <div class="title">属性：</div>
+            <div class="property-list"></div>
+        </div>
+        <ul class="tree"></ul>
+    </div>
+    <script type="text/javascript">
+        GraStoneCloud.DevModule.onReady = function () {
+            $("#viewer").css("height", window.innerHeight);
+            $(window).resize(function () {
+                $("#viewer").css("height", window.innerHeight);
+            });
+            let viewer = new GraStoneCloud.DevFx.Viewer("viewer");
+            viewer.backgroundColor([0.9, 0.9, 0.9]);
+            let viewModel = new GraStoneCloud.DevFx.ViewModel();
+            viewModel.viewer(viewer);
+            viewModel.modelServiceHost("120.78.129.125:8111");
+            viewModel.loadModelByPath("3f67fd8baf95428fb25b845909d1c738", "demo.mca");
+            viewer.setViewMode(Longan.ViewMode.Iso, true);
+            viewer.updateDisplay();
+            viewer.operatorManager.add(new GraStoneCloud.DevFx.CameraMouse());
+            let componentSelector = new GraStoneCloud.DevFx.ComponentSelector();
+            componentSelector.objectSelected.add(function (cs) {
+                let id = cs.getComponentId();
+                let props = cs.getComponentProperties();
+                $('.property-list').empty();
+                let propList = "";
+                for (var key in props) {
+                    propList += '<li><div style="min-width:80px; display:inline-block;">' + key + "：</div>" + props[key] + '</li>';
+                }
+                $('.property-list').append(propList);
+            });
+            viewer.operatorManager.add(componentSelector);
+            let lightModel = viewModel.findObjectByType("LightModel");
+            lightModel.modelLoaded.add(function (model) {
+                let modelStructure = model.getStructure();
+                makeTree(0, [modelStructure]);
+                $('.tree').append(menu);
+                $(function () {
+                    $(".tree").treemenu({ delay: 300 }).openActive();
+                });
+            });
+        }
+        let menu = "";
+        function getParent(key, structure) {
+            var parent = [];
+            for (var i in structure) {
+                if (structure[i].key == key) {
+                    parent.push(structure[i]);
+                }
+            }
+            return parent;
+        }
+        function makeTree(key, structure) {
+            var topMenu = structure;
+            if (topMenu.length > 0) {
+                for (var i in topMenu) {
+                    menu += '<li><a href="#">' + topMenu[i].name + '</a>';
+                    if (topMenu[i].childNodes && topMenu[i].childNodes.length > 0) {
+                        menu += '<ul>'
+                        makeTree(topMenu[i].key, topMenu[i].childNodes);
+                        menu += '</ul></li>'
+                    }
+                }
+            }
+        }
+    </script>
+</body>
+</html>
+```

package/docs/feature//350/267/257/345/276/204/346/274/253/346/270/270.md ADDED Viewed

@@ -0,0 +1,7 @@
+# 路径漫游
+## 实例HTML下载
+可直接复制以下代码保存成html格式打开实例
+```html
+```

package/docs/feature//350/277/233/345/272/246/346/250/241/346/213/237.md ADDED Viewed

@@ -0,0 +1,8 @@
+# 进度模拟
+## 实例HTML下载
+可直接复制以下代码保存成html格式打开实例
+```html
+```

package/docs/feature//351/242/234/350/211/262/350/256/276/347/275/256.md ADDED Viewed

@@ -0,0 +1,112 @@
+# 颜色设置
+通过轻量模型对象提供的函数可以方便的修改构件的颜色。
+## 修改构件颜色
+通过ViewModel可以获取轻量模型对象。
+```js
+let model = viewModel.findObjectByType("LightModel");
+```
+通过轻量模型对象的setComponentColor函数可以修改构件的颜色。
+```js
+model.setComponentColor("243274", 0, 0, 200, 125);
+viewer.updateDisplay(); // 需要updateDisplay刷新viewer才能显示改变
+```
+其中参数"243274"是构件的ID，后四位参数分别是颜色的r，g，b，a值，它们的值是0~255之间，其中a是指alpha指，当a值小于255时，颜色会出现透明。
+## 取消构件颜色
+通过轻量模型对象的unsetComponentColor函数可以取消颜色的设置。
+```js
+model.unsetComponentColor("243274");
+viewer.updateDisplay(); // 需要updateDisplay刷新viewer才能显示改变
+```
+其中参数"243274"是构件的ID。
+## 实例HTML下载
+可直接<a :href="$withBase('/demo/颜色设置.html')" target="_blank"><b>预览颜色设置实例</b></a>
+或者复制以下代码保存成html格式打开实例
+```html
+<!DOCTYPE html>
+<html>
+<head>
+    <meta charset="UTF-8">
+    <title>颜色设置实例</title>
+    <script src="http://120.78.129.125:8111/js/jquery.js"></script>
+    <script src="http://120.78.129.125:8111/js/gs.dev.js"></script>
+    <script src="http://120.78.129.125:8111/js/longan/longan.js"></script>
+    <style>
+        .button-box {
+            color: #46CFB0;
+            margin: auto auto;
+            padding: 10px;
+            position: absolute;
+            left: 20px;
+            top: 20px;
+            background-color: #2C3E50;
+            min-width: 300px;
+            min-height: 50px;
+            border-radius: 5px;
+            box-shadow: 0 0 10px #555;
+            overflow: auto;
+        }
+    </style>
+</head>
+<body style="margin:0px">
+    <div>
+        <div id="viewer">
+        </div>
+        <div class="button-box">
+            <button onclick="changeColorClick()">修改屋顶颜色</button>
+        </div>
+    </div>
+    <script type="text/javascript">
+        let viewModel;
+        let viewer;
+        GraStoneCloud.DevModule.onReady = function () {
+            $("#viewer").css("height", window.innerHeight);
+            $(window).resize(function () {
+                $("#viewer").css("height", window.innerHeight);
+            });
+            viewer = new GraStoneCloud.DevFx.Viewer("viewer");
+            viewer.backgroundColor([0.9, 0.9, 0.9]);
+            viewModel = new GraStoneCloud.DevFx.ViewModel();
+            viewModel.viewer(viewer);
+            viewModel.modelServiceHost("120.78.129.125:8111");
+            viewModel.loadModelByPath("3f67fd8baf95428fb25b845909d1c738", "demo.mca");
+            viewer.setViewMode(Longan.ViewMode.Iso, true);
+            viewer.updateDisplay();
+            viewer.operatorManager.add(new GraStoneCloud.DevFx.CameraMouse());
+        }
+        let isChangeColor = true;
+        function changeColorClick() {
+            let model = viewModel.findObjectByType("LightModel");
+            if (isChangeColor) {
+                model.setComponentColor("243274", 0, 0, 200, 125);
+            } else {
+                model.unsetComponentColor("243274");
+            }
+            isChangeColor = !isChangeColor;
+            viewer.updateDisplay();
+        }
+    </script>
+</body>
+</html>
+```

package/docs/gs-bim-air.md ADDED Viewed

@@ -0,0 +1,231 @@
+gs-bim-air
+# gs-bim-air
+## Table of contents
+### References
+- [Loader](gs-bim-air.md#loader)
+- [LonganCore](gs-bim-air.md#longancore)
+- [ProjectionType](gs-bim-air.md#projectiontype)
+### Namespaces
+- [Animation](modules/Animation.md)
+- [Command](modules/Command.md)
+- [Geometry](modules/Geometry.md)
+- [Longan](modules/Longan.md)
+- [SDK](modules/SDK.md)
+- [Utility](modules/Utility.md)
+### Enumerations
+- [CuttingCreateType](enums/CuttingCreateType.md)
+- [ModelStatus](enums/ModelStatus.md)
+- [PathType](enums/PathType.md)
+- [ShowBorder](enums/ShowBorder.md)
+- [SkyboxType](enums/SkyboxType.md)
+- [ViewerType](enums/ViewerType.md)
+### Classes
+- [ComponentSelector](classes/ComponentSelector.md)
+- [CuttingOptions](classes/CuttingOptions.md)
+- [DataSource](classes/DataSource.md)
+- [EarthCameraMouse3D](classes/EarthCameraMouse3D.md)
+- [GisBIMObject](classes/GisBIMObject.md)
+- [GisRefLightModel](classes/GisRefLightModel.md)
+- [MapTileSet3D](classes/MapTileSet3D.md)
+- [Material](classes/Material.md)
+- [Panel](classes/Panel.md)
+- [ParameterManager](classes/ParameterManager.md)
+- [ParametricGeometryManager](classes/ParametricGeometryManager.md)
+- [Process](classes/Process.md)
+- [SegmentObject](classes/SegmentObject.md)
+- [TerrainProvider](classes/TerrainProvider.md)
+- [TreeNodeObject](classes/TreeNodeObject.md)
+- [Viewer](classes/Viewer.md)
+### Interfaces
+- [LoaderOptions](interfaces/LoaderOptions.md)
+- [Model](interfaces/Model.md)
+- [SliceModelParam](interfaces/SliceModelParam.md)
+- [ToolbarVisible](interfaces/ToolbarVisible.md)
+- [ViewerOptions](interfaces/ViewerOptions.md)
+### Variables
+- [Manager](gs-bim-air.md#manager)
+- [ViewerWrapper](gs-bim-air.md#viewerwrapper)
+- [default](gs-bim-air.md#default)
+- [defaultModel](gs-bim-air.md#defaultmodel)
+- [fileService](gs-bim-air.md#fileservice)
+- [renderObjectService](gs-bim-air.md#renderobjectservice)
+## References
+### Loader
+Renames and re-exports [__type](gs-bim-air.md#__type)
+___
+### LonganCore
+Re-exports [LonganCore](modules/Longan.LonganCore.md)
+___
+### ProjectionType
+Re-exports [ProjectionType](enums/Longan.ProjectionType.md)
+## Variables
+### Manager
+• `Const` **Manager**: `Object`
+#### Type declaration
+| Name | Type |
+| :------ | :------ |
+| `ComponentManager` | typeof `ComponentManager` |
+| `HighlightManager` | typeof `HighlightManager` |
+| `InvisibleManager` | typeof `InvisibleManager` |
+| `IsolationManager` | typeof `IsolationManager` |
+| `MaterialManager` | typeof `MaterialManager` |
+| `PanelManager` | typeof `PanelManager` |
+| `PropertyManager` | typeof `default` |
+| `SelectionManager` | typeof `SelectionManager` |
+| `StructureTreeManager` | typeof `StructureTreeManager` |
+___
+### ViewerWrapper
+• **ViewerWrapper**: `Object`
+#### Type declaration
+| Name | Type |
+| :------ | :------ |
+| `ViewerWrapper` | `VueConstructor`<`Vue`<`Record`<`string`, `any`\>, `Record`<`string`, `any`\>, `never`, `never`, (`event`: `string`, ...`args`: `any`[]) => `Vue`<`Record`<`string`, `any`\>, `Record`<`string`, `any`\>, `never`, `never`, (event: string, ...args: any[]) =\> Vue<Record<string, any\>, Record<string, any\>, never, never, ...\>\>\>\> |
+| `install` | (`Vue`: `any`) => `void` |
+___
+### default
+• `Const` **default**: `Object`
+#### Type declaration
+| Name | Type |
+| :------ | :------ |
+| `Animation` | [`Animation`](modules/Animation.md) |
+| `CAE` | `__module` |
+| `Command` | [`Command`](modules/Command.md) |
+| `ComponentSelector` | typeof [`ComponentSelector`](classes/ComponentSelector.md) |
+| `CuttingCreateType` | typeof [`CuttingCreateType`](enums/CuttingCreateType.md) |
+| `CuttingOptions` | typeof [`CuttingOptions`](classes/CuttingOptions.md) |
+| `DataSource` | typeof [`DataSource`](classes/DataSource.md) |
+| `EarthCameraMouse3D` | typeof [`EarthCameraMouse3D`](classes/EarthCameraMouse3D.md) |
+| `Geometry` | [`Geometry`](modules/Geometry.md) |
+| `GisBIMObject` | typeof [`GisBIMObject`](classes/GisBIMObject.md) |
+| `GisRefLightModel` | typeof [`GisRefLightModel`](classes/GisRefLightModel.md) |
+| `Loader` | (`config`: [`LoaderOptions`](interfaces/LoaderOptions.md)) => `Promise`<`void`\> |
+| `Longan` | [`Longan`](modules/Longan.md) |
+| `LonganCore` | [`LonganCore`](modules/Longan.LonganCore.md) |
+| `Manager` | { `ComponentManager`: typeof `ComponentManager` ; `HighlightManager`: typeof `HighlightManager` ; `InvisibleManager`: typeof `InvisibleManager` ; `IsolationManager`: typeof `IsolationManager` ; `MaterialManager`: typeof `MaterialManager` ; `PanelManager`: typeof `PanelManager` ; `PropertyManager`: typeof `default` ; `SelectionManager`: typeof `SelectionManager` ; `StructureTreeManager`: typeof `StructureTreeManager`  } |
+| `Manager.ComponentManager` | typeof `ComponentManager` |
+| `Manager.HighlightManager` | typeof `HighlightManager` |
+| `Manager.InvisibleManager` | typeof `InvisibleManager` |
+| `Manager.IsolationManager` | typeof `IsolationManager` |
+| `Manager.MaterialManager` | typeof `MaterialManager` |
+| `Manager.PanelManager` | typeof `PanelManager` |
+| `Manager.PropertyManager` | typeof `default` |
+| `Manager.SelectionManager` | typeof `SelectionManager` |
+| `Manager.StructureTreeManager` | typeof `StructureTreeManager` |
+| `MapTileSet3D` | typeof [`MapTileSet3D`](classes/MapTileSet3D.md) |
+| `Material` | typeof [`Material`](classes/Material.md) |
+| `ModelStatus` | typeof [`ModelStatus`](enums/ModelStatus.md) |
+| `Panel` | typeof [`Panel`](classes/Panel.md) |
+| `ParameterManager` | typeof [`ParameterManager`](classes/ParameterManager.md) |
+| `ParametricGeometryManager` | typeof [`ParametricGeometryManager`](classes/ParametricGeometryManager.md) |
+| `PathType` | typeof [`PathType`](enums/PathType.md) |
+| `Process` | typeof [`Process`](classes/Process.md) |
+| `ProjectionType` | typeof [`ProjectionType`](enums/Longan.ProjectionType.md) |
+| `SDK` | [`SDK`](modules/SDK.md) |
+| `SegmentObject` | typeof [`SegmentObject`](classes/SegmentObject.md) |
+| `ShowBorder` | typeof [`ShowBorder`](enums/ShowBorder.md) |
+| `SkyboxType` | typeof [`SkyboxType`](enums/SkyboxType.md) |
+| `TerrainProvider` | typeof [`TerrainProvider`](classes/TerrainProvider.md) |
+| `TreeNodeObject` | typeof [`TreeNodeObject`](classes/TreeNodeObject.md) |
+| `Utility` | [`Utility`](modules/Utility.md) |
+| `Viewer` | typeof [`Viewer`](classes/Viewer.md) |
+| `ViewerType` | typeof [`ViewerType`](enums/ViewerType.md) |
+| `ViewerWrapper` | { `ViewerWrapper`: `VueConstructor`<`Vue`<`Record`<`string`, `any`\>, `Record`<`string`, `any`\>, `never`, `never`, (`event`: `string`, ...`args`: `any`[]) => `Vue`<`Record`<`string`, `any`\>, `Record`<`string`, `any`\>, `never`, `never`, (event: string, ...args: any[]) =\> Vue<Record<string, any\>, Record<string, any\>, never, never, ...\>\>\>\> ; `install`: (`Vue`: `any`) => `void`  } |
+| `ViewerWrapper.ViewerWrapper` | `VueConstructor`<`Vue`<`Record`<`string`, `any`\>, `Record`<`string`, `any`\>, `never`, `never`, (`event`: `string`, ...`args`: `any`[]) => `Vue`<`Record`<`string`, `any`\>, `Record`<`string`, `any`\>, `never`, `never`, (event: string, ...args: any[]) =\> Vue<Record<string, any\>, Record<string, any\>, never, never, ...\>\>\>\> |
+| `ViewerWrapper.install` | (`Vue`: `any`) => `void` |
+| `defaultModel` | [`Model`](interfaces/Model.md) |
+| `fileService` | { `deleteFile`: (`fileService`: `any`, `id`: `any`) => `Promise`<`AxiosResponse`<`any`\>\> ; `uploadFile`: (`fileService`: `any`, `file`: `Blob` \| `File`) => `Promise`<`AxiosResponse`<`any`\>\> ; `urls`: { `file`: (`fileService`: `any`, `id`: `any`) => `string` ; `files`: (`fileService`: `any`) => `string`  }  } |
+| `fileService.deleteFile` | (`fileService`: `any`, `id`: `any`) => `Promise`<`AxiosResponse`<`any`\>\> |
+| `fileService.uploadFile` | (`fileService`: `any`, `file`: `Blob` \| `File`) => `Promise`<`AxiosResponse`<`any`\>\> |
+| `fileService.urls` | { `file`: (`fileService`: `any`, `id`: `any`) => `string` ; `files`: (`fileService`: `any`) => `string`  } |
+| `fileService.urls.file` | (`fileService`: `any`, `id`: `any`) => `string` |
+| `fileService.urls.files` | (`fileService`: `any`) => `string` |
+| `renderObjectService` | { `createRenderObject`: (`parentId`: `string`, `obj`: `any`, `tag`: `string`) => `Promise`<`AxiosResponse`<`any`\>\> ; `deleteRenderObjects`: (`ids`: `string`[]) => `Promise`<`AxiosResponse`<`any`\>\> ; `getRenderObjectsRelated`: (`typeName`: `string`, `related`: `string`[], `tag`: `string`) => `Promise`<[`RenderObject`](classes/Longan.RenderObject.md)[]\> ; `item`: { `deleteRenderObject`: (`id`: `any`) => `Promise`<`AxiosResponse`<`any`\>\> ; `editRenderObject`: (`id`: `string`, `obj`: `any`) => `Promise`<`AxiosResponse`<`any`\>\> ; `getRenderObject`: (`id`: `any`, `tree?`: `boolean`) => `Promise`<[`RenderObject`](classes/Longan.RenderObject.md)\> ; `setRenderObjectOrder`: (`id`: `any`, `data`: `any`) => `Promise`<`AxiosResponse`<`any`\>\>  } ; `viewer`: `any` = null } |
+| `renderObjectService.createRenderObject` | (`parentId`: `string`, `obj`: `any`, `tag`: `string`) => `Promise`<`AxiosResponse`<`any`\>\> |
+| `renderObjectService.deleteRenderObjects` | (`ids`: `string`[]) => `Promise`<`AxiosResponse`<`any`\>\> |
+| `renderObjectService.getRenderObjectsRelated` | (`typeName`: `string`, `related`: `string`[], `tag`: `string`) => `Promise`<[`RenderObject`](classes/Longan.RenderObject.md)[]\> |
+| `renderObjectService.item` | { `deleteRenderObject`: (`id`: `any`) => `Promise`<`AxiosResponse`<`any`\>\> ; `editRenderObject`: (`id`: `string`, `obj`: `any`) => `Promise`<`AxiosResponse`<`any`\>\> ; `getRenderObject`: (`id`: `any`, `tree?`: `boolean`) => `Promise`<[`RenderObject`](classes/Longan.RenderObject.md)\> ; `setRenderObjectOrder`: (`id`: `any`, `data`: `any`) => `Promise`<`AxiosResponse`<`any`\>\>  } |
+| `renderObjectService.item.deleteRenderObject` | (`id`: `any`) => `Promise`<`AxiosResponse`<`any`\>\> |
+| `renderObjectService.item.editRenderObject` | (`id`: `string`, `obj`: `any`) => `Promise`<`AxiosResponse`<`any`\>\> |
+| `renderObjectService.item.getRenderObject` | (`id`: `any`, `tree?`: `boolean`) => `Promise`<[`RenderObject`](classes/Longan.RenderObject.md)\> |
+| `renderObjectService.item.setRenderObjectOrder` | (`id`: `any`, `data`: `any`) => `Promise`<`AxiosResponse`<`any`\>\> |
+| `renderObjectService.viewer` | `any` |
+___
+### defaultModel
+• `Const` **defaultModel**: [`Model`](interfaces/Model.md)
+___
+### fileService
+• **fileService**: `Object`
+#### Type declaration
+| Name | Type |
+| :------ | :------ |
+| `deleteFile` | (`fileService`: `any`, `id`: `any`) => `Promise`<`AxiosResponse`<`any`\>\> |
+| `uploadFile` | (`fileService`: `any`, `file`: `Blob` \| `File`) => `Promise`<`AxiosResponse`<`any`\>\> |
+| `urls` | { `file`: (`fileService`: `any`, `id`: `any`) => `string` ; `files`: (`fileService`: `any`) => `string`  } |
+| `urls.file` | (`fileService`: `any`, `id`: `any`) => `string` |
+| `urls.files` | (`fileService`: `any`) => `string` |
+___
+### renderObjectService
+• **renderObjectService**: `Object`
+#### Type declaration
+| Name | Type |
+| :------ | :------ |
+| `createRenderObject` | (`parentId`: `string`, `obj`: `any`, `tag`: `string`) => `Promise`<`AxiosResponse`<`any`\>\> |
+| `deleteRenderObjects` | (`ids`: `string`[]) => `Promise`<`AxiosResponse`<`any`\>\> |
+| `getRenderObjectsRelated` | (`typeName`: `string`, `related`: `string`[], `tag`: `string`) => `Promise`<[`RenderObject`](classes/Longan.RenderObject.md)[]\> |
+| `item` | { `deleteRenderObject`: (`id`: `any`) => `Promise`<`AxiosResponse`<`any`\>\> ; `editRenderObject`: (`id`: `string`, `obj`: `any`) => `Promise`<`AxiosResponse`<`any`\>\> ; `getRenderObject`: (`id`: `any`, `tree?`: `boolean`) => `Promise`<[`RenderObject`](classes/Longan.RenderObject.md)\> ; `setRenderObjectOrder`: (`id`: `any`, `data`: `any`) => `Promise`<`AxiosResponse`<`any`\>\>  } |
+| `item.deleteRenderObject` | (`id`: `any`) => `Promise`<`AxiosResponse`<`any`\>\> |
+| `item.editRenderObject` | (`id`: `string`, `obj`: `any`) => `Promise`<`AxiosResponse`<`any`\>\> |
+| `item.getRenderObject` | (`id`: `any`, `tree?`: `boolean`) => `Promise`<[`RenderObject`](classes/Longan.RenderObject.md)\> |
+| `item.setRenderObjectOrder` | (`id`: `any`, `data`: `any`) => `Promise`<`AxiosResponse`<`any`\>\> |
+| `viewer` | `any` |

package/docs/guide/EasyStart.md ADDED Viewed

@@ -0,0 +1,98 @@
+# 快速上手
+本节将介绍如何在项目中使用轻量化云平台。
+## 引入相关JavaScript文件
+在页面文件中引入JS文件
+```html
+<!-- 轻量化云平台依赖于JQuery -->
+<script src="http://120.78.129.125:8111/js/jquery.js"></script>
+<script src="http://120.78.129.125:8111/js/gs.dev.js"></script>
+<script src="http://120.78.129.125:8111/js/longan/longan.js"></script>
+```
+其中jquery.js是jquery文件，如果在项目其它地方已经引入，这里就不需要引入了。
+其它gs.dev.js和longan.js为轻量化云平台主文件。
+## 创建Viewer控件
+由于控件需要一个载体，这里创建一个id为viewer的div元素。
+``` html
+<div id="viewer">
+</div>
+```
+根据页面添加JavaScript代码。
+``` html
+<script type="text/javascript">
+    GraStoneCloud.DevModule.onReady = function () {
+        $("#viewer").css("height", window.innerHeight);
+        $(window).resize(function () {
+            $("#viewer").css("height", window.innerHeight);
+        });
+        let viewer = new GraStoneCloud.DevFx.Viewer("viewer");
+        viewer.updateDisplay();
+    }
+</script>
+```
+你可以这样来调整控件容器Viewer的大小：
+``` js
+$("#viewer").css("height", window.innerHeight);
+$(window).resize(function () {
+    $("#viewer").css("height", window.innerHeight);
+});
+```
+以下是为Viewer控件创建过程：
+```js
+// Viewer构造函数输入参数为div容器的id。
+let viewer = new GraStoneCloud.DevFx.Viewer("viewer");
+// viewer.updateDisplay可更新控件绘制。
+viewer.updateDisplay();
+```
+## 实例HTML下载
+可直接<a :href="$withBase('/demo/快速上手.html')" target="_blank"><b>预览实例</b></a>
+或者复制以下代码保存成html格式打开实例
+```html
+<!DOCTYPE html>
+<html>
+<head>
+    <meta charset="UTF-8">
+    <title>首页</title>
+    <script src="http://120.78.129.125:8111/js/jquery.js"></script>
+    <script src="http://120.78.129.125:8111/js/gs.dev.js"></script>
+    <script src="http://120.78.129.125:8111/js/longan/longan.js"></script>
+</head>
+<body style="margin:0px">
+    <div>
+        <div id="viewer">
+        </div>
+    </div>
+    <script type="text/javascript">
+        GraStoneCloud.DevModule.onReady = function () {
+            $("#viewer").css("height", window.innerHeight);
+            $(window).resize(function () {
+                $("#viewer").css("height", window.innerHeight);
+            });
+            let viewer = new GraStoneCloud.DevFx.Viewer("viewer");
+			viewer.updateDisplay();
+            alert("viewer created!!!");
+		}
+    </script>
+</body>
+</html>
+```