> ## Documentation Index
> Fetch the complete documentation index at: https://dev.marginnote.com.cn/llms.txt
> Use this file to discover all available pages before exploring further.

# 获取色板

> 读该学习集实际使用的那套摘录色板。

每个编号返回两个颜色：`baseColor` 是配置里的原色，`displayColor` 是随当前主题调整后的颜色。
取色或者比对颜色用 `displayColor`，把编号当成固定的颜色名则会出错。




## OpenAPI

````yaml /openapi/plugin-api.yaml get /study-sets/{topicid}/note-palette
openapi: 3.1.0
info:
  title: 场景插件 API
  summary: 场景插件在网页面板里可以调用的接口。
  description: >
    场景插件的面板是一个网页。页面里向 `/bridge/v1` 发请求，就能读写 MarginNote 里的数据。

    请求由 MarginNote 处理，与外部命令行工具共用同一套处理代码。外部工具要带令牌，面板不必带。

    面板页面从 `mnpanel://panel/index.html` 加载，因此 `fetch('/bridge/v1' + path)`
    属于同源请求。


    面板调用受这些条件约束：


    - 请求不带令牌，本文件也不声明安全方案。

    - 页面能调用哪些接口，取决于两份名单。模板里的 `plugins` 名单和沉浸态决定面板能不能建好，
      网页面板白名单决定页面能调哪些接口。不在白名单里的请求返回 `403`，
      错误码为 `IN_PROCESS_NOT_ALLOWED`。
    - `GET /capabilities` 里的 `requiresMax` 只约束外部 Agent。面板的请求在 MarginNote 进程内处理，
      不受令牌、订阅状态与跨设备批准的限制，能否调用只看该路径是否在白名单内。
    - 写操作里的 `addon`，MarginNote 会改写为当前面板所属插件的 id；`confirm` 由 MarginNote 补上。
      页面填的值不会生效。

    用 `mn.api(path, opts)` 读取数据。该方法始终将 Response Body 按 JSON 解析，相当于

    `fetch('/bridge/v1' + path, opts).then(r => r.json())`。


    响应的内容不是 JSON 的接口，改用 `fetch`：


    - `GET /guide` 返回 Markdown 正文。

    - `GET /notes/{noteid}/render` 返回卡片长图或 PDF。

    - `GET /documents/{bookmd5}/pages/{index}/content/{contentId}` 返回图片。

    - `GET /bundles/{bundleId}/files` 带 `?path=` 时返回该文件的原始字节。


    调用失败时 Promise 不会进入 reject。MarginNote 把错误对象

    `{"error":{"code":"…","message":"…"}}` 当作 Response Body 返回，因此结果落在 resolve 里。

    判断调用结果看响应里是否带 `error`，写操作另看响应里的 `persisted`。


    接口清单、各项上限与 Request Body 结构随 MarginNote 的版本变化，运行时以 `GET /capabilities` 与

    `GET /guide` 返回的内容为准。
  version: '0.91'
servers: []
security: []
tags:
  - name: 能力与状态
    description: 读取 MarginNote 的能力、版本与当前上下文。调用其他接口之前先读这组。
  - name: 卡片与摘录
    description: 卡片的读取与写入、摘录的创建、批注、标签、元数据与留白。
  - name: 手写会话
    description: 手写层、作答纸、练习准备清单与会话记录的读取与提交。
  - name: 学习集与卡组
    description: 学习集结构、脑图树、子脑图、色板、快照与复习卡组。
  - name: 文档与页面
    description: 文档目录、页文本、页内注释面、摘录清单与同步诊断。
  - name: 导出与 Anki
    description: 文档导出计划、导出文件、Anki 导出能力、作业与产物。
  - name: 查找
    description: 跨库搜索、文件夹列表与学习集列表。
  - name: 界面与模板
    description: 读取当前界面状态与沉浸模板。
  - name: 插件辅助
    description: 面板辅助脚本、已配对设备与本机 helper 信息。
  - name: 任务包与同步诊断
    description: 拆书任务包与旧 CloudKit 同步诊断。
