跳到主要内容

图例

只有设了 legend 的 series 才会进图例。legend 对象控制图例放在哪、怎么排;没有任何 series 带标签时, 什么都不画。

字段类型设置什么
showboolean设为 false 就整块隐藏图例(连标签一起)。
positionstring图例在画布上的位置(见下)。
titlestring条目上方的标题。
show_boxboolean给图例画外框。
width / heightnumber图例尺寸(像素)。
col_limitinteger最多几列,用于 outside_bottom_columns 排布。
entry_limitinteger最多显示多少条,超出折叠成 … (+N more)。
wrapinteger条目文字按字符数折行。
at[number, number]把图例放在画布上的绝对像素位置。
at_data[number, number]把图例放在某个数据坐标上。
entriesentry[]手写的图例条目,绕开自动收集(见下)。
groupsgroup[]带标题的分组条目 —— {title, entries};优先级最高,会取代 entries 与自动收集(见下)。

手写条目​

entries 会取代自动收集:不再「一个带 legend 的 series 一条」,而是你写什么就显示什么。当颜色编码 藏在数据里、而不是藏在 series 列表里时,就需要它 —— 带逐点 colors 的散点带图、热力图的色条、手工上色 的图。

{ "entries": [ { "label": "ATTC", "color": "tomato", "shape": "circle" } ] }
条目字段类型设置什么
labelstring必填。 条目文字。
colorstring必填。 色块颜色。
shapestring | object"rect"(默认)· "line" · "circle" · {"marker": "triangle"} · {"size": 6}。
dasharraystring虚线样式(配 "line" 形状)。
WITH d AS (
SELECT "group" AS g, expression
FROM read_csv_auto('{{DFK_BASE_URL}}data/samples.tsv')
WHERE "group" = 'Control'
)
SELECT kuva_render(to_json({
'x_axis': {'name': 'sample'},
'y_axis': {'name': 'expression'},
'legend': {
'position': 'outside_right_top',
'title': 'above median',
'entries': [
{'label': 'high', 'color': '#c44e52', 'shape': 'circle'},
{'label': 'low', 'color': '#4c72b0', 'shape': 'circle'}
]
},
'series': [{
'type': 'strip',
'groups': [{
'label': 'Control',
'values': (SELECT list(expression ORDER BY expression) FROM d),
'point_colors': (SELECT list(CASE WHEN expression > 5 THEN '#c44e52' ELSE '#4c72b0' END
ORDER BY expression) FROM d)
}],
'point_size': 4,
'style': 'swarm'
}]
})) AS chart;

分组条目​

groups 把图例切成若干带粗体标题的段落,每段各自列条目,条目形状与 entries 完全一样:

WITH d AS (
SELECT "group" AS g, expression,
CASE WHEN "group" = 'Control'
THEN (CASE WHEN expression > 5 THEN '#c44e52' ELSE '#4c72b0' END)
ELSE (CASE WHEN expression > 5 THEN '#e6a532' ELSE '#55a868' END)
END AS c
FROM read_csv_auto('{{DFK_BASE_URL}}data/samples.tsv')
WHERE "group" IN ('Control', 'Drug_A')
)
SELECT kuva_render(to_json({
'x_axis': {'name': 'sample'},
'y_axis': {'name': 'expression'},
'legend': {
'position': 'outside_right_top',
'groups': [
{'title': 'Control', 'entries': [
{'label': 'below 5', 'color': '#4c72b0', 'shape': 'circle'},
{'label': 'above 5', 'color': '#c44e52', 'shape': 'circle'}]},
{'title': 'Drug A', 'entries': [
{'label': 'below 5', 'color': '#55a868', 'shape': 'circle'},
{'label': 'above 5', 'color': '#e6a532', 'shape': 'circle'}]}
]
},
'series': [{'type': 'strip',
'groups': (SELECT list({'label': g, 'values': vals, 'point_colors': cols} ORDER BY g)
FROM (SELECT g, list(expression ORDER BY expression) AS vals,
list(c ORDER BY expression) AS cols
FROM d GROUP BY g))}]
})) AS chart;

分组的顺序就是你写的顺序,组与组之间空半行。与 entries 一样,它们是手写的键:没有任何东西会去核对它们与 series 是否一致,所以要自己保证它们和你真正画出来的颜色对得上。

位置​

position 取下列任一值。比较时忽略大小写与分隔符,所以 outsideRightTop、outside_right_top、 OutsideRightTop 都解析到同一处。

图内图外
inside_top_left · inside_top_center · inside_top_rightoutside_right_top · outside_right_middle · outside_right_bottom
inside_bottom_left · inside_bottom_center · inside_bottom_rightoutside_left_top · outside_left_middle · outside_left_bottom
outside_top_left · outside_top_center · outside_top_right
outside_bottom_left · outside_bottom_center · outside_bottom_right
outside_bottom_columns —— 图下方的多列版式

位置写错会报错并指出那个字符串,而不是静默退回默认位置。

示例​

图外带标题的图例,配三组 series:

SELECT kuva_render(to_json({
'x_axis': {'name': 'x'},
'y_axis': {'name': 'y'},
'legend': {'position': 'outside_right_top', 'title': 'condition', 'show_box': true},
'series': list({'type': 'scatter', 'data': pts, 'legend': g} ORDER BY g)
})) AS chart
FROM (
SELECT "group" AS g, array_agg({'x': x, 'y': y} ORDER BY x) AS pts
FROM read_csv_auto('{{DFK_BASE_URL}}data/scatter.tsv')
GROUP BY "group"
);

说明​

stats_box 的 position 与 legend.position 用同一套取值,包括上面这些图内 / 图外的 名字。