从 1.x 迁移

本文档将帮助你从 soonspacejs 1.x 版本升级到 soonspacejs 2.x 版本。

升级准备

准备工作只需要在原本项目中安装最新版本即可

yarn add soonspacejs@2.x.x -S
# or
npm i soonspacejs@2.x.x -S

有哪些不兼容

配置项

1. 配置项的名称发生了变化。(这是一个遗留已久的命名问题)

// 1.x
new SoonSpace({
  el: '#view',
  option: {},
  events: {},
});

// 2.x
new SoonSpace({
  el: '#view',
  options: {},
  events: {},
});

2. 不再兼容 1.x 早期版本的 backgroundColor、backgroundAlpha 字段，使用 background.color、 background.alpha 替代。

API

1. Poi、PoiNode 所有的 create 类方法，参数 info.scale 由 { width: 1, height: 1 } 改为 { x: 1, y: i, z: 1 }。

// 1.x
ssp.createPoi({
  ...
  scale: { width: 1, height: 1 }
})

// 2.x
ssp.createPoi({
  ...
  scale: { x: 1, y: i, z: 1 }
})

2. 插件安装 ssp.install 改为插件注册 ssp.registerPlugin。

完善中...

框架插件

1. vue-soonspace

   SoonSpace 版本	插件版本
   1.x.x	vue-soonspace@0.x.x
   2.x.x	vue-soonspace@2.1.x

npm i vue-soonspace@2.x.x -S
# or
yarn add vue-soonspace@2.x.x -S

1. react-soonspace

   SoonSpace 版本	插件版本
   1.x.x	react-soonspace@0.x.x
   2.x.x	react-soonspace@2.1.x

npm i react-soonspace@2.x.x -S
# or
yarn add react-soonspace@2.x.x -S

功能插件

1. 热力图插件（heat-map）

   SoonSpace 版本	插件版本
   1.x.x	@soonspacejs/heatmap
   2.x.x	@soonspacejs/plugin-heat-map

npm un @soonspacejs/heatmap -S
npm i @soonspacejs/plugin-heat-map -S

# or
yarn remove @soonspacejs/heatmap -S
yarn add @soonspacejs/plugin-heat-map -S

2. 巡检控制器（patrol-controls）

   SoonSpace 版本	插件版本
   1.x.x	@soonspacejs/patrol-controls
   2.x.x	@soonspacejs/plugin-patrol-controls

npm un @soonspacejs/patrol-controls -S
npm i @soonspacejs/plugin-patrol-controls -S

# or
yarn remove @soonspacejs/patrol-controls -S
yarn add @soonspacejs/plugin-patrol-controls -S

3. 对象操作控制器（transform-controls）

   SoonSpace 版本	插件版本
   1.x.x	@soonspacejs/transform-controls
   2.x.x	@soonspacejs/plugin-transform-controls

npm un @soonspacejs/transform-controls -S
npm i @soonspacejs/plugin-transform-controls -S

# or
yarn remove @soonspacejs/transform-controls -S
yarn add @soonspacejs/plugin-transform-controls -S

平台协同插件

1. soonmanager-sync

   SoonSpace 版本	插件版本
   1.x.x	@soonspacejs/soonmanager-sync
   2.x.x	@soonspacejs/plugin-soonmanager-sync

npm un @soonspacejs/soonmanager-sync -S
npm i @soonspacejs/plugin-soonmanager-sync -S

# or
yarn remove @soonspacejs/soonmanager-sync -S
yarn add @soonspacejs/plugin-soonmanager-sync -S