paths:
  /study-sets/{topicid}/note-palette:
    get:
      tags:
        - 学习集与卡组
      summary: 获取色板
      description: |
        读该学习集实际使用的那套摘录色板。

        每个编号返回两个颜色：`baseColor` 是配置里的原色，`displayColor` 是随当前主题调整后的颜色。
        取色或者比对颜色用 `displayColor`，把编号当成固定的颜色名则会出错。
      operationId: getStudySetsTopicidNotePalette
      parameters:
        - $ref: '#/components/parameters/Topicid'
      responses:
        '200':
          description: 色板。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaletteResponse'
              examples:
                recorded:
                  summary: 真机实录（MarginNote 0.61，2026-09-18 录制）；实录只保留开头部分
                  value:
                    colors:
                      - baseColor:
                          hex: '#FFFFAA'
                          rgba:
                            r: 255
                            b: 170
                            g: 255
                            a: 1
                        displayColor:
                          hex: '#FFFFAA'
                          rgba:
                            r: 255
                            b: 170
                            g: 255
                            a: 1
                        colorIndex: 0
                      - baseColor:
                          hex: '#BEFFBE'
                          rgba:
                            r: 190
                            b: 190
                            g: 255
                            a: 1
                        displayColor:
                          hex: '#BEFFBE'
                          rgba:
                            r: 190
                            b: 190
                            g: 255
                            a: 1
                        colorIndex: 1
                      - baseColor:
                          hex: '#ADD2FF'
                          rgba:
                            r: 173
                            b: 255
                            g: 210
                            a: 1
                        displayColor:
                          hex: '#ADD2FF'
                          rgba:
                            r: 173
                            b: 255
                            g: 210
                            a: 1
                        colorIndex: 2
                    source: default
                    appearance: light
                    count: 16
                    title: 理工公式对照材料 · 样例
                    bridgeApiVersion: '0.61'
                    studySetId: 77012CA0-48E8-4D29-B5F5-1EEA927AE086
                measured:
                  summary: 实测于 2026-10-07，App 0.91
                  value:
                    colors:
                      - baseColor:
                          hex: '#FFFFAA'
                          rgba:
                            r: 255
                            b: 170
                            g: 255
                            a: 1
                        displayColor:
                          hex: '#FFFFAA'
                          rgba:
                            r: 255
                            b: 170
                            g: 255
                            a: 1
                        colorIndex: 0
                      - baseColor:
                          hex: '#BEFFBE'
                          rgba:
                            r: 190
                            b: 190
                            g: 255
                            a: 1
                        displayColor:
                          hex: '#BEFFBE'
                          rgba:
                            r: 190
                            b: 190
                            g: 255
                            a: 1
                        colorIndex: 1
                      - baseColor:
                          hex: '#ADD2FF'
                          rgba:
                            r: 173
                            b: 255
                            g: 210
                            a: 1
                        displayColor:
                          hex: '#ADD2FF'
                          rgba:
                            r: 173
                            b: 255
                            g: 210
                            a: 1
                        colorIndex: 2
                      - baseColor:
                          hex: '#FFAABE'
                          rgba:
                            r: 255
                            b: 190
                            g: 170
                            a: 1
                        displayColor:
                          hex: '#FFAABE'
                          rgba:
                            r: 255
                            b: 190
                            g: 170
                            a: 1
                        colorIndex: 3
                      - baseColor:
                          hex: '#FFFF00'
                          rgba:
                            r: 255
                            b: 0
                            g: 255
                            a: 1
                        displayColor:
                          hex: '#FFFF00'
                          rgba:
                            r: 255
                            b: 0
                            g: 255
                            a: 1
                        colorIndex: 4
                      - baseColor:
                          hex: '#00FF00'
                          rgba:
                            r: 0
                            b: 0
                            g: 255
                            a: 1
                        displayColor:
                          hex: '#00FF00'
                          rgba:
                            r: 0
                            b: 0
                            g: 255
                            a: 1
                        colorIndex: 5
                      - baseColor:
                          hex: '#00BEFF'
                          rgba:
                            r: 0
                            b: 255
                            g: 190
                            a: 1
                        displayColor:
                          hex: '#00BEFF'
                          rgba:
                            r: 0
                            b: 255
                            g: 190
                            a: 1
                        colorIndex: 6
                      - baseColor:
                          hex: '#FF0000'
                          rgba:
                            r: 255
                            b: 0
                            g: 0
                            a: 1
                        displayColor:
                          hex: '#FF0000'
                          rgba:
                            r: 255
                            b: 0
                            g: 0
                            a: 1
                        colorIndex: 7
                      - baseColor:
                          hex: '#FF8000'
                          rgba:
                            r: 255
                            b: 0
                            g: 128
                            a: 1
                        displayColor:
                          hex: '#FF8000'
                          rgba:
                            r: 255
                            b: 0
                            g: 128
                            a: 1
                        colorIndex: 8
                      - baseColor:
                          hex: '#008040'
                          rgba:
                            r: 0
                            b: 64
                            g: 128
                            a: 1
                        displayColor:
                          hex: '#008040'
                          rgba:
                            r: 0
                            b: 64
                            g: 128
                            a: 1
                        colorIndex: 9
                      - baseColor:
                          hex: '#003EB3'
                          rgba:
                            r: 0
                            b: 179
                            g: 62
                            a: 1
                        displayColor:
                          hex: '#003EB3'
                          rgba:
                            r: 0
                            b: 179
                            g: 62
                            a: 1
                        colorIndex: 10
                      - baseColor:
                          hex: '#CF1B11'
                          rgba:
                            r: 207
                            b: 17
                            g: 27
                            a: 1
                        displayColor:
                          hex: '#CF1B11'
                          rgba:
                            r: 207
                            b: 17
                            g: 27
                            a: 1
                        colorIndex: 11
                      - baseColor:
                          hex: '#FFFFFF'
                          rgba:
                            r: 255
                            b: 255
                            g: 255
                            a: 1
                        displayColor:
                          hex: '#FFFFFF'
                          rgba:
                            r: 255
                            b: 255
                            g: 255
                            a: 1
                        colorIndex: 12
                      - baseColor:
                          hex: '#DADADA'
                          rgba:
                            r: 218
                            b: 218
                            g: 218
                            a: 1
                        displayColor:
                          hex: '#DADADA'
                          rgba:
                            r: 218
                            b: 218
                            g: 218
                            a: 1
                        colorIndex: 13
                      - baseColor:
                          hex: '#B4B4B4'
                          rgba:
                            r: 180
                            b: 180
                            g: 180
                            a: 1
                        displayColor:
                          hex: '#B4B4B4'
                          rgba:
                            r: 180
                            b: 180
                            g: 180
                            a: 1
                        colorIndex: 14
                      - baseColor:
                          hex: '#C39DE0'
                          rgba:
                            r: 195
                            b: 224
                            g: 157
                            a: 1
                        displayColor:
                          hex: '#C39DE0'
                          rgba:
                            r: 195
                            b: 224
                            g: 157
                            a: 1
                        colorIndex: 15
                    source: default
                    appearance: light
                    count: 16
                    title: The Quiet Case for Walkable Streets
                    bridgeApiVersion: '0.91'
                    studySetId: 449C1665-E0DD-4A20-9E67-2B0D451F746D
      x-codeSamples:
        - lang: javascript
          label: 获取某一档的实际颜色
          source: >
            const p = await mn.api('/study-sets/' + topicid + '/note-palette');

            const third = p.colors[3];

            mn.log(third.colorIndex, third.displayColor.hex,
            third.displayColor.rgba);
components:
  parameters:
    Topicid:
      name: topicid
      in: path
      required: true
      description: >-
        学习集的 topicid。取自 `GET /ui-state` 的 `state.topicid`、`GET
        /library/study-sets`，或 `GET /writing/context` 响应里的 `window.topicid`。
      schema:
        type: string
  schemas:
    PaletteResponse:
      type: object
      description: 该学习集实际使用的色板。
      properties:
        bridgeApiVersion:
          type: string
        studySetId:
          type: string
        title:
          type: string
        count:
          type: number
        source:
          type: string
        appearance:
          type: string
        colors:
          type: array
          items:
            type: object
            properties:
              colorIndex:
                type: number
                description: 级别，从 0 起。
              baseColor:
                $ref: '#/components/schemas/ColorValue'
              displayColor:
                $ref: '#/components/schemas/ColorValue'
    ColorValue:
      type: object
      properties:
        hex:
          type: string
        rgba:
          type: object
          properties:
            r:
              type: number
            g:
              type: number
            b:
              type: number
            a:
              type: number

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.