Joint.js 项目中自定义图标导出为VSDX格式的解决方案

问题背景

在使用Joint.js的Joint Plus扩展进行图表导出时，开发者遇到了一个常见问题：当尝试将包含自定义图标的图表导出为VSDX格式时，所有图像和样式都会丢失，导致导出的Visio文件中只显示空白形状。

问题分析

经过深入分析，发现问题的根源在于当前版本的Joint Plus扩展（4.0.4）无法正确处理基于字体图标的导出。开发者原本使用的是自定义字体(VemIcons)来显示图标，通过Unicode字符引用图标，这种方式在浏览器中显示正常，但在导出为VSDX格式时无法保留。

解决方案

1. 使用SVG图像替代字体图标

最有效的解决方案是将字体图标替换为SVG格式的图像。SVG作为矢量图形格式，不仅能够保持高质量的显示效果，还能被Visio导出功能正确处理。

实现步骤：

1. 创建自定义元素类：继承自dia.Element基类，定义专门用于显示图标的元素类型。

const markup = util.svg`
    <image @selector='icon'></image>
`;

class DeviceIconModel extends dia.Element {
    defaults() {
        return util.defaultsDeep(
            {
                type: 'mapShapes.DeviceIconModel',
                attrs: {
                    icon: {
                        href: 'assets/icons/heart.svg',
                        width: 48,
                        height: 48
                    }
                },
            },
            super.defaults
        );
    }

    preinitialize(): void {
        this.markup = markup;
    }
}

2. 正确设置元素属性：将自定义数据存储在模型属性中，而非表示属性中。

const icon = new DeviceIconModel({
    size: {
      width: (item.size.width + item.size.height) / 2,
      height: (item.size.width + item.size.height) / 2
    },
    position: item.position,
    cursor: 'default',
    data: {
        mapObjId: item.mapObjId,
        mapObjType: item.mapObjType,
        icon: item.icon,
        mapAssetId: mapAssetId,
        link: item.link,
        deviceType: item.deviceType,
        mapAssetEntityId: assetEntityId
    },
    attrs: {
      root: {
        'data-tooltip': deviceDescription ?? null
      },
      icon: {
        href: MapIconsDictionary[item.icon.replace('.gif', '')],
        transform: 'translate(0,5)',
        cursor: 'default'
      }
    }
});

2. 数据存储最佳实践

在Joint.js中，应该区分表示属性和模型数据：

• 表示属性(attrs)：用于控制元素在视图中的显示方式，如位置、大小、颜色等
• 模型数据：存储业务相关的自定义数据，应直接存储在模型上

这种分离使得代码更加清晰，也便于维护和扩展。

实施建议

1. 图标资源准备：将原有的字体图标转换为SVG格式，确保每个图标都有对应的SVG文件。

2. 渐进式迁移：可以逐步将现有基于字体的图标替换为SVG版本，而不是一次性全部替换。

3. 性能优化：对于大量使用相同图标的场景，可以考虑使用<use>元素引用同一个SVG定义，减少文件大小。

4. 样式处理：由于SVG图像不能通过CSS直接改变颜色，需要在SVG文件中预设好颜色方案，或者使用SVG滤镜实现动态着色。

总结

通过将字体图标替换为SVG图像，并正确组织数据存储结构，开发者可以成功解决Joint.js图表导出为VSDX格式时图标丢失的问题。这种解决方案不仅解决了当前问题，还提供了更好的代码组织和维护性，为未来的功能扩展打下了良好基础。