Skip to content

样式与主题 ​

预览版本

jsMind V2 的编程 API 目前是预览版本,之后还会更新。请随时查阅本文档,以了解当前的接口。

导图、节点或边上的视觉覆盖。未设置的字段回退到主题。

本页由 TypeDoc 根据已发布的类型声明 dist/jsmind.d.ts 生成。

JmNodeStyle ​

接口

单个节点的视觉覆盖。

说明

每个字段都是可选的,未设置的字段回退到主题。节点只保存与主题不同的项,因此主题变更仍能到达所有未显式覆盖任何项的节点。

incoming 放在子节点上:一条线只连接一个子节点,由子节点持有最自然。该名称与布局层(calculateNodeIncomingPoint / calculateNodeOutgoingPoint)对应。

属性

名称类型说明
background (可选)string背景色,例如 #ffffff。
borderColor (可选)string边框颜色。
borderStyle (可选)JmLinePattern边框虚实样式。
borderWidth (可选)number边框宽度,单位为像素。
color (可选)string文本颜色。
fontSize (可选)number字号,单位为像素。
fontWeight (可选)JmFontWeight字重。
incoming (可选)JmLineStyle连接本节点与其父节点的线条样式。
tone (可选)JmTone该节点的语义语气。会覆盖主题中的背景、边框和文本颜色。

JmLineStyle ​

接口

单条线的视觉样式。

说明

有两处共用:JmNodeStyle.incoming(连接节点与其父节点的线)和 JmEdge.style(额外的、非层级关系的线)。同一形状避免为同一事物准备两套词汇。

属性

名称类型说明
color (可选)string线条颜色,例如 #4a9eff。
curve (可选)JmLineCurve线条在端点之间的走线方式。默认为 bezier。
pattern (可选)JmLinePattern线条图案。
width (可选)number线条宽度,单位为像素。

JmStyle ​

接口

整张思维导图的样式声明,按数据文件中的存储形式。

说明

名称用单数,与节点和边上的 style 字段一致:同一种 style 概念,范围由它所在的位置决定。mind.style 覆盖整张图;node.style 覆盖一个节点;edge.style 覆盖一条边。在同一份文档里同时携带 styles 和 style,差别只在一个 s,对生成 JSON 的 agent 是个陷阱。

可以读作:「这张思维导图看起来是这样——它继承 theme,再覆盖下列字段。」

把继承与覆盖放在一份扁平声明里,可以避免嵌套 { name, ...overrides } 的歧义:那里的 name 既可能被读成「这个主题叫什么」,也可能被读成「继承哪个主题」。这里的 theme 只能是后者。

  • theme 指定要继承的内置预设。省略时表示 "default",因此一份只覆盖几种颜色的文件不必写出主题名。
  • defaultTone 指定没有自己 tone 的节点用哪个语气。存名字而不是调色板,这份声明才仍然是一个继承决策:在 tones 里改一次,整张图跟着变。
  • 其余每个字段都是叠加在该预设之上的覆盖,并且会深合并。

属性

名称类型说明
background (可选)string画布背景色。
defaultTone (可选)string没有自己 tone 的节点使用的语气。
expander (可选)Partial<JmThemeExpander>展开/折叠控件的几何覆盖。
line (可选)Partial<JmThemeLine>线条几何覆盖。
node (可选)JmThemeNodeOverride节点几何覆盖。
theme (可选)string要继承的内置主题名称。默认为 "default"。
tones (可选)Partial<Record<JmTone, Partial<JmTonePalette>>>按语气覆盖的颜色。

JmThemeNode ​

接口

所有节点共享的几何与排版。

属性

名称类型说明
borderWidthnumber默认边框宽度,单位为像素。
fontFamilystring字体族。
fontSizenumber基础字号,单位为像素。
lineHeightnumber行高,作为字号的倍数。
maxWidthnumber文本换行前的最大节点宽度,单位为像素。
paddingnumber内边距,单位为像素。
radiusnumber圆角半径,单位为像素。
rootFontSizenumber根节点字号,单位为像素。
shadowJmThemeShadow空闲、悬停和选中状态下的投影。

JmThemeLine ​

接口

一张思维导图中所有线条共享的几何。

属性

名称类型说明
curveJmLineCurve默认的曲线形状。命名为 curve 以与 JmLineStyle.curve 一致。
patternJmLinePattern默认的线条图案。命名为 pattern 以与 JmLineStyle.pattern 一致。
widthnumber默认线条宽度,单位为像素。

