python-xmind库使用说明

python-xmind库使用说明

概述

python-xmind是一个用于读取、创建和修改XMind思维导图文件的Python库。它提供了简单易用的API，让开发者能够以编程方式处理XMind文件。

安装

pip install xmind

基本概念

1. 工作簿 (Workbook)

• XMind文件的最顶层容器
• 可以包含多个工作表
• 通过 xmind.load() 加载或 xmind.new() 创建(new方法有待考证)

2. 工作表 (Sheet)

• 工作簿中的单个思维导图页面
• 每个工作表有一个根主题
• 通过 workbook.getSheets() 获取

3. 主题 (Topic)

• 思维导图中的节点
• 可以有标题、ID、结构类型等属性
• 支持层级结构（父子关系）

基本使用方法

1. 加载现有XMind文件

import xmind

# 加载XMind文件
workbook = xmind.load("ugOpen.xmind")

# 获取工作表
sheets = workbook.getSheets()
print(f"工作表数量: {
     
     len(sheets)}")

# 获取第一个工作表
sheet = sheets[0]
print(f"工作表标题: {
     
     sheet.getTitle()}")

2. 获取主题信息

# 获取根主题
root_topic = sheet.getRootTopic()
print(f"根主题: {
     
     root_topic.getTitle()}")
print(f"根主题ID: {
     
     root_topic.getID()}")

# 获取子主题
sub_topics = root_topic.getSubTopics()
print(f"子主题数量: {
     
     len(sub_topics)}")

for topic in sub_topics:
    print(f"  - {
     
     topic.getTitle()}")

3. 创建新的XMind文件

# 创建新工作簿
workbook = xmind.load("new.xmind")

# 获取主工作表
sheet = workbook.getPrimarySheet()
sheet.setTitle("我的思维导图")

# 创建根主题
root_topic = sheet.getRootTopic()
root_topic.setTitle("中心主题")

# 添加子主题
sub_topic = root_topic.addSubTopic()
sub_topic.setTitle("子主题1")

# 保存文件
xmind.save(workbook, "new_mindmap.xmind")

4. 修改现有文件

# 加载文件
workbook = xmind.load("ugOpen.xmind")
sheet = workbook.getPrimarySheet