gc-starter-bigscreen-design

基于千行低代码的大屏设计器

一、安装

npm install gc-starter-bigscreen-design

组件依赖于一些组件，如果工程中没有，需要安装

npm install @antv/[email protected]  @jiaminghi/[email protected] [email protected] [email protected] insert-css@^2.0.0 jquery@^3.6.4  [email protected] moment@^2.29.1 qs@^6.9.6 sortablejs@^1.15.0 tiny-sass-compiler@^0.12.2 vue-codemirror@^4.0.6 vue-contextmenujs@^1.4.9 vue-draggable-resizable-gorkys@^2.4.8 vue-json-editor@^1.4.3 vue-json-viewer@^2.2.22 vue-quill-editor@^3.0.6 vue-sketch-ruler@^1.0.3 vuedraggable@^2.24.3 [email protected] echarts@^5.2.2

二、组件注册及使用

1. 注册配置

1.1 在 main.js 注册基础配置

在您的框架中，接口的baseURL可能有所不同，所以需要注册一些基础配置（目前只有baseURL），如下：

// 全局引入css
import 'gc-starter-bigscreen-design/lib/bigScreenDesign.css'
import { registerConfig } from 'gc-starter-bigscreen-design'

// 第二个参数router是路由实例，添加后内部将会为您注册路由，快速访问
registerConfig({
  // 后端的大屏服务基础路径
  baseUrl: 'http://127.0.0.1:8066/bigScreen',
  // 大屏设计路由
  designUrl: '/design',
  // 预览路由
  previewUrl: '/preview',
  // 页面管理路由
  pageManagementUrl: '/management',
  // 数据管理
  dataSourceUrl: '/dataSourceManagement',
  // 数据源管理
  dataSourceSetUrl: '/dataSourceManagement',
  // 数据集管理
  dataSetConfigUrl: '/dataSetManagement'
}, router)

Q: 如何使用系统内已经存在的配置，比如baseURL 在window.baseURL上已经绑定，根据环境不同这个baseURL不同而不一样，怎么写。 A: 可这样写

registerConfig({
  // 后端大屏对应接口baseUrl地址
  baseUrl: window.baseURL
	// ...	
}, router)

Q: 如何使用在 .env.prod 、 .env.dev中的变量？ A: 比如，在 .env.prod 、 .env.dev中定义了 VUE_APP_BASE_URL （必须以VUE_APP_开头），在js中这么取即可

registerConfig({
  // 后端大屏对应接口baseUrl地址
  baseUrl: process.env.VUE_APP_BASE_URL
	// ...	
}, router)

1.2 引入大屏运行器所需要的vuex模块

// 其他代码省略
// 此处引入页面运行器vuex模块
import { $bigScreen } from 'gc-starter-bigscreen-design'
const store = new Vuex.Store({
  modules: {
    // 此处导出大屏所需vuex模块
    bigScreen: $bigScreen.bigScreenStore
  }
})
export default store

2. 快速访问（不用建页面，直接访问）

启动项目后，可分别访问

（此处假设前端基础路径为 localhost:8080） 下面的路由地址和在main.js 中 registerConfig 注入的配置一致

localhost:8080/management
localhost:8080/design?code=xxx
localhost:8080/preview?code=xxx
localhost:8080/dataSourceManagement
localhost:8080/dataSetManagement

3. 自定义页面路由

3.1 大屏管理页页面

在组件中引入设计器组件

<template>
  <BigScreenManagement />
</template>
<script>
import { BigScreenManagement } from 'gc-starter-bigscreen-design'
export default {
  components: {
    BigScreenManagement
  }
}
</script>

3.2 设计态页面

在组件中引入设计器组件 引用该组件的路由必须包含code参数，code参数为页面的唯一标识

<template>
  <!-- code为大屏设计时的编码，你可以携带到本页面路由中获取 -->
  <BigScreenDesign 
    ref="BigScreenDesign"
		:header-show="headerShow"
    :code="code"
  />
</template>
<script>
import { BigScreenDesign } from 'gc-starter-bigscreen-design'
export default {
  components: {
    BigScreenDesign
  },
  data () {
    return {
			// 是否展示头部，可隐藏后自己写头部
      headerShow: true
    }
  },
	computed: {
    code() {
      return this.$route.query.code
    }
  },
  methods: {
		// 下面是其方法
    // 保存并预览
    saveAndPreview () {
      this.$refs.BigScreenDesign.saveAndPreview()
    },
    // 保存
    save () {
      this.$refs.saveAndPreview.save()
    },
    // 清空
		empty () {
      this.$refs.saveAndPreview.empty()
    },
	}
}
</script>

3.3 运行态页面

在组件中引入运行态组件 引用该组件的路由必须包含code参数，code参数为页面的唯一标识

<template>
  <!-- code为大屏运行时的编码，你可以携带到本页面路由中获取 -->
  <BigScreenRun :code="code"/>
</template>
<script>
  import { BigScreenRun }  from 'gc-starter-bigscreen-design'
  export default {
    components: {
      BigScreenRun
    },
    computed: {
      code() {
        return this.$route.query.code
      }
    }
  }
</script>

3.4 数据源管理页面

<template>
  <DataSourceManagement />
</template>
<script>
  import { DataSourceManagement }  from 'gc-starter-bigscreen-design'
  export default {
    components: {
      DataSourceManagement
    }
  }
</script>

3.5 数据集管理页面

<template>
  <DataSetManagement />
</template>
<script>
  import { DataSetManagement }  from 'gc-starter-bigscreen-design'
  export default {
    components: {
      DataSetManagement
    }
  }
</script>

3.6 创建路由

为 3 中的页面创建路由，即可使用，路由和registerConfig注册的路径保持一致