JmThemeExpander ​

接口

折叠/展开控件的几何。

属性

名称类型说明
borderWidthnumber边框宽度,单位为像素。
fontSizenumber控件内绘制的字符或数字的字号,单位为像素。
lineHeightnumber该内容的行高,单位为像素。
radiusnumber圆角半径,单位为像素。
sizenumber展开控件的宽和高,单位为像素。

JmThemeShadow ​

接口

节点可能处于的三种视觉状态的投影。

说明

这些状态放在主题里而不是 CSS 里,因为它们改变节点的外观,而「这个节点看起来怎样」应当与其余外观放在一起。normal 是静止状态;hover 和 selected 是指针与选中对它的影响。

属性

名称类型说明
hoverJmThemeShadowLayer指针位于节点上方时的投影。
normalJmThemeShadowLayer节点空闲时的投影。
selectedJmThemeShadowLayer节点被选中时的投影。

JmThemeShadowLayer ​

接口

一层投影,按 CSS 的含义表述。

说明

写成四个数值加一个颜色,而不是像 "1px 1px 1px #666" 那样的 CSS 字符串,这样可以按字段合并——只改模糊半径的覆盖不必重写偏移——生成 JSON 的 agent 也不必写对 CSS 简写语法。

属性

名称类型说明
blurnumber模糊半径,单位为像素。
colorstring投影颜色,例如 #666666。
offsetXnumber水平偏移,单位为像素。
offsetYnumber垂直偏移,单位为像素。

JmThemeShadowOverride ​

接口

JmThemeShadow 的部分替换。

说明

每一层都是可选的,因此一份样式可以只改一种状态,或一种状态里的一个字段(hover.blur),而不必重写其余部分。合并后的结果始终是完整的。

属性

名称类型说明
hover (可选)Partial<JmThemeShadowLayer>悬停投影的覆盖。
normal (可选)Partial<JmThemeShadowLayer>空闲投影的覆盖。
selected (可选)Partial<JmThemeShadowLayer>选中投影的覆盖。

JmThemeNodeOverride ​

类型

JmThemeNode 的部分覆盖。

说明

与 Partial<JmThemeNode> 相同,但 shadow 允许只覆盖三种状态中的一种,而不必覆盖全部三种。

JmTonePalette ​

接口

一种语气解析得到的颜色。

说明

line 是连接线的颜色,通常与 border 不同,这样一棵子树可以读成一个视觉分组。

属性

名称类型说明
borderColorstring节点边框颜色。
fillColorstring节点背景色。
lineColorstring连接线颜色。
textColorstring节点文本颜色。

JmTone ​

枚举

语义语气。只表达颜色,从不表达几何。

说明

语义角色只关于颜色;几何是正交的(一个节点可以同时是警告色、粗边框和大字号)。把它们分开,agent 每次改动的副作用更少,生成的结果也更好控制。

成员

名称值说明
Accent"accent"强调色语气,让元素突出但不带评判。
Danger"danger"危险或负面语气。
Default"default"默认语气,从主题的中性色板解析。
Info"info"信息或中性强调语气。
Primary"primary"主要或强调语气。
Success"success"成功或正面语气。
Warning"warning"警告或谨慎语气。

JmFontWeight ​

枚举

字重。

说明

使用枚举而不是内联联合类型,这样 CLI 可以枚举可接受的值,而不必重复书写。JmLinePattern 和 JmLineCurve 已经是这种形状;fontWeight 原先是例外。

成员

名称值说明
Bold"bold"加粗字重。
Normal"normal"常规字重。

JmLinePattern ​

枚举

线条的虚实样式。

成员

名称值说明
Dashed"dashed"虚线。
Dotted"dotted"点线。
Solid"solid"实线。

JmLineCurve ​

枚举

线条在两个端点之间的走线方式。

说明

这与 JmLinePattern 是不同的维度:pattern 表示描边是否为虚线,curve 表示描边的形状。二者故意分开——直线虚线和曲线虚线都需要存在;像 v1 的 line_style 那样用一个样式字符串,只能表达其中之一。

成员

名称值说明
Bezier"bezier"三次贝塞尔曲线,从每个端点沿水平方向出发。
Straight"straight"从一个端点到另一个端点的直线段。

本文档由 AI 协助生成 / This documentation was prepared with AI assistance