GoView 说明文档

以新增一个图片组件为例

WARNING

务必进行的测试:

右侧属性响应式测试
数据->动态数据更新测试
使用 mock 数据，更新时间设置为5S，点击预览查看 5S 后图表是否进行了更新
打包编译测试，编译会报 TS 错误，请及时修改

首先在 packages 的文件夹里新增基础配置文件

路径	功能
packages/index	所有图表导出，图表动态加载方法等
packages/index.d	类型定义
packages/public	公共数据类，方法等
packages/chartConfiguration	图表基础配置
packages/components/Charts	图表模块
packages/components/Informations	信息模块
packages/components/Tables	表格模块
packages/components/Decorates	装饰模块

选择在 packages/components/Informations/MORE 下创建 Image 文件夹

在文件夹内创建对应的文件 index.ts、index.vue、config.ts、config.vue

index.ts 内容如下：

// 公共类型声明
import { ConfigType, PackagesCategoryEnum, ChartFrameEnum } from '@/packages/index.d'
// 当前[信息模块]分类声明
import { ChatCategoryEnum,ChatCategoryEnumName } from '../../index.d'

export const ImageConfig: ConfigType = {
  // 唯一key，注意！！！文件夹名称需要修改成与当前组件一致！！！
  key: 'Image',
  // 图表组件渲染 Components 格式: V + key
  chartKey: 'VImage',
  // 配置组件渲染 Components 格式: VC + key
  conKey: 'VCImage',
  // 名称
  title: '图片',
  // 子分类目录
  category: ChatCategoryEnum.MORE,
  // 子分类目录
  categoryName: ChatCategoryEnumName.MORE,
  // 包分类
  package: PackagesCategoryEnum.INFORMATIONS,
  // 图表类型
  chartFrame: ChartFrameEnum.COMMON,
  // 图片 (注意！图片存放的路径必须在 src/assets/images/chart/包分类名称/*)
  // 文件夹名称需要和包分类名称一致: PackagesCategoryEnum.INFORMATIONS
  image: 'photo.png'
}

注意！

v1.1.9 / v2.1.6 版本以下，图片需要直接引入。但是开发环境生成的组件，在生产环境的层级展示中图片会有问题。

使用方式如下：

// 展示图片
import image from '@/assets/images/chart/informations/photo.png'

export const ImageConfig: ConfigType = {
  // .....和上面一致
  // 图片
  image: image
}

config.ts 内容如下，在创建新图表时会执行 new Config()

// 公共类型
import { PublicConfigClass } from '@/packages/public'
// 公共类型
import { CreateComponentType } from '@/packages/index.d'
// 获取上面的 index 配置内容
import { ImageConfig } from './index'
// 深拷贝
import cloneDeep from 'lodash/cloneDeep'

export const option = {
  // 数据源字段
  dataset: [],
  // 配置项
  options1: '',
  options2: ''
  // ...
}

// 图表类
export default class Config extends PublicConfigClass implements CreateComponentType {
  public key = ImageConfig.key
  public chartConfig = cloneDeep(ImageConfig)
  public option = cloneDeep(option)
}

index.vue 内容如下:

vue

<template>
  <div class="go-packages-image">
    <div :style="getStyle(borderRadius)">
      <n-image
        :object-fit="fit"
        preview-disabled
        :src="option.dataset"
        :fallback-src="requireErrorImg()"
        :width="w"
        :height="h"
      ></n-image>
    </div>
  </div>
</template>

<script setup lang="ts">
import { PropType, shallowReactive, watch, toRefs } from 'vue'
import { requireErrorImg } from '@/utils'
import { useChartDataFetch } from '@/hooks'
import { CreateComponentType } from '@/packages/index.d'
import { useChartEditStore } from '@/store/modules/chartEditStore/chartEditStore'

const props = defineProps({
  chartConfig: {
    type: Object as PropType<CreateComponentType>,
    required: true
  }
})

// 这里能拿到图表宽高等
const { w, h } = toRefs(props.chartConfig.attr)
// 这里能拿到上面 config.ts 里的 option 数据
const { colors, dur, backgroundColor } = toRefs(props.chartConfig.option)

const option = shallowReactive({
  dataset: ''
})

// 编辑更新
watch(
  () => props.chartConfig.option.dataset,
  (newData: any) => {
    option.dataset = newData
  }, {
    immediate: true
  }
)

// 预览更新
useChartDataFetch(props.chartConfig, useChartEditStore, (newData: string) => {
  option.dataset = newData
})
</script>

config.vue 内容如下：

vue

<template>
  <!-- 默认展开 -->
  <CollapseItem name="样式" :expanded="true">
    <SettingItemBox name="边框">
      <SettingItem name="圆角">
        <!-- 与 config.ts 里的 option 对应 -->
        <!-- n-input-number 是 NaiveUI 的控件 -->
        <n-input-number
          v-model:value="optionData.options1"
          size="small"
          :min="0"
          placeholder="图片圆角"
        ></n-input-number>
      </SettingItem>
      <!-- 颜色粗细等等... -->
    </SettingItemBox>
  </CollapseItem>
</template>

<script setup lang="ts">
import { PropType, computed } from 'vue'
// 以下是封装的设置模块布局组件，具体效果可在官网查看
import {
  GlobalSetting,
  CollapseItem,
  SettingItemBox,
  SettingItem
} from '@/components/Pages/ChartItemSetting'
// 获取 option 的数据，便于使用 typeof 获取类型
import { option } from './config'

const props = defineProps({
  optionData: {
    type: Object as PropType<typeof option>,
    required: true
  }
})

</script>

然后把图片组件在 src\packages\components\Informations\Mores\index.ts 中进行导出

// 图片组件
import { ImageConfig } from './Image/index'、
// 其它组件
import { TextCloudConfig } from './TextCloud/index'

// 这里的顺序决定着最终的展示顺序
export default [TextCloudConfig, ImageConfig]

此时页面图表中将出现【图片】组件，试试把它拖拽到页面进行测试吧~

以新增一个图片组件为例 ​

以新增一个图片组件为例